funk-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 272a8ff8b3472a24d3e3230745e4aa4b02ad61b9
+  data.tar.gz: a414ef71aa521bf2e22655e72d137228e4535f2a
+SHA512:
+  metadata.gz: 27146b1bd7b71c2aa1e94fec682dd1b759238ce13c7805528b8fc8fbd90d75d6696771098d90d6e4119b8eb76addd6d52c1698cac291f2a0bd2e761b9296c1e4
+  data.tar.gz: 5dd9ff379721a8007ec06f604a97cfd84afd5c986a14affab03a2f86244c7573284043688ced7751ecb2a219cf11d4303ae588705a6505433c5a492f2f56d718

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tony Schneider
+
+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,63 @@
+# Funk
+
+Funk is a structured computation implementation inspired by Prismatic's [Graph](https://github.com/Prismatic/plumbing#graph-the-functional-swiss-army-knife) library.
+
+## Installation
+
+_Note:_ This has not yet been released on rubygems, but will be shortly.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'funk-rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install funk-rb
+
+## Usage
+
+```ruby
+# compile a graph of functions which can be inter-dependent.
+stats = Funk.compile(
+  count: -> (items) { items.length },
+  mean:  -> (items, count) { (items.reduce(:+) / count).round(1) },
+  mean_sq: -> (items, count) { (items.reduce(1) { |m, i| m + i**2 } / count).round(1) },
+  variance: -> (mean, mean_sq) { (mean_sq - mean**2).round(1) })
+
+# funk-rb figures out what order to call them in so dependencies are satisfied
+stats.call(items: (1..10).to_a.map(&:to_f))
+#=> {:items=>[1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0],
+#    :count=>10,
+#    :mean=>5.5,
+#    :mean_sq=>38.6,
+#    :variance=>8.4}
+
+# Can call the same function more than once with different input.
+stats.call(items: [1,1,2,3,5,8,13].map(&:to_f))
+#=> {:items=>[1.0, 1.0, 2.0, 3.0, 5.0, 8.0, 13.0],
+#    :count=>7,
+#    :mean=>4.7,
+#    :mean_sq=>39.1,
+#    :variance=>17.0}
+```
+
+## 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/tonywok/funk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,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 => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "funk"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/funk.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'funk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "funk-rb"
+  spec.version       = Funk::VERSION
+  spec.authors       = ["Tony Schneider", "John Andrews"]
+  spec.email         = ["tonywok@gmail.com", "john.m.andrews@gmail.com"]
+
+  spec.summary       = %q{Structured computation graphs for ruby!}
+  spec.homepage      = "https://github.com/tonywok/funk"
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+end

data/lib/funk.rb

@@ -0,0 +1,21 @@
+require "funk/version"
+require "funk/graph"
+require "funk/evaluators/eager"
+
+module Funk
+
+  def self.compile(fns, strategy: Funk::Evaluators::Eager, instruments: [])
+    graph = Graph.new(fns)
+    strategy.new(graph, instruments: instruments)
+  end
+
+  def self.compile_module(mod, **args)
+    dummy_receiver = Object.new
+    fn_hash = mod.instance_methods(false).each_with_object({}) do |meth, hash|
+      m = mod.instance_method(meth)
+      hash[meth] = m.bind(dummy_receiver)
+    end
+    compile(fn_hash, **args)
+  end
+
+end

data/lib/funk/evaluators/eager.rb

@@ -0,0 +1,42 @@
+require "funk/result"
+
+module Funk
+  module Evaluators
+    class Eager
+      attr_reader :graph
+
+      def initialize(graph, instruments: [])
+        @graph, @instruments = graph, instruments
+      end
+
+      def call(input)
+        instruments = @instruments.map{ |i| i.new }
+        @graph.tsort.each_with_object(Result.new(instruments)) do |fn, result|
+          result[fn.name] = evaluate(fn, result.merge(input), instruments)
+        end
+      end
+
+      private
+
+      def evaluate(fn, input, instruments)
+        before_call(fn, input, instruments)
+        value = fn.call(input)
+        after_call(fn, input, value, instruments)
+        value
+      end
+
+      def before_call(fn, input, instruments)
+        instruments.each do |inst|
+          inst.before_call(fn, input) if inst.respond_to?(:before_call)
+        end
+      end
+
+      def after_call(fn, input, value, instruments)
+        instruments.reverse.each do |inst|
+          inst.after_call(fn, input, value) if inst.respond_to?(:after_call)
+        end
+      end
+
+    end
+  end
+end

data/lib/funk/fn.rb

@@ -0,0 +1,64 @@
+require "set"
+require "funk/missing_dependencies_exception"
+
+module Funk
+  class Fn
+
+    REQUIRED_PARAM_TYPES = [:req, :keyreq].freeze
+
+    attr_reader :name
+    attr_reader :dependencies
+
+    def initialize(name, callable)
+      @name = name
+      @parameters = callable.parameters
+      @dependencies = @parameters.map(&:last)
+      @fn = callable
+    end
+
+    def call(hash)
+      assert_dependencies_present_in(hash)
+      args = extract_argument_values(hash)
+
+      @fn.call(*args)
+    end
+
+    private
+
+    def assert_dependencies_present_in(hash)
+      present_keys = Set.new(hash.keys)
+      deps = Set.new(dependencies)
+      unless deps.subset?(present_keys)
+        raise MissingDependenciesException, "Function #{name.inspect} is missing dependencies #{deps.difference(present_keys).to_a.inspect}"
+      end
+    end
+
+    # Check for required arguments which are missing from input values.
+    # If an argument is optional we don't raise, and we also don't use `nil`
+    # so that the proper default value will be used by the callable.
+    #
+    # One might be tempted to raise this dependency logic up a level
+    # but be warned: one Fn instance could require an argument which is
+    # optional in another Fn.
+    #
+    # NOTE: we don't currently support keyword args
+    def extract_argument_values(hash)
+      missing = []
+      args = []
+      @parameters.each do |(type, name)|
+        value = hash[name]
+        if value != Funk::NO_INPUT_PROVIDED
+          args << value
+        elsif REQUIRED_PARAM_TYPES.include?(type)
+          missing << name
+        end
+      end
+
+      if missing.empty?
+        args
+      else
+        raise MissingDependenciesException, "Function #{name.inspect} is missing dependencies #{missing.inspect}"
+      end
+    end
+  end
+end

