gruff 0.9.0 → 0.12.2

data/lib/gruff/renderer/bezier.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Renderer::Bezier
-    def initialize(args = {})
-      @color = args[:color]
-      @width = args[:width] || 1.0
+    def initialize(color:, width: 1.0)
+      @color = color
+      @width = width
     end
 
     def render(points)

data/lib/gruff/renderer/circle.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Renderer::Circle
-    def initialize(args = {})
-      @color = args[:color]
-      @width = args[:width] || 1.0
+    def initialize(color:, width: 1.0)
+      @color = color
+      @width = width
     end
 
     def render(origin_x, origin_y, perim_x, perim_y)

data/lib/gruff/renderer/dash_line.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Renderer::DashLine
-    def initialize(args = {})
-      @color = args[:color]
-      @width = args[:width]
+    def initialize(color:, width:)
+      @color = color
+      @width = width
     end
 
     def render(start_x, start_y, end_x, end_y)

data/lib/gruff/renderer/dot.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Renderer::Dot
-    def initialize(style, config)
+    def initialize(style, color:, width: 1.0)
       @style = style
-      @color = config[:color]
-      @width = config[:width] || 1.0
+      @color = color
+      @width = width
     end
 
     def render(new_x, new_y, circle_radius)

data/lib/gruff/renderer/ellipse.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Renderer::Ellipse
-    def initialize(args = {})
-      @color = args[:color]
-      @width = args[:width] || 1.0
+    def initialize(color:, width: 1.0)
+      @color = color
+      @width = width
     end
 
     def render(origin_x, origin_y, width, height, arc_start, arc_end)

data/lib/gruff/renderer/line.rb

@@ -1,15 +1,24 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Renderer::Line
     EPSILON = 0.001
 
-    def initialize(args = {})
-      @color = args[:color]
-      @width = args[:width]
+    def initialize(color:, width: nil, shadow_color: nil)
+      @color = color
+      @width = width
+      @shadow_color = shadow_color
     end
 
     def render(start_x, start_y, end_x, end_y)
+      render_line(start_x, start_y, end_x, end_y, @color)
+      render_line(start_x, start_y + 1, end_x, end_y + 1, @shadow_color) if @shadow_color
+    end
+
+  private
+
+    def render_line(start_x, start_y, end_x, end_y, color)
       # FIXME(uwe): Workaround for Issue #66
       #             https://github.com/topfunky/gruff/issues/66
       #             https://github.com/rmagick/rmagick/issues/82
@@ -24,8 +33,8 @@ module Gruff
       draw = Renderer.instance.draw
 
       draw.push
-      draw.stroke(@color)
-      draw.fill(@color)
+      draw.stroke(color)
+      draw.fill(color)
       draw.stroke_width(@width) if @width
       draw.line(start_x, start_y, end_x, end_y)
       draw.pop

data/lib/gruff/renderer/polygon.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Renderer::Polygon
-    def initialize(args = {})
-      @color = args[:color]
-      @width = args[:width] || 1.0
-      @opacity = args[:opacity] || 1.0
+    def initialize(color:, width: 1.0, opacity: 1.0)
+      @color = color
+      @width = width
+      @opacity = opacity
     end
 
     def render(points)

data/lib/gruff/renderer/polyline.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Renderer::Polyline
-    def initialize(args = {})
-      @color = args[:color]
-      @width = args[:width]
+    def initialize(color:, width:)
+      @color = color
+      @width = width
     end
 
     def render(points)

data/lib/gruff/renderer/rectangle.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Renderer::Rectangle
-    def initialize(args = {})
-      @color = args[:color]
+    def initialize(color: nil)
+      @color = color
     end
 
     def render(upper_left_x, upper_left_y, lower_right_x, lower_right_y)

data/lib/gruff/renderer/renderer.rb

@@ -7,58 +7,51 @@ module Gruff
   class Renderer
     include Singleton
 
-    attr_accessor :draw, :image, :scale
+    attr_accessor :draw, :image, :scale, :text_renderers
 
-    class << self
-      def setup(columns, rows, font, scale, theme_options)
-        draw = Magick::Draw.new
-        draw.font = font if font
-        # Scale down from 800x600 used to calculate drawing.
-        draw.scale(scale, scale)
+    def self.setup(columns, rows, font, scale, theme_options)
+      draw = Magick::Draw.new
+      draw.font = font if font
+      # Scale down from 800x600 used to calculate drawing.
+      draw.scale(scale, scale)
 
-        image = Renderer.instance.background(columns, rows, scale, theme_options)
+      image = Renderer.instance.background(columns, rows, scale, theme_options)
 
