rubyplot 0.0.1 → 0.1.pre.a1

data/lib/rubyplot/artist/axis.rb

@@ -0,0 +1,3 @@
+require_relative 'axis/base'
+require_relative 'axis/x_axis'
+require_relative 'axis/y_axis'

data/lib/rubyplot/artist/axis/base.rb

@@ -0,0 +1,34 @@
+module Rubyplot
+  module Artist
+    class Axis
+      class Base
+        # Length in pixels of the arrow after the last major tick.
+        FINISH_ARROW_LENGTH = 10.0
+
+        attr_reader :label, :ticks, :major_ticks_count
+        attr_reader :abs_x1, :abs_x2, :abs_y1, :abs_y2, :backend, :length
+        attr_reader :stroke_width, :major_ticks
+        attr_accessor :title, :min_val, :max_val
+
+        def initialize axes
+          @axes = axes
+          @title = ''
+          @min_val = nil
+          @max_val = nil
+          @stroke_width = 1.0
+          @major_ticks_count = 5
+          @x_ticks = nil
+          @texts = []
+          @lines = []
+        end
+
+        def draw
+          configure_title
+          @lines.each(&:draw)
+          @texts.each(&:draw)
+        end
+
+      end # class Base
+    end # class Axis
+  end # class Artist
+end # module Rubyplot

data/lib/rubyplot/artist/axis/x_axis.rb

@@ -0,0 +1,35 @@
+require_relative 'base'
+
+module Rubyplot
+  module Artist
+    class XAxis < Axis::Base
+      def initialize axes
+        super
+        @abs_x1 = @axes.origin[0]
+        @abs_x2 = @axes.abs_x + @axes.width - @axes.y_axis_margin
+        @major_ticks_distance = (@abs_x2 - @abs_x1) / @major_ticks_count
+        @length = (@abs_x2 - @abs_x1).abs
+        configure_axis_line
+      end
+
+      private
+
+      def configure_axis_line
+        @lines << Rubyplot::Artist::Line2D.new(
+          self, abs_x1: @abs_x1, abs_y1: @axes.origin[1], abs_x2: @abs_x2, abs_y2: @axes.origin[1],
+                stroke_width: @stroke_width
+        )
+      end
+
+      def configure_title
+        @texts << Rubyplot::Artist::Text.new(
+          @title,
+          self,
+          pointsize: @axes.marker_font_size,
+          abs_y: @axes.origin[1] + 20,
+          abs_x: @axes.origin[0] + (@abs_x2 - @abs_x1)/2
+        )
+      end
+    end # class XAxis
+  end # class Artist
+end # module Rubyplot

data/lib/rubyplot/artist/axis/y_axis.rb

@@ -0,0 +1,40 @@
+module Rubyplot
+  module Artist
+    class YAxis < Axis::Base
+      def initialize(*)
+        super
+        @abs_x1 = @axes.origin[0]
+        @abs_y1 = @axes.origin[1]
+        @abs_x2 = @axes.origin[0]
+        @abs_y2 = @axes.origin[1] - (@axes.height - @axes.x_axis_margin)
+        @y_ticks = []
+        @length = (@abs_y1 - @abs_y2).abs
+        configure_axis_line
+      end
+
+      private
+
+      def configure_axis_line
+        @lines << Rubyplot::Artist::Line2D.new(
+          self,
+          abs_x1: @abs_x1,
+          abs_y1: @abs_y1,
+          abs_x2: @abs_x2,
+          abs_y2: @abs_y2,
+          stroke_width: @stroke_width
+        )
+      end
+
+      def configure_title
+        @texts << Rubyplot::Artist::Text.new(
+          @title,
+          self,
+          rotation: -90.0,
+          abs_x: @axes.origin[0] - 10,
+          abs_y: (@abs_y1 - @abs_y2) / 2,
+          pointsize: @axes.marker_font_size
+        )
+      end
+    end # class YAxis
+  end # class Artist
+end # module Rubyplot

data/lib/rubyplot/artist/base.rb

