scruffy 0.2.1 → 0.2.2

data/CHANGES

@@ -1,5 +1,15 @@
 = Scruffy Changelog
 
+== Version 0.2.2
+(August 19th, 2006)
+
+* Removed all font-family and text-rendering attributes from elements.
+	- These were causing issues with Batik and Adobe Viewer.  Horrible font problems.
+* Added require 'builder' to renderers/base.rb
+* Added minor shadows to most graph types.  Adds some depth perception.
+* Added graph.layout as an alias of renderer.  (graph.layout looks nicer).
+* Added markers, values, grid options.
+
 == Version 0.2.1
 (August 18th, 2006)
 

data/lib/scruffy/components/base.rb

@@ -4,28 +4,32 @@ module Scruffy
       attr_reader :id
       
       # In terms of percentages:  [10, 10] == 10% by 10%
-      attr_reader :position
-      attr_reader :size
-      attr_reader :options
+      attr_accessor :position
+      attr_accessor :size
+      attr_accessor :options
+      attr_accessor :visible
       
       def initialize(id, options = {})
         @id = id.to_sym
-        @position = options[:position]
-        @size = options[:size]
+        @position = options[:position] || [0, 0]
+        @size = options[:size] || [100, 100]
+        @visible = options[:visible] || true
         @options = options
       end
       
       def render(svg, bounds, options={})
-        unless bounds.nil?
-          @render_height = bounds[:height]
+        if @visible
+          unless bounds.nil?
+            @render_height = bounds[:height]
         
-          svg.g(:id => id.to_s, 
-                :transform => "translate(#{bounds.delete(:x)}, #{bounds.delete(:y)})") {
+            svg.g(:id => id.to_s, 
+                  :transform => "translate(#{bounds.delete(:x)}, #{bounds.delete(:y)})") {
 
-            draw(svg, bounds, options.merge(@options))
-          }
-        else
-          process(svg, options.merge(@options))
+              draw(svg, bounds, options.merge(@options))
+            }
+          else
+            process(svg, options.merge(@options))
+          end
         end
       end
       

data/lib/scruffy/components/data_markers.rb

@@ -12,9 +12,7 @@ module Scruffy
             svg.text(options[:point_markers][idx], :x => x_coord, :y => bounds[:height], 
                      'font-size' => relative(90), 
                      :fill => (options[:theme].marker || 'white').to_s, 
-                     'text-anchor' => 'middle', 
-                     'font-family' => options[:theme].font_family, 
-                     'text-rendering' => 'optimizeLegibility') unless options[:point_markers][idx].nil?
+                     'text-anchor' => 'middle') unless options[:point_markers][idx].nil?
           end
         end
       end   # draw

data/lib/scruffy/components/grid.rb

@@ -1,8 +1,10 @@
 module Scruffy
   module Components
     class Grid < Base
+      attr_accessor :markers
+      
       def draw(svg, bounds, options={})
-        markers = options[:markers] || 5
+        markers = (options[:markers] || self.markers) || 5
         
         (0...markers).each do |idx|
           marker = ((1 / (markers - 1).to_f) * idx) * bounds[:height]

data/lib/scruffy/components/label.rb

@@ -4,8 +4,7 @@ module Scruffy
       def draw(svg, bounds, options={})
         svg.text(@options[:text], :class => 'text', :x => (bounds[:width] / 2), :y => bounds[:height], 
                 'font-size' => relative(100), :fill => options[:theme].marker, :stroke => 'none', 'stroke-width' => '0',
-                'text-anchor' => (@options[:text_anchor] || 'middle'), 
-                'font-family' => options[:theme].font_family, 'text-rendering' => 'optimizeLegibility')
+                'text-anchor' => (@options[:text_anchor] || 'middle'))
       end
     end
   end

data/lib/scruffy/components/legend.rb

@@ -20,9 +20,7 @@ module Scruffy::Components
                   :x => offset + point + relative(100), 
                   :y => relative(80), 
                   'font-size' => relative(80), 
-                  :fill => (options[:theme].marker || 'white'), 
-                  'font-family' => options[:theme].font_family, 
-                  'text-rendering' => 'optimizeLegibility')
+                  :fill => (options[:theme].marker || 'white'))
       end
     end   # draw
     

data/lib/scruffy/components/style_info.rb

@@ -5,6 +5,11 @@ module Scruffy
     # In hindsight, ImageMagick and Mozilla SVG's handling of CSS styling is
     # extremely inconsistant, so use this at your own risk.
     class StyleInfo < Base
+      def initialize(*args)
+        super
+        
+        @visible = false
+      end
       def process(svg, options={})
         svg.defs {
           svg.style(:type => "text/css") {

data/lib/scruffy/components/title.rb

@@ -4,8 +4,7 @@ module Scruffy
       def draw(svg, bounds, options={})
         svg.text(options[:title], :class => 'title', :x => (bounds[:width] / 2), :y => bounds[:height], 
                 'font-size' => relative(100), :fill => options[:theme].marker, :stroke => 'none', 'stroke-width' => '0',
-                'text-anchor' => (@options[:text_anchor] || 'middle'), 
-                'font-family' => options[:theme].font_family, 'text-rendering' => 'optimizeLegibility')
+                'text-anchor' => (@options[:text_anchor] || 'middle'))
       end
     end
   end

data/lib/scruffy/components/value_markers.rb

@@ -1,8 +1,10 @@
 module Scruffy
   module Components
     class ValueMarkers < Base
+      attr_accessor :markers
+      
       def draw(svg, bounds, options={})
-        markers = options[:markers] || 5
+        markers = (options[:markers] || self.markers) || 5
         all_values = []
 
         (0...markers).each do |idx|
@@ -18,11 +20,9 @@ module Scruffy
           svg.text( marker_value.to_s, 
                     :x => bounds[:width], 
                     :y => (bounds[:height] - marker), 
-                    'font-size' => relative(10),
+                    'font-size' => relative(8),
                     :fill => ((options.delete(:marker_color_override) || options[:theme].marker) || 'white').to_s,
-                    'text-anchor' => 'end', 
-                    'font-family' => options[:theme].font_family, 
-                    'text-rendering' => 'optimizeLegibility')
+                    'text-anchor' => 'end')
         end
         
       end

data/lib/scruffy/components/viewport.rb

@@ -3,8 +3,6 @@ module Scruffy::Components
   class Viewport < Base
     include Scruffy::Helpers::Canvas
     
-    attr_accessor :components
-    
     def initialize(*args, &block)
       super(*args)
       

data/lib/scruffy/formatters.rb

@@ -46,6 +46,25 @@ module Scruffy::Formatters
       end
   end
   
+  # Allows you to pass in a Proc for use as a formatter.
+  #
+  # Use:
+  #
+  # graph.value_formatter = Scruffy::Formatters::Custom.new { |value, idx, options| "Displays Returned Value" }
+  class Custom < Base
+    attr_reader :proc
+    
+    def initialize(&block)
+      self.proc = block
+    end
+    
+    def format(target, idx, options)
+      proc.call(target, idx, options)
+    end
+  end
+  
+  
+  
   # Default number formatter.
   # Limits precision, beautifies numbers.
   class Number < Base

data/lib/scruffy/graph.rb

@@ -159,11 +159,20 @@ module Scruffy
       options[:as] ? rasterizer.rasterize(svg, options) : svg
     end
     
-    
     def renderer=(val)
       raise ArgumentError, "Renderer must include a #render(options) method." unless (val.respond_to?(:render) && val.method(:render).arity.abs > 0)
       
       @renderer = val
     end
+    
+    alias :layout :renderer
+    
+    def component(id)
+      renderer.component(id)
+    end
+    
+    def remove(id)
+      renderer.remove(id)
+    end
   end
 end

data/lib/scruffy/helpers.rb

@@ -7,4 +7,5 @@
 module Scruffy::Helpers; end
 
 require 'scruffy/helpers/canvas'
-require 'scruffy/helpers/layer_container'
+require 'scruffy/helpers/layer_container'
+require 'scruffy/helpers/meta'

data/lib/scruffy/helpers/canvas.rb

