prawn-graph 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48595c4b07bae03905c3f1884ea25c7940793669
-  data.tar.gz: d64af98709158716e5130bcd278ad5c5b783fdcb
+  metadata.gz: 2b4ef08ce19955ddfb4f13cfdd5ea16dc32f43ce
+  data.tar.gz: 5596f850626b686869af45159666b45cb92261c3
 SHA512:
-  metadata.gz: 3f4551d1a9c008ab92462af6b261c25db9b9ec8fd6d9ba4fd1b0fde0602ae2d67a14e05f2760d1e1b34bf7c8d07727c133e0931a4d40d39444790ac6e739b94a
-  data.tar.gz: 3da90cd7612b627883d015ca24c2cf4b7b59a4e3274ae2e52f1b3fb6d279b70aa43837059e1ebd18b4bac09c6eee0e53c5d57a1c55ec101f0ea94dbe83801715
+  metadata.gz: caa5f449c651cda707d11796dcd688aaa3e4cd3fbcd3220b1c8b8c69301c634dfd39d6a583a3c739312ba4470151c42332f68d007515dd603511a7b5b0744724
+  data.tar.gz: 8d5d19afcc85fd66106062fbb2c3db5868699376c315b25a71739bfee1347ec5fa439c3198570a42c2a16fc446af148845c2c0a8d6256471159ef1a87d9f0792

data/README.md

