prawn-graph 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bab79a3dc4ba1072ba72479b83ac9de8a1d38922
-  data.tar.gz: 6c23d7a89268e42bfff25b1da58bcb49adc7e3bc
+  metadata.gz: e781761d7d174b22bde7030b5987e8e59c99a69f
+  data.tar.gz: 9102428b3c801fb0c1e32daf04912a0ef7866c65
 SHA512:
-  metadata.gz: b6b4482768b7d5470a3a3913698cd8669a391d8947a576c540d45938a76c62b644705f7572fd7474e21a218b2aab72d1a3a7c342d1dcacdbcfddbbcf79050898
-  data.tar.gz: d4666cd5006ccaef777fe90c882b36da57a170903dd1017588b037ddd9d5070b81533c86db743ce4fb2acab5083926a72888e0a1e07a3f20e5a617699611a4c9
+  metadata.gz: 155310ed2dde8d1375d42632af91b7f78c7f9f032f026f795ad437cbb2a6eeba318e62ac5ef6753751ec4e10903576e1b312be2377f0a97fa55fb2b30f86a9e3
+  data.tar.gz: d845d5ad0201e5e2b549a022b6ab66170121748f4c5e989e739917b75c541e3098c6f03c76c26b602109bb34b375d4b17790f7fb7266214b6218fb005f9d44f0

data/README.md

@@ -77,37 +77,54 @@ adventurous - please add it!
 
 ## Using prawn-graph
 
-```ruby
-  require 'prawn-graph'
-
-  series = []
-  series << Prawn::Graph::Series.new([1,2,3,4,5], title: "Some numbers", type: :bar)
+Graphs can be created by calling the `graph` or its alias, `chart` method with an array of
+`Prawn::Graph::Series` objects representing the data you would like to plot and how it should
+be displayed. It will also take a hash of options, and block which will have the graph yeilded
+to it.
 
-  Prawn::Document.generate('test.pdf') do
-    graph series
-  end
+```ruby
+  graph data, options = {}, &block.
 ```
 
 When called with just a set of data, prawn-graph will do its best to make the graph fit in the 
 available space. For a little more control over how the graphs are rendered in the document
-you can pass the following options:
+you can pass the following options to `graph` or `chart`:
 
 Option      | Data type | Description
 ----------- | --------- | -----------
 :at         | [integer, integer] | Specify the location on the page you want the graph to appear.
 :width      | integer   | Desired width of the graph.  Defaults to horizontal space available.
 :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.
+
+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.
+
+```ruby
+  Prawn::Graph::Series.new [1,2,3,4], options = {}
+```
+
+Valid `options` are:
+
+Option        | Data type | Description
+------------- | --------- | -----------
+:mark_average | boolean   | Should we mark a line showing the average value of the series? Defaults to false.
+:mark_minimum | boolean   | Should we mark the minimum value of the series? Defaults to false.
+:mark_maximum | boolean   | Should we mark the maximum value of the series? Defaults to false.
+:title        | string    | The title of this series, which will be shown in the series key.
+:type         | symbol    | How this series should be rendered. Defaults to `:bar`, valid options are `:bar`, `:line`.
 
-### Advanced example
+### Show me some code!
 
 ```ruby
   require 'prawn-graph'
 
   series = []
-  series << Prawn::Graph::Series.new([4,9,3,2,1,6,2,8,2,3,4,9,2], title: "A label for a series", type: :bar, mark_average: true)
-  series << Prawn::Graph::Series.new([5,4,3,2,7,9,2,8,7,5,4,9,2].reverse, title: "Another label", type: :line, mark_average: true)
+  series << Prawn::Graph::Series.new([4,9,3,2,1,6,2,8,2,3,4,9,2], title: "A label for a series", type: :bar)
+  series << Prawn::Graph::Series.new([5,4,3,2,7,9,2,8,7,5,4,9,2].reverse, title: "Another label", type: :line, mark_average: true, mark_minimum: true)
   series << Prawn::Graph::Series.new([1,2,3,4,5,9,6,4,5,6,3,2,11], title: "Yet another label", type: :bar)
-  series << Prawn::Graph::Series.new([1,2,3,4,5,12,6,4,5,6,3,2,9].shuffle, title: "One final label", type: :line, mark_average: true)
+  series << Prawn::Graph::Series.new([1,2,3,4,5,12,6,4,5,6,3,2,9].shuffle, title: "One final label", type: :line, mark_average: true, mark_maximum: true)
 
   Prawn::Document.generate('test.pdf') do
     graph series, width: 500, height: 200, title: "A Title for the chart", at: [10,700]

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

