xdg 1.0.0 → 2.0.0

data/.ruby

@@ -0,0 +1,33 @@
+--- 
+name: xdg
+version: 2.0.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: []
+
+conflicts: []
+
+replaces: []
+
+engine_check: []
+
+organization: RubyWorks
+contact: Thomas Sawyer <transfire@gmail.com>
+created: 2008-09-27
+copyright: Copyright (c) 2008 Thomas Sawyer
+licenses: 
+- Apache 2.0
+authors: 
+- Thomas Sawyer
+maintainers: []
+
+resources: 
+  home: http://rubyworks.github.com/xdg
+  code: http://github.com/rubyworks/xdg
+repositories: {}
+
+spec_version: 1.0.0

data/APACHE2.txt

@@ -0,0 +1,204 @@
+.
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+

data/{HISTORY → HISTORY.rdoc}

@@ -1,5 +1,19 @@
 = RELEASE HISTORY
 
+== 2.0.0 / 2011-06-09
+
+Major new release is full rewrite of the API, with an eye out for
+support future XDG standards beyond the base directories. The
+new API uses a single point of entry `XDG[]` (a shortcut for
+`XDG::BaseDir[]`).
+
+Changes:
+
+* Complete rewrite of API.
+* Utilize single point of entry interface.
+* Structure project for future support of more of XDG.
+
+
 == 1.0.0 / 2009-12-01
 
 This is major reimplementation of the XDG API to be more flexiable

data/README.rdoc