@@ -8,11 +8,6 @@
 [![security](https://hakiri.io/github/HHRy/prawn-graph/master.svg)](https://hakiri.io/github/HHRy/prawn-graph/master)
 ![Maintained: yes](https://img.shields.io/badge/maintained-yes-brightgreen.png)
 
-**This readme reflects the state of _master_ which is not the released version of prawn-graph.**
-
-**The code being used to cut gems for release is the `stable` Branch, please make pull requests for**
-**bug fixes from that branch.**
-
 An extension for the [prawn pdf library][5] which adds the ability to draw graphs (or charts if
 you perfer) in PDF documents.
 
@@ -49,7 +44,6 @@ The `bar_chart`, `line_chart`, `bar_graph`, and `line_graph` methods have been r
 version of prawn-graph is no-longer backwards compatible. If you _must_ use those old methods, then please 
 use version `0.9.10` and **upgrade your calls to prawn graph to use the new `graph` methods as soon as possible**.
 
-
 ## Installation
 
 To use prawn-graph, you can add the following to your `Gemfile`:
@@ -100,6 +94,7 @@ Option      | Data type | Description
 :height     | integer   | Desired height of the graph.  Defaults to vertical space available.
 :title      | string    | The overall title for your chart
 :series_key | boolean   | Should we render the series key for multi series graphs? Defaults to true.
+:theme      | Prawn::Graph::Theme | An instance of the Theme object which should be used to style this chart. Default is a greyscale theme for printing.
 
 The `data` passed to `graph` or `chart` should be an `Array` of `Prawn::Graph::Series` objects, which
 themselves are made up of an array of data points to plot, and a series of options.
@@ -136,6 +131,51 @@ Option        | Data type | Description
   end
 ``` 
 
+### Theming
+
+You can pass an instnace of `Prawn::Graph::Theme` using the `:theme` option to the `graph` and `chart` methods. The 
+theme expects to be initialised with a Hash in the following format:
+
+```ruby
+{
+  series:
+    [
+      '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' 
+}
+```
+
+Valid keys are:
+
+Option              | Data type          | Description
+------------------- | ------------------ | -----------
+:series             | Array of Strings   | HEX code colours used to draw a series on the chart. Will cycle through these are too many series for colors
+:title              | string             | HEX color code used to color this part of the chart
+:background         | string             | HEX color code used to color this part of the chart
+:grid               | string             | HEX color code used to color this part of the chart
+:axes               | string             | HEX color code used to color this part of the chart
+:markers            | string             | HEX color code used to color this part of the chart
+:stroke_grid_lines  | boolean            | Should the grid lines be stroked?
+:default            | string             | HEX color code used to color this part of the chart
+:average            | string             | HEX color code used to color this part of the chart
+:max                | string             | HEX color code used to color this part of the chart
+:min                | string             | HEX color code used to color this part of the chart
+
+
 ### Output
 <img src="http://prawn-graph.ryanstenhouse.jp/img/prawn-graph-output.png" alt="Prawn Graph Example Output" width="933" height="420">
 

data/lib/prawn/graph/calculations/layout_calculator.rb

@@ -16,7 +16,7 @@ module Prawn
           end
         end
 
-        def initialize(bounds, attributes = nil, theme = Prawn::Graph::Theme::Default)
+        def initialize(bounds, attributes = nil, theme = Prawn::Graph::Theme.default)
           @bounds = bounds
           @graph_area       = Dimensions.new({ width: 0, height: 0, x: 0, y: 0 })
           @title_area       = Dimensions.new({ width: 0, height: 0, x: 0, y: 0 })

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

@@ -16,7 +16,7 @@ module Prawn
           if @series[series_index].mark_average?
             average_y_coordinate = (point_height_percentage(@series[series_index].avg) * @plot_area_height) - 5
             prawn.line_width = 1
-            prawn.stroke_color = @color[series_index]
+            prawn.stroke_color =  @canvas.theme.color_for(@series[series_index]) # @color[series_index]
             prawn.dash(2)
             prawn.stroke_line([0, average_y_coordinate], [ @plot_area_width, average_y_coordinate ])
             prawn.undash
@@ -53,8 +53,8 @@ module Prawn
 
                 @series.size.times do |series_index|
                   series_offset = series_index + 1
-                  prawn.fill_color    = @color[series_index]
-                  prawn.stroke_color  = @color[series_index]
+                  prawn.fill_color    = @canvas.theme.color_for(@series[series_index])
+                  prawn.stroke_color  = @canvas.theme.color_for(@series[series_index])
                   prawn.line_width  = width
 
                   starting = (prawn.bounds.left + (point * width_per_point))

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

@@ -17,7 +17,7 @@ module Prawn
           verify_series_are_ok!
           @options  =  {xaxis_labels: []}.merge(options.merge({ series_count: series.size }))
           @prawn    = prawn
-          @theme    = Prawn::Graph::Theme::Default
+          @theme    = options[:theme].nil? ? Prawn::Graph::Theme.default : options[:theme]
           @layout   = Prawn::Graph::Calculations::LayoutCalculator.new([prawn.bounds.width, prawn.bounds.height], @options, @theme).calculate
 
           yield self if block_given?

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

@@ -14,7 +14,7 @@ module Prawn
         private
 
         def apply_marker_to_graph(value_marked, value, x, y, color)
-          if @series.mark_maximum? && value_marked == false && value != 0 && value == @series.max
+          if value_marked == false && value != 0 && value == @series.max
             draw_marker_point(color, x, y)
             value_marked = true
           end
@@ -26,7 +26,7 @@ module Prawn
           if @series.mark_average?
             average_y_coordinate = (point_height_percentage(@series.avg) * @plot_area_height) - 5
             prawn.line_width = 1
-            prawn.stroke_color = @color
+            prawn.stroke_color = @canvas.theme.color_for(@series) #@color
             prawn.dash(2)
             prawn.stroke_line([0, average_y_coordinate], [ @plot_area_width, average_y_coordinate ])
             prawn.undash
@@ -47,8 +47,8 @@ module Prawn
                 spacing = width_per_point
 
                 prawn.line_width = 2
-                prawn.fill_color    = @color
-                prawn.stroke_color  = @color
+                prawn.fill_color    =  @canvas.theme.color_for(@series)
+                prawn.stroke_color  =  @canvas.theme.color_for(@series)
 
                 previous_value = @series.values[i - 1]
                 this_value = v
@@ -66,10 +66,15 @@ module Prawn
                   prawn.fill_ellipse([ ( this_x_offset), this_y ], 1)
                 end
 
-                min_marked = apply_marker_to_graph(min_marked, previous_value, previous_x_offset, previous_y, @canvas.theme.min)
-                min_marked = apply_marker_to_graph(min_marked, this_value, this_x_offset, this_y, @canvas.theme.min)
-                max_marked = apply_marker_to_graph(max_marked, previous_value, previous_x_offset, previous_y, @canvas.theme.max)
-                max_marked = apply_marker_to_graph(max_marked, this_value, this_x_offset, this_y, @canvas.theme.max)
+                if @series.mark_minimum?
+                  min_marked = apply_marker_to_graph(min_marked, previous_value, previous_x_offset, previous_y, @canvas.theme.min)
+                  min_marked = apply_marker_to_graph(min_marked, this_value, this_x_offset, this_y, @canvas.theme.min)
+                end
+
+                if @series.mark_maximum?
+                  max_marked = apply_marker_to_graph(max_marked, previous_value, previous_x_offset, previous_y, @canvas.theme.max)
+                  max_marked = apply_marker_to_graph(max_marked, this_value, this_x_offset, this_y, @canvas.theme.max)
+                end
 
                 j += 1
               end

data/lib/prawn/graph/extension.rb

@@ -13,6 +13,7 @@ module Prawn
       #    `:at`          - The point from where the graph will be drawn. `[<Integer>x, <Integer>y]`
       #    `:title`       - The title for this chart. Must be a string. `<String>`
       #    `:series_key`  - Should we render the key to series in this chart? `<Boolean>`
+      #    `:theme     `  - An instance of the theme to be used for styling this graph. `<Prawn::Graph::Theme>`
       #
       def graph(series, options = {}, &block)
         canvas = Prawn::Graph::ChartComponents::Canvas.new(series, self, options, &block)

data/lib/prawn/graph/series.rb

@@ -5,7 +5,7 @@ module Prawn
     # on a chart.
     #
     class Series
-      attr_accessor :values, :options
+      attr_accessor :values, :options, :uuid
 
       DEFAULT_OPTIONS = {
         title:            nil,
@@ -18,6 +18,7 @@ module Prawn
       def initialize(values = [], options = {})
         @values   = values
         @options  = OpenStruct.new(DEFAULT_OPTIONS.merge(options))
+        @uuid = SecureRandom.uuid
       end
 
       # @return [String] The value of +options.title+.

data/lib/prawn/graph/theme.rb

@@ -1,41 +1,61 @@
 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,
-        }),
-      })
+    class Theme
+
+      attr_reader :theme
+
+      # The default theme is special, only create one of them.
+      #
+      def self.default
+        @@_default_theme ||= Prawn::Graph::Theme.new(Prawn::Graph::Theme::Default)
+      end
+
+      def initialize(arg)
+        @series_map = {}
+        @current_series_color = 0
+        @theme = OpenStruct.new(arg)
+      end
+
+      def number_of_colors
+        theme.series.size
+      end
+
+      def ==(other)
+        theme == other.theme
+      end
+
+      def color_for(series)
+        @series_map[series.uuid] = cycle_color unless @series_map.has_key?(series.uuid)
+        @series_map[series.uuid]
+      end
+
+      def font_sizes
+        @font_sizes ||= OpenStruct.new({default:      8, main_title:   10, axis_labels:  5, series_key:   8 })
+      end
+
+      def method_missing(method_name, *arguments)
+        if arguments.any?
+          @theme.send(method_name, arguments)
+        else
+          @theme.send(method_name)
+        end
+      end
+
+      Default = {series:['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' }
+      
+      private
+
+      def cycle_color
+        if @series_map.empty?
+          @current_series_color = 0
+        else
+          next_color_index = @current_series_color + 1
+          next_color_index = 0 if next_color_index == @theme.series.size
+          @current_series_color = next_color_index
+        end
+        @theme.series[@current_series_color]
+      end
+
     end
   end
 end

data/lib/prawn/graph/version.rb

@@ -1,5 +1,5 @@
 module Prawn
   module Graph
-    VERSION = "1.0.4"
+    VERSION = "1.0.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn-graph
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Ryan Stenhouse
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler