xdg 0.4.0 → 0.5.0

data/CHANGES

@@ -0,0 +1,39 @@
+== 0.0.4 / 2008-10-26
+
+* 9 Other Enhancements
+
+    * removed xdg_ prefixes and replaced _file methods with _find and _glob methods (#d414dfa6fef6ec382c76689116b4483cbbcafd72)
+    * prepare for v0.4 release (#c634ffd603b0859027dd4bfd9c1c57b87d634d9c)
+    * remove some old commented-out code (#f62bac03f2ffe31e8a95d841be234311f7cfbff0)
+    * fixed data_find and data_glob (#8107b5b5b8893d040c6bd60ae9a0d65d6885ae84)
+    * Update RELEASE file. (#722f7600f403c39792c3df91ad789c5d3ae13473)
+    * updated documentation for 0.4 release (#c535b36186a6a3d2b1ea5766a07e541ec90a75d1)
+    * added MANIFEST to .gitignore (#723be0082d9a1e9a0f579aa094267027e1708730)
+    * correction or RELEASE (#0f3bd5f80c241704b338037b1bb66b0fbd8e597b)
+    * Fixed plural in RELEASE file. (#ccdf281610d5339aa1bff32be34c8369f204e463)
+
+
+== 0.0.3 / 2008-10-11
+
+* 5 Other Enhancements
+
+    * removed xdg_ prefix from module methods (#240e88d385ee1b7e063e8cd87e22ce8fb085afd8)
+    * moved web/index.html to doc directory (#e61b13e66eefb16566ea5f1ce3723dbfda8369dc)
+    * updated reap serives (#5cfaf1f6ad47ecc518047053902ef4e092c69891)
+    * prepare for next release (#7566509dd82d9cfe3bf28e32bdb68304429ebe93)
+    * fixed issue of xdg_ prefix still being used internally (#ad95493af4413e864cfa2ef2f982c7f48f371473)
+
+
+== 0.0.1 / 2008-09-27
+
+* 1 Major Enhancements
+
+    * Started project.  (#10ca99f20bd90399220a68939f4a04677ff22402)
+
+* 4 Other Enhancements
+
+    * added gitignore (#8d1385c2bcc0acbdb5ed5e014c977213caf7d4a6)
+    * Folio namespace is not used. (#577aca3700f5cc179a343068863a0a964133159e)
+    * added website (#067510f4af2c7deb3c3ac27832e0980b17af1695)
+    * VERSION file has been added. (#c76940fd4e79270d247a881a2a0e58a2f2fa9bdf)
+

data/MANIFEST

@@ -9,6 +9,7 @@ test/fakeroot/etc
 test/fakeroot/etc/xdg
 test/fakeroot/etc/xdg/bar.config
 test/test_xdg.rb
+CHANGES
 RELEASE
 README
 HISTORY
@@ -16,7 +17,6 @@ meta
 meta/homepage
 meta/summary
 meta/abstract
-meta/releases
 meta/title
 meta/authors
 meta/contact

data/README

@@ -19,13 +19,17 @@ XDG is a module with a small set of easy to use methods:
 
   XDG.config_home
   XDG.config_dirs
+  XDG.config_find(pattern){ |path| ... }
+  XDG.config_select(pattern){ |path| ... }
+
   XDG.data_home
   XDG.data_dirs
-  XDG.cache_home
+  XDG.data_find(pattern){ |path| ... }
+  XDG.data_select(pattern){ |path| ... }
 
-  XDG.data_file(file)
-  XDG.config_file(file)
-  XDG.cache_file(file)
+  XDG.cache_home
+  XDG.cache_find(pattern){ |path| ... }
+  XDG.cache_select(pattern){ |path| ... }
 
   XDG.config_work
   XDG.data_work
@@ -43,8 +47,8 @@ Using RubyGems:
 Installing the tarball requires Ruby Setup
 (see http://setup.rubyforge.org).
 
-  $ tar -xvzf xdg-0.4.1
-  $ cd xdg-0.4.1
+  $ tar -xvzf xdg-0.5.0
+  $ cd xdg-0.5.0
   $ sudo setup.rb all
 
 == Development

data/RELEASE

@@ -1,21 +1,29 @@
-= XDG 0.4 hits the streets!
+= XDG 0.5
 
   http://xdg.rubyforge.org
 
-This release removes the xdg_ prefix from the instance-level
-method names. Now module and instance levels are the same.
+XDG provides a module for supporting the XDG Base Directory
+Standard[1].
 
-Also, data_file, config_file and cache_file have been replaced with
-data_find, config_find, cache_find, data_glob, config_glob and
-cache_glob.
+If your program utilizes user or system-wide support files
+(eg. configuration files), you owe it to yourself to checkout
+the XDG standard.
 
-What' next? Well, I can't say I'm fond of the term 'glob', so I
-may rename that to 'map' or 'collect' (or 'select'?)  and then 
-add the ability to use blocks for matching too.
+In this release, _glob methods were renamed to _select and now
+can take a selection block in addition to, or as opposed to,
+the glob pattern argument.
 
+What's next? The API should be stable now. I do not forsee
+and reasons for it to change. In the future, I may add some
+additonal ruby-esque features, but that should be purely
+in addition to what is already there. If all this holds true
+for a hwile a 1.0 release will be forth-coming.
 
-### 0.4.0 / 2008-10-26
+[1]http://standards.freedesktop.org/basedir-spec/basedir-spec-0.6.html 
 
-* Renamed instance level methods without 'xdg_' prefix.
-* Replace _file methods with _find and _glob methods.
+---
+
+### 0.5.0 / 2008-10-28
+
+* Renamed *_glob methods to *_select, and added block option.
 

data/VERSION

@@ -1 +1 @@
-xdg 0.4.0 beta (2008-10-26)
+xdg 0.5.0 beta (2008-10-26)

data/lib/xdg.rb

@@ -1,8 +1,3 @@
-# :Title: XDG
-# :Author: &trans;
-# :Copyright: (c)2008 Tiger Ops
-# :License: GPLv3
-
 # = XDG Base Directory Standard
 #
 # This provides a conveient library for conforming to the
@@ -28,13 +23,14 @@
 # files. Like var/ in FHS.
 #
 # This module returns paths as strings.
-
+#
 module XDG
 
   extend self    #module_function
 
+  # Returns user's home directory.
   def home
-    ENV['HOME'] || File.expand_path('~')
+    File.expand_path('~') # ENV['HOME']
   end
 
   # Location of user's personal config directory.
@@ -77,12 +73,31 @@ module XDG
   end
 
   # Find a file or directory in data dirs.
-  def data_find(*glob_and_flags)
-    data_glob(*glob_and_flags).first
+  #
+  # See: +data_select+.
+  #
+  def data_find(*glob_and_flags, &block)
+    data_select(*glob_and_flags, &block).first
   end
 
-  def data_glob(*glob_and_flags)
+  # Return array of matching files or directories
+  # in any of the data locations.
+  #
+  # This starts with the user's home directory
+  # and then searches system directories.
+  #
+  # String parameters are joined into a pathname
+  # while Integers and Symbols treated as flags.
+  #
+  # For example, the following are equivalent:
+  #
+  #   XDG.data_select('stick/units', File::FNM_CASEFOLD)
+  #
+  #   XDG.data_select('stick', 'uits', :casefold)
+  #
+  def data_select(*glob_and_flags, &block)
     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}")
@@ -93,7 +108,11 @@ module XDG
     find = []
     [data_home, *data_dirs].each do |dir|
       path = File.join(dir, *glob)
-      find.concat(Dir.glob(path, flag))
+      if block_given?
+        find.concat(Dir.glob(path, flag).select(&block))
+      else
+        find.concat(Dir.glob(path, flag))
+      end
     end
     find
   end
@@ -101,9 +120,10 @@ module XDG
   # Return the fist matching file or directory
   # from the config locations.
   #
-  # See +config_glog+.
-  def config_find(*glob_and_flags)
-    config_glob(*glob_and_flags).first
+  # See: +config_select+.
+  #
+  def config_find(*glob_and_flags, &block)
+    config_select(*glob_and_flags, &block).first
   end
 
   # Return array of matching files or directories
@@ -117,12 +137,13 @@ module XDG
   #
   # For example, the following are equivalent:
   #
-  #   XDG.config_glob('sow/plugins', File::FNM_CASEFOLD)
+  #   XDG.config_select('sow/plugins', File::FNM_CASEFOLD)
   #
-  #   XDG.config_glob('sow', 'plugins', :casefold)
+  #   XDG.config_select('sow', 'plugins', :casefold)
   #
-  def config_glob(*glob_and_flags)
+  def config_select(*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}")
@@ -133,7 +154,11 @@ module XDG
     find = []
     [config_home, *config_dirs].each do |dir|
       path = File.join(dir, *glob)
-      find.concat(Dir.glob(path, flag))
+      if block_given?
+        find.concat(Dir.glob(path, flag).select(&block))
+      else
+        find.concat(Dir.glob(path, flag))
+      end
     end
     find
   end
@@ -141,9 +166,10 @@ module XDG
   # Return the fist matching file or directory
   # in the cache directory.
   #
-  # See +cache_glog+.
-  def cache_find(*glob_and_flags)
-    cache_glob(*glob_and_flags).first
+  # See: +cache_select+.
+  #
+  def cache_find(*glob_and_flags, &block)
+    cache_select(*glob_and_flags, &block).first
   end
 
   # Return array of matching files or directories
@@ -154,12 +180,13 @@ module XDG
   #
   # For example, the following are equivalent:
   #
-  #   XDG.cache_glob('sow/tmp', File::FNM_CASEFOLD)
+  #   XDG.cache_select('sow/tmp', File::FNM_CASEFOLD)
   #
-  #   XDG.cache_glob('sow', 'tmp', :casefold)
+  #   XDG.cache_select('sow', 'tmp', :casefold)
   #
-  def cache_glob(*glob_and_flags)
+  def cache_select(*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}")
@@ -168,7 +195,11 @@ module XDG
       end
     end
     path = File.join(cache_home,*glob)
-    Dir.glob(path, flag)
+    if block_given?
+      Dir.glob(path, flag).select(&block)
+    else
+      Dir.glob(path, flag)
+    end
   end
 
   #--
@@ -199,3 +230,8 @@ module XDG
 
 end # module XDG
 
+# :Title: XDG
+# :Author: &trans;
+# :Copyright: (c)2008 Tiger Ops
+# :License: GPLv3
+

data/test/test_xdg.rb

@@ -60,23 +60,23 @@ class TestXDG < Test::Unit::TestCase
 
   # Test the glob methods.
 
-  def test_data_glob
+  def test_data_select
     file = 'foo.dat'
-    assert_equal(File.join(Dir.pwd,'home/.local/share', file), XDG.data_find(file))
+    assert_equal([File.join(Dir.pwd,'home/.local/share', file)], XDG.data_select(file))
     file = 'bar.dat'
-    assert_equal([File.join(Dir.pwd,'usr/share', file)], XDG.data_glob(file))
+    assert_equal([File.join(Dir.pwd,'usr/share', file)], XDG.data_select(file))
   end
 
-  def test_config_glob
+  def test_config_select
     file = 'foo.config'
-    assert_equal([File.join(Dir.pwd,'home/.config', file)], XDG.config_glob(file))
+    assert_equal([File.join(Dir.pwd,'home/.config', file)], XDG.config_select(file))
     file = 'bar.config'
-    assert_equal([File.join(Dir.pwd,'etc/xdg', file)], XDG.config_glob(file))
+    assert_equal([File.join(Dir.pwd,'etc/xdg', file)], XDG.config_select(file))
   end
 
-  def test_cache_glob
+  def test_cache_select
     file = 'foo.cache'
-    assert_equal([File.join(Dir.pwd,'home/.cache', file)], XDG.cache_glob(file))
+    assert_equal([File.join(Dir.pwd,'home/.cache', file)], XDG.cache_select(file))
   end
 
   # Test the working directory variations.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xdg
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - tigerops-community@rubyforge.org
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-26 00:00:00 -04:00
+date: 2008-10-28 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -23,6 +23,7 @@ extensions: []
 extra_rdoc_files: 
 - README
 - MANIFEST
+- CHANGES
 - RELEASE
 - HISTORY
 - VERSION
@@ -32,6 +33,7 @@ files:
 - meta
 - test
 - MANIFEST
+- CHANGES
 - RELEASE
 - README
 - HISTORY
@@ -41,7 +43,6 @@ files:
 - meta/homepage
 - meta/summary
 - meta/abstract
-- meta/releases
 - meta/title
 - meta/authors
 - meta/contact

data/meta/releases

@@ -1 +0,0 @@
-