gnuplotter 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e22bb3e189d98c8194963a813459064cf12451e3
-  data.tar.gz: 8b6c8b99f7bac294dacefc91a79f71a44bea52b1
+  metadata.gz: ee985cfe2433db143aeb9be53f61fb781dcde027
+  data.tar.gz: 0fab1e8d3ef299dfd4b81f5421d45955ef6a1bae
 SHA512:
-  metadata.gz: d7cb5e47786b5b0a125ddd543490d232842bb41f1c34048d307b5c4f338b0f979166e60e058890135ad3d15efeefb68f3c71482e254847b00174ebbcd291351d
-  data.tar.gz: c46b8ec52c2e6df8d973e860710d5f065646444b8b578591e2b5bafe4a6516840018675b6f60ce51fdf8afe4a693208f1c8688c13b49f6f3df65ab79630cc56f
+  metadata.gz: 29b60ec46a3ce0ec355457737fe8d9ccbe52344e1ac95e97bdbeafda492103a722b5a029c267cc11074d81490f51ab0e490caebedb8d8822e61f9f232802bbef
+  data.tar.gz: 25b22ca33e40b96d03316e06fe971ae7e112cc8be235ff59934b258516896bc7f73d77c59f6efb5cd7d48e9f055357d96813f12b4466482430113e00ed754daa

data/README.md

@@ -1,2 +1,84 @@
 # gnuplotter
-Ruby wrapper for gnuplot
+
+Gnuplot is a very powerful tool to plot scientific data. This is a Ruby wrapper
+around Gnuplot with a syntax closely following Gnuplot's. 
+
+Installation
+------------
+First you must install Gnuplot. Follow the instruction at the Gnuplot website:
+
+http://www.gnuplot.info/
+
+Then install the Ruby gem run:
+
+`gem install gnuplotter`
+
+All done!
+
+Example
+-------
+
+```
+#!/usr/bin/env ruby
+
+require 'gnuplotter'
+
+data1 = [
+  [0,   0,   0.5,  0.5],
+  [0,   1,   -0.5, 0.5],
+  [1,   1,   1,    0]
+]
+
+data2 = [
+  [10,   10,   1.5,  1.5],
+  [10,   11,   -1.5, 1.5],
+  [11,   11,   11,    10]
+]
+
+gp = GnuPlotter.new
+
+gp.set title:    "Foobar"
+gp.set terminal: "dumb"
+
+gp.add_dataset(using: "1:2:3:4", with: "vectors nohead", title: "'foo'") do |plotter|
+  data1.map { |d| plotter << d }
+end
+
+gp.add_dataset(using: "1:2:3:4", with: "vectors nohead", title: "'bar'") do |plotter|
+  data2.map { |d| plotter << d }
+end
+
+puts gp.plot
+```
+
+See more examples in the `examples/` directory.
+
+Testing
+-------
+gnuplotter have a `to_gp` method that dumps a standaline Gnuplot script with
+data, which is very useful for debugging and testing. For the above example
+the output is:
+
+```
+set title "Foobar"
+set terminal dumb
+plot "-" using 1:2:3:4 with vectors nohead title 'foo', "-" using 1:2:3:4 with vectors nohead title 'bar'
+0 0 0.5 0.5
+0 1 -0.5 0.5
+1 1 1 0
+e
+10 10 1.5 1.5
+10 11 -1.5 1.5
+11 11 11 10
+e
+```
+
+
+Author
+------
+Copyright 2015 Martin Asser Hansen mail@maasha.dk
+
+License
+-------
+GPL/v2
+

data/Rakefile

@@ -0,0 +1,17 @@
+require 'pp'
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+task :default => "test"
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir['test/*'].select { |f| File.basename(f).match(/^test_.+\.rb$/) }
+  t.warning    = true
+end
+
+desc "Add or update rdoc"
+task :doc do
+  `rdoc lib/`
+end

