xdg 2.1.0 → 2.2.0

data/.ruby

@@ -1,36 +1,36 @@
 --- 
-name: xdg
-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
+spec_version: 1.0.0
+replaces: []
+
 loadpath: 
 - lib
-manifest: Manifest.txt
-requires: 
-- name: qed
-  version: 0+
-  group: 
-  - test
-conflicts: []
+name: xdg
+repositories: {}
 
-replaces: []
+conflicts: []
 
 engine_check: []
 
-organization: RubyWorks
+title: XDG
 contact: Thomas Sawyer <transfire@gmail.com>
-created: 2008-09-27
-copyright: Copyright (c) 2008,2011 Thomas Sawyer
+resources: 
+  code: http://github.com/rubyworks/xdg
+  home: http://rubyworks.github.com/xdg
+maintainers: []
+
+requires: 
+- group: 
+  - test
+  name: qed
+  version: 0+
+manifest: Manifest.txt
+version: 2.2.0
 licenses: 
 - Apache 2.0
+copyright: Copyright (c) 2008,2011 Thomas Sawyer
 authors: 
 - Thomas Sawyer
-maintainers: []
-
-resources: 
-  home: http://rubyworks.github.com/xdg
-  code: http://github.com/rubyworks/xdg
-repositories: {}
-
-spec_version: 1.0.0
+organization: RubyWorks
+description: XDG provides a module for supporting the XDG Base Directory Standard. See http://standards.freedesktop.org/basedir-spec/basedir-spec-0.6.html
+summary: XDG provides an interface for using XDG directory standard.
+created: 2008-09-27

data/HISTORY.rdoc

@@ -1,5 +1,18 @@
 = RELEASE HISTORY
 
+== 2.2.0 / 2011-06-11
+
+This release changes BaseDir#to_s to return the first directory
+entry, and moves the old #to_s to #environment_with_defaults
+with an alias of #env. The old #env now being called #environment.
+
+Changes:
+
+* Rename #env to #environment.
+* Rename #to_s to #environment_with_defaults.
+* Modify #to_s to return first directory.
+
+
 == 2.1.0 / 2011-06-10
 
 This release changes the BaseDir#list method, where as it used

data/lib/xdg/base_dir/mixin.rb

@@ -14,7 +14,7 @@ module XDG
     #
     #     c = MyAppConfig.new
     #
-    #     c.config.home.to_s  #=> '~/.config/myapp'
+    #     c.config.home.list  #=> ['~/.config/myapp']
     #
     module Mixin
 

data/lib/xdg/base_dir.rb

@@ -48,13 +48,24 @@ module XDG
       @environment_variables
     end
 
-    # The equivalent environment setting.
+    # The environment setting, or it's equivalent when the BaseDir
+    # is a combination of environment variables.
     #
     # @return [String] evnironment vsetting
-    def env
+    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 :env, :environment_with_defaults
+
     # Returns a complete list of expanded directories.
     #
     # @return [Array<String>] expanded directory list
@@ -107,27 +118,33 @@ module XDG
       map{ |dir| Pathname.new(dir) }
     end
 
-    # This is same as #env, but also includes default values.
+    # 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] envinronment value.
+    # @return [String] directory
     def to_s
-      environment_variables.map{ |v| ENV[v] || DEFAULTS[v] }.join(':')
+      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

data/lib/xdg/version.rb

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

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xdg
 version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: 
-  version: 2.1.0
+  segments: 
+  - 2
+  - 2
+  - 0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-09 00:00:00 Z
+date: 2011-06-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: qed
@@ -20,6 +25,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id001
@@ -77,12 +85,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []