scruffy 0.2.2 → 0.2.3

data/spec/scruffy/graph_spec.rb

@@ -0,0 +1,175 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'scruffy'
+require 'fileutils'
+
+module CustomRenderers
+  def blank_renderer
+    object = Object.new
+    object.instance_eval { class << self;self;end }.instance_eval { define_method :render do |options|
+        puts "Rendering"
+      end
+    }
+    object
+  end
+end
+
+describe "A new Scruffy::Graph" do
+  include CustomRenderers
+  
+  setup do
+    @graph = Scruffy::Graph.new
+  end
+  
+  it "should have a blank title" do
+    @graph.title.should be_nil
+  end
+  
+  it "should be set to the keynote theme" do
+    @graph.theme.class.should equal(Scruffy::Themes::Keynote)
+  end
+  
+  it "should have zero layers" do
+    @graph.layers.should be_empty
+  end
+  
+  it "should not have a default layer type" do
+    @graph.default_type.should be_nil
+  end
+  
+  it "should not have any point markers (x-axis values)" do
+    @graph.point_markers.should be_nil
+  end
+  
+  it "should format values as numbers by default" do
+    @graph.value_formatter.should be_instance_of(Scruffy::Formatters::Number)
+  end
+  
+  it "should use a StandardRenderer" do
+    @graph.renderer.should_be be_instance_of(Scruffy::Renderers::Standard)
+  end
+  
+  it "should accept a new title" do
+    @graph.title = "New Title"
+    @graph.title.should == "New Title"
+  end
+  
+  it "should accept a new theme" do
+    @graph.theme = Scruffy::Themes::Mephisto
+    @graph.theme.should equal(Scruffy::Themes::Mephisto)
+  end
+  
+  it "should accept a new default type" do
+    @graph.default_type = :line
+    @graph.default_type.should equal(:line)
+  end
+  
+  it "should accept new point markers" do
+    markers = ['Jan', 'Feb', 'Mar']
+    @graph.point_markers = markers
+    @graph.point_markers.should equal(markers)
+  end
+  
+  it "should accept a new renderer" do
+    renderer = blank_renderer
+    @graph.renderer = renderer
+    @graph.renderer.should equal(renderer)
+  end
+  
+  it "should not accept renderers with missing #render methods" do
+      lambda { @graph.renderer = 1 }.should raise_error(ArgumentError)
+  end
+end
+
+describe "A Scruffy::Graph's initialization block" do
+  include CustomRenderers
+  
+  it "should accept just a default_type Symbol" do
+    lambda { Scruffy::Graph.new(:line) }.should_not raise_error
+  end
+  
+  it "should accept just an options hash" do
+    lambda { Scruffy::Graph.new({:title => "My Title"}) }.should_not raise_error
+    lambda { Scruffy::Graph.new(:title => "My Title", :theme => Scruffy::Themes::Keynote) }.should_not raise_error
+  end
+  
+  it "should accept both a default_type and options hash" do
+    lambda {
+      Scruffy::Graph.new(:line, {:title => "My Title"})
+      Scruffy::Graph.new(:line, :title => "My Title")
+    }.should_not raise_error
+  end
+  
+  it "should reject any invalid argument combination" do
+    lambda { Scruffy::Graph.new({:title => "My Title"}, :line) }.should raise_error(ArgumentError)
+    lambda { Scruffy::Graph.new(:line, {:title => "My Title"}, "Any additional arguments.") }.should raise_error(ArgumentError)
+    lambda { Scruffy::Graph.new(:line, "Any additional arguments.") }.should raise_error(ArgumentError)
+  end
+  
+  it "should reject any options that are not supported" do
+    lambda { Scruffy::Graph.new(:title => "My Title", :some_key => "Some Value") }.should raise_error(ArgumentError)
+  end
+  
+  it "should successfully save all valid options" do
+      options = {:title => "My Title",
+                 :theme => {:background => [:black], 
+                            :colors => [:red => 'red', :yellow => 'yellow']},
+                 :layers => [ Scruffy::Layers::Line.new(:points => [100, 200, 300]) ],
+                 :default_type => :average,
+                 :value_formatter => Scruffy::Formatters::Currency.new,
+                 :point_markers => ['One Hundred', 'Two Hundred', 'Three Hundred']}
+                 
+      @graph = Scruffy::Graph.new(options)
+
+      @graph.title.should == options[:title]
+      @graph.theme.should == options[:theme]
+      @graph.layers.should == options[:layers]
+      @graph.default_type.should == options[:default_type]
+      @graph.value_formatter.should == options[:value_formatter]
+      @graph.point_markers.should == options[:point_markers]
+  end
+end
+
+
+context "A fully populated Graph" do
+  setup do
+    FileUtils.rm_f File.dirname(__FILE__) + '/*.png'
+    FileUtils.rm_f File.dirname(__FILE__) + '/*.jpg'
+
+    @graph = Scruffy::Graph.new :title => 'Test Graph'
+    @graph << Scruffy::Layers::Average.new(:title => 'Average', :points => @graph.layers)    
+    @graph.layers.first.relevant_data = false
+    @graph << Scruffy::Layers::AllSmiles.new(:title => 'Smiles', :points => [100, 200, 300])
+    @graph << Scruffy::Layers::Area.new(:title => 'Area', :points => [100, 200, 300])
+    @graph << Scruffy::Layers::Bar.new(:title => 'Bar', :points => [100, 200, 300])
+    @graph << Scruffy::Layers::Line.new(:title => 'Line', :points => [100, 200, 300])
+  end
+  
+  it "should render to SVG" do
+    @graph.render(:width => 800).should be_instance_of(String)
+  end
+  
+  it "should rasterize to PNG" do
+    lambda {
+      #@graph.render(:width => 800, :as => 'PNG', :to => outfile('test_graph.png'))
+    }.should_not raise_error
+  end
+
+  it "should rasterize to JPG" do
+    lambda {
+      #@graph.render(:width => 800, :as => 'JPG', :to => outfile('test_graph.jpg'))
+    }.should_not raise_error
+  end
+end
+
+
+context "A graph with hash data" do
+  specify "should render identically to a graph with array data" do
+    @hashgraph = Scruffy::Graph.new :title => 'Graph'
+    @hashgraph.add(:line, 'Data', { 0 => 1, 1 => 2, 3 => 4 })
+    
+    @arraygraph = Scruffy::Graph.new :title => 'Graph'
+    @arraygraph.add(:line, 'Data', [1, 2, nil, 4])
+    
+    @hashgraph.render(:to => outfile('hash.svg')).should == @arraygraph.render(:to => outfile('array.svg'))
+  end
+end

data/spec/scruffy/layers/base_spec.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+require 'scruffy'
+  
+context "Any layer" do
+  specify "should accept but ignore nil data" do
+    render([100, nil, 300]).should eql([[0.0, 400], [400.0, 0.0]])
+  end
+  
+  specify "should accept hash data as sequentially-keyed data" do
+    render([100, nil, 300]).should eql([[0.0, 400], [400.0, 0.0]])
+    render({0 => 100, 2 => 300}).should eql([[0.0, 400], [400.0, 0.0]])
+  end
+  
+  def render points
+    layer = Scruffy::Layers::Base.new(:title => 'My base Layer', :points => points)
+      
+    #stub out draw to just return coords
+    class << layer; def draw(svg, coords, options={}); coords end; end;
+      
+    coords = []
+      
+    lambda {
+      size = [400,400]
+      coords = layer.render(Scruffy::Renderers::Base.new.render(:layers => [layer], :size => size), 
+                    :size => size, :min_value => 100, :max_value => 300)
+    }.should_not raise_error
+      
+    coords
+  end
+end

data/spec/{layers → scruffy/layers}/line_spec.rb

@@ -1,9 +1,10 @@
-context "A Line layer" do
+describe "A Line layer" do
   setup do
     @layer = Scruffy::Layers::Line.new(:title => 'My Line Layer', :points => [100, 200, 300])
     
     svg = mock('svg')
     svg.should_receive(:polyline).once
     svg.should_receive(:circle).exactly(3).times
