invokable 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f703edf97638d502bd35c3717fb629355e17f7f1d2468376698baec50c8b495
-  data.tar.gz: a04e0e82205103781a0fff545a3a8dceb37a9eebf0103c01996331b4a060d877
+  metadata.gz: 6dcc085ff857ef0a95578db5f816338c0ade3da6ef4ecb263f86924e4b4e2cfb
+  data.tar.gz: 235f058b7b39b8ff91b8d2580281fad56a388fcea46d19ae3a4bc3657c913d1c
 SHA512:
-  metadata.gz: e79339f1c7b207ac86f2c083009e6a51972099e57fa03e3c45f45bb1b0dddf2f9c1f3fd33adab6230dac951466f3fba9b9671130c40af283ff9d2439f98fe919
-  data.tar.gz: 87263922f9790fc9dda1acc43df77cd0c3077f57998d2364ad91bdd27b2d0495455369a3a18c8026eac2623d4d2f32e1e05b61a89f9e2d55e15197329848a7cd
+  metadata.gz: bc8294c008fedd2a69337d886515b8fb9c3a2dd6fea8330b15371ffa9b44db0a5ce3c679badede4e2455230db25845ac723b11aa6736f9b62d690b462f7623e9
+  data.tar.gz: f6cab459416371d902933ee1ef3fd24f935bcc0ad7b6c9e0a9bd261bf95d8736c763ec416b94b063acf52fbc4a08df04586ac4b6bde8c02aedcb47b8f8074ef9

data/Gemfile.lock

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

data/README.md

