prawn-charts 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d229bb1567aa946fa8f682c7fba2c2464cdf44ca
+  data.tar.gz: e1e42e6ddd1e162ba0bba5e57aca729dc0af7e5d
+SHA512:
+  metadata.gz: 14f82bd9bfd2013ca1ed09fd8522b2a38e05b0ca8647cf62702d13b902581fca1aa17dbcb96232fb8067b7432fd4751a6574e1ad585fd7365fec5e733b991742
+  data.tar.gz: 74033d486dd821171d746e55b0fa806e8f674aefe60b6b8fb34f71cd344c63d09ceff516a71d6da09102f8d0f64a09373abf56262842db7e146f3576ea3a416c

data/.gitignore

@@ -0,0 +1,51 @@
+.gems
+*.pdf
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prawn-charts.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Zac Kleinpeter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Zac
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Prawn::Charts
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'prawn-charts'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prawn-charts
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+=======

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.test_files = FileList['spec/*_spec.rb']
+end
+
+desc "Run Specs"
+task default: :test
+

data/lib/config/locales/en.yml

@@ -0,0 +1,14 @@
+en:
+  prawn:
+    charts:
+      errors:
+        messages:
+          no_series:
+            message: "No series data for %{chart_type}."
+            summary:
+              "When creating a chart %{klass} looks for a key named 'series'
+              to be in the options passed in.  This series data will need to be
+              in a specific format for the %{chart_type} to understand."
+            resolution: "Please use the following series example to create the
+              %{chart_type}.
+            Example: %{example_options}"

data/lib/prawn/charts/bar.rb

@@ -0,0 +1,79 @@
+module Prawn
+  module Charts
+    class Bar < Base
+      attr_accessor :ratio
+
+      def initialize pdf, opts = {}
+        super pdf, opts
+        @ratio = opts[:ratio] || 0.75
+      end
+
+      def plot_values
+        return if series.nil?
+        series.each_with_index do |bar,index|
+          point_x = first_x_point index
+
+          bar[:values].each do |h|
+            fill_color bar[:color]
+            fill do
+              height = value_height(h[:value])
+              rectangle [point_x,height], bar_width, height
+              #draw_text height.to_i, at: [point_x,height]
+              #draw_text h[:value], at: [point_x,height]
+            end
+            point_x += additional_points
+          end
+
+        end
+      end
+
+      def first_x_point index
+        (bar_width * index) + (bar_space * (index + 1))
+      end
+
+      def additional_points
+        (bar_space + bar_width) * series.count
+      end
+
+      def x_points
+        points = nil
+        series.each_with_index do |bar,index|
+          tmp = []
+
+          tmp << first_x_point(index) + (bar_width / 2)
+
+          bar[:values].each do |h|
+            tmp << tmp.last + additional_points
+          end
+
+          points ||= [0] * tmp.length
+
+          tmp.each_with_index do |point, i|
+            points[i] += point
+          end
+        end
+
+        points.map do |point|
+          (point / series.count).to_i
+        end
+      end
+
+      def bar_width
+        @bar_width ||= (bounds.width * ratio) / series_length.to_f
+      end
+
+      def bar_space
+        @bar_space ||= (bounds.width * (1.0 - ratio)) / (series_length + 1).to_f
+      end
+
+      def series_length
+        series.map { |v| v[:values].length }.max * series.count
+      end
+
+      def value_height val
+        bounds.height * ((val - min_value) / series_height.to_f)
+      end
+
+    end
+  end
+end

data/lib/prawn/charts/base.rb

