functo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb30677ba2bf297b33d5172f8294e9d41a86600b
+  data.tar.gz: 3d93acaadc048c2a5022923ea765c8218fda4647
+SHA512:
+  metadata.gz: aec41c3f34032376bca10c93f10aaba7cfdf628ea1516543f12270f68f16ee29ce7f8a21c7fb19551bafa8a29eb142ef3f790964bb6e1cab9b76e2e307cfdac2
+  data.tar.gz: cd3cd144a62511eb42a8af4bb739184d2fa090b6a9d3851cd84a15315d0bb1f7c6f4287da5282241fadd946c397dd4ef980c2f87a4357b49e4d75a045fa63f58

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Samuel Scully
+
+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,153 @@
+# Functo
+
+Functo is a dynamic module for composable method objects in ruby.
+
+It turns this:
+
+```ruby
+class AddsTwo
+  attr_reader :number
+  protected :number
+
+  def initialize(number)
+    @number = number
+  end
+
+  def add
+    number + 2
+  end
+end
+```
+
+in to this:
+
+```ruby
+class AddsTwo
+  include Functo.call :add, :number
+
+  def add
+    number + 2
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'functo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install functo
+
+## Usage
+
+Functo objects can take up to three arguments.
+
+```ruby
+class Multiply
+  include Functo.call :multiply, :first, :second, :third
+
+  def multiply
+    first * second * third
+  end
+end
+
+Multiply.call(10, 20, 30)
+# => 6000
+
+class Divide
+  include Functo.call :multiply, :first, :second, :third, :fourth
+
+  def divide
+    first / second / third / fourth
+  end
+end
+# => ArgumentError: given 4 arguments when only 3 are allowed
+```
+
+If you find yourself needing more you should consider composing method objects or encapsulating some of your arguments in another object.
+
+You can use square brackets to call Functo objects:
+
+```ruby
+AddsTwo[3]
+# => 5
+```
+
+and they can be used in blocks:
+
+```ruby
+[1, 2, 3].map(&AddsTwo)
+# => [3, 4, 5]
+```
+
+### Composition
+
+Functo objects can be composed using `compose` or the turbo operator `>>`:
+
+```ruby
+AddMulti = AddsTwo.compose(MultipliesThree)
+
+AddMulti.call(3)
+# => 15
+
+MultiAdd = MultipliesThree >> AddsTwo
+
+MultiAdd[3]
+# => 11
+```
+
+The difference between the two is that the turbo operator will splat arrays passed between the composed objects but `compose` will not.
+
+```ruby
+class SplitDigits
+  include Functo.call :split, :number
+
+  def split
+    number.to_s.split(//).map(&:to_i)
+  end
+end
+
+class Sum
+  include Functo.call :sum, :first, :second, :third
+
+  def sum
+    first + second + third
+  end
+end
+
+SumDigits = SplitDigits >> Sum
+
+SumDigits[123]
+# => 6
+
+SumDigits2 = SplitDigits.compose(Sum)
+
+SumDigits2[123]
+# => ArgumentError: wrong number of arguments (given 1, expected 3)
+```
+
+## Acknowledgements
+
+Functo was inspired by these gems:
+
+* [concord](https://github.com/mbj/concord) by mbj
+* [procto](https://github.com/snusnu/procto) by snusnu
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sbscully/functo.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "functo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/functo.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'functo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "functo"
+  spec.version       = Functo::VERSION
+  spec.authors       = ["Samuel Scully"]
+  spec.email         = ["sbscully@gmail.com"]
+
+  spec.summary       = %q{Composable method objects in ruby.}
+  spec.homepage      = "https://github.com/sbscully/functo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/functo/version.rb

@@ -0,0 +1,3 @@
+class Functo < Module
+  VERSION = "0.1.0"
+end

data/lib/functo.rb

@@ -0,0 +1,108 @@
+require "functo/version"
+
+class Functo < Module
+  MAX_ARGUMENTS = 3
+
+  private_class_method :new
+
+  def self.call(*names)
+    output = names.shift
+
+    if names.length > MAX_ARGUMENTS
+      raise ArgumentError.new("given #{names.length} arguments when only #{MAX_ARGUMENTS} are allowed")
+    end
+
+    new(names, output)
+  end
+
+  private
+
+  def initialize(inputs, output)
+    @inputs = Array(inputs)
+    @output = output
+    @inputs_module = Module.new
+    @output_module = Module.new
+
+    define_initialize
+    define_readers
+    define_call
+  end
+
+  def included(host)
+    host.include(@inputs_module)
+    host.extend(@output_module)
+
+    host.extend(ClassMethods)
+  end
+
+  def define_initialize
+    ivars = @inputs.map { |name| "@#{name}" }
+    size = @inputs.size
+
+    @inputs_module.class_eval do
+      define_method :initialize do |*args|
+        args_size = args.size
+
+        if args_size != size
+          fail ArgumentError, "wrong number of arguments (#{args_size} for #{size})"
+        end
+
+        ivars.zip(args) { |ivar, arg| instance_variable_set(ivar, arg) }
+      end
+
+      private :initialize
+    end
+  end
+
+  def define_readers
+    attribute_names = @inputs
+
+    @inputs_module.class_eval do
+      attr_reader(*attribute_names)
+      protected(*attribute_names)
+    end
+  end
+
+  def define_call
+    call_method = @output
+
+    @output_module.class_eval do
+      define_method :call do |*args|
+        new(*args).public_send(call_method)
+      end
+    end
+  end
+
+  module ClassMethods
+    def [](*args)
+      call(*args)
+    end
+
+    def to_proc
+      public_method(:call).to_proc
+    end
+
+    def compose(outer, splat: false)
+      inner = self
+      klass = Class.new
+
+      klass.define_singleton_method :call do |*args|
+        if splat
+          outer.call(*inner.call(*args))
+        else
+          outer.call(inner.call(*args))
+        end
+      end
+
+      klass.extend(ClassMethods)
+
+      klass
+    end
+
+    def >>(outer)
+      compose(outer, splat: true)
+    end
+  end
+  private_constant(:ClassMethods)
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: functo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Scully
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: 
+email:
+- sbscully@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- functo.gemspec
+- lib/functo.rb
+- lib/functo/version.rb
+homepage: https://github.com/sbscully/functo
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Composable method objects in ruby.
+test_files: []