prawn-graph 0.0.4 → 0.9.0

data/lib/prawn/graph/chart_components.rb

@@ -0,0 +1,2 @@
+require_relative "chart_components/series_renderer"
+require_relative "chart_components/canvas"

data/lib/prawn/graph/chart_components/canvas.rb

@@ -0,0 +1,138 @@
+module Prawn
+  module Graph
+    module ChartComponents
+      # A Prawn::Graph::Canvas represents the area on which a graph will be drawn. Think of it
+      # as the container in which your chart / graph will be sized to fit within. 
+      #
+      class Canvas
+        attr_reader :layout, :series, :prawn, :theme
+
+        # @param series [Array[Prawn::Graph::Series]]
+        # @param prawn [Prawn::Document]
+        # @param options [Hash]
+        # @return [Prawn::Graph::Canvas] a canvas ready to be drawn on the provided +prawn+ document.
+        #
+        def initialize(series, prawn, options = {}, &block)
+          @series   = series
+          verify_series_are_ok!
+          @options  = options.merge({ series_count: series.size })
+          @prawn    = prawn
+          @theme    = Prawn::Graph::Theme::Default
+          @layout   = Prawn::Graph::Calculations::LayoutCalculator.new([prawn.bounds.width, prawn.bounds.height], @options, @theme).calculate
+
+          yield self if block_given?
+        end
+
+        # Fires off the actual drawing of the chart on the provided canvas.
+        # @return [nil]
+        #
+        def draw
+          prawn.bounding_box(position, :width => layout.canvas_width, :height => layout.canvas_height, padding: 0) do
+            prawn.save_graphics_state do         
+              apply_theme! 
+              render_title_area!
+              render_series_keys!
+              render_graph_area!
+            end
+          end
+        end
+
+        # The coordinates which the canvas will be drawn at
+        # @return [Array] [X-Coord, Y-Coord]
+        #
+        def position
+          @options[:at] || [0,0]
+        end
+
+        private
+
+        def apply_theme!
+          prawn.fill_color    @theme.default
+          prawn.stroke_color  @theme.default
+          prawn.font_size     @theme.font_sizes.default
+        end
+
+        def plot_series!
+          bar_charts    = series.collect{ |s| s if s.type == :bar }.compact
+          others        = series - bar_charts
+
+          BarChartRenderer.render(bar_charts, self, theme.series[0..(bar_charts.size - 1)]) unless bar_charts.empty?
+
+          i = bar_charts.size
+          others.each do |series|
+            SeriesRenderer.render(series, self, theme.series[i])
+            i+=1
+          end
+        end
+
+        def render_graph_area!
+          if layout.graph_area.renderable?
+            prawn.bounding_box layout.graph_area.point, width: layout.graph_area.width, height: layout.graph_area.height do
+              plot_series!
+            end
+          end
+        end
+
+        def render_title_area!
+          if layout.title_area.renderable?
+            prawn.text_box "<color rgb=\"#{@theme.title}\">#{@options[:title]}</color>", at: layout.title_area.point, inline_format: true, 
+            valign: :center, align: :center, size: @theme.font_sizes.main_title, width: layout.title_area.width, height: layout.title_area.height
+          end
+        end
+
+        def render_series_keys!
+          if layout.series_key_area.renderable?
+            prawn.bounding_box layout.series_key_area.point, width: layout.series_key_area.width, height: layout.series_key_area.height do
+              series.each_with_index do |series, i|
+                series_offset = i + 1
+
+                prawn.save_graphics_state do
+                  prawn.stroke_color = theme.axes
+                  prawn.line_width = 0.5
+                  prawn.fill_color = theme.series[i]
+
+                  series_offset = series_offset * theme.font_sizes.series_key
+
+                  title = series.title || "Series #{series_offset}"
+                  top_position = (prawn.bounds.top - (series_offset * 3))
+
+
+                  prawn.fill_and_stroke_rectangle([ theme.font_sizes.series_key, top_position ], theme.font_sizes.series_key, theme.font_sizes.series_key)
+                  
+                  prawn.fill_color = theme.axes
+                  prawn.text_box title, at: [ (theme.font_sizes.series_key * 3), top_position ], size: theme.font_sizes.series_key, height: (series_offset * 2)
+                end
+              end
+            end
+          end
+        end
+
+        # Verifies that we provide an array-like object of Prawn::Graph::Series instances to
+        # the Canvas, for later rendering.
+        #
+        def verify_series_are_ok!
+          if @series.respond_to?(:each) && @series.respond_to?(:collect)
+            classes = @series.collect{ |c| c.is_a?(Prawn::Graph::Series) }.uniq
+            if classes.size > 1 || classes[0] != true
+              raise RuntimeError.new("All of the items provided must be instances of Prawn::Graph::Series")
+            end
+          else
+            raise RuntimeError.new("Series provided must be an Array (or Array-like) object.")
+          end
+        end
+        
+        # From prawn-svg - creates a cipped retangle, which we will then use to draw the graphs
+        # upon.
+        #
+        def clip_graph_to_bounds(x, y, width, height)
+          prawn.move_to x, y
+          prawn.line_to x + width, y
+          prawn.line_to x + width, y + height
+          prawn.line_to x, y + height
+          prawn.close_path
+          prawn.add_content "W n"
+        end
+      end
+    end
+  end
+end

data/lib/prawn/graph/chart_components/series_renderer.rb

@@ -0,0 +1,173 @@
+module Prawn
+  module Graph
+    module ChartComponents
+
+      # The Prawn::Graph::ChartComponents::SeriesRenderer is used to plot indivdual Prawn::Graph::Series on
+      # a Prawn::Graph::ChartComponents::Canvas and its associated Prawn::Document.
+      #
+      module SeriesRenderer
+        class << self 
+          # @param series [Prawn::Graph::Series]
+          # @param canvas [Prawn::Graph::ChartComponents::Canvas]
+          #
+          def render(series, canvas, color = '000000')
+            raise ArgumentError.new("series must be a Prawn::Graph::Series") unless series.is_a?(Prawn::Graph::Series)
+            raise ArgumentError.new("canvas must be a Prawn::Graph::ChartComponents::Canvas") unless canvas.is_a?(Prawn::Graph::ChartComponents::Canvas)
+
+            @series = series
+            @canvas = canvas
+            @prawn = canvas.prawn
+            @color = color
+
+            @graph_area = @canvas.layout.graph_area
+
+            @plot_area_width  = @graph_area.width - 25
+            @plot_area_height = @graph_area.height - 20
+
+            render_line_chart
+          end
+
+          private
+
+          def render_line_chart
+            prawn.bounding_box [@graph_area.point[0] + 5, @graph_area.point[1] - 20], width: @plot_area_width, height: @plot_area_height do
+              j = 2
+              prawn.save_graphics_state do  
+                @series.values.each_with_index do |v, i|
+                  next if i == 0
+
+                  width_per_point = (@plot_area_width / @series.size).round(2).to_f
+                  spacing = width_per_point
+
+                  prawn.line_width = 2
+                  prawn.fill_color    = @color
+                  prawn.stroke_color  = @color
+
+
+                  previous_value = @series.values[i - 1]
+                  this_value = v
+
+                  previous_y  = (point_height_percentage(previous_value) * @plot_area_height) - 5
+                  this_y      = (point_height_percentage(this_value) * @plot_area_height) - 5
+
+                  previous_x_offset = ((spacing * (j - 1)) - spacing) + (spacing / 2.0)
+                  this_x_offset    = ((spacing * j) - spacing) + (spacing / 2.0)
+
+
+                  prawn.stroke_line([previous_x_offset, previous_y], [ this_x_offset, this_y ])
+                  
+                  prawn.fill_color = @canvas.theme.markers
+                  prawn.fill_ellipse([ ( previous_x_offset), previous_y ], 1)
+                  prawn.fill_ellipse([ ( this_x_offset), this_y ], 1)
+                  j += 1
+                end
+                
+              end
+              render_axes
+            end
+          end
+
+          def render_axes
+            prawn.stroke_color  = @canvas.theme.axes
+            prawn.fill_color  = @canvas.theme.axes
+            prawn.stroke_horizontal_line(0, @plot_area_width, at: 0) 
+            prawn.stroke_vertical_line(0, @plot_area_height, at: 0) 
+            prawn.fill_and_stroke_ellipse [ 0,0], 1
+          end
+
+          # Calculates the relative height of a given point based on the maximum value present in
+          # the series.
+          #
+          def point_height_percentage(value)
+            ((BigDecimal(value, 10)/BigDecimal(@series.max, 10)) * BigDecimal(1)).round(2)
+          end
+
+          def prawn
+            @prawn
+          end
+        end
+      end
+
+
+
+      # The Prawn::Graph::ChartComponents::BarChartRenderer is used to plot one or more bar charts 
+      # in a sensible way on a a Prawn::Graph::ChartComponents::Canvas and its associated 
+      # Prawn::Document.
+      #
+      module BarChartRenderer
+        class << self 
+          # @param series [Prawn::Graph::Series]
+          # @param canvas [Prawn::Graph::ChartComponents::Canvas]
+          #
+          def render(series, canvas, colors)
+            @series = series
+            @canvas = canvas
+            @prawn = canvas.prawn
+            @colors = colors
+
+
+            @graph_area = @canvas.layout.graph_area
+
+            @plot_area_width  = @graph_area.width - 25
+            @plot_area_height = @graph_area.height - 20
+
+            render_bar_charts
+          end
+
+          private
+
+          def render_bar_charts
+            prawn.bounding_box [@graph_area.point[0] + 5, @graph_area.point[1] - 20], width: @plot_area_width, height: @plot_area_height do
+           
+              prawn.save_graphics_state do  
+                num_points        = @series[0].size
+                width_per_point   = (@plot_area_width / num_points).round(2).to_f
+                width             = ((width_per_point * BigDecimal('0.9')) / @series.size).round(2).to_f
+                spacing           = (width_per_point - (width * @series.size).to_f / 2.0)
+
+                num_points.times do |point|
+
+                  @series.size.times do |series_index|
+                    series_offset = series_index + 1
+                    prawn.fill_color    = @colors[series_index]
+                    prawn.stroke_color  = @colors[series_index]
+                    prawn.line_width  = width
+
+                    starting = (prawn.bounds.left + (point * width_per_point))
+
+                    x_position = ( (starting + (series_offset * width) ).to_f - (width / 2.0))
+                    y_position = ((point_height_percentage(@series[series_index].values[point]) * @plot_area_height) - 5).to_f
+
+                    prawn.fill_and_stroke_line([ x_position ,0], [x_position ,y_position])
+                  end
+
+                end
+
+              end
+              render_axes
+            end
+          end
+
+          def render_axes
+            prawn.stroke_color  = @canvas.theme.axes
+            prawn.fill_color  = @canvas.theme.axes
+            prawn.stroke_horizontal_line(0, @plot_area_width, at: 0) 
+            prawn.stroke_vertical_line(0, @plot_area_height, at: 0) 
+            prawn.fill_and_stroke_ellipse [ 0,0], 1
+          end
+
+          # Calculates the relative height of a given point based on the maximum value present in
+          # the series.
+          #
+          def point_height_percentage(value)
+            ((BigDecimal(value, 10)/BigDecimal(@series[0].max, 10)) * BigDecimal(1)).round(2)
+          end
+
+          def prawn
+            @prawn
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prawn/graph/charts.rb

@@ -0,0 +1,4 @@
+require_relative "charts/base"
+require_relative "charts/bar"
+require_relative "charts/line"
+require_relative "charts/legacy"

data/lib/prawn/graph/charts/bar.rb

@@ -0,0 +1,18 @@
+module Prawn
+  module Graph
+    module Charts
+      class Bar < Base
+
+        private
+
+        def chart_object
+          Prawn::Graph::Charts::Legacy::Bar.new(@series.collect(&:to_a), @prawn, @options)
+        end
+
+        def series_type
+          :bar
+        end
+      end
+    end
+  end
+end

data/lib/prawn/graph/charts/base.rb

@@ -0,0 +1,69 @@
+module Prawn
+  module Graph
+    module Charts
+
+      class Base
+        VALID_OPTIONS = [:at, :width, :height]
+        attr_reader :series, :prawn, :options, :lowest_value, :highest_value
+
+        def initialize(data, prawn, options = {}, &block)
+          Prawn.verify_options VALID_OPTIONS, options
+
+          if data.is_a?(Array) || (!data.is_a?(Array) && data.is_a?(Prawn::Graph::Series))
+            data = [ data ] unless data.is_a?(Array) 
+          else
+            raise ArgumentError.new("data must be a multidimensional Array, array of Prawn::Graph::Series or a single Prawn::Graph::Series")
+          end
+
+          @series = []
+          data.each do |s|
+            if s.is_a?(Prawn::Graph::Series)
+              @series << s
+            else
+              title = s.shift
+              @series << Prawn::Graph::Series.new(s, title: title, type: series_type)
+            end
+          end
+          
+          @prawn = prawn
+          @options = options
+          calculate_extreme_values!
+        end
+
+        def titles
+          @series.collect(&:title)
+        end
+
+        def position
+        end
+
+        def draw
+          chart_object.draw
+        end
+
+        private
+
+        def chart_object
+          raise RuntimeError.new("I need to be subclassed.")
+        end
+
+        def series_type
+          :bar
+        end
+
+        def calculate_extreme_values!
+          @lowest_value = @series.collect(&:min).min
+          @highest_value = @series.collect(&:max).max
+        end
+
+        def process_the(data_array)
+          col = []
+          val = []
+          data_array.each { |i| val << i[1]; col << i[0] }
+          [ col, val, val.min, val.max ]
+        end
+
+      end
+    end
+  end
+end

data/lib/prawn/graph/charts/legacy.rb

@@ -0,0 +1,4 @@
+require_relative 'legacy/grid'
+require_relative 'legacy/base'
+require_relative 'legacy/bar'
+require_relative 'legacy/line'

data/lib/prawn/graph/charts/legacy/bar.rb

@@ -0,0 +1,28 @@
+module Prawn
+  module Graph
+    module Charts
+      module Legacy
+        class Bar < Prawn::Graph::Charts::Legacy::Base
+
+          private
+
+          def plot_values
+            base_x = @grid.start_x + 1
+            base_y = @grid.start_y + 1
+            bar_width = calculate_bar_width
+            @document.line_width bar_width
+            last_position = base_x 
+            point_spacing = calculate_plot_spacing
+            @values.each do |value|
+              @document.move_to [base_x + last_position, base_y]
+              bar_height = calculate_point_height_from value
+              @document.stroke_color @theme.series.sample
+              @document.stroke_line_to [base_x + last_position, base_y + bar_height]
+              last_position += point_spacing
+            end
+          end
+        end
+      end
+    end
+  end
+end