require_options 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Atomic Object
+ 
+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,34 @@
+== Description
+Simply extract named arguments from a hash.  Require or allow a set of keys.
+
+== Rationale
+When using hashes to accomplish named-argument semantics for methods, we
+noticed a common pattern:
+
+* We often pull options out into local vars at the head of a method
+* We often raise argument errors for missing keys in the hash
+
+RequireOptions accomplishes both tasks succinctly.
+
+== Install
+  script/plugin git://github.com/atomicobject/require_options.git
+  
+== Example
+  class Car
+    include RequireOptions    
+
+    def drive(opts)
+      gear, speed = require_options(opts, :speed, :gear) 
+      # opts 
+    end    
+
+    def put_in_trunk(opts)
+      allow_options opts, :flare, :tire, :luggage
+      # opts may contain any and all of the named keys, but no others
+    end
+
+    def register(opts)
+      require_at_least_one opts, :license, :ssn
+      # This method wants to use either opts[:license] OR opts[:ssn]
+    end
+  end

data/Rakefile

@@ -0,0 +1,27 @@
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = "spec/**/*_spec.rb"
+  t.spec_opts = ["-f s -c"]
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "require_options"
+    s.summary = "Simply extract named arguments from a hash.  Require or allow a set of keys."
+    s.description = "Simply extract named arguments from a hash.  Require or allow a set of keys."
+    s.email = "github@atomicobject.com"
+    s.homepage = "http://github.com/atomicobject/require_options"
+    s.authors = ["Atomic Object"]
+    s.executables = []
+    s.files =  FileList["lib/**/*.rb", "LICENSE", "Rakefile"]
+    s.test_files = FileList["spec/**/*.rb"]
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/TODO

@@ -0,0 +1 @@
+* Make gem

data/lib/require_options.rb

@@ -0,0 +1,20 @@
+module RequireOptions
+  def require_options(options, *required_keys)
+    values = required_keys.flatten.map do |key|
+      val = options[key]
+      raise "#{key} required" unless options[key]
+      val
+    end
+    values.size == 1 ? values.first : values
+  end
+  
+  def allow_options(options, *allowed_options)
+    options.keys.each do |key|
+      raise "#{key} not allowed" unless allowed_options.include?(key)
+    end
+  end
+  
+  def require_at_least_one(options, *keys)
+    raise "#{keys.join(' or ')} is required" unless keys.any? { |key| !options[key].nil? && !options[key].empty?}
+  end
+end

data/spec/require_options_spec.rb

@@ -0,0 +1,77 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "/../lib/require_options")
+
+describe RequireOptions do
+  include RequireOptions
+  
+  describe "#require_options" do
+    it "returns the list of values from the specified keys" do
+      opts = {:gear => 2, :speed => 200}
+      gear, speed = require_options(opts, :gear, :speed)
+      
+      gear.should == 2
+      speed.should == 200
+    end
+    
+    it "returns a value rather than a list of values if only one key is given" do
+      opts = {:name => "John"}
+      name = require_options(opts, :name)
+      name.should == "John"
+    end
+
+    it "does NOT reject extraneous keys" do
+      opts = {:name => "John", :tractor => "Deere"}
+      name = require_options(opts, :name)
+      name.should == "John"
+    end
+    
+    it "raises an error if given key does not exist in hash" do
+      opts = {:gear => 2}
+      lambda {
+        require_options(opts, :gear, :speed)
+      }.should raise_error("speed required")
+    end
+  end
+  
+  describe "#allow_options" do
+    it "disallows keys if they have not been specified" do
+      opts = {:name => "Jason", :age => 22}
+      lambda {
+        allow_options(opts, :age)
+      }.should raise_error("name not allowed")
+    end
+    
+    it "does nothing if keys are allowed" do
+      lambda {
+        allow_options({:name => "Josh"}, :name)
+      }.should_not raise_error
+    end
+  end
+  
+  describe "#require_at_least_one" do
+    it "ensures that at least one of the given keys is present" do
+      opts = {:license => "1234"}      
+      
+      lambda {
+        require_at_least_one(opts, :license, :ssn)
+      }.should_not raise_error
+      
+      opts = {:ssn => "4311"}
+      
+      lambda {
+        require_at_least_one(opts, :license, :ssn)
+      }.should_not raise_error
+      
+      opts = {:name => "Jane"}
+      
+      lambda {
+        require_at_least_one(opts, :license, :ssn)
+      }.should raise_error("license or ssn is required")
+      
+      opts = {:ssn => ""}
+      
+      lambda {
+        require_at_least_one(opts, :license, :ssn)
+      }.should raise_error("license or ssn is required")
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: require_options
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Atomic Object
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-31 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Simply extract named arguments from a hash.  Require or allow a set of keys.
+email: github@atomicobject.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- LICENSE
+- Rakefile
+- lib/require_options.rb
+- README.rdoc
+- TODO
+has_rdoc: true
+homepage: http://github.com/atomicobject/require_options
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simply extract named arguments from a hash.  Require or allow a set of keys.
+test_files: 
+- spec/require_options_spec.rb