prawn_charts 0.0.4 → 0.0.5

data/spec/log_vertical_data_collector.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+module PrawnCharts
+  describe LogVerticalDataCollector do
+    context "#convert_to_pdf" do
+      it "converts a y_units data point to a y_pdf_points data point" do
+        collector = LogVerticalDataCollector.new(400, [0, 10, 100, 1_000])
+        expect(collector.convert_to_pdf(17)).to be_within(0.1).of 164.0
+      end
+    end
+  end
+end

data/todo

@@ -0,0 +1,5 @@
+1. Document code
+2. Analyze how messages are being sent in the program
+3. Update draw_graph method so it is more elegant
+4. Read through all the code and refactor
+5. Add tests

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn_charts
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2013-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -58,31 +58,23 @@ files:
 - images/prawn_charts_log_example.png
 - images/simple_linear_example.png
 - lib/prawn_charts.rb
-- lib/prawn_charts/data_collectors/container/container_data_collector.rb
-- lib/prawn_charts/data_collectors/container/graph_title_data_collector.rb
-- lib/prawn_charts/data_collectors/graph/horizontal_lines_data_collector.rb
-- lib/prawn_charts/data_collectors/graph/linear_y_pdf_data_collector.rb
-- lib/prawn_charts/data_collectors/graph/log_y_pdf_data_collector.rb
-- lib/prawn_charts/data_collectors/graph/pdf_data_collector.rb
-- lib/prawn_charts/data_collectors/graph/x_labels_data_collector.rb
-- lib/prawn_charts/data_collectors/graph/x_pdf_data_collector.rb
-- lib/prawn_charts/data_collectors/graph/y_labels_data_collector.rb
-- lib/prawn_charts/data_collectors/graph/y_pdf_data_collector.rb
+- lib/prawn_charts/core_extensions.rb
+- lib/prawn_charts/data_collector.rb
+- lib/prawn_charts/data_points.rb
+- lib/prawn_charts/examples/linear_example.rb
 - lib/prawn_charts/examples/log_example.rb
-- lib/prawn_charts/examples/simple_linear_example.rb
-- lib/prawn_charts/examples/simple_log_example.rb
-- lib/prawn_charts/renderers/prawn_chart_renderer.rb
+- lib/prawn_charts/helpers.rb
+- lib/prawn_charts/linear_vertical_data_collector.rb
+- lib/prawn_charts/log_vertical_data_collector.rb
+- lib/prawn_charts/prawn_chart_renderer.rb
+- lib/prawn_charts/renderer_assistant.rb
 - lib/prawn_charts/version.rb
 - prawn_charts.gemspec
-- spec/data_collectors/container/container_data_collector_spec.rb
-- spec/data_collectors/graph/horizontal_lines_data_collector_spec.rb
-- spec/data_collectors/graph/linear_y_pdf_data_collector_spec.rb
-- spec/data_collectors/graph/log_y_pdf_data_collector_spec.rb
-- spec/data_collectors/graph/pdf_data_collector_spec.rb
-- spec/data_collectors/graph/x_labels_data_collector_spec.rb
-- spec/data_collectors/graph/x_pdf_data_collector_spec.rb
-- spec/data_collectors/graph/y_labels_data_collector_spec.rb
+- spec/data_collector_spec.rb
+- spec/linear_vertical_data_collector_spec.rb
+- spec/log_vertical_data_collector.rb
 - spec/spec_helper.rb
+- todo
 homepage: ''
 licenses: []
 post_install_message: 
@@ -108,12 +100,7 @@ signing_key:
 specification_version: 3
 summary: Library to create line graphs in Prawn
 test_files:
-- spec/data_collectors/container/container_data_collector_spec.rb
-- spec/data_collectors/graph/horizontal_lines_data_collector_spec.rb
-- spec/data_collectors/graph/linear_y_pdf_data_collector_spec.rb
-- spec/data_collectors/graph/log_y_pdf_data_collector_spec.rb
-- spec/data_collectors/graph/pdf_data_collector_spec.rb
-- spec/data_collectors/graph/x_labels_data_collector_spec.rb
-- spec/data_collectors/graph/x_pdf_data_collector_spec.rb
-- spec/data_collectors/graph/y_labels_data_collector_spec.rb
+- spec/data_collector_spec.rb
+- spec/linear_vertical_data_collector_spec.rb
+- spec/log_vertical_data_collector.rb
 - spec/spec_helper.rb

data/lib/prawn_charts/data_collectors/container/container_data_collector.rb

@@ -1,59 +0,0 @@
-module PrawnCharts
-  class ContainerDataCollector
-    attr_reader :inputs
-    def initialize(inputs)
-      @inputs = inputs
-    end
-
-    def height
-      bottom_gap +
-      inputs[:graph_height] +
-      top_gap
-    end
-
-    def width
-      left_gap + right_gap + inputs[:graph_width]
-    end
-
-    def graph_top_left
-      [left_gap, (height - top_gap)]
-    end
-
-    def graph_title_top_left
-      [left_gap, (bottom_gap + inputs[:graph_height] + inputs[:graph_title_height])]
-    end
-
-    def y_title_top_left
-      [inputs[:container_left_padding], (bottom_gap + inputs[:graph_height])]
-    end
-
-    def x_title_top_left
-      [left_gap, (inputs[:container_bottom_padding] + inputs[:x_title_height])]
-    end
-
-    private
-
-    # gap is area between container edge and graph
-    def left_gap
-      inputs[:container_left_padding] +
-      inputs[:y_label_width] +
-      inputs[:y_label_offset] +
-      inputs[:y_title_width]
-    end
-
-    def right_gap
-      inputs[:container_right_padding]
-    end
-
-    def top_gap
-      inputs[:container_top_padding] +
-      inputs[:graph_title_height]
-    end
-
-    def bottom_gap
-      inputs[:container_bottom_padding] +
-      inputs[:x_label_height] +
-      inputs[:x_title_height]
-    end
-  end
-end

data/lib/prawn_charts/data_collectors/container/graph_title_data_collector.rb

@@ -1,15 +0,0 @@
-module PrawnCharts
-  class GraphTitleDataCollector
-    attr_reader :graph_title, :position, :graph_title_height, :graph_title_width
-    def initialize(graph_title, position, graph_title_height, graph_title_width)
-      @graph_title = graph_title
-      @position = position
-      @graph_title_height = graph_title_height
-      @graph_title_width = graph_title_width
-    end
-
-    def collect
-      { title: graph_title, at: position, height: graph_title_height, width: graph_title_width }
-    end
-  end
-end

data/lib/prawn_charts/data_collectors/graph/horizontal_lines_data_collector.rb

@@ -1,22 +0,0 @@
-module PrawnCharts
-  class HorizontalLinesDataCollector
-    attr_reader :graph_height_pdf, :graph_width_pdf, :y_labels
-    def initialize(graph_height_pdf, graph_width_pdf, y_labels)
-      @graph_height_pdf = graph_height_pdf
-      @graph_width_pdf = graph_width_pdf
-      @y_labels = y_labels
-    end
-
-    def collect
-      y_labels.map.with_index do |_, index|
-        [0, graph_width_pdf, index * y_label_increment]
-      end
-    end
-
-    private
-
-    def y_label_increment
-      graph_height_pdf.to_f / (y_labels.count - 1)
-    end
-  end
-end

data/lib/prawn_charts/data_collectors/graph/linear_y_pdf_data_collector.rb

@@ -1,23 +0,0 @@
-module PrawnCharts
-  class LinearYPdfDataCollector
-    attr_reader :input_data, :graph_height_pdf, :y_labels
-    def initialize(input_data, graph_height_pdf, y_labels)
-      @input_data = input_data
-      @graph_height_pdf = graph_height_pdf
-      @y_labels = y_labels
-    end
-
-    def collect
-      input_data.inject([]) do |memo, (_, y_units)|
-        result = y_units.nil? ? nil : y_units * pdf_points_per_unit
-        memo << result
-      end
-    end
-
-    private
-
-    def pdf_points_per_unit
-      graph_height_pdf.to_f / y_labels.max
-    end
-  end
-end

data/lib/prawn_charts/data_collectors/graph/log_y_pdf_data_collector.rb

@@ -1,21 +0,0 @@
-module PrawnCharts
-  class LogYPdfDataCollector
-    attr_reader :input_data, :graph_height_pdf, :y_labels
-    def initialize(input_data, graph_height_pdf, y_labels)
-      @input_data = input_data
-      @graph_height_pdf = graph_height_pdf
-      @y_labels = y_labels
-    end
-
-    def pdf_points_per_unit
-      graph_height_pdf.to_f / (y_labels.count - 1)
-    end
-
-    def collect
-      input_data.inject([]) do |memo, (_, y_units)|
-        result = y_units.nil? ? nil : (Math.log10(y_units) * pdf_points_per_unit)
-        memo << result
-      end
-    end
-  end
-end

data/lib/prawn_charts/data_collectors/graph/pdf_data_collector.rb

@@ -1,26 +0,0 @@
-module PrawnCharts
-  class PdfDataCollector
-    attr_reader :scale, :input_data, :graph_width_pdf, :graph_height_pdf, :y_labels
-    def initialize(scale, input_data, graph_width_pdf, graph_height_pdf, y_labels)
-      @scale = scale
-      @input_data = input_data
-      @graph_width_pdf = graph_width_pdf
-      @graph_height_pdf = graph_height_pdf
-      @y_labels = y_labels
-    end
-
-    def collect
-      x_pdf_data.zip(y_pdf_data).select { |x, y| [x, y] unless y.nil? }
-    end
-
-    private
-
-    def x_pdf_data
-      XPdfDataCollector.new(input_data, graph_width_pdf).collect
-    end
-
-    def y_pdf_data
-      YPdfDataCollector.new(scale, input_data, graph_height_pdf, y_labels).collect
-    end
-  end
-end

data/lib/prawn_charts/data_collectors/graph/x_labels_data_collector.rb

@@ -1,29 +0,0 @@
-module PrawnCharts
-  class XLabelsDataCollector
-    attr_reader :input_data, :graph_width_pdf, :label_height, :label_width
-    def initialize(input_data, graph_width_pdf, label_height, label_width)
-      @input_data = input_data
-      @graph_width_pdf = graph_width_pdf
-      @label_height = label_height
-      @label_width = label_width
-    end
-
-    def horizontal_offset
-      label_width / 2
-    end
-
-    def collect
-      input_data.map.with_index do |(label, _), index|
-        x_pdf = x_pdf_data[index] - horizontal_offset
-        y_pdf = -(label_height)
-        [label, [x_pdf, y_pdf] ]
-      end
-    end
-
-    private
-
-    def x_pdf_data
-      XPdfDataCollector.new(input_data, graph_width_pdf).collect
-    end
-  end
-end

data/lib/prawn_charts/data_collectors/graph/x_pdf_data_collector.rb

@@ -1,16 +0,0 @@
-module PrawnCharts
-  class XPdfDataCollector
-    def initialize(input_data, graph_width_pdf)
-      @input_data = input_data
-      @graph_width_pdf = graph_width_pdf
-    end
-
-    def pdf_points_per_unit
-      @graph_width_pdf.to_f / (@input_data.length - 1)
-    end
-
-    def collect
-      0.step(@graph_width_pdf, pdf_points_per_unit).to_a
-    end
-  end
-end

data/lib/prawn_charts/data_collectors/graph/y_labels_data_collector.rb

@@ -1,35 +0,0 @@
-module PrawnCharts
-  class YLabelsDataCollector
-    attr_reader :y_labels, :graph_height_pdf, :label_width, :label_height, :y_label_offset
-    def initialize(y_labels, graph_height_pdf, label_width, label_height, y_label_offset)
-      @y_labels = y_labels
-      @graph_height_pdf = graph_height_pdf
-      @label_width = label_width
-      @label_height = label_height
-      @y_label_offset = y_label_offset
-    end
-
-    def collect
-      y_labels.map.with_index do |y_label, index|
-        y_label = number_to_string_with_commas(y_label)
-        x_pdf = -label_width - y_label_offset
-        y_pdf = index * y_label_increment + vertical_offset
-        [y_label, [x_pdf, y_pdf]]
-      end
-    end
-
-    private
-
-    def vertical_offset
-      label_height / 2
-    end
-
-    def y_label_increment
-      graph_height_pdf.to_f / (y_labels.count - 1)
-    end
-
-    def number_to_string_with_commas(number)
-      number.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
-    end
-  end
-end

data/lib/prawn_charts/data_collectors/graph/y_pdf_data_collector.rb

@@ -1,21 +0,0 @@
-module PrawnCharts
-  class YPdfDataCollector
-    attr_reader :scale, :input_data, :graph_height_pdf, :y_labels
-    def initialize(scale, input_data, graph_height_pdf, y_labels)
-      @scale = scale
-      @input_data = input_data
-      @graph_height_pdf = graph_height_pdf
-      @y_labels = y_labels
-    end
-
-    def collect
-      if scale == :linear
-        LinearYPdfDataCollector.new(input_data, graph_height_pdf, y_labels).collect
-      elsif scale == :log
-        LogYPdfDataCollector.new(input_data, graph_height_pdf, y_labels).collect
-      else
-        raise("Scale must be :linear or :log")
-      end
-    end
-  end
-end

data/lib/prawn_charts/examples/simple_linear_example.rb

@@ -1,59 +0,0 @@
-require_relative "./../prawn_charts"
-
-module PrawnCharts
-  ##################################
-  #Graph Data Collectors
-  ##################################
-  input_data = [["Apr-11", 10],
-                ["May-11", 30],
-                ["Jun-11", 50],
-                ["Jul-11", 3],
-                ["Aug-11", 40],
-                ["Sep-11", nil],
-                ["Oct-11", nil],
-                ["Dec-11", 100],
-                ["Jan-12", nil],
-                ["Feb-12", nil],
-                ["Mar-12", 5],
-                ["Apr-12", nil],
-                ["May-12", nil],
-                ["Jun-12", 75]]
-  scale = :linear
-  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, 25, 50, 75, 100, 125]
-  y_label_height = 30
-  y_label_width = 65
-  y_label_offset = 10
-  y_label_text_box_options = { align: :right, valign: :center }
-
-  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
-
-  ##################################
-  #Create PDF
-  ##################################
-
-  Prawn::Document.extensions << PrawnChartRenderer
-
-  pdf = Prawn::Document.new
-
-  pdf.bounding_box([50, pdf.cursor], :width => graph_width_pdf, :height => graph_height_pdf) do
-    pdf.stroke_bounds
-    pdf.draw_chart(pdf_data)
-    pdf.draw_dots(pdf_data, dot_radius)
-    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.draw_horizontal_lines(horizontal_lines_data)
-  end
-
-  pdf.render_file(Dir.home + "/desktop/simple_linear_prawn_graph.pdf")
-end

data/lib/prawn_charts/examples/simple_log_example.rb

@@ -1,59 +0,0 @@
-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 }
-
-  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
-
-  ##################################
-  #Create PDF
-  ##################################
-
-  Prawn::Document.extensions << PrawnChartRenderer
-
-  pdf = Prawn::Document.new
-
-  pdf.bounding_box([50, pdf.cursor], :width => graph_width_pdf, :height => graph_height_pdf) do
-    pdf.stroke_bounds
-    pdf.draw_chart(pdf_data)
-    pdf.draw_dots(pdf_data, dot_radius)
-    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.draw_horizontal_lines(horizontal_lines_data)
-  end
-
-  pdf.render_file(Dir.home + "/desktop/simple_log_prawn_graph.pdf")
-end