prawn_charts 0.0.4 → 0.0.5

data/README.md

@@ -10,7 +10,7 @@ charts in Prawn with no dependencies other than Prawn.
 Clone the respository and run the following script to generate a PDF
 file with a log graph on your Desktop:
 ```bash
-$ ruby lib/examples/log_example.rb
+$ ruby lib/prawn_charts/examples/log_example.rb
 ```
 
 This script will generate a PDF file of a log graph that is only 6KB.
@@ -19,33 +19,103 @@ This script will generate a PDF file of a log graph that is only 6KB.
 
 
 Prawn Charts can also be used to generate linear graphs.  This graph
-does not leverage built in features (i.e. graph title, y label, x label)
+does not leverage some built in features (i.e. graph title, y label, x label)
 and demonstrates that Prawn Charts is easily customizable.
 
 ![alt tag](https://raw.github.com/MrPowers/prawn_charts/master/images/simple_linear_example.png)
 
+## Contributing
+
+Please send pull requests - they will be merged :)
+
 ## Code Organization
 
 The DataCollectors (located in lib/data_collectors) are responsible for
-manipulating input data in a format suitable for the PrawnChartRenderer.  The
-PrawnChartRenderer module should be mixed in to Prawn::Document, so the
-renderer methods can be called directly on the Prawn::Document object.  
+converting input data to pdf_points, so it can be graphed.  
 
-This example code shows how to use the PdfDataCollector to get formatted
-data that can be passed to the draw_chart() and draw_dots() methods:
+The RenderingAssistant is responsible for parsing the input hash and
+combining user specified data with smart defaults.  The graph is fully
+customizable, but smart defaults allow for rapid prototyping.
 
-```ruby
-Prawn::Document.extensions << PrawnChartRenderer
+The PrawnChartRenderer module should be mixed in to Prawn::Document, so the
+draw_graph method can be called directly on the Prawn::Document object.
+See the lib/prawn_charts/examples/ directory for examples on how to use
+this gem.
+
+## Example Input
+
+The entire log example is included in this README for easy reference:
 
+```ruby
+Prawn::Document.extensions << PrawnCharts::PrawnChartRenderer
 pdf = Prawn::Document.new
-pdf.bounding_box([50, pdf.cursor], :width => graph_width_pdf, :height => graph_height_pdf) do
-  pdf.stroke_bounds
 