data/examples/heatmap.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'gnuplotter'
+
+gp = GnuPlotter.new
+gp.set   title:     "Heatmap"
+gp.set   view:      "map"
+gp.set   autoscale: "xfix"
+gp.set   autoscale: "yfix"
+gp.set   nokey:     true
+gp.set   tic:       "scale 0"
+gp.set   palette:   "rgbformulae 22,13,10"
+gp.unset xtics:     true
+gp.unset ytics:     true
+
+gp.add_dataset(matrix: :true, with: "image") do |plotter|
+  row = []
+
+  0.upto(400) do |i|
+    0.upto(600) do |j|
+      row[j] = i + j
+    end
+
+    plotter << row
+  end
+end
+
+gp.splot

data/examples/histogram.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'gnuplotter'
+
+data = [
+  ["Dogs", 343],
+  ["Fishes", 143],
+  ["Cats", 123],
+  ["Birds", 321],
+  ["Bugs", 80],
+  ["Cows", 200],
+  ["Snakes", 140]
+]
+
+gp = GnuPlotter.new
+gp.set terminal:  "dumb"
+gp.set title:     "Animals"
+gp.set xlabel:    "Type"
+gp.set ylabel:    "Count"
+gp.set yrange:    "[0:*]"
+gp.set autoscale: "xfix"
+gp.set style:     "fill solid 0.5 border"
+gp.set xtics:     "out"
+gp.set ytics:     "out"
+gp.set xtics:     "rotate" # Don't work with dumb terminal, try "png"
+
+gp.add_dataset(using: "2:xticlabels(1)", with: "boxes notitle") do |plotter|
+   data.each { |d| plotter << d }
+end
+
+puts gp.plot

data/examples/lines.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'gnuplotter'
+
+data1 = [
+  [0,   0,   0.5,  0.5],
+  [0,   1,   -0.5, 0.5],
+  [1,   1,   1,    0]
+]
+
+data2 = [
+  [10,   10,   1.5,  1.5],
+  [10,   11,   -1.5, 1.5],
+  [11,   11,   11,    10]
+]
+
+gp = GnuPlotter.new
+
+gp.set title:    "Foobar"
+gp.set terminal: "dumb"
+
+gp.add_dataset(using: "1:2:3:4", with: "vectors nohead", title: "'foo'") do |plotter|
+  data1.map { |d| plotter << d }
+end
+
+gp.add_dataset(using: "1:2:3:4", with: "vectors nohead", title: "'bar'") do |plotter|
+  data2.map { |d| plotter << d }
+end
+
+puts gp.plot

data/{gnuplotter.gemspecs → gnuplotter.gemspec}

@@ -17,7 +17,5 @@ Gem::Specification.new do |s|
   s.rubygems_version  = "2.0.0"
   s.files             = `git ls-files`.split("\n")
   s.test_files        = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables       = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.extra_rdoc_files  = Dir["wiki/*.rdoc"]
   s.require_paths     = ["lib"]
 end

data/lib/gnuplotter.rb

