magic_options 1.0.0 → 1.0.1

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+rdoc/*

data/README.rdoc

@@ -0,0 +1,79 @@
+= magic_options
+
+MagicOptions is a ruby module that provides mechanisms for splatting
+an options hash into an object's instance variables, typically during
+object initialization.  Each key is taken as the name of an instance
+variable, to which the associated value is assigned.
+
+Version 1.0.0 broke compatibility with previous versions, in the
+interests of being useful in subclasses and in initializers that take
+more than just an options hash.
+
+== Examples
+
+The simplest approach is to use MagicOptions::ClassMethods#magic_initialize:
+
+  require 'rubygems'
+  require 'magic_options'
+
+  class Gullible
+
+    include MagicOptions
+
+    magic_initialize
+
+  end
+
+  Gullible.new :accepts => "anything"
+  # => #<Gullible:0x7f77e407fdb0 @accepts="anything">
+
+If you want an +ArgumentError+ for options that don't have accessors:
+
+  class Cow
+
+    include MagicOptions
+
+    magic_initialize :only => :respond_to?
+
+    attr_accessor :color, :gender
+
+  end
+
+  Cow.new :color => "brown", :gender => "female"
+  # => #<Cow:0x7f77e409a6d8 @gender="female", @color="brown">
+  Cow.new :color => "brown", :gender => "female", :wheels => 4
+  # => ArgumentError: Unknown option wheels for new Cow
+
+If your object initializer must do more than apply the magic options pattern,
+you can use MagicOptions#magic_options inside your +initialize+ method. This
+example also illustrates a more explicit method of specifying which options
+are allowed:
+
+  class Professor < Staff
+
+    include MagicOptions
+
+    def initialize(name, options = {})
+      magic_options options, :only => [:iq, :hairstyle]
+    end
+
+  end
+
+  Professor.new :hair_style => :einsteinian
+  # => #<Professor:0x7f77e406d980 @hair_style=:einsteinian>
+  Professor.new :does_not_take => :anything
+  # => ArgumentError: Unknown option does_not_take for new Professor
+
+== Obtaining
+
+To install from rubygems.org:
+
+  gem install magic_options
+
+To fetch the source from github.com:
+
+  git clone git://github.com/sheldonh/magic_options.git
+
+== Credits
+
+Written in colaboration with @rorymckinley[http://twitter.com/#!/rorymckinley]

data/Rakefile

@@ -1 +1,20 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+desc 'Generate rdoc documentation'
+RDoc::Task.new do |t|
+  t.main = 'README.rdoc'
+  t.rdoc_dir = 'rdoc'
+  t.rdoc_files.include %w{ README.rdoc lib/**/*.rb }
+end
+
+desc 'Run all rspec examples'
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  desc 'Run all rspec examples with pretty output'
+  RSpec::Core::RakeTask.new(:doc) do |t|
+    t.rspec_opts = '--color --format=doc'
+  end
+end

data/lib/magic_options.rb

@@ -1,7 +1,58 @@
 require "magic_options/version"
 
+# MagicOptions is a ruby module that provides mechanisms for splatting
+# an options hash into an object's instance variables, typically during
+# object initialization.  Each key is taken as the name of an instance
+# variable, to which the associated value is assigned.
+#
+# For example:
+#
+# <tt>
+#   class Cow
+#     def initialize(name, options = {})
+#       @name = name.capitalize
+#       @color = color
+#       @gender = gender
+#     end
+#   end
+#
+#   Cow.new('Daisy', :color => 'brown', :gender => 'female')
+#   # => #<Cow:0x000000015d02b8 @color="brown", @gender="female", @name="Daisy">
+# </tt>
+#
+# Here's how the same object initializer might be defined with MagicOptions:
+#
+# <tt>
+#   class Cow
+#     include MagicOptions
+#
+#     def initialize(name, options = {})
+#       @name = name.capitalize
+#       magic_options(options, :only => [:color, :gender])
+#     end
+#   end
+# </tt>
+#
+# If your initialize method does nothing other than implement the magic options pattern,
+# you can let MagicOptions::ClassMethods#magic_initialize define it for you instead.
+#
 module MagicOptions
 