@@ -0,0 +1,262 @@
+module Prawn
+  module Charts
+
+    # Prawn::Charts::Base will handle most of the common activities that any
+    # chart will require.  It also will call the drawing functions for each of
+    # the types of charts.
+    class Base
+      attr_reader :pdf, :config
+
+      extend Forwardable
+
+      def_delegators :@pdf, :bounding_box, :bounds
+      def_delegators :@pdf, :draw_text, :pad, :text
+      def_delegators :@pdf, :stroke_axis, :rotate, :stroke_bounds
+      def_delegators :@pdf, :height_of, :width_of
+      def_delegators :@pdf, :fill, :fill_color
+      def_delegators :@pdf, :rectangle, :stroke_color, :line, :stroke
+      def_delegators :@pdf, :fill_ellipse, :curve
+
+      #
+      # @param pdf [Prawn::Document] and instance of the prawn document
+      # @param opts [Hash]
+      # @option opts :title [String]
+      # @option opts :at [Array<x,y>]
+      # @option opts :width [Fixnum] (500)
+      # @option opts :height [Fixnum] (200)
+      # @option opts :x  [Hash] ({title: 'X Axis', display: false })
+      # @option opts :y  [Hash] ({title: 'Y Axis', display: false})
+      # @option opts :y1 [Hash] ({title: 'Y1 Axis', display: false})
+      # @option opts :key_formatter   [Proc] lambda{|key| key.to_s },
+      # @option opts :value_formatter [Proc] lambda{|value| value.to_s},
+      # @option opts :series [Array<Hash>] [
+      #     {
+      #       name:             'Red',
+      #       color:            'FF00',
+      #       values:           [{ key: , value: }]
+      #     },
+      #     {
+      #       name:             'Blue',
+      #       color:            '1F1F',
+      #       values:           [{ key: , value: }]
+      #     }]
+      # }
+      def initialize pdf, opts = {}
+
+        @pdf    = pdf
+        opts    = defaults.merge(opts)
+        @config = OpenStruct.new defaults.merge(opts)
+        opts.keys.each do |key|
+          define_singleton_method key.to_s, &@config.method(key)
+        end
+
+        raise Errors::NoChartData.new if @config.series.nil?
+      end
+
+      def defaults
+        {
+          padding:  {
+            bottom:  50,
+            left:    50,
+            right:   50,
+            top:     50,
+          },
+          x:  { display: false },
+          y:  { display: false },
+          y1: { display: false },
+          at:               [0,0],
+          width:            500,
+          height:           200,
+          key_formatter:    lambda{ |key| key.to_s },
+          value_formatter:  lambda{ |value| value.to_s }
+        }
+      end
+
+      def draw
+        bounding_box at, width: width, height: height do
+          stroke_bounds
+          fill_color '0000'
+
+          draw_title
+          draw_x_axis_label  if x[:display]
+          draw_y_axis_label  if y[:display]
+          draw_y1_axis_label if y1[:display]
+
+          bounding_box(chart_at, width: chart_width, height: chart_height) do
+            draw_x_axis  if x[:display]
+            draw_y_axis  if y[:display]
+            draw_y1_axis if y1[:display]
+            #stroke_axis( color: 'FF00', step_length: 50 )
+            plot_values
+          end
+
+        end
+      end
+
+      def padding_top_bottom
+        padding[:top] + padding[:bottom]
+      end
+
+      def padding_left_right
+        padding[:left] + padding[:right]
+      end
+
+      def chart_at
+        [ bounds.left + (padding_left_right / 2), bounds.top - (padding_top_bottom / 2) ]
+      end
+
+      def chart_width
+        bounds.width - padding_left_right
+      end
+
+      def chart_height
+        bounds.height - padding_top_bottom
+      end
+
+      def draw_title
+        opts ={ width: bounds.width, height: height_of(title.to_s) }
+        bounding_box( [bounds.left, bounds.top - height_of(title.to_s) / 2], opts ) do
+          text title, align: :center
+        end
+      end
+
+      def draw_y_axis_label
+        w = width_of(y[:title]) / 2
+        rotate 90, origin: [bounds.left + w , (bounds.height / 2 )] do
+          mid = bounds.height / 2
+          draw_text y[:title], at: [0, mid]
+        end
+      end
+
+      def draw_y1_axis_label
+        w = width_of(y1[:title]) / 2
+        rotate 270, origin: [bounds.right - w, (bounds.height / 2 )] do
+          mid = bounds.height / 2
+          draw_text y1[:title], at: [bounds.right - w, mid]
+        end
+      end
+
+      def draw_x_axis_label
+        opts ={ width: bounds.width, height: height_of(x[:title]) }
+        bounding_box( [bounds.left, bounds.bottom + height_of(x[:title])], opts ) do
+          text x[:title], align: :center
+        end
+      end
+
+
+      def draw_x_axis
+        txt = series.map do |s|
+          s[:values].map{ |v| height_of(key_formatter.call(v[:key]))}.max
+        end.max
+
+        opts = {
+          series:  series,
+          at:      [0,0],
+          width:   bounds.width,
+          height:  txt,
+          points:  x_points,
+          formatter: key_formatter
+        }
+
+        Prawn::Charts::XAxis.new(pdf, opts).draw
+      end
+
+      def draw_y_axis
+        txt = series.map do |s|
+          s[:values].map{ |v| width_of(value_formatter.call(v[:value]))}.max
+        end.max
+
+        opts = {
+          at:         [-txt, bounds.height],
+          width:      txt,
+          height:     bounds.height,
+          points:     [min_value, max_value],
+          formatter:  value_formatter,
+          percentage: percentage
+        }
+
+        Prawn::Charts::YAxis.new(pdf, opts).draw
+
+      end
+
+      def draw_y1_axis
+        txt = series.map do |s|
+          s[:values].map{ |v| width_of(value_formatter.call(v[:value]))}.max
+        end.max
+
+        opts = {
+          at:         [bounds.right, bounds.height],
+          width:      txt,
+          height:     bounds.height,
+          points:     [min_value, max_value],
+          formatter:  value_formatter
+        }
+
+        Prawn::Charts::YAxis.new(pdf, opts).draw
+
+      end
+
+
+      def plot_values
+      end
+
+      def x_points
+      end
+
+      def values
+        @values ||= series.map{ |bar| bar[:values].map{|single| single[:value] }}.flatten
+      end
+
+      def keys
+        @keys ||= series.map{ |v| v[:values].map{|k| k[:key] }}.flatten.uniq
+      end
+
+      def max_value
+        n = values.max
+        exp = 10 ** (Math.log10(n).floor - 1)
+        n + ( exp  - n % exp)  + exp
+      end
+
+      def min_value
+        n = (values.min - delta_value * 0.1).to_i
+        exp = 10 ** (Math.log10(n).floor - 1)
+        n - (n % exp)
+      end
+
+      def delta_value
+        values.max - values.min
+      end
+
+      def series_height
+        max_value - min_value
+      end
+
+      def percentage
+        false
+      end
+
+      def stacked_bar_values
+        keys.map do |key|
+          items = for_key(key)
+          {
+            key: key,
+            values: items,
+            total: items.inject(0){ |s,v| s + v[:value] }
+          }
+        end
+      end
+
+
+      def for_key key
+        series.map do |v|
+          {
+            name: v[:name],
+            color: v[:color],
+            value: v[:values].detect{|k| k[:key] == key }[:value]
+          }
+        end
+      end
+
+    end
+  end
+end

