magic_options 0.0.1 → 1.0.0

data/README.md

@@ -1,36 +1,55 @@
 magic_options
 -------------
 
-MagicOptions is a ruby module that provides an initialize method that takes an
-optional hash of options.  Each key is taken as the name of an instance
-variable, to which the associated value is assigned.
+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.
 
-Example
--------
+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'
 
-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 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
 
-  magic_options :iq, :hair_style
+  def initialize(name, options = {})
+    magic_options options, :only => [:iq, :hairstyle]
+  end
 
 end
 
@@ -40,6 +59,51 @@ 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
 ---------
 

data/lib/magic_options/version.rb

@@ -1,3 +1,3 @@
 module MagicOptions
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/lib/magic_options.rb

@@ -2,10 +2,10 @@ require "magic_options/version"
 
 module MagicOptions
 
-  def initialize(options = {})
+  def magic_options(options, config = {})
+    magic_options_validate(options, config)
     options.each do |option, value|
-      magic_options_validate(option)
-      instance_variable_set "@#{option}".to_sym, value
+      instance_variable_set "@#{option}", value
     end
   end
 
@@ -15,24 +15,37 @@ module MagicOptions
 
   module ClassMethods
 
-    attr_accessor :magic_options_allowed
+    attr_accessor :magic_options_config
 
-    def magic_options(*allowed)
-      self.magic_options_allowed = allowed
+    def magic_initialize(config = {})
+      self.magic_options_config = config
+      class_eval %{
+        def initialize(options = {})
+          magic_options(options, self.class.magic_options_config)
+        end
+      }
     end
 
   end
 
 private
 
-  def magic_options_validate(option)
-    return unless allowed = self.class.magic_options_allowed
-    if allowed[0] == :accessors
-      return if respond_to?(option)
-    else
-      return if allowed.include?(option)
+  def magic_options_validate(options, config)
+    if config[:only] == :respond_to?
+      if unknown = options.keys.detect { |option| !respond_to?(option) }
+        raise ArgumentError, "Unknown option #{unknown} in new #{self.class}"
+      end
+    elsif config[:only]
+      only = [config[:only], config[:require]].flatten.compact
+      if unknown = options.keys.detect { |option| !only.include?(option) }
+        raise ArgumentError, "Unknown option #{unknown} in new #{self.class}"
+      end
+    end
+    if (required = [config[:require]].flatten.compact).size > 0
+      if missing = required.detect { |requirement| !options.keys.include?(requirement) }
+        raise ArgumentError, "Missing option #{missing} in new #{self.class}"
+      end
     end
-    raise ArgumentError, "Unknown option #{option} in new #{self.class}"
   end
 
 end

data/spec/magic_options/class_method_spec.rb

@@ -0,0 +1,205 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+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
+
+    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
+
+    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
+
+    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
+
+        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
+
+    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
+
+  end
+
+end
+

data/spec/magic_options/instance_method_spec.rb

@@ -0,0 +1,168 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe "MagicOptions#magic_options" do
+
+  context "Given class Cow mixes in MagicOptions" do
+
+    before(:each) do
+      require 'magic_options'
+      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
+
+    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
+
+    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
+
+    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
+
+      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
+
+    end
+
+  end
+
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: magic_options
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Sheldon Hearn
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-23 00:00:00 Z
+date: 2011-09-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -50,7 +50,8 @@ files:
 - lib/magic_options.rb
 - lib/magic_options/version.rb
 - magic_options.gemspec
-- spec/magic_options/magic_options_spec.rb
+- spec/magic_options/class_method_spec.rb
+- spec/magic_options/instance_method_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/sheldonh/magic_options
 licenses: []

data/spec/magic_options/magic_options_spec.rb

@@ -1,87 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-
-describe "MagicOptions" do
-
-  require 'magic_options'
-  class Klazz
-    include MagicOptions
-    attr_accessor :accessible
-  end
-
-  context "without specifying magic_options" do
-
-    it "sets instance variables for all options" do
-      object = Klazz.new(:color => "green")
-      object.instance_variables.should include("@color")
-      object.instance_variable_get(:@color).should == "green"
-    end
-
-  end
-
-  context "with magic_options :accessors" do
-
-    before(:each) do
-      Klazz.send :magic_options, :accessors
-    end
-
-    it "allows options named after accessors" do
-      lambda {
-        object = Klazz.new(:accessible => "is an accessor")
-      }.should_not raise_error
-    end
-
-    it "disallows any other option" do
-      lambda {
-        object = Klazz.new(:color => "is not an accessor")
-      }.should raise_error(ArgumentError)
-    end
-
-  end
-
-  context "with magic_options :color, :shape" do
-
-    before(:each) do
-      Klazz.send :magic_options, :color, :shape
-    end
-
-    it "allows an option called :color" do
-      lambda {
-        object = Klazz.new(:color => "green")
-      }.should_not raise_error
-    end
-
-    it "allows options an option called :shape" do
-      lambda {
-        object = Klazz.new(:shape => "round")
-      }.should_not raise_error
-    end
-
-    it "disallows any other option" do
-      lambda {
-        object = Klazz.new(:size => "is not a magic option")
-      }.should raise_error
-    end
-
-  end
-
-  context "with a disallowed option" do
-
-    before(:each) do
-      Klazz.send :magic_options, :allowed
-    end
-
-    it "raises an ArgumentError" do
-      lambda {
-        object = Klazz.new(:size => "is not a magic option")
-      }.should raise_error(ArgumentError)
-    end
-
-    it "says which class disallowed which option" do
-      lambda {
-        object = Klazz.new(:size => "is not a magic option")
-      }.should raise_error("Unknown option size in new Klazz")
-    end
-
-  end
-
-end