invokr 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: 54217bbbc58bdaa01e35ac2136a36f5692e8c9b3
-  data.tar.gz: 482641abbb16a1cb72e5cd4029f59ba19bf26531
-SHA512:
-  metadata.gz: e966c7c7ddb73d96ea9bc7c2cf1d52d854b77c3c34d9f75001cc0c8b6807704ae9c09465a942f84b3919e707c82baa18a46beed6ca965acf9b8cf57671200596
-  data.tar.gz: d4bc38723344baf8a3ead9501865e0f1f78c06a8f740705934698eec425ee0d812b19ab314dac51f7ef09f4e51ce3e14514939fbeccda45ddac72520abdaa3e5
+--- 
+SHA1: 
+  metadata.gz: c973b1faf440edfe2f271633ac8e036aa3c5a088
+  data.tar.gz: 1340286f0aac16980c4fb7946e7c94d5a81ff885
+SHA512: 
+  metadata.gz: 277e09fa4dce4c7a8b465b2c9fa02bff91dc4a79f2ea7ea87660fcbce02f251208106053354aa47d93872e40378b39e16717535094983843cf9a31902ad65a39
+  data.tar.gz: 238f90dc85020e397ea467f167aa0284a809eafabc075a92346e953565b7394d502eb06aa91b15a7379e4c8b5796916f0a507d6993b55a337d911f0f6f9cb37b

data/README.md

@@ -31,6 +31,14 @@ my_proc = ->|a,b| { a + b }
 Invokr.invoke proc: my_proc, with: { a: 2, b, 4 }
 ```
 
+## Using vs. With
+
+If you supply arguments that the method doesn't know how to handle, an `Invokr::ExtraArgumentsError` is raised. This is because, in general, you can't supply extra arguments to a plain old ruby method. However, from time to time we want to be able to pass in extra arguments. You can use the `using` keyword in order to simulate the behavior of the splat (`*`) operator:
+
+```ruby
+Invokr.invoke method: :add_transaction, on: bank_account, with: { amount: 12.34, account_id: 24, extra_arg: 'hey, there' }
+```
+
 ## Querying 
 
 Want to investigate the arguments of a method?
@@ -59,11 +67,6 @@ end
 
 Without knowing how to parse the source code for `#my_method`, Invokr couldn't know what the default values are. And even if I brought in e.g. [ruby_parser](https://github.com/seattlerb/ruby_parser), I'd have to support lazy evaluation, for when you supply a method or constant as the default. This complexity is completely unneccessary when using keyword arguments, so I suggest using that approach for multiple defaults for now.
 
-## Todo
-
-* Cleanup
-* Use the `Invokr::Method` object within the `Invokr::Builder`.
-
 ## Pre-keyword argument hash defaults
 
 Before ruby 2.x introduced keyword arguments, it was common to end your method signature with a default hash, e.g. `def my_method args = {}`. Invoker supports this by building a Hash out of all the unused arguments you passed in, and passing *that* into the optional argument.
@@ -85,6 +88,11 @@ Invokr.inject MyKlass, using: { foo: 'FOO', bar: 'BAR', baz: 'BAZ' }
 
 Even though `MyKlass` doesn't depend on `baz`, because everything it *did* need was present in the `using` Hash, Invokr was able to instantiate an instance of `MyKlass`
 
+## Todo
+
+* Cleanup
+* Use the `Invokr::Method` object within the `Invokr::Builder`.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/invokr/fork )

data/lib/invokr.rb

@@ -30,25 +30,30 @@ module Invokr
   private
 
   def invoke_method args = {}
-    method_name, obj, hsh_args = require_arguments! args, :method, :on, :with
+    method_name, obj, hsh_args = require_arguments! args, :method, :on, [:with, :using]
+    allow_unused = args.has_key? :using
     method = obj.method method_name
-    invocation = Builder.build method, hsh_args, args[:block]
+    invocation = Builder.build method, hsh_args, args[:block], allow_unused
     invocation.invoke! obj
   end
 
   def invoke_proc _proc, args = {}
-    hsh_args = require_arguments! args, :with
-    invocation = Builder.build _proc, hsh_args, args[:block]
+    hsh_args = require_arguments! args, [:with, :using]
+    allow_unused = args.has_key? :using
+    invocation = Builder.build _proc, hsh_args, args[:block], allow_unused
     obj = SimpleDelegator.new _proc
     invocation.invoke! obj
   end
 
   def require_arguments! hsh, *args
     found_args, missing_args = args.partition do |arg|
