gnuplotrb 0.2.0

data/lib/gnuplotrb/staff/settings.rb

@@ -0,0 +1,65 @@
+module GnuplotRB
+  ##
+  # This module takes care of path to gnuplot executable
+  # and checking its version.
+  module Settings
+    ##
+    # Since gem uses some modern gnuplot features it's
+    # required to have modern gnuplot installed.
+    MIN_GNUPLOT_VERSION = 5.0
+    ##
+    # ====== Overview
+    # Get path that should be used to run gnuplot executable.
+    # Default value: 'gnuplot'
+    def self.gnuplot_path
+      self.gnuplot_path = 'gnuplot' unless defined?(@gnuplot_path)
+      @gnuplot_path
+    end
+
+    ##
+    # ====== Overview
+    # Set path to gnuplot executable.
+    def self.gnuplot_path=(path)
+      validate_version(path)
+      opts = { stdin_data: "set term\n" }
+      @available_terminals = Open3.capture2e(path, **opts)
+                                  .first
+                                  .scan(/[:\n] +([a-z][^ ]+)/)
+                                  .map(&:first)
+      @gnuplot_path = path
+    end
+
+    ##
+    # ====== Overview
+    # Get list of terminals (png, html, qt, jpeg etc)
+    # available for that gnuplot.
+    def self.available_terminals
+      gnuplot_path
+      @available_terminals
+    end
+
+    ##
+    # ====== Overview
+    # Get gnuplot version. Uses gnuplot_path to find
+    # gnuplot executable.
+    def self.version
+      gnuplot_path
+      @version
+    end
+
+    ##
+    # ====== Overview
+    # Validates gnuplot version. Compares current gnuplot's
+    # version with ::MIN_GNUPLOT_VERSION.
+    # ====== Arguments
+    # * *path* - path to gnuplot executable.
+    def self.validate_version(path)
+      @version = IO.popen("#{path} --version")
+                   .read
+                   .match(/gnuplot ([^ ]+)/)[1]
+                   .to_f
+      message = "Your Gnuplot version is #{@version}, please update it to at least 5.0"
+      fail(ArgumentError, message) if @version < MIN_GNUPLOT_VERSION
+    end
+  end
+end

data/lib/gnuplotrb/staff/terminal.rb

@@ -0,0 +1,171 @@
+module GnuplotRB
+  ##
+  # === Overview
+  # Terminal keeps open pipe to gnuplot process, cares about naming in-memory
+  # datablocks (just indexing with sequential integers). All the output
+  # to gnuplot handled by this class. Terminal also handles options passed
+  # to gnuplot as 'set key value'.
+  class Terminal
+    include ErrorHandling
+    OPTION_ORDER = [:term, :output, :multiplot]
+
+    class << self
+      ##
+      # Close given gnuplot pipe
+      def close_arg(stream)
+        stream.puts
+        stream.puts 'exit'
+        Process.waitpid(stream.pid)
+      end
+    end
+
+    ##
+    # ====== Overview
+    # Creates new Terminal connected with gnuplot.
+    # Uses Settings::gnuplot_path to find gnuplot
+    # executable. Each time you create Terminal it starts new
+    # gnuplot subprocess which is closed after GC deletes
+    # linked Terminal object.
+    # ====== Arguments
+    # * *persist* - gnuplot's -persist option
+    def initialize(persist: false)
+      @cmd = Settings.gnuplot_path
+      @current_datablock = 0
+      @cmd += ' -persist' if persist
+      @cmd += ' 2>&1'
+      stream = IO.popen(@cmd, 'w+')
+      handle_stderr(stream)
+      ObjectSpace.define_finalizer(self, proc { Terminal::close_arg(stream) } )
+      @in = stream
+      yield(self) if block_given?
+    end
+
+    ##
+    # ====== Overview
+    # Outputs datablock to this gnuplot terminal.
+    # ====== Arguments
+    # * *data* - data stored in datablock
+    # ====== Examples
+    #   data = "1 1\n2 4\n3 9"
+    #   Terminal.new.store_datablock(data)
+    #   #=> returns '$DATA1'
+    #   #=> outputs to gnuplot:
+    #   #=>   $DATA1 << EOD
+    #   #=>   1 1
+    #   #=>   2 4
+    #   #=>   3 9
+    #   #=>   EOD
+    def store_datablock(data)
+      name = "$DATA#{@current_datablock += 1}"
+      self.puts "#{name} << EOD"
+      self.puts data
+      self.puts 'EOD'
+      name
+    end
+
+    ##
+    # ====== Overview
+    # Converts given options to gnuplot format;
+    # for {opt1: val1, .. , optN: valN} it returns
+    #   set opt1 val1
+    #   ..
+    #   set optN valN
+    # ====== Arguments
+    # * *options* - hash of options to convert
+    def options_hash_to_string(options)
+      result = ''
+      options.sort_by { |key, _| OPTION_ORDER.find_index(key) || -1 }.each do |key, value|
+        if value
+          result += "set #{OptionHandling.option_to_string(key, value)}\n"
+        else
+          result += "unset #{key}\n"
+        end
+      end
+      result
+    end
+
+    ##
+    # ====== Overview
+    # Applies given options to current gnuplot instance;
+    # for {opt1: val1, .. , optN: valN} it will output to gnuplot
+    #   set opt1 val1
+    #   ..
+    #   set optN valN
+    # ====== Arguments
+    # *options* - hash of options to set
+    # ====== Examples
+    #   set({term: ['qt', size: [100, 100]]})
+    #   #=> outputs to gnuplot: "set term qt size 100,100\n"
+    def set(options)
+      OptionHandling.validate_terminal_options(options)
+      self.puts(options_hash_to_string(options))
+    end
+
+    ##
+    # ====== Overview
+    # Unset some options
+    # ====== Arguments
+    # * **options* - Array of options need to unset
+    def unset(*options)
+      options.flatten
+             .sort_by { |key| OPTION_ORDER.find_index(key) || -1 }
+             .each { |key| self.puts "unset #{OptionHandling.string_key(key)}" }
+      self
+    end
+
+    ##
+    # ====== Overview
+    # Short way to plot Datablock, Plot or Splot object.
+    # Other items will be just piped out to gnuplot.
+    def <<(item)
+      case item
+      when Dataset
+        Plot.new(item).plot(self)
+      when Plottable
+        item.plot(self)
+      else
+        self.print(item.to_s)
+      end
+      self
+    end
+
+    ##
+    # ====== Overview
+    # Just puts *command* to gnuplot pipe and returns self
+    # to allow chaining.
+    def puts(command)
+      self.print("#{command}\n")
+    end
+
+    ##
+    # ====== Overview
+    # Just prints *command* to gnuplot pipe and returns self
+    # to allow chaining.
+    def print(command)
+      check_errors
+      @in.print(command)
+      self
+    end
+
+    ##
+    # ====== Overview
+    # Call replot on gnuplot. This will execute last plot once again
+    # with rereading data.
+    def replot(**options)
+      set(options)
+      self.puts('replot')
+      unset(options.keys)
+      sleep 0.01 until File.size?(options[:output]) if options[:output]
+      self
+    end
+
+    ##
+    # ====== Overview
+    # Send gnuplot command to turn it off and for its Process to quit.
+    # Closes pipe so Terminal object should not be used after #close call.
+    def close
+      check_errors
+      Terminal::close_arg(@in)
+    end
+  end
+end

data/lib/gnuplotrb/version.rb

@@ -0,0 +1,6 @@
+##
+# === Overview
+# Ruby bindings for gnuplot.
+module GnuplotRB
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: gnuplotrb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ivan Evgrafov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hamster
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: chunky_png
+  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: daru
+  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: Renewed ruby bindings for gnuplot. Started at GSoC 2015.
+email:
+- dilcom3107@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- gnuplotrb.gemspec
+- lib/gnuplotrb.rb
+- lib/gnuplotrb/external_classes/array.rb
+- lib/gnuplotrb/external_classes/daru.rb
+- lib/gnuplotrb/external_classes/iruby.rb
+- lib/gnuplotrb/external_classes/string.rb
+- lib/gnuplotrb/mixins/error_handling.rb
+- lib/gnuplotrb/mixins/option_handling.rb
+- lib/gnuplotrb/mixins/plottable.rb
+- lib/gnuplotrb/multiplot.rb
+- lib/gnuplotrb/plot.rb
+- lib/gnuplotrb/splot.rb
+- lib/gnuplotrb/staff/datablock.rb
+- lib/gnuplotrb/staff/dataset.rb
+- lib/gnuplotrb/staff/settings.rb
+- lib/gnuplotrb/staff/terminal.rb
+- lib/gnuplotrb/version.rb
+homepage: https://github.com/dilcom/gnuplotrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for gnuplot
+test_files: []