gnuplotrb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d42c4f1c4c5be11d3c393f511a24de68744aeac1
+  data.tar.gz: dc1035d41e16bfd1413f22bfe37194747f8e4966
+SHA512:
+  metadata.gz: 6d0d96f5abeec5638c9642cc08f73caf3cbdc00695b820a159d00a52cdba780c928072f65b0ee6d11e163aab52c2ace600c3d78b3be0017a51890636c3aaa100
+  data.tar.gz: 5cf75980f6ba0ddbb262f8062d7bb7c009ad970df5a4ed9988b4256d35badf3d2bb867d91f9bd21d32cf2c8cccd7ab0c03706fc92f6f6e766cd9d82dc12b660a

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ivan Evgrafov
+
+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.rdoc

@@ -0,0 +1,34 @@
+= GnuplotRB
+
+This is part of ruby gnuplot gem. It already can plot something (see examples and notebooks) but some features still waiting for implementation.
+
+{<img src="https://travis-ci.org/dilcom/gnuplotrb.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/dilcom/gnuplotrb]
+{<img src="https://codeclimate.com/github/dilcom/gnuplotrb/badges/gpa.svg" alt="Code quality" />}[https://codeclimate.com/github/dilcom/gnuplotrb]
+{<img src="https://codeclimate.com/github/dilcom/gnuplotrb/badges/coverage.svg" alt="Test coverage" />}[https://codeclimate.com/github/dilcom/gnuplotrb]
+
+
+== Installation
+While gem isn't on rubygems, it may be installed from source.
+=== Dependencies
+* Ruby 2.0+
+* It is required to install {gnuplot 5.0}[http://www.gnuplot.info/download.html] to use that gem.
+=== Gem installation
+==== Install latest version from repository (may be unstable)
+  git clone https://github.com/dilcom/gnuplotrb.git
+  cd gnuplotrb
+  bundle install
+  rake install
+==== Install latest stable vrsion
+  gem install gnuplotrb
+==== Install latest stable vrsion using bundler
+* add
+    gem 'gnuplotrb'
+  to your Gemfile
+* run
+    bundle install
+
+== Plain examples
+You may find several examples in {examples directory}[https://github.com/dilcom/gnuplotrb/tree/master/examples]
+
+== Notebooks with examples
+You may find several iRuby notebooks and readme for them in {notebooks directory}[https://github.com/dilcom/gnuplotrb/tree/master/notebooks]

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rspec/core'
+require 'rdoc/task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb'].uniq
+  spec.rspec_opts = '--format documentation'
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include %w(README.rdoc lib)
+end
+
+RuboCop::RakeTask.new

data/gnuplotrb.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gnuplotrb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gnuplotrb'
+  spec.version       = GnuplotRB::VERSION
+  spec.authors       = ['Ivan Evgrafov']
+  spec.email         = ['dilcom3107@gmail.com']
+
+  spec.summary       = 'Ruby bindings for gnuplot'
+  spec.description   = 'Renewed ruby bindings for gnuplot. Started at GSoC 2015.'
+  spec.homepage      = 'https://github.com/dilcom/gnuplotrb'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|unimplemented_features|examples|future_work|notebooks|\..+)/) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'hamster', '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rdoc', '~> 4.2'
+  spec.add_development_dependency 'rubocop', '~> 0.29'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'chunky_png'
+  spec.add_development_dependency 'daru'
+end

data/lib/gnuplotrb.rb

@@ -0,0 +1,30 @@
+require 'tempfile'
+require 'hamster'
+require 'open3'
+
+def require_if_available(name)
+  begin
+    require name
+  rescue LoadError
+    false
+  end
+end
+
+require_if_available('daru')
+
+require 'gnuplotrb/external_classes/string'
+require 'gnuplotrb/external_classes/array'
+require 'gnuplotrb/external_classes/daru'
+require 'gnuplotrb/external_classes/iruby'
+
+require 'gnuplotrb/version'
+require 'gnuplotrb/staff/settings'
+require 'gnuplotrb/mixins/option_handling'
+require 'gnuplotrb/mixins/error_handling'
+require 'gnuplotrb/mixins/plottable'
+require 'gnuplotrb/staff/terminal'
+require 'gnuplotrb/staff/datablock'
+require 'gnuplotrb/staff/dataset'
+require 'gnuplotrb/plot'
+require 'gnuplotrb/splot'
+require 'gnuplotrb/multiplot'

data/lib/gnuplotrb/external_classes/array.rb

@@ -0,0 +1,14 @@
+class Array
+  # taken for example from current gnuplot bindings
+  def to_gnuplot_points
+    return '' if self.empty?
+    case self[0]
+    when Array
+      self[0].zip(*self[1..-1]).map { |a| a.join(' ') }.join("\n")
+    when Numeric
+      join("\n")
+    else
+      self[0].zip(*self[1..-1]).to_gnuplot_points
+    end
+  end
+end

data/lib/gnuplotrb/external_classes/daru.rb

@@ -0,0 +1,25 @@
+if defined? Daru
+  module Daru
+    class DataFrame
+      def to_gnuplot_points
+        result = ''
+        self.each_row_with_index do |row, index|
+          result += "#{index.to_s} "
+          result += row.to_a.join(' ')
+          result += "\n"
+        end
+        result
+      end
+    end
+
+    class Vector
+      def to_gnuplot_points
+        result = ''
+        self.each_with_index do |value, index|
+          result += "#{index} #{value}\n"
+        end
+        result
+      end
+    end
+  end
+end

data/lib/gnuplotrb/external_classes/iruby.rb

@@ -0,0 +1,18 @@
+if defined?(IRuby)
+  module GnuplotRB
+    module Plottable
+      def to_iruby
+        available_terminals = {
+          'png'      => 'image/png',
+          'pngcairo' => 'image/png',
+          'jpeg'     => 'image/jpeg',
+          'svg'      => 'image/svg+xml',
+          'dumb'     => 'text/plain'
+        }
+        terminal, options = term.is_a?(Array) ? [term[0], term[1]] : [term, {}]
+        terminal = 'svg' unless available_terminals.keys.include?(terminal)
+        [available_terminals[terminal], self.send("to_#{terminal}".to_sym, **options)]
+      end
+    end
+  end
+end

data/lib/gnuplotrb/external_classes/string.rb

@@ -0,0 +1,5 @@
+class String
+  def to_gnuplot_points
+    clone
+  end
+end

data/lib/gnuplotrb/mixins/error_handling.rb

@@ -0,0 +1,42 @@
+module GnuplotRB
+  ##
+  # Just a new error name
+  class GnuplotError < ArgumentError
+  end
+
+  ##
+  # Mixin for classes that need to run subprocess and
+  # handle errors from its stderr.
+  module ErrorHandling
+    ##
+    # ====== Overview
+    # Check if there were errors in previous commands.
+    # Throws GnuplotError in case of any errors.
+    def check_errors
+      unless @err_array.empty?
+        command = @err_array.first
+        rest = @err_array[1..-1].join('; ')
+        message = "Error in previous command (\"#{command}\"): \"#{rest}\""
+        @err_array.clear
+        fail GnuplotError, message
+      end
+    end
+
+    ##
+    # ====== Overview
+    # Start new thread that will read stderr given as stream
+    # and add errors into @err_array.
+    def handle_stderr(stream)
+      @err_array = []
+      Thread.new do
+        until (line = stream.gets).nil? do
+          line.strip!
+          @err_array << line if line.size > 3
+        end
+      end
+    end
+
+    private :check_errors,
+            :handle_stderr
+  end
+end

data/lib/gnuplotrb/mixins/option_handling.rb

@@ -0,0 +1,157 @@
+module GnuplotRB
+  ##
+  # ====== Overview
+  # This module contains methods which are mixed into several classes
+  # to set, get and convert their options.
+  module OptionHandling
+    class << self
+      # Some values of options should be quoted to be read by gnuplot
+      #
+      # TODO: update list with data from gnuplot documentation !!!
+      QUOTED_OPTIONS = %w(
+        title
+        output
+        xlabel
+        x2label
+        ylabel
+        y2label
+        clabel
+        cblabel
+        zlabel
+        rgb
+        font
+      )
+
+      ##
+      # For inner use!
+      # Replacement '_' with ' ' is made to allow passing several options
+      # with the same first word of key.
+      # See issue #7 for more info.
+      def string_key(key)
+        key.to_s.gsub(/_/) { ' ' } + ' '
+      end
+
+      ##
+      # ====== Overview
+      # Recursive function that converts Ruby option to gnuplot string
+      # ====== Arguments
+      # * *key* - name of option in gnuplot
+      # * *option* - an option that should be converted
+      # ====== Examples
+      #   option_to_string(['png', size: [300, 300]]) #=> 'png size 300,300'
+      #   option_to_string(xrange: 0..100) #=> 'xrange [0:100]'
+      #   option_to_string(multiplot: true) #=> 'multiplot'
+      def option_to_string(key = nil, option)
+        return string_key(key) if !!option == option # check for boolean
+        value = ruby_class_to_gnuplot(option)
+        value = "\"#{value}\"" if QUOTED_OPTIONS.include?(key.to_s)
+        ## :+ here is necessary, because using #{value} will remove quotes
+        value = string_key(key) + value if key
+        value
+      end
+
+      ##
+      # Method for inner use.
+      # Needed to convert several ruby classes into
+      # value that should be piped to gnuplot.
+      def ruby_class_to_gnuplot(option_object)
+        case option_object
+        when Array
+          option_object.map { |el| option_to_string(el) }
+                       .join(option_object[0].is_a?(Numeric) ? ',' : ' ')
+        when Hash
+          option_object.map { |i_key, i_val| option_to_string(i_key, i_val) }
+                       .join(' ')
+        when Range
+          "[#{option_object.begin}:#{option_object.end}]"
+        else
+          option_object.to_s
+        end
+      end
+
+      ##
+      # ====== Overview
+      # Check if given terminal available for use.
+      # ====== Arguments
+      # * *terminal* - terminal to check (e.g. 'png', 'qt', 'gif')
+      def valid_terminal?(terminal)
+        Settings.available_terminals.include?(terminal)
+      end
+
+      ##
+      # ====== Overview
+      # Check if given options are valid for gnuplot.
+      # Raises ArgumentError if invalid options found.
+      # ====== Arguments
+      # * *options* - Hash of options to check
+      #   (e.g. {term: 'qt', title: 'Plot title'})
+      #
+      # Now checks only terminal name.
+      def validate_terminal_options(options)
+        terminal = options[:term]
+        if terminal
+          terminal = terminal[0] if terminal.is_a?(Array)
+          message = 'Seems like your Gnuplot does not ' \
+                    'support that terminal, please see supported ' \
+                    'terminals with Settings::available_terminals'
+          fail(ArgumentError, message) unless valid_terminal?(terminal)
+        end
+      end
+    end
+
+    ##
+    # You should implement #initialize in classes that use OptionsHelper
+    def initialize(*args)
+      fail NotImplementedError, 'You should implement #initialize' \
+                                ' in classes that use OptionsHelper!'
+    end
+
+    ##
+    # You should implement #new_with_options in classes that use OptionsHelper
+    def new_with_options(*args)
+      fail NotImplementedError, 'You should implement #new_with_options' \
+                                ' in classes that use OptionsHelper!'
+    end
+
+    ##
+    # ====== Overview
+    # Create new Plot (or Dataset or Splot or Multiplot) object where current
+    # options are merged with given. If no options
+    # given it will just return existing set of options.
+    # ====== Arguments
+    # * *options* - options to add. If no options given, current
+    #   options are returned.
+    # ====== Example
+    #   sin_graph = Plot.new(['sin(x)', title: 'Sin'], title: 'Sin on [0:3]', xrange: 0..3)
+    #   sin_graph.plot
+    #   sin_graph_update = sin_graph.options(title: 'Sin on [-10:10]', xrange: -10..10)
+    #   sin_graph_update.plot
+    #   # this may also be considered as
+    #   # sin_graph.title(...).xrange(...)
+    def options(**options)
+      @options ||= Hamster::Hash.new
+      if options.empty?
+        @options
+      else
+        new_with_options(@options.merge(options))
+      end
+    end
+
+    ##
+    # Method for inner use.
+    # ====== Arguments
+    # * *key* - [Symbol] - option key
+    # * *value* - anything treated as options value in gnuplot gem
+    def option(key, *value)
+      if value.empty?
+        value = options[key]
+        value = value[0] if value && value.size == 1
+        value
+      else
+        options(key => value)
+      end
+    end
+
+    private :option
+  end
+end

data/lib/gnuplotrb/mixins/plottable.rb

@@ -0,0 +1,102 @@
+module GnuplotRB
+  ##
+  # This module contains methods that should be mixed into
+  # plottable classes. It includes OptionHandling and
+  # implements several plotting methods.
+  module Plottable
+    include OptionHandling
+
+    ##
+    # Terminal object used by this Plottable to pipe data to gnuplot.
+    attr_reader :terminal
+
+    ##
+    # You should implement #plot in classes that are Plottable
+    def plot(*args)
+      fail NotImplementedError, 'You should implement #plot in classes that are Plottable!'
+    end
+
+    ##
+    # Method for inner use.
+    # ====== Overview
+    # Method which outputs plot to specific terminal (possibly some file).
+    # Explicit use should be avoided. This method is called from #method_missing
+    # when it handles method names like #to_png(options).
+    # ====== Arguments
+    # * *terminal* - string corresponding to terminal type (png, html, jpeg etc)
+    # * *path* - path to output file, if none given it will output to temp file
+    #   and then read it and return binary contents of file
+    # * *options* - used in 'set term <term type> <options here>'
+    # ====== Examples
+    #   ## plot here may be Plot, Splot, Multiplot or any other plottable class
+    #   plot.to_png('./result.png', size: [300, 500])
+    #   contents = plot.to_svg(size: [100, 100])
+    #   plot.to_dumb('./result.txt', size: [30, 15])
+    def to_specific_term(terminal, path = nil, **options)
+      if path
+        result = plot(term: [terminal, options], output: path)
+      else
+        path = Dir::Tmpname.make_tmpname(terminal, 0)
+        plot(term: [terminal, options], output: path)
+        result = File.binread(path)
+        File.delete(path)
+      end
+      result
+    end
+
+    ##
+    # ====== Overview
+    # In this gem #method_missing is used both to handle
+    # options and to handle plotting to specific terminal.
+    #
+    # ====== Options handling
+    # ======= Overview
+    # You may set options using #option_name(option_value) method.
+    # A new object will be constructed with selected option set.
+    # And finally you can get current value of any option using
+    # #options_name without arguments.
+    # ======= Arguments
+    # * *option_value* - value to set an option. If none given
+    #   method will just return current option's value
+    # ======= Examples
+    #   plot = Splot.new
+    #   new_plot = plot.title('Awesome plot')
+    #   plot.title #=> nil
+    #   new_plot.title #=> 'Awesome plot'
+    #
+    # ====== Plotting to specific term
+    # ======= Overview
+    # Gnuplot offers possibility to output graphics to many image formats.
+    # The easiest way to to so is to use #to_<plot_name> methods.
+    # ======= Arguments
+    # * *options* - set of options related to terminal (size, font etc).
+    #   Be careful, some terminals have their own specific options.
+    # ======= Examples
+    #   # font options specific for png term
+    #   multiplot.to_png('./result.png', size: [300, 500], font: ['arial', 12])
+    #   # font options specific for svg term
+    #   content = multiplot.to_svg(size: [100, 100], fname: 'Arial', fsize: 12)
+    def method_missing(meth_id, *args)
+      meth = meth_id.id2name
+      if meth[0..2] == 'to_'
+        term = meth[3..-1]
+        super unless OptionHandling.valid_terminal?(term)
+        to_specific_term(term, *args)
+      else
+        option(meth_id, *args)
+      end
+    end
+
+    ##
+    # Returns true foe existing methods and
+    # #to_<term_name> when name is a valid terminal type.
+    def respond_to?(meth_id)
+      # Next line is here to force iRuby use #to_iruby
+      # instead of #to_svg.
+      return super if defined? IRuby
+      meth = meth_id.id2name
+      term = meth[0..2] == 'to_' && OptionHandling.valid_terminal?(meth[3..-1])
+      term || super
+    end
+  end
+end