@@ -0,0 +1,14 @@
+module Rubyplot
+  module Artist
+    class Base
+      # Absolute X co-ordinate of this Aritist on the canvas.
+      attr_reader :abs_x
+      # Absolute Y co-ordinate of this Aritist on the canvas.
+      attr_reader :abs_y
+      def initialize(abs_x, abs_y)
+        @abs_x = abs_x
+        @abs_y = abs_y
+      end
+    end # class Base
+  end # module Artist
+end # module Rubyplot

data/lib/rubyplot/artist/circle.rb

@@ -0,0 +1,28 @@
+module Rubyplot
+  module Artist
+    class Circle < Base
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(owner, abs_x:, abs_y:, radius:, stroke_opacity: 0.0,
+        color: :default, stroke_width:)
+        super(abs_x, abs_y)
+        @owner = owner
+        @radius = radius
+        @stroke_width = stroke_width
+        @stroke_opacity = stroke_opacity
+        @color = color
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def draw
+        Rubyplot.backend.draw_circle(
+          x: @abs_x,
+          y: @abs_y,
+          radius: @radius,
+          stroke_opacity: @stroke_opacity,
+          stroke_width: @stroke_width,
+          color: Rubyplot::Color::COLOR_INDEX[@color]
+        )
+      end
+    end # class Circle
+  end # module Artist
+end # module Rubyplot

data/lib/rubyplot/artist/figure.rb

@@ -0,0 +1,90 @@
+module Rubyplot
+  module Artist
+    class Figure < Artist::Base
+      DEFAULT_TARGET_WIDTH = 800
+
+      # Title on the figure.
+      attr_reader :title
+      # Number of Axes objects in the rows.
+      attr_reader :nrows
+      # Number of Axes objects in the cols.
+      attr_reader :ncols
+      # Total width of the Figure in pixels.
+      attr_reader :width
+      # Total height of the Figure in pixels.
+      attr_reader :height
+      # Ratio of the total height that is the spacing between the top of the
+      #   Figure and the top of the Axes.
+      attr_reader :top_spacing
+      # Ratio of the total width that is the spacing between the left of the
+      #   Figure and the left of the Axes.
+      attr_reader :left_spacing
+      # Ratio of the total width that is the spacing between the right of the
+      #   Figure and the right of the Axes.
+      attr_reader :right_spacing
+      # Ratio of the total width that is the spacing between the bottom of the
+      #   Figure and the bottom of the Axes.
+      attr_reader :bottom_spacing
+      attr_reader :theme_options
+      attr_reader :marker_color
+      attr_reader :font_color
+
+      # Initialize a Rubyplot::Artist::Figure object.
+      # @param height [Integer] nil Height in pixels of the complete Figure.
+      # @param width [Integer] nil Width in pixels of the complete Figure.
+      def initialize(height: nil, width: nil)
+        super(0, 0)
+        @title = ''
+        @nrows = 1
+        @ncols = 1
+        @width = width || DEFAULT_TARGET_WIDTH
+        @height = height || @width * 0.75
+        @top_spacing = 0.05
+        @bottom_spacing = 0.05
+        @left_spacing = 0.05
+        @right_spacing = 0.05
+        @subplots = nil
+        @n = 0
+        setup_default_theme
+        add_subplots @nrows, @ncols
+      end
+
+      def add_subplots(nrows, ncols)
+        @subplots = Array.new(nrows) { Array.new(ncols) { nil } }
+      end
+
+      def add_subplot(nrow, ncol)
+        @subplots[nrow][ncol] = Rubyplot::Artist::Axes.new(self)
+        @subplots[nrow][ncol]
+      end
+
+      # Draw on a canvas and output to a file.
+      #
+      # @param output [TrueClass, FalseClass] true Whether to output to file or not.
+      def write(file_name, output: true)
+        Rubyplot.backend.set_base_image_gradient(
+          Rubyplot::Color::COLOR_INDEX[@theme_options[:background_colors][0]],
+          Rubyplot::Color::COLOR_INDEX[@theme_options[:background_colors][1]],
+          @width,
+          @height,
+          @theme_options[:background_direction]
+        )
+        @subplots.each { |i| i.each(&:draw) }
+        Rubyplot.backend.write(file_name) if output
+      end
+
+      private
+
+      def setup_default_theme
+        defaults = {
+          marker_color: :white,
+          font_color: :black,
+          background_image: nil
+        }
+        @theme_options = defaults.merge Themes::CLASSIC_WHITE
+        @marker_color = @theme_options[:marker_color]
+        @font_color = @theme_options[:font_color] || @marker_color
+      end
+    end # class Figure
+  end # module Artist
+end # module Rubyplot