-  pdf_data = PdfDataCollector.new(scale, input_data, graph_width_pdf, graph_height_pdf, y_labels).collect
-  pdf.draw_chart(pdf_data)
-  pdf.draw_dots(pdf_data, dot_radius)
-end
+data = [
+  {x_label: "Apr-11", y: 1_000},
+  {x_label: "May-11", y: nil},
+  {x_label: "Jun-11", y: nil},
+  {x_label: "Jul-11", y: nil},
+  {x_label: "Aug-11", y: 300_000},
+  {x_label: "Sep-11", y: nil},
+  {x_label: "Oct-11", y: nil},
+  {x_label: "Dec-11", y: 17},
+  {x_label: "Jan-12", y: nil},
+  {x_label: "Feb-12", y: nil},
+  {x_label: "Mar-12", y: 10},
+  {x_label: "Apr-12", y: nil},
+  {x_label: "May-12", y: nil},
+  {x_label: "Jun-12", y: 1_000_000}
+]
+
+orange = "D95D2E"
+green = "62C545"
+white = "FFFFFF"
+
+colors = {
+  :rectangle_fill => white,
+  :line => green,
+  :dots => orange
+}
+
+input = {
+  :graph => {
+    :starting_point => [100, 400],
+    :width => 300,
+    :height => 200,
+    :data => data,
+    :y_labels => ["1", "10", "100", "1,000", "10,000", "100,000", "1,000,000"],
+    :scale => :log
+  },
+  :dots => {},
+  :y_labels => {
+    :offset => -62,
+    :text_box_options => {:width => 55, :align => :right}
+  },
+  :x_labels => {},
+  :horizontal_lines => true,
+  :graph_title => { :title => "cool graph" },
+  :x_title => { :title => "x title" },
+  :y_title => { :title => "y title", :offset => -60 },
+}
+
+pdf.draw_graph(input, colors)
+
+pdf.render_file(Dir.home + "/desktop/log_prawn_graph.pdf")
 ```
 
-There are separate methods to draw_chart(), draw_dots(), draw_labels(),
-draw_horizontal_lines(), and draw titles, so the charts can be customized.
+The following code illustrates most of the inputs that can be set to
+configure the graph:
+
+```ruby
+data = [{y: 5, x_label: "Jan 11"}, {y: 17, x_label: "Feb 11"}, {y: 14, x_label: "Mar 11"}]
+input = {
+  :graph => {:starting_point => [100, 200], :width => 300, :height => 200, :data => data, :y_labels => [0, 5, 10, 15, 20]},
+  :dots => { :radius => 4 },
+  :horizontal_lines => true,
+  :graph_title => { :title => "cool graph", :offset => 50, :text_box_options => {} },
+  :x_title => { :title => "x title", :offset => -60, :text_box_options => {} },
+  :y_title => { :title => "y title", :offset => -50, :text_box_options => {} },
+  :x_labels => { :offset => -50, :text_box_options => { :width => 100, :height => 20, align: :center, rotate: 45 } },
+  :y_labels => { :offset => -40, :text_box_options => { :height => 40, valign: :center } }
+}
+```

data/lib/prawn_charts.rb

@@ -5,5 +5,4 @@ module PrawnCharts
 end
 
 lib_path = File.expand_path(File.dirname(__FILE__))
-Dir["#{lib_path}/prawn_charts/data_collectors/**/*.rb"].each {|file| require file }
-Dir["#{lib_path}/prawn_charts/renderers/**/*.rb"].each {|file| require file }
+Dir["#{lib_path}/prawn_charts/*.rb"].each {|file| require file }

data/lib/prawn_charts/core_extensions.rb

@@ -0,0 +1,7 @@
+class Hash
+  def dig(*path)
+    path.inject(self) do |location, key|
+      location.respond_to?(:keys) ? location[key] : nil
+    end
+  end
+end

data/lib/prawn_charts/data_collector.rb

@@ -0,0 +1,68 @@
+module PrawnCharts
+  class DataCollector
+    # Arranges graph data in an easy format for Prawn to process
+    attr_reader :height, :width, :data, :y_labels_units, :scale
+    def initialize(input)
+      @height = input.fetch(:height)
+      @width = input.fetch(:width)
+      @data = input.fetch(:data)
+      @y_labels_units = input.fetch(:y_labels)
+      @scale = input.fetch(:scale, :linear)
+    end
+
+    def y_labels
+      y_labels_units.inject([]) do |memo, label|
+        memo << { label: label.to_s, y: y_convert_to_pdf(label) }
+        memo
+      end
+    end
+
+    def horizontal_lines
+      y_labels_units.map do |y|
+        y_pdf = y_convert_to_pdf(y)
+        [[0, y_pdf], [width, y_pdf]]
+      end
+    end
+
+    def data_points
+      @data_points ||= data.map.with_index do |data, index|
+        DataPoint.new(
+          x_units: index,
+          y_units: data[:y],
+          x_pdf: index * pdf_points_per_x_unit,
+          y_pdf: (y_convert_to_pdf(data[:y]) if data[:y]),
+          x_label: data[:x_label]
+        )
+      end
+    end
+
+    def graph_points
+      data_points.select { |data_point| data_point.y_pdf }
+    end
+
+    def y_convert_to_pdf(n)
+      vertical_data_collector.convert_to_pdf(to_float(n))
+    end
+
+    private
+
+    def to_float(object)
+      return object.gsub(",", "").to_f if object.instance_of? String
+      object.to_f
+    end
+
+    def vertical_data_collector
+      return LinearVerticalDataCollector.new(height, y_labels_units) if scale == :linear
+      LogVerticalDataCollector.new(height, y_labels_units)
+    end
+
+    # x methods
+    def max_x_units
+      data.length - 1
+    end
+
+    def pdf_points_per_x_unit
+      width / max_x_units.to_f
+    end
+  end
+end

data/lib/prawn_charts/data_points.rb

@@ -0,0 +1,16 @@
+module PrawnCharts
+  class DataPoint
+    attr_reader :x_units, :y_units, :x_pdf, :y_pdf, :x_label
+    def initialize(input)
+      @x_units = input.fetch :x_units
+      @y_units = input.fetch :y_units
+      @x_pdf = input.fetch :x_pdf
+      @y_pdf = input.fetch :y_pdf
+      @x_label = input.fetch :x_label
+    end
+
+    def coordinate
+      [x_pdf, y_pdf]
+    end
+  end
+end

data/lib/prawn_charts/examples/linear_example.rb

@@ -0,0 +1,55 @@
+require_relative "./../../prawn_charts"
+
+Prawn::Document.extensions << PrawnCharts::PrawnChartRenderer
+pdf = Prawn::Document.new
+
+data = [
+  {x_label: "Apr-11", y: 10},
+  {x_label: "May-11", y: nil},
+  {x_label: "Jun-11", y: nil},
+  {x_label: "Jul-11", y: nil},
+  {x_label: "Aug-11", y: 3},
+  {x_label: "Sep-11", y: nil},
+  {x_label: "Oct-11", y: nil},
+  {x_label: "Dec-11", y: 17},
+  {x_label: "Jan-12", y: nil},
+  {x_label: "Feb-12", y: nil},
+  {x_label: "Mar-12", y: 14},
+  {x_label: "Apr-12", y: nil},
+  {x_label: "May-12", y: nil},
+  {x_label: "Jun-12", y: 16}
+]
+
+orange = "D95D2E"
+green = "62C545"
+light_blue = "EDF1F7"
+white = "FFFFFF"
+black = "000000"
+
+colors = {
+  :rectangle_border => black,
+  :rectangle_fill => white,
+  :line => green,
+  :dots => orange,
+  :x_labels => black,
+  :y_labels => black,
+  :horizontal_lines => black,
+  :graph_title => black,
+  :x_title => black,
+  :y_title => black
+}
+
+input = {
+  :graph => {:starting_point => [100, 400], :width => 300, :height => 200, :data => data, :y_labels => [0, 5, 10, 15, 20]},
+  :dots => {},
+  :y_labels => {},
+  :x_labels => {},
+  :horizontal_lines => true,
+  :graph_title => { :title => "cool graph" },
+  :x_title => { :title => "x title" },
+  :y_title => { :title => "y title" },
+}
+
+pdf.draw_graph(input, colors)
+
+pdf.render_file(Dir.home + "/desktop/linear_prawn_graph.pdf")

data/lib/prawn_charts/examples/log_example.rb

@@ -1,133 +1,56 @@
-require_relative "../../prawn_charts"
-
-module PrawnCharts
-  ##################################
-  #Graph Data Collectors
-  ##################################
-  input_data = [["Apr-11", 5_000_000],
-                ["May-11", nil],
-                ["Jun-11", nil],
-                ["Jul-11", nil],
-                ["Aug-11", 1_000_000],
-                ["Sep-11", nil],
-                ["Oct-11", nil],
-                ["Dec-11", 10_000],
-                ["Jan-12", nil],
-                ["Feb-12", nil],
-                ["Mar-12", 150_000],
-                ["Apr-12", nil],
-                ["May-12", nil],
-                ["Jun-12", 7_500_000]]
-  scale = :log
-  graph_height_pdf = 200
-  graph_width_pdf = graph_height_pdf * 1.7
-  dot_radius = 4
-
-  x_label_width = 50
-  x_label_height = 35
-  x_label_text_box_options = { overflow: :shrink_to_fit, align: :center, rotate: 45 }
-
-  y_labels = [0, 10, 100, 1_000, 10_000, 100_000, 1_000_000, 10_000_000]
-  y_label_height = 30
-  y_label_width = 65
-  y_label_offset = 10
-  y_label_text_box_options = { align: :right, valign: :center }
-
-  graph_title_text = "Cool Prawn Graph"
-  graph_title_height = 40
-
-  y_title_width = 30
-  y_title_text = "HCV Viral Load"
-
-  x_title_height = 40
-  x_title_text = "Month"
-
-  pdf_data = PdfDataCollector.new(scale, input_data, graph_width_pdf, graph_height_pdf, y_labels).collect
-  x_label_data = XLabelsDataCollector.new(input_data, graph_width_pdf, x_label_height, x_label_width).collect
-  y_label_data = YLabelsDataCollector.new(y_labels, graph_height_pdf, y_label_width, y_label_height, y_label_offset).collect
-  horizontal_lines_data = HorizontalLinesDataCollector.new(graph_height_pdf, graph_width_pdf, y_labels).collect
-
-  ##################################
-  #Container Data Collectors
-  ##################################
-
-  container_inputs = {
-    container_left_padding: 0,
-    y_label_offset: y_label_offset,
-    y_label_width: y_label_width,
-    y_title_width: y_title_width,
-    container_right_padding: 20,
-    container_top_padding: 20,
-    graph_title_height: graph_title_height,
-    container_bottom_padding: 0,
-    x_label_height: x_label_height,
-    x_title_height: x_title_height,
-    graph_height: graph_height_pdf,
-    graph_width: graph_width_pdf
-  }
-
-  container_data_collector = ContainerDataCollector.new(container_inputs)
-
-  graph_title_position = container_data_collector.graph_title_top_left
-  graph_title_options = { align: :center, valign: :center}
-  graph_title_data = GraphTitleDataCollector.new(graph_title_text, graph_title_position, graph_title_height, graph_width_pdf).collect
-
-  y_title_position = container_data_collector.y_title_top_left
-  # specifying width is a temp hack solution because of a Prawn bug: https://github.com/prawnpdf/prawn/pull/505
-  y_title_options = { align: :center, valign: :center, rotate: 90, rotate_around: :center, width: 65 }
-  y_title_data = GraphTitleDataCollector.new(y_title_text, y_title_position, graph_height_pdf, y_title_width).collect
-
-  x_title_position = container_data_collector.x_title_top_left
-  x_title_options = { align: :center, valign: :center }
-  x_title_data = GraphTitleDataCollector.new(x_title_text, x_title_position, x_title_height, graph_width_pdf).collect
-
-  graph_top_left = container_data_collector.graph_top_left
-
-  ##################################
-  #Colors
-  ##################################
-
-  orange = "D95D2E"
-  green = "62C545"
-  light_blue = "EDF1F7"
-  white = "FFFFFF"
-  black = "000000"
-
-  ##################################
-  #Create PDF
-  ##################################
-
-  Prawn::Document.extensions << PrawnChartRenderer
-
-  pdf = Prawn::Document.new
-  pdf.bounding_box([0, pdf.cursor], :width => container_data_collector.width, :height => container_data_collector.height) do
-    pdf.stroke_bounds
-    pdf.fill_color = light_blue
-    pdf.fill_rectangle([0, pdf.cursor], container_data_collector.width, container_data_collector.height)
-    pdf.fill_color = black
-
-    pdf.draw_title(graph_title_data, graph_title_options)
-    pdf.draw_title(y_title_data, y_title_options)
-    pdf.draw_title(x_title_data, x_title_options)
-
-    pdf.bounding_box(container_data_collector.graph_top_left, :width => graph_width_pdf, :height => graph_height_pdf) do
-      pdf.stroke_bounds
-      pdf.fill_color = white
-      pdf.fill_rectangle([0, pdf.cursor], graph_width_pdf, graph_height_pdf)
-
-      pdf.stroke_color = green
-      pdf.draw_chart(pdf_data)
-      pdf.fill_color = orange
-      pdf.draw_dots(pdf_data, dot_radius)
-
-      pdf.fill_color = black
-      pdf.draw_labels(x_label_data, x_label_width, x_label_height, x_label_text_box_options)
-
-      pdf.draw_labels(y_label_data, y_label_width, y_label_height, y_label_text_box_options)
-
-      pdf.stroke_color = black
-      pdf.draw_horizontal_lines(horizontal_lines_data)
-    end
-  end
-  pdf.render_file(Dir.home + "/desktop/log_prawn_graph.pdf")
-end
+require_relative "./../../prawn_charts"
+
+Prawn::Document.extensions << PrawnCharts::PrawnChartRenderer
+pdf = Prawn::Document.new
+
+data = [
+  {x_label: "Apr-11", y: 1_000},
+  {x_label: "May-11", y: nil},
+  {x_label: "Jun-11", y: nil},
+  {x_label: "Jul-11", y: nil},
+  {x_label: "Aug-11", y: 300_000},
+  {x_label: "Sep-11", y: nil},
+  {x_label: "Oct-11", y: nil},
+  {x_label: "Dec-11", y: 17},
+  {x_label: "Jan-12", y: nil},
+  {x_label: "Feb-12", y: nil},
+  {x_label: "Mar-12", y: 10},
+  {x_label: "Apr-12", y: nil},
+  {x_label: "May-12", y: nil},
+  {x_label: "Jun-12", y: 1_000_000}
+]
+
+orange = "D95D2E"
+green = "62C545"
+white = "FFFFFF"
+
+colors = {
+  :rectangle_fill => white,
+  :line => green,
+  :dots => orange
+}
+
+input = {
+  :graph => {
+    :starting_point => [100, 400],
+    :width => 300,
+    :height => 200,
+    :data => data,
+    :y_labels => ["1", "10", "100", "1,000", "10,000", "100,000", "1,000,000"],
+    :scale => :log
+  },
+  :dots => {},
+  :y_labels => {
+    :offset => -62,
+    :text_box_options => {:width => 55, :align => :right}
+  },
+  :x_labels => {},
+  :horizontal_lines => true,
+  :graph_title => { :title => "cool graph" },
+  :x_title => { :title => "x title" },
+  :y_title => { :title => "y title", :offset => -60 },
+}
+
+pdf.draw_graph(input, colors)
+
+pdf.render_file(Dir.home + "/desktop/log_prawn_graph.pdf")