@@ -7,6 +7,20 @@ module Scruffy::Helpers
   # Provides common methods for canvas objects.  Primarily used for providing spacial-type calculations
   # where necessary.
   module Canvas
+    attr_accessor :components
+    
+    def reset_settings!
+      self.options = {}
+    end
+    
+    def component(id, components=self.components)
+      components.find { |elem| elem.id == id }
+    end
+    
+    def remove(id, components=self.components)
+      components.delete(component(id))
+    end
+    
     protected
       # Converts percentage values into actual pixe values based on the known render size.
       #

data/lib/scruffy/helpers/layer_container.rb

@@ -1,4 +1,5 @@
 module Scruffy::Helpers
+  
   # ==Scruffy::Helpers::LayerContainer
   #
   # Author:: Brasten Sager
@@ -8,10 +9,12 @@ module Scruffy::Helpers
   # container for graph layers.  The best example of this is the Scruffy::Graph
   # object itself, but this module is also used by Scruffy::Layer::Stacked.
   module LayerContainer
-    # Adds a Layer to the Graph/Container.  Accepts either a list of arguments used to build a new layer, or
-    # a Scruffy::Layers::Base-derived object.  When passing a list of arguments, all arguments are optional, but the arguments
-    # specified must be provided in a particular order: type (Symbol), title (String), points (Array),
-    # options (Hash).
+    
+    # Adds a Layer to the Graph/Container.  Accepts either a list of 
+    # arguments used to build a new layer, or a Scruffy::Layers::Base-derived 
+    # object.  When passing a list of arguments, all arguments are optional, 
+    # but the arguments specified must be provided in a particular order: 
+    # type (Symbol), title (String), points (Array), options (Hash).
     #
     # Both #add and #<< can be used.
     #

data/lib/scruffy/helpers/meta.rb

@@ -0,0 +1,5 @@
+module Scruffy::MetaAttributes
+    def singleton_class
+      (class << self; self; end)
+    end
+end

data/lib/scruffy/layers/area.rb

@@ -36,6 +36,9 @@ module Scruffy::Layers
       #     }
       #   }
       # }
+      svg.g(:transform => "translate(0, -#{relative(2)})") {
+        svg.polygon(:points => points_value, :style => "fill: black; stroke: black; fill-opacity: 0.06; stroke-opacity: 0.06;")
+      }
 
       svg.polygon(:points => points_value, :fill => color.to_s, :stroke => color.to_s, 'style' => "opacity: #{opacity}")
     end

data/lib/scruffy/layers/bar.rb

@@ -12,6 +12,14 @@ module Scruffy::Layers
       coords.each do |coord|
         x, y, bar_height = (coord.first-(@bar_width * 0.5)), coord.last, (height - coord.last)
 
+        svg.g(:transform => "translate(-#{relative(0.5)}, -#{relative(0.5)})") {
+          svg.rect( :x => x, :y => y, :width => @bar_width + relative(1), :height => bar_height + relative(1), 
+                    :style => "fill: black; fill-opacity: 0.15; stroke: none;" )
+          svg.rect( :x => x+relative(0.5), :y => y+relative(2), :width => @bar_width + relative(1), :height => bar_height - relative(0.5), 
+                    :style => "fill: black; fill-opacity: 0.15; stroke: none;" )
+
+        }
+        
         svg.rect( :x => x, :y => y, :width => @bar_width, :height => bar_height, 
                   :fill => color.to_s, 'style' => "opacity: #{opacity}; stroke: none;" )
       end

data/lib/scruffy/layers/line.rb

@@ -9,11 +9,21 @@ module Scruffy::Layers
     
     # Renders line graph.
     def draw(svg, coords, options={})
+      svg.g(:class => 'shadow', :transform => "translate(#{relative(0.5)}, #{relative(0.5)})") {
+        svg.polyline( :points => stringify_coords(coords).join(' '), :fill => 'transparent', 
+                      :stroke => 'black', 'stroke-width' => relative(2), 
+                      :style => 'fill-opacity: 0; stroke-opacity: 0.35' )
+
+        coords.each { |coord| svg.circle( :cx => coord.first, :cy => coord.last + relative(0.9), :r => relative(2), 
+                                          :style => "stroke-width: #{relative(2)}; stroke: black; opacity: 0.35;" ) }
+      }
+
+
       svg.polyline( :points => stringify_coords(coords).join(' '), :fill => 'none', 
                     :stroke => color.to_s, 'stroke-width' => relative(2) )
 
