bumpspark 1.0.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bruce Williams (and collaborators at RedHanded)
+
+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/README.markdown

@@ -0,0 +1,66 @@
+# Bumpspark
+
+Generate "bumpspark"-style sparklines from Ruby & Rails.
+
+Note: This library is based on _why's `bumpspark' code, originally discussed and
+collaborated on at [RedHanded] [1].  It has been refactored and built out as
+a gem suitable for inclusion in Rails projects (and standalone Ruby code).
+
+Bumpsparks are sparklines which show discrete data points and highlight 
+extremes.  If you like Tufte and _why, you'll probably like these.
+
+## Credits
+
+Thanks to the various collaborators on _why's original post:
+
+* _why (concept, BMP implementation)
+* jzp (png)
+* MenTaLguY (transparency)
+
+## Installation
+
+    sudo gem install bruce-bumpspark --source http://gems.github.com
+
+## Usage
+
+### From Rails
+
+1. Include the gem as a dependency in `config/environment.rb`
+       
+        config.gem 'bruce-bumpspark', :lib => 'bumpspark', :source => 'http://gems.github.com'
+       
+2. Use `bumpspark_tag` from your views or helpers, passing it the data points
+   you'd like graphed.
+
+        <%= bumpspark_tag [12, 34, 12, 42, 12, 23] %>
+    
+## From Ruby
+
+Simply create a `Bumpspark::Graph` instance and call `to_png` on it.
+
+    require 'bumpspark'
+    
+    graph = Bumpspark::Graph.new [12, 34, 12, 42, 12, 23]
+    
+    File.open('bumpspark.png', 'wb') do |file|
+      file.write graph.to_png
+    end
+
+## Note on Patches/Pull Requests
+ 
+Please check the TODO file for information on things that need doing. 
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009 Bruce Williams, et al. See LICENSE for details.
+
+[1]: http://redhanded.hobix.com/inspect/sparklinesForMinimalists.html

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bumpspark"
+    gem.summary = %Q{Generates "bumpspark"-style sparklines for Ruby & Rails}
+    gem.description = %Q{Generates transparent PNG "bumpspark"-style sparklines. Use from Ruby directly or as a Rails helper generating an image tag w/ built-in data, as conceived by whytheluckystiff.}
+    gem.email = "bruce@codefluency.com"
+    gem.homepage = "http://github.com/bruce/bumpspark"
+    gem.authors = ["Bruce Williams"]
+    # TESTING ONLY
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "activesupport"
+    gem.add_development_dependency "actionpack"
+    gem.add_development_dependency "rmagick"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bumpspark #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.markdown

@@ -0,0 +1,15 @@
+# Things to do
+
+## Useful
+
+* Configuration of colors
+* Support specific, value-based color thresholds
+
+## Pedantic
+
+* More advanced normalization rules
+
+## Please contribute
+
+* Support for different formats
+* More in-depth tests

data/VERSION

@@ -0,0 +1 @@
+1.0.4

data/bumpspark.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bumpspark}
+  s.version = "1.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bruce Williams"]
+  s.date = %q{2009-08-30}
+  s.description = %q{Generates transparent PNG "bumpspark"-style sparklines. Use from Ruby directly or as a Rails helper generating an image tag w/ built-in data, as conceived by whytheluckystiff.}
+  s.email = %q{bruce@codefluency.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "TODO.markdown",
+     "VERSION",
+     "bumpspark.gemspec",
+     "lib/bumpspark.rb",
+     "lib/bumpspark/formats/png.rb",
+     "lib/bumpspark/graph.rb",
+     "lib/bumpspark_helper.rb",
+     "rails/init.rb",
+     "test/bumpspark_helper_test.rb",
+     "test/bumpspark_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/bruce/bumpspark}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Generates "bumpspark"-style sparklines for Ruby & Rails}
+  s.test_files = [
+    "test/bumpspark_helper_test.rb",
+     "test/bumpspark_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<actionpack>, [">= 0"])
+      s.add_development_dependency(%q<rmagick>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<actionpack>, [">= 0"])
+      s.add_dependency(%q<rmagick>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<actionpack>, [">= 0"])
+    s.add_dependency(%q<rmagick>, [">= 0"])
+  end
+end

data/lib/bumpspark.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) << "/bumpspark/formats/png"
+require File.dirname(__FILE__) << "/bumpspark/graph"
+
+module Bumpspark
+  VERSION = File.read(File.dirname(__FILE__) << "/../VERSION").strip
+end

data/lib/bumpspark/formats/png.rb

@@ -0,0 +1,63 @@
+require 'zlib'
+
+module Bumpspark
+  
+  module Formats
+    
+    module PNG
+      
+      BLACK = [0,    0,    0]
+      RED   = [0xFF, 0,    0]
+      GREY  = [0x99, 0x99, 0x99]
+      
+      HEADER = [137, 80, 78, 71, 13, 10, 26, 10].pack("C*")
+    
+      # Generate a PNG
+      def to_png
+        generate_png
+      end
+  
+      private
+  
+      def rows
+        normalized_numbers.inject([]) { |ary, r|
+          ary << [BLACK] * 15 << [BLACK] * 15
+          ary.last[r / 9,4] = [(r > 50 and RED or GREY)] * 4
+          ary
+        }.transpose.reverse
+      end
+
+      def generate_png
+        raw_data = rows.map { |row| [0] + row }.flatten.pack("C*")
+        ihdr_data = [
+          rows.first.length,rows.length,
+          8,2,0,0,0
+        ].pack("NNCCCCC")
+        ihdr = chunk("IHDR", ihdr_data)
+        trns = chunk("tRNS", ([ 0 ]*6).pack("C6"))
+        idat = chunk("IDAT", Zlib::Deflate.deflate(raw_data))
+        iend = chunk("IEND", "")
+        HEADER + ihdr + trns + idat + iend
+      end
+  
+      def chunk(type, data)
+        to_check = type + data
+        [data.length].pack("N") + to_check + [Zlib.crc32(to_check)].pack("N")
+      end
+
+      def normalized_numbers
+        nums = numbers.empty? ? [0] : numbers
+        min, max = nums.min, nums.max
+        width = max - min
+        return [1] * nums.size if width == 0
+        width += (300 * 1000)
+        nums.map do |result|
+          ((result - min) * 100 / width.to_f).to_i
+        end
+      end
+    
+    end
+    
+  end
+  
+end

data/lib/bumpspark/graph.rb

@@ -0,0 +1,14 @@
+module Bumpspark
+  
+  class Graph
+    
+    include Formats::PNG
+
+    attr_reader :numbers
+    def initialize(numbers)
+      @numbers = numbers
+    end
+  
+  end
+
+end

data/lib/bumpspark_helper.rb

@@ -0,0 +1,19 @@
+require 'base64'
+
+module BumpsparkHelper
+  
+  # Generate a "bumpspark"-style sparkline image tag
+  #
+  # call-seq:
+  #   <%= bumpspark_tag([20, 23, 12, 23]) %>
+  def bumpspark_tag(numbers, html_opts={})
+    graph = Bumpspark::Graph.new(numbers)
+    tag(:img, html_opts.merge(:src => bumpspark_tag_src(graph)))
+  end
+  
+  def bumpspark_tag_src(graph) #:nodoc:
+    data = Base64.encode64(graph.to_png).delete("\n")
+    return "data:image/png;base64,#{CGI.escape(data)}" 
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1 @@
+ActionView::Base.send(:include, BumpsparkHelper)

data/test/bumpspark_helper_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+require 'activesupport'
+require 'action_view'
+require 'action_controller'
+
+require 'bumpspark_helper'
+
+BumpsparkHelper.send(:include, ActionView::Helpers::TagHelper)
+BumpsparkHelper.send(:include, ActionView::Helpers::AssetTagHelper)
+
+class BumpsparkHelperTest < Test::Unit::TestCase
+  
+  include BumpsparkHelper
+  include ActionView::Helpers::AssetTagHelper
+  
+  should "generate an image" do
+    tag = bumpspark_tag([1, 2, 3])
+    assert tag.include?('<img'), tag
+    assert tag.include?('src'), tag
+  end
+  
+end

data/test/bumpspark_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+require 'rmagick'
+
+class BumpsparkTest < Test::Unit::TestCase
+  
+  context "generating pngs" do
+    
+    should "work for an empty bumpspark" do
+      assert_valid_png []
+    end
+    
+    should "work for a bumpspark with one datapoint" do
+      assert_valid_png [1]      
+    end
+    
+    should "work for a bumpspark with multiple datapoints" do
+      assert_valid_png [1, 2, 3]
+    end
+    
+  end
+  
+  def assert_valid_png(data)
+    image = Magick::Image.from_blob(generate(data)).first
+    assert image, "No valid image generated"
+    assert_equal "image/png", image.mime_type, "Image has wrong mime type"
+  end
+  
+  def generate(data, format=:png)
+    Bumpspark::Graph.new(data).send("to_#{format}")
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'bumpspark'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: bumpspark
+version: !ruby/object:Gem::Version 
+  version: 1.0.4
+platform: ruby
+authors: 
+- Bruce Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Generates transparent PNG "bumpspark"-style sparklines. Use from Ruby directly or as a Rails helper generating an image tag w/ built-in data, as conceived by whytheluckystiff.
+email: bruce@codefluency.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- TODO.markdown
+- VERSION
+- bumpspark.gemspec
+- lib/bumpspark.rb
+- lib/bumpspark/formats/png.rb
+- lib/bumpspark/graph.rb
+- lib/bumpspark_helper.rb
+- rails/init.rb
+- test/bumpspark_helper_test.rb
+- test/bumpspark_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bruce/bumpspark
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: []
+
+rubyforge_project: 
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: Generates "bumpspark"-style sparklines for Ruby & Rails
+test_files: 
+- test/bumpspark_helper_test.rb
+- test/bumpspark_test.rb
+- test/test_helper.rb