platonic_config 0.1.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage
+doc
+.yardoc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in platonic_config.gemspec
+gemspec

data/README.md

@@ -0,0 +1,113 @@
+# Platonic Config
+A mixin to allow easy class and instance level configuration, with easy
+defaults.
+
+## Installation
+
+```shell
+gem install platonic_config
+```
+
+## Example Usage
+
+```ruby
+require 'platonic_config'
+class MyAwesomeShirt
+  include PlatonicConfig
+  define_options :color => 'red', :size => 'large', :logo => nil
+end
+
+MyAwesomeShirt.color # => 'red'
+MyAwesomeShirt.color 'blue'
+MyAwesomeShirt.color # => 'blue'
+
+MyAwesomeShirt.config do |c|
+  c.size 'large'
+end
+
+MyAwesomeShirt.size # => 'large'
+
+shirt = MyAwesomeShirt.new
+
+shirt.config do |c|
+  c.logo 'Batman'
+  c.size 'medium'
+end
+
+shirt.logo # => 'Batman'
+shirt.options # => { :color => 'red', :size => 'medium', :logo => 'Batman' }
+
+MyAwesomeShirt.reset_defaults
+MyAwesomeShirt.options # => :color => 'red', :size => 'large', :logo => nil
+another_shirt = MyAwesomeShirt.new
+another_shirt.options # => :color => 'red', :size => 'large', :logo => nil
+```
+
+## Usage
+
+To start using PlatonicConfig, include the module in your class, and set
+the default configuration values.
+
+```ruby
+class C
+  include PlatonicConfig
+  define_options :opt1 => 'foo', :opt2 => 'bar'
+end
+```
+
+### On the class
+
+From this point on, your class will respond to all these configuration
+options, and be able to be configured using a block.
+
+```ruby
+C.config do |c|
+  c.opt1 'spam'
+end
+```
+
+Any individual option can be queried with the option name, or all
+options can be looked at with "options".
+
+```ruby
+C.opt1    # => 'spam'
+C.options # => { :opt1 => 'foo', :opt2 => 'bar' }
+```
+
+To reset configuration to the defaults you specified, call
+reset_defaults.
+
+```ruby
+C.reset_defaults
+```
+
+
+### On the instance
+
+Any new instances of your class can be configured independently
+
+```ruby
+instance = C.new
+instance.config do |c|
+  c.opt2 'bananas'
+end
+```
+
+All options are merged with the options set in the class, with the
+instance variables overriding. Any of these options can be queried
+individually, or examined all at once.
+
+```ruby
+instance.opt2 # => 'bananas'
+instance.options # => { :opt1 => 'foo', :opt2 => 'bananas' }
+```
+
+To clear the options set on the instance (and letting the class defaults
+come through), call reset_defaults.
+
+```ruby
+instance.reset_defaults
+```
+
+
+

data/Rakefile

@@ -0,0 +1,25 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--format nested --color']
+end
+
+desc "Run RSpec with code coverage"
+task :coverage do
+  ENV['COVERAGE'] = "true"
+  Rake::Task["spec"].execute
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = %w(lib/**/*.rb)
+  end
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yard, you must: gem install yard"
+  end
+end

data/lib/platonic_config.rb

@@ -0,0 +1,103 @@
+require "platonic_config/version"
+
+
+module PlatonicConfig
+
+  # Give the options defined on the instance merged with the class-level defaults
+  def options
+    self.class.options.merge instance_options
+  end
+
+  # return just the options set on the instance
+  def instance_options
+    @options ||= {}
+  end
+
+  # convenience method to allow for block level configuration
+  def configure
+    yield self
+    self
+  end
+  alias config configure
+
+  # Set up configuration methodss on the base class
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  # Allow calls directly on the object to configuration keys
+  # Ex: define_options :foo => bar
+  # instance.foo
+  def method_missing(sym,*args,&block)
+    if self.class.options.has_key? sym
+      if args.length == 1
+        instance_options[sym] = args[0]
+      end
+      options[sym]
+    else
+      super
+    end
+  end
+
+  # Let respond_to? answer for symbols defined in the options
+  def respond_to?(sym)
+    if self.class.options.has_key? sym
+      true
+    else
+      super
+    end
+  end
+
+  # Reset all config values set on the instance
+  def reset_defaults
+    @options = {}
+  end
+
+  module ClassMethods
+    # Define the options and defaults for this coniguration
+    def define_options(options = {})
+      @default_options = options
+      reset_defaults
+    end
+
+    # return the set of configured options
+    def options
+      @options
+    end
+
+    # set all configured options back to their default values
+    def reset_defaults
+      @options = @default_options.dup
+    end
+
+    # Allow calls directly on the object to configuration keys
+    # Ex: define_options :foo => bar
+    # Class.foo
+    def method_missing(sym,*args,&block)
+      if @options.has_key? sym
+        if args.length == 1
+          @options[sym] = args[0]
+        end
+        @options[sym]
+      else
+        super
+      end
+    end
+
+    # Let respond_to? answer for symbols defined in the options
+    def respond_to?(sym)
+      if @options.has_key? sym
+        true
+      else
+        super
+      end
+    end
+
+    # convenience method to allow for block level configuration
+    def configure
+      yield self
+      self
+    end
+    alias config configure
+  end
+end

