itrigga-param_fu 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "1.3.0"
+  gem "rspec-rails", "1.3.2"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end
+
+group :test do
+  gem "rspec", "1.3.0"
+  gem "rspec-rails", "1.3.2"
+  gem "bundler", "~> 1.0.0"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.1.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (1.3.0)
+    rspec-rails (1.3.2)
+      rack (>= 1.0.0)
+      rspec (>= 1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (= 1.3.0)
+  rspec-rails (= 1.3.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Anson
+
+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,19 @@
+= itrigga-param_fu
+
+Validates params to methods are present and correct
+
+== Contributing to itrigga-param_fu
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Anson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "itrigga-param_fu"
+  gem.homepage = "http://gemcutter.com/itrigga-param_fu"
+  gem.license = "MIT"
+  gem.summary = %Q{Validates parameters to methods}
+  gem.description = %Q{Validates parameters to methods are present and are the required types}
+  gem.email = "support@itrigga.com"
+  gem.authors = ["Al Davidson","Anson Kelly"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'spec/version'
+require 'spec/rake/spectask'
+require 'spec/ruby'
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', 'spec/spec.opts']
+end
+
+task :default => :spec
+
+desc "Run all specs with rcov"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.rcov = true
+  t.rcov_dir = 'coverage'
+  t.rcov_opts = ['--exclude', "features,kernel,load-diff-lcs\.rb,instance_exec\.rb,lib/spec.rb,lib/spec/runner.rb,^spec/*,bin/spec,examples,/gems,/Library/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
+  t.rcov_opts << '--sort coverage --text-summary --aggregate coverage.data'
+end
+
+
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/trigga/param_fu/param_fu.rb

@@ -0,0 +1,52 @@
+module Trigga
+  module ParamFu
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+    
+    module ClassMethods
+      def require_obj_or_id(opts, key)
+        obj_or_id(opts,key)
+        raise ArgumentError.new("#{key} or #{key_with_id(key)} are required") unless opts[key_with_id(key)]
+        opts
+      end
+      
+      def require_param(opts, *keys)
+        keys.to_a.each do |k|
+          raise ArgumentError.new("#{k} is required") unless opts[k]
+        end
+        opts
+      end
+
+      def obj_or_id(opts, key)
+        opts[key_with_id(key)] ||= opts[key].id if opts[key]
+      end
+      
+      def key_with_id(key)
+        (key.to_s + '_id').to_sym
+      end
+      
+      def require_one_of( opts, *keys )
+        present = (opts.keys & keys)
+        raise ArgumentError.new( "at least one of the arguments #{keys.inspect} is required" ) if present.empty?
+        return present
+      end
+    end
+    
+    module InstanceMethods
+      def require_obj_or_id(opts,key)
+        self.class.require_obj_or_id(opts, key)
+      end
+      def obj_or_id(opts, key)
+        self.class.obj_or_id(opts, key)
+      end
+      def require_param(opts, *keys)
+        self.class.require_param(opts, *keys)
+      end
+      def require_one_of( opts, *keys )
+        self.class.require_one_of( opts, *keys )
+      end
+    end
+  end
+end

data/lib/trigga/param_fu.rb

@@ -0,0 +1,6 @@
+# allow this to be used outside of full Rails init
+this_dir =  File.dirname(__FILE__)
+$: << this_dir unless $:.include?(this_dir)
+
+#require 'trigga/param_fu'
+Dir[File.join(File.dirname(File.expand_path(__FILE__)),"param_fu","*.rb")].each {|f| require f }

data/spec/param_fu_spec.rb

@@ -0,0 +1,120 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Tester
+  include ::Trigga::ParamFu
+end
+
+describe ::Trigga::ParamFu do
+  before(:each) do
+    @t = Tester.new
+  end  
+  
+  describe "class methods" do
+    
+    describe "key_with_id" do
+      it "should add '_id' onto the given symbol" do
+        Tester.key_with_id(:blart).should == :blart_id
+      end
+    end
+    
+    describe "obj_or_id" do
+      describe "when the given hash already contains :(given_key)_id" do
+        it "should not change the value of that _id key" do
+          @my_obj = mock("object")
+          @my_obj.stub!(:id).and_return(456)
+          @my_hash = {:my_key_id=>123, :my_obj=>@my_obj}
+          Tester.obj_or_id( @my_hash, :my_key )
+          @my_hash[:my_key_id].should == 123
+        end
+      end
+      
+      describe "when the given hash does not already contain :(given_key)_id" do
+        
+        describe "and the given hash contains the given key without an added _id" do
+          it "should set the :(given_key)_id to the id of the object" do
+            @mock_obj = mock("obj")
+            @mock_obj.stub!(:id).and_return(123)
+            Tester.obj_or_id( {:my_obj=>@mock_obj}, :my_obj ).should == 123
+          end
+        end
+      end
+    end
+    
+    describe "require_param" do
+      context "when given a single key" do
+        
+        context "when key is not present in opts" do
+          it "should raise an ArgumentError" do
+            lambda{ Tester.require_param( {:key1=>'value1'}, :key2 ) }.should raise_error(ArgumentError)
+          end
+        end
+        context "when key is present in opts" do
+          it "should not raise an error" do
+            lambda{ Tester.require_param( {:key1=>'value1'}, :key1 ) }.should_not raise_error(ArgumentError)
+          end
+        end
+      end
+      context "when given multiple keys" do
+        context "when all keys are present" do
+          it "should not raise an error" do
+            lambda{ Tester.require_param( {:key1=>'value1', :key2=>'value2'}, :key2, :key1 ) }.should_not raise_error(ArgumentError)
+          end
+        end
+        context "when at least one key is not present" do
+          it "should raise an ArgumentError " do
+            lambda{ Tester.require_param( {:key1=>'value1', :key2=>'value2'}, :key2, :key1, :key3 ) }.should raise_error(ArgumentError)
+          end
+        end
+      end
+    end
+  
+    describe "require_obj_or_id" do
+      context "when the key is present" do
+        it "should not raise an error" do
+          lambda{ Tester.require_obj_or_id( {:obj_name=>'value1'}, :obj_name ) }.should_not raise_error(ArgumentError)
+        end
+      end
+      context "when the key is not present" do
+        context "when the key suffixed with _id is present" do
+          it "should not raise an error" do
+            lambda{ Tester.require_obj_or_id( {:obj_id=>'value1'}, :obj ) }.should_not raise_error(ArgumentError)
+          end
+        end
+        context "when the key is not present even suffixed with _id" do
+          it "should raise an error" do
+            lambda{ Tester.require_obj_or_id( {:key1=>'value1', :key2_id=>123}, :key3 ) }.should raise_error(ArgumentError)
+          end
+        end
+      end
+    end
+    
+    describe "require_one_of" do
+      context "when at least one of the given keys is contained in opts" do
+        it "should not raise an error" do
+          lambda{ Tester.require_one_of( {:obj=>'value1'}, :foo, :bar, :obj ) }.should_not raise_error(ArgumentError)          
+        end
+      end
+      context "when none of the given keys are contained in opts" do
+        it "should raise an error" do
+          lambda{ Tester.require_one_of( {:obj=>'value1'}, :foo, :bar ) }.should raise_error(ArgumentError)          
+        end
+      end
+    end
+  end
+  
+  describe "instance_methods" do
+    describe "require_obj_or_id" do
+      it "should call the class method require_obj_or_id" do
+        Tester.should_receive(:require_obj_or_id).with( {:key=>'val'}, :key )
+        @t.require_obj_or_id( {:key=>'val'}, :key )
+      end
+    end
+    
+    describe "obj_or_id" do
+      it "should call the class method obj_or_id" do
+        Tester.should_receive(:obj_or_id).with( {:key=>'val'}, :key )
+        @t.obj_or_id( {:key=>'val'}, :key )
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format progress
+--loadby mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+RAILS_ENV = 'test'
+ENV['RAILS_ENV'] = 'test'
+RAILS_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+$LOAD_PATH.unshift(File.join(RAILS_ROOT, 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'lib/trigga/param_fu'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["RAILS_ROOT}/support/**/*.rb"].each {|f| require f}

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: itrigga-param_fu
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Al Davidson
+- Anson Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec-rails
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+  type: :development
+description: Validates parameters to methods are present and are the required types
+email: support@itrigga.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/trigga/param_fu.rb
+- lib/trigga/param_fu/param_fu.rb
+- spec/param_fu_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://gemcutter.com/itrigga-param_fu
+licenses: 
+- MIT
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Validates parameters to methods
+test_files: []
+