sparklines 0.4.0 → 0.4.1

data/CHANGELOG

@@ -1,4 +1,11 @@
 
+0.4.1
+
+* Converted to Hoe for rakefile
+* Added whisker graph [Luke Francl]
+* General cleanup and bug fixes
+* Experimental label option
+
 0.3.0
 
 * Changed to a Class for maintainability

data/Manifest.txt

@@ -0,0 +1,7 @@
+Rakefile
+Manifest.txt
+README
+CHANGELOG
+lib/sparklines.rb
+test/test_all.rb
+test/output

data/Rakefile

@@ -0,0 +1,17 @@
+
+require 'rubygems'
+require 'hoe'
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'sparklines'
+
+Hoe.new('Sparklines', Sparklines::VERSION) do |p|
+  p.name = "sparklines"
+  p.author = "Geoffrey Grosenbach"
+  p.description = "Tiny graphs."
+  p.email = 'boss@topfunky.com'
+  p.summary = "Tiny graphs."
+  p.url = "http://nubyonrails.com/pages/sparklines"
+  p.clean_globs = ['test/output/*']
+
+  # * extra_deps - An array of rubygem dependencies.
+end

data/lib/sparklines.rb

@@ -1,7 +1,6 @@
 
 require 'rubygems'
 require 'RMagick'
-require 'mathn'
 
 =begin rdoc
 
@@ -56,6 +55,7 @@ Graph types:
  pie
  smooth
  bar
+ whisker
 
 General Defaults:
 
@@ -74,7 +74,7 @@ Licensed under the MIT license.
 =end
 class Sparklines
 
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 
   @@label_margin = 5.0
   @@pointsize = 10.0
@@ -109,7 +109,7 @@ class Sparklines
         :label => nil
       }
 
-      # Hack for HashWithIndifferentAccess
+      # HACK for HashWithIndifferentAccess
       options_sym = Hash.new
       options.keys.each do |key|
         options_sym[key.to_sym] = options[key]
@@ -119,7 +119,7 @@ class Sparklines
     	
       # Call the appropriate method for actual plotting.
       sparkline = self.new(data, options_sym)
-      if %w(area bar pie smooth discrete).include? options_sym[:type]
+      if %w(area bar pie smooth discrete whisker).include? options_sym[:type]
         sparkline.send options_sym[:type]
       else
         sparkline.plot_error options_sym
@@ -133,7 +133,7 @@ class Sparklines
       end
     end
 
-  end
+  end # class methods
 
   def initialize(data=[], options={})
     @data = Array(data)
@@ -141,6 +141,7 @@ class Sparklines
     normalize_data
   end
 
+  ##
   # Creates a continuous area sparkline. Relevant options.
   #
   # :step - An integer that determines the distance between each point on the sparkline.  Defaults to 2.
@@ -164,6 +165,7 @@ class Sparklines
   # :above_color - A string or color code representing the color to draw values above or equal the upper value.  Defaults to red.
   #
   # :below_color - A string or color code representing the color to draw values below the upper value. Defaults to gray.
+
   def area
 
     step = @options[:step].to_i
@@ -231,9 +233,9 @@ class Sparklines
     @canvas.to_blob
   end
 
+  ##
+  # A bar graph.
 
-  # Draws a bar graph.
-  #
   def bar
     step = @options[:step].to_i
     height = @options[:height].to_f
@@ -260,6 +262,7 @@ class Sparklines
   end
 
 
+  ##
   # Creates a discretized sparkline
   #
   # :height - An integer that determines what the height of the sparkline will be.  Defaults to 14
@@ -269,6 +272,7 @@ class Sparklines
   # :above_color - A string or color code representing the color to draw values above or equal the upper value.  Defaults to red.
   #
   # :below_color - A string or color code representing the color to draw values below the upper value. Defaults to gray.
+
   def discrete
 
     height = @options[:height].to_i
@@ -295,6 +299,7 @@ class Sparklines
   end
 
 
+  ##
   # Creates a pie-chart sparkline
   #
   # :diameter - An integer that determines what the size of the sparkline will be.  Defaults to 20
@@ -302,8 +307,8 @@ class Sparklines
   # :share_color - A string or color code representing the color to draw the share of the pie represented by percent.  Defaults to red.
   #
   # :remain_color - A string or color code representing the color to draw the pie not taken by the share color. Defaults to lightgrey.
-  def pie
 
+  def pie
     diameter = @options[:diameter].to_i
     background_color = @options[:background_color]
 
@@ -362,6 +367,7 @@ class Sparklines
   end
 
 
+  ##
   # Creates a smooth sparkline.
   #
   # :step - An integer that determines the distance between each point on the sparkline.  Defaults to 2.
@@ -379,6 +385,7 @@ class Sparklines
   # :max_color - A string or color code representing the color that the dot drawn at the largest value will be displayed as.  Defaults to green.
   #
   # :last_color - A string or color code representing the color that the dot drawn at the last value will be displayed as.  Defaults to red.
+
   def smooth
 
     step = @options[:step].to_i
@@ -416,7 +423,65 @@ class Sparklines
   end
 
 
+  ##
+  # Creates a whisker sparkline to track on/off type data. There are five states: 
+  # on, off, no value, exceptional on, exceptional off. On values create an up 
+  # whisker and off values create a down whisker. Exceptional values may be 
+  # colored differently than regular values to indicate, for example, a shut out.
+  # No value produces an empty row to indicate a tie.
+  # 
+  # * results - an array of integer values between -2 and 2. -2 is exceptional 
+  #   down, 1 is regular down, 0 is no value, 1 is up, and 2 is exceptional up.
+  # * options - a hash that takes parameters
+  #
+  # :height - height of the sparkline
+  #
+  # :whisker_color - the color of regular whiskers; defaults to black
+  #
+  # :exception_color - the color of exceptional whiskers; defaults to red
+  
+  def whisker
+
+    # step = @options[:step].to_i
+    height = @options[:height].to_i
+    background_color = @options[:background_color]
+
+    create_canvas((@data.size - 1) * 2, height, background_color)
+    
+    whisker_color = @options[:whisker_color] || 'black'
+    exception_color = @options[:exception_color] || 'red'
+
+    i = 0
+    @data.each do |r|
+      color = whisker_color
+
+      if ( (r == 2 || r == -2) && exception_color )
+        color = exception_color
+      end
+
+      y_mid_point = (r >= 1) ? (@canvas.rows/2.0 - 1).ceil : (@canvas.rows/2.0).floor
+
+      y_end_point = y_mid_point
+      if ( r > 0) 
+        y_end_point = 0
+      end
+
+      if ( r < 0 )
+        y_end_point = @canvas.rows
+      end
+
+      @draw.stroke( color )
+      @draw.line( i, y_mid_point, i, y_end_point )
+      i += 2
+    end
+
+    @draw.draw(@canvas)
+    @canvas.to_blob 
+  end
+
+  ##
   # Draw the error Sparkline.
+
   def plot_error(options={})
     create_canvas(40, 15, 'white')
 
@@ -439,23 +504,27 @@ private
     end
   end
 
-  # * arr - an array of points (represented as two element arrays)
+  ##
+  # * :arr - an array of points (represented as two element arrays)
+  
   def open_ended_polyline(arr)
     0.upto(arr.length - 2) { |i|
       @draw.line(arr[i][0], arr[i][1], arr[i+1][0], arr[i+1][1])
     }
   end
 
+  ##
   # Create an image to draw on and a drawable to do the drawing with.
   #
-  # TODO Refactor into smaller functions
+  # TODO Refactor into smaller methods
+
   def create_canvas(w, h, bkg_col)
     @draw = Magick::Draw.new
     @draw.pointsize = @@pointsize # TODO Use height
     @canvas = Magick::Image.new(w , h) { self.background_color = bkg_col }
