prawn-graph 0.0.1

data/README.markdown

@@ -0,0 +1,3 @@
+# prawn-graph - Easy Graphing for Prawn
+
+More content to come soon, I promise!

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rake'
+require "rake/gempackagetask" 
+
+PRAWN_GRAPH_VERSION = '0.0.1'
+
+spec = Gem::Specification.new do |spec|
+  spec.name = "prawn-graph"
+  spec.version = PRAWN_GRAPH_VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "An extension to Prawn that provides the ability to draw basic graphs and charts natively in your PDFs."
+  spec.files = Dir.glob("{examples,lib,spec,vendor,data}/**/**/*") +
+                      ["Rakefile"]
+  spec.require_path = "lib"
+  
+  spec.test_files = Dir[ "test/*_test.rb" ]
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = %w{README.markdown}
+  spec.rdoc_options << '--title' << 'Prawn Documentation' <<
+                       '--main' << 'README' << '-q'
+  spec.author = "Ryan Stenhouse"
+  spec.email = " ryan@ryanstenhouse.eu"
+  spec.rubyforge_project = "prawn"
+  spec.homepage = "http://ryanstenhouse.eu"
+  spec.description = <<END_DESC
+  An extension to Prawn that provides the ability to draw basic graphs and charts natively in your PDFs.
+END_DESC
+end
+ 
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+ 

data/examples/example_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),
+                             %w[.. vendor prawn-core lib]))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "rubygems"
+require "prawn/core"
+require "prawn/graph"
+ 
+Prawn.debug = true
+ 

data/examples/graph/advanced_bar_chart.rb

@@ -0,0 +1,22 @@
+
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+options = {
+            :title => 'Average litter size per kind of animal',
+            :label_x => 'Kind of animal',
+            :label_y => 'Average litter size',
+            :at => [10,10],
+          }
+
+data =    [
+            ['Raccoons', 4],
+            ['Mice', 11],
+            ['Dogs', 6],
+            ['Panda', 1],
+            ['Gorilla', 1],
+            ['Cats', 4]
+          ]
+
+Prawn::Document.generate('advanced_bar_chart.pdf') do
+  bar_chart data, options
+end

data/examples/graph/bar_chart.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+# Simplest bar chart example
+# 
+
+data =  [
+          ['Cats',20],
+          ['Dogs',36],
+          ['Hamsters',45],
+          ['Goldfish', 5]
+        ]
+
+Prawn::Document.generate('bar_chart.pdf') do
+  bar_chart data, :at => [10, 10]
+end
+

data/examples/graph/line_chart.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+# Simplest line chart example
+# 
+
+data =  [
+          ['January',20],
+          ['February',36],
+          ['March',45],
+          ['April', 5]
+        ]
+
+Prawn::Document.generate('line_chart.pdf') do
+  line_chart data, :at => [10, 10]
+end
+

data/lib/prawn/graph.rb

@@ -0,0 +1,94 @@
+require 'bigdecimal'
+
+require File.dirname(__FILE__) + '/graph/errors'
+require File.dirname(__FILE__) + '/graph/chart'
+require File.dirname(__FILE__) + '/graph/grid'
+require File.dirname(__FILE__) + '/graph/bar'
+require File.dirname(__FILE__) + '/graph/line'
+
+module Prawn
+
+  class Document
+
+    # Adds compatibility with the current stable version of prawn 
+    #
+    alias text draw_text
+
+    # Draws a fairly simple bar chart. Data should be passed in as an array of
+    # arrays, much like how Tables are dealt with:
+    #
+    #   [
+    #     [ 'Field Title', 10 ],
+    #     [ 'Another Title', 20]
+    #   ]
+    #
+    #  options[:at] MUST be specified, as the coordinates where you want your
+    #  bar chart to be drawn.
+    #
+    #  options[:width] Sets the width of the chart, defaults to 500
+    #  options[:height] Sets the height of the chart, defaults to 200
+    #  options[:spacing] Sets the spacing between the grid squares of the chart, defaults to 20
+    #
+    # It will do its best to try and size content to fit the available size; but at
+    # the moment it's not too clever. If your graph looks squashed; make it bigger.
+    #
+    # Other available options are:
+    #
+    #  :label_x Which sets a label to be shown along the X Axis.
+    #  :label_y Which sets a label to be shown along the Y Axis.
+    #  :title Which sets a Title for the chart
+    #
+    # For now, these values DO NOT scale in size. X/Y labels are always 8 points and Titles
+    # are always 10 points.
+    #
+    def bar_chart(data, options = {})
+      if data.nil? || data.empty?
+        raise Prawn::Errors::NoGraphData,
+          "data must be a non-empty, non-nil, two dimensional array " +
+          "in the form [ [ 'Title', SomeValue ]  ]"
+      end
+      Prawn::Chart::Bar.new(data, self, options).draw
+    end
+    alias :bar_graph :bar_chart
+
+    # Draws a fairly simple line chart. Data should be passed in as an array of
+    # arrays, much like how Tables are dealt with:
+    #
+    #   [
+    #     [ 'Field Title', 10 ],
+    #     [ 'Another Title', 20]
+    #   ]
+    #
+    #  options[:at] MUST be specified, as the coordinates where you want your
+    #  bar chart to be drawn.
+    #
+    #  options[:width] Sets the width of the chart, defaults to 500
+    #  options[:height] Sets the height of the chart, defaults to 200
+    #  options[:spacing] Sets the spacing between the grid squares of the chart, defaults to 20
+    #
+    # It will do its best to try and size content to fit the available size; but at
+    # the moment it's not too clever. If your graph looks squashed; make it bigger.
+    #
+    # Other available options are:
+    #
+    #  :label_x Which sets a label to be shown along the X Axis.
+    #  :label_y Which sets a label to be shown along the Y Axis.
+    #  :title Which sets a Title for the chart
+    #
+    # For now, these values DO NOT scale in size. X/Y labels are always 8 points and Titles
+    # are always 10 points.
+    #
+    def line_chart(data, options = {})
+      if data.nil? || data.empty?
+        raise Prawn::Errors::NoGraphData,
+          "data must be a non-empty, non-nil, two dimensional array " +
+          "in the form [ [ 'Title', SomeValue ]  ]"
+      end
+      Prawn::Chart::Line.new(data, self, options).draw
+    end
+    alias :line_graph :line_chart
+
+
+  end
+
+end