@@ -0,0 +1,259 @@
+# >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< #
+#                                                                                #
+# Copyright (C) 2015 Martin Asser Hansen (mail@maasha.dk).                       #
+#                                                                                #
+# This program is free software; you can redistribute it and/or                  #
+# modify it under the terms of the GNU General Public License                    #
+# as published by the Free Software Foundation; either version 2                 #
+# of the License, or (at your option) any later version.                         #
+#                                                                                #
+# This program is distributed in the hope that it will be useful,                #
+# but WITHOUT ANY WARRANTY; without even the implied warranty of                 #
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                  #
+# GNU General Public License for more details.                                   #
+#                                                                                #
+# You should have received a copy of the GNU General Public License              #
+# along with this program; if not, write to the Free Software                    #
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. #
+#                                                                                #
+# http://www.gnu.org/copyleft/gpl.html                                           #
+#                                                                                #
+# >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< #
+
+require 'gnuplotter/version'
+require 'tempfile'
+require 'open3'
+
+# Error class for all things Gnuplotter.
+class GnuPlotterError < StandardError; end
+
+class GnuPlotter
+
+  # Quotes around the values of the below keys are stripped.
+  NOQUOTE = [
+    :auto,
+    :autoscale,
+    :cbrange,
+    :border,
+    :boxwidth,
+    :datafile,
+    :grid,
+    :key,
+    :logscale,
+    :nocbtics,
+    :palette,
+    :rtics,
+    :terminal,
+    :tic,
+    :style,
+    :view,
+    :yrange,
+    :ytics,
+    :xrange,
+    :xtics,
+    :ztics
+  ]
+
+  # Constructor method for a GnuPlot object.
+  def initialize
+    @options  = Hash.new { |h1, k1| h1[k1] = Hash.new { |h2, k2| h2[k2] = [] } }
+    @datasets = []
+  end
+
+  # Method to set an option in the GnuPlot environment e.g:
+  # set(title: "Nobel Prize")
+  # set(grid: :true)   # note no such thing as set(grid).
+  def set(options)
+    raise GnuPlotterError, "Non-hash options given" unless options.is_a? Hash
+
+    options.each do |key, value|
+      @options[:set][key.to_sym] << value
+    end
+
+    self
+  end
+
+  # Method to unset an option in the GnuPlot environment e.g:
+  # unset(ytics: true)   # note no such thing as unset(ytics).
+  def unset(options)
+    raise GnuPlotterError, "Non-hash options given" unless options.is_a? Hash
+
+    options.each do |key, value|
+      @options[:unset][key.to_sym] << value || true
+    end
+
+    self
+  end
+
+  # Method that returns a GnuPlot script as a list of lines.
+  def to_gp(cmd = "plot")
+    if ! @datasets.empty?
+      data_lines = []
+
+      @datasets.each do |dataset|
+        data_lines.push(*dataset.format_data, "e")
+      end
+
+      plot_settings + [data_settings(cmd, true)] + data_lines
+    else
+      plot_settings
+    end
+  end
+
+  # Method to add a dataset to the current GnuPlot.
+  #   add_dataset(using: "1:2:3:4", with: "vectors nohead", title: "'bar'") do |plotter|
+  #     data.map { |d| plotter << d }
+  #   end
+  def add_dataset(options = {})
+    raise GnuPlotterError, "No block given" unless block_given?
+
+    dataset = DataSet.new(options)
+    @datasets << dataset
+
+    yield dataset
+  end
+
+  # Method to execute the plotting of added datasets.
+  # Any plot data, i.e. dumb terminal, is returned.
+  def plot
+    gnuplot("plot")
+  end
+
+  # Method to execute the splotting of added datasets.
+  # Any plot data, i.e. dumb terminal, is returned.
+  def splot
+    gnuplot("splot")
+  end
+
+  private
+
+  # Method that calls gnuplot via open3 and performs the plotting.
+  # Any plot data, i.e. dumb terminal, is returned.
+  def gnuplot(method)
+    @datasets.each { |dataset| dataset.close }
+
+    result = nil
+
+    Open3.popen3("gnuplot -persist") do |stdin, stdout, stderr, wait_thr|
+      plot_settings.each { |line| stdin.puts line }
+
+      if @datasets.empty?
+        stdin.puts "#{method} 1/0"
+      else
+        stdin.puts data_settings(method)
+      end
+
+      stdin.close
+      result = stdout.read
+      stdout.close
+
+      exit_status = wait_thr.value
+
+      unless exit_status.success?
+        raise GnuPlotterError, stderr.read
+      end
+    end
+
+    @datasets.each { |dataset| dataset.delete }
+
+    result
+  end
+
+  # Returns a list of lines with the plot settings.
+  def plot_settings
+    lines = []
+
+    @options.each do |method, options|
+      options.each do |key, list|
+        list.each do |value|
+          if value == :true or value === true
+            lines << %Q{#{method} #{key}}
+          elsif NOQUOTE.include? key.to_sym
+            lines << %Q{#{method} #{key} #{value}}
+          else
+            lines << %Q{#{method} #{key} "#{value}"}
+          end
+        end
+      end
+    end
+
+    lines
+  end
+
+  # Returns one comma seperated line with plot settings for each dataset.
+  def data_settings(method, input = nil)
+    list = []
+
+    @datasets.each do |dataset|
+      list << dataset.format_options(input)
+    end
+
+    "#{method} " + list.join(", ")
+  end
+
+  # Nested class for GnuPlot datasets.
+  class DataSet
+    # Constructor for the DataSet object.
+    def initialize(options = {})
+      @options = options
+      @file    = Tempfile.new("gp")
+      @io      = @file.open
+    end
+
+    # Write method.
+    def <<(*obj)
+      @io.puts obj.join(" ")
+    end
+
+    alias :write :<<
+
+    # Method to close a DataSet temporary file io.
+    def close
+      @io.close unless @io.closed?
+    end
+
+    # Method to delete a DataSet temporary file.
+    def delete
+      @io.close unless @io.closed?
+      @file.unlink if File.exist? @file.path
+    end
+
+    # Method that builds a plot/splot command string from dataset options.
+    def format_options(input = nil)
+      options = []
+
+      if input
+        options << %Q{"-"}
+      else
+        options << %Q{"#{@file.path}"}
+      end
+
+      @options.each do |key, value|
+        if value == :true
+          options << "#{key}"
+        else
+          options << "#{key} #{value}"
+        end
+      end
+
+      options.join(" ")
+    end
+
+    # Method that returns data lines from file.
+    def format_data
+      lines = []
+
+      @io.close if @io.respond_to? :close
+
+      File.open(@file) do |ios|
+        ios.each do |line|
+          line.chomp!
+
+          lines << line
+        end
+      end
+
+      lines
+    end
+  end
+end

data/lib/gnuplotter/version.rb

@@ -1,3 +1,3 @@
-module GnuPlotter
-  VERSION = "0.0.0"
+class GnuPlotter
+  VERSION = "1.0.0"
 end

data/test/helper.rb

@@ -0,0 +1,54 @@
+# >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< #
+#                                                                                #
+# Copyright (C) 2007-2014 Martin Asser Hansen (mail@maasha.dk).                  #
+#                                                                                #
+# This program is free software; you can redistribute it and/or                  #
+# modify it under the terms of the GNU General Public License                    #
+# as published by the Free Software Foundation; either version 2                 #
+# of the License, or (at your option) any later version.                         #
+#                                                                                #
+# This program is distributed in the hope that it will be useful,                #
+# but WITHOUT ANY WARRANTY; without even the implied warranty of                 #
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                  #
+# GNU General Public License for more details.                                   #
+#                                                                                #
+# You should have received a copy of the GNU General Public License              #
+# along with this program; if not, write to the Free Software                    #
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. #
+#                                                                                #
+# http://www.gnu.org/copyleft/gpl.html                                           #
+#                                                                                #
+# >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< #
+#                                                                                #
+# This software is part of the Biopieces framework (www.biopieces.org).          #
+#                                                                                #
+# >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< #
+
+require 'gnuplotter'
+require 'test/unit'
+
+module Kernel
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    return out.string
+  ensure
+    $stdout = STDOUT
+  end
+
+  def capture_stderr
+    out = StringIO.new
+    $stderr = out
+    yield
+    return out.string
+  ensure
+    $stderr = STDERR
+  end
+end
+
+class Test::Unit::TestCase
+  def self.test(desc, &impl)
+    define_method("test #{desc}", &impl)
+  end
+end

data/test/test_gnuplotter.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), '..')
+
+require 'test/helper'
+
+class TestGnuPlotter < Test::Unit::TestCase 
+  def setup
+    @data1 = [
+      [0, 0, 0.5,  0.5],
+      [0, 1, -0.5, 0.5],
+      [1, 1, 1,    0]
+    ]
+
+    @data2 = [
+      [10, 10, 1.5,  1.5],
+      [10, 11, -1.5, 1.5],
+      [11, 11, 11,   10]
+    ]
+
+    @gp = GnuPlotter.new.set(title: "test").set(terminal: "dumb")
+  end
+
+  test "#to_gp with no settings returns empty array" do
+    assert_equal([], GnuPlotter.new.to_gp)
+  end
+
+  test "#set with non-hash options raises" do
+    assert_raise(GnuPlotterError) { GnuPlotter.new.set("title") }
+  end
+
+  test "#unset with non-hash options raises" do
+    assert_raise(GnuPlotterError) { GnuPlotter.new.set("title") }
+  end
+
+  test "#to_gp with set quoted and unquoted options returns correctly" do
+    gp = GnuPlotter.new.set(title: "test").set(terminal: "dumb")
+    assert_equal(['set title "test"', 'set terminal dumb'], gp.to_gp)
+  end
+
+  test "#to_gp with unset quoted and unquoted options returns correctly" do
+    gp = GnuPlotter.new.unset(title: true).unset(terminal: true)
+    assert_equal(['unset title', 'unset terminal'], gp.to_gp)
+  end
+
+  test "#add_dataset without block raises" do
+    assert_raise(GnuPlotterError) { @gp.add_dataset }
+  end
+
+  test "#to_gp with one dataset returns correctly" do
+    @gp.add_dataset(using: "1:2:3:4", with: "vectors nohead", title: "'foo'") do |plotter|
+      @data1.map { |d| plotter << d }
+    end
+
+    expected = [
+      'set title "test"',
+      'set terminal dumb',
+      'plot "-" using 1:2:3:4 with vectors nohead title \'foo\'',
+      '0 0 0.5 0.5',
+      '0 1 -0.5 0.5',
+      '1 1 1 0',
+      'e'
+    ]
+
+    assert_equal(expected, @gp.to_gp)
+  end
+
+  test "#to_gp with two datasets returns correctly" do
+    @gp.add_dataset(using: "1:2:3:4", with: "vectors nohead", title: "'foo'") do |plotter|
+        @data1.map { |d| plotter << d }
+    end
+
+    @gp.add_dataset(using: "1:2:3:4", with: "vectors nohead", title: "'bar'") do |plotter|
+        @data2.map { |d| plotter << d }
+    end
+
+    expected = [
+      'set title "test"',
+      'set terminal dumb',
+      'plot "-" using 1:2:3:4 with vectors nohead title \'foo\', "-" using 1:2:3:4 with vectors nohead title \'bar\'',
+      '0 0 0.5 0.5',
+      '0 1 -0.5 0.5',
+      '1 1 1 0',
+      'e',
+      '10 10 1.5 1.5',
+      '10 11 -1.5 1.5',
+      '11 11 11 10',
+      'e'
+    ]
+
+    assert_equal(expected, @gp.to_gp)
+  end
+
+  test "#plot produces something" do
+    @gp.add_dataset(using: "1:2:3:4", with: "vectors nohead", title: "'foo'") do |plotter|
+        @data1.map { |d| plotter << d }
+    end
+
+    assert_equal(String, @gp.plot.class)
+  end
+
+  test "#splot produces something" do
+    @gp.add_dataset(matrix: "with lines notitle") do |plotter|
+        @data1.map { |d| plotter << d }
+    end
+
+    assert_equal(String, @gp.splot.class)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnuplotter
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Martin A. Hansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-21 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies: []
 description: GnuPlotter is a wrapper around gnuplot.
 email: mail@maasha.dk
@@ -19,8 +19,15 @@ files:
 - ".gitignore"
 - LICENSE
 - README.md
-- gnuplotter.gemspecs
+- Rakefile
+- examples/heatmap.rb
+- examples/histogram.rb
+- examples/lines.rb
+- gnuplotter.gemspec
+- lib/gnuplotter.rb
 - lib/gnuplotter/version.rb
+- test/helper.rb
+- test/test_gnuplotter.rb
 homepage: http://github.com/maasha/gnuplotter
 licenses:
 - GPL2
@@ -45,4 +52,6 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: GnuPlotter
-test_files: []
+test_files:
+- test/helper.rb
+- test/test_gnuplotter.rb