-    
+
     # Make room for label and last value
-    if !@options[:label].nil?
+    unless @options[:label].nil?
       @options[:has_last] = true
       @label_width = calculate_width(@options[:label])
       @data_last_width = calculate_width(@data.last)
@@ -463,19 +532,19 @@ private
       @label_and_data_last_width = @label_width + @data_last_width + @@label_margin * 7.0
       w += @label_and_data_last_width
     end
-    
+
     @canvas = Magick::Image.new(w , h) { self.background_color = bkg_col }
     @canvas.format = "PNG"
-    
+
     # Draw label and last value
-    if !@options[:label].nil?
+    unless @options[:label].nil?
       if ENV.has_key?('MAGICK_FONT_PATH')
         vera_font_path = File.expand_path('Vera.ttf', ENV['MAGICK_FONT_PATH'])
         @font = File.exists?(vera_font_path) ? vera_font_path : nil
       else
         @font = nil
       end
-      
+
       @draw.fill = 'black'
       @draw.font = @font if @font
       @draw.gravity = Magick::WestGravity
@@ -483,7 +552,7 @@ private
                       @label_width, 1.0,
                       w - @label_and_data_last_width + @@label_margin, h - calculate_caps_height/2.0,
                       @options[:label])
-                      
+
       @draw.fill = 'red'
       @draw.annotate( @canvas, 
                       @data_last_width, 1.0,
@@ -491,9 +560,11 @@ private
                       @data.last.to_s)
     end
   end
-  
+
+  ##
   # Utility to draw a coloured box
   # Centred on pt, offset off in each direction, fill color is col
+
   def drawbox(pt, offset, color)
     @draw.stroke 'transparent'
     @draw.fill(color)
@@ -508,5 +579,4 @@ private
     @draw.get_type_metrics(@canvas, 'X').height
   end
 
-
 end

data/test/{all_test.rb → test_all.rb}

@@ -21,10 +21,29 @@ class SparklinesTest < Test::Unit::TestCase
 
   def test_each_graph_with_label
     %w{pie area discrete smooth bar}.each do |type|
-    	quick_graph("labeled_#{type}", :type => type, :label => 'Comments for you')
+    	quick_graph("labeled_#{type}", :type => type, :label => 'Glucose')
     end
   end
 
+  def test_whisker_random
+    # Need data ranging from -2 to +2
+    @data = (1..40).map { |i| rand(3) * (rand(2) == 1 ? -1 : 1) }
+    quick_graph("whisker", :type => 'whisker')
+  end
+
+  def test_whisker_non_exceptional
+    @data = [1,1,1,1,1,1,1,1,1,1,1,1,1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1]
+    quick_graph("whisker_non_exceptional", :type => 'whisker')
+  end
+
+  ##
+  # Send random values in the range (-9..9)
+  
+  def test_whisker_junk
+    @data = (1..40).map { |i| rand(10) * (rand(2) == 1 ? -1 : 1) }
+    quick_graph("whisker_junk", :type => 'whisker')
+  end
+
   def test_pie
     # Test extremes which previously did not work right
     [0, 1, 45, 95, 99, 100].each do |value|

metadata

@@ -1,18 +1,19 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: sparklines
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2006-07-31 00:00:00 -07:00
-summary: Tiny graphs for concise data.
+  version: 0.4.1
+date: 2006-10-20 00:00:00 -07:00
+summary: Tiny graphs.
 require_paths: 
 - lib
+- test
 email: boss@topfunky.com
-homepage: http://www.topfunky.com
+homepage: http://nubyonrails.com/pages/sparklines
 rubyforge_project: sparklines
-description: Make tiny graphs for use on websites or documents.
-autorequire: gruff
+description: Tiny graphs.
+autorequire: 
 default_executable: 
 bindir: bin
 has_rdoc: true
@@ -25,18 +26,19 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Geoffrey Grosenbach
 files: 
