gnuplotrb 0.2.0 → 0.3.0

data/lib/gnuplotrb/staff/dataset.rb

@@ -5,7 +5,7 @@ module GnuplotRB
   # this 'x*sin(x)' or filename) and options related to original dataset
   # in gnuplot (with, title, using etc).
   class Dataset
-    include OptionHandling
+    include Plottable
     ##
     # Data represented by this dataset
     attr_reader :data
@@ -15,7 +15,7 @@ module GnuplotRB
     OPTION_ORDER = %w(index using axes title)
 
     ##
-    # Hash of init handlers for data given in 
+    # Hash of init handlers for data given in
     # different containers.
     INIT_HANDLERS = Hash.new(:init_default).merge(
       String =>          :init_string,
@@ -50,61 +50,8 @@ module GnuplotRB
     # The same data but datablock stores it in temp file:
     #   Dataset.new(points, with: 'points', title: 'Points', file: true)
     def initialize(data, **options)
-      self.send(INIT_HANDLERS[data.class], data, options)
-    end
-
-    ##
-    # Method for inner use.
-    def init_string(data, options)
-      @type, @data= if File.exist?(data)
-        [:datafile, "'#{data}'"]
-      else
-        [:math_function, data.clone]
-      end
-      @options = Hamster.hash(options)
-    end
-
-    ##
-    # Method for inner use.
-    def init_dblock(data, options)
-      @type = :datablock
-      @data = data.clone
-      @options = Hamster.hash(options)
-    end
-
-    ##
-    # Method for inner use.
-    # TODO: make it better
-    def init_daru_frame(data, options)
-      options[:title] ||= data.name
-      if options[:using]
-        options[:using] = " #{options[:using]} "
-        data.vectors.to_a.each_with_index do |daru_index, array_index|
-          options[:using].gsub!(/([\:\( ])#{daru_index}([\:\) ])/) { "#{$1}#{array_index + 2}#{$2}"}
-        end
-        options[:using].gsub!(/index/) { 1 }
-        options[:using].strip!
-      else
-        new_opt = (2...(2 + data.vectors.size)).to_a.join(':')
-        options[:using] = "#{new_opt}:xtic(1)"
-      end
-      init_default(data, options)
-    end
-
-    ##
-    # Method for inner use.
-    def init_daru_vector(data, options)
-      options[:using] ||= '2:xtic(1)'
-      options[:title] ||= data.name
-      init_default(data, options)
-    end
-
-    ##
-    # Method for inner use.
-    def init_default(data, file: false, **options)
-      @type = :datablock
-      @data = Datablock.new(data, file)
-      @options = Hamster.hash(options)
+      # run method by name
+      send(INIT_HANDLERS[data.class], data, options)
     end
 
     ##
@@ -120,16 +67,7 @@ module GnuplotRB
     #   Dataset.new(points, with: 'points', title: 'Points').to_s
     #   #=> "$DATA1 with points title 'Points'"
     def to_s(terminal = nil)
-      "#{@type == :datablock ? @data.name(terminal) : @data } #{options_to_string}"
-    end
-
-    ##
-    # ====== Overview
-    # Create string from own options
-    def options_to_string
-      options.sort_by { |key, _| OPTION_ORDER.find_index(key.to_s) || 999 }
-             .map { |key, value| OptionHandling.option_to_string(key, value) }
-             .join(' ')
+      "#{@type == :datablock ? @data.name(terminal) : @data} #{options_to_string}"
     end
 
     ##
@@ -145,18 +83,18 @@ module GnuplotRB
     # ====== Examples
     # Updating dataset with Math formula or filename given:
     #   dataset = Dataset.new('file.data')
-    #   dataset.update('asd')
+    #   dataset.update(data: 'asd')
     #   #=> nothing updated
-    #   dataset.update('asd', title: 'File')
+    #   dataset.update(data: 'asd', title: 'File')
     #   #=> Dataset.new('file.data', title: 'File')
     # Updating dataset with data stored in Datablock:
     #   in_memory_points = Dataset.new(points, title: 'Old one')
-    #   in_memory_points.update(some_update, title: 'Updated')
+    #   in_memory_points.update(data: some_update, title: 'Updated')
     #   #=> Dataset.new(points + some_update, title: 'Updated')
     #   temp_file_points = Dataset.new(points, title: 'Old one', file: true)
-    #   temp_file_points.update(some_update)
+    #   temp_file_points.update(data: some_update)
     #   #=> data updated but no new dataset created
-    #   temp_file_points.update(some_update, title: 'Updated')
+    #   temp_file_points.update(data: some_update, title: 'Updated')
     #   #=> data updated and new dataset with title 'Updated' returned
     def update(data = nil, **options)
       if data && @type == :datablock
@@ -164,7 +102,7 @@ module GnuplotRB
         if new_datablock == @data
           update_options(options)
         else
-          Dataset.new(@data.update(data), @options.merge(options))
+          self.class.new(new_datablock, options)
         end
       else
         update_options(options)
@@ -177,12 +115,29 @@ module GnuplotRB
     # data stored in datablock and calls super otherwise.
     def clone
       if @type == :datablock
-        Dataset.new(@data, **@options)
+        new_with_options(@options)
       else
         super
       end
     end
 
+    ##
+    # ====== Overview
+    # Creates new Plot object with only one Dataset given - self.
+    # Calls #plot on created Plot. All arguments given to this #plot
+    # will be sent to Plot#plot instead.
+    # ====== Example
+    #   sin = Dataset.new('sin(x)')
+    #   sin.plot(term: [qt, size: [300, 300]])
+    #   #=> shows qt window 300x300 with sin(x)
+    #   sin.to_png('./plot.png')
+    #   #=> creates png file with sin(x) plotted
+    def plot(*args)
+      Plot.new(self).plot(*args)
+    end
+
+    private
+
     ##
     # ====== Overview
     # Creates new dataset with existing options merged with
@@ -196,38 +151,74 @@ module GnuplotRB
     #   #=> Dataset.new('file.data', title: 'File')
     def update_options(**options)
       if options.empty?
-        return self
+        self
       else
-        Dataset.new(@data, @options.merge(options))
+        new_with_options(@options.merge(options))
       end
     end
 
     ##
-    # Method for inner use.
+    # ====== Overview
+    # Create string from own options
+    def options_to_string
+      options.sort_by { |key, _| OPTION_ORDER.find_index(key.to_s) || 999 }
+             .map { |key, value| OptionHandling.option_to_string(key, value) }
+             .join(' ')
+    end
+
+    ##
     # Needed by OptionHandling to create new object when
     # options are changed.
     def new_with_options(options)
       self.class.new(@data, options)
     end
 
-    ##
-    # ====== 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.
-    # ====== Examples
-    #   dataset = Dataset.new('file.data')
-    #   dataset.title #=> nil
-    #   new_dataset = dataset.title('Awesome plot')
-    #   dataset.title #=> nil
-    #   new_dataset.title #=> 'Awesome plot'
-    def method_missing(meth_id, *args)
-      option(meth_id, *args)
+    def init_string(data, options)
+      @type, @data = File.exist?(data) ? [:datafile, "'#{data}'"] : [:math_function, data.clone]
+      @options = Hamster.hash(options)
+    end
+
+    def init_dblock(data, options)
+      @type = :datablock
+      @data = data.clone
+      @options = Hamster.hash(options)
     end
 
-    private :init_default,
-            *INIT_HANDLERS.values,
-            :new_with_options
+    def get_daru_columns(data, cnt)
+      new_opt = (2..cnt).to_a.join(':')
+      if data.index[0].is_a?(DateTime) || data.index[0].is_a?(Numeric)
+        "1:#{new_opt}"
+      else
+        "#{new_opt}:xtic(1)"
+      end
+    end
+
+    def init_daru_frame(data, options)
+      options[:title] ||= data.name
+      if options[:using]
+        options[:using] = " #{options[:using]} "
+        data.vectors.to_a.each_with_index do |daru_index, array_index|
+          options[:using].gsub!(/([\:\(\$ ])#{daru_index}([\:\) ])/) do
+            "#{Regexp.last_match(1)}#{array_index + 2}#{Regexp.last_match(2)}"
+          end
+        end
+        options[:using].gsub!('index', '1').strip!
+      else
+        options[:using] = get_daru_columns(data, data.vectors.size + 1)
+      end
+      init_default(data, options)
+    end
+
+    def init_daru_vector(data, options)
+      options[:using] ||= get_daru_columns(data, 2)
+      options[:title] ||= data.name
+      init_default(data, options)
+    end
+
+    def init_default(data, file: false, **options)
+      @type = :datablock
+      @data = Datablock.new(data, file)
+      @options = Hamster.hash(options)
+    end
   end
 end

data/lib/gnuplotrb/staff/settings.rb

@@ -7,59 +7,71 @@ module GnuplotRB
     # 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
+    class << self
+      ##
+      # Max fit dely is used inside fit function.
+      # If it waits for output more than max_fit_delay seconds
+      # this behaviour is considered as errorneus.
+      # For heavy calculations max_fit_delay may be increased.
+      attr_writer :max_fit_delay
+      def max_fit_delay
+        @max_fit_delay ||= 5
+      end
+      ##
+      # ====== Overview
+      # Get path that should be used to run gnuplot executable.
+      # Default value: 'gnuplot'
+      def gnuplot_path
+        self.gnuplot_path = 'gnuplot' unless defined?(@gnuplot_path)
+        @gnuplot_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
+      # Set path to gnuplot executable.
+      def 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 gnuplot version. Uses gnuplot_path to find
-    # gnuplot executable.
-    def self.version
-      gnuplot_path
-      @version
-    end
+      ##
+      # ====== Overview
+      # Get list of terminals (png, html, qt, jpeg etc)
+      # available for that gnuplot.
+      def available_terminals
+        gnuplot_path
+        @available_terminals
+      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
+      ##
+      # ====== Overview
+      # Get gnuplot version. Uses gnuplot_path to find
+      # gnuplot executable.
+      def 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 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
 end

data/lib/gnuplotrb/staff/terminal.rb

@@ -7,7 +7,7 @@ module GnuplotRB
   # to gnuplot as 'set key value'.
   class Terminal
     include ErrorHandling
-    OPTION_ORDER = [:term, :output, :multiplot]
+    OPTION_ORDER = [:term, :output, :multiplot, :timefmt, :xrange]
 
     class << self
       ##
@@ -35,7 +35,7 @@ module GnuplotRB
       @cmd += ' 2>&1'
       stream = IO.popen(@cmd, 'w+')
       handle_stderr(stream)
-      ObjectSpace.define_finalizer(self, proc { Terminal::close_arg(stream) } )
+      ObjectSpace.define_finalizer(self, proc { Terminal.close_arg(stream) })
       @in = stream
       yield(self) if block_given?
     end
@@ -57,9 +57,9 @@ module GnuplotRB
     #   #=>   EOD
     def store_datablock(data)
       name = "$DATA#{@current_datablock += 1}"
-      self.puts "#{name} << EOD"
-      self.puts data
-      self.puts 'EOD'
+      stream_puts "#{name} << EOD"
+      stream_puts data
+      stream_puts 'EOD'
       name
     end
 
@@ -98,7 +98,7 @@ module GnuplotRB
     #   #=> 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))
+      stream_puts(options_hash_to_string(options))
     end
 
     ##
@@ -109,7 +109,7 @@ module GnuplotRB
     def unset(*options)
       options.flatten
              .sort_by { |key| OPTION_ORDER.find_index(key) || -1 }
-             .each { |key| self.puts "unset #{OptionHandling.string_key(key)}" }
+             .each { |key| stream_puts "unset #{OptionHandling.string_key(key)}" }
       self
     end
 
@@ -118,13 +118,10 @@ module GnuplotRB
     # 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
+      if item.is_a? Plottable
         item.plot(self)
       else
-        self.print(item.to_s)
+        stream_print(item.to_s)
       end
       self
     end
@@ -133,15 +130,15 @@ module GnuplotRB
     # ====== Overview
     # Just puts *command* to gnuplot pipe and returns self
     # to allow chaining.
-    def puts(command)
-      self.print("#{command}\n")
+    def stream_puts(command)
+      stream_print("#{command}\n")
     end
 
     ##
     # ====== Overview
     # Just prints *command* to gnuplot pipe and returns self
     # to allow chaining.
-    def print(command)
+    def stream_print(command)
       check_errors
       @in.print(command)
       self
@@ -153,7 +150,7 @@ module GnuplotRB
     # with rereading data.
     def replot(**options)
       set(options)
-      self.puts('replot')
+      stream_puts('replot')
       unset(options.keys)
       sleep 0.01 until File.size?(options[:output]) if options[:output]
       self
@@ -165,7 +162,7 @@ module GnuplotRB
     # Closes pipe so Terminal object should not be used after #close call.
     def close
       check_errors
-      Terminal::close_arg(@in)
+      Terminal.close_arg(@in)
     end
   end
 end

data/lib/gnuplotrb/version.rb

@@ -2,5 +2,5 @@
 # === Overview
 # Ruby bindings for gnuplot.
 module GnuplotRB
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/gnuplotrb.rb

@@ -1,13 +1,12 @@
 require 'tempfile'
 require 'hamster'
 require 'open3'
+require 'base64'
 
 def require_if_available(name)
-  begin
-    require name
-  rescue LoadError
-    false
-  end
+  require name
+rescue LoadError
+  false
 end
 
 require_if_available('daru')
@@ -15,7 +14,6 @@ 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'
@@ -25,6 +23,8 @@ require 'gnuplotrb/mixins/plottable'
 require 'gnuplotrb/staff/terminal'
 require 'gnuplotrb/staff/datablock'
 require 'gnuplotrb/staff/dataset'
+require 'gnuplotrb/fit'
 require 'gnuplotrb/plot'
 require 'gnuplotrb/splot'
 require 'gnuplotrb/multiplot'
+require 'gnuplotrb/animation'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnuplotrb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ivan Evgrafov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2015-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hamster
@@ -149,10 +149,11 @@ files:
 - Rakefile
 - gnuplotrb.gemspec
 - lib/gnuplotrb.rb
+- lib/gnuplotrb/animation.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/fit.rb
 - lib/gnuplotrb/mixins/error_handling.rb
 - lib/gnuplotrb/mixins/option_handling.rb
 - lib/gnuplotrb/mixins/plottable.rb

data/lib/gnuplotrb/external_classes/iruby.rb

@@ -1,18 +0,0 @@
-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