-      coords.each { |coord| svg.circle( :cx => coord.first, :cy => coord.last, :r => relative(2.5), 
-                                        :fill => color.to_s ) }
+      coords.each { |coord| svg.circle( :cx => coord.first, :cy => coord.last, :r => relative(2), 
+                                        :style => "stroke-width: #{relative(2)}; stroke: #{color.to_s}; fill: #{color.to_s}" ) }
     end
   end
 end

data/lib/scruffy/renderers/base.rb

@@ -1,3 +1,4 @@
+require 'builder'
 module Scruffy::Renderers
   # ===Scruffy::Renderers::Base
   #
@@ -11,19 +12,29 @@ module Scruffy::Renderers
   class Base
     include Scruffy::Helpers::Canvas
     
-    attr_accessor :components    
+    attr_accessor :options
+
+    def initialize(options = {})
+      self.components = []
+      self.options = options
+      define_layout
+    end
 
     # Renders the graph and all components.
     def render(options = {})
       options[:graph_id]    ||= 'scruffy_graph'
       options[:complexity]  ||= (global_complexity || :normal)
 
+      # Allow subclasses to muck with components prior to renders.
+      rendertime_renderer = self.clone
+      rendertime_renderer.instance_eval { before_render if respond_to?(:before_render) }
+
       svg = Builder::XmlMarkup.new(:indent => 2)
       svg.instruct!
       svg.instruct! 'DOCTYPE', 'svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"  type'
       svg.svg(:xmlns => "http://www.w3.org/2000/svg", 'xmlns:xlink' => "http://www.w3.org/1999/xlink", :width => options[:size].first, :height => options[:size].last) {
         svg.g(:id => options[:graph_id]) {
-          self.components.each do |component|
+          rendertime_renderer.components.each do |component|
             component.render(svg, 
                              bounds_for( options[:size], component.position, component.size ), 
                              options)
@@ -32,7 +43,42 @@ module Scruffy::Renderers
       }
       svg.target!
     end
-  
+    
+    def before_render
+      set_values(self.options[:values])    if (self.options[:values] && self.options[:values] != :hide)
+      hide_grid     if (self.options[:grid] == :hide)
+      hide_values   if (self.options[:values] == :hide)
+      hide_labels   if (self.options[:labels] == :hide)
+    end
+    
+    def method_missing(sym, *args)
+      self.options = {} if self.options.nil?
+      
+      if args.size > 0
+        self.options[sym] = args[0]
+      else
+        return self.options[sym]
+      end
+    end
+
+    protected
+      def hide_grid
+        grids.each { |grid| grid.visible = false }
+      end
+    
+      def set_values(val)
+        values.each { |value| value.markers = val }
+        grids.each { |grid| grid.markers = val }
+      end
+    
+      def hide_values
+        values.each { |value| value.visible = false }
+      end
+    
+      def hide_labels
+        labels.each { |label| label.visible = false }
+      end    
+
     private
       def global_complexity
         if Kernel.const_defined? "SCRUFFY_COMPLEXITY"
@@ -41,5 +87,5 @@ module Scruffy::Renderers
           nil
         end
       end
-  end
+  end   # base
 end

data/lib/scruffy/renderers/cubed.rb

@@ -13,7 +13,7 @@ module Scruffy::Renderers
                       :bottom_right => [55, 65] }
     
     # Returns a Cubed instance.
-    def initialize
+    def define_layout
       super do |components|
         components << Scruffy::Components::Title.new(:title, :position => [5, 2], :size => [90, 7])
                       

data/lib/scruffy/renderers/cubed3d.rb

@@ -13,7 +13,7 @@ module Scruffy::Renderers
                       :bottom_right => [55, 65] }
     
     # Returns a Cubed instance.
-    def initialize
+    def define_layout
       super do |components|
         components << Scruffy::Components::Title.new(:title, :position => [5, 2], :size => [90, 7])
                       

data/lib/scruffy/renderers/empty.rb

@@ -13,11 +13,10 @@ module Scruffy::Renderers
     #
     # If a block is provided, the components array is passed to
     # the block, allowing callers to add components during initialize.
-    def initialize
-      self.components = []
+    def define_layout
       self.components << Scruffy::Components::Background.new(:background, :position => [0,0], :size =>[100, 100])      
 
-      yield(components) if block_given?
+      yield(self.components) if block_given?
     end
   end
 end

data/lib/scruffy/renderers/reversed.rb

@@ -2,8 +2,7 @@ module Scruffy
   module Renderers
     class Reversed < Base
 
-      def initialize
-        self.components = []
+      def define_layout
         self.components << Scruffy::Components::Background.new(:background, :position => [0,0], :size =>[100, 100])
         self.components << Scruffy::Components::Title.new(:title, :position => [98, 95], :size => [1, 3], :text_anchor => 'end')
         #self.components << Scruffy::Components::Grid.new(:grid, :position => [14, 12], :size => [78.5, 70])

data/lib/scruffy/renderers/sparkline.rb

@@ -2,8 +2,7 @@ module Scruffy
   module Renderers
     # Experimental, do not use.
     class Sparkline < Base
-      def initialize
-        self.components = []
+      def define_layout
         self.components << Scruffy::Components::Graphs.new(:sparkline, :position => [0, 0], :size => [100, 100])                  
       end
     end

data/lib/scruffy/renderers/split.rb

@@ -1,29 +1,43 @@
 module Scruffy
   module Renderers
     # Renderer that splits the graphs up into four other little graphs.
-    class Split < Base
-      def initialize(options = {})
-        self.components = []
-        self.components << Scruffy::Components::Background.new(:background, :position => [0,0], :size =>[100, 100])
-        self.components << Scruffy::Components::Title.new(:title, :position => [5, 2], :size => [90, 7])
-        self.components << Scruffy::Components::Label.new(:label_one, :text => options[:split_label] || '', 
-                                                          :position => [30, 54.5], :size => [40, 3])
+    class Split < Empty
+      def define_layout
+        super do |components|
+          components << Scruffy::Components::Title.new(:title, :position => [5, 2], :size => [90, 7])
+          components << Scruffy::Components::Label.new(:label_one, :text => self.options[:split_label] || '', 
+                                                      :position => [30, 54.5], :size => [40, 3])
 
-        # Viewports
-        self.components << Scruffy::Components::Viewport.new(:top_left, :position => [3, 20], 
-                                                             :size => [90, 30], &graph_block(:top))
-        self.components << Scruffy::Components::Viewport.new(:top_left, :position => [3, 65], 
-                                                             :size => [90, 30], &graph_block(:bottom))
+          # Viewports
+          components << Scruffy::Components::Viewport.new(:top, :position => [3, 20], 
+                                                         :size => [90, 30], &graph_block(:top))
+          components << Scruffy::Components::Viewport.new(:bottom, :position => [3, 65], 
+                                                         :size => [90, 30], &graph_block(:bottom))
         
-        self.components << Scruffy::Components::Legend.new(:legend, :position => [5, 11], :size => [90, 4])
+          components << Scruffy::Components::Legend.new(:legend, :position => [5, 11], :size => [90, 4])
+        end
       end
 
+      protected
+        def labels
+          [component(:top).component(:labels), component(:bottom).component(:labels)]
+        end
+    
+        def values
+          [component(:top).component(:values), component(:bottom).component(:values)]
+        end
+      
+        def grids
+          [component(:top).component(:grid), component(:bottom).component(:grid)]
+        end
+      
+
       private
         def graph_block(graph_filter)
           block = Proc.new { |components|
             components << Scruffy::Components::Grid.new(:grid, :position => [10, 0], :size => [90, 89])
-            components << Scruffy::Components::ValueMarkers.new(:value_markers, :position => [0, 2], :size => [8, 89])
-            components << Scruffy::Components::DataMarkers.new(:data_markers, :position => [10, 92], :size => [90, 8])
+            components << Scruffy::Components::ValueMarkers.new(:values, :position => [0, 2], :size => [8, 89])
+            components << Scruffy::Components::DataMarkers.new(:labels, :position => [10, 92], :size => [90, 8])
             components << Scruffy::Components::Graphs.new(:graphs, :position => [10, 0], :size => [90, 89], :only => graph_filter)
           }
           

