scruffy 0.2.6 → 0.3.0.beta1

data/{History.txt → CHANGES.txt}

@@ -1,17 +1,20 @@
 = Scruffy Changelog
-== Version 0.2.6
-(August 23rd, 2009)
-* Fixed some syntax errors causing problems with Builder
 
-== Version 0.2.5
-(unknown)
-* unknown -- logs say suranyami added support for font_family...?
-  (Feel free to update this entry)
+== Version 0.3.0.beta1
+(January 1st, 2011)
+* Really? 2011? Wow.
+* Merged in divergent forks from github
+* Probably broken, but lets get it fixed.
 
-== Version 0.2.4
-(2008-08-22)
-* Bug #21517, legend text missing, fixed.
-* Bug #21604, Fails to properly require RMagick, fixed.
+== Version 0.2.6
+(December 12th, 2008)
+* Forked from the official 0.2.5 release (http://github.com/delano/scruffy/)
+* Added stroke_width and style attributes to Line
+* Added toggleable shadow and dots attributes to Line
+* Changed the default Line to not include shadow or dots and to have a width of 1 pixel.
+* Added stroke_width for Component::Graph. Default is now 1. 
+* Changed the default theme to one appropriate for hi-res charts
+* Removed website from release
 
 == Version 0.2.3
 (July 4th, 2008)
@@ -115,4 +118,4 @@ This is not a public release.
 * Marker transformers: currency, percentages.
 * Basic Graphs: Area, Bar, Line.
 * Advanced Graphs: Average, AllSmiles.
-* Initial documentation.
+* Initial documentation.

data/README.txt

@@ -1,17 +1,37 @@
-= scruffy
+= scruffy, unofficial release
+
+This is a fork from based on the official 0.2.5 release. See below for 
+further a longer description.  
+
+== DESCRIPTION:
 
 * scruffy.rubyforge.org
 
 Author:: Brasten Sager (brasten@nagilum.com)
 Date:: July 8, 2008
-
-== DESCRIPTION:
+Release:: 0.2.5
 
 Scruffy is a Ruby library for generating high quality, good looking graphs.  It is designed
 to be easy to use and highly customizable.
 
 For basic usage instructions, refer to the documentation for Scruffy::Graph.
 
+
+== FORK DESCRIPTION
+
+* http://github.com/delano/scruffy/
+
+Author:: Delano Mandelbaum (delano@solutious.com)
+Author:: Kalin Harvey
+Date:: December 12, 2008
+
+We love scruffy. Our motivation for creating a forking is to make it useful for hi-resolution 
+graphs and charts. We would love to get our changes in to the official release but until
+that time they will be available at the GitHub URI above. 
+
+CHANGES.txt contains everything we've been up to. 
+
+
 == FEATURES
 
 * Renders to SVG or bitmap (PNG, JPG)
@@ -40,27 +60,7 @@ For basic usage instructions, refer to the documentation for Scruffy::Graph.
 
 * sudo gem install scruffy
 
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2008 Brasten Sager (brasten@nagilum.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.
+== LICENSE:
 
-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.
+See Licence.txt

data/lib/scruffy.rb

@@ -1,6 +1,3 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
 # ===Scruffy Graphing Library for Ruby
 #
 # Author:: Brasten Sager
@@ -14,8 +11,6 @@ $:.unshift(File.dirname(__FILE__)) unless
 module Scruffy
 end
   
-require 'rubygems'
-gem 'builder', '>= 2.0'
 require 'builder'
 
 require 'scruffy/helpers'

data/lib/scruffy/components.rb

@@ -13,6 +13,7 @@ require 'scruffy/components/title'
 require 'scruffy/components/background'
 require 'scruffy/components/graphs'
 require 'scruffy/components/grid'
+require 'scruffy/components/axes'
 require 'scruffy/components/value_markers'
 require 'scruffy/components/data_markers'
 require 'scruffy/components/legend'

data/lib/scruffy/components/axes.rb

@@ -0,0 +1,23 @@
+module Scruffy
+  module Components
+    class Axes < Base
+      include Scruffy::Helpers::Marker
+      
+      def draw(svg, bounds, options={})
+        stroke_width = options[:stroke_width]
+        
+        colour = options[:theme].grid || options[:theme].marker
+        unless options[:show_x] == false
+          y = (options[:max_value] * bounds[:height])/(options[:max_value] - options[:min_value])
+          svg.line(:x1 => 0, :y1 => y, :x2 => bounds[:width], :y2 => y, :style => "stroke: #{colour.to_s}; stroke-width: #{stroke_width};")
+        end
+        
+        unless options[:show_y] == false
+          x = -0.5
+          svg.line(:x1 => x, :y1 => 0, :x2 => x, :y2 => bounds[:height], :style => "stroke: #{colour.to_s}; stroke-width: #{stroke_width};")
+        end
+      end
+    end
+  end
+end
+

data/lib/scruffy/components/background.rb

@@ -2,12 +2,12 @@ module Scruffy
   module Components
     class Background < Base
       def draw(svg, bounds, options={})
-        fill = "#EEEEEE"
+        fill = nil
         case options[:theme].background
         when Symbol, String
           fill = options[:theme].background.to_s
         when Array
-          fill = "url(#BackgroundGradient)"
+          fill = "url(#BackgroundGradient) #{options[:theme].background[0]}" # the second part is a fallback for Firefox, which does support gradient fills, but unfortunately can't handle url(#fragment) references for SVGs loaded from a data: URI (whereas it does work ok for external images); if we don't specify a solid fallback color it fills black!
           svg.defs {
             svg.linearGradient(:id=>'BackgroundGradient', :x1 => '0%', :y1 => '0%', :x2 => '0%', :y2 => '100%') {
               svg.stop(:offset => '5%', 'stop-color' => options[:theme].background[0])
@@ -15,7 +15,7 @@ module Scruffy
             }
           }
         end
-        
+
         # Render background (maybe)
         svg.rect(:width => bounds[:width], :height => bounds[:height], :x => "0", :y => "0", :fill => fill) unless fill.nil?
       end

data/lib/scruffy/components/base.rb

@@ -13,11 +13,14 @@ module Scruffy
       attr_accessor :options
       attr_accessor :visible
       
+      # Options:
+      # stroke_width:: numeric value for width of line (0.1 - 10, default: 1)
       def initialize(id, options = {})
         @id = id.to_sym
         @position = options[:position] || [0, 0]
         @size = options[:size] || [100, 100]
         @visible = options[:visible] || true
+        
         @options = options
       end
       

data/lib/scruffy/components/data_markers.rb

@@ -2,18 +2,33 @@ module Scruffy
   module Components
 
     class DataMarkers < Base
-
+      
+      include Scruffy::Helpers::Marker
+      
+      attr_accessor :markers
+      
       def draw(svg, bounds, options={})
+        if options[:calculate_markers] && (options[:point_markers].nil? || options[:point_markers].empty?)
+          markers = (options[:markers] || self.markers) || 5
+          options[:point_markers] = []
+          each_marker(markers, options[:min_key], options[:max_key], bounds[:width], options, :key_formatter) do |label, x|
+            options[:point_markers] << [x, label]
+          end
+        end
         unless options[:point_markers].nil?
-          point_distance = bounds[:width] / (options[:point_markers].size - 1).to_f
-    
+          dx = bounds[:width].to_f / (options[:max_key] - options[:min_key] + 1)
           (0...options[:point_markers].size).map do |idx| 
-            x_coord = point_distance * idx
-            svg.text(options[:point_markers][idx],
-              :x => x_coord,
-              :y => bounds[:height], 
-              'font-size' => relative(90),
+            x_coord = dx * (options[:point_markers][idx].first - options[:min_key]) + dx/2
+            if options[:point_markers_ticks]
+              svg.line(:x1 => x_coord, :y1 => 0, :x2 => x_coord, :y2 => -3, :style => "stroke:#{(options[:theme].marker || 'white').to_s}; stroke-width:1")
+            end
+
+            svg.text(options[:point_markers][idx].last,
+              :x => 0,
+              :y => 0, 
+              'font-size' => options[:theme].marker_font_size || relative(90),
               'font-family' => options[:theme].font_family,
+              :transform => "translate(#{x_coord},#{bounds[:height]}) rotate(#{options[:point_markers_rotation] || 0})",
               :fill => (options[:theme].marker || 'white').to_s, 
               'text-anchor' => 'middle') unless options[:point_markers][idx].nil?
           end

data/lib/scruffy/components/graphs.rb

@@ -26,9 +26,13 @@ module Scruffy
           layer_options[:index]       = idx
           layer_options[:min_value]   = options[:min_value]
           layer_options[:max_value]   = options[:max_value]
+          layer_options[:min_key]     = options[:min_key]
+          layer_options[:max_key]     = options[:max_key]
           layer_options[:complexity]  = options[:complexity]
           layer_options[:size]        = [bounds[:width], bounds[:height]]
           layer_options[:color]       = layer.preferred_color || layer.color || options[:theme].next_color
+          layer_options[:border]      = options[:border]
+          layer_options[:outline]       = layer.preferred_outline || layer.outline || options[:theme].next_outline
           layer_options[:opacity]     = opacity_for(idx)
           layer_options[:theme]       = options[:theme]
 

data/lib/scruffy/components/grid.rb

@@ -3,14 +3,55 @@ module Scruffy
     class Grid < Base
       attr_accessor :markers
       
+      include Scruffy::Helpers::Marker
+      
       def draw(svg, bounds, options={})
         markers = (options[:markers] || self.markers) || 5
         
-        (0...markers).each do |idx|
-          marker = ((1 / (markers - 1).to_f) * idx) * bounds[:height]
-          svg.line(:x1 => 0, :y1 => marker, :x2 => bounds[:width], :y2 => marker, :style => "stroke: #{options[:theme].marker.to_s}; stroke-width: 2;")
+        stroke_width = options[:stroke_width]
+        
+        colour = options[:theme].grid || options[:theme].marker
+        
+        each_marker(markers, options[:min_value], options[:max_value], bounds[:height], options, :value_formatter) do |label, y|
+          svg.line(:x1 => 0, :y1 => y, :x2 => bounds[:width], :y2 => y, :style => "stroke: #{colour.to_s}; stroke-width: #{stroke_width};")
+        end
+        
+        #add a 0 line
+        y = (options[:max_value] * bounds[:height])/(options[:max_value] - options[:min_value])
+        svg.line(:x1 => 0, :y1 => y, :x2 => bounds[:width], :y2 => y, :style => "stroke: #{colour.to_s}; stroke-width: #{stroke_width};")
+        
+      end
+    end
+    
+    class VGrid < Base
+      attr_accessor :markers
+      
+      include Scruffy::Helpers::Marker
+      
+      def draw(svg, bounds, options={})
+        colour = options[:theme].grid || options[:theme].marker
+        
+        if options[:graph].point_markers #get vertical grid lines up with points if there are labels for them
+          point_distance = bounds[:width] / (options[:graph].point_markers.size).to_f
+          stroke_width = options[:stroke_width]
+          (0...options[:graph].point_markers.size).map do |idx| 
+            x = point_distance * idx  + point_distance/2
+            svg.line(:x1 => x, :y1 => 0, :x2 => x, :y2 => bounds[:height], :style => "stroke: #{colour.to_s}; stroke-width: #{stroke_width};")
+          end
+          #add the far right and far left lines
+          svg.line(:x1 => 0, :y1 => 0, :x2 => 0, :y2 => bounds[:height], :style => "stroke: #{colour.to_s}; stroke-width: #{stroke_width};")
+          svg.line(:x1 => bounds[:width], :y1 => 0, :x2 => bounds[:width], :y2 => bounds[:height], :style => "stroke: #{colour.to_s}; stroke-width: #{stroke_width};")
+        else
+            
+          markers =  (options[:key_markers] || self.markers) || 5 #options[:point_markers].size#
+          stroke_width = options[:stroke_width]
+          each_marker(markers, options[:min_key], options[:max_key], bounds[:width], options, :key_formatter) do |label, x|
+            svg.line(:x1 => x, :y1 => 0, :x2 => x, :y2 => bounds[:height], :style => "stroke: #{colour.to_s}; stroke-width: #{stroke_width};")
+          end
+          
         end
       end
     end
   end
-end
+end
+

data/lib/scruffy/components/legend.rb

@@ -1,5 +1,47 @@
 module Scruffy::Components
-
+  
+  class XLegend < Base
+    def draw(svg, bounds, options={})
+      if options[:title]
+        svg.text(options[:x_legend],
+                 :class => 'title',
+        :x => (bounds[:width] / 2),
+        :y => bounds[:height], 
+            'font-size' => options[:theme].legend_font_size || relative(100),
+            'font-family' => options[:theme].font_family,
+        :fill => options[:theme].marker,
+        :stroke => 'none', 'stroke-width' => '0',
+            'text-anchor' => (@options[:text_anchor] || 'middle'))
+      end
+    end
+  end #XLegend
+  
+  
+  
+  class YLegend < Base
+    def draw(svg, bounds, options={})
+      if options[:title]
+        svg.text(options[:y_legend],
+                 :class => 'title',
+        :x => (0),
+        :y => 0, 
+            'font-size' => options[:theme].legend_font_size || relative(100),
+            'font-family' => options[:theme].font_family,
+            :transform => "translate(#{bounds[:width] / 2},#{bounds[:height]/2}) rotate(#{-90})",
+        :fill => options[:theme].marker,
+        :stroke => 'none', 'stroke-width' => '0',
+            'text-anchor' => (@options[:text_anchor] || 'middle'))
+      end
+    end
+  end #YLegend
+  
+  
+  
+  
+  
+  
+  
+  
   class Legend < Base
     FONT_SIZE = 80
     
@@ -11,18 +53,18 @@ module Scruffy::Components
         set_line_height = 0.08 * bounds[:height]
         @line_height = bounds[:height] / legend_info.length
         @line_height = set_line_height if @line_height >
-          set_line_height
+        set_line_height
       else
         set_line_height = 0.90 * bounds[:height]
         @line_height = set_line_height
       end
-
+      
       text_height = @line_height * FONT_SIZE / 100
       # #TODO how does this related to @points?
       active_width, points = layout(legend_info, vertical)
-
+      
       offset = (bounds[:width] - active_width) / 2    # Nudge over a bit for true centering
-
+      
       # Render Legend
       points.each_with_index do |point, idx|
         if vertical
@@ -38,18 +80,18 @@ module Scruffy::Components
         # "#{x} #{y} #{@line_height} #{size}"
         
         svg.rect(:x => x, 
-          :y => y, 
-          :width => size, 
-          :height => size,
-          :fill => legend_info[idx][:color])
-
+                 :y => y, 
+                 :width => size, 
+                 :height => size,
+                 :fill => legend_info[idx][:color])
+        
         svg.text(legend_info[idx][:title], 
-          :x => x + @line_height, 
-          :y => y + text_height * 0.75,
+                 :x => x + @line_height, 
+                 :y => y + text_height * 0.75,
           'font-size' => text_height, 
           'font-family' => options[:theme].font_family,
-          :style => "color: #{options[:theme].marker || 'white'}",
-          :fill => (options[:theme].marker || 'white'))
+        :style => "color: #{options[:theme].marker || 'white'}",
+        :fill => (options[:theme].marker || 'white'))
       end
     end   # draw
     
@@ -60,9 +102,9 @@ module Scruffy::Components
     def relevant_legend_info(layers, categories=(@options[:category] ? [@options[:category]] : @options[:categories]))
       legend_info = layers.inject([]) do |arr, layer|
         if categories.nil? ||
-            (categories.include?(layer.options[:category]) ||
-              (layer.options[:categories] && (categories & layer.options[:categories]).size > 0) )
-
+         (categories.include?(layer.options[:category]) ||
+         (layer.options[:categories] && (categories & layer.options[:categories]).size > 0) )
+          
           data = layer.legend_data
           arr << data if data.is_a?(Hash)
           arr = arr + data if data.is_a?(Array)
@@ -70,7 +112,7 @@ module Scruffy::Components
         arr
       end
     end   # relevant_legend_info
-      
+    
     # Returns an array consisting of the total width needed by the legend
     # information, as well as an array of @x-coords for each element. If
     # vertical, then these are @y-coords, and @x is 0
@@ -84,7 +126,7 @@ module Scruffy::Components
           longest = longest < cur_length ? cur_length : longest
         }
         y_positions = []
-        (0..legend_info_array.length - 1).each {|y|
+         (0..legend_info_array.length - 1).each {|y|
           y_positions << y * @line_height
         }
         [longest, y_positions]
@@ -94,12 +136,12 @@ module Scruffy::Components
           enum[1] << enum.first                                 # Add location to points
           enum[0] += relative(50)                               # Add room for color box
           enum[0] += (relative(50) * elem[:title].length)       # Add room for text
-
+          
           [enum.first, enum.last]
         end        
       end
     end
-
+    
   end   # class Legend
   
 end   # Scruffy::Components