Module: Folio::XDG

Defined in:
lib/folio/xdg.rb

Overview

XDG Base Directory Standard

This provides a conveient library for conforming to the XDG Base Directory Standard.

http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

Some important clarifications, not made clear by the above specification.

The data directories are for “read-only” files. In other words once something is put there, it should only be read, never written to by a program. (Generally speaking only users or pacakge mangers should be adding, changing or removing files from the data locations.

The config locations are where you should store files that may change, and effect operations depending one there content. This is like etc/ in the FHS, but alterable by end users and and end user programs, not just root and sudo admin scripts.

The cache location stores files that could judt as well be deleted and everyihtng still works find. This is for variable and temporary files. Like var/ in FHS.

This module returns paths as strings.

Class Method Summary collapse

Class Method Details

.home ⇒ Object 



44
45
46
 
# File 'lib/folio/xdg.rb', line 44

def home
  ENV['HOME'] || File.expand_path('~')
end

.xdg_cache_file(file) ⇒ Object

Find a file or directory in the user cache.



104
105
106
 
# File 'lib/folio/xdg.rb', line 104

def xdg_cache_file(file)
  File.join(cache_home,file)
end

.xdg_cache_home ⇒ Object

Location of user’s personal cache directory.



81
82
83
84
85
 
# File 'lib/folio/xdg.rb', line 81

def xdg_cache_home
  File.expand_path(
    ENV['XDG_CACHE_HOME'] || File.join(home, '.cache')
  )
end

.xdg_cache_work ⇒ Object

Location of working cache directory.



130
131
132
133
134
135
 
# File 'lib/folio/xdg.rb', line 130

def xdg_cache_work
  File.expand_path(
    #ENV['XDG_CACHE_WORK'] || File.join(Dir.pwd, '.cache')
    File.join(Dir.pwd, '.cache')
  )
end

.xdg_config_dirs ⇒ Object

List of user’s shared config directories.



56
57
58
59
60
61
62
 
# File 'lib/folio/xdg.rb', line 56

def xdg_config_dirs
  dirs = ENV['XDG_CONFIG_DIRS'].split(/[:;]/)
  if dirs.empty?
    dirs = %w{/etc/xdg}
  end
  dir.collect{ |d| File.expand_path(d) }
end

.xdg_config_file(file) ⇒ Object

Find a file or directory in config dirs.



96
97
98
99
100
101
 
# File 'lib/folio/xdg.rb', line 96

def xdg_config_file(file)
  [config_home, *config_dirs].each do |dir|
    path = File.join(dir,file)
    break path if File.exist?(path)
  end
end

.xdg_config_home ⇒ Object

Location of user’s personal config directory.



49
50
51
52
53
 
# File 'lib/folio/xdg.rb', line 49

def xdg_config_home
  File.expand_path(
    ENV['XDG_CONFIG_HOME'] || File.join(home, '.config')
  )
end

.xdg_config_work ⇒ Object

Location of working config directory.



114
115
116
117
118
119
 
# File 'lib/folio/xdg.rb', line 114

def xdg_config_work
  File.expand_path(
    #ENV['XDG_CONFIG_WORK'] || File.join(Dir.pwd, '.config')
    File.join(Dir.pwd, '.config')
  )
end

.xdg_data_dirs ⇒ Object

List of user’s shared data directores.



72
73
74
75
76
77
78
 
# File 'lib/folio/xdg.rb', line 72

def xdg_data_dirs
  dirs = ENV['XDG_DATA_DIRS'].split(/[:;]/)
  if dirs.empty?
    dirs = %w{/usr/local/share/ /usr/share/}
  end
  dir.collect{ |d| File.expand_path(d) }
end

.xdg_data_file(file) ⇒ Object

Find a file or directory in data dirs.



88
89
90
91
92
93
 
# File 'lib/folio/xdg.rb', line 88

def xdg_data_file(file)
  [data_home, *data_dirs].each do |dir|
    path = File.join(dir,file)
    break path if File.exist?(path)
  end
end

.xdg_data_home ⇒ Object

Location of user’s personal data directory.



65
66
67
68
69
 
# File 'lib/folio/xdg.rb', line 65

def xdg_data_home
  File.expand_path(
    ENV['XDG_DATA_HOME'] || File.join(home, '.local', 'share')
  )
end

.xdg_data_work ⇒ Object

Location of working data directory.



122
123
124
125
126
127
 
# File 'lib/folio/xdg.rb', line 122

def xdg_data_work
  File.expand_path(
    #ENV['XDG_DATA_WORK'] || File.join(Dir.pwd, '.share')
    File.join(Dir.pwd, '.share')
  )
end