data/lib/prawn/charts/combo.rb

@@ -0,0 +1,19 @@
+module Prawn
+  module Charts
+
+    class Combo
+
+      def initialize pdf, opts = {}
+        @pdf        = pdf
+        @line_chart = opts[:line_chart]
+        @bar_chart  = opts[:bar_chart]
+      end
+
+      def draw
+        Prawn::Charts::Bar.new( @pdf,  @bar_chart ).draw
+        Prawn::Charts::Line.new(@pdf, @line_chart ).draw
+      end
+
+    end
+  end
+end

data/lib/prawn/charts/error/no_series.rb

@@ -0,0 +1,52 @@
+module Prawn
+  module Charts
+    class NoSeries < Error
+
+      def initialize chart_type, klass, opts
+        super(
+          compose_message(
+            "no_series",
+            {
+              chart_type:       chart_type,
+              klass:            klass,
+              example_options:  "\n\n" + opts.merge(series).inspect
+            }
+          )
+        )
+      end
+
+
+      private
+
+      def series
+        {
+          series: [
+            {
+              name:             'Red',
+              color:            'FF00',
+              value_formatter:  "lambda{|value| value.to_s}",
+              values:           [
+                { key: 1, value: 100 },
+                { key: 2, value: 220 },
+                { key: 3, value: 330 },
+                { key: 4, value: 403 }
+              ]
+            },
+            {
+              name:             'Green',
+              color:            '0000',
+              value_formatter:  "lambda{|value| value.to_s}",
+              values:           [
+                { key: 1, value: 140 },
+                { key: 2, value: 120 },
+                { key: 3, value: 330 },
+                { key: 4, value: 300 }
+              ]
+            }
+          ]
+        }
+      end
+
+    end
+  end
+end