+    
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+def outfile( name )
+  output_dir = File.join(File.dirname(__FILE__), "output")
+  
+  FileUtils.mkdir( output_dir ) unless File.exist?( output_dir )
+  File.join( output_dir, name )
+end

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -rlgoDCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/graph_creation_test.rb

@@ -0,0 +1,101 @@
+require 'test/unit'
+require 'scruffy'
+
+class SimpleTheme < Scruffy::Themes::Base
+  def initialize
+    super({
+        :background => [:white, :white],
+        :marker => :black,
+        :colors => %w(blue green red orange yellow purple pink),
+        :stroke_color => 'white'
+      })
+  end
+end
+
+class GraphCreationTest < Test::Unit::TestCase
+  BASE_DIR = File.dirname(__FILE__)
+  WEBSITE_DIR = BASE_DIR + "/../website/images/graphs"
+
+  def test_create_pie
+    graph = Scruffy::Graph.new
+    graph.title = "Favourite Snacks"
+    graph.renderer = Scruffy::Renderers::Pie.new
+
+    graph.add :pie, '', {
+      'Apple' => 20,
+      'Banana' => 100,
+      'Orange' => 70,
+      'Taco' => 30
+    }
+
+    graph.render :to => "#{WEBSITE_DIR}/pie_test.svg"
+    graph.render :width => 400, :to => "#{WEBSITE_DIR}/pie_test.png", :as => 'png'
+  end
+  
+  def test_create_line
+    graph = Scruffy::Graph.new
+    graph.title = "Sample Line Graph"
+    graph.renderer = Scruffy::Renderers::Standard.new
+
+    graph.add :line, 'Example', [20, 100, 70, 30, 106]
+
+    graph.render :to => "#{WEBSITE_DIR}/line_test.svg"
+    graph.render  :width => 400, :to => "#{WEBSITE_DIR}/line_test.png", :as => 'png'
+  end
+
+  
+  def test_create_bar
+    graph = Scruffy::Graph.new
+    graph.title = "Sample Bar Graph"
+    graph.renderer = Scruffy::Renderers::Standard.new
+    graph.add :bar, 'Example', [20, 100, 70, 30, 106]
+    graph.render :to => "#{WEBSITE_DIR}/bar_test.svg"
+    graph.render  :width => 400, :to => "#{WEBSITE_DIR}/bar_test.png", :as => 'png'
+  end
+  
+  def test_split
+    graph = Scruffy::Graph.new
+    graph.title = "Long-term Comparisons"
+    graph.value_formatter = Scruffy::Formatters::Currency.new(:special_negatives => true, :negative_color => '#ff7777')
+    graph.renderer = Scruffy::Renderers::Split.new(:split_label => 'Northeastern (Top) / Central (Bottom)')
+
+    graph.add :area, 'Jeff', [20, -5, 100, 70, 30, 106, 203, 100, 50, 203, 289, 20], :category => :top    
+    graph.add :area, 'Jerry', [-10, 70, 20, 102, 201, 26, 30, 106, 203, 100, 50, 39], :category => :top
+    graph.add :bar,  'Jack', [30, 0, 49, 29, 100, 203, 70, 20, 102, 201, 26, 130], :category => :bottom
+    graph.add :line, 'Brasten', [42, 10, 75, 150, 130, 70, -10, -20, 50, 92, -21, 19], :categories => [:top, :bottom]
+    graph.add :line, 'Jim', [-10, -20, 50, 92, -21, 56, 92, 84, 82, 100, 39, 120], :categories => [:top, :bottom]
+    graph.point_markers = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+    
+    graph.render :to => "#{WEBSITE_DIR}/split_test.svg"
+    graph.render  :width => 500, :to => "#{WEBSITE_DIR}/split_test.png", :as => 'png'
+  end
+  
+  def test_stacking
+    graph = Scruffy::Graph.new
+    graph.title = "Comparative Agent Performance"
+    graph.value_formatter = Scruffy::Formatters::Percentage.new(:precision => 0)
+    graph.add :stacked do |stacked|
+      stacked.add :bar, 'Jack', [30, 60, 49, 29, 100, 120]
+      stacked.add :bar, 'Jill', [120, 240, 0, 100, 140, 20]
+      stacked.add :bar, 'Hill', [10, 10, 90, 20, 40, 10]
+    end
+    graph.point_markers = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun']
+    graph.render :to => "#{WEBSITE_DIR}/stacking_test.svg"
+    graph.render  :width => 500, :to => "#{WEBSITE_DIR}/stacking_test.png", :as => 'png'
+  end
+  
+  def test_multi_layered
+    graph = Scruffy::Graph.new
+    graph.title = "Some Kind of Information"
+    graph.renderer = Scruffy::Renderers::Cubed.new
+
+    graph.add :area, 'Jeff', [20, -5, 100, 70, 30, 106], :categories => [:top_left, :bottom_right]    
+    graph.add :area, 'Jerry', [-10, 70, 20, 102, 201, 26], :categories => [:bottom_left, :buttom_right]
+    graph.add :bar,  'Jack', [30, 0, 49, 29, 100, 203], :categories => [:bottom_left, :top_right]
+    graph.add :line, 'Brasten', [42, 10, 75, 150, 130, 70], :categories => [:top_right, :bottom_left]
+    graph.add :line, 'Jim', [-10, -20, 50, 92, -21, 56], :categories => [:top_left, :bottom_right]
+    graph.point_markers = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun']
+    graph.render :to => "#{WEBSITE_DIR}/multi_test.svg"
+    graph.render  :width => 500, :to => "#{WEBSITE_DIR}/multi_test.png", :as => 'png'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/scruffy'