@@ -8,46 +8,76 @@ Objects are functions! Treat any Object, Hashes, Arrays, and Sets as Procs (like
 ## Synopsis
 
 ```ruby
-  require 'invokable/hash'
+require 'invokable'
+require 'invokable/hash'
 
-  number_names = { 1 => "One", 2 => "Two", 3 => "Three" }
-  [1, 2, 3, 4].map(&number_names) # => ["One", "Two", "Three", nil]
+number_names = { 1 => "One", 2 => "Two", 3 => "Three" }
+[1, 2, 3, 4].map(&number_names) # => ["One", "Two", "Three", nil]
 ```
 
 ```ruby
-  require 'invokable/array'
+require 'invokable'
+require 'invokable/array'
 
-  alpha = ('a'..'z').to_a
-  [1, 2, 3, 4].map(&alpha) # => ["b", "c", "d", "e"]
+alpha = ('a'..'z').to_a
+[1, 2, 3, 4].map(&alpha) # => ["b", "c", "d", "e"]
 ```
 
 ```ruby
-  require 'invokable/set'
+require 'invokable'
+require 'invokable/set'
 
-  favorite_numbers = Set[3, Math::PI]
-  [1, 2, 3, 4].select(&favorite_numbers) # => [3]
+favorite_numbers = Set[3, Math::PI]
+[1, 2, 3, 4].select(&favorite_numbers) # => [3]
 ```
 
 ```ruby
-  require 'invokable'
+# service objects
+require 'invokable'
 
-  # service objects
-  class GetDataFromSomeService
-    include Invokable
+class GetDataFromSomeService
+  include Invokable
 
-    def call(user)
-      # do the dirt
-    end
+  def call(user)
+    # do the dirt
   end
+end
 
-  data_for_user = GetDataFromSomeService.new.memoize # 'memoize' makes a proc that caches results
-  User.all.map(&data_for_user)
+data_for_user = GetDataFromSomeService.new.memoize # 'memoize' makes a proc that caches results
+User.all.map(&data_for_user)
+```
+```ruby
+# command objects that enclose state, can be treated as automatically curried functions.
+require 'invokable'
+require 'invokable/command'
+
+class TwitterPoster
+  include Invokable::Command
+
+  enclose do |model|
+    @model = model
+  end
+
+  def call(user)
+    # do the dirt
+    ...
+    TwitterStatus.new(user, data)
+  end
+end
+
+TwitterPoster.call(Model.find(1)) # => #<TwitterPoster ...>
+TwitterPoster.call(Model.find(1), current_user) # => #<TwitterStatus ...>
+
+# both the class and it's instances can be used any where Procs are.
+
+Model.where(created_at: Date.today).map(&:TwitterPoster) # => [#<TwitterPoster ...>, ...]
 ```
 
 Use as much or a little as you need:
 
 ```ruby
 require 'invokable'         # loads Invokable module
+require 'invokable/command' # loads Invokable::Command module
 require 'invokable/hash'    # loads hash patch
 require 'invokable/array'   # loads array patch
 require 'invokable/set'     # loads set patch
@@ -111,6 +141,7 @@ Returns a proc that is a composition of this invokable and the given invokable.
 
 ## See Also
 
+  - [Closures and Objects are Equivalent](http://wiki.c2.com/?ClosuresAndObjectsAreEquivalent)
   - [Clojure](https://clojure.org)
   - [Arc](http://www.arclanguage.org)
 

data/lib/invokable.rb

@@ -2,6 +2,7 @@ require 'invokable/version'
 require 'invokable/core'
 require 'invokable/compose'
 
+# TODO: make use of Gem::Version
 if RUBY_VERSION.split('.').take(2).join('.').to_f < 2.6
   require 'invokable/proc'
   require 'invokable/method'

data/lib/invokable/command.rb

@@ -0,0 +1,65 @@
+module Invokable
+  # Treat "Command Objects" as curried functions
+  #
+  # @see https://ruby-doc.org/core-2.7.0/Proc.html#method-i-curry Proc#curry
+  #
+  # @version 0.5.0
+  module Command
+    def self.included(klass)
+      klass.include(Invokable)
+      klass.extend(Invokable::Core)
+      klass.extend(Invokable::Compose)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Return the "total" arity of the class (i.e. the arity of the initializer and the arity of the call method)
+      #
+      # @version 0.5.0
+      # @see https://ruby-doc.org/core-2.7.1/Proc.html#method-i-arity Proc#arity
+      # @see initializer_arity
+      #
+      # @return [Integer]
+      def arity
+        initializer_arity + instance_method(:call).arity
+      end
+  
+      # Return the arity of the initializer
+      #
+      # @version 0.5.0
+      # @see arity
+      #
+      # @return [Integer]
+      def initializer_arity
+        @initializer ? @initializer.arity : 0
+      end
+  
+      # To specify any enclosed state
+      def enclose(&block)
+        raise 'A block is required' if block.nil?
+  
+        @initializer = block
+        define_method :initialize, &block
+      end
+  
+      # Handle automatic currying--will accept either the initializer arity or the total arity of the class. If
+      # the initializer arity is used return a class instance. If the total arity is used instantiate the class
+      # and return the results of the `call` method.
+      #
+      # @version 0.5.0
+      # @see arity
+      # @see initializer_arity
+      def call(*args)
+        if args.length == initializer_arity
+          new(*args)
+        elsif args.length == arity
+          init_args = args.slice(0, initializer_arity)
+          call_args = args.slice(initializer_arity, args.length)
+          new(*init_args).call(*call_args)
+        else
+          raise "Wrong number of arguments expected #{initializer_arity} or #{arity}, got: #{args.length}"
+        end
+      end
+    end
+  end
+end

data/lib/invokable/core.rb

@@ -36,5 +36,14 @@ module Invokable
         @memo[args.hash] ||= call(*args)
       end
     end
+
+    # Return the arity (i.e. the number of arguments) of the `call` method.
+    #
+    # @version 0.5.0
+    # @see https://ruby-doc.org/core-2.7.1/Proc.html#method-i-arity Proc#arity
+    # @return [Integer]
+    def arity
+      method(:call).arity
+    end
   end
 end

data/lib/invokable/data.rb

@@ -1,3 +1,2 @@
-require_relative 'core'
 require_relative 'hash'
 require_relative 'set'

data/lib/invokable/version.rb

@@ -1,3 +1,3 @@
 module Invokable
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invokable
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Delon Newman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - invokable.gemspec
 - lib/invokable.rb
 - lib/invokable/array.rb
+- lib/invokable/command.rb
 - lib/invokable/compose.rb
 - lib/invokable/core.rb
 - lib/invokable/data.rb
@@ -89,7 +90,7 @@ metadata:
   source_code_uri: https://github.com/delonnewman/invokable
   changelog_uri: https://github.com/delonnewman/invokable#changelog
   documentation_uri: https://www.rubydoc.info/gems/invokable
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Objects are functions! Treat any Object, Hashes, Arrays and Sets as Procs
   (like Enumerable but for Proc-like objects)