data/lib/rubyplot/artist/legend.rb

@@ -0,0 +1,59 @@
+module Rubyplot
+  module Artist
+    class Legend < Artist::Base
+      TOP_MARGIN = 2.5
+      BOTTOM_MARGIN = 2.5
+      # Space between the color box and the legend text.
+      BOX_AND_TEXT_SPACE = 5.0
+      attr_reader :legend_box_size, :font, :font_size, :font_color
+
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(legend_box, axes, text:, color:,abs_x:,abs_y:)
+        super(abs_x, abs_y)
+        @legend_box = legend_box
+        @axes = axes
+        @text = text
+        @color = color
+        @legend_box_size = @legend_box.per_legend_height -
+                           (TOP_MARGIN + BOTTOM_MARGIN) # size of the color box of the legend.
+        @font_size = 20.0
+        @font = @axes.font
+        @font_color = @axes.font_color
+        configure_legend_color_box
+        configure_legend_text
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def draw
+        @legend_color_box.draw
+        @text.draw
+      end
+
+      private
+
+      def configure_legend_color_box
+        @legend_color_box = Rubyplot::Artist::Rectangle.new(
+          self,
+          abs_x: @abs_x,
+          abs_y: @abs_y + TOP_MARGIN,
+          width: @legend_box_size,
+          height: @legend_box_size,
+          border_color: @color,
+          fill_color: @color
+        )
+      end
+
+      def configure_legend_text
+        @text = Rubyplot::Artist::Text.new(
+          @text,
+          self,
+          abs_x: @abs_x + @legend_box_size + BOX_AND_TEXT_SPACE,
+          abs_y: @legend_color_box.abs_y + @legend_box_size - 2.5,
+          font: @font,
+          color: @font_color,
+          pointsize: @font_size
+        )
+      end
+    end # class Legend
+  end # class Artist
+end # module Rubyplot

data/lib/rubyplot/artist/legend_box.rb

@@ -0,0 +1,89 @@
+module Rubyplot
+  module Artist
+    class LegendBox < Base
+      # Ratio of total height of legend box that is the top margin.
+      TOP_SPACING_RATIO = 0.1
+      # Ratio of the total height of the legend box that is the bottom margin.
+      BOTTOM_SPACING_RATIO = 0.1
+      # Ratio of the total width of the legend box that is the left margin.
+      LEFT_SPACING_RATIO = 0.1
+      # Ratio of the total width of the legend box that is the right margin.
+      RIGHT_SPACING_RATIO = 0.1
+
+      attr_accessor :border_color
+
+      def initialize(axes, abs_x:, abs_y:)
+        super(abs_x, abs_y)
+        @axes = axes
+        @border_color = :black
+        @legends = []
+        configure_dimensions
+        configure_legends
+        configure_legend_box
+      end
+
+      def draw
+        unless @legends.empty?
+          @bounding_box.draw
+          @legends.each(&:draw)
+        end
+      end
+
+      def top_margin
+        TOP_SPACING_RATIO * @legends_height
+      end
+
+      def bottom_margin
+        BOTTOM_SPACING_RATIO * @legends_height
+      end
+
+      def left_margin
+        LEFT_SPACING_RATIO * @legends_width
+      end
+
+      def right_margin
+        RIGHT_SPACING_RATIO * @legends_width
+      end
+
+      # Calculation of the height that each legend takes.
+      def per_legend_height
+        25.0
+      end
+
+      private
+
+      def configure_legend_box
+        @bounding_box = Rubyplot::Artist::Rectangle.new(
+          self,
+          abs_x: @abs_x,
+          abs_y: @abs_y,
+          width: @width,
+          height: @height,
+          border_color: @border_color
+        )
+      end
+
+      def configure_dimensions
+        @legends_height = @axes.plots.size * per_legend_height
+        @legends_width = 0.2 * @axes.width
+        @height = @legends_height + top_margin + bottom_margin
+        @width = @legends_width + left_margin + right_margin
+      end
+
+      def configure_legends
+        @axes.plots.each_with_index do |plot, count|
+          next unless plot.label != ''
+
+          @legends << Rubyplot::Artist::Legend.new(
+            self,
+            @axes,
+            text: plot.label,
+            color: plot.color,
+            abs_x: @abs_x + left_margin,
+            abs_y: @abs_y + count * per_legend_height + top_margin
+          )
+        end
+      end
+    end # class LegendBox
+  end # module Artist
+end # module Rubyplot

