xdg 2.2.5 → 3.0.0

data/demo/02_base_dir_extended.md

@@ -1,47 +0,0 @@
-# Extended Base Directory Standard
-
-The extended base directory standard provides additional locations
-not apart the offical standard. These are somewhat experimental.
-
-## Resource
-
-    XDG['RESOURCE_HOME'].environment.assert == ENV['XDG_RESOURCE_HOME'].to_s
-
-    XDG['RESOURCE_HOME'].environment_variables.assert == ['XDG_RESOURCE_HOME']
-
-Looking at the data home location by default it should be pointing to
-our joe users home directory under `.local`.
-
-    XDG['RESOURCE_HOME'].list.assert == ['~/.local']
-
-    XDG['RESOURCE_HOME'].to_a.assert == [$froot + 'home/joe/.local']
-
-
-## Work
-
-The working configuration directory
-
-    XDG['CONFIG_WORK'].environment.assert == ENV['XDG_CONFIG_WORK'].to_s
-
-    XDG['CONFIG_WORK'].environment_variables.assert == ['XDG_CONFIG_WORK']
-
-Looking at the config work location, by default it should be pointing to
-the current working directorys `.config` or `config` directory.
-
-    XDG['CONFIG_WORK'].list.assert == ['.config', 'config']
-
-    XDG['CONFIG_WORK'].to_a.assert == [Dir.pwd + '/.config', Dir.pwd + '/config']
-
-The working cache directory
-
-    XDG['CACHE_WORK'].environment.assert == ENV['XDG_CACHE_WORK'].to_s
-
-    XDG['CACHE_WORK'].environment_variables.assert == ['XDG_CACHE_WORK']
-
-Looking at the cache work location, by default it should be pointing to
-the current working directorys `.tmp` or `tmp` directory.
-
-    XDG['CACHE_WORK'].list.assert == ['.tmp', 'tmp']
-
-    XDG['CACHE_WORK'].to_a.assert == [Dir.pwd + '/.tmp', Dir.pwd + '/tmp']
-

data/demo/03_base_dir_mixin.md

@@ -1,17 +0,0 @@
-# Base Directory Mixin
-
-The base directory mixin is used to easy augment a class for 
-access to a named subdirectory of the XDG directories.
-
-    class MyAppConfig
-      include XDG::BaseDir::Mixin
-
-      def subdirectory
-        'myapp'
-      end
-    end
-
-    c = MyAppConfig.new
-
-    c.config.home.to_a  #=> [$froot + 'home/joe/.config/myapp']
-

data/demo/applique/ae.rb

@@ -1,2 +0,0 @@
-require 'ae'
-AE.ansi = false

data/demo/applique/fakeroot.rb

@@ -1,17 +0,0 @@
-require 'fileutils'
-
-dir = File.expand_path(File.dirname(File.dirname(__FILE__)))
-
-$froot = File.join(dir, 'fixtures/fakeroot/')
-
-puts "Fake root at: `#{$froot}'."
-
-#
-ENV['HOME']            = $froot + 'home/joe'
-#ENV['XDG_DATA_HOME']   = $froot + '.local/share'
-ENV['XDG_DATA_DIRS']   = $froot + 'usr/share'
-#ENV['XDG_CONFIG_HOME'] = $froot + '.config'
-ENV['XDG_CONFIG_DIRS'] = $froot + 'etc/xdg' + ':' + $froot + 'etc'
-#ENV['XDG_CACHE_HOME']  = $froot + '.cache'
-ENV['XDG_CACHE_DIRS']  = $froot + 'tmp'
-

data/demo/applique/xdg.rb

@@ -1 +0,0 @@
-require 'xdg'

data/demo/fixtures/fakeroot/etc/xdg/bar.config

@@ -1 +0,0 @@
-BAR.CONFIG

data/demo/fixtures/fakeroot/home/joe/foo.txt

@@ -1 +0,0 @@
-FOO TEXT

data/demo/fixtures/fakeroot/usr/share/bar.dat

@@ -1 +0,0 @@
-BAR.DAT

data/lib/xdg/base_dir.rb