data/test/test_scruffy.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestScruffy < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/website/images/blank.gif.html

@@ -0,0 +1,7 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<html><head>
+<title>404 Not Found</title>
+</head><body>
+<h1>Not Found</h1>
+<p>The requested URL /images/blank.gif was not found on this server.</p>
+</body></html>

data/website/images/graphs/bar_test.svg

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"  type=""?>
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" width="600" height="360" xmlns="http://www.w3.org/2000/svg">
+  <g id="scruffy_graph">
+    <g transform="translate(0.0, 0.0)" id="background">
+      <defs>
+        <linearGradient x2="0%" y2="100%" x1="0%" id="BackgroundGradient" y1="0%">
+          <stop stop-color="black" offset="5%"/>
+          <stop stop-color="#4A465A" offset="95%"/>
+        </linearGradient>
+      </defs>
+      <rect width="600.0" x="0" y="0" height="360.0" fill="url(#BackgroundGradient)"/>
+    </g>
+    <g transform="translate(30.0, 7.2)" id="title">
+      <text class="title" font-size="25.2" x="270.0" text-anchor="middle" y="25.2" stroke="none" stroke-width="0" fill="white">Sample Bar Graph</text>
+    </g>
+    <g transform="translate(12.0, 93.6)" id="view">
+      <g>
+        <g transform="translate(0.0, 4.752)" id="values">
+          <text font-size="16.91712" x="96.12" text-anchor="end" y="211.464" fill="white">7</text>
+          <text font-size="16.91712" x="96.12" text-anchor="end" y="158.598" fill="white">32</text>
+          <text font-size="16.91712" x="96.12" text-anchor="end" y="105.732" fill="white">57</text>
+          <text font-size="16.91712" x="96.12" text-anchor="end" y="52.866" fill="white">81</text>
+          <text font-size="16.91712" x="96.12" text-anchor="end" y="0.0" fill="white">106</text>
+        </g>
+        <g transform="translate(106.8, 0.0)" id="grid">
+          <line x2="427.2" y2="0.0" x1="0" style="stroke: white; stroke-width: 2;" y1="0.0"/>
+          <line x2="427.2" y2="52.866" x1="0" style="stroke: white; stroke-width: 2;" y1="52.866"/>
+          <line x2="427.2" y2="105.732" x1="0" style="stroke: white; stroke-width: 2;" y1="105.732"/>
+          <line x2="427.2" y2="158.598" x1="0" style="stroke: white; stroke-width: 2;" y1="158.598"/>
+          <line x2="427.2" y2="211.464" x1="0" style="stroke: white; stroke-width: 2;" y1="211.464"/>
+        </g>
+        <g transform="translate(106.8, 218.592)" id="labels">
+        </g>
+        <g transform="translate(106.8, 0.0)" id="graphs">
+          <g class="graph_layer" id="component_graphs_graph_0">
+            <g transform="translate(-1.05732, -1.05732)">
+              <rect width="79.01064" x="4.272" y="183.881739130435" height="29.6969008695652" style="fill: black; fill-opacity: 0.15; stroke: none;"/>
+              <rect width="79.01064" x="5.32932" y="188.111019130435" height="26.5249408695652" style="fill: black; fill-opacity: 0.15; stroke: none;"/>
+            </g>
+            <rect width="76.896" x="4.272" y="183.881739130435" height="27.5822608695652" fill="#6886B4" style="opacity: 1.0; stroke: none;"/>
+            <g transform="translate(-1.05732, -1.05732)">
+              <rect width="79.01064" x="89.712" y="12.8289585439838" height="200.749681456016" style="fill: black; fill-opacity: 0.15; stroke: none;"/>
+              <rect width="79.01064" x="90.76932" y="17.0582385439838" height="197.577721456016" style="fill: black; fill-opacity: 0.15; stroke: none;"/>
+            </g>
+            <rect width="76.896" x="89.712" y="12.8289585439838" height="198.635041456016" fill="#6886B4" style="opacity: 1.0; stroke: none;"/>
+            <g transform="translate(-1.05732, -1.05732)">
+              <rect width="79.01064" x="175.152" y="76.973751263903" height="136.604888736097" style="fill: black; fill-opacity: 0.15; stroke: none;"/>
+              <rect width="79.01064" x="176.20932" y="81.203031263903" height="133.432928736097" style="fill: black; fill-opacity: 0.15; stroke: none;"/>
+            </g>
+            <rect width="76.896" x="175.152" y="76.973751263903" height="134.490248736097" fill="#6886B4" style="opacity: 1.0; stroke: none;"/>
+            <g transform="translate(-1.05732, -1.05732)">
+              <rect width="79.01064" x="260.592" y="162.500141557128" height="51.0784984428716" style="fill: black; fill-opacity: 0.15; stroke: none;"/>
+              <rect width="79.01064" x="261.64932" y="166.729421557128" height="47.9065384428716" style="fill: black; fill-opacity: 0.15; stroke: none;"/>
+            </g>
+            <rect width="76.896" x="260.592" y="162.500141557128" height="48.9638584428716" fill="#6886B4" style="opacity: 1.0; stroke: none;"/>
+            <g transform="translate(-1.05732, -1.05732)">
+              <rect width="79.01064" x="346.032" y="0.0" height="213.57864" style="fill: black; fill-opacity: 0.15; stroke: none;"/>
+              <rect width="79.01064" x="347.08932" y="4.22928" height="210.40668" style="fill: black; fill-opacity: 0.15; stroke: none;"/>
+            </g>
+            <rect width="76.896" x="346.032" y="0.0" height="211.464" fill="#6886B4" style="opacity: 1.0; stroke: none;"/>
+          </g>
+        </g>
+      </g>
+    </g>
+    <g transform="translate(30.0, 46.8)" id="legend">
+      <rect width="10.8" x="226.8" y="0" height="10.8" fill="#6886B4"/>
+      <text font-size="1.3824" x="228.528" y="1.0368" fill="white" style="color: white">Example</text>
+    </g>
+  </g>
+</svg>