keyword_curry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a54423b4a5b808a084833e30c8f50d31aa8ccb11
+  data.tar.gz: 3a166e85ec33b095389a1f6ee441751edcfa4f63
+SHA512:
+  metadata.gz: 79fe88752ad3916ea19c8a8ce5942306eaf5cf801a820f74981e95a615d4b20b6438c7ee8eecd229e066d8319e69cb8b7327f09db165b3e8695207e14cc37358
+  data.tar.gz: efcc0192d88858ff6b6ed41048d0be3b6603bacc4f2adc34c29ab9acdf63bbf113f3ef12c548c1c4f9b8a885862d966edc728a3e6a37447fed7d8c932d287fd0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stephen Best
+
+MIT License
+
+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.md

@@ -0,0 +1,59 @@
+# KeywordCurry
+
+Augments Ruby currying to handle MRI 2.1 required keyword arguments.
+
+Proc like objects can be curried until all their required keywords have been received
+
+Please note **monkey patching is optional**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'keyword_curry'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keyword_curry
+
+## Usage
+
+### Mnkey patching is optional
+
+This gem merely adds a couple of modules and it's up to you whether you would
+like all of your Procs monkey patched.
+
+The monkey patch version
+```ruby
+require "keyword_curry"
+
+Proc.prepend(KeywordCurry::KeywordArgumentCurrying)
+```
+
+You may wish for this behaviour only on special Procs
+```ruby
+require "keyword_curry"
+
+class SpecialProc < Proc
+  include KeywordCurry::KeywordArgumentCurrying
+
+  # ...
+end
+```
+
+### Currying Examples
+
+```ruby
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/keyword_curry.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keyword_curry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keyword_curry"
+  spec.version       = KeywordCurry::VERSION
+  spec.authors       = ["Stephen Best"]
+  spec.email         = ["bestie@gmail.com"]
+  spec.summary       = %q{Augments Ruby currying to handle required keyword arguments. Proc style objects can be curried until all its required keywords have been received}
+  spec.description   = spec.summary + %q{Proc like objects can be curried until all their required keywords have been received}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = "2.1.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/lib/keyword_curry.rb

@@ -0,0 +1,5 @@
+require "keyword_curry/version"
+
+module KeywordCurry
+  # Your code goes here...
+end

data/lib/keyword_curry/keyword_argument_currying.rb

@@ -0,0 +1,54 @@
+module KeywordArgumentCurrying
+  def curry(arity = arity)
+    required_keywords = parameters
+      .select { |param| param.first == :keyreq }
+      .map    { |param| param.last }
+
+    if required_keywords.empty?
+      super
+    else
+      curried_proc = self
+      collected_positional_args = []
+      collected_keyword_args = {}
+
+      keyword_currier = Proc.new { |keywords|
+        curried_proc.call(keywords) unless keywords.is_a?(Hash)
+
+        collected_keyword_args.merge!(keywords)
+
+        outstanding_keywords = required_keywords - collected_keyword_args.keys
+
+        if outstanding_keywords.empty?
+          curried_proc.call(*collected_positional_args, collected_keyword_args)
+        else
+          keyword_currier
+        end
+      }
+
+      positional_argument_handler = Proc.new { |*args|
+        if arity == -1
+          keyword_args = args.last if args.last.is_a?(Hash)
+
+          if keyword_args
+            positional_args = args[0..-2]
+          else
+            positional_args = args
+            keyword_args = {}
+          end
+        else
+          positional_args = args.take(curried_proc.arity)
+          keyword_args = args[curried_proc.arity..-1].first || {}
+        end
+
+        collected_positional_args += positional_args
+        keyword_currier.call(keyword_args)
+      }
+
+      if arity == 0
+        keyword_currier
+      else
+        positional_argument_handler.curry(arity)
+      end
+    end
+  end
+end

data/lib/keyword_curry/version.rb

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

data/spec/lib/keyword_curry/keyword_argument_currying_spec.rb

@@ -0,0 +1,308 @@
+require 'spec_helper'
+
+require 'keyword_curry/keyword_argument_currying'
+
+describe KeywordArgumentCurrying do
+  before(:all) {
+    Proc.prepend(KeywordArgumentCurrying)
+  }
+
+  describe "#curry" do
+    let(:spy) {
+      double(:spy, :proc_was_called => "return value")
+    }
+
+    let(:proc_return_value) { double(:proc_return_value) }
+
+    let(:pos1) { double(:pos1) }
+    let(:pos2) { double(:pos2) }
+    let(:key1) { double(:key1) }
+    let(:key2) { double(:key2) }
+
+    context "with positional args" do
+      let(:proc_to_curry) {
+        Proc.new { |pos1, pos2|
+          spy.proc_was_called(pos1, pos2)
+          proc_return_value
+        }
+      }
+
+      context "when less then the required args have been passed" do
+        it "does not call the proc_to_curry" do
+          proc_to_curry.curry.call(pos1)
+
+          expect(spy).not_to have_received(:proc_was_called)
+        end
+
+        it "returns another proc_to_curry" do
+          curried = proc_to_curry.curry.call(pos1)
+
+          expect(curried).to be_a Proc
+        end
+      end
+
+      context "when all required arguments are passed together" do
+        it "immediately calls the proc_to_curry" do
+          proc_to_curry.curry.call(pos1, pos2)
+
+          expect(spy).to have_received(:proc_was_called).with(pos1, pos2)
+        end
+
+        it "returns the proc_to_curry's return value" do
+          return_value = proc_to_curry.curry.call(pos1, pos2)
+
+          expect(return_value).to be proc_return_value
+        end
+      end
+
+      context "when all required args are passed separately" do
+        it "calls the proc_to_curry" do
+          proc_to_curry.curry
+            .call(pos1)
+            .call(pos2)
+
+          expect(spy).to have_received(:proc_was_called).with(pos1, pos2)
+        end
+
+        it "returns the proc_to_curry's return value" do
+          return_value = proc_to_curry.curry
+            .call(pos1)
+            .call(pos2)
+
+          expect(return_value).to be proc_return_value
+        end
+      end
+    end
+
+    context "with keyword arguments" do
+      context "with only optional keyword arguments" do
+        let(:proc_to_curry) {
+          Proc.new { |key1: nil|
+            spy.proc_was_called(key1: key1)
+            proc_return_value
+          }
+        }
+
+        it "immediately calls the proc_to_curry" do
+          proc_to_curry.curry.call(key1: key1)
+
+          expect(spy).to have_received(:proc_was_called).with(key1: key1)
+        end
+
+        it "returns the proc_to_curry's return value" do
+          return_value = proc_to_curry.curry.call(key1: key1)
+
+          expect(return_value).to be proc_return_value
+        end
+      end
+
+      context "with required keyword arguments" do
+        let(:proc_to_curry) {
+          Proc.new { |key1:, key2:|
+            spy.proc_was_called(key1: key1, key2: key2)
+            proc_return_value
+          }
+        }
+
+        context "before all required keywords are received" do
+          it "does not call the proc_to_curry" do
+            proc_to_curry.curry.call(key1: key1)
+
+            expect(spy).not_to have_received(:proc_was_called)
+          end
+
+          it "returns another proc_to_curry" do
+            curried_proc_to_curry = proc_to_curry.curry.call(key1: key1)
+
+            expect(curried_proc_to_curry).to be_a Proc
+          end
+        end
+
+        context "when all required keywords are received together" do
+          it "calls the proc_to_curry with all keyword arguments" do
+            proc_to_curry.curry.call(key1: key1, key2: key2)
+
+            expect(spy).to have_received(:proc_was_called)
+              .with(key1: key1, key2: key2)
+          end
+
+          it "returns the proc_to_curry's return value" do
+            return_value = proc_to_curry.curry.call(key1: key1, key2: key2)
+
+            expect(return_value).to be proc_return_value
+          end
+        end
+
+        context "when all required args are passed separately" do
+          it "calls the proc_to_curry" do
+            proc_to_curry.curry
+              .call(key1: key1)
+              .call(key2: key2)
+
+            expect(spy).to have_received(:proc_was_called)
+              .with(key1: key1, key2: key2)
+          end
+
+          it "returns the proc_to_curry's return value" do
+            return_value = proc_to_curry.curry
+              .call(key1: key1)
+              .call(key2: key2)
+
+            expect(return_value).to be proc_return_value
+          end
+        end
+      end
+    end
+
+    context "with mixed positional and keyword args" do
+      let(:proc_to_curry) {
+        Proc.new { |pos1, pos2, key1:, key2:|
+          spy.proc_was_called(pos1, pos2, key1: key1, key2: key2)
+          proc_return_value
+        }
+      }
+
+      let(:pos1) { double(:pos1) }
+      let(:pos2) { double(:pos2) }
+      let(:key1) { double(:key1) }
+      let(:key2) { double(:key2) }
+
+      context "when all args are passed together" do
+        it "immediately calls the proc_to_curry" do
+          proc_to_curry.curry
+            .call(pos1, pos2, key1: key1, key2: key2)
+
+          expect(spy).to have_received(:proc_was_called)
+            .with(pos1, pos2, key1: key1, key2: key2)
+        end
+
+        it "returns the proc_to_curry's return value" do
+          return_value = proc_to_curry.curry
+            .call(pos1, pos2, key1: key1, key2: key2)
+
+          expect(return_value).to be proc_return_value
+        end
+      end
+
+      context "when all positional arguments are passed" do
+        context "but no keywords are passed" do
+          it "does not call the proc_to_curry" do
+            proc_to_curry.curry.call(pos1, pos2)
+
+            expect(spy).not_to have_received(:proc_was_called)
+          end
+
+          it "returns another proc_to_curry" do
+            curried_proc_to_curry = proc_to_curry.curry.call(pos1, pos2)
+
+            expect(curried_proc_to_curry).to be_a Proc
+          end
+        end
+
+        context "before all required keywords have been received" do
+          it "does not call the proc_to_curry" do
+            proc_to_curry.curry
+              .call(pos1, pos2)
+              .call(key1: key1)
+
+            expect(spy).not_to have_received(:proc_was_called)
+          end
+
+          it "returns another proc_to_curry" do
+            curried_proc_to_curry = proc_to_curry.curry
+              .call(pos1, pos2)
+              .call(key1: key1)
+
+            expect(curried_proc_to_curry).to be_a Proc
+          end
+        end
+
+        context "and all required keywords have been received" do
+          it "calls the proc_to_curry" do
+            proc_to_curry.curry
+              .call(pos1, pos2)
+              .call(key1: key1)
+
+            expect(spy).not_to have_received(:proc_was_called)
+          end
+
+          it "returns the proc_to_curry's return value" do
+            return_value = curried_proc_to_curry = proc_to_curry.curry
+              .call(pos1, pos2)
+              .call(key1: key1)
+              .call(key2: key2)
+
+            expect(return_value).to be proc_return_value
+          end
+        end
+      end
+    end
+
+    context "with splatted positional arguments and keyword arguments" do
+      let(:proc_to_curry) {
+        Proc.new { |*positional_args, key1:, key2:|
+          spy.proc_was_called(*positional_args, key1: key1, key2: key2)
+          proc_return_value
+        }
+      }
+
+      it "only accepts positional args on the first call" do
+        curred_with_pos1 = proc_to_curry.curry.call(pos1)
+
+        expect {
+          curred_with_pos1.call(pos2)
+        }.to raise_error(/missing keywords: key1, key2/)
+      end
+
+      it "will accept any number of positional arguemnts on the first call" do
+        curried_with_positional_args = proc_to_curry.curry.call(
+          pos1, pos2, "something else"
+        )
+
+        curried_with_positional_args.call(key1: key1, key2: key2)
+
+        expect(spy).to have_received(:proc_was_called)
+          .with(pos1, pos2, "something else", key1: key1, key2: key2)
+      end
+
+      it "can curry keywords with the first call" do
+        curred_with_pos1_key1 = proc_to_curry.curry.call(pos1, key1: key1)
+
+        curred_with_pos1_key1.call(key2: key2)
+
+        expect(spy).to have_received(:proc_was_called)
+          .with(pos1, key1: key1, key2: key2)
+      end
+
+      it "can curry keywords after first call" do
+        curred_with_pos1 = proc_to_curry.curry.call(pos1)
+
+        curred_with_pos1
+          .call(key1: key1)
+          .call(key2: key2)
+
+        expect(spy).to have_received(:proc_was_called)
+          .with(pos1, key1: key1, key2: key2)
+      end
+
+      context "when two positional and all keyword arguments are passed together" do
+        it "immediately calls the proc with all positional and keyword arguments" do
+          proc_to_curry.curry
+            .call(pos1, pos2, key1: key1, key2: key2)
+
+          expect(spy).to have_received(:proc_was_called)
+            .with(pos1, pos2, key1: key1, key2: key2)
+        end
+      end
+
+      context "when two positional and all keyword arguments are passed together" do
+        it "immediately calls the proc with all positional and keyword arguments" do
+          proc_to_curry.curry
+            .call(pos1, pos2, key1: key1)
+
+          expect(spy).not_to have_received(:proc_was_called)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: keyword_curry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephen Best
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Augments Ruby currying to handle required keyword arguments. Proc style
+  objects can be curried until all its required keywords have been receivedProc like
+  objects can be curried until all their required keywords have been received
+email:
+- bestie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- keyword_curry.gemspec
+- lib/keyword_curry.rb
+- lib/keyword_curry/keyword_argument_currying.rb
+- lib/keyword_curry/version.rb
+- spec/lib/keyword_curry/hash_merge_currying_spec.rb
+- spec/lib/keyword_curry/keyword_argument_currying_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '='
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: Augments Ruby currying to handle required keyword arguments. Proc style objects
+  can be curried until all its required keywords have been received
+test_files:
+- spec/lib/keyword_curry/hash_merge_currying_spec.rb
+- spec/lib/keyword_curry/keyword_argument_currying_spec.rb
+- spec/spec_helper.rb