@@ -1,255 +0,0 @@
-module XDG
-
-  # Base Directory Standard
-  class BaseDir
-
-    # Try to get information from Ruby's install configuration.
-    require 'rbconfig'
-
-    sysconfdir = ::RbConfig::CONFIG['sysconfdir'] || '/etc'
-    datadir    = ::RbConfig::CONFIG['datadir']    || '/usr/share'
-
-    # Standard defaults for locations.
-    DEFAULTS = {
-      'XDG_DATA_HOME'   => ['~/.local/share'],
-      'XDG_DATA_DIRS'   => ['/usr/local/share', datadir],
-      'XDG_CONFIG_HOME' => ['~/.config'],
-      'XDG_CONFIG_DIRS' => [File.join(sysconfdir,'xdg'), sysconfdir],
-      'XDG_CACHE_HOME'  => ['~/.cache'],
-      'XDG_CACHE_DIRS'  => ['/tmp']
-    }
-
-    # BaseDir iterates over directory paths.
-    include Enumerable
-
-    # Shortcut for `BaseDir.new`.
-    def self.[](*env)
-      new(*env)
-    end
-
-    # Initialize new instance of BaseDir class.
-    def initialize(*env)
-      @environment_variables = []
-      env.each do |v|
-        v = v.to_s.upcase
-        if v !~ /_/
-          @environment_variables << 'XDG_' + v + '_HOME'
-          @environment_variables << 'XDG_' + v + '_DIRS'
-        else
-          @environment_variables << 'XDG_' + v
-        end
-      end
-    end
-
-    # The environment variables being referenced.
-    #
-    # @return [Array] list of XDG environment variable names
-    def environment_variables
-      @environment_variables
-    end
-
-    # The environment setting, or it's equivalent when the BaseDir
-    # is a combination of environment variables.
-    #
-    # @return [String] evnironment vsetting
-    def environment
-      environment_variables.map{ |v| ENV[v] }.join(':')
-    end
-
-    # This is same as #environment, but also includes default values.
-    #
-    # @return [String] envinronment value.
-    def environment_with_defaults
-      environment_variables.map{ |v| ENV[v] || DEFAULTS[v] }.join(':')
-    end
-
-    # Shortcut for #environment_with_defaults.
-    alias_method :env, :environment_with_defaults
-
-    # Returns a complete list of expanded directories.
-    #
-    # @return [Array<String>] expanded directory list
-    def to_a
-      environment_variables.map do |v|
-        if paths = ENV[v]
-          dirs = paths.split(/[:;]/)
-        else
-          dirs = DEFAULTS[v]
-        end
-        dirs.map{ |path| expand(path) }
-      end.flatten
-    end
-
-    # BaseDir is essentially an array.
-    alias_method :to_ary, :to_a
-
-    # Number of directory paths.
-    def size
-      to_a.size
-    end
-
-    # Iterate of each directory.
-    def each(&block)
-      to_a.each(&block)
-    end
-
-    # Returns an *unexpanded* list of directories.
-    #
-    # @return [Array<String>] unexpanded directory list
-    def list
-      environment_variables.map do |v|
-        if paths = ENV[v]
-          dirs = paths.split(/[:;]/)
-        else
-          dirs = DEFAULTS[v]
-        end
-        if subdirectory
-          dirs.map{ |path| File.join(path, subdirectory) }
-        else
-          dirs
-        end
-      end.flatten
-    end
-
-    # List of directories as Pathanme objects.
-    #
-    # @return [Array<Pathname>] list of directories as Pathname objects
-    def paths
-      map{ |dir| Pathname.new(dir) }
-    end
-
-    # Returns the first directory expanded. Since a environment settings
-    # like `*_HOME` will only have one directory entry, this definition
-    # of #to_s makes utilizing those more convenient.
-    #
-    # @return [String] directory
-    def to_s
-      to_a.first
-    end
-
-    # The first directory converted to a Pathname object.
-    #
-    # @return [Pathname] pathname of first directory
-    def to_path
-      Pathname.new(to_a.first)
-    end
-
-    # The common subdirectory.
-    attr :subdirectory
-
-    # Set subdirectory to be applied to all paths.
-    def subdirectory=(path)
-      @subdirectory = path.to_s
-    end
-
-    # Set subdirectory to be applied to all paths and return `self`.
-    #
-    # @return [BaseDir] self
-    def with_subdirectory(path)
-      @subdirectory = path if path
-      self
-    end
-
-    # Return array of matching files or directories
-    # in any of the resource locations, starting with
-    # the home directory and searching outward into
-    # system directories.
-    #
-    # Unlike #select, this doesn't take a block and each
-    # additional glob argument is treated as a logical-or.
-    #
-    #   XDG[:DATA].glob("stick/*.rb", "stick/*.yaml")
-    #
-    def glob(*glob_and_flags)
-      glob, flags = *parse_arguments(*glob_and_flags)
-      find = []
-      to_a.each do |dir|
-        glob.each do |pattern|
-          find.concat(Dir.glob(File.join(dir, pattern), flags))
-        end
-      end
-      find.uniq
-    end
-
-    # Return array of matching files or directories
-    # in any of the resource locations, starting with
-    # the home directory and searching outward into
-    # system directories.
-    #
-    # String parameters are joined into a pathname
-    # while Integers and Symbols treated as flags.
-    #
-    # For example, the following are equivalent:
-    #
-    #   XDG::BaseDir[:DATA,:HOME].select('stick/units', File::FNM_CASEFOLD)
-    #
-    #   XDG::BaseDir[:DATA,:HOME].select('stick', 'units', :casefold)
-    #
-    def select(*glob_and_flags, &block)
-      glob, flag = *parse_arguments(*glob_and_flags)
-      find = []
-      to_a.each do |dir|
-        path = File.join(dir, *glob)
-        hits = Dir.glob(path, flag)
-        hits = hits.select(&block) if block_given?
-        find.concat(hits)
-      end
-      find.uniq
-    end
-
-    # Find a file or directory. This works just like #select
-    # except that it returns the first match found.
-    #
-    # TODO: It would be more efficient to traverse the dirs and use #fnmatch.
-    def find(*glob_and_flags, &block)
-      glob, flag = *parse_arguments(*glob_and_flags)
-      find = nil
-      to_a.each do |dir|
-        path = File.join(dir, *glob)
-        hits = Dir.glob(path, flag)
-        hits = hits.select(&block) if block_given?
-        find = hits.first
-        break if find
-      end
-      find
-    end
-
-  private
-
-    def parse_arguments(*glob_and_flags)
-      glob, flags = *glob_and_flags.partition{ |e| String===e }
-      glob = ['**/*'] if glob.empty?
-      flag = flags.inject(0) do |m, f|
-        if Symbol === f
-          m + File::const_get("FNM_#{f.to_s.upcase}")
-        else
-          m + f.to_i
-        end
-      end
-      return glob, flag
-    end
-
-    #
-    def expand(path)
-      if subdirectory
-        File.expand_path(File.join(path, subdirectory))
-      else
-        File.expand_path(path)
-      end
-    end
-
-    # If Pathname is referenced the library is automatically loaded.
-    def self.const_missing(const)
-      if const == :Pathname
-        require 'pathname'
-        ::Pathname
-      else
-        super(const)
-      end
-    end
-
-  end
-
-end
-
-# Copyright (c) 2008 Rubyworks

