fp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: baccf0eb49c70cddf93cee6e0812f39ab9fee72c
+  data.tar.gz: 724ce47500b4a7933c1d268b38d7bc85b113907e
+SHA512:
+  metadata.gz: 0cb3f3bc3129649ba39a05e740a887e44716a4263946980a7d2c792ef35015631081e32f95d06bc0c363edaaee774df2b3fe21ca28fb3bccb170fdf441e74ad4
+  data.tar.gz: 7700f5ef033f71d398822bf022766b42d5d5c0b7a9ba948c18241f9e71f32a7f7396d7b3d00d354b13b7b7fed111ceeb5d3d9d8c36063d4917ff64e3e98f0d6d

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+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 fp.gemspec
+gemspec

data/README.md

@@ -0,0 +1,186 @@
+# FP.rb
+
+This Gem provides functionality that makes it easier to use functional patterns in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fp
+
+## Usage
+
+### The FP::Fn Base Class
+
+The FP::Fn class simulates closure-like behavior with classes and familiar class syntax. It eliminates
+the boilerplate that is otherwise necessary when using classes in a functional style.
+
+This class provides a way to emulate familiar patterns from functional languages. In most functional
+languages, it is common to define functions within the body of other functions to help
+with computation.
+These inner functions have access to
+the arguments that outer function are called with, as these are part of the environment in which they are defined.
+
+Lets look at an example:
+Imagine that for some reason you had to implement exponentiation yourself, and only had addition to work with.
+Since multiplication can be define as a series of additions, and exponentiation is defined as a series of
+multiplications, you can use addition and recursive function calls to solve the problem.
+
+In Ruby, the closest example would look something like this:
+
+````ruby
+def slow_exponentiate(x, y)
+  multiply_x = ->(num_left) {
+    if num_left > 0
+      x + multiply_x.(num_left - 1)
+    else
+      0
+    end
+  }
+
+  exponentiate_x = ->(num_left) {
+    if num_left > 0
+      multiply_x.(exponentiate_x.(num_left - 1))
+    else
+      1
+    end
+  }
+
+  exponentiate_x.(y)
+end
+````
+In Haskell, this solution would look something like this:
+
+````haskell
+slowExponentiate x y =
+  let exponentiate_x 0 = 1
+      exponentiate_x num_left = multiply_x(exponentiate_x(num_left - 1))
+      multiply_x 0 = 0
+      multiply_x num_left = x + multiply_x(num_left - 1)
+  in exponentiate_x y
+````
+
+Here is similar code in JavaScript:
+
+````javascript
+function slowExponentiate(x, y) {
+  var multiplyX = function(num_left) {
+    if(num_left > 0) {
+      return x + multiplyX(num_left - 1);
+    } else {
+      return 1;
+    }
+  }
+
+  var exponentiateX = function(num_left){
+    if(num_left > 0) {
+      multiplyX(exponentiateX(num_left - 1);
+    } else {
+      return 0
+    }
+  }
+
+  return exponentiate(y);
+}
+````
+
+The thing is, many would consider this code to be ugly.
+The FP::Fn gives you the best of both worlds: the familiar syntax of
+Ruby with this powerful functional idiom.
+
+````ruby
+class SlowExponentiate < FP::Fn
+  arguments :x, :y, by: :position
+
+  def call(x, y)
+    exponentiate_x(y)
+  end
+
+  private
+  def exponentiate_x(num_left)
+    if num_left > 0
+      multiply_x(exponentiate_x(num_left - 1))
+    else
+      1
+    end
+  end
+
+  def multiply_x(num_left)
+    if num_left > 0
+      x + multiply_x(num_left-1)
+    else
+      0
+    end
+  end
+end
+
+SlowExponentiate.(2, 0) # => 1
+SlowExponentiate.(2, 1) # => 2
+SlowExponentiate.(2, 8) # => 256
+````
+
+What *exactly* does it do? Well, it:
+
+- Creates class methods that correspond to public instance methods that
+  creates a `new` instance and calls the method on that instance, returning the result.
+
+- Provides an `arguments` class method to specify the arguments that will become part of this "closure".
+
+Doing the same thing with classes normally would look something like this:
+
+````ruby
+class SlowExponentiate
+  attr_reader :x, :y
+
+  def initialize(x, y)
+    @x = x
+    @y = y
+  end
+
+  def call
+    exponentiate_x(y)
+  end
+
+  private
+  def exponentiate_x(num_left)
+    if num_left > 0
+      multiply_x(exponentiate_x(num_left - 1))
+    else
+      1
+    end
+  end
+
+  def multiply_x(num_left)
+    if num_left > 0
+      x + multiply_x(num_left-1)
+    else
+      0
+    end
+  end
+end
+
+SlowExponentiate.new(2, 8).call # => 256
+````
+
+Over time, the initialization overhead adds up, slowly making it harder to add more functionality to your code. Additionally, there are many different ways
+to write above code in pure Ruby, each with different tradeoffs.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joelmccracken/fp.rb.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fp"
+
+# 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/fp.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fp"
+  spec.version       = FP::VERSION
+  spec.authors       = ["Joel McCracken"]
+  spec.email         = ["mccracken.joel@gmail.com"]
+
+  spec.summary       = %q{A little library for functional programming}
+  spec.homepage      = "https://github.com/joelmccracken/fp.rb"
+  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 "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+end

data/fp.rb

@@ -0,0 +1,59 @@
+module FP
+  class Fn
+    def self.method_added(method_name, &block)
+      is_attr_reader = (@arguments || []).include?(method_name)
+      is_public_method = public_instance_methods.include?(method_name)
+
+      if !is_attr_reader && is_public_method
+        eval <<-EOS
+          def self.#{method_name}(*args, &block)
+            new(*args, &block).#{method_name}
+          end
+        EOS
+      end
+    end
+
+    def self.arguments(*args)
+      maybe_spec = args.last
+
+      if maybe_spec.is_a?(Hash)
+        @arguments = args[0..-2]
+        @spec = args.last
+      else
+        @arguments = args
+        @spec = nil
+      end
+
+      by_name = @spec && @spec[:by] == :name
+      by_position = @spec && [:pos, :position].include?(@spec[:by])
+      no_spec = !@spec
+
+      attr_readers = @arguments.map { |arg| ":#{arg}"}.join ", "
+
+      eval "attr_reader #{attr_readers}"
+
+      attr_assignments = @arguments.map { |arg|
+        "@#{arg} = #{arg}"
+      }.join("\n")
+
+      if by_position || no_spec
+        arguments_string = @arguments.join(", ")
+
+        eval <<-EOS
+          def initialize(#{arguments_string})
+            #{attr_assignments}
+          end
+        EOS
+      elsif by_name
+        arguments_string = @arguments.map{ |arg| "#{arg}:"}.join(", ")
+        eval <<-EOS
+          def initialize(#{arguments_string})
+            #{attr_assignments}
+          end
+        EOS
+      else
+        raise "Unknown value (#{@spec && @spec[:by]}) for arguments spec :by parameter; valid options are :name and :position"
+      end
+    end
+  end
+end

data/lib/fp.rb

@@ -0,0 +1,5 @@
+require "fp/version"
+require "fp/fn"
+
+module FP
+end

data/lib/fp/fn.rb

@@ -0,0 +1,59 @@
+module FP
+  class Fn
+    def self.method_added(method_name, &block)
+      is_attr_reader = (@arguments || []).include?(method_name)
+      is_public_method = public_instance_methods.include?(method_name)
+
+      if !is_attr_reader && is_public_method
+        eval <<-EOS
+          def self.#{method_name}(*args, &block)
+            new(*args, &block).#{method_name}
+          end
+        EOS
+      end
+    end
+
+    def self.arguments(*args)
+      maybe_spec = args.last
+
+      if maybe_spec.is_a?(Hash)
+        @arguments = args[0..-2]
+        @spec = args.last
+      else
+        @arguments = args
+        @spec = nil
+      end
+
+      by_name = @spec && @spec[:by] == :name
+      by_position = @spec && [:pos, :position].include?(@spec[:by])
+      no_spec = !@spec
+
+      attr_readers = @arguments.map { |arg| ":#{arg}"}.join ", "
+
+      eval "attr_reader #{attr_readers}"
+
+      attr_assignments = @arguments.map { |arg|
+        "@#{arg} = #{arg}"
+      }.join("\n")
+
+      if by_position || no_spec
+        arguments_string = @arguments.join(", ")
+
+        eval <<-EOS
+          def initialize(#{arguments_string})
+            #{attr_assignments}
+          end
+        EOS
+      elsif by_name
+        arguments_string = @arguments.map{ |arg| "#{arg}:"}.join(", ")
+        eval <<-EOS
+          def initialize(#{arguments_string})
+            #{attr_assignments}
+          end
+        EOS
+      else
+        raise "Unknown value (#{@spec && @spec[:by]}) for arguments spec :by parameter; valid options are :name and :position"
+      end
+    end
+  end
+end

data/lib/fp/version.rb

@@ -0,0 +1,3 @@
+module FP
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: fp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel McCracken
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-06 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: 
+email:
+- mccracken.joel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fp.gemspec
+- fp.rb
+- lib/fp.rb
+- lib/fp/fn.rb
+- lib/fp/version.rb
+homepage: https://github.com/joelmccracken/fp.rb
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A little library for functional programming
+test_files: []