maid-xdg 2.2.1.1 → 2.2.1.2

data/lib/xdg/base_dir/extended.rb

@@ -0,0 +1,20 @@
+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,2011 Thomas Sawyer
+# Distributed under the terms of the APACHE 2.0 license.

data/lib/xdg/base_dir/global_variables.rb

@@ -0,0 +1,18 @@
+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')
+

data/lib/xdg/base_dir/legacy.rb

@@ -0,0 +1,72 @@
+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

data/lib/xdg/base_dir/mixin.rb

@@ -0,0 +1,84 @@
+module XDG
+  class BaseDir
+    #
+    # The BaseDir::Mixin module can be used to add XDG base directory
+    # methods to your own classes.
+    #
+    #     class MyAppConfig
+    #       include XDG::BaseDir::Mixin
+    #
+    #       def subdirectory
+    #         'myapp'
+    #       end
+    #     end
+    #
+    #     c = MyAppConfig.new
+    #
+    #     c.config.home.list  #=> ['~/.config/myapp']
+    #
+    module Mixin
+
+      # @todo do we need this?
+      extend self
+
+      # Override this method to change the subdirectory of the mixin.
+      def subdirectory
+        nil
+      end
+
+      #
+      def home
+        File.expand_path('~')
+      end
+
+      #
+      def data
+        obj = XDG['DATA'].with_subdirectory(subdirectory)
+        class << obj
+          def home
+            XDG['DATA_HOME'].with_subdirectory(subdirectory)
+          end
+          def dirs
+            XDG['DATA_DIRS'].with_subdirectory(subdirectory)
+          end
+        end
+        return obj
+      end
+
+      #
+      def config
+        obj = XDG['CONFIG'].with_subdirectory(subdirectory)
+        class << obj
+          def home
+            XDG['CONFIG_HOME'].with_subdirectory(subdirectory)
+          end
+          def dirs
+            XDG['CONFIG_DIRS'].with_subdirectory(subdirectory)
+          end
+          def work
+            XDG['CONFIG_WORK'].with_subdirectory(subdirectory)
+          end
+        end
+        return obj
+      end
+
+      #
+      def cache
+        obj = XDG['CACHE'].with_subdirectory(subdirectory)
+        class << obj
+          def home
+            XDG['CACHE_HOME'].with_subdirectory(subdirectory)
+          end
+          def dirs
+            XDG['CACHE_DIRS'].with_subdirectory(subdirectory)
+          end
+          def work
+            XDG['CACHE_WORK'].with_subdirectory(subdirectory)
+          end
+        end
+        return obj
+      end
+
+    end
+  end
+end

data/lib/xdg/version.rb

@@ -0,0 +1,3 @@
+module XDG
+  VERSION = '2.2.1.2'
+end

data/test/fakeroot/.cache/DUMMY.txt

@@ -0,0 +1 @@
+Just here to provide a file for github to keep this directory.

data/test/fakeroot/etc/xdg/bar.config

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

data/test/fakeroot/home/.cache/foo.cache

@@ -0,0 +1 @@
+FOO.CACHE

data/test/fakeroot/home/.local/share/foo.dat

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

data/test/fakeroot/usr/share/bar.dat

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

data/test/test_xdg_legacy.rb