-        Renderer.instance.draw  = draw
-        Renderer.instance.scale = scale
-        Renderer.instance.image = image
-      end
-
-      def setup_transparent_background(columns, rows)
-        image = Renderer.instance.render_transparent_background(columns, rows)
-        Renderer.instance.image = image
-      end
+      Renderer.instance.draw  = draw
+      Renderer.instance.scale = scale
+      Renderer.instance.image = image
+      Renderer.instance.text_renderers = []
+    end
 
-      def background_image=(image)
-        Renderer.instance.image = image
-      end
+    def self.setup_transparent_background(columns, rows)
+      image = Renderer.instance.render_transparent_background(columns, rows)
+      Renderer.instance.image = image
+    end
 
-      def font=(font)
-        draw = Renderer.instance.draw
-        draw.font = font if font
-      end
+    def self.background_image=(image)
+      Renderer.instance.image = image
+    end
 
-      def finish
-        draw  = Renderer.instance.draw
-        image = Renderer.instance.image
+    def self.font=(font)
+      draw = Renderer.instance.draw
+      draw.font = font if font
+    end
 
-        draw.draw(image)
-      end
+    def self.finish
+      draw  = Renderer.instance.draw
+      image = Renderer.instance.image
 
-      def write(file_name)
-        Renderer.instance.image.write(file_name)
-      end
+      draw.draw(image)
 
-      def to_blob(file_format)
-        Renderer.instance.image.to_blob do
-          self.format = file_format
-        end
+      Renderer.instance.text_renderers.each do |renderer|
+        renderer.render(renderer.width, renderer.height, renderer.x, renderer.y, renderer.gravity)
       end
     end
 
     def background(columns, rows, scale, theme_options)
       case theme_options[:background_colors]
       when Array
-        gradated_background(columns, rows, theme_options[:background_colors][0], theme_options[:background_colors][1], theme_options[:background_direction])
+        gradated_background(columns, rows, *theme_options[:background_colors][0..1], theme_options[:background_direction])
       when String
         solid_background(columns, rows, theme_options[:background_colors])
       else
@@ -102,7 +95,7 @@ module Gruff
 
       if @gradated_background_retry_count < 3
         @gradated_background_retry_count += 1
-        gradated_background(top_color, bottom_color, direct)
+        gradated_background(columns, rows, top_color, bottom_color, direct)
       else
         raise e
       end

data/lib/gruff/renderer/text.rb

@@ -1,14 +1,29 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Renderer::Text
-    def initialize(text, args = {})
+    using Magick::GruffAnnotate
+
+    def initialize(text, font:, size:, color:, weight: Magick::NormalWeight, rotation: nil)
       @text = text.to_s
-      @font = args[:font]
-      @font_size = args[:size]
-      @font_color = args[:color]
-      @font_weight = args[:weight] || Magick::NormalWeight
-      @rotation = args[:rotation]
+      @font = font
+      @font_size = size
+      @font_color = color
+      @font_weight = weight
+      @rotation = rotation
+    end
+
+    attr_reader :width, :height, :x, :y, :gravity
+
+    def add_to_render_queue(width, height, x, y, gravity = Magick::NorthGravity)
+      @width = width
+      @height = height
+      @x = x
+      @y = y
+      @gravity = gravity
+
+      Renderer.instance.text_renderers << self
     end
 
     def render(width, height, x, y, gravity = Magick::NorthGravity)
@@ -36,7 +51,14 @@ module Gruff
 
       draw.font_weight = font_weight
       draw.pointsize = size
-      draw.get_type_metrics(image, text.to_s)
+
+      # The old ImageMagick causes SEGV with string which has '%' + alphabet (eg. '%S').
+      # This format is used to embed value into a string using image properties.
+      # However, gruff use plain image as canvas which does not have any property.
+      # So, in here, it just escape % in order to avoid SEGV.
+      text = text.to_s.gsub(/(%+)/) { ('%' * Regexp.last_match(1).size * 2).to_s }
+
+      draw.get_type_metrics(image, text)
     end
   end
 end

data/lib/gruff/scatter.rb

@@ -1,44 +1,48 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
-# Here's how to set up an XY Scatter Chart
+#
+# Here's how to set up a Gruff::Scatter.
 #
 #   g = Gruff::Scatter.new(800)
-#   g.data(:apples, [1,2,3,4], [4,3,2,1])
-#   g.data('oranges', [5,7,8], [4,1,7])
-#   g.write('test/output/scatter.png')
+#   g.data :apples, [1,2,3,4], [4,3,2,1]
+#   g.data 'oranges', [5,7,8], [4,1,7]
+#   g.write('scatter.png')
 #
 class Gruff::Scatter < Gruff::Base
   # Maximum X Value. The value will get overwritten by the max in the
   # datasets.
