gnuplot-multiplot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4c0653c1594f2ae3242908f8170dbd8b6ffa861
+  data.tar.gz: 7b7df0ec132ddd21fc57277c857e4e5954f9a904
+SHA512:
+  metadata.gz: 7d918578d37d13808ae03b1922c22285b08da6553d270c908b30bb0e88e4fc4ced6caffbc9fa908281a173287b46b3863b6e4e16e247b809d3ef1c622f413de9
+  data.tar.gz: 264ae370989eb1b9207af59c78d6f2bd3ed740d43c6d54bcf44d2290120175767c8ee719f7a00939be823c71fc0b3fa519c881557549d480445d662f713ab29c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2014 Brigham Young University
+author: John T. Prince
+
+MIT License
+
+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,75 @@
+# Gnuplot::Multiplot
+
+Enhances the gnuplot gem with a simple interface to multiplot functionality.
+
+## Installation
+
+    gem install gnuplot-multiplot
+
+gnuplot-multiplot includes gnuplot as a dependency, so you get both if you
+install the multiplot gem.
+
+## Examples
+
+```ruby
+require 'gnuplot/multiplot'
+
+x = (0..50).collect { |v| v.to_f }
+mult2 = x.map {|v| v * 2 }]
+squares = x.map {|v| v * 4 }
+
+Gnuplot.open do |gp|
+  Gnuplot::Multiplot.new(gp, layout: [2,1]) do |mp|
+    Gnuplot::Plot.new(mp) do |plot|
+      plot.data << Gnuplot::DataSet.new( [x, mult2] )
+    end
+
+    Gnuplot::Plot.new(mp) do |plot|
+      plot.data << Gnuplot::DataSet.new( [x, squares] )
+    end
+  end
+end
+```
+
+Options for multiplot may also be passed in as a gnuplot-ready String:
+
+```ruby
+Gnuplot::Multiplot.new(gp, %Q{layout 2,1 title "some title"}) do |mp|
+  ...
+end
+```
+
+## Options
+
+    title: String,
+    font: String (fontspec),
+    enhanced: true/false,   # noenhanced if false
+    layout: [num_rows,num_cols],
+    rowsfirst: true/false,  # columnsfirst if false
+    downwards: true/false,  # upwards if false
+    scale: Float (xscale)   || [Float (xscale), Float (yscale)],
+    offset: Float (xoffset) || [Float (xoffset), Float (yoffset)],
+
+## An inconsistent inferface?
+
+The gnuplot gem is very object oriented.  Virtually no options are passed in
+using a hash, as done here with multiplot.  To be consistent with the gnuplot
+gem the various properties of multiplot should probably be set as attributes
+similar to Gnuplot::DataSet.  However, given how gnuplot is currently
+implemented, it would require several hacks to achieve (e.g., the first Plot
+called would need to prompt the multiplot object to issue its commands).  This
+gem's interface, while not as consistent with the current gnuplot gem as one
+might like, is simple and minimally invasive.  To build something more
+consistent with the current gnuplot interface would require a rewrite of
+gnuplot, IMHO.
+
+## Why not just pipe in the multiplot commands directly?
+
+It's not hard to pipe in your own commands for a multiplot (it's even uglier
+than this interface, of course), but you still have to alter the default
+behavior of Plot.new to add in the necessary newlines between plots.  This gem
+takes care of those necessary newlines.
+
+## Copying
+
+MIT License (see LICENSE)

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rubabel #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/gnuplot-multiplot.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gnuplot/multiplot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gnuplot-multiplot"
+  spec.version       = Gnuplot::Multiplot::VERSION
+  spec.authors       = ["John T. Prince"]
+  spec.email         = ["jtprince@gmail.com"]
+  spec.summary       = %q{multiplot for the gnuplot gem}
+  spec.description   = %q{simple multiplot interface to enhance the gnuplot gem}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  [
+    ["gnuplot", "~> 2.6.2"],
+  ].each do |args|
+    spec.add_dependency(*args)
+  end
+
+  [
+    ["bundler", "~> 1.5.3"],
+    ["rake"],
+    ["rspec", "~> 2.14.1"], 
+    ["rdoc", "~> 4.1.0"], 
+    ["simplecov", "~> 0.8.2"],
+  ].each do |args|
+    spec.add_development_dependency(*args)
+  end
+
+end

data/lib/gnuplot/multiplot.rb

@@ -0,0 +1,52 @@
+require "gnuplot/multiplot/version"
+require 'gnuplot'
+
+module Gnuplot
+  module MultiplotBehavior
+    def initialize(io = nil, cmd = "plot")
+      reply = super(io, cmd)
+      io << "\n"
+      reply
+    end
+  end
+  class Plot
+    prepend MultiplotBehavior
+  end
+end
+
+module Gnuplot
+
+  class Multiplot
+    NEGATIVE_BOOLEANS = {
+      enhanced: :noenhanced,
+      rowsfirst: :columnsfirst,
+      downwards: :upwards,
+    }
+
+    def initialize(gnuplot, opts={}, &block)
+      string = 
+        if opts.is_a?(Hash)
+          opts.map {|key, val|
+            if NEGATIVE_BOOLEANS.has_key?(key)
+              val ? key : NEGATIVE_BOOLEANS[key]
+            else
+              pair = 
+                if val.is_a?(Array)
+                  [key, val.join(", ")]
+                elsif key == :title
+                  [key, "\"#{val}\""]
+                else
+                  [key, val]
+                end
+              pair.join(" ")
+            end
+          }.join(" ")
+        else
+          opts
+        end
+      gnuplot << "set multiplot " << string << "\n"
+      block.call(gnuplot)
+      gnuplot << "unset multiplot\n"
+    end
+  end
+end

