invokable 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4908901ef4becc2a2de44b1ce8a23d656ac5f2a5b00b3122b59d087fdc30e7c7
-  data.tar.gz: a042c77682ff40a6d481d14cb20840113eac45757b21c13ec0e2e40f52abdad5
+  metadata.gz: faf0947e19adf5c11f17f5893122d24aa48323807dd364593a38c391e8901c34
+  data.tar.gz: a482d9ddd514251f362c149eca16774b5b4853159eb52c79653c3f5f8df5b9ac
 SHA512:
-  metadata.gz: 9e320d788d71a963d844f262a56a3c9413a016b89f050a9249d17e5cd57157d39588410f190f0b85b682c91b11c183597955a72ea508cea0460dcf1f033adf86
-  data.tar.gz: f7b08dcbf9311e95791c98df269e2533ace49abc7aba539c767aa4755db60e3d81754f4e65574094ede2f01c621167cd5270b135ea5329b36810441cf49e7dfb
+  metadata.gz: 7d2b9ac66665785662b3ab016981a4c747ab32c88e637cb2bfc2a52e34ed353e5f341a5ef178582e7a3cae584576c341aa88907967cd4722acd07c2cb29d001e
+  data.tar.gz: a89620c1f7127ed27794ef84d45803cbabaf93ceee680edf80a638f4c020551fbde83b3682d8afef70597a692158b157c701d9f3c27b634e5e24476c37f81337

data/Gemfile

@@ -7,4 +7,5 @@ gemspec
 
 group :development do
   gem 'pry'
+  gem 'yard'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    invokable (0.2.1)
+    invokable (0.2.2)
 
 GEM
   remote: https://rubygems.org/
@@ -26,6 +26,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    yard (0.9.24)
 
 PLATFORMS
   ruby
@@ -36,6 +37,7 @@ DEPENDENCIES
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
+  yard
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -62,7 +62,7 @@ many one method objects out there (e.g. ServiceObjects) that are essentially fun
 
 # API
 
-## to_proc -> a_proc
+## `to_proc -> Proc`
 
 ```ruby
 hash = { a: 1, b, 2 }
@@ -76,8 +76,7 @@ returning a proc that passes it's arguments to the object's `call` method. When
 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
+## `curry([arity]) -> 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)).

data/lib/invokable.rb

@@ -4,7 +4,7 @@ require 'invokable/version'
 module Invokable
   # If object responds to `call` convert into a Proc forwards it's arguments along to `call`.
   #
-  # @see [Proc#call]
+  # @see https://ruby-doc.org/core-2.7.0/Proc.html#method-i-call Proc#call
   # @return [Proc]
   def to_proc
     if respond_to?(:call)
@@ -17,14 +17,15 @@ module Invokable
     end
   end
 
-  # Return a curried proc. If the optional arity argument is given, it determines the number of arguments.
+  # 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]
+  # @see https://ruby-doc.org/core-2.7.0/Proc.html#method-i-curry Proc#curry
+  # @param arity [Number]
   # @return [Proc]
-  def curry(*args)
-    to_proc.curry(*args)
+  def curry(arity = nil)
+    to_proc.curry(arity)
   end
 end

data/lib/invokable/array.rb

@@ -1,6 +1,10 @@
 require_relative '../invokable'
 
+# Extend core Array object by aliasing it's `[]` method as `call`,
+# and including the `Invokable` module.
+#
+# @see https://ruby-doc.org/core-2.7.0/Array.html#method-i-5B-5D Array#[]
 class Array
   include Invokable
-  alias call at
+  alias call []
 end

data/lib/invokable/hash.rb

@@ -1,5 +1,9 @@
 require_relative '../invokable'
 
+# Extend core Hash object by aliasing it's `dig` method as `call`,
+# and including the `Invokable` module.
+#
+# @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-dig Hash#dig
 class Hash
   include Invokable
   alias call dig

data/lib/invokable/set.rb

@@ -1,6 +1,10 @@
 require 'set'
 require_relative '../invokable'
 
+# Extend stdlib Set object by aliasing it's `include?` method as `call`,
+# and including the `Invokable` module.
+#
+# @see https://ruby-doc.org/stdlib-2.7.0/libdoc/set/rdoc/Set.html#method-i-include-3F Set#include?
 class Set
   include Invokable
   alias call include?

data/lib/invokable/version.rb

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

metadata

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