gnuplotrb 0.3.1 → 0.3.2

data/lib/gnuplotrb/mixins/option_handling.rb

@@ -1,190 +1,190 @@
-module GnuplotRB
-  ##
-  # 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 properly
-      #
-      # @todo update list with data from gnuplot documentation !!!
-      QUOTED_OPTIONS = %w(
-        title
-        output
-        xlabel
-        x2label
-        ylabel
-        y2label
-        clabel
-        cblabel
-        zlabel
-        rgb
-        font
-        background
-        format
-        format_x
-        format_y
-        format_xy
-        format_x2
-        format_y2
-        format_z
-        format_cb
-        timefmt
-        dt
-        dashtype
-      )
-
-      private_constant :QUOTED_OPTIONS
-
-      ##
-      # Replace '_' with ' ' is made to allow passing several options
-      # with the same first word of key. See issue #7 for more info.
-      # @param key [Symbol, String] key to modify
-      # @return [String] given key with '_' replaced with ' '
-      def string_key(key)
-        key.to_s.gsub(/_/) { ' ' } + ' '
-      end
-
-      ##
-      # Recursive function that converts Ruby option to gnuplot string
-      #
-      # @param key [Symbol] name of option in gnuplot
-      # @param option an option that should be converted
-      # @example
-      #   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
-
-      ##
-      # @private
-      # 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
-
-      ##
-      # Check if given terminal available for use.
-      #
-      # @param terminal [String] terminal to check (e.g. 'png', 'qt', 'gif')
-      # @return [Boolean] true or false
-      def valid_terminal?(terminal)
-        Settings.available_terminals.include?(terminal)
-      end
-
-      ##
-      # Check if given options are valid for gnuplot.
-      # Raises ArgumentError if invalid options found.
-      # Now checks only terminal name.
-      #
-      # @param options [Hash] options to check (e.g. "{ term: 'qt', title: 'Plot title' }")
-      def validate_terminal_options(options)
-        terminal = options[:term]
-        return unless terminal
-        terminal = terminal[0] if terminal.is_a?(Array)
-        message = 'Seems like your Gnuplot does not ' \
-                  "support that terminal (#{terminal}), please see " \
-                  'supported terminals with Settings::available_terminals'
-        fail(ArgumentError, message) unless valid_terminal?(terminal)
-      end
-    end
-
-    ##
-    # @private
-    # You should implement #initialize in classes that use OptionsHelper
-    def initialize(*_)
-      fail NotImplementedError, 'You should implement #initialize' \
-                                ' in classes that use OptionsHelper!'
-    end
-
-    ##
-    # @private
-    # You should implement #new_with_options in classes that use OptionsHelper
-    def new_with_options(*_)
-      fail NotImplementedError, 'You should implement #new_with_options' \
-                                ' in classes that use OptionsHelper!'
-    end
-
-    ##
-    # 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.
-    #
-    # @param options [Hash] options to add
-    # @return [Dataset, Splot, Multiplot] new object created with given options
-    # @return [Hamster::Hash] current options if given options empty
-    # @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
-    #   # sin_graph IS NOT affected
-    def options(**options)
-      @options ||= Hamster::Hash.new
-      if options.empty?
-        @options
-      else
-        new_with_options(@options.merge(options))
-      end
-    end
-
-    ##
-    # Update existing Plot (or Dataset or Splot or Multiplot) object with given options.
-    #
-    # @param options [Hash] options to add
-    # @return [Dataset, Splot, Multiplot] self
-    # @example
-    #   sin_graph = Plot.new(['sin(x)', title: 'Sin'], title: 'Sin on [0:3]', xrange: 0..3)
-    #   sin_graph.plot
-    #   sin_graph.options!(title: 'Sin on [-10:10]', xrange: -10..10)
-    #   sin_graph.plot
-    #   # second #plot call will plot not the same as first, sin_graph IS affected
-    def options!(**options)
-      @options = @options ? @options.merge(options) : Hamster::Hash.new(options)
-      self
-    end
-
-    private
-
-    ##
-    # Return current option value if no value given. Create new
-    # object with given option set if value given.
-    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
-
-    ##
-    # Just set an option.
-    def option!(key, *value)
-      options!(key => value)
-    end
-  end
-end
+module GnuplotRB
+  ##
+  # 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 properly
+      #
+      # @todo update list with data from gnuplot documentation !!!
+      QUOTED_OPTIONS = %w(
+        title
+        output
+        xlabel
+        x2label
+        ylabel
+        y2label
+        clabel
+        cblabel
+        zlabel
+        rgb
+        font
+        background
+        format
+        format_x
+        format_y
+        format_xy
+        format_x2
+        format_y2
+        format_z
+        format_cb
+        timefmt
+        dt
+        dashtype
+      )
+
+      private_constant :QUOTED_OPTIONS
+
+      ##
+      # Replace '_' with ' ' is made to allow passing several options
+      # with the same first word of key. See issue #7 for more info.
+      # @param key [Symbol, String] key to modify
+      # @return [String] given key with '_' replaced with ' '
+      def string_key(key)
+        key.to_s.gsub(/_/) { ' ' } + ' '
+      end
+
+      ##
+      # Recursive function that converts Ruby option to gnuplot string
+      #
+      # @param key [Symbol] name of option in gnuplot
+      # @param option an option that should be converted
+      # @example
+      #   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
+
+      ##
+      # @private
+      # 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
+
+      ##
+      # Check if given terminal available for use.
+      #
+      # @param terminal [String] terminal to check (e.g. 'png', 'qt', 'gif')
+      # @return [Boolean] true or false
+      def valid_terminal?(terminal)
+        Settings.available_terminals.include?(terminal)
+      end
+
+      ##
+      # Check if given options are valid for gnuplot.
+      # Raises ArgumentError if invalid options found.
+      # Now checks only terminal name.
+      #
+      # @param options [Hash] options to check (e.g. "{ term: 'qt', title: 'Plot title' }")
+      def validate_terminal_options(options)
+        terminal = options[:term]
+        return unless terminal
+        terminal = terminal[0] if terminal.is_a?(Array)
+        message = 'Seems like your Gnuplot does not ' \
+                  "support that terminal (#{terminal}), please see " \
+                  'supported terminals with Settings::available_terminals'
+        fail(ArgumentError, message) unless valid_terminal?(terminal)
+      end
+    end
+
+    ##
+    # @private
+    # You should implement #initialize in classes that use OptionsHelper
+    def initialize(*_)
+      fail NotImplementedError, 'You should implement #initialize' \
+                                ' in classes that use OptionsHelper!'
+    end
+
+    ##
+    # @private
+    # You should implement #new_with_options in classes that use OptionsHelper
+    def new_with_options(*_)
+      fail NotImplementedError, 'You should implement #new_with_options' \
+                                ' in classes that use OptionsHelper!'
+    end
+
+    ##
+    # 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.
+    #
+    # @param options [Hash] options to add
+    # @return [Dataset, Splot, Multiplot] new object created with given options
+    # @return [Hamster::Hash] current options if given options empty
+    # @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
+    #   # sin_graph IS NOT affected
+    def options(**options)
+      @options ||= Hamster::Hash.new
+      if options.empty?
+        @options
+      else
+        new_with_options(@options.merge(options))
+      end
+    end
+
+    ##
+    # Update existing Plot (or Dataset or Splot or Multiplot) object with given options.
+    #
+    # @param options [Hash] options to add
+    # @return [Dataset, Splot, Multiplot] self
+    # @example
+    #   sin_graph = Plot.new(['sin(x)', title: 'Sin'], title: 'Sin on [0:3]', xrange: 0..3)
+    #   sin_graph.plot
+    #   sin_graph.options!(title: 'Sin on [-10:10]', xrange: -10..10)
+    #   sin_graph.plot
+    #   # second #plot call will plot not the same as first, sin_graph IS affected
+    def options!(**options)
+      @options = @options ? @options.merge(options) : Hamster::Hash.new(options)
+      self
+    end
+
+    private
+
+    ##
+    # Return current option value if no value given. Create new
+    # object with given option set if value given.
+    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
+
+    ##
+    # Just set an option.
+    def option!(key, *value)
+      options!(key => value)
+    end
+  end
+end

data/lib/gnuplotrb/mixins/plottable.rb

@@ -1,208 +1,208 @@
-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
-
-    ##
-    # @private
-    # You should implement #plot in classes that are Plottable
-    def plot(*_)
-      fail NotImplementedError, 'You should implement #plot in classes that are Plottable!'
-    end
-
-    ##
-    # 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
-      case
-      when meth[0..2] == 'to_'
-        term = meth[3..-1]
-        super unless OptionHandling.valid_terminal?(term)
-        to_specific_term(term, *args)
-      when meth[-1] == '!'
-        option!(meth[0..-2].to_sym, *args)
-      when meth[-1] == '='
-        option!(meth[0..-2].to_sym, *args)
-        option(meth[0..-2].to_sym)
-      else
-        option(meth_id, *args)
-      end
-    end
-
-    ##
-    # @return [true] for existing methods and
-    #   #to_|term_name| when name is a valid terminal type.
-    # @return [false] otherwise
-    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
-
-    ##
-    # This method is used to embed plottable objects into iRuby notebooks. There is
-    # {a notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/basic_usage.ipynb]
-    # with examples of its usage.
-    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], send("to_#{terminal}".to_sym, **options)]
-    end
-
-    ##
-    # @private
-    # Output 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).
-    #
-    # @param trminal [String] terminal name ('png', 'svg' etc)
-    # @param path [String] path to output file, if none given it will output to temp file
-    #   and then read it and return binary contents of file
-    # @param options [Hash] used in #plot
-    # @example
-    #   ## 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
-
-    ##
-    # @return [Terminal] terminal object linked with this Plottable object
-    def own_terminal
-      @terminal ||= Terminal.new
-    end
-
-    ##
-    # @!method xrange(value = nil)
-    # @!method yrange(value = nil)
-    # @!method title(value = nil)
-    # @!method option_name(value = nil)
-    # Clone existing object and set new options value in created one or just return
-    # existing value if nil given.
-    #
-    # Method is handled by #method_missing.
-    #
-    # 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.
-    # 
-    # Available options are listed in Plot, Splot, Multiplot etc class top level doc.
-    #
-    # @param value new value for option
-    # @return new object with option_name set to *value* if value given
-    # @return old option value if no value given
-    #
-    # @example
-    #   plot = Splot.new
-    #   new_plot = plot.title('Awesome plot')
-    #   plot.title #=> nil
-    #   new_plot.title #=> 'Awesome plot'
-
-    ##
-    # @!method xrange!(value)
-    # @!method yrange!(value)
-    # @!method title!(value)
-    # @!method option_name!(value)
-    # Set value for an option.
-    #
-    # Method is handled by #method_missing.
-    #
-    # You may set options using obj.option_name!(option_value) or 
-    # obj.option_name = option_value methods.
-    # 
-    # Available options are listed in Plot, Splot, Multiplot etc class top level doc.
-    #
-    # @param value new value for option
-    # @return self
-    #
-    # @example
-    #   plot = Splot.new
-    #   plot.title #=> nil
-    #   plot.title!('Awesome plot')
-    #   plot.title #=> 'Awesome plot'
-    #
-    # @example
-    #   plot = Splot.new
-    #   plot.title #=> nil
-    #   plot.title = 'Awesome plot'
-    #   plot.title #=> 'Awesome plot'
-
-    ##
-    # @!method to_png(path = nil, **options)
-    # @!method to_svg(path = nil, **options)
-    # @!method to_gif(path = nil, **options)
-    # @!method to_canvas(path = nil, **options)
-    # Output to plot to according image format.
-    #
-    # All of #to_|terminal_name| methods are handled with #method_missing.
-    #
-    # Gnuplot offers possibility to output graphics to many image formats.
-    # The easiest way to to so is to use #to_<plot_name> methods.
-    #
-    # @param path [String] path to save plot file to.
-    # @param options [Hash] specific terminal options like 'size',
-    #   'font' etc
-    #
-    # @return [String] contents of plotted file unless path given
-    # @return self if path given
-    #
-    # @example
-    #   # 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)
-  end
-end
+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
+
+    ##
+    # @private
+    # You should implement #plot in classes that are Plottable
+    def plot(*_)
+      fail NotImplementedError, 'You should implement #plot in classes that are Plottable!'
+    end
+
+    ##
+    # 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
+      case
+      when meth[0..2] == 'to_'
+        term = meth[3..-1]
+        super unless OptionHandling.valid_terminal?(term)
+        to_specific_term(term, *args)
+      when meth[-1] == '!'
+        option!(meth[0..-2].to_sym, *args)
+      when meth[-1] == '='
+        option!(meth[0..-2].to_sym, *args)
+        option(meth[0..-2].to_sym)
+      else
+        option(meth_id, *args)
+      end
+    end
+
+    ##
+    # @return [true] for existing methods and
+    #   #to_|term_name| when name is a valid terminal type.
+    # @return [false] otherwise
+    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
+
+    ##
+    # This method is used to embed plottable objects into iRuby notebooks. There is
+    # {a notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/basic_usage.ipynb]
+    # with examples of its usage.
+    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], send("to_#{terminal}".to_sym, **options)]
+    end
+
+    ##
+    # @private
+    # Output 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).
+    #
+    # @param trminal [String] terminal name ('png', 'svg' etc)
+    # @param path [String] path to output file, if none given it will output to temp file
+    #   and then read it and return binary contents of file
+    # @param options [Hash] used in #plot
+    # @example
+    #   ## 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
+
+    ##
+    # @return [Terminal] terminal object linked with this Plottable object
+    def own_terminal
+      @terminal ||= Terminal.new
+    end
+
+    ##
+    # @!method xrange(value = nil)
+    # @!method yrange(value = nil)
+    # @!method title(value = nil)
+    # @!method option_name(value = nil)
+    # Clone existing object and set new options value in created one or just return
+    # existing value if nil given.
+    #
+    # Method is handled by #method_missing.
+    #
+    # 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.
+    # 
+    # Available options are listed in Plot, Splot, Multiplot etc class top level doc.
+    #
+    # @param value new value for option
+    # @return new object with option_name set to *value* if value given
+    # @return old option value if no value given
+    #
+    # @example
+    #   plot = Splot.new
+    #   new_plot = plot.title('Awesome plot')
+    #   plot.title #=> nil
+    #   new_plot.title #=> 'Awesome plot'
+
+    ##
+    # @!method xrange!(value)
+    # @!method yrange!(value)
+    # @!method title!(value)
+    # @!method option_name!(value)
+    # Set value for an option.
+    #
+    # Method is handled by #method_missing.
+    #
+    # You may set options using obj.option_name!(option_value) or 
+    # obj.option_name = option_value methods.
+    # 
+    # Available options are listed in Plot, Splot, Multiplot etc class top level doc.
+    #
+    # @param value new value for option
+    # @return self
+    #
+    # @example
+    #   plot = Splot.new
+    #   plot.title #=> nil
+    #   plot.title!('Awesome plot')
+    #   plot.title #=> 'Awesome plot'
+    #
+    # @example
+    #   plot = Splot.new
+    #   plot.title #=> nil
+    #   plot.title = 'Awesome plot'
+    #   plot.title #=> 'Awesome plot'
+
+    ##
+    # @!method to_png(path = nil, **options)
+    # @!method to_svg(path = nil, **options)
+    # @!method to_gif(path = nil, **options)
+    # @!method to_canvas(path = nil, **options)
+    # Output to plot to according image format.
+    #
+    # All of #to_|terminal_name| methods are handled with #method_missing.
+    #
+    # Gnuplot offers possibility to output graphics to many image formats.
+    # The easiest way to to so is to use #to_<plot_name> methods.
+    #
+    # @param path [String] path to save plot file to.
+    # @param options [Hash] specific terminal options like 'size',
+    #   'font' etc
+    #
+    # @return [String] contents of plotted file unless path given
+    # @return self if path given
+    #
+    # @example
+    #   # 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)
+  end
+end