data/lib/gnuplot/multiplot/version.rb

@@ -0,0 +1,5 @@
+module Gnuplot
+  class Multiplot
+    VERSION = "0.0.1"
+  end
+end

data/spec/gnuplot/multiplot_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require 'gnuplot/multiplot'
+require 'stringio'
+
+class String
+  def unindent 
+    gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
+  end
+end
+
+describe Gnuplot::Multiplot do
+  describe 'with a simple dataset' do
+    let(:xs) { (3..4).collect { |v| v.to_f } }
+    let(:ys) do 
+      { mult2: xs.map {|v| v * 2 },
+        square: xs.map {|v| v ** 2 }, 
+      }
+    end
+    let(:expected) {
+      <<-OUTPUT.unindent
+      set multiplot layout 2, 1 title "one title to rule them all"
+      set title "mult2"
+      plot '-' notitle
+      3.0 6.0
+      4.0 8.0
+      e
+      set title "square"
+      plot '-' notitle
+      3.0 9.0
+      4.0 16.0
+      e
+      unset multiplot
+      OUTPUT
+    }
+
+    describe 'simple plot' do
+      it 'uses hash options' do
+        gp = StringIO.new
+        Gnuplot::Multiplot.new(gp, layout: [2,1], title: "one title to rule them all", ) do |mp|
+          %i{mult2 square}.each do |response|
+            Gnuplot::Plot.new(mp) do |plot|
+              plot.title response
+              plot.data << Gnuplot::DataSet.new( [xs, ys[response]] ) {|ds| ds.notitle }
+            end
+          end
+        end
+
+        gp.rewind 
+        expect(gp.string).to eq expected
+      end
+
+      it 'uses string options' do
+        gp = StringIO.new
+        Gnuplot::Multiplot.new(gp, "layout 2, 1 title \"one title to rule them all\"" ) do |mp|
+          %i{mult2 square}.each do |response|
+            Gnuplot::Plot.new(mp) do |plot|
+              plot.title response
+              plot.data << Gnuplot::DataSet.new( [xs, ys[response]] ) {|ds| ds.notitle }
+            end
+          end
+        end
+
+        gp.rewind 
+        expect(gp.string).to eq expected
+      end
+    end
+  end
+
+
+  xit 'plots a stacked plot demo (from gnuplot demo site)'  do
+    params = {
+      boxwidth: "0.3 absolute", 
+      style: "fill solid 1.00 border",
+      tmargin: 0,
+      bmargin: 0,
+      lmargin: 3,
+      rmargin: 3,
+      yrange: "[0 : 10]",
+      key: "autotitle column nobox samplen 1 noenhanced",
+      style: "data boxes",
+      xtics: "nomirror",
+      tics: "scale 0 font \",8\"",
+    }
+    unset = %w{xtics ytics title}
+    data = { Hungary: [3,10,8,7], Germany: [2,1,1,8,1], UK: [2,9,3,3] }
+
+    Gnuplot.open do |gp|
+      Gnuplot::Multiplot.new(gp, layout: [4,1], title: "Auto-layout of stacked plots") do |mp|
+        data.each do |country, ydata|
+          Gnuplot::Plot.new(gp) do |plot|
+            params.each do |pair|
+              plot.set(*pair)
+            end
+            unset.each {|val| plot.unset(val) }
+            if country == data.keys.last
+              plot.xlabel "Immigration to U.S. by Decade"
+              plot.xtics %w(1900-1909 1910-1919 1920-infinity booyah).each_with_index.map {|v,i| "\"#{v}\" #{i}" }.join(", ")
+
+            end
+
+            plot.data << Gnuplot::DataSet.new( [[0,1,2,3], ydata] ) do |ds|
+              ds.title = country
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+
+require 'rspec/core/formatters/progress_formatter'
+# doesn't say so much about pending guys
+class QuietPendingFormatter < RSpec::Core::Formatters::ProgressFormatter
+  def example_pending(example)
+    output.print pending_color('*')
+  end
+end
+
+require 'rspec/core/formatters/documentation_formatter'
+class QuietPendingDocFormatter < RSpec::Core::Formatters::DocumentationFormatter
+  def example_pending(example)
+    output.puts pending_color( "<pending>: #{example.execution_result[:pending_message]}" )
+  end
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.formatter = QuietPendingDocFormatter
+  config.color = true
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: gnuplot-multiplot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John T. Prince
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gnuplot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: simple multiplot interface to enhance the gnuplot gem
+email:
+- jtprince@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gnuplot-multiplot.gemspec
+- lib/gnuplot/multiplot.rb
+- lib/gnuplot/multiplot/version.rb
+- spec/gnuplot/multiplot_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: multiplot for the gnuplot gem
+test_files:
+- spec/gnuplot/multiplot_spec.rb
+- spec/spec_helper.rb