+  # Assign every value from the options hash into an instance variable named after the associated key.
+  # The optional config hash may impose constraints on this behaviour as follows:
+  #
+  # [+:only+]
+  #   Specify the only options that are allowed.  The special value +:respond_to?+ specifies that options
+  #   are allowed if they name a method on the instance.
+  #
+  # [+:require+]
+  #   Specify options that must be passed.  Options specified in +:require+ do not also need to be
+  #   specified in +:only+.
+  #
+  # Raises:
+  #
+  # [ArgumentError] when +:only+ is specified and an option is passed that is not in +:only+ or +:require+
+  # [ArgumentError] when +:require+ specifies one or more options that are not passed
   def magic_options(options, config = {})
     magic_options_validate(options, config)
     options.each do |option, value|
@@ -9,14 +60,35 @@ module MagicOptions
     end
   end
 
-  def self.included(base)
+  def self.included(base) # :nodoc:
     base.extend(ClassMethods)
   end
 
+  # When an object initializer need do nothing more than implement the magic options pattern,
+  # it can be defined in terms of its magic options as follows:
+  #
+  # <tt>
+  #   class Cow
+  #     include MagicOptions
+  #     magic_initialize(:require => :name, :only => [:color, :gender])
+  #   end
+  #
+  #   Cow.new(:name => 'Daisy', :color => 'brown', :gender => 'female')
+  #   # => #<Cow:0x000000015d02b8 @color="brown", @gender="female", @name="Daisy">
+  # </tt>
+  #
+  # When the object initializer must do more than this (for example, if it must call +super+),
+  # you can define it yourself in terms of MagicOptions#magic_options.
+  #
   module ClassMethods
 
+    # Class accessor used by #magic_initialize to store the +config+ hash it receives, to be
+    # passed into MagicOptions#magic_options in the object initializer that #magic_initialize
+    # defines.
     attr_accessor :magic_options_config
 