data/lib/prawn/graph/bar.rb

@@ -0,0 +1,172 @@
+module Prawn
+  module Chart
+    class Bar
+      
+      attr_accessor :grid, :headings, :values, :highest_value, :document, :colour
+
+      def initialize(data, document, options = {})
+        if options[:at].nil? || options[:at].empty?
+          raise Prawn::Errors::NoGraphStartSet,
+            "you must specify options[:at] as the coordinates wher you" +
+            " wish this graph to be drawn from."
+        end
+        opts = { :width => 500, :height => 200, :spacing => 20 }.merge(options)
+        (@headings, @values, @highest_value) = process_the data
+        (grid_x_start, grid_y_start, grid_width, grid_height) = parse_sizing_from opts 
+        @colour = (!opts[:use_color].nil? || !opts[:use_colour].nil?)
+        @document = document
+        @grid = Prawn::Chart::Grid.new(grid_x_start, grid_y_start, grid_width, grid_height, opts[:spacing], document)
+      end
+  
+      def draw
+        @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 reset
+        @document.line_width 1
+        @document.stroke_color '000000'
+        @document.fill_color '000000'
+        @document.move_to @grid.point
+      end
+
+      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
+          if @colour
+            @document.stroke_color [rand(255), rand(255), rand(255), 0]
+          else
+            @document.stroke_color 'AAAAAA'
+          end
+          @document.stroke_line_to [base_x + last_position, base_y + bar_height]
+          last_position += point_spacing
+        end
+      end
+
+      def label_axes
+        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
+      end
+
+      def draw_x_axis_label
+        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
+      end
+
+      def draw_y_axis_label
+        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
+      end
+
+      def draw_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
+      end
+
+      def parse_sizing_from(o)
+        x_offset = 15
+        y_offset = 0
+        move_y_up = 0
+        grid_width = o[:width]
+        grid_height = o[:height]
+
+        # 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), (grid_width - x_offset), (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.nitems)
+      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

data/lib/prawn/graph/chart.rb

@@ -0,0 +1,4 @@
+module Prawn
+  module Chart
+  end
+end

data/lib/prawn/graph/errors.rb

@@ -0,0 +1,6 @@
+module Prawn
+  module Errors
+    NoGraphData =  Class.new(StandardError) 
+    NoGraphStartSet =  Class.new(StandardError) 
+  end
+end

data/lib/prawn/graph/grid.rb

@@ -0,0 +1,43 @@
+module Prawn
+  module Chart
+    class Grid
+
+      attr_accessor :width, :height, :point, :spacing, :document
+
+      def initialize(grid_x_start, grid_y_start, grid_width, grid_height, spacing, document)
+        @point = [grid_x_start, grid_y_start]
+        @width = grid_width
+        @height = grid_height
+        @spacing = spacing
+        @document = document
+      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 'CCCCCC'
+        (@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
+        @document.move_to @point
+        @document.line_width(2)
+        @document.stroke_color '000000'
+        @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

data/lib/prawn/graph/line.rb

@@ -0,0 +1,43 @@
+module Prawn
+  module Chart
+    class Line < Bar
+
+      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
+          if @colour
+            @document.fill_color '00DD00'
+          else
+            @document.fill_color 'AAAAAA'
+          end
+          @document.fill_circle_at point, :radius => 1
+          last_position += point_spacing
+        end
+        @document.line_width 2
+        if @colour
+          @document.stroke_color '00DD00'
+        else
+          @document.stroke_color 'AAAAAA'
+        end
+        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