data/lib/funk/graph.rb

@@ -0,0 +1,37 @@
+require "tsort"
+require "funk/fn"
+require "funk/input_fn"
+
+module Funk
+  class Graph
+
+    def initialize(map)
+      fn_map = map.each_with_object({}) do |(name, impl), fn_map|
+        fn = fn_map[name] = Fn.new(name, impl)
+        fn.dependencies.each do |dep_name|
+          fn_map[dep_name] ||= InputFn.new(dep_name)
+        end
+      end
+      accum = Hash.new { |h,k| h[k] = [] }
+      @nodes = fn_map.each_with_object(accum) do |(name, fn), graph|
+        graph[fn] = []
+        fn.dependencies.each do |dep_name|
+          graph[fn] << fn_map[dep_name]
+        end
+      end
+    end
+
+    # Topological Sort - exposes tsort enum
+    #
+    include TSort
+
+    def tsort_each_child(n, &b)
+      @nodes[n].each(&b)
+    end
+
+    def tsort_each_node(&b)
+      @nodes.each_key(&b)
+    end
+
+  end
+end

data/lib/funk/input_fn.rb

@@ -0,0 +1,25 @@
+require "funk/fn"
+require "funk/missing_dependencies_exception"
+
+module Funk
+  NO_INPUT_PROVIDED = Object.new
+  def NO_INPUT_PROVIDED.inspect
+    "[not provided]"
+  end
+
+  class InputFn < Fn
+
+    def initialize(name, _=nil)
+      @name = name
+      @dependencies = []
+    end
+
+    def call(input)
+      if input.has_key?(name)
+        input[name]
+      else
+        NO_INPUT_PROVIDED
+      end
+    end
+  end
+end

data/lib/funk/instruments/graph_viz.rb

@@ -0,0 +1,33 @@
+module Funk
+  module Instruments
+    class GraphViz
+      def initialize
+        @dots = []
+      end
+
+      def after_call(fn, input, value)
+        name = "node #{fn.name}"
+        style = {
+          "label" => "< #{fn.name} <br/> #{value.inspect} >",
+          "shape" => fn.is_a?(InputFn) ? "circle" : "box",
+        }
+        node = name + "[" + style.map { |attr,val| "#{attr}=#{val}" }.join(" ") + "]"
+
+        @dots << node
+        fn.dependencies.each do |dep|
+          edge = "#{dep} -> #{fn.name}"
+          @dots << edge
+        end
+      end
+
+      def digraph
+        digraph = []
+        digraph << "digraph {"
+        digraph.concat(@dots)
+        digraph << "}"
+        digraph.join("\n")
+      end
+
+    end
+  end
+end

data/lib/funk/instruments/timings.rb

@@ -0,0 +1,25 @@
+module Funk
+  module Instruments
+    class Timings
+      def initialize()
+        @timings = {}
+      end
+
+      def before_call(fn, input)
+        @timings[fn.name] = {:start => Time.now}
+      end
+
+      def after_call(fn, input, value)
+        @timings[fn.name][:end] = Time.now
+      end
+
+      def each
+        @timings.sort {|a,b|
+          a[1][:start] <=> b[1][:start]
+        }.each do |t|
+          yield t[0], t[1]
+        end
+      end
+    end
+  end
+end

data/lib/funk/missing_dependencies_exception.rb

@@ -0,0 +1,4 @@
+module Funk
+  class MissingDependenciesException < StandardError
+  end
+end

data/lib/funk/result.rb

@@ -0,0 +1,19 @@
+require "delegate"
+
+module Funk
+  class Result < Delegator
+    attr_reader :instruments
+
+    def initialize(instruments)
+      @instruments = instruments.each_with_object({}) do |inst, obj|
+        obj[inst.class.name.split("::").last] = inst
+      end
+      @result = {}
+    end
+
+    # delegate all other methods to @result hash
+    def __getobj__
+      @result
+    end
+  end
+end

data/lib/funk/version.rb

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

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: funk-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tony Schneider
+- John Andrews
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tonywok@gmail.com
+- john.m.andrews@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- funk.gemspec
+- lib/funk.rb
+- lib/funk/evaluators/eager.rb
+- lib/funk/fn.rb
+- lib/funk/graph.rb
+- lib/funk/input_fn.rb
+- lib/funk/instruments/graph_viz.rb
+- lib/funk/instruments/timings.rb
+- lib/funk/missing_dependencies_exception.rb
+- lib/funk/result.rb
+- lib/funk/version.rb
+homepage: https://github.com/tonywok/funk
+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: Structured computation graphs for ruby!
+test_files: []