-      hsh.has_key? arg
+      Array(arg).any? &hsh.method(:has_key?)
     end
     raise InputError.new missing_args unless missing_args.empty?
-    list = found_args.map { |arg| hsh.fetch arg }
+    list = found_args.map do |arg|
+      pair = hsh.detect do |k,_| Array(arg).include? k end
+      pair.fetch 1
+    end
     args.size == 1 ? list.first : list
   end
 end

data/lib/invokr/builder.rb

@@ -7,12 +7,13 @@ module Invokr
 
     attr :argument_names, :injector, :method, :missing_args, :unused_args
 
-    def initialize method, injector, implicit_block
+    def initialize method, injector, implicit_block, allow_unused = false
       @argument_names = method.parameters.map &:last
       @injector = injector
       @method = method
       @opt_arg_name = nil
 
+      @allow_unused = allow_unused
       @block_arg = nil
       @implicit_block = implicit_block
       @keyword_args = {}
@@ -24,7 +25,7 @@ module Invokr
 
     def build
       handle_args!
-      check_for_unused_args!
+      check_for_unused_args! unless @allow_unused
       check_for_missing_args!
       build_invocation
     end

data/lib/invokr/errors.rb

@@ -4,7 +4,7 @@ module Invokr
 
     def initialize missing_args
       @missing_args = missing_args
-      missing_args.map! do |arg| "`#{arg}'" end
+      missing_args.map! do |arg| display arg end
     end
 
     def message
@@ -22,6 +22,13 @@ module Invokr
       last_arg = missing_args.pop
       "#{missing_args.join ', '} and #{last_arg}"
     end
+
+    def display arg
+      list = Array(arg).map do |arg| "`#{arg}'" end
+      str = list * " or "
+      str.insert 0, "either " if list.size > 1
+      str
+    end
   end
 
   class BadArgumentsError < ArgumentError

data/lib/invokr/version.rb

@@ -1,3 +1,3 @@
 module Invokr
-  VERSION = "0.9.5"
+  VERSION = "0.9.6"
 end

data/test/dependency_injection_test.rb

@@ -58,7 +58,7 @@ class DependencyInjectionExampleTest < Minitest::Test
       [[:req, :foo],[:req, :bar]]
     end
 
-    def call(foo, bar)
+    def call foo, bar
       OpenStruct.new foo: foo, bar: bar
     end
   end

data/test/invokr_test.rb

@@ -7,13 +7,21 @@ class InvokrTest < Minitest::Test
     assert_equal 5, result
   end
 
+  def test_using_keyword_overrides_extra_arguments_error
+    my_proc = ->a,b{a**b}
+
+    result = Invokr.invoke proc: my_proc, using: { a: 2, b: 3, c: nil }
+
+    assert_equal 8, result
+  end
+
   def test_incorrectly_invoking
     error = assert_raises Invokr::InputError do
       Invokr.invoke
     end
 
     assert_equal(
-      "cannot invoke; missing required arguments: `method', `on' and `with'",
+      "cannot invoke; missing required arguments: `method', `on' and either `with' or `using'",
       error.message,
     )
   end

metadata

@@ -1,79 +1,64 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: invokr
-version: !ruby/object:Gem::Version
-  version: 0.9.5
+version: !ruby/object:Gem::Version 
+  version: 0.9.6
 platform: ruby
-authors:
+authors: 
 - ntl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-12-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.6"
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *id001
   type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id003 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  name: minitest
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-red_green
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *id002
   type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
+  name: minitest-red_green
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *id004
   type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *id005
+  type: :development
 description: Invoke methods with a consistent Hash interface. Useful for metaprogramming.
-email:
+email: 
 - nathanladd+github@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- ".gitignore"
+
+files: 
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -98,30 +83,29 @@ files:
 - test/rest_args_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ntl/invokr
-licenses:
+licenses: 
 - MIT
 metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Invoke methods with a consistent Hash interface.
-test_files:
+test_files: 
 - test/block_args_test.rb
 - test/dependency_injection_test.rb
 - test/invokr_test.rb