invokable 0.5.0

checksums.yaml

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

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+tags

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+## 0.4.2
+
+- `invokable/array` is no longer loaded with `invokable/data`.
+   This created a bit of havok in a few places. Including breaking
+   puma bootup in Rails 5.2.4.1.

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in data-functions.gemspec
+gemspec
+
+group :development do
+  gem 'pry'
+  gem 'yard'
+end
+
+group :test do
+  gem 'gen-test'
+end

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    invokable (0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    faker (1.9.6)
+      i18n (>= 0.7)
+    gen-test (0.1.1)
+      faker (~> 1.9.6)
+      regexp-examples (~> 1.5.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (13.0.1)
+    regexp-examples (1.5.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    yard (0.9.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  gen-test
+  invokable!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  yard
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Delon Newman
+
+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,154 @@
+![Ruby](https://github.com/delonnewman/invokable/workflows/Ruby/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/invokable.svg)](https://badge.fury.io/rb/invokable)
+
+# Invokable
+
+Objects are functions! Treat any Object, Hashes, Arrays, and Sets as Procs (like Enumerable but for Procs)
+
+## Synopsis
+
+```ruby
+require 'invokable'
+require 'invokable/hash'
+
+number_names = { 1 => "One", 2 => "Two", 3 => "Three" }
+[1, 2, 3, 4].map(&number_names) # => ["One", "Two", "Three", nil]
+```
+
+```ruby
+require 'invokable'
+require 'invokable/array'
+
+alpha = ('a'..'z').to_a
+[1, 2, 3, 4].map(&alpha) # => ["b", "c", "d", "e"]
+```
+
+```ruby
+require 'invokable'
+require 'invokable/set'
+
+favorite_numbers = Set[3, Math::PI]
+[1, 2, 3, 4].select(&favorite_numbers) # => [3]
+```
+
+```ruby
+# service objects
+require 'invokable'
+
+class GetDataFromSomeService
+  include Invokable
+
+  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)
+```
+```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
+require 'invokable/data'    # loads hash and set patches
+```
+
+## Why?
+
+A function is a mapping of one value to another with the additional constraint that for the one input value you will
+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. Service Objects) that are essentially functions. Why not treat them as such?
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'invokable'
+```
+
+And then execute:
+
+    > bundle
+
+Or install it yourself as:
+
+    > gem install invokable
+
+## API
+
+### `to_proc => 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(arity = nil) => 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)).
+
+### `memoize => Proc`
+
+Returns a memoized proc, that is, a proc that caches it's return values by it's arguments.
+
+### `<<(invokable) => Proc`
+
+Returns a proc that is a composition of this invokable and the given invokable.
+
+### `>>(invokable) => Proc`
+
+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)
+
+## TODO
+
+  - benchmark Invokable#to_proc
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/invokable.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "invokable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "invokable"
+  spec.version       = Invokable::VERSION
+  spec.authors       = ["Delon Newman"]
+  spec.email         = ["contact@delonnewman.name"]
+
+  spec.summary       = %q{Objects are functions! Treat any Object, Hashes, Arrays and Sets as Procs (like Enumerable but for Proc-like objects)}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/delonnewman/invokable"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = "#{spec.homepage}#changelog"
+    spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/invokable"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/invokable.rb

@@ -0,0 +1,16 @@
+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'
+end
+
+module Invokable
+  def self.included(base)
+    base.include(Invokable::Core)
+    base.include(Invokable::Compose)
+  end
+end

data/lib/invokable/array.rb

@@ -0,0 +1,10 @@
+require_relative 'core'
+
+# 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::Core
+  alias call []
+end

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/compose.rb

@@ -0,0 +1,25 @@
+module Invokable
+  module Compose
+    # Return a proc that is the composition of this invokable and the given `invokable`.
+    # The returned proc takes a variable number of arguments, calls `invokable` with
+    # them then calls this proc with the result.
+    #
+    # @return [Proc]
+    def <<(invokable)
+      Proc.new do |*args|
+        call(invokable.call(*args))
+      end
+    end
+
+    # Return a proc that is the composition of this invokable and the given `invokable`.
+    # The returned proc takes a variable number of arguments, calls `invokable` with
+    # them then calls this proc with the result.
+    #
+    # @return [Proc]
+    def >>(invokable)
+      Proc.new do |*args|
+        invokable.call(call(*args))
+      end
+    end
+  end
+end

data/lib/invokable/core.rb

@@ -0,0 +1,49 @@
+module Invokable
+  module Core
+    # If object responds to `call` convert into a Proc forwards it's arguments along to `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)
+        # TODO: Would method(:call) be more performant? We need benchmarks.
+        Proc.new do |*args|
+          call(*args)
+        end
+      else
+        raise "Don't know how to convert #{self.inspect} into a Proc"
+      end
+    end
+  
+    # 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 https://ruby-doc.org/core-2.7.0/Proc.html#method-i-curry Proc#curry
+    # @param arity [Integer]
+    # @return [Proc]
+    def curry(arity = nil)
+      to_proc.curry(arity)
+    end
+  
+    # Return a memoized proc, that is, a proc that caches it's return values by it's arguments.
+    #
+    # @return [Proc]
+    def memoize
+      Proc.new do |*args|
+        @memo ||= {}
+        @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

@@ -0,0 +1,2 @@
+require_relative 'hash'
+require_relative 'set'

data/lib/invokable/hash.rb

@@ -0,0 +1,12 @@
+require_relative 'core'
+
+# 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
+  if RUBY_VERSION.split('.').take(2).join('.').to_f < 2.7
+    include Invokable::Core
+    alias call dig
+  end
+end

data/lib/invokable/method.rb

@@ -0,0 +1,5 @@
+require_relative 'compose'
+
+class Method
+  include Invokable::Compose
+end

data/lib/invokable/proc.rb

@@ -0,0 +1,5 @@
+require_relative 'compose'
+
+class Proc
+  include Invokable::Compose
+end

data/lib/invokable/set.rb

@@ -0,0 +1,11 @@
+require 'set'
+require_relative 'core'
+
+# 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::Core
+  alias call include?
+end

data/lib/invokable/version.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: invokable
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Delon Newman
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Objects are functions! Treat any Object, Hashes, Arrays and Sets as Procs
+  (like Enumerable but for Proc-like objects)
+email:
+- contact@delonnewman.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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
+- lib/invokable/hash.rb
+- lib/invokable/method.rb
+- lib/invokable/proc.rb
+- lib/invokable/set.rb
+- lib/invokable/version.rb
+homepage: https://github.com/delonnewman/invokable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/delonnewman/invokable
+  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:
+rdoc_options: []
+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'
+requirements: []
+rubygems_version: 3.0.6
+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)
+test_files: []