gruff 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f87f85fa28083c6c5de44ae3ff41f6ec46c23b87
-  data.tar.gz: a53548ce9aad15d9790b783e89c430e9152c46a6
+  metadata.gz: 0fb3277a32b433f5d7490eb5a3a7cf2cc8f1886c
+  data.tar.gz: 6e6f08031cc7193190aac0f7408b6084e9645a9f
 SHA512:
-  metadata.gz: 0c29244b01317a82ca81b1090d1b24d956e8c7437cca469847aba06f9c48128ea2d47c76b9fd8db76fb02c08671e47e18b98a677fc149154140af413aed8e190
-  data.tar.gz: 5f30539089e2b77e077e95df0117316771b901c6415f7710cbfb0bd5875e74607889433b8f8df8cadc4f918bae91207e074809c48b8ac8d586ddd02f306f3f1c
+  metadata.gz: d2837b625697ac1fc44c9b9c03bdf651306391296e3c80335f1772e2f3526559a73899b85c8a872db2727e7ef4d01038cb45a3a9a761339fc906535a1996f3d3
+  data.tar.gz: c0d09da804c25c538307b43f8a81c50ee731ce193c1d76557c5700ca758d0809af6288d5a1a277805e9e864eeccb698f202b9de7c6f0a9921c16f18d59003b15

data/Gemfile

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

data/History.txt

@@ -1,3 +1,24 @@
+== 0.5.0
+
+We have added a couple of cosmetic changes:  Multiple marker lines both
+vertically and horizontally, and multi-line titles, or no title at all if
+you want more space for the chart.
+
+Features:
+
+* Issue #86 Added support for multiple references lines along both axes to
+  Line Graph
+* Issue #89 Allow multiline and empty titles
+
+Documentation:
+
+* Issue #61 Remove the "BETA Software" warning in the README.
+
+Pull requests:
+
+* Issue #90 Added missing parenthesis in base.rb
+
+
 == 0.4.0
 
 All old branches and pull requests have been merged or deleted.  Over 40

data/README.md

@@ -5,12 +5,6 @@
 
 A library for making beautiful graphs.
 
-## WARNING
-
-This is beta-quality software. It works well according to our tests,
-but the API may change and other features will be added.
-We are working to make Gruff production quality software.
-
 ## Installation
 
 Add this line to your application's Gemfile:

data/RELEASE.md

@@ -1,81 +1,30 @@
-Subject: [ANN] Gruff 0.4.0 released!
+Subject: [ANN] Gruff 0.5.0 released!
 
-The Gruff team is pleased to announce the release of Gruff 0.4.0.
+The Gruff team is pleased to announce the release of Gruff 0.5.0.
 
-New in version 0.4.0:
+New in version 0.5.0:
 
-All old branches and pull requests have been merged or deleted.  Over 40
-issues have been resolved!  Ruby 2.0 compatibility has been confirmed.
-Several new features.
+We have added a couple of cosmetic changes:  Multiple marker lines both
+vertically and horizontally, and multi-line titles, or no title at all if
+you want more space for the chart.
 
 Features:
 
-* Issue #38 Separate themes into Gruff::Themes module
-* Issue #39 Add staggered labels
-* Issue #40 Added spacing factor to bar graphs
-* Issue #41 Add rotation to spider chart
-* Issue #65 Add RMagick and RMagick4J respectively as dependencies to the
-  Gruff gem
-* Issue #81 Ensure Ruby 2.0 compatibility
-    
-Bugfixes:
-
-* Issue #17 Baseline drawn at incorrect position
-* Issue #21 Division By Zero Error on Documented Example
-* Issue #36 When writing the same chart multiple times, it should not be
-  rendered again.
-* Issue #44 XY Datasets are inconvenient to use. (documentation and/or
-  code is wrong)
-* Issue #46 issue with markers that are floats
-* Issue #51 line with nil in dataset
-* Issue #52 Wrong direction in y_axis_label
-* Issue #54 Explicitly specify overlapping for lines (Gruff::Line)
-* Issue #58 Clean up data sorting
-* Issue #59 Escape '%' in labels
-* Issue #60 Correct DOT graph drawing
-* Issue #63 Some charts are drawn with transparent text when running with
-  JRuby/RMagick4J
-* Issue #66 Marker line for 54.0 is missing on bar_set_marker.png example
-* Issue #68 Y-axis label for bar_x_y_labels.png should be rotated when
-  drawn with JRuby
-    
-Support:
-
-* Issue #4 Scaling a graph leads to fuzzy pictures
-* Issue #8 zero-width bar entries drawn
-* Issue #11 Feature: Data value markers
-* Issue #18 Set encoding to uft-8
-* Issue #24 Gruff::SideStackedBar
-* Issue #35 Add option for line height in legend.
-* Issue #49 font directive is not setting font in charts
-* Issue #53 Is this project still alive?
+* Issue #86 Added support for multiple references lines along both axes to
+  Line Graph
+* Issue #89 Allow multiline and empty titles
     
 Documentation:
 
-* Issue #57 Build failing on Travis and no Build Status image in Readme
+* Issue #61 Remove the "BETA Software" warning in the README.
     
 Pull requests:
 
-* Issue #9 Add gradient background direction
-* Issue #12 Bar updates
-* Issue #14 Make use of the TEXT_OFFSET_PERCENTAGE const variable
-* Issue #16 Fix exception when y_axis_increment is used in line bars
-* Issue #26 Fix bug with additional point included on area charts
-* Issue #27 Added marker_shadow_color to allow to draw shadows below
-  marker lines
-* Issue #37 Update lib/gruff/base.rb: set legend under the graph
-* Issue #42 Update lib/gruff/base.rb: set legend under the graph
-* Issue #43 Fixed issue #25
-* Issue #48 add license information to the gemspec
-* Issue #56 Fixed gem file generation problem
-    
-Internal:
-
-* Issue #80 Remove the .rmvrc file from the project
+* Issue #90 Added missing parenthesis in base.rb
     
 You can find a complete list of issues here:
 
-* https://github.com/topfunky/gruff/issues?state=closed&milestone=2
+* https://github.com/topfunky/gruff/issues?state=closed&milestone=4
 
 
 Installation:

data/gruff.gemspec

@@ -7,7 +7,6 @@ require 'gruff/version'
 Gem::Specification.new do |s|
   s.name = %q{gruff}
   s.version = Gruff::VERSION
-  # s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ['Geoffrey Grosenbach', 'Uwe Kubosch']
   s.date = Date.today.to_s
   s.description = %q{Beautiful graphs for one or multiple datasets. Can be used on websites or in documents.}
@@ -15,13 +14,11 @@ Gem::Specification.new do |s|
   # s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
   s.files = `git ls-files`.split($/)
   # s.has_rdoc = true
-  s.homepage = %q{http://nubyonrails.com/pages/gruff}
+  s.homepage = %q{https://github.com/topfunky/gruff}
   # s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = %w(lib)
   # s.rubyforge_project = %q{gruff}
-  # s.rubygems_version = %q{1.3.1}
   s.summary = %q{Beautiful graphs for one or multiple datasets.}
-  # s.test_files = ["test/test_accumulator_bar.rb", "test/test_area.rb", "test/test_bar.rb", "test/test_base.rb", "test/test_bullet.rb", "test/test_dot.rb", "test/test_legend.rb", "test/test_line.rb", "test/test_mini_bar.rb", "test/test_mini_pie.rb", "test/test_mini_side_bar.rb", "test/test_net.rb", "test/test_photo.rb", "test/test_pie.rb", "test/test_scene.rb", "test/test_side_bar.rb", "test/test_sidestacked_bar.rb", "test/test_spider.rb", "test/test_stacked_area.rb", "test/test_stacked_bar.rb"]
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
   s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   s.specification_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/gruff/base.rb

@@ -521,8 +521,8 @@ module Gruff
     def setup_graph_measurements
       @marker_caps_height = @hide_line_markers ? 0 :
           calculate_caps_height(@marker_font_size)
-      @title_caps_height = @hide_title ? 0 :
-          calculate_caps_height(@title_font_size)
+      @title_caps_height = (@hide_title || @title.nil?) ? 0 :
+          calculate_caps_height(@title_font_size) * @title.lines.to_a.size
       @legend_caps_height = @hide_legend ? 0 :
           calculate_caps_height(@legend_font_size)
 

data/lib/gruff/line.rb

@@ -13,11 +13,10 @@ require File.dirname(__FILE__) + '/base'
 
 class Gruff::Line < Gruff::Base
 
-  # Draw a dashed line at the given value
-  attr_accessor :baseline_value
-
-  # Color of the baseline
-  attr_accessor :baseline_color
+  # Allow for reference lines ( which are like baseline ... just allowing for more & on both axes )
+  attr_accessor :reference_lines
+  attr_accessor :reference_line_default_color
+  attr_accessor :reference_line_default_width
 
   # Dimensions of lines and dots; calculated based on dataset size if left unspecified
   attr_accessor :line_width
@@ -30,6 +29,34 @@ class Gruff::Line < Gruff::Base
   attr_accessor :minimum_x_value
   attr_accessor :maximum_x_value
 
+  # Get the value if somebody has defined it.
+  def baseline_value
+    if (@reference_lines.key?(:baseline))
+      @reference_lines[:baseline][:value]
+    else
+      nil
+    end
+  end
+
+  # Set a value for a baseline reference line..
+  def baseline_value=(new_value)
+    @reference_lines[:baseline] ||= Hash.new
+    @reference_lines[:baseline][:value] = new_value
+  end
+
+  def baseline_color
+    if (@reference_lines.key?(:baseline))
+      @reference_lines[:baseline][:color]
+    else
+      nil
+    end
+  end
+
+  def baseline_color=(new_value)
+    @reference_lines[:baseline] ||= Hash.new
+    @reference_lines[:baseline][:color] = new_value
+  end
+
   # Call with target pixel width of graph (800, 400, 300), and/or 'false' to omit lines (points only).
   #
   #  g = Gruff::Line.new(400) # 400px wide with lines
@@ -47,9 +74,11 @@ class Gruff::Line < Gruff::Base
       super args.shift
     end
 
+    @reference_lines = Hash.new
+    @reference_line_default_color = 'red'
+    @reference_line_default_width = 5
+
     @hide_dots = @hide_lines = false
-    @baseline_color = 'red'
-    @baseline_value = nil
     @maximum_x_value = nil
     @minimum_x_value = nil
   end
@@ -81,7 +110,7 @@ class Gruff::Line < Gruff::Base
   #   g.title = "X/Y Dataset"
   #   g.dataxy("Apples", [1,3,4,5,6,10], [1, 2, 3, 4, 4, 3])
   #   g.dataxy("Bapples", [1,3,4,5,7,9], [1, 1, 2, 2, 3, 3])
-  #   g.dataxy("Capples", [[1,1],[2,3],[3,4],[4,5],[5,7],[6,9])
+  #   g.dataxy("Capples", [[1,1],[2,3],[3,4],[4,5],[5,7],[6,9]])
   #   #you can still use the old data method too if you want:
   #   g.data("Capples", [1, 1, 2, 2, 3, 3])  
   #   #labels will be drawn at the x locations of the keys passed in.
@@ -121,6 +150,26 @@ class Gruff::Line < Gruff::Base
 
   end
 
+  def draw_reference_line(reference_line, left, right, top, bottom)
+    @d = @d.push
+    @d.stroke_color(reference_line[:color] || @reference_line_default_color)
+    @d.fill_opacity 0.0
+    @d.stroke_dasharray(10, 20)
+    @d.stroke_width(reference_line[:width] || @reference_line_default_width)
+    @d.line(left, top, right, bottom)
+    @d = @d.pop
+  end
+
+  def draw_horizontal_reference_line(reference_line)
+    level = @graph_top + (@graph_height - reference_line[:norm_value] * @graph_height)
+    draw_reference_line(reference_line, @graph_left, @graph_left + @graph_width, level, level)
+  end
+
+  def draw_vertical_reference_line(reference_line)
+    index = @graph_left + (@x_increment * reference_line[:index])
+    draw_reference_line(reference_line, index, index, @graph_top, @graph_top + graph_height)
+  end
+
   def draw
     super
 
@@ -129,15 +178,9 @@ class Gruff::Line < Gruff::Base
     # Check to see if more than one datapoint was given. NaN can result otherwise.  
     @x_increment = (@column_count > 1) ? (@graph_width / (@column_count - 1).to_f) : @graph_width
 
-    if defined?(@norm_baseline)
-      level = @graph_top + (@graph_height - @norm_baseline * @graph_height)
-      @d = @d.push
-      @d.stroke_color @baseline_color
-      @d.fill_opacity 0.0
-      @d.stroke_dasharray(10, 20)
-      @d.stroke_width 5
-      @d.line(@graph_left, level, @graph_left + @graph_width, level)
-      @d = @d.pop
+    @reference_lines.each_value do |curr_reference_line|
+      draw_horizontal_reference_line(curr_reference_line) if curr_reference_line.key?(:norm_value)
+      draw_vertical_reference_line(curr_reference_line) if curr_reference_line.key?(:index)
     end
 
     @norm_data.each do |data_row|
@@ -190,16 +233,35 @@ class Gruff::Line < Gruff::Base
   end
 
   def setup_data
-    if @baseline_value
-      @maximum_value = [@maximum_value.to_f, @baseline_value.to_f].max
-      @minimum_value = [@minimum_value.to_f, @baseline_value.to_f].min
+
+    # Deal with horizontal reference line values that exceed the existing minimum & maximum values.
+    possible_maximums = [@maximum_value.to_f]
+    possible_minimums = [@minimum_value.to_f]
+
+    @reference_lines.each_value do |curr_reference_line|
+      if (curr_reference_line.key?(:value))
+        possible_maximums << curr_reference_line[:value].to_f
+        possible_minimums << curr_reference_line[:value].to_f
+      end
     end
+
+    @maximum_value = possible_maximums.max
+    @minimum_value = possible_minimums.min
+
     super
   end
 
   def normalize(force=false)
     super(force)
-    @norm_baseline = ((@baseline_value.to_f - @minimum_value) / @spread.to_f) if @baseline_value
+
+    @reference_lines.each_value do |curr_reference_line|
+
+      # We only care about horizontal markers ... for normalization. 
+      # Vertical markers won't have a :value, they will have an :index
+
+      curr_reference_line[:norm_value] = ((curr_reference_line[:value].to_f - @minimum_value) / @spread.to_f) if (curr_reference_line.key?(:value))
+
+    end
 
     #normalize the x data if it is specified
     @data.each_with_index do |data_row, index|

data/lib/gruff/version.rb

@@ -1,3 +1,3 @@
 module Gruff
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/test/gruff_test_case.rb

@@ -32,7 +32,6 @@ class Gruff::Base
 end
 
 class GruffTestCase < Test::Unit::TestCase
-
   def setup
     srand 42
     @datasets = [

data/test/test_line.rb

@@ -484,7 +484,7 @@ class TestGruffLine < GruffTestCase
     g.dataxy('Apples', [[1, 1], [3, 2], [4, 3], [5, 4], [6, 4], [10, 3]])
     g.dataxy('Bapples', [[1, 1], [3, 1], [4, 2], [5, 2], [7, 3], [9, 3]])
     g.data('Capples', [1, 1, 2, 2, 3, 3])
-    g.dataxy('Dapples', [[1, 1], [2, 3], [5, 8], [13, 21]])
+    g.dataxy('Dapples', [[1, 1], [2, 2], [5, 6], [13, 13], [15, nil], [2, 17], [3, nil], [3, 17], [13, nil], [3, 18], [5, nil], [2, 18]])
     g.dataxy('Eapples', [[1, 1], [2, 3], [5, 8], [13, 21], [13, 8], [5, 3], [2, 1], [1, 1]])
     g.labels = {0 => '2003', 2 => '2004', 4 => '2005', 6 => '2006', 8 => '2007', 10 => '2008', 12 => '2009'}
     g.write('test/output/line_xy_pairs.png')
@@ -534,6 +534,29 @@ class TestGruffLine < GruffTestCase
     g.write('test/output/line_y_axis_increment.png')
   end
 
+  def test_multiple_reference_lines
+
+    g = Gruff::Line.new
+    g.title = 'Line Chart with Multiple Reference Lines'
+
+    g.data('Apples', [3, 2, 3, 4, 4, 3])
+    g.data('Oranges', [4, 8, 7, 9, 8, 9])
+    g.data('Watermelon', [2, 3, 4, 5, 6, 8])
+    g.data('Peaches', [9, 9, 10, 8, 7, 9])
+
+    g.labels = {0 => '2003', 2 => '2004', 4 => '2005'}
+
+    g.reference_line_default_width = 1
+
+    g.reference_lines[:baseline]  = { :value => 5 }
+    g.reference_lines[:lots]      = { :value => 9 }
+    g.reference_lines[:little]    = { :value => 3 }
+    g.reference_lines[:horiz_one] = { :index => 1, :color => 'green' }
+    g.reference_lines[:horiz_two] = { :index => 3, :color => 'green' }
+
+    g.write('line_reference_lines.png')
+  end
+
   def test_baseline
     g = Gruff::Line.new
     g.title = 'Line Chart with Baseline = 5'
@@ -549,6 +572,14 @@ class TestGruffLine < GruffTestCase
     g.write('line_baseline.png')
   end
 
+  def test_webp
+    g = setup_basic_graph('800x400')
+    g.title = 'Line Chart WEBP'
+    g.write('line_webp.webp')
+  rescue Magick::ImageMagickError
+    assert_match /no encode delegate for this image format .*\.webp/, $!.message
+  end
+
   private
 
   # TODO Reset data after each theme

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gruff
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Geoffrey Grosenbach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -242,6 +242,7 @@ files:
 - test/output/line_one_value_array.png
 - test/output/line_pos_neg.png
 - test/output/line_pos_neg_400.png
+- test/output/line_reference_lines.png
 - test/output/line_similar_high_end_values.png
 - test/output/line_similar_high_end_values_with_floor.png
 - test/output/line_small_small_zero.png
@@ -260,6 +261,7 @@ files:
 - test/output/line_tiny.png
 - test/output/line_transparent.png
 - test/output/line_very_small.png
+- test/output/line_webp.webp
 - test/output/line_wide_graph.png
 - test/output/line_wide_graph_small.png
 - test/output/line_xy.png
@@ -487,6 +489,7 @@ files:
 - test/output_java/line_one_value_array.png
 - test/output_java/line_pos_neg.png
 - test/output_java/line_pos_neg_400.png
+- test/output_java/line_reference_lines.png
 - test/output_java/line_similar_high_end_values.png
 - test/output_java/line_similar_high_end_values_with_floor.png
 - test/output_java/line_small_small_zero.png
@@ -505,6 +508,7 @@ files:
 - test/output_java/line_tiny.png
 - test/output_java/line_transparent.png
 - test/output_java/line_very_small.png
+- test/output_java/line_webp.webp
 - test/output_java/line_wide_graph.png
 - test/output_java/line_wide_graph_small.png
 - test/output_java/line_xy.png
@@ -629,7 +633,7 @@ files:
 - test/test_spider.rb
 - test/test_stacked_area.rb
 - test/test_stacked_bar.rb
-homepage: http://nubyonrails.com/pages/gruff
+homepage: https://github.com/topfunky/gruff
 licenses:
 - MIT
 metadata: {}
@@ -649,7 +653,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Beautiful graphs for one or multiple datasets.
@@ -781,6 +785,7 @@ test_files:
 - test/output/line_one_value_array.png
 - test/output/line_pos_neg.png
 - test/output/line_pos_neg_400.png
+- test/output/line_reference_lines.png
 - test/output/line_similar_high_end_values.png
 - test/output/line_similar_high_end_values_with_floor.png
 - test/output/line_small_small_zero.png
@@ -799,6 +804,7 @@ test_files:
 - test/output/line_tiny.png
 - test/output/line_transparent.png
 - test/output/line_very_small.png
+- test/output/line_webp.webp
 - test/output/line_wide_graph.png
 - test/output/line_wide_graph_small.png
 - test/output/line_xy.png
@@ -1026,6 +1032,7 @@ test_files:
 - test/output_java/line_one_value_array.png
 - test/output_java/line_pos_neg.png
 - test/output_java/line_pos_neg_400.png
+- test/output_java/line_reference_lines.png
 - test/output_java/line_similar_high_end_values.png
 - test/output_java/line_similar_high_end_values_with_floor.png
 - test/output_java/line_small_small_zero.png
@@ -1044,6 +1051,7 @@ test_files:
 - test/output_java/line_tiny.png
 - test/output_java/line_transparent.png
 - test/output_java/line_very_small.png
+- test/output_java/line_webp.webp
 - test/output_java/line_wide_graph.png
 - test/output_java/line_wide_graph_small.png
 - test/output_java/line_xy.png