tcravit_ruby_lib 0.0.3 → 0.0.4

data/lib/tcravit_ruby_lib/app_config.rb

@@ -0,0 +1,70 @@
+module TcravitRubyLib #:nodoc:
+
+  # Simple and Flexible Configuration Data Storage.
+  #
+  # AppConfig provides a simple facility for storing configuration data in
+  # an application. It does this using metaprogramming techniques to define
+  # accessor methods dynamically when the configuration file is loaded.
+  #
+  # This is far from the best way to do this, and was written as an exercise
+  # in metaprogramming as much as anything else.
+  #
+  # === Example
+  # 
+  #     TcravitRubyLib::AppConfig.configure do
+  #         some_value 1023
+  #         another_value "Foo"
+  #     end
+  #     
+  #     TcravitRubyLib::AppConfig.some_value      # => 1023
+  #     TcravitRubyLib::AppConfig.some_value = 2048
+  #     TcravitRubyLib::AppConfig.some_value     # => 2048
+  #      
+  # Author:: Tammy Cravit (mailto:tammy@tammycravit.com)
+  # Copyright:: Copyright (c) 2011, Tammy Cravit. All rights reserved.
+  # License:: This program is free software: you can redistribute it and/or modify
+  #           it under the terms of the GNU General Public License as published by
+  #           the Free Software Foundation, either version 3 of the License, or
+  #           (at your option) any later version.
+  
+  module AppConfig
+    extend self
+    
+    def configure(&block)
+      @definitions ||= Hash.new
+
+      # The method_missing auto-trigger should only run when we're inside
+      # a configure block
+      @in_config = true
+      instance_eval &block
+      @in_config = false
+    end
+    
+    def remove!(key)
+      the_sym = key.to_sym
+      @definitions.delete(the_sym)
+      send :undef_method, the_sym
+      send :undef_method, "#{the_sym.to_s}=".to_sym      
+    end
+    
+    def method_missing(methname, *args)
+      if (methname.to_s =~ /^([A-Za-z0-9][A-Za-z0-9\-\_]+)$/)
+        if @in_config
+          getter_method_name = methname.to_s.to_sym
+          setter_method_name = "#{methname}=".to_s.to_sym
+          send :define_method, getter_method_name do
+            @definitions[getter_method_name]
+          end
+          send :define_method, setter_method_name do |new_value|
+            @definitions[getter_method_name] = new_value
+          end
+          send setter_method_name, (args.count > 0 ? args.first : nil)
+        else
+          super
+        end
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/tcravit_ruby_lib/config_searcher.rb

@@ -3,7 +3,7 @@ require 'pathname'
 module TcravitRubyLib #:nodoc:
 
   # Utilities for locating a configuration directory within a tree.
-  # 
+  #
   # Unix utilities such as +git+ will look for the .git directory in a 
   # project by starting with the current directory and traversing upward
   # until a .git folder is found. This allows local configuration in a 
@@ -11,6 +11,13 @@ module TcravitRubyLib #:nodoc:
   #
   # This module, inspired by a post on Practicing Ruby, implements that 
   # kind of traversal for Ruby applications.
+  #
+  # Author:: Tammy Cravit (mailto:tammy@tammycravit.com)
+  # Copyright:: Copyright (c) 2011, Tammy Cravit. All rights reserved.
+  # License:: This program is free software: you can redistribute it and/or modify
+  #           it under the terms of the GNU General Public License as published by
+  #           the Free Software Foundation, either version 3 of the License, or
+  #           (at your option) any later version.  
   module ConfigSearcher
 
     # Locate a configuration folder by starting in the specified directory

data/lib/tcravit_ruby_lib/version.rb

@@ -1,3 +1,3 @@
 module TcravitRubyLib
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/tcravit_ruby_lib.rb

@@ -1,5 +1,6 @@
 require "tcravit_ruby_lib/version"
 require 'tcravit_ruby_lib/config_searcher'
+require 'tcravit_ruby_lib/app_config'
 
 module TcravitRubyLib # :nodoc:
 end

data/spec/tcravit_ruby_lib/app_config_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe "TcravitRubyLib::AppConfig" do
+    
+  STRING_VAL = "string"
+  NUMERIC_VAL = 18293
+  SYMBOLIC_VAL = :squid
+  
+  before(:all) do
+    TcravitRubyLib::AppConfig.configure do
+      string_value STRING_VAL
+      numeric_value NUMERIC_VAL
+      symbol_value SYMBOLIC_VAL
+    end
+  end
+  
+  it "should return the values for defined properties" do
+    TcravitRubyLib::AppConfig.string_value.should == STRING_VAL
+    TcravitRubyLib::AppConfig.numeric_value.should == NUMERIC_VAL
+    TcravitRubyLib::AppConfig.symbol_value.should == SYMBOLIC_VAL      
+  end
+  
+  it "should raise an error for undefined properties" do
+    lambda { TcravitRubyLib::AppConfig.fishpaste_value }.should raise_error
+  end
+  
+  it "should allow me to change a configuration property" do
+    TcravitRubyLib::AppConfig.string_value = "new value"
+    TcravitRubyLib::AppConfig.string_value.should == "new value"
+  end
+  
+  it "should allow me to remove a configuration property" do
+    TcravitRubyLib::AppConfig.remove!(:string_value)
+    lambda { TcravitRubyLib::AppConfig.string_value }.should raise_error
+  end
+  
+  it "should allow additional properties to be added" do
+    TcravitRubyLib::AppConfig.configure do
+      another_value 192
+    end
+    TcravitRubyLib::AppConfig.configure do
+      and_another_value 384
+    end
+    TcravitRubyLib::AppConfig.another_value.should == 192
+    TcravitRubyLib::AppConfig.and_another_value.should == 384
+  end
+  
+end