-  attr_accessor :maximum_x_value
+  attr_writer :maximum_x_value
 
   # Minimum X Value. The value will get overwritten by the min in the
   # datasets.
-  attr_accessor :minimum_x_value
+  attr_writer :minimum_x_value
 
   # The number of vertical lines shown for reference.
-  attr_accessor :marker_x_count
+  attr_writer :marker_x_count
 
   # Attributes to allow customising the size of the points.
-  attr_accessor :circle_radius
-  attr_accessor :stroke_width
+  attr_writer :circle_radius
+  attr_writer :stroke_width
 
   # Allow disabling the significant rounding when labeling the X axis.
   # This is useful when working with a small range of high values (for example, a date range of months, while seconds as units).
-  attr_accessor :disable_significant_rounding_x_axis
+  attr_writer :disable_significant_rounding_x_axis
 
   # Allow enabling vertical lines. When you have a lot of data, they can work great.
-  attr_accessor :enable_vertical_line_markers
+  attr_writer :enable_vertical_line_markers
 
   # Allow using vertical labels in the X axis (and setting the label margin).
-  attr_accessor :x_label_margin
-  attr_accessor :use_vertical_x_labels
+  attr_writer :x_label_margin
+  attr_writer :use_vertical_x_labels
 
   # Allow passing lambdas to format labels.
-  attr_accessor :y_axis_label_format
-  attr_accessor :x_axis_label_format
+  attr_writer :y_axis_label_format
+  attr_writer :x_axis_label_format
+
+  def initialize_store
+    @store = Gruff::Store.new(Gruff::Store::XYData)
+  end
+  private :initialize_store
 
   def initialize_ivars
     super
@@ -55,8 +59,6 @@ class Gruff::Scatter < Gruff::Base
     @x_axis_label_format = nil
     @x_label_margin = nil
     @y_axis_label_format = nil
-
-    @store = Gruff::Store.new(Gruff::Store::XYData)
   end
   private :initialize_ivars
 
@@ -80,8 +82,6 @@ class Gruff::Scatter < Gruff::Base
         Gruff::Renderer::Circle.new(color: data_row.color, width: stroke_width).render(new_x, new_y, new_x - circle_radius, new_y)
       end
     end
-
-    Gruff::Renderer.finish
   end
 
   # The first parameter is the name of the dataset.  The next two are the
@@ -191,7 +191,7 @@ private
       calculate_spread
       normalize
 
-      @marker_count = (@x_spread / @x_axis_increment).to_i
+      self.marker_count = (@x_spread / @x_axis_increment).to_i
       @x_increment = @x_axis_increment
     end
     increment_x_scaled = @graph_width.to_f / (@x_spread / @x_increment)
@@ -201,7 +201,9 @@ private
       # TODO: Fix the vertical lines, and enable them by default. Not pretty when they don't match up with top y-axis line
       if @enable_vertical_line_markers
         x = @graph_left + @graph_width - index.to_f * increment_x_scaled
-        Gruff::Renderer::Line.new(color: @marker_color).render(x, @graph_top, x, @graph_bottom)
+
+        line_renderer = Gruff::Renderer::Line.new(color: @marker_color, shadow_color: @marker_shadow_color)
+        line_renderer.render(x, @graph_top, x, @graph_bottom)
       end
 
       unless @hide_line_numbers
@@ -212,7 +214,7 @@ private
         label = vertical_label(marker_label, @x_increment)
         rotation = -90.0 if @use_vertical_x_labels
         text_renderer = Gruff::Renderer::Text.new(label, font: @font, size: @marker_font_size, color: @font_color, rotation: rotation)
-        text_renderer.render(1.0, 1.0, x_offset, y_offset)
+        text_renderer.add_to_render_queue(1.0, 1.0, x_offset, y_offset)
       end
     end
   end

data/lib/gruff/scene.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'observer'
-require 'gruff/base'
 
 # A scene is a non-linear graph that assembles layers together to tell a story.
 # Layers are folders with appropriately named files (see below). You can group

data/lib/gruff/side_bar.rb

@@ -1,27 +1,50 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
 # Graph with individual horizontal bars instead of vertical bars.
+#
+# Here's how to set up a Gruff::SideBar.
+#
+#   g = Gruff::SideBar.new
+#   g.title = 'SideBar Graph'
+#   g.labels = {
+#     0 => '5/6',
+#     1 => '5/15',
+#     2 => '5/24',
+#     3 => '5/30',
+#   }
+#   g.group_spacing = 20
+#   g.data :Art, [0, 5, 8, 15]
+#   g.data :Philosophy, [10, 3, 2, 8]
+#   g.data :Science, [2, 15, 8, 11]
+#   g.write('sidebar.png')
+#
 class Gruff::SideBar < Gruff::Base
+  using String::GruffCommify
+
   # Spacing factor applied between bars.
-  attr_accessor :bar_spacing
+  attr_writer :bar_spacing
 
   # Spacing factor applied between a group of bars belonging to the same label.
-  attr_accessor :group_spacing
+  attr_writer :group_spacing
 
   # Set the number output format for labels using sprintf.
   # Default is +"%.2f"+.
-  attr_accessor :label_formatting
+  attr_writer :label_formatting
 
   # Output the values for the bars on a bar graph.
   # Default is +false+.
-  attr_accessor :show_labels_for_bar_values
+  attr_writer :show_labels_for_bar_values
+
+  # Prevent drawing of column labels left of a side bar graph.  Default is +false+.
+  attr_writer :hide_labels
 
   def initialize_ivars
     super
+    @bar_spacing = 0.9
+    @group_spacing = 10
     @label_formatting = nil
     @show_labels_for_bar_values = false
+    @hide_labels = false
   end
   private :initialize_ivars
 
@@ -34,14 +57,25 @@ class Gruff::SideBar < Gruff::Base
     draw_bars
   end
 
+protected
+
+  def hide_labels?
+    @hide_labels
+  end
+
+  def hide_left_label_area?
+    hide_labels?
+  end
+
+  def hide_bottom_label_area?
+    @hide_line_markers
+  end
+
 private
 
   def draw_bars
     # Setup spacing.
     #
-    @bar_spacing ||= 0.9
-    @group_spacing ||= 10
-
     bars_width = (@graph_height - calculate_spacing) / column_count.to_f
     bar_width = bars_width / store.length
     height = Array.new(column_count, 0)
@@ -57,7 +91,7 @@ private
       data_row.points.each_with_index do |data_point, point_index|
         group_spacing = @group_spacing * @scale * point_index
 
-        # Using the original calcs from the stacked bar chart
+        # Using the original calculations from the stacked bar chart
         # to get the difference between
         # part of the bart chart we wish to stack.
         temp1 = @graph_left + (@graph_width - data_point * @graph_width - height[point_index])
@@ -89,8 +123,6 @@ private
         end
       end
     end
-
-    Gruff::Renderer.finish
   end
 
   # Instead of base class version, draws vertical background lines and label
@@ -98,7 +130,7 @@ private
     return if @hide_line_markers
 
     # Draw horizontal line markers and annotate with numbers
-    number_of_lines = @marker_count || 5
+    number_of_lines = marker_count
     number_of_lines = 1 if number_of_lines == 0
 
     # TODO: Round maximum marker value to a round number like 100, 0.1, 0.5, etc.
@@ -106,13 +138,16 @@ private
     (0..number_of_lines).each do |index|
       line_diff = (@graph_right - @graph_left) / number_of_lines
       x = @graph_right - (line_diff * index) - 1
-      Gruff::Renderer::Line.new(color: @marker_color).render(x, @graph_bottom, x, @graph_top)
+
+      line_renderer = Gruff::Renderer::Line.new(color: @marker_color, shadow_color: @marker_shadow_color)
+      line_renderer.render(x, @graph_bottom, x, @graph_top)
+
       diff = index - number_of_lines
       marker_label = diff.abs * increment + minimum_value
 
       unless @hide_line_numbers
         text_renderer = Gruff::Renderer::Text.new(marker_label, font: @font, size: @marker_font_size, color: @font_color)
-        text_renderer.render(0, 0, x, @graph_bottom + (LABEL_MARGIN * 2.0), Magick::CenterGravity)
+        text_renderer.add_to_render_queue(0, 0, x, @graph_bottom + LABEL_MARGIN, Magick::CenterGravity)
       end
     end
   end
@@ -125,11 +160,7 @@ private
       lbl = @use_data_label ? label : @labels[index]
 
       text_renderer = Gruff::Renderer::Text.new(lbl, font: @font, size: @marker_font_size, color: @font_color)
-      if RUBY_PLATFORM == 'java'
-        text_renderer.render(1, 1, @graph_left - LABEL_MARGIN * 2.0, y_offset, Magick::EastGravity)
-      else
-        text_renderer.render(1, 1, -@graph_left + LABEL_MARGIN * 2.0, y_offset, Magick::EastGravity)
-      end
+      text_renderer.add_to_render_queue(@graph_left - LABEL_MARGIN, 1.0, 0.0, y_offset, Magick::EastGravity)
     end
   end