data/lib/xdg/base_dir/extended.rb

@@ -1,19 +0,0 @@
-module XDG
-
-  # Base directory interface class.
-  class BaseDir
-
-    #
-    DEFAULTS['XDG_RESOURCE_HOME'] = ['~/.local']
-    DEFAULTS['XDG_RESOURCE_DIRS'] = ['/usr/local','/usr']
-
-    # Working directory
-    # TODO: Not sure about these defaults
-    DEFAULTS['XDG_CONFIG_WORK']   = ['.config','config']
-    DEFAULTS['XDG_CACHE_WORK']    = ['.tmp','tmp']
-    DEFAULTS['XDG_RESOURCE_WORK'] = ['.local']
-  end
-
-end
-
-# Copyright (c) 2008 Rubyworks

data/lib/xdg/base_dir/global_variables.rb

@@ -1,19 +0,0 @@
-if RUBY_VERSION > '1.9'
-  require_relative 'base_dir'
-else
-  require 'xdg/base_dir'
-end
-
-$XDG_DATA        = XDG::BaseDir.new('DATA')
-$XDG_DATA_HOME   = XDG::BaseDir.new('DATA', 'HOME')
-$XDG_DATA_DIRS   = XDG::BaseDir.new('DATA', 'DIRS')
-
-$XDG_CONFIG      = XDG::BaseDir.new('CONFIG')
-$XDG_CONFIG_HOME = XDG::BaseDir.new('CONFIG', 'HOME')
-$XDG_CONFIG_DIRS = XDG::BaseDir.new('CONFIG', 'DIRS')
-
-$XDG_CACHE       = XDG::BaseDir.new('CACHE')
-$XDG_CACHE_HOME  = XDG::BaseDir.new('CACHE', 'HOME')
-$XDG_CACHE_DIRS  = XDG::BaseDir.new('CACHE', 'DIRS')
-
-# Copyright (c) 2008 Rubyworks

data/lib/xdg/base_dir/legacy.rb

@@ -1,74 +0,0 @@
-module XDG
-  class BaseDir
-    # Legacy API can serve as a stop gap until a developer
-    # has time to update an program already using XDG.
-    #
-    # Do NOT use this module for future development!!!
-    module Legacy
-      #
-      require 'xdg'
-      require 'xdg/base_dir/extended'
-
-      #
-      extend self
-
-      #
-      def home
-        File.expand_path('~')
-      end
-
-      #
-      def data
-        obj = XDG['DATA']
-        class << obj
-          def home
-            XDG['DATA_HOME'].to_a.first
-          end
-          def dirs
-            XDG['DATA_DIRS'].to_a
-          end
-        end
-        return obj
-      end
-
-      #
-      def config
-        obj = XDG['CONFIG']
-        class << obj
-          def home
-            XDG['CONFIG_HOME'].to_a.first
-          end
-          def dirs
-            XDG['CONFIG_DIRS'].to_a
-          end
-          def work
-            XDG['CONFIG_WORK'].to_a
-          end
-        end
-        return obj
-      end
-
-      #
-      def cache
-        obj = XDG['CACHE']
-        class << obj
-          def home
-            XDG['CACHE_HOME'].to_a.first
-          end
-          def dirs
-            XDG['CACHE_DIRS'].to_a
-          end
-          def work
-            XDG['CACHE_WORK'].to_a
-          end
-        end
-        return obj
-      end
-
-    end
-  end
-
-  extend BaseDir::Legacy
-end
-
-# Copyright (c) 2008 Rubyworks