config_newton 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Bleigh
+
+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/README.rdoc

@@ -0,0 +1,80 @@
+= ConfigNewton
+
+A common pattern for Ruby libraries is to have some kind of configuration that can be set at the library level. ConfigNewton is a simple library that provides a user-friendly way to expose that configuration.
+
+== Installation
+
+    gem install config_newton
+    
+== Usage
+
+    require 'config_newton'
+    
+    # The library author sets it up like this:
+    
+    module MyLibrary
+      include ConfigNewton
+      
+      configurable do
+        property :email
+        property :special_sauce, :default => true
+      end
+    end
+    
+    # And the end user can set it like this:
+    
+    MyLibrary.configure do |config|
+      config.email = 'dude@somewhere.com'
+      config.special_sauce = false
+    end
+    
+    # And the library author can use it like this:
+    
+    module MyLibrary
+      class Client
+        # ... somewhere in the code ...
+        MyLibrary.config.email # => 'dude@somewhere.com'
+      end
+    end
+    
+== Other Useful Bits
+
+There are a few other useful features of ConfigNewton. For instance, you can convert the configuration to a hash at any time, or just access it like one:
+
+    MyLibrary.config.to_hash # => {:email => 'dude@somewhere.com', :special_sauce => false}
+    MyLibrary[:special_sauce] # => false
+    
+You can also load user settings from a YAML file quite easily. Let's say you're developing a Rails plugin. You can easily load a <tt>config</tt> directory YAML file like this:
+    
+    MyLibrary.config.load_from("#{Rails.root}/config/my_library.yml", Rails.env)
+    
+The second argument specified is the "root key" for the configuration, allowing you to easily specify environments or other conditions. Using our examples above the user would create a YAML file in <tt>config/my_library.yml</tt> and populate it like this:
+
+    development:
+      email: just@testing.com
+      special_sauce: false
+    
+    production
+      email: bob@example.com
+      special_sauce: true
+      
+== Roadmap
+
+There's still further I'd like to take this library, here are a few thoughts:
+
+Hierarchical Configuration :: Create multi-level configurations that retain an intuitive interface both for the library developer and the user.
+Typed Configurations :: Implement a simple casting system to automatically convert values into desired types.
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Intridea, Inc. and Michael Bleigh. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "config_newton"
+    gem.summary = %Q{A simple tool to add class-level configuration to libraries.}
+    gem.description = %Q{Library authors can now easily add class-level configuration including YAML loading with just a few lines of code.}
+    gem.email = "michael@intridea.com"
+    gem.homepage = "http://github.com/intridea/config_newton"
+    gem.authors = ["Michael Bleigh"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "config_newton #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/config_newton.rb

@@ -0,0 +1,133 @@
+module ConfigNewton
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.class_eval do
+      @configuration = ConfigNewton::Configuration.new
+    end
+  end
+  
+  module ClassMethods
+    # Configure the class either with a hash
+    # or by providing a block. See the documentation
+    # for Configuration#set.
+    def configure(options = {}, &block)
+      config.set(options, &block)
+    end
+    
+    # A list of configurable properties.
+    def configurables
+      configuration.properties
+    end
+    
+    # The configuration object.
+    def configuration
+      @configuration
+    end
+    alias :config :configuration
+    
+    protected
+    
+    # Add either a single configurable property to
+    # the class/module or provide a block that will
+    # allow you to set multiple at once.
+    #
+    # <b>Example:</b>
+    #
+    #     
+    def configurable(property = nil, options = {}, &block)
+      if block_given?
+        @configuration.instance_eval(&block)
+      else
+        @configuration.add(property, options)
+      end
+    end
+  end
+  
+  class Configuration
+    def initialize
+      @hash = {}
+      @properties = []
+      @defaults = {}
+    end
+    
+    attr_reader :properties
+    
+    # Add a new property that can be set and read
+    # on this configuration.
+    #
+    # <b>Options:</b>
+    #
+    # <tt>:default</tt> :: Specify a default value.
+    def add(name, options = {})
+      raise ArgumentError, "Property name cannot be blank." unless name && name != ""
+      @properties << name.to_sym
+      @defaults[name.to_sym] = options[:default] if options[:default]
+      self.class.class_eval <<-RUBY
+        def #{name}
+          self[:#{name}]
+        end
+        
+        def #{name}=(value)
+          self[:#{name}] = value
+        end
+      RUBY
+    end
+    alias :property :add
+    
+    # Read an individual property on the configuration.
+    def [](property)
+      @hash[property.to_sym] || @defaults[property.to_sym]
+    end
+    
+    # Set an individual property on the configuration.
+    def []=(property, value)
+      @hash[property.to_sym] = value
+    end
+    
+    # Converts the configuration into a symbol-keyed
+    # hash.
+    def to_hash
+      @defaults.merge(@hash)
+    end
+    
+    # Set the properties of the configuration
+    # either by providing a hash or by providing
+    # a block. The block will yield a configuration
+    # object that has method setters and getters.
+    #
+    # Example:
+    # 
+    #     MyClass.config.set do |config|
+    #       config.property = 123
+    #     end
+    def set(properties = {}, &block)
+      if block_given?
+        yield self
+      else
+        @hash.merge!(properties.inject({}){|h,(k,v)| h[k.to_sym] = v; h})
+      end
+      self
+    end
+    
+    # Load configuration from a YAML string. Provide
+    # a root node if you want something other than
+    # the entire yaml document to be utilized. For
+    # example, in Rails, you might provide the 
+    # Rails environment as a root node.
+    def load(yaml_string, root_node = nil)
+      hash = YAML::load(yaml_string)
+      set(root_node ? hash[root_node] : hash)
+    end
+    
+    # Load configuration from a YAML file specified
+    # by the path given (or a file pointer). Provide
+    # a root node if you want something other than
+    # the entire yaml document to be utilized. For
+    # example, in Rails, you might provide the 
+    # Rails environment as a root node.
+    def load_from(file_or_path, root_node = 'configuration')
+      hash = YAML::load_file(file_or_path)
+      set(root_node ? hash[root_node] : hash)
+    end
+  end
+end

data/spec/config_newton/configuration_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe ConfigNewton::Configuration do
+  subject { ConfigNewton::Configuration.new }
+  
+  describe '#add' do
+    it 'should be able to add properties' do
+      subject.add(:abc)
+      subject.abc.should be_nil
+    end
+    
+    it 'should be able to have a default' do
+      subject.add(:abc, :default => 123)
+      subject.abc.should == 123
+    end
+    
+    it 'should raise an ArgumentError if no name is passed' do
+      lambda{subject.add}.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe '#to_hash' do
+    it 'should be able to convert to a hash' do
+      subject.add(:foo, :default => 123)
+      subject.add(:bar)
+      subject.add(:baz, :default => 890)
+      subject.bar = 456
+      subject.baz = 789
+      subject.to_hash.should == {
+        :foo => 123,
+        :bar => 456,
+        :baz => 789
+      }
+    end
+  end
+  
+  it 'should be able to read and write to properties' do
+    subject.add(:abc)
+    subject.abc = 123
+    subject.abc.should == 123
+  end
+  
+  
+  describe '#[]' do
+    before do
+      subject.add(:abc)
+      subject.abc = 123
+    end
+    
+    it 'should retrieve set values' do
+      subject[:abc].should == 123
+    end
+    
+    it 'should convert to symbol' do
+      subject['abc'].should == 123
+    end
+  end
+  
+  describe '#[]=' do
+    before do
+      subject.add(:abc)
+    end
+    
+    it 'should set the value' do
+      subject[:abc] = 123
+    end
+    
+    it 'should convert to symbol' do
+      subject['abc'] = 123
+    end
+    
+    after do
+      subject[:abc].should == 123
+    end
+  end
+  
+  describe '#load' do
+    let(:yaml) {
+      <<-YAML
+      development:
+        email: bob@example.com
+        special_sauce: false
+      
+      production:
+        email: frank@example.com
+        special_sauce: false
+      YAML
+    }
+    
+    before do
+      subject.add(:email)
+      subject.add(:special_sauce, :default => true)
+    end
+    
+    it 'should be able to load from YAML' do
+      subject.load(yaml, 'development').email.should == 'bob@example.com'
+      subject.load(yaml, 'production').email.should == 'frank@example.com'
+    end
+  end
+end

data/spec/config_newton_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+class SampleClass
+  include ConfigNewton
+end
+
+describe ConfigNewton do
+  describe '.configure' do
+    before do
+      SampleClass.send(:configurable) do
+        property :foo, :default => 123
+        property :bar
+        property :baz, :default => 890
+      end
+    end
+    
+    it 'should define the configure method on the class' do
+      SampleClass.should be_respond_to(:configure)
+    end
+    
+    context 'setting values' do
+      before do
+        SampleClass.config[:foo] = nil
+        SampleClass.config[:bar] = nil
+      end
+      
+      it 'should accept a hash' do
+        SampleClass.configure(:foo => 330, :bar => 555)
+      end
+      
+      it 'should accept a block with an argument' do
+        SampleClass.configure do |config|
+          config.foo = 330
+          config.bar = 555
+        end
+      end
+      
+      after do
+        SampleClass.config.to_hash.should == {
+          :foo => 330,
+          :bar => 555,
+          :baz => 890
+        }
+      end
+    end
+    
+    it 'should accept a block with an argument' do
+      
+    end
+  end
+  
+  describe '.configurable' do
+    it 'should allow for configurables to be created' do
+      SampleClass.send(:configurable, :abc)
+      SampleClass.config.should be_respond_to(:abc)
+    end
+  
+    it 'should allow for block configurable creation' do
+      SampleClass.send(:configurable) do
+        property :abc, :default => 123
+        property :def
+      end
+    
+      SampleClass.config.should be_respond_to(:def)
+      SampleClass.config.abc.should == 123
+    end
+    
+    it 'should be protected' do
+      lambda{SampleClass.configurable(:abc)}.should raise_error(NoMethodError)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'config_newton'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: config_newton
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Library authors can now easily add class-level configuration including YAML loading with just a few lines of code.
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/config_newton.rb
+- spec/config_newton/configuration_spec.rb
+- spec/config_newton_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/intridea/config_newton
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple tool to add class-level configuration to libraries.
+test_files: 
+- spec/config_newton/configuration_spec.rb
+- spec/config_newton_spec.rb
+- spec/spec_helper.rb