cupcakinator 0.0.2

data/.gitignore

@@ -0,0 +1,22 @@
+.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+bin/
+foo.rb
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+config.yml
+bar_config.yml

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--format progress
+--debug
+--drb
+

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p392

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'simplecov', :require => false, :group => :test
+gem 'json', '~> 1.7.7'

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :all_after_pass => true, :focus_on_failed => true, :all_on_start => true, :cli => "--drb --debug" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}){ |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb'){ "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end
+
+guard 'spork', :test_unit => false do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bryan Taylor
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Cupcakinator
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cupcakinator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cupcakinator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/cupcakinator.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cupcakinator/version', __FILE__)
+require 'base64'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bryan Taylor"]
+  gem.email         = ['YmNwdGF5bG9yQGdtYWlsLmNvbQ==\n'].collect{ |foo| Base64.decode64(foo) }
+  gem.description   = %q{ Add config from YAML to any class }
+  gem.summary       = %q{ Easy to add config from YAML to any class }
+  gem.homepage      = "http://github.com/rubyisbeautiful/cupcakinator"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cupcakinator"
+  gem.require_paths = ["lib"]
+  gem.version       = Cupcakinator::VERSION
+
+  gem.add_runtime_dependency 'hashie'
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "debugger"
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "guard-spork"
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rb-readline'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "redcarpet"
+
+
+
+
+end

data/lib/cupcakinator.rb

@@ -0,0 +1,29 @@
+require 'cupcakinator/version'
+require 'cupcakinator/base'
+require 'cupcakinator/config'
+require 'cupcakinator/options'
+require 'cupcakinator/errors'
+
+# the purpose of cupcakinator is to provide an simple, flexible dynamic method to retrrieve configuration
+# data for a class
+# it provides this dynamic method as 'config' by default for both the class and any instances
+# @example class Foo uses cupcakinator, see Cupcakinator::Base::cupcakinate
+#   given config.yml:
+#   bacon:
+#     flavor: pork
+#   meatball:
+#     flavor:
+#       - pork
+#       - chicken
+#   >> Foo.config
+#   {"meatball"=>{"flavor"=>["chicken", "pork"]}}
+#   >> Foo.config.meatball
+#   {"flavor"=>["chicken", "pork"]}
+module Cupcakinator
+
+  def self.included(other)
+    other.extend Cupcakinator::Base
+  end
+
+
+end

data/lib/cupcakinator/base.rb

@@ -0,0 +1,110 @@
+require 'yaml'
+
+module Cupcakinator
+
+  module Base
+
+
+    def self.included(other)
+      raise "deprecated: don't include Cupcakinator::Base directly"
+      #puts "included (via Base) in #{other}"
+      #other.extend ClassMethods
+    end
+
+
+    def self.extend_object(other)
+      class_eval <<-ENDOFCLASSDEF
+        class << self
+          @cupcakinator_options = nil;
+          @cupcakinator_config = nil;
+        end
+      ENDOFCLASSDEF
+      super
+    end
+
+
+    # this is the main access point to using and setting up cupcakinator
+    # it accepts any arguments, the following are currently recognized:
+    # @param [Array<Hash>] options
+    # @option options.last [Hash] :dir The directory where the file can be found
+    # @option options.last [Hash] :file The configuration filename
+    # @option options.last [Hash] :method The method used to access the configuration options
+    # @example  Default usage - Foo will load ./config/config.yml into a method named 'config'
+    #   class Foo
+    #     include cupcakinator
+    #     cupcakinate
+    #   end
+    #   >> puts Foo.config
+    #   { :foo => 'bar' }
+    #
+    # @example  method name change - Foo will load ./config/config.yml into a method named 'le_config'
+    #   class Foo
+    #     include cupcakinator
+    #     cupcakinate method: 'le_config'
+    #   end
+    #   >> puts Foo.le_config
+    #   { :foo => 'bar' }
+    #   >> puts Foo.new.le_config
+    #   { :foo => 'bar' }
+    #
+    # @example  with Rails - Foo will load config/foo_config.yml relative to Rails root into a method named 'config'
+    #   class Foo
+    #     include cupcakinator
+    #     cupcakinate dir: Rails.root.join('config'), file: 'foo_config.yml'
+    #   end
+    #   >> puts Foo.config
+    #   { :foo => 'bar' }
+    #   >> puts Foo.new.config
+    #   { :foo => 'bar' }
+    #
+    def cupcakinate(*options)
+      if !options.empty?
+        default_options = _cupcakinator_options
+        @cupcakinator_options = default_options.merge(options.last)
+      end
+    end
+
+
+    def _cupcakinator_options
+      if @cupcakinator_options.nil?
+        @cupcakinator_options = Cupcakinator::Options.new
+      end
+      @cupcakinator_options
+    end
+
+
+    def _cupcakinator_config
+      if @cupcakinator_config.nil?
+        filename = File.join(_cupcakinator_options[:dir], _cupcakinator_options[:file])
+        yaml_config = YAML.load_file(filename)
+        @cupcakinator_config = Cupcakinator::Config.new(yaml_config)
+      end
+      @cupcakinator_config
+    rescue Errno::ENOENT
+      raise Cupcakinator::ConfigFileNotFoundError.new("Can't find Cupcakinator configured config file #{filename}\nCupcakinator options:\n#{_cupcakinator_options}")
+    rescue Psych::SyntaxError => e
+      raise Cupcakinator::ConfigFileInvalidError.new("Cupcakinator configure config file #{filename} invalid\nOriginal error: #{e.message}")
+    end
+
+
+    def method_missing(original_method, *args)
+      if original_method.to_s == _cupcakinator_options[:method].to_s
+         _cupcakinator_config(*args)
+      else
+        super
+      end
+    end
+
+
+  end
+
+
+  def method_missing(original_method, *args)
+    if original_method.to_s == self.class._cupcakinator_options[:method].to_s
+       self.class._cupcakinator_config(*args)
+    else
+      super
+    end
+  end
+
+end

data/lib/cupcakinator/config.rb

@@ -0,0 +1,25 @@
+require 'hashie/extensions/method_access'
+require 'hashie/extensions/coercion'
+
+module Cupcakinator
+
+  # known configuration variables
+  # method
+  # dir
+  # file
+  class Config < Hash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::Coercion
+
+    coerce_value Hash, Config
+
+    def initialize(h={})
+      super
+      h.each_pair do |k,v|
+        self[k] = v
+      end
+    end
+
+  end
+
+end

data/lib/cupcakinator/errors.rb

@@ -0,0 +1,6 @@
+module Cupcakinator
+
+  class ConfigFileNotFoundError < StandardError; end
+  class ConfigFileInvalidError < StandardError; end
+
+end

data/lib/cupcakinator/options.rb

@@ -0,0 +1,17 @@
+module Cupcakinator
+
+  # known configuration variables
+  # method
+  # dir
+  # file
+  class Options < Cupcakinator::Config
+
+    DEFAULT_OPTIONS = Cupcakinator::Config.new(method: :config, dir: '.', file: 'config.yml')
+
+    def initialize(opts=DEFAULT_OPTIONS)
+      super
+    end
+
+  end
+
+end

data/lib/cupcakinator/version.rb

@@ -0,0 +1,3 @@
+module Cupcakinator
+  VERSION = "0.0.2"
+end

data/spec/cupcakinator/base_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Cupcakinator::Base do
+
+  before :all do
+    class CupcakinatorBaseSpecFoo
+      include Cupcakinator
+
+      cupcakinate dir: File.expand_path(File.join(File.dirname(__FILE__), '..')), method: 'el_config', file: 'el_config.yml'
+    end
+  end
+
+
+
+  describe 'cupcakinate' do
+
+    # a better way to do this?  It's got the sleep to guarantee a new class name but of course slows it all down
+    # a new class name was necessary to ensure clean slate... I tried deregistering the object name, but it seemed
+    # like it was not going to bear fruit
+    before :each do
+      sleep(1)
+      @klass = nil
+      t = Time.now.strftime("Foo%Y%m%d%H%M%s")
+      eval <<-ENDOFKLASS
+        class #{t}
+          include Cupcakinator
+        end
+      ENDOFKLASS
+      @klass = Object.module_eval(t)
+    end
+
+
+    it "should call _cupcakinator_options" do
+      @klass.should_receive(:_cupcakinator_options).at_least(1).and_return({})
+
+      @klass.cupcakinate method: 'config'
+    end
+
+    it 'should set the default config with no options' do
+      @klass.cupcakinate
+
+      @klass._cupcakinator_options.should eq Cupcakinator::Options.new
+    end
+
+    it 'should merge options into default' do
+      @klass.cupcakinate file: 'conf.yml'
+
+      @klass._cupcakinator_options[:file].should == 'conf.yml'
+    end
+
+  end
+
+
+  describe '_cupcakinator_config' do
+
+    it 'should return a Cupcakinator::Config' do
+      CupcakinatorBaseSpecFoo._cupcakinator_config.class.should eq(Cupcakinator::Config)
+    end
+
+    it 'should return a Cupcakinator::Config for an embedded Hash (in yaml)' do
+      CupcakinatorBaseSpecFoo._cupcakinator_config.bacon.class.should eq(Cupcakinator::Config)
+    end
+
+  end
+
+
+  describe 'method missing' do
+
+    let(:subject){ CupcakinatorBaseSpecFoo }
+
+    it 'should use default method missing if not the configured cupcakinator method' do
+      expect { subject.doodle }.to raise_error(NoMethodError)
+    end
+
+    it 'should not raise if NoMethodError when using the configured cupcakinator method' do
+      expect { subject.el_config }.to_not raise_error(NoMethodError)
+    end
+
+    it 'should delegeate to _cupcakinator_config when using the configured cupcakinator method' do
+      CupcakinatorBaseSpecFoo.should_receive(:_cupcakinator_config).with('john')
+
+      subject.el_config('john')
+    end
+
+  end
+
+
+
+  context 'instance methods' do
+
+
+    describe 'method missing' do
+
+      let(:subject){ CupcakinatorBaseSpecFoo.new }
+
+      it 'should use default method missing if not the configured cupcakinator method' do
+        expect { subject.doodle }.to raise_error(NoMethodError)
+      end
+
+      it 'should not raise if NoMethodError when using the configured cupcakinator method' do
+        expect { subject.el_config }.to_not raise_error(NoMethodError)
+      end
+
+      it 'should delegeate to _cupcakinator_config when using the configured cupcakinator method' do
+        CupcakinatorBaseSpecFoo.should_receive(:_cupcakinator_config).with('john')
+
+        subject.el_config('john')
+      end
+
+    end
+
+
+  end
+
+end

data/spec/cupcakinator_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+class CupcakinatorSpecFoo
+  include Cupcakinator
+
+  cupcakinate method: 'config', file: 'config.yml'
+end
+
+class CupcakinatorSpecBar < CupcakinatorSpecFoo
+  cupcakinate method: 'bar_config'
+end
+
+class CupcakinatorSpecBaz
+  include Cupcakinator
+
+  cupcakinate method: 'baz_config'
+end
+
+
+describe Cupcakinator do
+
+  context 'inheritence' do
+
+    it "parent should not have child's options" do
+      CupcakinatorSpecFoo._cupcakinator_options[:method].should == 'config'
+    end
+
+    it "child should not have parent's options" do
+      CupcakinatorSpecBar._cupcakinator_options[:method].should == 'bar_config'
+    end
+
+  end
+
+
+  context 'multiple uses' do
+
+    it "should exist separately per invocation" do
+      CupcakinatorSpecBaz._cupcakinator_options[:method].should_not eq CupcakinatorSpecFoo._cupcakinator_options[:method]
+    end
+
+  end
+
+end

data/spec/el_config.yml

@@ -0,0 +1,2 @@
+bacon:
+  chunky: true

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'spork'
+
+Spork.prefork do
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+
+  require 'rspec'
+
+  $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+  require 'cupcakinator'
+end
+
+Spork.each_run do
+
+end

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: cupcakinator
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Bryan Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  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: guard-spork
+  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: rake
+  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: rb-readline
+  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: rspec
+  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: yard
+  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: redcarpet
+  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: ! ' Add config from YAML to any class '
+email:
+- !binary |-
+  YmNwdGF5bG9yQGdtYWlsLmNvbQ==
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- cupcakinator.gemspec
+- lib/cupcakinator.rb
+- lib/cupcakinator/base.rb
+- lib/cupcakinator/config.rb
+- lib/cupcakinator/errors.rb
+- lib/cupcakinator/options.rb
+- lib/cupcakinator/version.rb
+- spec/cupcakinator/base_spec.rb
+- spec/cupcakinator_spec.rb
+- spec/el_config.yml
+- spec/spec_helper.rb
+homepage: http://github.com/rubyisbeautiful/cupcakinator
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Easy to add config from YAML to any class
+test_files:
+- spec/cupcakinator/base_spec.rb
+- spec/cupcakinator_spec.rb
+- spec/el_config.yml
+- spec/spec_helper.rb
+has_rdoc: