srawlins-scruffy 0.2.9

data/lib/scruffy/themes.rb

@@ -0,0 +1,175 @@
+# ===Scruffy Themes
+#
+# Author:: Brasten Sager & A.J. Ostman
+# Date:: August 27th, 2006
+#
+# Scruffy Themes allow you to alter the colors and appearances of
+# your graph.
+module Scruffy::Themes
+  
+  # ==Scruffy::Themes::Base
+  #
+  # Author:: Brasten Sager & A.J. Ostman
+  # Date:: August 27th, 2006
+  #
+  # The base theme class.  Most themes can be constructed simply
+  # by instantiating a new Base object with a hash of color values.
+  #
+  # See Scruffy::Themes::Base#instantiate for examples.
+  class Base
+    attr_accessor :background     # Background color or array of two colors
+    attr_accessor :colors         # Array of colors for data graphs
+    attr_accessor :outlines       # Array of colors for outlines of elements for data graphs
+    attr_accessor :marker         # Marker color for grid lines, values, etc.
+    attr_accessor :font_family    # Font family: Not really supported.  Maybe in the future.
+    attr_accessor :marker_font_size    # Marker Font Size:
+    attr_accessor :title_font_size    # Title Font Size:
+    attr_accessor :legend_font_size    # Legend Font Size:
+
+    # Returns a new Scruffy::Themes::Base object.
+    #
+    # Hash options:
+    # background:: background color.
+    # colors:: an array of color values to use for graphs.
+    # marker:: color used for grid lines, values, data points, etc.
+    # font_family:: in general, allows you to change the font used in the graph.
+    #               This is not yet supported in most graph elements, 
+    #               and may be deprecated soon anyway.
+    def initialize(descriptor)
+      self.background = descriptor[:background]
+      self.colors     = descriptor[:colors]
+      self.outlines     = descriptor[:outlines]
+      self.marker     = descriptor[:marker]
+      self.font_family = descriptor[:font_family]
+      self.marker_font_size = descriptor[:marker_font_size]
+      self.title_font_size = descriptor[:title_font_size]
+      self.legend_font_size = descriptor[:legend_font_size]
+    end
+    
+    # Returns the next available color in the color array.
+    def next_color
+      @previous_color = 0 if @previous_color.nil?
+      @previous_color += 1
+              
+      self.colors[(@previous_color-1) % self.colors.size]
+    end
+    
+    
+    # Returns the next available outline in the outline array.
+    def next_outline
+      @previous_outline = 0 if @previous_outline.nil?
+      @previous_outline += 1
+      if self.outlines.nil?
+        return "#000000"
+      end
+      self.outlines[(@previous_outline-1) % self.outlines.size]
+    end
+
+    # todo: Implement darken function.
+    def darken(color, shift=20); end
+    
+    # todo: Implement lighten function.
+    def lighten(color, shift=20); end
+    
+  end
+  
+
+  
+  # A basic default theme
+  # Based on http://www.wellstyled.com/tools/colorscheme2/index-en.html?tetrad;50;0;255;1;-1;1;-0.6;0.1;1;0.6;1;1;-1;1;-0.6;0.1;1;0.6;1;1;-1;1;-0.6;0.1;1;0.6;1;1;-1;1;-0.6;0.1;1;0.6;1;0
+  class Standard < Base
+    def initialize
+      super({
+              :background => ['#FFFFFF', '#FFFFFF'],
+              :marker => '#999999',
+              :colors => %w(#1919B3 #FFB200 #FFFF00 #660099 #E9E9FF #FFF7E6 #FFFFE6 #F7E6FF #0F0F6B #996B00 #999900 #3D005C)
+            })
+    
+    end
+  end
+  
+  # Keynote theme, based on Apple's Keynote presentation software.
+  #
+  # Color values used from Gruff's default theme.
+  class Keynote < Base
+    def initialize
+      super({  
+              :background => [:black, '#4A465A'],
+              :marker => :white, 
+              :colors => %w(#6886B4 #FDD84E #72AE6E #D1695E #8A6EAF #EFAA43 white)
+             })
+    end
+  end
+
+  # Roughly, roughly based on the color scheme of www.mephistoblog.com.
+  class Mephisto < Base
+    def initialize
+      super({
+              :background => ['#101010', '#999977'],
+              :marker => :white,
+              :colors => %w(#DD3300 #66AABB #225533 #992200)
+            })
+      
+    end
+  end
+  
+  # Based on the color scheme used by almost every Ruby blogger.
+  class RubyBlog < Base
+    def initialize
+      super({
+              :background => ['#670A0A', '#831515'],
+              :marker => '#DBD1C1',
+              :colors => %w(#007777 #444477 #994444 #77FFBB #D75A20)
+            })
+    end
+  end
+  
+  # Inspired by http://www.colorschemer.com/schemes/
+  class Apples < Base
+    def initialize
+      super({
+              :background => ['#3B411F', '#4A465A'],
+              :marker => '#DBD1C1',
+              :colors => %w(#AA3322 #DD3322 #DD6644 #FFEE88 #BBCC66 #779933)
+            })
+    end
+  end
+  
+  # Inspired by http://www.colorschemer.com/schemes/  
+  class CareBears < Base
+    def initialize
+      super({
+              # Playing with Sky Background
+              # :background => ['#2774B6', '#5EA6D8'],
+              # :marker => :white,
+              :background => [:black, '#4A465A'],
+              :marker => :white,
+              :colors => %w(#FFBBBB #00CC33 #7788BB #EEAA44 #FFDD11 #44BBDD #DD6677)
+            })
+    end
+  end  
+  
+  
+  # Inspired by http://www.colorschemer.com/schemes/
+  class Vitamins < Base
+    def initialize
+      super({
+              :background => [:black, '#4A465A'],
+              :marker => :white,
+              :colors => %w(#CC9933 #FFCC66 #CCCC99 #CCCC33 #99CC33 #3333CC #336699 #6633CC #9999CC #333366)
+            })
+    end
+  end
+  
+  # Inspired by http://www.colorschemer.com/schemes/
+  class Tulips < Base
+    def initialize
+      super({
+              :background => ['#670A0A', '#831515'],
+              :marker => '#DBD1C1',
+              :colors => %w(#F2C8CA #BF545E #D2808E #97985C #B3B878 #A24550)
+            })
+    end
+  end
+  
+end

data/lib/scruffy/version.rb

@@ -0,0 +1,9 @@
+module Scruffy
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 9
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/graph_creation_test.rb

@@ -0,0 +1,286 @@
+require 'test/unit'
+require 'test_helper'
+
+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
+
+$make_png = true
+begin
+  require 'RMagick'
+rescue LoadError
+  $make_png = nil
+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' if $make_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' if $make_png
+  end
+  
+  
+  def test_create_line_with_negatives
+    graph = Scruffy::Graph.new
+    graph.title = "Sample Line Graph"
+    graph.renderer = Scruffy::Renderers::Standard.new
+
+    graph.add :line, 'Example', [-20, 100, -70, -30, 106]
+    theme = Scruffy::Themes::Base.new :background=>"#ffffff", :marker=>"#444444",
+                          :colors=>["#4f83bf","#be514e","#a1ba5e","#82649a"],
+                          :title_font_size => 30, :marker_font_size=>10
+    graph.render :to => "#{WEBSITE_DIR}/line_test_with_negatives.svg",:theme=>theme
+    graph.render  :width => 400, :to => "#{WEBSITE_DIR}/line_test_with_negatives.png",:theme=>theme, :as => 'png' if $make_png
+  end
+  
+  
+  def test_create_negative_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]
+    theme = Scruffy::Themes::Apples.new 
+    graph.render :to => "#{WEBSITE_DIR}/negative_line_test.svg",:theme=>theme
+    graph.render  :width => 600,:theme=>theme, :to => "#{WEBSITE_DIR}/negative_line_test.png", :as => 'png' if $make_png
+  end
+  
+  def test_create_small_value_line
+    graph = Scruffy::Graph.new
+    graph.title = "Sample Line Graph"
+    graph.renderer = Scruffy::Renderers::Standard.new
+    graph.value_formatter = Scruffy::Formatters::Number.new(:precision => 1)
+    graph.add :line, 'Example', [0.2,0.5,0.1,0.9,0.8,1.2,0.05,1]
+
+    graph.render :to => "#{WEBSITE_DIR}/small_value_line_test.svg"
+    graph.render  :width => 400, :to => "#{WEBSITE_DIR}/small_value_line_test.png", :as => 'png' if $make_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' if $make_png
+  end
+  
+  
+  
+  
+  def test_create_bar_with_negatives
+    graph = Scruffy::Graph.new
+    graph.title = "Sample Bar Graph"
+    graph.renderer = Scruffy::Renderers::Standard.new
+    graph.add :bar, 'Example', [20, 100,-10, 70, 30, -40, 106]
+    graph.render :to => "#{WEBSITE_DIR}/negative_bar_test.svg"
+    graph.render  :width => 400, :to => "#{WEBSITE_DIR}/negative_bar_test.png", :as => 'png' if $make_png
+  end
+  
+  
+  def test_create_bar_with_all_negatives
+    graph = Scruffy::Graph.new
+    graph.title = "Sample Bar Graph"
+    graph.renderer = Scruffy::Renderers::Standard.new
+    graph.add :bar, 'Example', [-20, -100,-10, -70, -30, -40, -106]
+    
+    theme = Scruffy::Themes::Base.new :background=>"#ffffff", :marker=>"#444444",
+                          :colors=>["#ff0000","#00ff00","#0000ff","#cccccc"],
+                          :title_font_size => 30, :marker_font_size=>10
+    
+    graph.render :to => "#{WEBSITE_DIR}/all_negative_bar_test.svg",:theme=>theme
+    graph.render  :width => 400,:theme=>theme, :to => "#{WEBSITE_DIR}/all_negative_bar_test.png", :as => 'png' if $make_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' if $make_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' if $make_png
+  end
+  
+  
+  def test_reg_multi_bar
+    graph = Scruffy::Graph.new
+    graph.title = "Comparative Agent Performance"
+    graph.value_formatter = Scruffy::Formatters::Percentage.new(:precision => 0)
+    #graph.add :multi do |multi|
+      graph.add :bar, 'Jack', [30, 60, 49, 29, 100, 120]
+      graph.add :bar, 'Jill', [120, 240, 0, 100, 140, 20]
+      graph.add :bar, 'Hill', [10, 10, 90, 20, 40, 10]
+    #end
+    graph.point_markers = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun']
+    graph.render :to => "#{WEBSITE_DIR}/reg_multi_bar_test.svg"
+    graph.render  :width => 500, :to => "#{WEBSITE_DIR}/reg_multi_bar_test.png", :as => 'png' if $make_png
+  end
+  
+  def test_multi_bar
+    graph = Scruffy::Graph.new
+    graph.title = "Comparative Agent Performance"
+    graph.value_formatter = Scruffy::Formatters::Percentage.new(:precision => 0)
+    graph.add :multi do |multi|
+      multi.add :multi_bar, 'Jack', [30, 60, 49, 29, 100, 120]
+      multi.add :multi_bar, 'Jill', [120, 240, 0, 100, 140, 20]
+      multi.add :multi_bar, 'Hill', [10, 10, 90, 20, 40, 10]
+      multi.add :multi_bar, 'Bob', [-10, -20, -30, -40, -50, -60]
+    end
+    graph.point_markers = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun']
+    graph.point_markers_ticks = true
+    theme = Scruffy::Themes::Base.new :background=>"#ffffff", :marker=>"#444444",
+                          :colors=>["#cccccc","#ff0000","#00ff00","#0000ff"],
+                          :title_font_size => 30, :marker_font_size=>10
+    
+    graph.render :to => "#{WEBSITE_DIR}/multi_bar_test.svg",:theme=>theme
+    
+    graph.render  :width => 900,:theme=>theme, :to => "#{WEBSITE_DIR}/multi_bar_test.png", :as => 'png' if $make_png
+  end
+  
+  
+  def test_box_plot
+    graph = Scruffy::Graph.new()
+    graph.title = "Box Plot Test"
+    graph.x_legend = "Time in Seconds"
+    graph.y_legend = "Inces of Rain"
+    graph.value_formatter = Scruffy::Formatters::Percentage.new(:precision => 0)
+    graph.add :box, "Test Data", [
+                                [10,8,6.2,4,2],
+                                [12,9,8.2,4.2,3.5],
+                                [10,8,5.3,4,2],
+                                [12,9,8.2,4.2,3.5],
+                                [10,8,6.6,4,2],
+                                [12,9,8.2,4.2,3.5]
+                                ]
+                                
+    graph.point_markers = ['Jan', 'Feb','Jan', 'Feb','Jan', 'Feb']
+    graph.point_markers_ticks = true
+    graph.renderer = Scruffy::Renderers::AxisLegend.new
+    
+    theme = Scruffy::Themes::Base.new :background=>"#ffffff", :marker=>"#aaaaaa",
+                          :colors=>["#4f83bf","#be514e","#a1ba5e","#82649a"],
+                          :legend_font_size=>30,
+                          :title_font_size=>40,
+                          :marker_font_size=>20,
+                          :outlines=>["#be514e","#a1ba5e","#82649a","#4f83bf"]
+    graph.render :to => "#{WEBSITE_DIR}/box_plot_test.svg",:padding=>:padded,:theme=>theme,:key_markers=>8
+    graph.render  :size => [600,540],:theme=>theme,:key_markers=>7, :to => "#{WEBSITE_DIR}/box_plot_test.png", :as => 'png',:padding=>:padded if $make_png
+  end
+  
+ 
+  
+  def test_rotated_point_markers
+    graph = Scruffy::Graph.new({:point_markers_rotation=>30}) #
+    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.point_markers_ticks = true
+    #Rotation was set when the graph was created
+    #You can also do something like this
+    #graph.point_markers_rotation = 90
+    graph.render :to => "#{WEBSITE_DIR}/rotated_point_markers_test.svg"
+    graph.render  :width => 500, :to => "#{WEBSITE_DIR}/rotated_point_markers_test.png", :as => 'png' if $make_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' if $make_png
+  end
+  
+  def test_scatter
+    graph = Scruffy::Graph.new
+    graph.title = "Some Kind of Information"
+    graph.renderer = Scruffy::Renderers::Standard.new
+
+    graph.add :scatter, 'Stephanie', {0 => 0, 1 => 1, 2 => 4, 3 => 9, 4 => 8, 5 => 10, 6 => 12, 7 => 3, 8 => 13}    
+    graph.add :line, 'Artiom', {-3 => 2, 1.5 => 6, 2 => 4.5, 15 => -4}, :dots => true   
+    graph.add :scatter, 'Sam', [[-3,15], [1.5,18], [2,9], [15,6]]   
+    graph.render :to => "#{WEBSITE_DIR}/scatter_test.svg"
+    graph.render  :width => 500, :to => "#{WEBSITE_DIR}/scatter_test.png", :as => 'png' if $make_png
+  end
+  
+  def test_scatter_by_date
+    graph = Scruffy::Graph.new
+    graph.title = "Some Kind of Information"
+    graph.renderer = Scruffy::Renderers::Standard.new
+    graph.key_formatter = Scruffy::Formatters::Date.new("%H:%M")
+    h = {}
+    start = Time.local(2009, 1, 20, 12, 0, 0)
+    30.times{|i| h[start + 60*i] = i*i}
+    
+    graph.add :scatter, 'DNI', h
+    graph.render :to => "#{WEBSITE_DIR}/scatter_date_test.svg", :calculate_markers => true
+    graph.render  :width => 500, :to => "#{WEBSITE_DIR}/scatter_date_test.png", :as => 'png' if $make_png
+  end
+end