algoplot 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Jon-Michael Deldin
+
+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.markdown

@@ -0,0 +1,37 @@
+# algoplot: A script for comparing the growth of functions
+
+## Examples
+
+Merge sort (O(n log n)) vs. bubble sort (O(n^2))
+
+    algoplot -o merge-vs-bubble.png 'x * log(x)' 'x^2'
+
+![merge sort vs. bubble sort plot](https://github.com/jmdeldin/algoplot/raw/master/doc/merge-vs-bubble.png)
+
+## Usage
+
+- Run `algoplot -h` for specific options
+- Use `x` instead of `n` when plotting functions
+
+## Installation
+
+You need
+
+- [Gnuplot](http://www.gnuplot.info) installed with the `gnuplot` command
+  available on your `$PATH`
+- [Ruby](http://ruby-lang.org) (only tested with 1.9.3)
+
+Once you have the prerequisites installed, simply run the following command
+from your terminal:
+
+    gem install algoplot
+
+You may need to prefix it with `sudo` depending on your setup.
+
+## Author
+
+Jon-Michael Deldin <dev@jmdeldin.com>
+
+https://github.com/jmdeldin/algoplot
+
+Feedback and patches are welcome!

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include '*.gem'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+end
+
+desc 'build gem'
+task :gemify do
+  sh "gem build algoplot.gemspec"
+end

data/algoplot.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name         = 'algoplot'
+  s.version      = '0.0.1'
+  s.date         = '2012-05-15'
+  s.summary      = "algoplot is a script to visually compare algorithms."
+  s.description  =
+    "algoplot uses Gnuplot to generate growth plots given N and functions."
+  s.authors      = ["Jon-Michael Deldin"]
+  s.email        = 'dev@jmdeldin.com'
+  s.homepage     = 'http://github.com/jmdeldin/algoplot'
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = ["algoplot"]
+  s.require_path = 'lib'
+
+  s.add_dependency('gnuplot', '>= 2.4.1')
+end

data/bin/algoplot

@@ -0,0 +1,10 @@
+#! /usr/bin/env ruby
+#
+# Run `algoplot -h` for usage.
+#
+
+require_relative '../lib/algoplot/options'
+
+opts = AlgoPlot::Options.new(ARGV).options
+
+AlgoPlot::plot(opts[:n], opts[:functions], opts[:output])

data/lib/algoplot.rb

@@ -0,0 +1,34 @@
+require 'gnuplot'
+
+module AlgoPlot
+
+  def self.get_extension(filename)
+    File.extname(filename.downcase).delete('.')
+  end
+
+  def self.is_extension_allowed?(ext)
+    %w(pdf png jpg).include? ext
+  end
+
+  # ds.with = "lines"
+  def self.create_dataset(func)
+    Gnuplot::DataSet.new(func)
+  end
+
+  def self.plot(n, functions, filename)
+    ext = get_extension(filename)
+    fail "Extension #{ext} not allowed" unless is_extension_allowed?(ext)
+    Gnuplot.open do |gp|
+      Gnuplot::Plot.new(gp) do |plot|
+        plot.terminal ext
+        plot.output filename
+        plot.xrange "[0:#{n}]"
+        plot.title "Growth of #{functions.join(', ')}"
+        plot.ylabel "steps"
+        plot.xlabel "N"
+        plot.data = functions.map { |f| create_dataset(f) }
+      end
+    end
+  end
+
+end

data/lib/algoplot/options.rb

@@ -0,0 +1,52 @@
+require 'optparse'
+require_relative '../algoplot'
+
+module AlgoPlot
+  class Options
+    attr_reader :options
+
+    SCRIPT = 'algoplot'
+
+    def initialize(argv)
+      @options = {:n => 100, :functions => [], :output => nil}
+
+      argv = ["-h"] if argv.empty?
+      parse_options(argv)
+    end
+
+    private
+
+    def parse_options(argv)
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: #{SCRIPT} -o FILE.pdf fn1 fn2 [...]"
+
+        opts.on("-n SIZE", "--size", "input size") do |n|
+          @options[:n] = n.to_i
+        end
+
+        opts.on("-o FILE", "--output", "filename (PNG, PDF, JPG)") do |o|
+          @options[:output] = o
+        end
+
+        opts.on('-h', '--help', 'show this screen') do
+          STDERR.puts opts
+          abort
+        end
+      end
+
+      parser.parse!(argv)
+
+      if options[:output].nil?
+        raise ArgumentError, "Output filename must be given\n#{parser}"
+      end
+
+      if argv.size < 2
+        raise ArgumentError, "At least two functions must be given.\n#{parser}"
+      else
+        @options[:functions] = argv
+      end
+    end
+
+
+  end
+end

data/spec/algoplot_spec.rb

@@ -0,0 +1,38 @@
+require 'minitest/autorun'
+require_relative '../lib/algoplot'
+require_relative '../lib/algoplot/options'
+
+describe :AlgoPlot do
+  it 'only accepts JPG, PNG, PDF extensions' do
+    %w(pdf png jpg).each do |ext|
+      AlgoPlot::is_extension_allowed?(ext).must_equal true
+    end
+
+    AlgoPlot::is_extension_allowed?('gif').wont_equal true
+  end
+
+  it 'separates a file extension from the filename' do
+    AlgoPlot::get_extension('example.file.png').must_equal 'png'
+  end
+
+  it 'downcases a file extension' do
+    AlgoPlot::get_extension('example.file.PNG').must_equal 'png'
+  end
+
+  it 'creates a DataSet object from a string' do
+    AlgoPlot::create_dataset('x**2').must_be_instance_of(Gnuplot::DataSet)
+  end
+
+  it 'writes plots to a file' do
+    require 'tempfile'
+    file = Tempfile.new(['plot', '.png'])
+
+    begin
+      AlgoPlot::plot(100, %w(x x**2), file.path)
+      File.size(file.path).must_be :>, 10
+    ensure
+      file.close
+      file.unlink
+    end
+  end
+end

data/spec/options_spec.rb

@@ -0,0 +1,24 @@
+require 'minitest/autorun'
+require_relative '../lib/algoplot/options'
+
+describe :Options do
+  subject { AlgoPlot::Options }
+
+  it 'fails when given fewer than two functions' do
+    lambda { subject.new(%w(x)) }.must_raise ArgumentError
+  end
+
+  it 'fails when output is omitted' do
+    lambda { subject.new(%w(x x**2)) }.must_raise ArgumentError
+  end
+
+  it 'returns a hash of options' do
+    opts = subject.new(%w(-o foo.png -n 2000 x x**2))
+
+    exp = {:n => 2000, :output => 'foo.png', :functions => %w(x x**2)}
+
+    opts.options.must_equal exp
+  end
+
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: algoplot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jon-Michael Deldin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gnuplot
+  requirement: &10669400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *10669400
+description: algoplot uses Gnuplot to generate growth plots given N and functions.
+email: dev@jmdeldin.com
+executables:
+- algoplot
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.markdown
+- Rakefile
+- algoplot.gemspec
+- bin/algoplot
+- doc/merge-vs-bubble.png
+- lib/algoplot.rb
+- lib/algoplot/options.rb
+- spec/algoplot_spec.rb
+- spec/options_spec.rb
+homepage: http://github.com/jmdeldin/algoplot
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: algoplot is a script to visually compare algorithms.
+test_files: []