data/lib/platonic_config/version.rb

@@ -0,0 +1,5 @@
+# Placeholder module for versioning
+module PlatonicConfig
+  # Version of the module
+  VERSION = "0.1.1"
+end

data/platonic_config.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "platonic_config/version"
+
+Gem::Specification.new do |s|
+  s.name        = "platonic_config"
+  s.version     = PlatonicConfig::VERSION
+  s.authors     = ["Ryan Sorensen"]
+  s.email       = ["rcsorensen@gmail.com"]
+  s.homepage    = "http://github.com/rcs/platonic_config"
+  s.summary     = %q{Easy per class and per instance configuration}
+  s.description = %q{Platonic makes it easy to stop worrying about the implementation details of class configuration}
+
+  s.rubyforge_project = "platonic_config"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "rspec"
+end

data/spec/platonic_config_spec.rb

@@ -0,0 +1,121 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "PlatonicConfig" do
+  describe "basic use" do
+    it "can be mixed in" do
+      expect {
+        Class.new.send(:include, PlatonicConfig)
+      }.to_not raise_error
+    end
+  end
+  describe "on the class" do
+    before :each do
+      @klass = Class.new do
+        include PlatonicConfig
+        define_options :color => nil, :size => nil
+      end
+    end
+
+    it "exposes the config methods" do
+      @klass.respond_to? :color
+    end
+
+    it "doesn't bork method_missing" do
+      expect {
+        @klass.not_a_method
+      }.to raise_error NoMethodError
+    end
+
+    it "doesn't bork respond_to?" do
+      @klass.respond_to?(:not_a_method).should_not be_true
+    end
+
+    it "returns a hash of the options" do
+      @klass.options.should == { :color => nil, :size => nil }
+    end
+
+    it "exposes the config methods in the instance" do
+      @klass.new.respond_to? :color
+    end
+
+    it "stores configuration values" do
+      @klass.color "red"
+      @klass.color.should == "red"
+    end
+
+    it "resets configuration values" do
+      @klass.color "red"
+      @klass.reset_defaults
+      @klass.color.should be_nil
+    end
+
+    it "exposes options in instances" do
+      @klass.new.options.should == { :color => nil, :size => nil }
+    end
+
+    it "exposes class values in instances" do
+      @klass.color "red"
+      @klass.new.color.should == "red"
+    end
+
+    it "can be configured with a block" do
+      @klass.config do |c|
+        c.color "chartreuse"
+      end
+
+      @klass.color.should == "chartreuse"
+    end
+
+    describe "for the instance" do
+      before :each do
+        @instance = @klass.new
+      end
+
+      it "allows overriding in instances" do
+        @klass.color "red"
+        @instance.color "blue"
+        @instance.color.should == "blue"
+      end
+
+      it "merges options in instances" do
+        @klass.color "red"
+        @instance.size "large"
+        @instance.options.should == { :color => "red", :size => "large" }
+      end
+
+      it "doesn't allow different instances to effect each other" do
+        a = @klass.new
+        a.color "brown"
+        b = @klass.new
+        b.color "black"
+        a.color.should == "brown"
+        b.color.should == "black"
+      end
+      it "can be configured with a block" do
+        @instance.config do |c|
+          c.size "middling"
+        end
+        @instance.size.should == "middling"
+      end
+
+      it "resets only instance values" do
+        @klass.color 'crimson'
+        @instance.color 'vermillion'
+        @instance.color.should == 'vermillion'
+        @instance.reset_defaults
+        @instance.color.should == 'crimson'
+      end
+
+      it "doesn't bork method_missing" do
+        expect {
+          @instance.not_a_method
+        }.to raise_error NoMethodError
+      end
+
+      it "doesn't bork respond_to?" do
+        @instance.respond_to?(:not_a_method).should_not be_true
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end if ENV['COVERAGE']
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'platonic_config'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: platonic_config
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Sorensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70133964734180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133964734180
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70133964733760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133964733760
+description: Platonic makes it easy to stop worrying about the implementation details
+  of class configuration
+email:
+- rcsorensen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/platonic_config.rb
+- lib/platonic_config/version.rb
+- platonic_config.gemspec
+- spec/platonic_config_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rcs/platonic_config
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: platonic_config
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Easy per class and per instance configuration
+test_files:
+- spec/platonic_config_spec.rb
+- spec/spec_helper.rb