fun_with_configurations 0.0.1

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.3.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "debugger"
+end
+
+gem "fun_with_files"

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Bryce Anderson
+
+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,19 @@
+= fun_with_configurations
+
+Description goes here.
+
+== Contributing to fun_with_configurations
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Bryce Anderson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fun_with_configurations"
+  gem.homepage = "http://github.com/darthschmoo/fun_with_configurations"
+  gem.license = "MIT"
+  gem.summary = "A quick and feisty configuration creator (e.g. MyClass.config)"
+  gem.description = <<-DESC
+Attach a configuration object to any object or class with code like this:
+   spy.install_fwc_config do
+     spy_id "74 Baker"
+DESC
+  gem.email = "keeputahweird@gmail.com"
+  gem.authors = ["Bryce Anderson"]
+  # dependencies defined in Gemfile
+  
+  gem.files = Dir.glob( File.join( ".", "lib", "**", "*.rb" ) ) + 
+              Dir.glob( File.join( ".", "test", "**", "*.*" ) ) +
+              [ "Gemfile", 
+                "Rakefile", 
+                "LICENSE.txt", 
+                "README.rdoc",
+                "VERSION"
+              ]
+  
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fun_with_configurations #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/fun_with/configurations/config.rb

@@ -0,0 +1,43 @@
+module FunWith
+  module Configurations
+    class KeyError < Exception
+    end
+    
+    class Config < Hash
+      def initialize( &block )
+        self.instance_exec( &block ) if block_given?
+      end
+    
+      def method_missing( method, *args, &block )
+        method = method.to_s.gsub( /=$/, '' ).to_sym
+        
+        if block_given?
+          self[method] = Config.new unless self[method].is_a?(Config)
+          self[method].instance_exec( &block )
+        elsif args.length > 0
+          self[method] = args.first
+        else
+          self[method]   
+        end
+      end
+      
+      def []( sym )
+        sym = sym.to_sym if sym.is_a?(String)
+        self.class.key_check( sym )
+        super( sym )
+      end
+      
+      def []=( sym, val )
+        sym = sym.to_sym if sym.is_a?(String)
+        self.class.key_check( sym )
+        super( sym, val )
+      end
+      
+      def self.key_check( sym )
+        @reserved_symbols ||= Hash.instance_methods
+        raise KeyError.new("#{sym} is not a symbol") unless sym.is_a?(Symbol)
+        raise KeyError.new("#{sym} is reserved for use by Hash") if @reserved_symbols.include?( sym )
+      end
+    end
+  end
+end

data/lib/fun_with/configurations/configurations.rb

@@ -0,0 +1,15 @@
+module FunWith
+  module Configurations
+    module Configurable
+      def config=( config )
+        @fwc_config = config
+      end
+    
+      def config( &block )
+        yield @fwc_config if block_given?
+        @fwc_config
+      end
+    end
+  end
+end
+

data/lib/fun_with/configurations/object.rb

@@ -0,0 +1,11 @@
+class Object
+  def install_fwc_config( config = nil, &block )
+    extend FunWith::Configurations::Configurable
+    self.config = config || FunWith::Configurations::Config.new( &block )
+    self.config
+  end
+  
+  def install_fwc_config_from_file( filename )
+    install_fwc_config( eval( File.read( filename ) ) )  # TODO: Has to be a better way than eval().  Dangerous.
+  end
+end

data/lib/fun_with_configurations.rb

@@ -0,0 +1,5 @@
+require 'fun_with_files'
+require_relative File.join( "fun_with", "configurations", "config" )
+require_relative File.join( "fun_with", "configurations", "configurations" )
+require_relative File.join( "fun_with", "configurations", "object" )
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fun_with_configurations'
+
+class Test::Unit::TestCase
+end

data/test/test_fun_with_configurations.rb

@@ -0,0 +1,94 @@
+require 'helper'
+
+class TestFunWithConfigurations < Test::Unit::TestCase
+  should "configurize a class" do
+    o = Object.new
+    o.install_fwc_config do
+      malaprop :sym
+      blocky do
+        fish :guts
+      end
+    end
+    
+    assert_equal :sym, o.config.malaprop
+    assert_equal :guts, o.config.blocky.fish
+  end
+  
+  context "testing a configurized class" do
+    setup do
+      @obj = Object.new
+      @obj.install_fwc_config do
+        a :b
+        b :c
+        c do
+          d :e
+          e :f
+          f :g
+        end
+      end
+    end
+    
+    should "verify existing configuration" do
+      assert_equal :b, @obj.config.a
+      assert_equal :g, @obj.config.c.f
+    end
+    
+    should "blockily extend configuration" do
+      @obj.config.c.g do
+        h :i
+        i :j
+        j do
+          k :l
+          m do
+            n :o
+          end
+        end
+      end
+      
+      assert_equal :i, @obj.config.c.g.h
+      assert_equal :o, @obj.config.c.g.j.m.n
+    end
+    
+    should "blockily extend by overwriting existing keys" do
+      # replace c?  Additive 
+      @obj.config.c do
+        q :r
+      end
+      
+      assert_equal :b, @obj.config.a
+      assert_equal :g, @obj.config.c.f
+      assert_equal :r, @obj.config.c.q      
+    end
+    
+    should "handle equal-style assignment niftily" do
+      @obj.config.c = :d
+      assert_equal :d, @obj.config[:c]
+      assert_equal nil, @obj.config[:c=]
+    end
+    
+    should "gripe when given a string" do
+      assert defined?( FunWith::Configurations::KeyError )
+      assert_raises FunWith::Configurations::KeyError do |err|
+        @obj.config["c"]
+      end
+    end
+    
+    should "gripe when given a reserved method as a key" do
+      assert defined?( FunWith::Configurations::KeyError )
+      assert_raises FunWith::Configurations::KeyError do |err|
+        @obj.config[:keys] = ["22461", "80129"]
+      end
+    end
+  end
+  
+  should "successfully create configuration manually" do
+    @obj = Object.new
+    @obj.extend( FunWith::Configurations::Configurable )
+    @obj.config = FunWith::Configurations::Config.new do
+      betelgeuse "red"
+      rigel "blue-white"
+    end
+    
+    assert_equal "blue-white", @obj.config.rigel
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: fun_with_configurations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bryce Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fun_with_files
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "Attach a configuration object to any object or class with code like
+  this:\n   spy.install_fwc_config do\n     spy_id \"74 Baker\"\n"
+email: keeputahweird@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ./lib/fun_with/configurations/config.rb
+- ./lib/fun_with/configurations/configurations.rb
+- ./lib/fun_with/configurations/object.rb
+- ./lib/fun_with_configurations.rb
+- ./test/helper.rb
+- ./test/test_fun_with_configurations.rb
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+homepage: http://github.com/darthschmoo/fun_with_configurations
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2567250153676636570
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A quick and feisty configuration creator (e.g. MyClass.config)
+test_files: []