data/spec/tcravit_ruby_lib/config_searcher_spec.rb

@@ -1,56 +1,54 @@
 require 'spec_helper'
 require 'fileutils'
 
-describe "TcravitRubyLib" do
-  describe "ConfigSearcher" do
-  
-    BASE_DIR   = '/tmp/config_searcher_test'
-    DEEP_DIR   = "#{BASE_DIR}/foo/bar/baz"
-    CONFIG_DIR = "#{BASE_DIR}/.config"
-  
-    before(:all) do
-      FileUtils.mkdir_p DEEP_DIR
-      FileUtils.mkdir_p CONFIG_DIR
-    end
-  
-    after(:all) do
-      FileUtils.remove_dir BASE_DIR, true
-    end
-  
-    it "should successfully find a directory which exists" do
-      dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: DEEP_DIR, look_for: ".config")
-      dir_path.to_s.should_not be_nil
-      dir_path.to_s.should == CONFIG_DIR
-    end
+describe "TcravitRubyLib::ConfigSearcher" do
+
+  BASE_DIR   = '/tmp/config_searcher_test'
+  DEEP_DIR   = "#{BASE_DIR}/foo/bar/baz"
+  CONFIG_DIR = "#{BASE_DIR}/.config"
+
+  before(:all) do
+    FileUtils.mkdir_p DEEP_DIR
+    FileUtils.mkdir_p CONFIG_DIR
+  end
+
+  after(:all) do
+    FileUtils.remove_dir BASE_DIR, true
+  end
+
+  it "should successfully find a directory which exists" do
+    dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: DEEP_DIR, look_for: ".config")
+    dir_path.to_s.should_not be_nil
+    dir_path.to_s.should == CONFIG_DIR
+  end
+
+  it "should not find a directory when one doesn't exist" do
+    dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: DEEP_DIR, look_for: ".snausages")
+    dir_path.to_s.should == ""    
+  end
+
+  it "should return the container dir when the only_container_dir option is provided" do
+    dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: DEEP_DIR, look_for: ".config", only_container_dir: true)
+    dir_path.to_s.should == BASE_DIR
+  end
   
-    it "should not find a directory when one doesn't exist" do
-      dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: DEEP_DIR, look_for: ".snausages")
-      dir_path.to_s.should == ""    
-    end
+  it "should raise an exception when the start_in directory doesn't exist" do
+    an_exception = nil
   
-    it "should return the container dir when the only_container_dir option is provided" do
-      dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: DEEP_DIR, look_for: ".config", only_container_dir: true)
-      dir_path.to_s.should == BASE_DIR
-    end
-    
-    it "should raise an exception when the start_in directory doesn't exist" do
-      an_exception = nil
-    
-      begin
-        dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: "#{DEEP_DIR}xxxxxxx", look_for: ".snausages")
-      rescue => e
-        an_exception = e
-      end
-    
-      an_exception.should_not be_nil
-      an_exception.message.should == "No such file or directory - #{DEEP_DIR}xxxxxxx"
+    begin
+      dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: "#{DEEP_DIR}xxxxxxx", look_for: ".snausages")
+    rescue => e
+      an_exception = e
     end
   
-    it "should behave the same for the alternative option names" do
-      dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_dir: DEEP_DIR, config_dir: ".config")
-      dir_path.to_s.should_not be_nil
-      dir_path.to_s.should == CONFIG_DIR
-    end
+    an_exception.should_not be_nil
+    an_exception.message.should == "No such file or directory - #{DEEP_DIR}xxxxxxx"
+  end
+
+  it "should behave the same for the alternative option names" do
+    dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_dir: DEEP_DIR, config_dir: ".config")
+    dir_path.to_s.should_not be_nil
+    dir_path.to_s.should == CONFIG_DIR
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tcravit_ruby_lib
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-02 00:00:00.000000000Z
+date: 2011-12-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70224760100280 !ruby/object:Gem::Requirement
+  requirement: &70216638519080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70224760100280
+  version_requirements: *70216638519080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70224760099360 !ruby/object:Gem::Requirement
+  requirement: &70216638518460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70224760099360
+  version_requirements: *70216638518460
 description: 
 email:
 - tcravit@taylored-software.com
@@ -47,9 +47,11 @@ files:
 - README.md
 - Rakefile
 - lib/tcravit_ruby_lib.rb
+- lib/tcravit_ruby_lib/app_config.rb
 - lib/tcravit_ruby_lib/config_searcher.rb
 - lib/tcravit_ruby_lib/version.rb
 - spec/spec_helper.rb
+- spec/tcravit_ruby_lib/app_config_spec.rb
 - spec/tcravit_ruby_lib/config_searcher_spec.rb
 - tcravit_ruby_lib.gemspec
 homepage: ''
@@ -78,5 +80,6 @@ specification_version: 3
 summary: Random reusable ruby stuff
 test_files:
 - spec/spec_helper.rb
+- spec/tcravit_ruby_lib/app_config_spec.rb
 - spec/tcravit_ruby_lib/config_searcher_spec.rb
 has_rdoc: