prawn-graph 0.0.4 → 0.9.0

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

@@ -0,0 +1,193 @@
+require "bigdecimal" 
+
+module Prawn
+  module Graph
+    module Charts
+      module Legacy
+
+        class Base
+              
+          attr_accessor :grid, :headings, :values, :highest_value, :document, :colour
+          
+          def initialize(data, document, options = {})
+            opts = { :theme => Prawn::Graph::Theme::Default, :width => 500, :height => 200, :spacing => 20, :at => [0,0] }.merge(options)
+            (@headings, @values, @highest_value) = process_the data
+            (grid_x_start, grid_y_start, grid_width, grid_height) = parse_sizing_from opts 
+            @colour = false
+            @document = document
+            @theme = Prawn::Graph::Theme::Default
+            @grid = Prawn::Graph::Charts::Legacy::Grid.new(grid_x_start, grid_y_start, grid_width, grid_height, opts[:spacing], document, Prawn::Graph::Theme::Default)
+          end
+
+          # Draws the graph on the document which we have a reference to.
+          #
+          def draw
+            draw_bounding_box
+            @grid.draw
+            label_axes
+            if @title
+              draw_title
+            end
+            plot_values
+            if @x_label
+              draw_x_axis_label
+            end 
+            if @y_label
+              draw_y_axis_label
+            end 
+           reset
+          end
+
+          private
+
+          def draw_bounding_box
+            @document.fill_color @theme.background
+            @document.fill_and_stroke_rectangle [(@point.first - 10), (@point.last + ( @total_height + 40 ))], @document.bounds.width, (@total_height + 40)
+            @document.fill_color '000000'
+          end   
+
+          def label_axes
+            @document.fill_color @theme.title
+            base_x = @grid.start_x + 1
+            base_y = @grid.start_y + 1
+
+            # Put the values up the Y Axis
+            #
+            @document.draw_text @highest_value, :at => [base_x - 15, base_y + @grid.height], :size => 5
+            @document.draw_text '0', :at => [base_x - 15, base_y ], :size => 5
+
+            # Put the column headings along the X Axis
+            #
+            point_spacing = calculate_plot_spacing 
+            last_position = base_x + (point_spacing / 2)
+            @headings.each do |heading|
+              @document.draw_text heading, :at => [last_position, base_y - 15 ], :size => 5
+              last_position += point_spacing
+            end
+            @document.fill_color @theme.background
+          end
+
+          def draw_title
+            @document.fill_color @theme.title
+            x_coord = calculate_x_axis_center_point(@title, 10)
+            y_coord = @grid.start_y + @grid.height + 10
+            @document.draw_text @title, :at => [x_coord, y_coord] ,:size => 10
+            @document.fill_color @theme.background
+          end
+
+          def draw_x_axis_label
+            @document.fill_color @theme.axes
+            x_coord = calculate_x_axis_center_point(@x_label, 8)
+            y_coord = @grid.start_y - 30
+            @document.draw_text @x_label, :at => [x_coord, y_coord] ,:size => 8
+            @document.fill_color @theme.background
+          end
+
+          def draw_y_axis_label
+            @document.fill_color @theme.axes
+            y_coord = calculate_y_axis_center_point(@y_label, 8)
+            x_coord = @grid.start_x - 30
+            @document.draw_text @y_label, :at => [x_coord, y_coord] ,:size => 8, :rotate => 90
+            @document.fill_color @theme.background
+          end
+          
+          # All subclasses of Prawn::Chart::Base must implement thier own plot_values
+          # method, which does the actual real heavy lifting of drawing the graph.
+          #
+          def plot_values
+            raise RuntimeError.new('subclasses of Prawn::Chart::Base must implement their own plot_values method')
+          end
+
+          def reset
+            @document.line_width 1
+            @document.stroke_color '000000'
+            @document.fill_color '000000'
+            @document.move_to @grid.point
+          end
+
+
+          # Utility methods for dealing with working out where things should be
+          # the calculations and such done here are all very rough, but are
+          # sufficient for now to plot just what we need.
+          #
+          
+          
+          def parse_sizing_from(o)
+            x_offset = 15
+            y_offset = 0
+            move_y_up = 0
+            grid_width = o[:width]
+            grid_height = o[:height]
+          
+            @total_width = o[:width]
+            @total_height = o[:height]
+            @point = o[:at].dup 
+
+            # Make room for the title if we're choosing to Render it.
+            #
+            if o[:title]
+              @title = o[:title]
+              y_offset += 10 
+            end
+
+            # Make room for X Axis labels if we're using them.
+            #
+            if o[:label_x]
+              y_offset += 30
+              move_y_up += 30
+              @x_label = o[:label_x]
+            end
+
+            # Make room for Y Axis labels if we're using them.
+            #
+            if o[:label_y]
+              @y_label = o[:label_y]
+              x_offset += 15
+            end
+
+
+            # Return the values calculated here.
+            #
+            [ (o[:at][0] + x_offset), (o[:at][1] + move_y_up + 20), (grid_width - (x_offset - 20)), (grid_height - y_offset) ]
+          end
+
+          def process_the(data_array)
+            col = []
+            val = []
+            data_array.each { |i| val << i[1]; col << i[0] }
+            [ col, val ,val.sort.last ]
+          end
+
+          def calculate_x_axis_center_point(text, text_size, graph_start_x = @grid.start_x, graph_width = @grid.width)
+            ((graph_start_x + (graph_width / 2)) - ((text.length * text_size) / 4))
+          end
+          alias calculate_x_axis_centre_point calculate_x_axis_center_point
+
+          def calculate_y_axis_center_point(text, text_size, graph_start_y = @grid.start_y, graph_height = @grid.height)
+            ((graph_start_y + (graph_height / 2)) - ((text.length * text_size) / 4))
+          end
+          alias calculate_y_axis_centre_point calculate_y_axis_center_point
+
+          def calculate_plot_spacing
+            (@grid.width / @values.count)
+          end
+
+          def calculate_bar_width
+            calculate_plot_spacing / 2
+          end
+
+          def calculate_point_height_from(column_value)
+            cv = BigDecimal("#{column_value}")
+            hv = BigDecimal("#{@highest_value}")
+            gh = BigDecimal("#{@grid.height}")
+            percentage = (cv / (hv / 100))
+            ((gh / 100) * percentage).to_i
+          end
+
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Prawn
+  module Graph
+    module Charts
+      module Legacy
+
+        class Grid
+
+          attr_accessor :width, :height, :point, :spacing, :document
+
+          def initialize(grid_x_start, grid_y_start, grid_width, grid_height, spacing, document, theme = Prawn::Graph::Theme::Default)
+            @point = [grid_x_start, grid_y_start]
+            @width = grid_width
+            @height = grid_height
+            @spacing = spacing
+            @document = document
+            @theme = Prawn::Graph::Theme::Default
+          end
+
+          def start_x; @point.first; end
+          def start_y; @point.last; end
+
+          # Draws the Grid on the specified Prawn::Document
+          #
+          def draw
+            @document.stroke_color @theme.markers
+            if @theme.stroke_grid_lines
+              (@height / @spacing).times do |x|
+                offset = @spacing * (x + 1)
+                @document.move_to [@point.first, (@point.last + offset)]
+                @document.line_width(0.5)
+                @document.stroke_line_to([(@point.first + @width), (@point.last + offset)])
+              end
+            end
+            @document.move_to @point
+            @document.line_width(2)
+            @document.stroke_line_to([@point.first, @point.last + @height])
+            @document.move_to @point
+            @document.line_width(2)
+            @document.stroke_line_to([(@point.first + @width), @point.last])
+            @document.move_to @point.first, (@point.last + height)
+            @document.stroke_color '000000'
+            @document.line_width(1)
+            @document.move_to @point
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Prawn
+  module Graph
+    module Charts
+      module Legacy
+        class Line < Prawn::Graph::Charts::Legacy::Base
+
+          private
+          
+          def plot_values
+            base_x = @grid.start_x + 1
+            base_y = @grid.start_y + 1
+            p = [ [base_x, base_y] ]
+            bar_width = calculate_bar_width
+            @document.line_width bar_width
+            last_position = base_x + bar_width
+            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
+              point = [base_x + last_position, base_y + bar_height]
+              p << point
+              @document.fill_color @theme.series.last
+              @document.fill_circle_at point, :radius => 1
+              last_position += point_spacing
+            end
+            @document.line_width 2
+            @document.stroke_color @theme.series.last
+            p.each_with_index do |point,i|
+              next if point == p.last
+              @document.move_to point
+              @document.stroke_line_to p[i+1]
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

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

data/lib/prawn/graph/extension.rb

@@ -0,0 +1,59 @@
+module Prawn
+  module Graph
+    module Extension
+
+      # @deprecated bar_graph and bar_chart are deprecated and will be removed in a future version. Use the new graph / chart methods instead.
+      # Draws a bar graph into the PDF using the legacy graph stuff. Please avoid.
+      #
+      # Example:
+      #
+      #  bar_graph [ ["A", 1], ["B", 2], ["C", 3] ], at: [10,10]
+      #
+      def bar_graph(data, options = {}, &block)
+        deprecate :bar_graph
+        draw_graph(Prawn::Graph::Charts::Bar, data, options, &block)
+      end
+      alias bar_chart bar_graph
+
+      # @deprecated line_graph and line_chart are deprecated and will be removed in a future version. Use the new graph / chart methods instead.
+      # Draws a line graph into the PDF using the legacy graph stuff. Please avoid.
+      #
+      # Example:
+      #
+      #  line_graph [ ["A", 1], ["B", 2], ["C", 3] ], at: [10,10]
+      #
+      def line_graph(data, options = {}, &block)
+        deprecate :line_graph
+        draw_graph(Prawn::Graph::Charts::Line, data, options, &block)
+      end
+      alias line_chart line_graph
+
+      
+      # Plots one or more Prawn::Graph::Series on a chart. Expects an array-like object of
+      # Prawn::Graph::Series objects and some options for positioning the sizing the
+      # rendered graph
+      #
+      # @param series [Array] of Prawn::Graph::Series objects
+      # @param options [Hash] of options, which can be: `:width`, `:height` , `:at` , or `:title`
+      #
+      def graph(series, options = {}, &block)
+        canvas = Prawn::Graph::ChartComponents::Canvas.new(series, self, options, &block)
+        canvas.draw
+        {warnings: [], width: self.bounds.width, height: self.bounds.height}
+      end
+      alias chart graph
+
+      private
+
+      def draw_graph(klass, data, options, &block)
+        graph = klass.new(data, self, options, &block)
+        graph.draw
+        {warnings: [], width: self.bounds.width, height: self.bounds.height}
+      end
+      
+      def deprecate(method)
+        warn "[DEPRECATION] #{method} is deprecated and will be removed in future versions of prawn-graph. Use chart or graph instead."
+      end
+    end
+  end
+end

data/lib/prawn/graph/series.rb

@@ -0,0 +1,79 @@
+module Prawn
+  module Graph
+    
+    # A Prawn::Graph::Series represents a series of data which are to be plotted
+    # on a chart.
+    #
+    class Series
+      attr_accessor :values, :options
+
+      DEFAULT_OPTIONS = {
+        title:            nil,
+        type:             :bar,
+        mark_average:     false,
+        mark_minimum:     false,
+        mark_maximum:     false,
+      }
+
+      def initialize(values = [], options = {})
+        @values   = values
+        @options  = OpenStruct.new(DEFAULT_OPTIONS.merge(options))
+      end
+
+      # @return [String] The value of +options.title+.
+      #
+      def title
+        options.title
+      end
+
+      # @return [Symbol] The value of +options.type+.
+      #
+      def type
+        options.type
+      end
+
+      # @param value [Object] a value to be added to the series. Must be of the same kind as other +values+.
+      # @return [Array] The modified +values+ object.
+      #
+      def <<(value)
+        @values << value
+      end
+
+      # @return [Numeric] The smallest value stored in the +values+ of this Series.
+      #
+      def min
+        @values.min || 0
+      end
+
+      # @return [Numeric] The largest value stored in the +values+ of this Series.
+      #
+      def max
+        @values.max || 0
+      end
+
+      # @return [Numeric] The average value stored in the +values+ of this Series.
+      #
+      def avg
+        if size > 0
+          @values.inject(:+) / size
+        else
+          0
+        end
+      end
+
+      # @return [Numeric] The size of the +values+ stored in this Series.
+      #
+      def size
+        @values.size
+      end
+
+      # @deprecated Provided to allow for tempory backwards compatibilty with legacy graph drawing. Do not use.
+      # @return [Array] Series represented as an array in the format [ title, val1, val2... ]
+      #
+      def to_a
+        warn "[DEPRECATION] Series#to_a is deprecated and will be removed in a future version of prawn-graph."
+        [options.title, @values].compact.flatten
+      end
+    end
+  end
+end

data/lib/prawn/graph/theme.rb

@@ -0,0 +1,41 @@
+module Prawn
+  module Graph
+    module Theme
+      Default = OpenStruct.new({
+        series:               [
+                                'EBEDEF',
+                                'D6DBDF',
+                                '85929E',
+                                '34495E',
+                                '1B2631',
+                                'EBEDEF',
+                                'D6DBDF',
+                                '85929E',
+                                '34495E',
+                                '1B2631',
+                                'EBEDEF',
+                                'D6DBDF',
+                                '85929E',
+                                '34495E',
+                                '1B2631',
+                              ],
+        title:                '17202A',
+        background:           'FFFFFF',
+        grid:                 'F2F4F4',
+        axes:                 '17202A',
+        markers:              '34495E',
+        stroke_grid_lines:    true,
+        default:              '333333',
+        average:              '34495E',
+        max:                  '17202A',
+        min:                  '17202A',
+        font_sizes:           OpenStruct.new({
+          default:      8,
+          main_title:   10,
+          axis_labels:  5,
+          series_key:   8,
+        }),
+      })
+    end
+  end
+end