-- rakefile
+- Rakefile
+- Manifest.txt
 - README
 - CHANGELOG
-- MIT-LICENSE
 - lib/sparklines.rb
-- test/all_test.rb
+- test/test_all.rb
 - test/output
-test_files: []
-
+test_files: 
+- test/test_all.rb
 rdoc_options: []
 
 extra_rdoc_files: []
@@ -45,7 +47,15 @@ executables: []
 
 extensions: []
 
-requirements: 
-- none
-dependencies: []
+requirements: []
 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 

data/MIT-LICENSE

@@ -1,21 +0,0 @@
-Copyright (c) 2005 Geoffrey Grosenbach boss@topfunky.com
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

data/rakefile

@@ -1,213 +0,0 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/contrib/rubyforgepublisher'
-
-$:.unshift(File.dirname(__FILE__) + "/lib")
-require 'sparklines'
-
-PKG_NAME      = 'sparklines'
-PKG_VERSION   = Sparklines::VERSION
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-
-RELEASE_NAME  = "REL #{PKG_VERSION}"
-
-RUBY_FORGE_PROJECT = "sparklines"
-RUBY_FORGE_USER    = "topfunky"
-
-desc "Default Task"
-task :default => [ :clean, :test ]
-
-desc "Clean images generated by tests"
-task :clean do
-  rm FileList['test/output/*.png']
-  rm_rf "pkg"
-end
-
-# Build a graphic file by running a single test.
-#
-#   rake bar_extreme_values.png
-#   => Runs test_extreme_values
-
-rule ".png" do |t|
-  test_name = t.name.gsub(/\.png/, '')
-  Rake::Task[:clean].invoke
-  sh "ruby -Ilib:test test/all_test.rb -n /^test_#{test_name}/"
-end
-
-# Run the unit tests
-Rake::TestTask.new { |t|
-  t.libs << "test"
-  t.pattern = 'test/*_test.rb'
-  t.verbose = true
-}
-
-
-# Genereate the RDoc documentation
-Rake::RDocTask.new { |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title    = "Sparklines -- Tiny graphs"
-  rdoc.options << '--line-numbers --inline-source --main README --accessor adv_attr_accessor=M'
-  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
-  rdoc.rdoc_files.include('README', 'CHANGELOG')
-  rdoc.rdoc_files.include('lib/sparklines.rb')
-  rdoc.rdoc_files.include('lib/sparklines/*.rb')
-}
-
-
-# Create compressed packages
-spec = Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.name = PKG_NAME
-  s.summary = "Tiny graphs for concise data."
-  s.description = %q{Make tiny graphs for use on websites or documents.}
-  s.version = PKG_VERSION
-
-  s.author = "Geoffrey Grosenbach"
-  s.email = "boss@topfunky.com"
-  s.rubyforge_project = RUBY_FORGE_PROJECT
-  s.homepage = "http://www.topfunky.com"
-
-  s.has_rdoc = true
-  s.requirements << 'none'
-  s.require_path = 'lib'
-  s.autorequire = 'gruff'
-
-  s.files = [ "rakefile", "README", "CHANGELOG", "MIT-LICENSE" ]
-  s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
-  s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "\.svn" ) || item.include?("\.png") }
-end
-  
-Rake::GemPackageTask.new(spec) do |p|
-  p.gem_spec = spec
-  p.need_tar = true
-  p.need_zip = true
-end
-
-desc "Hackish copy to sparklines plugin for Rails"
-task :update_plugin do
-  cp "lib/sparklines.rb", "../plugins/sparklines/lib/sparklines.rb"
-end
-
-desc "Publish the API documentation"
-task :pgem => [:package] do 
-  Rake::SshFilePublisher.new("boss@topfunky.com", "public_html/gems/gems", "pkg", "#{PKG_FILE_NAME}.gem").upload
-end
-
-desc "Publish the release files to RubyForge."
-task :release => [:package] do
-  files = ["gem", "tgz", "zip"].map { |ext| "pkg/#{PKG_FILE_NAME}.#{ext}" }
-
-  if RUBY_FORGE_PROJECT then
-    require 'net/http'
-    require 'open-uri'
-
-    project_uri = "http://rubyforge.org/projects/#{RUBY_FORGE_PROJECT}/"
-    project_data = open(project_uri) { |data| data.read }
-    group_id = project_data[/[?&]group_id=(\d+)/, 1]
-    raise "Couldn't get group id" unless group_id
-
-    # This echos password to shell which is a bit sucky
-    if ENV["RUBY_FORGE_PASSWORD"]
-      password = ENV["RUBY_FORGE_PASSWORD"]
-    else
-      print "#{RUBY_FORGE_USER}@rubyforge.org's password: "
-      password = STDIN.gets.chomp
-    end
-
-    login_response = Net::HTTP.start("rubyforge.org", 80) do |http|
-      data = [
-        "login=1",
-        "form_loginname=#{RUBY_FORGE_USER}",
-        "form_pw=#{password}"
-      ].join("&")
-      http.post("/account/login.php", data)
-    end
-
-    cookie = login_response["set-cookie"]
-    raise "Login failed" unless cookie
-    headers = { "Cookie" => cookie }
-
-    release_uri = "http://rubyforge.org/frs/admin/?group_id=#{group_id}"
-    release_data = open(release_uri, headers) { |data| data.read }
-    package_id = release_data[/[?&]package_id=(\d+)/, 1]
-    raise "Couldn't get package id" unless package_id
-
-    first_file = true
-    release_id = ""
-
-    files.each do |filename|
-      basename  = File.basename(filename)
-      file_ext  = File.extname(filename)
-      file_data = File.open(filename, "rb") { |file| file.read }
-
-      puts "Releasing #{basename}..."
-
-      release_response = Net::HTTP.start("rubyforge.org", 80) do |http|
-        release_date = Time.now.strftime("%Y-%m-%d %H:%M")
-        type_map = {
-          ".zip"    => "3000",
-          ".tgz"    => "3110",
-          ".gz"     => "3110",
-          ".gem"    => "1400"
-        }; type_map.default = "9999"
-        type = type_map[file_ext]
-        boundary = "rubyqMY6QN9bp6e4kS21H4y0zxcvoor"
-
-        query_hash = if first_file then
-          {
-            "group_id" => group_id,
-            "package_id" => package_id,
-            "release_name" => RELEASE_NAME,
-            "release_date" => release_date,
-            "type_id" => type,
-            "processor_id" => "8000", # Any
-            "release_notes" => "",
-            "release_changes" => "",
-            "preformatted" => "1",
-            "submit" => "1"
-          }
-        else
-          {
-            "group_id" => group_id,
-            "release_id" => release_id,
-            "package_id" => package_id,
-            "step2" => "1",
-            "type_id" => type,
-            "processor_id" => "8000", # Any
-            "submit" => "Add This File"
-          }
-        end
-
-        query = "?" + query_hash.map do |(name, value)|
-          [name, URI.encode(value)].join("=")
-        end.join("&")
-
-        data = [
-          "--" + boundary,
-          "Content-Disposition: form-data; name=\"userfile\"; filename=\"#{basename}\"",
-          "Content-Type: application/octet-stream",
-          "Content-Transfer-Encoding: binary",
-          "", file_data, ""
-          ].join("\x0D\x0A")
-
-        release_headers = headers.merge(
-          "Content-Type" => "multipart/form-data; boundary=#{boundary}"
-        )
-
-        target = first_file ? "/frs/admin/qrs.php" : "/frs/admin/editrelease.php"
-        http.post(target + query, data, release_headers)
-      end
-
-      if first_file then
-        release_id = release_response.body[/release_id=(\d+)/, 1]
-        raise("Couldn't get release id") unless release_id
-      end
-
-      first_file = false
-    end
-  end
-end