data/lib/rubyplot/artist/line2d.rb

@@ -0,0 +1,24 @@
+module Rubyplot
+  module Artist
+    class Line2D < Artist::Base
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(owner,abs_x1:,abs_y1:,abs_x2:,abs_y2:,color: '#000000',
+        stroke_opacity: 0.0, stroke_width: 2.0)
+        @owner = owner
+        @abs_x1 = abs_x1
+        @abs_y1 = abs_y1
+        @abs_x2 = abs_x2
+        @abs_y2 = abs_y2
+        @color = color
+        @stroke_opacity = stroke_opacity
+        @stroke_width = stroke_width
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def draw
+        Rubyplot.backend.draw_line(x1: @abs_x1, y1: @abs_y1, x2: @abs_x2, y2: @abs_y2,
+                           stroke_width: @stroke_width)
+      end
+    end # class Line2D
+  end # class Artist
+end # module Rubyplot

data/lib/rubyplot/artist/plot.rb

@@ -0,0 +1,9 @@
+require_relative 'plot/base'
+require_relative 'plot/scatter'
+require_relative 'plot/line'
+require_relative 'plot/bar'
+require_relative 'plot/multi_bars'
+require_relative 'plot/stacked_bar'
+require_relative 'plot/multi_stacked_bar'
+require_relative 'plot/bubble'
+require_relative 'plot/area'

data/lib/rubyplot/artist/plot/area.rb

@@ -0,0 +1,38 @@
+module Rubyplot
+  module Artist
+    module Plot
+      class Area < Artist::Plot::Base
+        attr_accessor :sorted_data
+
+        def initialize(*)
+          super
+          @sorted_data = true
+        end
+
+        def data x_values, y_values=[]
+          y_values = Array.new(x_values.size) { |i| i } if y_values.empty?
+          x_values.sort! if @sorted_data
+          super(x_values, y_values)
+        end
+
+        def draw
+          poly_points = []
+          @normalized_data[:y_values].each_with_index do |iy, idx_y|
+            ix = @normalized_data[:x_values][idx_y]
+            abs_x = ix * @axes.x_axis.length + @axes.abs_x + @axes.y_axis_margin
+            abs_y = (@axes.y_axis.length - iy * @axes.y_axis.length) + @axes.abs_y
+            poly_points << [abs_x, abs_y]
+          end
+          poly_points << [@axes.x_axis.abs_x2, @axes.origin[1] - @axes.x_axis.stroke_width]
+          poly_points << [@axes.origin[0], @axes.origin[1] - @axes.x_axis.stroke_width]
+          Rubyplot::Artist::Polygon.new(
+            self,
+            coords: poly_points,
+            color: @data[:color],
+            fill_opacity: 0.3
+          ).draw
+        end
+      end # class Area
+    end # module Plot
+  end # module Artist
+end # module Rubyplot