magic_options 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,54 @@
+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.
+
+Example
+-------
+
+```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
+
+end
+
+Gullible.new :accepts => "anything"
+ => #<Gullible:0x7f77e407fdb0 @accepts="anything">
+
+class Professor
+
+  include MagicOptions
+
+  magic_options :iq, :hair_style
+
+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
+---------
+
+<https://github.com/sheldonh/magic_options>
+
+Credits
+-------
+
+Pair programmed with [@rorymckinley][c1]
+
+[c1]: http://twitter.com/#!/rorymckinley
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/magic_options/version.rb

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

data/lib/magic_options.rb

@@ -0,0 +1,38 @@
+require "magic_options/version"
+
+module MagicOptions
+
+  def initialize(options = {})
+    options.each do |option, value|
+      magic_options_validate(option)
+      instance_variable_set "@#{option}".to_sym, value
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    attr_accessor :magic_options_allowed
+
+    def magic_options(*allowed)
+      self.magic_options_allowed = allowed
+    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)
+    end
+    raise ArgumentError, "Unknown option #{option} in new #{self.class}"
+  end
+
+end

data/magic_options.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "magic_options/version"
+
+Gem::Specification.new do |s|
+  s.name        = "magic_options"
+  s.version     = MagicOptions::VERSION
+  s.authors     = ["Sheldon Hearn", "Rory McKinley"]
+  s.email       = ["sheldonh@starjuice.net", "rorymckinley@gmail.com"]
+  s.homepage    = "http://github.com/sheldonh/magic_options"
+  s.summary     = "Ruby module to provide initialize with magic options"
+
+  s.rubyforge_project = "magic_options"
+
+  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('rspec')
+end

data/spec/magic_options/magic_options_spec.rb

@@ -0,0 +1,87 @@
+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

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: magic_options
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sheldon Hearn
+- Rory McKinley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: 
+email: 
+- sheldonh@starjuice.net
+- rorymckinley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/magic_options.rb
+- lib/magic_options/version.rb
+- magic_options.gemspec
+- spec/magic_options/magic_options_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/sheldonh/magic_options
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: magic_options
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Ruby module to provide initialize with magic options
+test_files: []
+