@@ -0,0 +1,117 @@
+$:.unshift 'lib'
+
+require 'xdg/base_dir/legacy'
+require 'test/unit'
+
+# run test from fakeroot directory.
+Dir.chdir(File.join(File.dirname(__FILE__), 'fakeroot'))
+
+ENV['HOME']            = File.join(Dir.pwd, 'home')
+ENV['XDG_DATA_DIRS']   = File.join(Dir.pwd, 'usr/share')
+ENV['XDG_CONFIG_DIRS'] = File.join(Dir.pwd, 'etc/xdg')
+
+class TestXDG < Test::Unit::TestCase
+
+  # Test the standard paths.
+
+  def test_home
+    assert_equal(File.join(Dir.pwd,'home'), XDG.home)
+  end
+
+  def test_config_home
+    assert_equal(File.join(Dir.pwd,'home/.config'), XDG.config.home)
+  end
+
+  def test_config_dirs
+    assert_equal([File.join(Dir.pwd,"etc/xdg")], XDG.config.dirs)
+  end
+
+  def test_data_home
+    assert_equal(File.join(Dir.pwd,'home/.local/share'), XDG.data.home)
+  end
+
+  def test_data_dirs
+    assert_equal([File.join(Dir.pwd,'usr/share')], XDG.data.dirs)
+  end
+
+  def test_cache_home
+    assert_equal(File.join(Dir.pwd,'home/.cache'), XDG.cache.home)
+  end
+
+  # Test the find methods.
+
+  def test_data_find
+    file = 'foo.dat'
+    assert_equal(File.join(Dir.pwd,'home/.local/share', file), XDG.data.find(file))
+    file = 'bar.dat'
+    assert_equal(File.join(Dir.pwd,'usr/share', file), XDG.data.find(file))
+  end
+
+  def test_config_find
+    file = 'foo.config'
+    assert_equal(File.join(Dir.pwd,'home/.config', file), XDG.config.find(file))
+    file = 'bar.config'
+    assert_equal(File.join(Dir.pwd,'etc/xdg', file), XDG.config.find(file))
+  end
+
+  def test_cache_find
+    file = 'foo.cache'
+    assert_equal(File.join(Dir.pwd,'home/.cache', file), XDG.cache.find(file))
+  end
+
+  # Test the glob methods.
+
+  def test_data_select
+    file = 'foo.dat'
+    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.select(file))
+  end
+
+  def test_config_select
+    file = 'foo.config'
+    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.select(file))
+  end
+
+  def test_cache_select
+    file = 'foo.cache'
+    assert_equal([File.join(Dir.pwd,'home/.cache', file)], XDG.cache.select(file))
+  end
+
+  # Test the glob methods.
+
+  def test_data_glob
+    file = 'foo.dat'
+    assert_equal([File.join(Dir.pwd,'home/.local/share', file)], XDG.data.glob(file))
+    file = 'bar.dat'
+    assert_equal([File.join(Dir.pwd,'usr/share', file)], XDG.data.glob(file))
+  end
+
+  def test_config_glob
+    file = 'foo.config'
+    assert_equal([File.join(Dir.pwd,'home/.config', file)], XDG.config.glob(file))
+    file = 'bar.config'
+    assert_equal([File.join(Dir.pwd,'etc/xdg', file)], XDG.config.glob(file))
+  end
+
+  def test_cache_glob
+    file = 'foo.cache'
+    assert_equal([File.join(Dir.pwd,'home/.cache', file)], XDG.cache.glob(file))
+  end
+
+  # Test the working directory variations.
+
+  def test_config_work
+    result = [File.join(Dir.pwd,'.config'), File.join(Dir.pwd,'config')]
+    assert_equal(result, XDG.config.work)
+  end
+
+  def test_cache_work
+    result = [File.join(Dir.pwd,'.tmp'), File.join(Dir.pwd,'tmp')]
+    assert_equal(result, XDG.cache.work)
+  end
+
+end
+

data/xdg.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xdg/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "maid-xdg"
+  gem.version       = XDG::VERSION
+  gem.authors       = ["Trans (RubyWorks)"]
+  gem.email         = ["transfire@gmail.com"]
+  gem.description   = %q{XDG provides an interface for using XDG directory standard.}
+  gem.summary       = %q{XDG provides an interface for using XDG directory standard.}
+  gem.homepage      = "http://rubyworks.github.com/xdg"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'detroit'
+  gem.add_development_dependency 'qed'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maid-xdg
 version: !ruby/object:Gem::Version
-  version: 2.2.1.1
+  version: 2.2.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &12121500 !ruby/object:Gem::Requirement
+  requirement: &17817400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12121500
+  version_requirements: *17817400
 - !ruby/object:Gem::Dependency
   name: qed
-  requirement: &12120360 !ruby/object:Gem::Requirement
+  requirement: &17816900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,14 +32,52 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12120360
+  version_requirements: *17816900
 description: XDG provides an interface for using XDG directory standard.
 email:
 - transfire@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- .travis.yml
+- .yardopts
+- Assembly
+- COPYING.rdoc
+- DEMO.rdoc
+- Gemfile
+- HISTORY.rdoc
+- LICENSE.txt
+- MANIFEST
+- README.rdoc
+- Rakefile
+- demo/01_base_dir.rdoc
+- demo/02_base_dir_extended.rdoc
+- demo/03_base_dir_mixin.rdoc
+- demo/applique/ae.rb
+- demo/applique/fakeroot.rb
+- demo/applique/xdg.rb
+- demo/fixtures/fakeroot/.cache/DUMMY.txt
+- demo/fixtures/fakeroot/etc/xdg/bar.config
+- demo/fixtures/fakeroot/home/.cache/foo.cache
+- demo/fixtures/fakeroot/home/.local/share/foo.dat
+- demo/fixtures/fakeroot/home/joe/foo.txt
+- demo/fixtures/fakeroot/usr/share/bar.dat
+- lib/xdg.rb
+- lib/xdg/base_dir.rb
+- lib/xdg/base_dir/extended.rb
+- lib/xdg/base_dir/global_variables.rb
+- lib/xdg/base_dir/legacy.rb
+- lib/xdg/base_dir/mixin.rb
+- lib/xdg/version.rb
+- test/fakeroot/.cache/DUMMY.txt
+- test/fakeroot/etc/xdg/bar.config
+- test/fakeroot/home/.cache/foo.cache
+- test/fakeroot/home/.local/share/foo.dat
+- test/fakeroot/usr/share/bar.dat
+- test/test_xdg_legacy.rb
+- xdg.gemspec
 homepage: http://rubyworks.github.com/xdg
 licenses: []
 post_install_message: 
@@ -64,4 +102,10 @@ rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: XDG provides an interface for using XDG directory standard.
-test_files: []
+test_files:
+- test/fakeroot/.cache/DUMMY.txt
+- test/fakeroot/etc/xdg/bar.config
+- test/fakeroot/home/.cache/foo.cache
+- test/fakeroot/home/.local/share/foo.dat
+- test/fakeroot/usr/share/bar.dat
+- test/test_xdg_legacy.rb