gnuplotrb 0.3.1 → 0.3.2

data/lib/gnuplotrb.rb

@@ -1,35 +1,35 @@
-require 'tempfile'
-require 'hamster'
-require 'open3'
-require 'base64'
-
-##
-# Require gem if it's available in current gemspace.
-#
-# @param name [String] gem name
-# @return [Boolean] true if gem was loaded, false otherwise
-def require_if_available(name)
-  require name
-rescue LoadError
-  false
-end
-
-require_if_available('daru')
-
-require 'gnuplotrb/external_classes/string'
-require 'gnuplotrb/external_classes/array'
-require 'gnuplotrb/external_classes/daru'
-
-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/fit'
-require 'gnuplotrb/plot'
-require 'gnuplotrb/splot'
-require 'gnuplotrb/multiplot'
-require 'gnuplotrb/animation'
+require 'tempfile'
+require 'hamster'
+require 'open3'
+require 'base64'
+
+##
+# Require gem if it's available in current gemspace.
+#
+# @param name [String] gem name
+# @return [Boolean] true if gem was loaded, false otherwise
+def require_if_available(name)
+  require name
+rescue LoadError
+  false
+end
+
+require_if_available('daru')
+
+require 'gnuplotrb/external_classes/string'
+require 'gnuplotrb/external_classes/array'
+require 'gnuplotrb/external_classes/daru'
+
+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/fit'
+require 'gnuplotrb/plot'
+require 'gnuplotrb/splot'
+require 'gnuplotrb/multiplot'
+require 'gnuplotrb/animation'

data/lib/gnuplotrb/animation.rb

@@ -1,129 +1,129 @@
-module GnuplotRB
-  ##
-  # Animation allows to create gif animation with given plots
-  # as frames. Possible frames: Plot, Splot, Multiplot.
-  # More about its usage in
-  # {animation notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/animated_plots.ipynb].
-  #
-  # == Options
-  # Animations has several specific options:
-  # * animate - allows to get animated gif's. Possible values are true (just turn on animation),
-  #   ot hash with suboptions (:loop - count of loops, default 0 - infinity$; 
-  #   :delay - delay between frames; :optimize - boolean, reduces file size).
-  # * size - size of gif file in pixels (size: [500, 500]) or (size: 500)
-  # * background - background color
-  # * transparent
-  # * enhanced
-  # * font
-  # * fontscale
-  # * crop
-  #
-  # Animation ignores :term option and does not have methods like #to_png or #to_svg.
-  # One can also set animation any options related to Plot and they will be considered
-  # by all nested plots (if they does not override it with their own values).
-  #
-  # Animation inherits all plot array handling methods from Multiplot
-  # and adds aliases for them (#plots -> #frames; #update_frame! -> #update_plot!; etc).
-  class Animation < Multiplot
-    ##
-    # *Plot* here is also named as *frame*
-    alias_method :frames, :plots
-    alias_method :update_frame, :update_plot
-    alias_method :replace_frame, :replace_plot
-    alias_method :add_frame, :add_plot
-    alias_method :add_frames, :add_plots
-    alias_method :remove_frame, :remove_plot
-    alias_method :update_frame!, :update_plot!
-    alias_method :replace_frame!, :replace_plot!
-    alias_method :add_frame!, :add_plot!
-    alias_method :add_frames!, :add_plots!
-    alias_method :remove_frame!, :remove_plot!
-
-    ##
-    # This method creates a gif animation where frames are plots
-    # already contained by Animation object.
-    #
-    # Options passed in #plot have priority over those which were set before.
-    #
-    # Inner options of Plots have the highest priority (except
-    # :term and :output which are ignored).
-    #
-    # @param path [String] path to new gif file that will be created as a result
-    # @param options [Hash] see note about available options in top class documentation
-    # @return [nil] if path to output file given
-    # @return [String] gif file contents if no path to output file given
-    def plot(path = nil, **options)
-      options[:output] ||= path
-      plot_options = mix_options(options) do |plot_opts, anim_opts|
-        plot_opts.merge(term: ['gif', anim_opts])
-      end.to_h
-      need_output = plot_options[:output].nil?
-      plot_options[:output] = Dir::Tmpname.make_tmpname('anim', 0) if need_output
-      terminal = Terminal.new
-      multiplot(terminal, plot_options)
-      # guaranteed wait for plotting to finish
-      terminal.close
-      if need_output
-        result = File.binread(plot_options[:output])
-        File.delete(plot_options[:output])
-      else
-        result = nil
-      end
-      result
-    end
-
-    ##
-    # #to_|term_name| methods are not supported by animation
-    def to_specific_term(*_)
-      fail 'Specific terminals are not supported by Animation'
-    end
-
-    ##
-    # This method is used to embed gif animations
-    # into iRuby notebooks.
-    def to_iruby
-      gif_base64 = Base64.encode64(plot)
-      ['text/html', "<img src=\"data:image/gif;base64, #{gif_base64}\">"]
-    end
-
-    private
-
-    ##
-    # Dafault options to be used for that plot
-    def default_options
-      {
-        animate: {
-          delay: 10,
-          loop: 0,
-          optimize: true
-        }
-      }
-    end
-
-    ##
-    # This plot have some specific options which
-    # should be handled different way than others.
-    # Here are keys of this options.
-    def specific_keys
-      %w(
-        animate
-        size
-        background
-        transparent
-        enhanced
-        rounded
-        butt
-        linewidth
-        dashlength
-        tiny
-        small
-        medium
-        large
-        giant
-        font
-        fontscale
-        crop
-      )
-    end
-  end
-end
+module GnuplotRB
+  ##
+  # Animation allows to create gif animation with given plots
+  # as frames. Possible frames: Plot, Splot, Multiplot.
+  # More about its usage in
+  # {animation notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/animated_plots.ipynb].
+  #
+  # == Options
+  # Animations has several specific options:
+  # * animate - allows to get animated gif's. Possible values are true (just turn on animation),
+  #   ot hash with suboptions (:loop - count of loops, default 0 - infinity$; 
+  #   :delay - delay between frames; :optimize - boolean, reduces file size).
+  # * size - size of gif file in pixels (size: [500, 500]) or (size: 500)
+  # * background - background color
+  # * transparent
+  # * enhanced
+  # * font
+  # * fontscale
+  # * crop
+  #
+  # Animation ignores :term option and does not have methods like #to_png or #to_svg.
+  # One can also set animation any options related to Plot and they will be considered
+  # by all nested plots (if they does not override it with their own values).
+  #
+  # Animation inherits all plot array handling methods from Multiplot
+  # and adds aliases for them (#plots -> #frames; #update_frame! -> #update_plot!; etc).
+  class Animation < Multiplot
+    ##
+    # *Plot* here is also named as *frame*
+    alias_method :frames, :plots
+    alias_method :update_frame, :update_plot
+    alias_method :replace_frame, :replace_plot
+    alias_method :add_frame, :add_plot
+    alias_method :add_frames, :add_plots
+    alias_method :remove_frame, :remove_plot
+    alias_method :update_frame!, :update_plot!
+    alias_method :replace_frame!, :replace_plot!
+    alias_method :add_frame!, :add_plot!
+    alias_method :add_frames!, :add_plots!
+    alias_method :remove_frame!, :remove_plot!
+
+    ##
+    # This method creates a gif animation where frames are plots
+    # already contained by Animation object.
+    #
+    # Options passed in #plot have priority over those which were set before.
+    #
+    # Inner options of Plots have the highest priority (except
+    # :term and :output which are ignored).
+    #
+    # @param path [String] path to new gif file that will be created as a result
+    # @param options [Hash] see note about available options in top class documentation
+    # @return [nil] if path to output file given
+    # @return [String] gif file contents if no path to output file given
+    def plot(path = nil, **options)
+      options[:output] ||= path
+      plot_options = mix_options(options) do |plot_opts, anim_opts|
+        plot_opts.merge(term: ['gif', anim_opts])
+      end.to_h
+      need_output = plot_options[:output].nil?
+      plot_options[:output] = Dir::Tmpname.make_tmpname('anim', 0) if need_output
+      terminal = Terminal.new
+      multiplot(terminal, plot_options)
+      # guaranteed wait for plotting to finish
+      terminal.close
+      if need_output
+        result = File.binread(plot_options[:output])
+        File.delete(plot_options[:output])
+      else
+        result = nil
+      end
+      result
+    end
+
+    ##
+    # #to_|term_name| methods are not supported by animation
+    def to_specific_term(*_)
+      fail 'Specific terminals are not supported by Animation'
+    end
+
+    ##
+    # This method is used to embed gif animations
+    # into iRuby notebooks.
+    def to_iruby
+      gif_base64 = Base64.encode64(plot)
+      ['text/html', "<img src=\"data:image/gif;base64, #{gif_base64}\">"]
+    end
+
+    private
+
+    ##
+    # Dafault options to be used for that plot
+    def default_options
+      {
+        animate: {
+          delay: 10,
+          loop: 0,
+          optimize: true
+        }
+      }
+    end
+
+    ##
+    # This plot have some specific options which
+    # should be handled different way than others.
+    # Here are keys of this options.
+    def specific_keys
+      %w(
+        animate
+        size
+        background
+        transparent
+        enhanced
+        rounded
+        butt
+        linewidth
+        dashlength
+        tiny
+        small
+        medium
+        large
+        giant
+        font
+        fontscale
+        crop
+      )
+    end
+  end
+end

data/lib/gnuplotrb/external_classes/array.rb

@@ -1,17 +1,17 @@
-##
-# Methods to take data for GnuplotRB plots.
-class Array
-  # taken for example from current gnuplot bindings
-  # @return [String] array converted to Gnuplot format
-  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
+##
+# Methods to take data for GnuplotRB plots.
+class Array
+  # taken for example from current gnuplot bindings
+  # @return [String] array converted to Gnuplot format
+  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

@@ -1,43 +1,43 @@
-if defined? Daru
-  ##
-  # See {daru}[https://github.com/v0dro/daru] and
-  # {plotting from daru}[https://github.com/dilcom/gnuplotrb/blob/master/notebooks/plotting_from_daru.ipynb]
-  module Daru
-    ##
-    # Methods to take data for GnuplotRB plots.
-    class DataFrame
-      ##
-      # Convert DataFrame to Gnuplot format.
-      #
-      # @return [String] data converted to Gnuplot format
-      def to_gnuplot_points
-        result = ''
-        each_row_with_index do |row, index|
-          quoted = index.is_a?(String) || index.is_a?(Symbol)
-          result += quoted ? "\"#{index}\" " : "#{index} "
-          result += row.to_a.join(' ')
-          result += "\n"
-        end
-        result
-      end
-    end
-
-    ##
-    # Methods to take data for GnuplotRB plots.
-    class Vector
-      ##
-      # Convert Vector to Gnuplot format.
-      #
-      # @return [String] data converted to Gnuplot format
-      def to_gnuplot_points
-        result = ''
-        each_with_index do |value, index|
-          quoted = index.is_a?(String) || index.is_a?(Symbol)
-          result += quoted ? "\"#{index}\" " : "#{index} "
-          result += "#{value}\n"
-        end
-        result
-      end
-    end
-  end
-end
+if defined? Daru
+  ##
+  # See {daru}[https://github.com/v0dro/daru] and
+  # {plotting from daru}[https://github.com/dilcom/gnuplotrb/blob/master/notebooks/plotting_from_daru.ipynb]
+  module Daru
+    ##
+    # Methods to take data for GnuplotRB plots.
+    class DataFrame
+      ##
+      # Convert DataFrame to Gnuplot format.
+      #
+      # @return [String] data converted to Gnuplot format
+      def to_gnuplot_points
+        result = ''
+        each_row_with_index do |row, index|
+          quoted = (index.is_a?(String) || index.is_a?(Symbol)) && index.length > 0
+          result += quoted ? "\"#{index}\" " : "#{index} "
+          result += row.to_a.join(' ')
+          result += "\n"
+        end
+        result
+      end
+    end
+
+    ##
+    # Methods to take data for GnuplotRB plots.
+    class Vector
+      ##
+      # Convert Vector to Gnuplot format.
+      #
+      # @return [String] data converted to Gnuplot format
+      def to_gnuplot_points
+        result = ''
+        each_with_index do |value, index|
+          quoted = (index.is_a?(String) || index.is_a?(Symbol)) && index.length > 0
+          result += quoted ? "\"#{index}\" " : "#{index} "
+          result += "#{value}\n"
+        end
+        result
+      end
+    end
+  end
+end