invokable 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1704e11155d49e8801c46591a662a28633d93c7c069fa7a52c5412d4aa9a2162
-  data.tar.gz: 016e698868ebfe51cfd36c304391a0932a45e743f262fcd6004c208f6b8b3c09
+  metadata.gz: 4908901ef4becc2a2de44b1ce8a23d656ac5f2a5b00b3122b59d087fdc30e7c7
+  data.tar.gz: a042c77682ff40a6d481d14cb20840113eac45757b21c13ec0e2e40f52abdad5
 SHA512:
-  metadata.gz: b6ea38312e09b45aae62501b6d1ea623d991a358aae63c4056150d28bac91c039b795c58b67c7f6fedc8c8e336fa2dbed456739cf333164db11237c4e865085b
-  data.tar.gz: 888c37a34ba29d412b2451d28cc22b0da328f978fc08445e5872e5b8d2e293d8261132209cf1bca63148762a888592dfa9d3c466e24f55345f4d0df81d19a236
+  metadata.gz: 9e320d788d71a963d844f262a56a3c9413a016b89f050a9249d17e5cd57157d39588410f190f0b85b682c91b11c183597955a72ea508cea0460dcf1f033adf86
+  data.tar.gz: f7b08dcbf9311e95791c98df269e2533ace49abc7aba539c767aa4755db60e3d81754f4e65574094ede2f01c621167cd5270b135ea5329b36810441cf49e7dfb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    invokable (0.2.0)
+    invokable (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -60,6 +60,28 @@ A function is a mapping of one value to another with the additional constraint t
 always get the same output value. So, conceptually, Ruby Hashes, Arrays, and Sets are all functions. Also, there are
 many one method objects out there (e.g. ServiceObjects) that are essentially functions. Why not treat them as such?
 
+# API
+
+## to_proc -> a_proc
+
+```ruby
+hash = { a: 1, b, 2 }
+hash.class          # => Hash
+hash.to_proc.class  # => Proc
+[:a, :b].map(&hash) # => [1, 2]
+```
+
+Convert an object into a proc. When the `Invokable` module is included in a class it will do this by
+returning a proc that passes it's arguments to the object's `call` method. When `invokable/data` is
+loaded `Hash#call` is mapped to `Hash#dig`, `Array#call` is mapped to `Array#at`, and `Set#call`
+is mapped to `Set#include?`.
+
+## curry -> a_proc
+## curry(arity) -> a_proc
+
+Returns a curried proc. If the `arity` is given, it determines the number of arguments.
+(see [Proc#curry](https://ruby-doc.org/core-2.7.0/Proc.html#method-i-curry)).
+
 # Installation
 
 Add this line to your application's Gemfile:
@@ -83,7 +105,7 @@ Or install it yourself as:
 
 # TODO
 
-  - add support for `curry`, `memoize` and maybe transducers.
+  - add support for `memoize` and maybe transducers.
   - benchmark Invokable#to_proc
 
 # License

data/lib/invokable.rb

@@ -1,9 +1,10 @@
 require 'invokable/version'
 
-# TODO: Add curry, memoize, transducers?
+# TODO: Add memoize, transducers?
 module Invokable
   # If object responds to `call` convert into a Proc forwards it's arguments along to `call`.
   #
+  # @see [Proc#call]
   # @return [Proc]
   def to_proc
     if respond_to?(:call)
@@ -16,7 +17,14 @@ module Invokable
     end
   end
 
-  def curry
-    to_proc.curry
+  # Return a curried proc. If the optional arity argument is given, it determines the number of arguments.
+  # A curried proc receives some arguments. If a sufficient number of arguments are supplied, it passes the
+  # supplied arguments to the original proc and returns the result. Otherwise, returns another curried proc
+  # that takes the rest of arguments.
+  #
+  # @see [Proc#curry]
+  # @return [Proc]
+  def curry(*args)
+    to_proc.curry(*args)
   end
 end

data/lib/invokable/version.rb

@@ -1,3 +1,3 @@
 module Invokable
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: invokable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Delon Newman