data/lib/scruffy/renderers/standard.rb

@@ -1,20 +1,36 @@
-module Scruffy
-  module Renderers
-    class Standard < Base
-
-      def initialize
-        self.components = []
-        self.components << Scruffy::Components::Background.new(:background, :position => [0,0], :size =>[100, 100])
-        self.components << Scruffy::Components::Title.new(:title, :position => [5, 2], :size => [90, 7])
-        self.components << Scruffy::Components::Viewport.new(:graph_viewport, :position => [2, 26], :size => [89, 66]) do |view|
-          view << Scruffy::Components::Grid.new(:grid, :position => [20, 0], :size => [80, 90])
-          view << Scruffy::Components::ValueMarkers.new(:value_markers, :position => [0, 2], :size => [17.5, 90])
-          view << Scruffy::Components::DataMarkers.new(:data_markers, :position => [20, 94], :size => [80, 6])
-          view << Scruffy::Components::Graphs.new(:graphs, :position => [20, 0], :size => [80, 90])          
+module Scruffy::Renderers
+  class Standard < Empty
+    
+    def define_layout
+      super do |components|
+        components << Scruffy::Components::Title.new(:title, :position => [5, 2], :size => [90, 7])
+        components << Scruffy::Components::Viewport.new(:view, :position => [2, 26], :size => [89, 66]) do |graph|
+          graph << Scruffy::Components::ValueMarkers.new(:values, :position => [0, 2], :size => [18, 89])
+          graph << Scruffy::Components::Grid.new(:grid, :position => [20, 0], :size => [80, 89])
+          graph << Scruffy::Components::DataMarkers.new(:labels, :position => [20, 92], :size => [80, 8])
+          graph << Scruffy::Components::Graphs.new(:graphs, :position => [20, 0], :size => [80, 89])
         end
-        self.components << Scruffy::Components::Legend.new(:legend, :position => [5, 13], :size => [90, 6])
+        components << Scruffy::Components::Legend.new(:legend, :position => [5, 13], :size => [90, 6])
       end
-
     end
+    
+    protected
+      def hide_values
+        super
+        component(:view).position[0] = -10
+        component(:view).size[0] = 100
+      end
+    
+      def labels
+        [component(:view).component(:labels)]
+      end
+    
+      def values
+        [component(:view).component(:values)]
+      end
+      
+      def grids
+        [component(:view).component(:grid)]
+      end
   end
 end

data/lib/scruffy/themes.rb

@@ -16,10 +16,10 @@ module Scruffy::Themes
   #
   # See Scruffy::Themes::Base#instantiate for examples.
   class Base
-    attr_accessor :background
-    attr_accessor :colors
-    attr_accessor :marker
-    attr_accessor :font_family
+    attr_accessor :background     # Background color or array of two colors
+    attr_accessor :colors         # Array of colors 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.
 
     # Returns a new Scruffy::Themes::Base object.
     #
@@ -28,7 +28,8 @@ module Scruffy::Themes
     # 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.
+    #               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]

data/lib/scruffy/version.rb

@@ -1,3 +1,3 @@
 module Scruffy
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: scruffy
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2006-08-18 00:00:00 -07:00
+  version: 0.2.2
+date: 2006-08-19 00:00:00 -07:00
 summary: A powerful, clean graphing library for Ruby.
 require_paths: 
 - lib
@@ -56,6 +56,7 @@ files:
 - lib/scruffy/components/viewport.rb
 - lib/scruffy/helpers/canvas.rb
 - lib/scruffy/helpers/layer_container.rb
+- lib/scruffy/helpers/meta.rb
 - lib/scruffy/layers/all_smiles.rb
 - lib/scruffy/layers/area.rb
 - lib/scruffy/layers/average.rb