data/lib/prawn/charts/error.rb

@@ -0,0 +1,87 @@
+module Prawn
+  module Charts
+    # Modelled after Mongoid Errors
+    # SOURCE: Mongoid creator of awesome error messages
+    #  https://github.com/mongoid/mongoid/blob/master/lib/mongoid/errors/mongoid_error.rb
+    class Error < StandardError
+
+      BASE_KEY = 'prawn.charts.errors.messages'
+      #
+      # Compose the message.
+      #
+      # @example Create the message
+      #   error.compose_message
+      #
+      # @return [ String ] The composed message.
+      def compose_message(key, attributes)
+        @problem = problem(key, attributes)
+        @summary = summary(key, attributes)
+        @resolution = resolution(key, attributes)
+
+        "\n\nProblem:\n\n  #{@problem}"+
+        "\n\nSummary:\n\n  #{@summary}"+
+        "\n\nResolution:\n\n  #{@resolution} \n\n"
+      end
+
+      private
+
+      # Given the key of the specific error and the options hash, translate the
+      # message.
+      #
+      # @example Translate the message.
+      #   error.translate("errors", :key => value)
+      #
+      # @param [ String ] key The key of the error in the locales.
+      # @param [ Hash ] options The objects to pass to create the message.
+      #
+      # @return [ String ] A localized error message string.
+      def translate(key, options)
+        ::I18n.translate("#{BASE_KEY}.#{key}", options)
+      end
+
+      # Create the problem.
+      #
+      # @example Create the problem.
+      #   error.problem("error", {})
+      #
+      # @param [ String, Symbol ] key The error key.
+      # @param [ Hash ] attributes The attributes to interpolate.
+      #
+      # @return [ String ] The problem.
+      def problem(key, attributes)
+        translate("#{key}.message", attributes)
+      end
+
+      # Create the summary.
+      #
+      # @example Create the summary.
+      #   error.summary("error", {})
+      #
+      # @param [ String, Symbol ] key The error key.
+      # @param [ Hash ] attributes The attributes to interpolate.
+      #
+      # @return [ String ] The summary.
+      def summary(key, attributes)
+        translate("#{key}.summary", attributes)
+      end
+
+      # Create the resolution.
+      #
+      # @example Create the resolution.
+      #   error.resolution("error", {})
+      #
+      # @param [ String, Symbol ] key The error key.
+      # @param [ Hash ] attributes The attributes to interpolate.
+      #
+      # @return [ String ] The resolution.
+      def resolution(key, attributes)
+        translate("#{key}.resolution", attributes)
+      end
+
+    end
+    #NoChartData        = Class.new StandardError
+    #MalformedSeries    = Class.new StandardError
+    #MalformedAxis      = Class.new StandardError
+    #NoPlotValuesMethod = Class.new StandardError
+  end
+end