prawn-charts 0.0.1.alpha

data/lib/prawn/charts/line.rb

@@ -0,0 +1,61 @@
+module Prawn
+  module Charts
+
+    class Line < Bar
+
+      def plot_values
+        return if series.nil?
+        series.each_with_index do |bar,index|
+          point_x = first_x
+
+          points = bar[:values].map do |h|
+            height = value_height(h[:value])
+            point = [point_x,height]
+
+            fill_color bar[:color]
+            fill_ellipse point, 2
+            point_x += addition_x
+
+            point
+          end
+
+          stroke_color bar[:color]
+          stroke do
+            last_point = points.first
+            points.each do |point|
+              line last_point, point
+              last_point = point
+            end
+          end
+
+        end
+      end
+
+      def x_points
+        points = []
+        stacked_bar_values.each_with_index do |stack,index|
+          points << first_x_point(index) + (bar_width / 2)
+        end
+        points
+      end
+
+      def percentage
+        false
+      end
+
+
+      def first_x
+        (bar_width / 2) + bar_space
+      end
+
+      def addition_x
+        bar_width + bar_space
+      end
+
+
+      def series_length
+        series.map { |v| v[:values].length }.max
+      end
+    end
+  end
+end

data/lib/prawn/charts/stacked_bar.rb

@@ -0,0 +1,49 @@
+module Prawn
+  module Charts
+    class StackedBar < Bar
+
+      def plot_values
+        stacked_bar_values.each_with_index do |stack,index|
+          point_x = first_x_point(index)
+
+          point_y = bounds.bottom
+          stack[:values].each do |h|
+            fill_color h[:color]
+            fill do
+              percentage = h[:value].to_f / stack[:total].to_f
+              height = bounds.height * percentage
+              point_y += height
+              rectangle [point_x,point_y], bar_width, height
+            end
+          end
+        end
+      end
+
+      def percentage
+        true
+      end
+
+      def x_points
+        points = []
+        stacked_bar_values.each_with_index do |stack,index|
+          points << first_x_point(index) + (bar_width / 2)
+        end
+        points
+      end
+
+      def series_length
+        series.map { |v| v[:values].length }.max
+      end
+
+      def max_value
+        100
+      end
+
+      def min_value
+        0
+      end
+
+
+    end
+  end
+end

data/lib/prawn/charts/version.rb

@@ -0,0 +1,5 @@
+module Prawn
+  module Charts
+    VERSION = "0.0.1.alpha"
+  end
+end

data/lib/prawn/charts/x_axis.rb

@@ -0,0 +1,63 @@
+module Prawn
+  module Charts
+    class XAxis
+      attr_reader :pdf
+      attr_accessor :series, :at, :width, :height, :formatter
+
+      extend Forwardable
+
+      def_delegators :@pdf, :bounding_box, :stroke_bounds, :text
+      def_delegators :@pdf, :height_of, :width_of, :fill_color
+      def_delegators :@pdf, :draw_text, :bounds, :rotate
+
+      def initialize pdf, opts
+        @pdf       = pdf
+        @series    = opts[:series]
+        @at        = opts[:at]
+        @width     = opts[:width]
+        @height    = opts[:height]
+        @points    = opts[:points]
+        @formatter = opts[:formatter]
+      end
+
+      def draw
+        fill_color '0000'
+        bounding_box at, width: width, height: height do
+          index = 0
+          slice = if label_count_width < labels.count
+                    (labels.count.to_f / label_count_width.to_f).ceil
+                  else
+                    1
+                  end
+
+          labels.each_slice(slice) do |items|
+            offset = width_of(items.first) / 2
+            origin = [(@points[index] - offset).to_i,0]
+            point = [origin.first,-20]
+            rotate 20, origin: origin do
+              draw_text items.first, at: point
+            end
+            index += slice
+          end
+        end
+      end
+
+      def labels
+        @labels ||= series.map do |s|
+          s[:values].map do |v|
+            formatter.call(v[:key])
+          end.uniq
+        end.flatten.uniq
+      end
+
+      def max_label_width
+        @max_label_width ||= labels.map { |label| width_of(label) }.max
+      end
+
+
+      def label_count_width
+        (bounds.width / max_label_width).to_i
+      end
+    end
+  end
+end

data/lib/prawn/charts/y_axis.rb

