sparklines 0.4.7 → 0.4.8

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.4.8
+
+* Added bullet graph. See http://en.wikipedia.org/wiki/Bullet_graph or Stephen Few's book _Information Dashboard Design_.
+
 == 0.4.7
 
 * Improved normalization for better display of close, high-values. [Matt Van Horn]

data/Manifest.txt

@@ -18,4 +18,44 @@ samples/pie95.png
 samples/pie99.png
 samples/smooth-colored.png
 samples/smooth.png
+test/expected/area.png
+test/expected/area_high.png
+test/expected/area_min_max.png
+test/expected/bar.png
+test/expected/bar_extreme_values.png
+test/expected/bar_string.png.png
+test/expected/bar_tall.png
+test/expected/bar_wide.png
+test/expected/bullet_basic.png
+test/expected/bullet_full_featured.png
+test/expected/bullet_tall.png
+test/expected/bullet_wide.png
+test/expected/discrete.png
+test/expected/discrete_wide.png
+test/expected/error.png
+test/expected/labeled_area.png
+test/expected/labeled_bar.png
+test/expected/labeled_discrete.png
+test/expected/labeled_pie.png
+test/expected/labeled_smooth.png
+test/expected/labeled_whisker_decimals.png
+test/expected/pie.png
+test/expected/pie0.png
+test/expected/pie1.png
+test/expected/pie100.png
+test/expected/pie45.png
+test/expected/pie95.png
+test/expected/pie99.png
+test/expected/pie_flat.png
+test/expected/pie_large.png
+test/expected/smooth.png
+test/expected/smooth_colored.png
+test/expected/smooth_similar_nonzero_values.png
+test/expected/smooth_underneath_color.png
+test/expected/standard_deviation.png
+test/expected/standard_deviation_short.png
+test/expected/standard_deviation_tall.png
+test/expected/whisker.png
+test/expected/whisker_junk.png
+test/expected/whisker_non_exceptional.png
 test/test_all.rb

data/Rakefile

@@ -11,7 +11,7 @@ Hoe.new('Sparklines', Sparklines::VERSION) do |p|
   p.email = 'boss@topfunky.com'
   p.summary = "Tiny graphs."
   p.url = "http://nubyonrails.com/pages/sparklines"
-  p.clean_globs = ['test/output'] # Remove this directory on "rake clean"
+  p.clean_globs = ['test/actual'] # Remove this directory on "rake clean"
   p.remote_rdoc_dir = '' # Release to root
   p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
   # * extra_deps - An array of rubygem dependencies.

data/lib/sparklines.rb

@@ -74,7 +74,7 @@ Licensed under the MIT license.
 =end
 class Sparklines
 
-  VERSION = '0.4.7'
+  VERSION = '0.4.8'
 
   @@label_margin = 5.0
   @@pointsize = 10.0
@@ -121,7 +121,7 @@ class Sparklines
 
       # Call the appropriate method for actual plotting.
       sparkline = self.new(data, options_sym)
-      if %w(area bar pie smooth discrete whisker).include? options_sym[:type]
+      if %w(area bar bullet pie smooth discrete whisker).include? options_sym[:type]
         sparkline.send options_sym[:type]
       else
         sparkline.plot_error options_sym
@@ -498,6 +498,43 @@ class Sparklines
     @canvas.to_blob
   end
 
+  def bullet
+    height = @options[:height].to_f
+    @graph_width  = @options.has_key?(:width) ? @options[:width].to_f : 100.0
+    background_color = '#eeeeee' # @options[:background_color]
+    @thickness = height/3.0
+
+    create_canvas(@graph_width, height, background_color)
+
+    @value = @norm_data
+    @good_value = @options[:good].to_f
+    
+    @graph_height = @options[:height]
+
+    qualitative_range_colors = ['#bbbbbb', '#999999']
+    [:satisfactory, :bad].each_with_index do |indicator, index|
+      next unless @options.has_key?(indicator)
+      @draw = @draw.fill(qualitative_range_colors[index])
+      indicator_width_x  = @graph_width * (@options[indicator].to_f / @good_value)
+      @draw = @draw.rectangle(0, 0, indicator_width_x.to_i, @graph_height)
+    end
+
+    if @options.has_key?(:target)
+      @draw = @draw.fill 'black'
+      target_x = @graph_width * (@options[:target].to_f / @good_value)
+      half_thickness = (@thickness / 2.0).to_i
+      bar_width = 1.0
+      @draw = @draw.rectangle(target_x.to_i, half_thickness, (target_x + bar_width).to_i, @thickness * 2 + half_thickness)
+    end
+
+    # Value
+    @draw = @draw.fill 'black'
+    @draw = @draw.rectangle(0, @thickness.to_i, @graph_width * (@data.first.to_f / @good_value), (@thickness * 2.0).to_i)
+
+    @draw.draw(@canvas)
+    @canvas.to_blob
+  end
+
   ##
   # Draw the error Sparkline.
 
@@ -517,7 +554,10 @@ class Sparklines
   def normalize_data
     @minimum_value = @data.min
     @maximum_value = @data.max
-    if @options[:type].to_s == 'pie'
+    case @options[:type].to_s
+    when 'pie'
+      @norm_data = @data
+    when 'bullet'
       @norm_data = @data
     else
       @norm_data = @data.map do |value|
@@ -661,5 +701,4 @@ class Sparklines
     Math.sqrt(variance(population))
   end
 
-
 end

data/test/test_all.rb

@@ -3,11 +3,13 @@
 require 'test/unit'
 require 'lib/sparklines'
 require 'fileutils'
+require 'tidy_table'
+require 'dust'
 
 class SparklinesTest < Test::Unit::TestCase
 
   def setup
-    @output_dir = "test/output"
+    @output_dir = "test/actual"
     FileUtils.mkdir_p(@output_dir)
 
     @data = %w( 1 5 15 20 30 50 57 58 55 48
@@ -16,6 +18,49 @@ class SparklinesTest < Test::Unit::TestCase
     115 120 130 140 150 160 170 100 100 10).map {|i| i.to_f}
   end
 
+  test "basic bullet" do
+    Sparklines.plot_to_file("#{@output_dir}/bullet_basic.png", 85, {
+      :type => "bullet",
+      :target => 80,
+      :good => 100,
+      :height => 15
+    })
+  end
+
+  test "full-featured bullet" do
+    Sparklines.plot_to_file("#{@output_dir}/bullet_full_featured.png", 85, {
+      :type => "bullet",
+      :target => 90,
+      :bad => 60,
+      :satisfactory => 80,
+      :good => 100,
+      :height => 15
+    })
+  end
+
+  test "tall bullet" do
+    Sparklines.plot_to_file("#{@output_dir}/bullet_tall.png", 85, {
+      :type => "bullet",
+      :target => 90,
+      :bad => 60,
+      :satisfactory => 80,
+      :good => 100,
+      :height => 30
+    })
+  end
+
+  test "wide bullet" do
+    Sparklines.plot_to_file("#{@output_dir}/bullet_wide.png", 85, {
+      :type => "bullet",
+      :target => 90,
+      :bad => 60,
+      :satisfactory => 80,
+      :good => 100,
+      :height => 15,
+      :width => 200
+    })
+  end
+
   def test_each_graph
     %w{pie area discrete smooth bar}.each do |type|
       quick_graph("#{type}", :type => type)
@@ -150,7 +195,7 @@ class SparklinesTest < Test::Unit::TestCase
   end
 
   def test_close_values
-    Sparklines.plot_to_file("#{@output_dir}/smooth_close_values.png", [100, 90, 95, 99, 80, 90], {
+    Sparklines.plot_to_file("#{@output_dir}/smooth_similar_nonzero_values.png", [100, 90, 95, 99, 80, 90], {
       :type => 'smooth',
       :line_color => "#6699cc",
       :underneath_color => "#ebf3f6"
@@ -198,3 +243,29 @@ class SparklinesTest < Test::Unit::TestCase
   end
 
 end
+
+# HACK Make reference HTML file for viewing output
+END {
+  def image_tag(image_path)
+    %(<img src="#{image_path}" />)
+  end
+
+  reference_files = Dir['test/expected/*']
+  output = TidyTable.new(reference_files).to_html(%w(Expected Actual)) do |record|
+    [image_tag("../../" + record), image_tag("../../" + record.gsub('expected', 'actual'))]
+  end
+  FileUtils.mkdir_p("test/actual")
+  File.open("test/actual/result.html", "w") do |f|
+    f.write <<-EOL
+    <style>
+    .first_column {
+      text-align: right;
+    }
+    .last_column {
+      text-align: left;
+    }
+    </style>
+    EOL
+    f.write output
+  end
+}

metadata

@@ -1,33 +1,34 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: sparklines
 version: !ruby/object:Gem::Version 
-  version: 0.4.7
-date: 2007-12-05 00:00:00 -08:00
-summary: Tiny graphs.
-require_paths: 
-- lib
-email: boss@topfunky.com
-homepage: http://nubyonrails.com/pages/sparklines
-rubyforge_project: sparklines
-description: Tiny graphs.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
-platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
+  version: 0.4.8
+platform: ""
 authors: 
 - Geoffrey Grosenbach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-18 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: Tiny graphs.
+email: boss@topfunky.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
 files: 
 - CHANGELOG
 - MIT-LICENSE
@@ -49,27 +50,73 @@ files:
 - samples/pie99.png
 - samples/smooth-colored.png
 - samples/smooth.png
+- test/expected/area.png
+- test/expected/area_high.png
+- test/expected/area_min_max.png
+- test/expected/bar.png
+- test/expected/bar_extreme_values.png
+- test/expected/bar_string.png.png
+- test/expected/bar_tall.png
+- test/expected/bar_wide.png
+- test/expected/bullet_basic.png
+- test/expected/bullet_full_featured.png
+- test/expected/bullet_tall.png
+- test/expected/bullet_wide.png
+- test/expected/discrete.png
+- test/expected/discrete_wide.png
+- test/expected/error.png
+- test/expected/labeled_area.png
+- test/expected/labeled_bar.png
+- test/expected/labeled_discrete.png
+- test/expected/labeled_pie.png
+- test/expected/labeled_smooth.png
+- test/expected/labeled_whisker_decimals.png
+- test/expected/pie.png
+- test/expected/pie0.png
+- test/expected/pie1.png
+- test/expected/pie100.png
+- test/expected/pie45.png
+- test/expected/pie95.png
+- test/expected/pie99.png
+- test/expected/pie_flat.png
+- test/expected/pie_large.png
+- test/expected/smooth.png
+- test/expected/smooth_colored.png
+- test/expected/smooth_similar_nonzero_values.png
+- test/expected/smooth_underneath_color.png
+- test/expected/standard_deviation.png
+- test/expected/standard_deviation_short.png
+- test/expected/standard_deviation_tall.png
+- test/expected/whisker.png
+- test/expected/whisker_junk.png
+- test/expected/whisker_non_exceptional.png
 - test/test_all.rb
-test_files: 
-- test/test_all.rb
+has_rdoc: true
+homepage: http://nubyonrails.com/pages/sparklines
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- Manifest.txt
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.3.0
-    version: 
+rubyforge_project: sparklines
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: Tiny graphs.
+test_files: 
+- test/test_all.rb