kelredd-pathsconfig 0.1.0

data/README.rdoc

@@ -0,0 +1,48 @@
+= Pathsconfig
+
+== Description
+
+A ruby gem to help configure dynamic file paths for classes in a easy way.
+
+== Installation
+
+    sudo gem install kelredd-pathsconfig --source http://gems.github.com
+
+== Usage
+
+    # 1. Require the library
+    require 'pathsconfig'
+    
+    # 2. Create a paths config file in ./config/paths.yml or ./paths.yml
+    
+    # 3. Have a class that needs those paths
+    class Foo
+    
+    end
+    
+    # 4. Get sweet methods to generate those paths dynamically!
+
+== License
+
+Copyright (c) 2009 Kelly Redding
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/pathsconfig/version'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'pathsconfig'
+  s.version          = Pathsconfig::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "A ruby gem to help configure dynamic file paths for classes in a easy way."
+  s.author           = 'Kelly Redding'
+  s.email            = 'kelly@kelredd.com'
+  s.homepage         = 'http://code.kelredd.com'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib}/**/*")
+  # s.executables    = ['pathsconfig']
+  
+  # s.add_dependency('gem_name', '~> 0.0.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new(:coverage) do |t|
+    t.libs       = ['test']
+    t.test_files = FileList["test/**/*_test.rb"]
+    t.verbose    = true
+    t.rcov_opts  = ['--text-report', "-x #{Gem.path}", '-x /Library/Ruby', '-x /usr/lib/ruby']
+  end
+  
+  task :default => :coverage
+  
+rescue LoadError
+  warn "\n**** Install rcov (sudo gem install relevance-rcov) to get coverage stats ****\n"
+  task :default => :test
+end
+
+
+desc 'Generate the gemspec to serve this gem'
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "test/features --format pretty" 
+end

data/lib/pathsconfig.rb

@@ -0,0 +1,7 @@
+%w(yaml).each do |lib|
+  require lib
+end
+
+%w(extensions exceptions configuration base).each do |file|
+  require File.join(File.dirname(__FILE__), 'pathsconfig', "#{file}.rb")
+end

data/lib/pathsconfig/base.rb

@@ -0,0 +1,48 @@
+module Pathsconfig
+  module Base
+    
+    module ClassMethods
+      
+    end
+    
+    module InstanceMethods
+
+      def path_array(path_name)
+        raise Pathsconfig::ConfigError, "Pathsconfig has not been configured." unless Pathsconfig.config
+        raise Pathsconfig::ModelError, "class '#{self.class.name}' does not respond to the 'path_config' method." unless self.class.respond_to?(:path_config)
+        path_value = Pathsconfig.config[self.class.path_config.to_sym][path_name.to_sym]
+        if path_value.kind_of?(Hash)
+          raise Pathsconfig::ModelError, "multiple path types are configured and this model does not respond to the 'path_type' method." unless self.respond_to?(:path_type)
+          raise Pathsconfig::ModelError, "an '#{self.path_type}' type of the '#{path_name}' path has not been configured" if path_value[self.path_type.to_sym].nil?
+          path_value[self.path_type.to_sym].collect{ |exp| eval(exp) }.flatten
+        elsif path_value.kind_of?(Array)
+          path_value.collect{ |exp| eval(exp) }.flatten
+        elsif path_value.blank?
+          raise Pathsconfig::ModelError, "'#{path_name}' is not configured for #{self.class.name}"
+        else
+          raise Pathsconfig::ModelError, "'#{path_name}' is incorrectly configured for #{self.class.name}"
+        end
+      end
+
+      def path_string(path_name, options={})
+        options ||= {}
+        options[:type] ||= :system
+        options[:root] ||= Pathsconfig.root
+
+        case options[:type].to_sym
+        when :system
+          File.join((options[:root] + self.path_array(path_name)).compact)
+        else
+          ""
+        end
+      end
+      
+    end
+    
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+    
+  end
+end

data/lib/pathsconfig/configuration.rb

@@ -0,0 +1,35 @@
+module Pathsconfig
+  
+  @@config = nil
+  @@root = ""
+  
+  def self.config=(path)
+    begin
+      @@config = YAML.load_file(File.expand_path(path))
+      raise Pathsconfig::ConfigError, "Could not load paths configuration file: the config must be entered as a Hash" unless @@config.kind_of?(Hash)
+      @@config.symbolize_keys!
+    rescue Errno::ENOENT => err
+      raise Pathsconfig::ConfigError, "Could not load paths configuration file: #{err.message}"
+    rescue ArgumentError => err
+      raise Pathsconfig::ConfigError, "Could not load paths configuration file: #{err.message}"
+    end
+  end
+  
+  def self.config
+    @@config
+  end
+  
+  def self.clear
+    @@config = nil
+  end
+
+  def self.root=(path)
+    @@root = path
+  end
+  
+  def self.root
+    @@root
+  end
+  
+end
+

data/lib/pathsconfig/exceptions.rb

@@ -0,0 +1,12 @@
+module Pathsconfig
+  
+  class PathsconfigError < ::StandardError
+  end
+  
+  class ConfigError < PathsconfigError
+  end
+
+  class ModelError < PathsconfigError
+  end
+
+end

data/lib/pathsconfig/extensions.rb

@@ -0,0 +1,43 @@
+module Pathsconfig
+  module Extensions
+    module Hash
+      
+      module ClassMethods
+
+        unless ::Hash.respond_to?('symbolize_keys')
+          # inspired by from ActiveSupport::CoreExtensions::Hash::Keys (http://api.rubyonrails.org/)
+          def symbolize_keys(hash)
+            hash.keys.each{ |key| hash[(key.to_sym rescue key)] ||= hash.delete(key) }
+            hash
+          end
+        end
+        
+      end
+      
+      module InstanceMethods
+        
+        unless {}.respond_to?('symbolize_keys')
+          # Return a new hash with all keys converted to strings.
+          def symbolize_keys
+            self.class.symbolize_keys(self.clone)
+          end
+          # Destructively convert all keys to strings. 
+          def symbolize_keys!
+            self.class.symbolize_keys(self)
+          end
+        end
+
+      end
+      
+      def self.included(receiver)
+        receiver.extend         ClassMethods
+        receiver.send :include, InstanceMethods
+      end
+    
+    end
+  end
+end
+
+class Hash
+  include Pathsconfig::Extensions::Hash
+end

data/lib/pathsconfig/version.rb

@@ -0,0 +1,13 @@
+module Pathsconfig
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: kelredd-pathsconfig
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kelly Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: kelly@kelredd.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/pathsconfig
+- lib/pathsconfig/base.rb
+- lib/pathsconfig/configuration.rb
+- lib/pathsconfig/exceptions.rb
+- lib/pathsconfig/extensions.rb
+- lib/pathsconfig/version.rb
+- lib/pathsconfig.rb
+has_rdoc: false
+homepage: http://code.kelredd.com
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A ruby gem to help configure dynamic file paths for classes in a easy way.
+test_files: []
+