@@ -0,0 +1,76 @@
+module Prawn
+  module Charts
+    class YAxis
+      attr_reader :pdf
+      attr_accessor :points, :at, :width, :height, :formatter
+
+      extend Forwardable
+
+      def_delegators :@pdf, :bounding_box, :stroke_bounds, :text
+      def_delegators :@pdf, :height_of, :width_of, :fill_color
+      def_delegators :@pdf, :draw_text, :bounds
+
+      def initialize pdf, opts
+        @pdf       = pdf
+        @at        = opts[:at]
+        @width     = opts[:width]
+        @height    = opts[:height]
+        @points    = opts[:points]
+        @formatter = opts[:formatter]
+        @percentage = opts[:percentage]
+      end
+
+      def draw
+        fill_color '0000'
+        bounding_box at, width: width, height: height do
+          last_point = nil
+          list.each do |item|
+            percent = ((item - points.min).to_f / axis_height.to_f)
+            y_point = (percent * bounds.height) - (text_height / 3).to_i
+            if y_point > (last_point || y_point - 1)
+              draw_text formatter.call(item), at: [0, y_point]
+              last_point = y_point + text_height
+            end
+          end
+        end
+      end
+
+
+      def text_height
+        @text_height ||= height_of(formatter.call( points.first))
+      end
+
+      def axis_height
+        points.max - points.min
+      end
+
+      def single_height
+        (bounds.height / text_height).to_i
+      end
+
+      def list
+        return percentage_list if percentage?
+        return @range if @range
+        @range =[]
+        exp = Math.log10(points.min).floor - 1
+        (points.min.to_i..points.max.to_i).each_slice( 10 ** exp) do |n|
+          @range.push n.first
+        end
+        @range
+      end
+
+      def percentage?
+        @percentage
+      end
+
+      def percentage_list
+        percentage_list = []
+        (0 .. 100).each_slice(10) do |n|
+          percentage_list.push n.first
+        end
+        percentage_list
+      end
+
+    end
+  end
+end

data/lib/prawn/charts.rb

@@ -0,0 +1,133 @@
+require "prawn/charts/version"
+require "ostruct"
+require 'i18n'
+require File.dirname(__FILE__) + '/charts/error'
+require File.dirname(__FILE__) + '/charts/error/no_series'
+require File.dirname(__FILE__) + '/charts/base'
+require File.dirname(__FILE__) + '/charts/bar'
+require File.dirname(__FILE__) + '/charts/stacked_bar'
+require File.dirname(__FILE__) + '/charts/line'
+require File.dirname(__FILE__) + '/charts/combo'
+require File.dirname(__FILE__) + '/charts/x_axis'
+require File.dirname(__FILE__) + '/charts/y_axis'
+
+I18n.load_path << File.dirname(__FILE__) + '/../config/locales/en.yml'
+I18n.enforce_available_locales = false
+module Prawn
+  class Document
+
+    # Draws a bar chart.
+    #
+    #
+    # @example
+    #   1 + 1 = 2
+    #
+    # @param [Hash] opts ({}) the data and all options
+    # @option opts [String] :title The Title on the Chart
+    # @option opts [Boolean] :legend show legend
+    # @option opts [Hash] :padding { top: bottom: left: right: }
+    # @option opts [String] :x name of the x axis
+    # @option opts [String] :y name of the y axis
+    # @option opts [String] :y1 name of the y1 axis
+    # @option opts [Array [x,y]] :at Top Left corner of bounding box
+    # @option opts [Fixnum] :width width of chart
+    # @option opts [Fixnum] :height height of chart
+    # @option opts [Hash] :series all the data
+    # @option opts [Proc] :key_formatter formatter for the X values
+    # @option opts [Proc] :value_formatter formatter for the Y values
+    #
+    # @yieldparam [Prawn::Charts::Bar#config]
+    #
+    # @return [Prawn::Charts::Bar]
+    def bar_chart opts={}, &block
+      chart = Prawn::Charts::Bar.new(self, opts)
+      yield chart.config if block_given?
+      chart.draw
+    end
+
+    # Draws a stacked bar chart
+    #
+    # @example
+    #   1 + 1 = 2
+    #
+    # @param [Hash] opts ({}) the data and all options
+    # @option opts [String] :title The Title on the Chart
+    # @option opts [Boolean] :legend show legend
+    # @option opts [Hash] :padding { top: bottom: left: right: }
+    # @option opts [String] :x name of the x axis
+    # @option opts [String] :y name of the y axis
+    # @option opts [String] :y1 name of the y1 axis
+    # @option opts [Array [x,y]] :at Top Left corner of bounding box
+    # @option opts [Fixnum] :width width of chart
+    # @option opts [Fixnum] :height height of chart
+    # @option opts [Hash] :series all the data
+    # @option opts [Proc] :key_formatter formatter for the X values
+    # @option opts [Proc] :value_formatter formatter for the Y values
+    #
+    # @yieldparam [Prawn::Charts::StackedBar#config]
+    #
+    # @return [Prawn::Charts::StackedBar]
+    def stacked_bar_chart opts={}, &block
+      chart = Prawn::Charts::StackedBar.new(self, opts)
+      yield chart.config if block_given?
+      chart.draw
+    end
+
+    # Draws a line chart
+    #
+    # @example
+    #   1 + 1 = 2
+    #
+    # @param [Hash] opts ({}) the data and all options
+    # @option opts [String] :title The Title on the Chart
+    # @option opts [Boolean] :legend show legend
+    # @option opts [Hash] :padding { top: bottom: left: right: }
+    # @option opts [String] :x name of the x axis
+    # @option opts [String] :y name of the y axis
+    # @option opts [String] :y1 name of the y1 axis
+    # @option opts [Array [x,y]] :at Top Left corner of bounding box
+    # @option opts [Fixnum] :width width of chart
+    # @option opts [Fixnum] :height height of chart
+    # @option opts [Hash] :series all the data
+    # @option opts [Proc] :key_formatter formatter for the X values
+    # @option opts [Proc] :value_formatter formatter for the Y values
+    #
+    # @yieldparam [Prawn::Charts::Line#config]
+    #
+    # @return [Prawn::Charts::Line]
+    def line_chart opts={}, &block
+      chart = Prawn::Charts::Line.new(self, opts)
+      yield chart.config if block_given?
+      chart.draw
+    end
+
+    # Draws a combo of other charts.  Currently it will draw
+    # a combo of a bar chart and a line chart
+    #
+    # @example
+    #   1 + 1 = 2
+    #
+    # @param [Hash] opts ({}) the data and all options
+    # @option opts [String] :title The Title on the Chart
+    # @option opts [Boolean] :legend show legend
+    # @option opts [Hash] :padding { top: bottom: left: right: }
+    # @option opts [String] :x name of the x axis
+    # @option opts [String] :y name of the y axis
+    # @option opts [String] :y1 name of the y1 axis
+    # @option opts [Array [x,y]] :at Top Left corner of bounding box
+    # @option opts [Fixnum] :width width of chart
+    # @option opts [Fixnum] :height height of chart
+    # @option opts [Hash] :series all the data
+    # @option opts [Proc] :key_formatter formatter for the X values
+    # @option opts [Proc] :value_formatter formatter for the Y values
+    #
+    # @yieldparam [Prawn::Charts::Combo]
+    #
+    # @return [Prawn::Charts::Combo]
+    def combo_chart opts={}, &block
+      chart = Prawn::Charts::Combo.new(self, opts)
+      #yield chart if block_given?
+      chart.draw
+    end
+  end
+end

data/prawn-charts.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prawn/charts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "prawn-charts"
+  spec.version       = Prawn::Charts::VERSION
+  spec.authors       = ["Cajun"]
+  spec.email         = ["zac@kleinpeter.org"]
+  spec.description   = %q{WARNING: Alpha Software.  Charting Lib for Prawn.
+  Supports bar, line, and combo charts.  }
+  spec.summary       = %q{Prawn Charting Lib}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_rubygems_version = ">= 1.3.6"
+
+  spec.add_dependency "prawn"
+  spec.add_dependency "i18n"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+end

data/samples/simple.rb

