graph-function 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c946f96f1d2b6ad1677597932a09d73718cd212
+  data.tar.gz: 1384ddf665e7264e443cadbe244d1b891de6fa38
+SHA512:
+  metadata.gz: dd6abd630322b75eb5c39b0f93db4e93cc9982a3d0befee797e633fda804317bc3ca91e396e1285d9aa80456cdbfb1e29fd5bf0a1f2f50ebb35db3348df5efd3
+  data.tar.gz: f92d97f294452485d1ba65b6023b4c5ca7e0d1147eb070bc10c0801b8ab3021e7e699f3566aba4d9e38a21d9a2835aaf7a3058f1a3772a0b3e1a736072ee215e

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at your_email@example.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Alex Moore-Niemi
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Billy Everyteen
+
+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,108 @@
+# Graph::Function
+
+When I work on katas and exercises I found I often wanted to compare my implementations. After doing so a half dozen times I noticed some patterns, and figured it'd be valuable to capture those into an easier API to work with.
+
+## Disclaimer
+
+Because of the current implementation details: Ruby methods which operate on `self` **will not work**, and there is a negligible constant slow down on all functions tested because of use of `send(:func)`. The latter won't corrupt comparisons, but means you don't want to use this to benchmark functions individually except through `Graph::Function::Only`.
+
+## Installation
+
+Because this gem depends on `gnuplot` and `xquartz`, we need to follow their [prereq steps](https://github.com/rdp/ruby_gnuplot#pre-requisites-and-installation):
+
+```
+# these will vary by your system, mine is mac
+brew install Caskroom/cask/xquartz
+brew install gnuplot --with-x11
+# verify you have x11
+xpdyinfo | grep version
+```
+
+Now we're set. Add this line to your application's Gemfile:
+
+```ruby
+gem 'graph-function'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graph-function
+
+## Usage
+
+To set up, you only need the following:
+
+```ruby
+require 'graph/function'
+Graph::Function.configure
+```
+
+If you don't want to output to x11, just set `config.terminal` to a different option like `jpg`. Output is the file location of output, and is ignored for x11.
+
+```ruby
+Graph::Function.configure do |config|
+  config.terminal = 'jpg'
+	config.output = File.expand_path('../your_graph_name.jpg', __FILE__)
+end
+```
+
+For most use cases, you'll be creating a `Graph::Function::Comparison` and executing `#of` on it to provide it with `Method` objects that operate on the same parameter types<sup id="a1">[1](#f1)</sup>. `Comparison` and `Only` take a generator when initialized, but because `IntsComparison` does not, `.of` is a class method instead.
+
+The simplest usage (suitable for a large class of exercises, in my experience) is if you're comparing two functions that take a single argument of `Array[Int]` type:
+
+```ruby
+c = YourClass.new # this class has #function_name_one & #function_name_two
+Graph::Function::IntsComparison.of(c.method(:function_name_one), c.method(:function_name_two))
+# => will output an xquartz graph
+```
+
+![comparison](two_func.jpg)
+
+If your functions need to operate on other types, then you need to generate values of those types. For this, I use [Rantly](https://github.com/hayeah/rantly). Here's an example of comparing two functions that take `Hash{String => Integer}`:
+
+```ruby
+generator = proc {|size| Rantly { dict(size) { [string, integer] } }
+dict_comparison = Graph::Function::Comparison.new(generator)
+# CustomComparison can take any number of Methods
+dict_comparison.of(method(:hash_func_one), method(:hash_func_two))
+# => will output an xquartz graph
+```
+
+![comparison](custom_comparison.jpg)
+
+If you want to make use of more "real" fake data, [Faker](https://github.com/stympy/faker) is included, and can be used like so:
+
+```ruby
+faker_generator = proc {|size| Rantly(size) { call(Proc.new { Faker::Date.backward(14) }) }
+# using Only here, but anything that takes a generator can take one with Faker
+graph = Graph::Function::Only.new(faker_generator)
+graph.of(method(:custom_types))
+# => will output an xquartz graph
+```
+
+The only downside here is that you can't parameterize `Faker`, but you could use random generators to mix it up. Using the above example, `graph-function` won't pass anything into the `faker_generator` but the `size`, so if we want the value to change, we could use `Faker::Date.backward(proc { rand(10) }.call)`.
+
+Check out the [spec file](spec/graph/function_spec.rb) to see all of these and more examples.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/mooreniemi/graph-function. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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).
+
+## Footnotes
+
+<b id="f1">1</b> Why are we constrained to testing the same parameter types? The intent of this library is to graph _implementations_. Changing parameter types suggests a change in the _behavior_ of the function. That doesn't make for a very productive comparison. [↩](#a1)

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,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graph/function"
+
+require "pry"
+Pry.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/graph-function.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graph/function/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graph-function'
+  spec.version       = Graph::Function::VERSION
+  spec.authors       = ['Alex Moore-Niemi']
+  spec.email         = ['moore.niemi@gmail.com']
+
+  spec.summary       = %q{Graph function performance.}
+  spec.description   = %q{Using gnuplot and Ruby's benchmarking abilities, see the asymptotic behavior of your functions graphed.}
+  spec.homepage      = 'http://github.com/mooreniemi/graph-function'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'gnuplot'
+  spec.add_dependency 'rantly'
+  spec.add_dependency 'faker'
+  spec.add_dependency 'benchmark-memory'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+end

data/lib/graph/function/comparison.rb

@@ -0,0 +1,44 @@
+module Graph
+  module Function
+    class Comparison
+      include ReformatString
+      include PlotConfig
+      attr_accessor :data_generator
+
+      def initialize(generator)
+        @data_generator = generator
+      end
+
+      def of(*methods)
+        fail unless methods.all? {|m| m.is_a?(Method) }
+
+        methods.each do |m|
+          self.class.send(:define_method, m.name, proc(&m))
+        end
+
+        Gnuplot.open do |gp|
+          Gnuplot::Plot.new(gp) do |plot|
+
+            plot.title  "#{methods.map {|m| camel_title(m.name) }.join(', ') }"
+						set_up(plot)
+
+            x = (0..10000).step(1000).to_a
+
+            methods.each do |m|
+              y = x.collect do |v|
+                data = data_generator.call(v)
+                # FIXME can i get ride of the cost of `send`?
+                Benchmark.measure { self.send(m.name, data) }.real
+              end
+
+              plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+                ds.with = "linespoints"
+                ds.title = "#{escape_underscores(m.name)}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graph/function/ints_comparison.rb

@@ -0,0 +1,44 @@
+module Graph
+  module Function
+    class IntsComparison
+      extend ReformatString
+      extend PlotConfig
+
+      def self.of(method_one, method_two)
+        fail unless method_one.is_a?(Method) && method_two.is_a?(Method)
+
+        Gnuplot.open do |gp|
+          Gnuplot::Plot.new(gp) do |plot|
+            self.class.send(:define_method, :a, proc(&method_one))
+            self.class.send(:define_method, :b, proc(&method_two))
+
+            plot.title  "#{camel_title(method_one.name)} vs #{camel_title(method_two.name)}"
+            set_up(plot)
+
+            x = (0..10000).step(1000).to_a
+
+            y = x.collect do |v|
+              array = (0..v - 1).to_a.shuffle
+              Benchmark.measure { a(array) }.real
+            end
+
+            plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+              ds.with = "linespoints"
+              ds.title = "#{escape_underscores(method_one.name)}"
+            end
+
+            z = x.collect do |v|
+              array = (0..v - 1).to_a.shuffle
+              Benchmark.measure { b(array) }.real
+            end
+
+            plot.data << Gnuplot::DataSet.new( [x, z] ) do |ds|
+              ds.with = "linespoints"
+              ds.title = "#{escape_underscores(method_two.name)}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graph/function/only.rb

@@ -0,0 +1,39 @@
+module Graph
+  module Function
+    class Only
+      include ReformatString
+      include PlotConfig
+      attr_accessor :data_generator
+
+      def initialize(generator)
+        @data_generator = generator
+      end
+
+      def of(method_obj)
+        fail unless method_obj.is_a?(Method)
+
+        self.class.send(:define_method, :a, proc(&method_obj))
+
+        Gnuplot.open do |gp|
+          Gnuplot::Plot.new(gp) do |plot|
+
+            plot.title  "#{camel_title(method_obj.name)}"
+            set_up(plot)
+
+            x = (0..10000).step(1000).to_a
+
+            y = x.collect do |v|
+              data = data_generator.call(v)
+              Benchmark.measure { a(data) }.real
+            end
+
+            plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+              ds.with = "linespoints"
+              ds.title = "#{escape_underscores(method_obj.name)}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graph/function/plot_config.rb

@@ -0,0 +1,12 @@
+module Graph
+  module Function
+    module PlotConfig
+      def set_up(plot)
+        plot.ylabel 'execution time'
+        plot.xlabel 'input size'
+        plot.terminal (t = Graph::Function.configuration.terminal)
+        plot.output Graph::Function.configuration.output unless t == 'x11'
+      end
+    end
+  end
+end

data/lib/graph/function/reformat_string.rb

@@ -0,0 +1,12 @@
+module Graph
+  module Function
+    module ReformatString
+      def escape_underscores(s)
+        s.to_s.gsub("_", "\\_")
+      end
+      def camel_title(s)
+        s.to_s.split('_').collect(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/graph/function/version.rb

@@ -0,0 +1,5 @@
+module Graph
+  module Function
+    VERSION = "0.1.0"
+  end
+end

data/lib/graph/function.rb

@@ -0,0 +1,37 @@
+require 'gnuplot'
+require 'benchmark'
+require 'rantly'
+require 'faker'
+
+require 'graph/function/version'
+require 'graph/function/reformat_string'
+require 'graph/function/plot_config'
+require 'graph/function/only'
+require 'graph/function/comparison'
+require 'graph/function/ints_comparison'
+
+module Graph
+  module Function
+    # https://robots.thoughtbot.com/mygem-configure-block
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    class Configuration
+      attr_accessor :terminal, :output
+
+      # defaults
+      # see https://github.com/rdp/ruby_gnuplot/blob/master/examples/output_image_file.rb
+      # or http://mibai.tec.u-ryukyu.ac.jp/~oshiro/Doc/gnuplot_primer/gptermcmp.html
+      def initialize
+        @terminal = 'x11'
+        @output = '.'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: graph-function
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Moore-Niemi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gnuplot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rantly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-memory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !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'
+description: Using gnuplot and Ruby's benchmarking abilities, see the asymptotic behavior
+  of your functions graphed.
+email:
+- moore.niemi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- custom_comparison.jpg
+- graph-function.gemspec
+- lib/graph/function.rb
+- lib/graph/function/comparison.rb
+- lib/graph/function/ints_comparison.rb
+- lib/graph/function/only.rb
+- lib/graph/function/plot_config.rb
+- lib/graph/function/reformat_string.rb
+- lib/graph/function/version.rb
+- single_func.jpg
+- two_func.jpg
+homepage: http://github.com/mooreniemi/graph-function
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Graph function performance.
+test_files: []