@@ -0,0 +1,149 @@
+= XDG Standards for Ruby
+
+Author::    Thomas Sawyer
+Copyright:: (c) 2011 Thomas Sawyer
+License::   Apache 2.0
+
+
+== Introduction
+
+XDG provides an easy to use Ruby library for working with XDG standards.
+
+Presently, it only supports the XDG Base Directory Standard.
+
+If your program utilizes user or system-wide support files
+(e.g. configuration files), you owe it to yourself to checkout
+the XDG base directory standard.
+
+You can learn more about the standard at:
+http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
+
+
+== Resources
+
+* {Homepage}[http://rubyworks.github.com/xdg]
+* {Source Code}[http://github.com/rubyworks/xdg]
+* {Report an Issue}[http://github.com/rubyworks/xdg/issues]
+* {Mailing List}[http://googlegroups.com/group.rubyworks-mailinglist]
+
+
+== How to Use
+
+For working with XDG base directories, XDG provides a very simple
+yet flexible interface, `XDG[]`. Let's say you want to work
+with the $XDG_CONFIG_HOME directory. Simply use:
+
+    XDG['CONFIG_HOME']
+
+This will give you access to a number of useful methods all tied
+into the user's personal configuration directory. Some examples:
+
+    XDG['CONFIG_HOME'].glob(pattern)
+    XDG['CONFIG_HOME'].select(pattern){ |path| ... }
+    XDG['CONFIG_HOME'].find(pattern){ |path| ... }
+
+The same holds true for the other base directories.
+
+    XDG['DATA_HOME']
+    XDG['DATA_DIRS']
+
+    XDG['CACHE_HOME']
+    XDG['CACHE_DIRS']
+
+By leaving out the last qualifier, XDG will provide an interface
+that ties into both the `HOME` and `DIRS` paths.
+
+    XDG['DATA']
+    XDG['CONFIG']
+    XDG['CACHE']
+
+If you know XDG these are pretty much self-explanatory.
+But see the YARD-based API documentation for further specifics.
+
+=== Extended Functionality
+
+The Ruby XDG module also provides extended functionality
+not part of the standard specification. These extensions are
+simply add-on functionality deemed useful, or implementations
+of  proposals being discussed for a possible future version of
+the standard.
+
+    XDG['CONFIG_WORK']
+    XDG['CACHE_WORK']
+
+See the API documentation to learn more. Note that the extended modules
+are subject to greater potential for change as they are still being refined.
+
+=== Base Directory Mixin
+
+XDG provides a convenient base directory mixin that can provide handy a
+interface to a classes.
+
+    class MyAppConfig
+      include XDG::BaseDir::Mixin
+
+      def subdirectory
+        'myapp'
+      end
+    end
+
+    c = MyAppConfig.new
+
+    c.config.home.to_s  #=> '~/.config/myapp'
+
+
+=== Legacy API
+
+Version 2.0+ of library marks are major departure from the earlier
+"fluid" notations of previous versions. Where as one used to do:
+
+    XDG.data.home
+
+With the new API one now does:
+
+    XDG['DATA_HOME']
+
+This was done for a few reasons, but primarily because it reflects more
+closely Ruby's interface to the environment variables themselves, e.g.
+
+    ENV['XDG_DATA_HOME']
+
+If you prefer the older style, a compatibility layer is provided. You will
+need to load:
+
+    require 'xdg/base_dir/legacy'
+
+However we STRONGLY RECOMMEND that you do not use the legacy API --use it only
+if you need to keep some old code working and don't have time to update it at
+them moment. Sometime in the future the legacy API will be deprecated.
+
+
+== How to Install
+
+Using RubyGems:
+
+    $ sudo gem install xdg
+
+Installing the tarball requires Ruby Setup (see http://rubyworks.github.com/setup).
+
+    $ tar -xvzf xdg-0.5.2
+    $ cd xdg-0.5.2
+    $ sudo setup.rb all
+
+
+== Development
+
+GitHub[http://github.com] hosts our {source code}[http://github.com/rubyworks/xdg]
+and {issue ticket system}[http://github.com/rubyworks/xdg/issues].
+
+To contribute to the project please fork the repository, ideally, create a new
+topic branch for your work, and submit a pull request.
+
+
+== Copyright & License
+
+Copyright (c) 2008, 2011 Thomas Sawyer
+
+Distributed under the terms of the Apache 2.0 license.
+
+See APACHE2.txt file for details.

data/lib/xdg.rb

@@ -1,6 +1,4 @@
-require 'rbconfig'
-
-# = XDG Base Directory Standard
+# XDG Base Directory Standard
 #
 # This provides a conveient library for conforming to the
 # XDG Base Directory Standard.
@@ -26,233 +24,23 @@ require 'rbconfig'
 # The module returns all paths as String.
 #
 module XDG
-
-  #module_function
-  extend self
-
-  # Returns user's home directory.
-  #
-  def home
-    File.expand_path('~') # ENV['HOME']
-  end
-
-  # Access to data resource locations.
-  #
-  #   XDG.data.each{ |dir| ... }
-  #
-  def data(*glob_and_flags, &block)
-    if !glob_and_flags.empty? or block_given?
-      Data.select(*glob_and_flags, &block)
-    else
-      Data
-    end
-  end
-
-  # Access to configuration locations.
-  #
-  #   XDG.config.each{ |dir| ... }
-  #
-  def config(*glob_and_flags, &block)
-    if !glob_and_flags.empty? or block_given?
-      Config.select(*glob_and_flags, &block)
-    else
-      Config
-    end
-  end
-
-  # Access to cache locations.
-  #
-  #   XDG.cache.each{ |dir| ... }
-  #
-  def cache(*glob_and_flags, &block)
-    if !glob_and_flags.empty? or block_given?
-      Cache.select(*glob_and_flags, &block)
-    else
-      Cache
-    end
-  end
-
-  # Each directory set shares these common methods.
-  #
-  module Common
-
-    # Returns a complete list of directories, starting
-    # with the home location and moving outward.
-    def list
-      [home, *dirs]
-    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 = []
-      list.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.data.select('stick/units', File::FNM_CASEFOLD)
-    #
-    #   XDG.data.select('stick', 'units', :casefold)
-    #
-    def select(*glob_and_flags, &block)
-      glob, flag = *parse_arguments(*glob_and_flags)
-      find = []
-      list.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
-      list.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
-
+  if RUBY_VERSION > '1.9'
+    require_relative 'xdg/version'
+    require_relative 'xdg/base_dir'
+    require_relative 'xdg/base_dir/extended'
+    require_relative 'xdg/base_dir/mixin'
+  else
+    require 'xdg/version'
+    require 'xdg/base_dir'
+    require 'xdg/base_dir/extended'
+    require 'xdg/base_dir/mixin'
   end
 
-  # = DATA LOCATIONS
   #
-  module Data
-    include Common
-
-    # Location of personal data directory.
-    def home
-      @home ||= (
-        File.expand_path(
-          ENV['XDG_DATA_HOME'] || File.join(XDG.home, '.local', 'share')
-        )
-      )
-    end
-
-    # List of shared data directores.
-    def dirs
-      @dirs ||= (
-        dirs = ENV['XDG_DATA_DIRS'].split(/[:;]/)
-        if dirs.empty?
-          #dirs = [ Config::CONFIG['localdatadir'], Config::CONFIG['datadir'] ]
-          dirs = Resource.dirs.map{ |d| File.join(d, 'share') }
-        end
-        dirs = dirs.map{ |d| File.expand_path(d) }.uniq
-        dirs = dirs.select{ |d| File.directory?(d) }
-        dirs
-      )
-    end
-
-    extend self
+  def self.[](*env_path)
+    BaseDir.new(*env_path)
   end
+end
 
-  # = CONFIGUTATION LOCATIONS
-  #
-  module Config
-    include Common
-    extend self
-
-    # Location of personal config directory.
-    def home
-      @home ||= (
-        File.expand_path(
-          ENV['XDG_CONFIG_HOME'] || File.join(XDG.home, '.config')
-        )
-      )
-    end
-
-    # List of shared config directories.
-    def dirs
-      @dirs ||= (
-        dirs = ENV['XDG_CONFIG_DIRS'].to_s.split(/[:;]/)
-        if dirs.empty?
-          #dirs = ['etc/xdg', 'etc']
-          sysconfdir = ::Config::CONFIG['sysconfdir']
-          dirs = [ File.join(sysconfdir, 'xdg'), sysconfdir ]
-        end
-        dirs = dirs.map{ |d| File.expand_path(d) }.uniq
-        dirs = dirs.select{ |d| File.directory?(d) }
-        dirs
-      )
-    end
-
-    extend self
-  end
-
-  # = CACHE LOCATIONS
-  #
-  module Cache
-    include Common
-
-    # Location of user's personal cache directory.
-    def home
-      @home ||= (
-        File.expand_path(
-          ENV['XDG_CACHE_HOME'] || File.join(XDG.home, '.cache')
-        )
-      )
-    end
-
-    # Serves as a no-op, since there are no common cache directories
-    # defined by the XDG standard. (Though one might argue that 
-    # <tt>tmp/</tt> is one.)
-    def dirs
-      @dirs ||= []
-    end
-
-    extend self
-  end
-
-end # module XDG
-
-# Copyright (c) 2008,2009 Thomas Sawyer
-# Distributed under the terms of the LGPL v3.
+# Copyright (c) 2008,2011 Thomas Sawyer
+# Distributed under the terms of the APACHE 2.0 license.