@@ -33,6 +33,9 @@ module Prawn
             prawn.bounding_box [@graph_area.point[0] + 5, @graph_area.point[1] - 20], width: @plot_area_width, height: @plot_area_height do
               j = 2
               prawn.save_graphics_state do  
+                max_marked = false
+                min_marked = false
+
                 @series.values.each_with_index do |v, i|
                   next if i == 0
 
@@ -59,6 +62,36 @@ module Prawn
                   prawn.fill_color = @canvas.theme.markers
                   prawn.fill_ellipse([ ( previous_x_offset), previous_y ], 1)
                   prawn.fill_ellipse([ ( this_x_offset), this_y ], 1)
+
+                  if @series.mark_minimum? && min_marked == false && previous_value == @series.min
+                    prawn.save_graphics_state do
+                      prawn.fill_color = @canvas.theme.min
+                      prawn.stroke_color = @canvas.theme.min
+                      prawn.line_width = 1
+
+                      prawn.dash(2)
+                      prawn.stroke_line([previous_x_offset, 0], [previous_x_offset, previous_y])
+                      prawn.undash
+
+                      prawn.fill_ellipse([ ( previous_x_offset), previous_y ], 2)
+                      min_marked = true
+                    end
+                  end
+
+                  if @series.mark_maximum? && max_marked == false && previous_value == @series.max
+                    prawn.save_graphics_state do
+                      prawn.fill_color = @canvas.theme.max
+                      prawn.stroke_color = @canvas.theme.max
+                      prawn.line_width = 1
+
+                      prawn.dash(2)
+                      prawn.stroke_line([previous_x_offset, 0], [previous_x_offset, previous_y])
+                      prawn.undash
+
+                      prawn.fill_ellipse([ ( previous_x_offset), previous_y ], 2)
+                      max_marked = true
+                    end
+                  end
                   j += 1
                 end
                 
@@ -131,6 +164,8 @@ module Prawn
                 num_points        = @series[0].size
                 width_per_point   = (@plot_area_width / num_points).round(2).to_f
                 width             = ((width_per_point * BigDecimal('0.9')) / @series.size).round(2).to_f
+                min_marked        = false
+                max_marked        = false
 
                 num_points.times do |point|
 
@@ -155,6 +190,36 @@ module Prawn
                       prawn.stroke_line([0, average_y_coordinate], [ @plot_area_width, average_y_coordinate ])
                       prawn.undash
                     end
+
+                    if @series[series_index].mark_minimum? && min_marked == false && @series[series_index].values[point] == @series[series_index].min
+                      prawn.save_graphics_state do
+                        prawn.fill_color = @canvas.theme.min
+                        prawn.stroke_color = @canvas.theme.min
+                        prawn.line_width = 1
+
+                        prawn.dash(2)
+                        prawn.stroke_line([x_position, 0], [x_position, y_position])
+                        prawn.undash
+
+                        prawn.fill_ellipse([x_position, y_position ], 2)
+                        min_marked = true
+                      end
+                    end
+
+                    if @series[series_index].mark_maximum? && max_marked == false && @series[series_index].values[point] == @series[series_index].max
+                      prawn.save_graphics_state do
+                        prawn.fill_color = @canvas.theme.max
+                        prawn.stroke_color = @canvas.theme.max
+                        prawn.line_width = 1
+
+                        prawn.dash(2)
+                        prawn.stroke_line([x_position, 0], [x_position, y_position])
+                        prawn.undash
+
+                        prawn.fill_ellipse([x_position, y_position ], 2)
+                        max_marked = true
+                      end
+                    end
                   end
 
                 end

data/lib/prawn/graph/series.rb

@@ -71,6 +71,14 @@ module Prawn
         options.mark_average == true
       end
 
+      def mark_minimum?
+        options.mark_minimum == true
+      end
+
+      def mark_maximum?
+        options.mark_maximum == true
+      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... ]
       #

data/lib/prawn/graph/version.rb

@@ -1,5 +1,5 @@
 module Prawn
   module Graph
-    VERSION = "0.9.2"
+    VERSION = "0.9.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn-graph
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Ryan Stenhouse
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-14 00:00:00.000000000 Z
+date: 2016-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler