xdg 2.0.0 → 2.1.0

data/.ruby

@@ -1,14 +1,17 @@
 --- 
 name: xdg
-version: 2.0.0
+version: 2.1.0
 title: XDG
 summary: XDG provides an interface for using XDG directory standard.
 description: XDG provides a module for supporting the XDG Base Directory Standard. See http://standards.freedesktop.org/basedir-spec/basedir-spec-0.6.html
 loadpath: 
 - lib
 manifest: Manifest.txt
-requires: []
-
+requires: 
+- name: qed
+  version: 0+
+  group: 
+  - test
 conflicts: []
 
 replaces: []
@@ -18,7 +21,7 @@ engine_check: []
 organization: RubyWorks
 contact: Thomas Sawyer <transfire@gmail.com>
 created: 2008-09-27
-copyright: Copyright (c) 2008 Thomas Sawyer
+copyright: Copyright (c) 2008,2011 Thomas Sawyer
 licenses: 
 - Apache 2.0
 authors: 

data/HISTORY.rdoc

@@ -1,5 +1,19 @@
 = RELEASE HISTORY
 
+== 2.1.0 / 2011-06-10
+
+This release changes the BaseDir#list method, where as it used
+to be an alias for #to_a, it now differs in that it does not
+expand the paths. In addtion a few tests were fixed and version
+number properly updated int hte version.rb file.
+
+Changes:
+
+* Change BaseDir#list to not expand paths.
+* Properly assign VERSION constant.
+* Fix broken qed tests.
+
+
 == 2.0.0 / 2011-06-09
 
 Major new release is full rewrite of the API, with an eye out for

data/lib/xdg/base_dir.rb

@@ -48,7 +48,16 @@ module XDG
       @environment_variables
     end
 
-    # Returns a complete list of directories.
+    # The equivalent environment setting.
+    #
+    # @return [String] evnironment vsetting
+    def env
+      environment_variables.map{ |v| ENV[v] }.join(':')
+    end
+
+    # 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]
@@ -73,9 +82,22 @@ module XDG
       to_a.each(&block)
     end
 
-    # Returns a complete list of directories.
+    # Returns an *unexpanded* list of directories.
+    #
+    # @return [Array<String>] unexpanded directory list
     def list
-      to_a
+      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.
@@ -85,6 +107,32 @@ module XDG
       map{ |dir| Pathname.new(dir) }
     end
 
+    # This is same as #env, but also includes default values.
+    #
+    # @return [String] envinronment value.
+    def to_s
+      environment_variables.map{ |v| ENV[v] || DEFAULTS[v] }.join(':')
+    end
+
+    # @return [Pathname] pathname of first directory
+    def to_path
+      Pathname.new(to_a.first)
+    end
+
+    #
+    attr :subdirectory
+
+    #
+    def subdirectory=(path)
+      @subdirectory = path.to_s
+    end
+
+    #
+    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
@@ -98,7 +146,7 @@ module XDG
     def glob(*glob_and_flags)
       glob, flags = *parse_arguments(*glob_and_flags)
       find = []
-      list.each do |dir|
+      to_a.each do |dir|
         glob.each do |pattern|
           find.concat(Dir.glob(File.join(dir, pattern), flags))
         end
@@ -123,7 +171,7 @@ module XDG
     def select(*glob_and_flags, &block)
       glob, flag = *parse_arguments(*glob_and_flags)
       find = []
-      list.each do |dir|
+      to_a.each do |dir|
         path = File.join(dir, *glob)
         hits = Dir.glob(path, flag)
         hits = hits.select(&block) if block_given?
@@ -139,7 +187,7 @@ module XDG
     def find(*glob_and_flags, &block)
       glob, flag = *parse_arguments(*glob_and_flags)
       find = nil
-      list.each do |dir|
+      to_a.each do |dir|
         path = File.join(dir, *glob)
         hits = Dir.glob(path, flag)
         hits = hits.select(&block) if block_given?
@@ -149,35 +197,6 @@ module XDG
       find
     end
 
-    # @return [String] envinronment values.
-    def to_s
-      environment_variables.map{ |v| ENV[v] || DEFAULTS[v] }.join(':')
-    end
-
-    # @return [Pathname] pathname of first directory
-    def to_path
-      Pathname.new(to_s)
-    end
-
-    #
-    def env
-      environment_variables.map{ |v| ENV[v] }.join(':')
-    end
-
-    #
-    attr :subdirectory
-
-    #
-    def subdirectory=(path)
-      @subdirectory = path.to_s
-    end
-
-    #
-    def with_subdirectory(path)
-      @subdirectory = path if path
-      self
-    end
-
   private
 
     def parse_arguments(*glob_and_flags)

data/lib/xdg/version.rb

@@ -1,3 +1,3 @@
 module XDG
-  VERSION = '1.0.0'
+  VERSION = '2.1.0'
 end

data/qed/{02_base_dir_extended.rb → 02_base_dir_extended.rdoc}

@@ -7,11 +7,14 @@ The extended base directory standard provides
 == Resource
 
     XDG['RESOURCE_HOME'].env.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 user's home directory under `.local`.
 
+    XDG['RESOURCE_HOME'].list.assert == ['~/.local']
+
     XDG['RESOURCE_HOME'].to_a.assert == [$froot + 'home/joe/.local']
 
 
@@ -20,20 +23,26 @@ our joe user's home directory under `.local`.
 The working configuration directory
 
     XDG['CONFIG_WORK'].env.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 directory's `.config` or `config` directory.
 
-    XDG['CONFIG_WORK'].to_a.assert == ['.config', 'config']
+    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'].env.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 directory's `.tmp` or `tmp` directory.
 
-    XDG['CONFIG_WORK'].to_a.assert == ['.tmp', 'tmp']
+    XDG['CACHE_WORK'].list.assert == ['.tmp', 'tmp']
+
+    XDG['CACHE_WORK'].to_a.assert == [Dir.pwd + '/.tmp', Dir.pwd + '/tmp']
 

data/qed/{03_base_dir_mixin.rb → 03_base_dir_mixin.rdoc}

@@ -15,5 +15,5 @@ access to a named subdirectory of the XDG directories.
 
     c = MyAppConfig.new
 
-    c.config.home.to_s  #=> '~/.config/myapp'
+    c.config.home.to_a  #=> [$froot + 'home/joe/.config/myapp']
 

data/qed/applique/ae.rb

@@ -0,0 +1 @@
+AE.ansi = false

data/qed/applique/fakeroot.rb

@@ -4,6 +4,8 @@ dir = File.expand_path(File.dirname(File.dirname(__FILE__)))
 
 $froot = File.join(dir, 'fixtures/fakeroot/')
 
+p $froot
+
 #
 ENV['HOME']            = $froot + 'home/joe'
 #ENV['XDG_DATA_HOME']   = $froot + '.local/share'

metadata

@@ -2,7 +2,7 @@
 name: xdg
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -41,8 +41,9 @@ files:
 - lib/xdg/version.rb
 - lib/xdg.rb
 - qed/01_base_dir.rdoc
-- qed/02_base_dir_extended.rb
-- qed/03_base_dir_mixin.rb
+- qed/02_base_dir_extended.rdoc
+- qed/03_base_dir_mixin.rdoc
+- qed/applique/ae.rb
 - qed/applique/fakeroot.rb
 - qed/fixtures/fakeroot/etc/xdg/bar.config
 - qed/fixtures/fakeroot/home/.cache/foo.cache