@@ -0,0 +1,94 @@
+require 'prawn'
+require 'date'
+require_relative '../lib/prawn/charts'
+
+Prawn::Document.generate('chart.pdf') do
+  red   = []
+  green = []
+  blue  = []
+
+  5.times do |i|
+    red.push(   { key: i, value: rand(780) + 750 })
+    green.push( { key: i, value: rand(780) + 750 })
+    blue.push(  { key: i, value: rand(780) + 750 })
+  end
+
+  opts = {
+    title:   'Bar',
+    at:      [bounds.left + 20, bounds.top],
+    width:   500,
+    height:  200,
+    x: {title: 'X Axis', display: true},
+    y: {title: 'Y Axis', display: true},
+    key_formatter:    lambda{|key| (Date.today >> key).strftime('%b %Y')},
+    value_formatter:  lambda{|value| value.to_s},
+    series: [
+      {
+        name:             'Red',
+        color:            'FF00',
+        value_formatter:  lambda{|value| value.to_s},
+        values:           red
+      },
+      {
+        name:             'Green',
+        color:            '0000',
+        value_formatter:  lambda{|value| value.to_s},
+        values:           green
+      },
+      {
+        name:             'Blue',
+        color:            '1F1F',
+        value_formatter:  lambda{|value| value.to_s},
+        values:           blue
+      }
+    ]
+  }
+
+  bar_chart(opts) do |config|
+    config.title = 'Bar'
+  end
+
+  start_new_page
+  stacked_bar_chart(opts) do |config|
+    config.title = 'Stacked Bar'
+  end
+
+  start_new_page
+  line_chart(opts) do |config|
+    config.title = 'Line Chart'
+  end
+
+  start_new_page
+
+  line_opts = opts.merge({
+    title: nil,
+    x: {title: 'X Axis', display: false},
+    y: {title: 'Y Axis', display: false},
+    y1: {title: 'Y1 Axis', display: true},
+    series: [
+      {
+        name:             'Red',
+        color:            'FF00',
+        key_formatter:    lambda{|key| 'Red ' * key},
+        value_formatter:  lambda{|value| value.to_s},
+        values:           red
+      },
+    ]
+  })
+
+  bar_opts = opts.merge({
+    title: 'Combo Chart',
+    x: {title: 'X Axis', display: true},
+    y: {title: 'Y Axis', display: true},
+    series: [
+      {
+        name:             'BLUE',
+        color:            '12AA',
+        key_formatter:    lambda{|key| key.to_s},
+        value_formatter:  lambda{|value| value.to_s},
+        values:           blue
+      },
+    ]
+  })
+  combo_chart(line_chart: line_opts, bar_chart: bar_opts)
+end

data/spec/base_spec.rb

@@ -0,0 +1,56 @@
+require_relative 'spec_helper'
+
+describe Prawn::Charts::Base do
+  subject { Prawn::Charts::Base.new }
+
+  def defaults
+    {
+      padding:  10,
+      at:       [0,0],
+      width:    500,
+      height:   200,
+      spacing:  10,
+    }
+  end
+
+  def override
+    {
+      padding:  2,
+      at:       [10,10],
+      width:    50,
+      height:   3,
+      spacing:  2,
+    }
+  end
+
+  describe 'attributes' do
+    specify { subject.must_respond_to :title }
+    specify { subject.must_respond_to :legend }
+    specify { subject.must_respond_to :padding }
+    specify { subject.must_respond_to :x }
+    specify { subject.must_respond_to :y }
+    specify { subject.must_respond_to :y1 }
+    specify { subject.must_respond_to :at }
+    specify { subject.must_respond_to :width }
+    specify { subject.must_respond_to :height }
+    specify { subject.must_respond_to :spacing }
+  end
+
+  describe 'defaults' do
+    specify { subject.defaults.must_equal defaults }
+    specify { subject.padding.must_equal defaults[:padding] }
+    specify { subject.at.must_equal defaults[:at] }
+    specify { subject.width.must_equal defaults[:width] }
+    specify { subject.height.must_equal defaults[:height] }
+    specify { subject.spacing.must_equal defaults[:spacing] }
+
+    describe 'overriding defaults' do
+      subject { Prawn::Charts::Base.new(override) }
+      specify { subject.padding.must_equal 2 }
+      specify { subject.at.must_equal [10,10]}
+      specify { subject.width.must_equal 50}
+      specify { subject.height.must_equal 3}
+      specify { subject.spacing.must_equal 2}
+    end
+  end
+end

data/spec/document_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'spec_helper'
+
+describe Prawn::Document do
+  subject { Prawn::Document.new }
+
+  specify { subject.must_respond_to :bar_chart }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/prawn/charts.rb', __FILE__)
+