+    # Defines an object initializer that takes an options hash and passes it to
+    # MagicOptions#magic_options, along with the optional +config+ hash.
     def magic_initialize(config = {})
       self.magic_options_config = config
       class_eval %{
@@ -30,7 +102,7 @@ module MagicOptions
 
 private
 
-  def magic_options_validate(options, config)
+  def magic_options_validate(options, config) # :nodoc:
     if config[:only] == :respond_to?
       if unknown = options.keys.detect { |option| !respond_to?(option) }
         raise ArgumentError, "Unknown option #{unknown} in new #{self.class}"

data/lib/magic_options/version.rb

@@ -1,3 +1,4 @@
 module MagicOptions
-  VERSION = "1.0.0"
+  # The version of the MagicOptions gem.
+  VERSION = "1.0.1"
 end

data/magic_options.gemspec

@@ -17,5 +17,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency('rspec')
+  s.add_development_dependency('rake', '~> 0.9.2')
+  s.add_development_dependency('rdoc', '~> 2.5.8')
+  s.add_development_dependency('rspec', '~> 2.6.0')
 end

data/spec/magic_options/class_method_spec.rb

@@ -1,205 +1,41 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'magic_options'
 
-describe "MagicOptions::ClassMethods#magic_initialize" do
-
-  context "Given class Cow mixes in MagicOptions" do
-
-    before(:each) do
-      require 'magic_options'
-      class Cow
-        include MagicOptions
-      end
-    end
-
-    context "When it calls magic_initialize" do
-
-      before(:each) do
-        class Cow
-          magic_initialize
-        end
-      end
-      
-      context "Then Cow.new(:name => 'Daisy', :color => :brown)" do
-
-        before(:each) do
-          @cow = Cow.new(:name => 'Daisy', :color => :brown)
-        end
-
-        it "sets @name to 'Daisy'" do
-          @cow.instance_variable_get('@name').should == 'Daisy'
-        end
-
-        it "sets @color to :brown" do
-          @cow.instance_variable_get('@color').should == :brown
-        end
-
-      end
+describe "MagicOptions::ClassMethods#magic_initialize(config = {})" do
 
+  before(:each) do
+    begin; Object.send(:remove_const, :Cow); rescue; end
+    class Cow
+      include MagicOptions
     end
+  end
 
-    context "When it calls magic_initialize(:only => [:name, :color])" do
-
-      before(:each) do
-        class Cow
-          magic_initialize :only => [:name, :color]
-        end
-      end
-
-      context "Then Cow.new(:name => 'Daisy', :color => :brown)" do
-
-        before(:each) do
-          @cow = Cow.new(:name => 'Daisy', :color => :brown)
-        end
-
-        it "sets @name to 'Daisy'" do
-          @cow.instance_variable_get('@name').should == 'Daisy'
-        end
-
-        it "sets @color to :brown" do
-          @cow.instance_variable_get('@color').should == :brown
-        end
-
-      end
-
-      context "Then Cow.new(:name => 'Daisy', :gender => :female)" do
-
-        it "raises an ArgumentError" do
-          lambda {
-            Cow.new(:name => 'Daisy', :gender => :female)
-          }.should raise_error(ArgumentError)
-        end
-
-        it "reports the offending class and the unknown option" do
-          lambda {
-            Cow.new(:name => 'Daisy', :gender => :female)
-          }.should raise_error("Unknown option gender in new Cow")
-        end
-
-      end
+  it "creates an initialize(options = {}) instance method" do
+    Cow.should_receive(:method_added).with(:initialize)
 
+    class Cow
+      magic_initialize
     end
+  end
 
-    context "When it calls magic_initialize(:require => :name)" do
-
-      before(:each) do
-        class Cow
-          magic_initialize :require => :name
-        end
-      end
-
-      context "Then Cow.new(:name => 'Daisy', :color => :brown)" do
-
-        before(:each) do
-          @cow = Cow.new(:name => 'Daisy', :color => :brown)
-        end
-
-        it "sets @name to 'Daisy'" do
-          @cow.instance_variable_get('@name').should == 'Daisy'
-        end
-
-        it "sets @color to :brown" do
-          @cow.instance_variable_get('@color').should == :brown
-        end
-
-      end
-
-      context "Then Cow.new(:color => :brown)" do
-
-        it "raises an ArgumentError" do
-          lambda { @cow = Cow.new(:color => :brown) }.should raise_error(ArgumentError)
-        end
-
-        it "reports the offending class and the missing option" do
-          lambda { @cow = Cow.new(:color => 'Daisy') }.should raise_error("Missing option name in new Cow")
-        end
-      end
-
+  it "sets up initialize to pass through its options as magic_options' first argument" do
+    class Cow
+      magic_initialize
     end
 
-    context "When it calls magic_initialize(:only => :color, :require => :name)" do
-
-      before(:each) do
-        class Cow
-          magic_initialize :only => :color, :require => :name
-        end
-      end
-
-      context "Then Cow.new(:name => 'Daisy', :color => :brown)" do
-
-        before(:each) do
-          @cow = Cow.new(:name => 'Daisy', :color => :brown)
-        end
-
-        it "sets @name to 'Daisy'" do
-          @cow.instance_variable_get('@name').should == 'Daisy'
-        end
+    Cow.any_instance.should_receive(:magic_options).with({:name => "Daisy"}, {})
 
-        it "sets @color to :brown" do
-          @cow.instance_variable_get('@color').should == :brown
-        end
-
-      end
-
-      context "Then Cow.new(:color => :brown)" do
-
-        it "raises an ArgumentError" do
-          lambda { @cow = Cow.new(:color => :brown) }.should raise_error(ArgumentError)
-        end
-
-        it "reports the offending class and the missing option" do
-          lambda { @cow = Cow.new(:color => 'Daisy') }.should raise_error("Missing option name in new Cow")
-        end
-
-      end
+    cow = Cow.new(:name => 'Daisy')
+  end
 
+  it "sets up initialize to pass the given config as magic_options's second argument" do
+    class Cow
+      magic_initialize :only => :name
     end
 
-    context "When Cow calls attr_accessor(:name)" do
-
-      before(:each) do
-        class Cow
-          attr_accessor :name
-        end
-      end
-
-      context "When it calls magic_initialize(:only => :respond_to?)" do
-
-        before(:each) do
-          class Cow
-            magic_initialize :only => :respond_to?
-          end
-        end
-
-        context "Then Cow.new(:name => 'Daisy')" do
-
-          it "sets @name to 'Daisy'" do
-            @cow = Cow.new(:name => 'Daisy')
-            @cow.instance_variable_get('@name').should == 'Daisy'
-          end
-
-        end
-
-        context "Then Cow.new(:name => 'Daisy', :gender => :female)" do
-
-          it "raises an ArgumentError" do
-            lambda {
-              Cow.new(:name => 'Daisy', :gender => :female)
-            }.should raise_error(ArgumentError)
-          end
-
-          it "reports the offending class and the unknown option" do
-            lambda {
-              Cow.new(:name => 'Daisy', :gender => :female)
-            }.should raise_error("Unknown option gender in new Cow")
-          end
-
-        end
-
-      end
-
-    end
+    Cow.any_instance.should_receive(:magic_options).with({}, { :only => :name })
 
+    cow = Cow.new
   end
 
 end
-

data/spec/magic_options/instance_method_spec.rb

@@ -1,167 +1,96 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'magic_options'
 
-describe "MagicOptions#magic_options" do
+describe "MagicOptions#magic_options(options, config = {})" do
 
-  context "Given class Cow mixes in MagicOptions" do
-
-    before(:each) do
-      require 'magic_options'
-      class Cow
-        include MagicOptions
-      end
+  before(:each) do
+    begin; Object.send(:remove_const, :Cow); rescue; end
+    class Cow
+      include MagicOptions
     end
+  end
 
-    context "When Cow#initialize(options) calls magic_options(options)" do
-
-      before(:each) do
-        class Cow
-          def initialize(options = {})
-            magic_options options
-          end
-        end
-      end
-
-      context "Then Cow.new(:name => 'Daisy', :color => :brown)" do
-
-        before(:each) do
-          @cow = Cow.new(:name => 'Daisy', :color => :brown)
-        end
-
-        it "sets @name to 'Daisy'" do
-          @cow.instance_variable_get('@name').should == 'Daisy'
-        end
-
-        it "sets @color to :brown" do
-          @cow.instance_variable_get('@color').should == :brown
-        end
-
-      end
-
+  it "sets instance variables named after keys in the options hash" do
+    class Cow
+      def initialize(options = {}); magic_options(options); end
     end
+    @cow = Cow.new(:name => 'Daisy', :color => :brown)
+    @cow.should be_instance_variable_defined('@name')
+    @cow.should be_instance_variable_defined('@color')
+  end
 
-    context "When Cow#initialize(options) calls magic_options(options, :only => [:name, :color])" do
-
-      before(:each) do
-        class Cow
-          def initialize(options)
-            magic_options(options, :only => [:name, :color])
-          end
-        end
-      end
-
-      context "Then Cow.new(:name => 'Daisy', :color => :brown)" do
-
-        before(:each) do
-          @cow = Cow.new(:name => 'Daisy', :color => :brown)
-        end
-
-        it "sets @name to 'Daisy'" do
-          @cow.instance_variable_get('@name').should == 'Daisy'
-        end
-
-        it "sets @color to :brown" do
-          @cow.instance_variable_get('@color').should == :brown
-        end
-
-      end
-
-      context "Then Cow.new(:name => 'Daisy', :gender => :female)" do
-
-        it "raises an ArgumentError" do
-          lambda {
-            Cow.new(:name => 'Daisy', :gender => :female)
-          }.should raise_error(ArgumentError)
-        end
-
-        it "reports the offending class and the unknown option" do
-          lambda {
-            Cow.new(:name => 'Daisy', :gender => :female)
-          }.should raise_error("Unknown option gender in new Cow")
-        end
-
-      end
-
+  it "sets instance variable values to the values in the options hash" do
+    class Cow
+      def initialize(options = {}); magic_options(options); end
     end
+    @cow = Cow.new(:name => 'Daisy', :color => :brown)
+    @cow.instance_variable_get('@name').should == 'Daisy'
+    @cow.instance_variable_get('@color').should == :brown
+  end
 
-    context "When Cow#initialize(options) calls magic_options(options, :require => :name)" do
-
-      before(:each) do
-        class Cow
-          def initialize(options)
-            magic_options(options, :require => :name)
-          end
-        end
-      end
-
-      context "Then Cow.new(:name => 'Daisy', :color => :brown)" do
-
-        before(:each) do
-          @cow = Cow.new(:name => 'Daisy', :color => :brown)
-        end
-
-        it "sets @name to 'Daisy'" do
-          @cow.instance_variable_get('@name').should == 'Daisy'
-        end
-
-        it "sets @color to :brown" do
-          @cow.instance_variable_get('@color').should == :brown
-        end
-
-      end
-
-      context "Then Cow.new(:color => :brown)" do
-
-        it "raises an ArgumentError" do
-          lambda { @cow = Cow.new(:color => :brown) }.should raise_error(ArgumentError)
-        end
-
-        it "reports the offending class and the missing option" do
-          lambda { @cow = Cow.new(:color => 'Daisy') }.should raise_error("Missing option name in new Cow")
-        end
-      end
-
+  it "accepts any option names without config[:only]" do
+    class Cow
+      def initialize(options = {}); magic_options(options); end
     end
+    lambda { @cow = Cow.new(:name => 'Daisy', :color => :brown, :gender => :female) }.should_not raise_error
+  end
 
-    context "When Cow#initialize(options) calls magic_options(options, :only => :color, :require => :name)" do
-
-      before(:each) do
-        class Cow
-          def initialize(options)
-            magic_options(options, :only => :color, :require => :name)
-          end
-        end
-      end
-
-      context "Then Cow.new(:name => 'Daisy', :color => :brown)" do
-
-        before(:each) do
-          @cow = Cow.new(:name => 'Daisy', :color => :brown)
-        end
-
-        it "sets @name to 'Daisy'" do
-          @cow.instance_variable_get('@name').should == 'Daisy'
-        end
-
-        it "sets @color to :brown" do
-          @cow.instance_variable_get('@color').should == :brown
-        end
+  it "accepts option names included in config[:only]" do
+    class Cow
+      def initialize(options = {}); magic_options(options, :only => [:name, :color]); end
+    end
+    lambda { @cow = Cow.new(:name => 'Daisy', :color => :brown) }.should_not raise_error
+  end
 
-      end
+  it "raises ArgumentError for option names not included in config[:only]" do
+    class Cow
+      def initialize(options = {}); magic_options(options, :only => [:name, :color]); end
+    end
+    lambda { @cow = Cow.new(:name => 'Daisy', :color => :brown, :gender => :female) }.should raise_error(ArgumentError)
+  end
 
-      context "Then Cow.new(:color => :brown)" do
+  it "accepts the absence of options without config[:require]" do
+    class Cow
+      def initialize(options = {}); magic_options(options); end
+    end
+    lambda { @cow = Cow.new }.should_not raise_error
+  end
 
-        it "raises an ArgumentError" do
-          lambda { @cow = Cow.new(:color => :brown) }.should raise_error(ArgumentError)
-        end
+  it "raises ArgumentError for absent option names in config[:require]" do
+    class Cow
+      def initialize(options = {}); magic_options(options, :require => [:name, :color]); end
+    end
+    lambda { @cow = Cow.new(:name => 'Daisy') }.should raise_error(ArgumentError)
+  end
 
-        it "reports the offending class and the missing option" do
-          lambda { @cow = Cow.new(:color => 'Daisy') }.should raise_error("Missing option name in new Cow")
-        end
+  it "accepts option names in config[:require] even when they are not in config[:only]" do
+    class Cow
+      def initialize(options = {}); magic_options(options, :require => :name, :only => :color); end
+    end
+    lambda { @cow = Cow.new(:name => 'Daisy', :color => :brown) }.should_not raise_error
+  end
 
-      end
+  it "raises ArgumentError for option names absent from both config[:only] and config[:require]" do
+    class Cow
+      def initialize(options = {}); magic_options(options, :require => :name, :only => :color); end
+    end
+    lambda { @cow = Cow.new(:name => 'Daisy', :color => :brown, :gender => :female) }.should raise_error(ArgumentError)
+  end
 
+  it "accepts option names that match instance method names if config[:only] is :respond_to?" do
+    class Cow
+      attr_accessor :name, :color
+      def initialize(options = {}); magic_options(options, :only => :respond_to?); end
     end
+    lambda { @cow = Cow.new(:name => 'Daisy', :color => :brown) }.should_not raise_error
+  end
 
+  it "raises ArgumentError for option names that match no instance method names if config[:only] is :respond_to?" do
+    class Cow
+      attr_accessor :name, :color
+      def initialize(options = {}); magic_options(options, :only => :respond_to?); end
+    end
+    lambda { @cow = Cow.new(:name => 'Daisy', :color => :brown, :gender => :female) }.should raise_error(ArgumentError)
   end
 
 end

metadata

@@ -1,51 +1,61 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: magic_options
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Sheldon Hearn
 - Rory McKinley
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-25 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
+date: 2011-10-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &10414280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *10414280
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &10413780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.8
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *10413780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &10413320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *10413320
 description: 
-email: 
+email:
 - sheldonh@starjuice.net
 - rorymckinley@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
-- README.md
+- README.rdoc
 - Rakefile
 - lib/magic_options.rb
 - lib/magic_options/version.rb
@@ -55,36 +65,29 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/sheldonh/magic_options
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: magic_options
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby module to provide initialize with magic options
-test_files: []
-
+test_files:
+- spec/magic_options/class_method_spec.rb
+- spec/magic_options/instance_method_spec.rb
+- spec/spec_helper.rb

data/README.md

@@ -1,118 +0,0 @@
-magic_options
--------------
-
-MagicOptions is a ruby module that provides mechanisms for splatting
-an options hash into an object's instance variables.  Each key is taken
-as the name of an instance variable, to which the associated value is
-assigned.
-
-This is version 1.0.0.  It is not backward compatible with previous
-versions at all.  This version will be uploaded to rubygems.org within
-the next few days.
-
-Examples
---------
-
-```ruby
-require 'rubygems'
-require 'magic_options'
-
-class Gullible
-
-  include MagicOptions
-
-  magic_initialize
-
-end
-
-Gullible.new :accepts => "anything"
- => #<Gullible:0x7f77e407fdb0 @accepts="anything">
-
-class Cow
-
-  include MagicOptions
-
-  magic_initialize :only => :respond_to?
-
-  attr_accessor :color, :gender
-
-end
-
-Cow.new :color => "brown", :gender => "female"
- => #<Cow:0x7f77e409a6d8 @gender="female", @color="brown">
-Cow.new :color => "brown", :gender => "female", :wheels => 4
- => ArgumentError: Unknown option wheels for new Cow
-
-class Professor
-
-  include MagicOptions
-
-  def initialize(name, options = {})
-    magic_options options, :only => [:iq, :hairstyle]
-  end
-
-end
-
-Professor.new :hair_style => :einsteinian
- => #<Professor:0x7f77e406d980 @hair_style=:einsteinian>
-Professor.new :does_not_take => :anything
- => ArgumentError: Unknown option does_not_take for new Professor
-```
-
-Documentation
--------------
-
-Working code first.  For now, here are the specs for the magic_options
-method:
-
-```
-MagicOptions#magic_options(options, config = {})
-  Given class Cow mixes in MagicOptions
-    When Cow#initialize(options) calls magic_options(options)
-      Then Cow.new(:name => 'Daisy', :color => :brown)
-        sets @name to 'Daisy'
-        sets @color to :brown
-    When Cow#initialize(options) calls magic_options(options, :only => [:name, :color])
-      Then Cow.new(:name => 'Daisy', :color => :brown)
-        sets @name to 'Daisy'
-        sets @color to :brown
-      Then Cow.new(:name => 'Daisy', :gender => :female)
-        raises an ArgumentError
-        reports the offending class and the unknown option
-    When Cow#initialize(options) calls magic_options(options, :require => :name)
-      Then Cow.new(:name => 'Daisy', :color => :brown)
-        sets @name to 'Daisy'
-        sets @color to :brown
-      Then Cow.new(:color => :brown)
-        raises an ArgumentError
-        reports the offending class and the missing option
-    When Cow#initialize(options) calls magic_options(options, :only => :color, :require => :name)
-      Then Cow.new(:name => 'Daisy', :color => :brown)
-        sets @name to 'Daisy'
-        sets @color to :brown
-      Then Cow.new(:color => :brown)
-        raises an ArgumentError
-        reports the offending class and the missing option
-```
-
-MagicOptions::ClassMethods#magic_initialize(config = {}) creates an
-initialize method that works like this:
-
-```ruby
-def initialize(options = {})
-  magic_options(options, config)
-end
-```
-
-Obtaining
----------
-
-<https://github.com/sheldonh/magic_options>
-
-Credits
--------
-
-Pair programmed with [@rorymckinley][c1]
-
-[c1]: http://twitter.com/#!/rorymckinley
-