scruffy 0.2.2 → 0.2.3

data/config/hoe.rb

@@ -0,0 +1,78 @@
+require 'scruffy/version'
+
+AUTHOR = 'Brasten Sager'  # can also be an array of Authors
+# , 'David Parry', 'A.J. Ostman', 'Mat Schaffer']
+# (Using array of authors doesn't work for some reason.
+
+EMAIL = ["brasten@nagilum.com", "david.parry@suranyami.com"]
+DESCRIPTION = "Scruffy is a Ruby library for generating high quality, good looking graphs. It is designed to be easy to use and highly customizable."
+SUMMARY = 'A powerful, clean graphing library for Ruby.'
+GEM_NAME = 'scruffy' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'scruffy' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['builder', '>= 2.0'],
+  ['diff-lcs', '>= 1.1.2']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Scruffy::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'scruffy documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = SUMMARY
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/scruffy.rb

@@ -1,3 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
 # ===Scruffy Graphing Library for Ruby
 #
 # Author:: Brasten Sager
@@ -8,16 +11,15 @@
 #
 # For information on creating your own graph types, see the
 # documentation in Scruffy::Layers::Base.
-module Scruffy; end
-
-
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+module Scruffy
+end
   
 require 'rubygems'
-require_gem 'builder', '>= 2.0'
+gem 'builder', '>= 2.0'
+require 'builder'
 
 require 'scruffy/helpers'
+require 'scruffy/graph_state'
 require 'scruffy/graph'
 require 'scruffy/themes'
 require 'scruffy/version'

data/lib/scruffy/components/base.rb

@@ -1,5 +1,9 @@
 module Scruffy
   module Components
+    # ===Scruffy::Components::Base
+    # 
+    # Common attributes for all components, and a standard render method
+    # that calls draw after setting up the drawing transformations.
     class Base
       attr_reader :id
       

data/lib/scruffy/components/legend.rb

@@ -1,52 +1,86 @@
 module Scruffy::Components
 
   class Legend < Base
+    FONT_SIZE = 80
+    
     def draw(svg, bounds, options={})
+      vertical = options[:vertical_legend]
       legend_info = relevant_legend_info(options[:layers])
-      active_width, points = layout(legend_info)
+      @line_height, x, y, size = 0
+      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
+      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
+          x = 0
+          y = point
+          size = @line_height * 0.5
+        else
+          x = offset + point
+          y = 0
+          size = relative(50)
+        end
         
-        svg.rect( :x => offset + point, 
-                  :y => relative(25), 
-                  :width => relative(60), 
-                  :height => relative(50),
-                  :fill => legend_info[idx][:color])
+        # "#{x} #{y} #{@line_height} #{size}"
+        
+        svg.rect(:x => x, 
+          :y => y, 
+          :width => size, 
+          :height => size,
+          :fill => legend_info[idx][:color])
                   
-       svg.text(  legend_info[idx][:title], 
-                  :x => offset + point + relative(100), 
-                  :y => relative(80), 
-                  'font-size' => relative(80), 
-                  :fill => (options[:theme].marker || 'white'))
+        svg.text(legend_info[idx][:title], 
+          :x => x + @line_height, 
+          :y => y + text_height * 0.75,
+          'font-size' => text_height, 
+          :style => "color: #{options[:theme].marker || 'white'}",
+          :fill => (options[:theme].marker || 'white'))
       end
     end   # draw
     
     protected
-      # Collects Legend Info from the provided Layers.
-      #
-      # Automatically filters by legend's categories.
-      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) )
+    # Collects Legend Info from the provided Layers.
+    # 
+    # Automatically filters by legend's categories.
+    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) )
 
-            data = layer.legend_data
-            arr << data if data.is_a?(Hash)
-            arr = arr + data if data.is_a?(Array)
-          end
-          arr
+          data = layer.legend_data
+          arr << data if data.is_a?(Hash)
+          arr = arr + data if data.is_a?(Array)
         end
-      end   # relevant_legend_info
+        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.
-      #
-      # ie: [200, [0, 50, 100, 150]]
-      def layout(legend_info_array)
+    # 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
+    # 
+    # ie: [200, [0, 50, 100, 150]]
+    def layout(legend_info_array, vertical = false)
+      if vertical
+        longest = 0
+        legend_info_array.each {|elem|
+          cur_length = relative(50) * elem[:title].length
+          longest = longest < cur_length ? cur_length : longest
+        }
+        y_positions = []
+        (0..legend_info_array.length - 1).each {|y|
+          y_positions << y * @line_height
+        }
+        [longest, y_positions]
+      else
         legend_info_array.inject([0, []]) do |enum, elem|
           enum[0] += (relative(50) * 2) if enum.first != 0      # Add spacer between elements
           enum[1] << enum.first                                 # Add location to points
@@ -56,6 +90,7 @@ module Scruffy::Components
           [enum.first, enum.last]
         end        
       end
+    end
 
   end   # class Legend
   

data/lib/scruffy/components/viewport.rb

@@ -7,34 +7,31 @@ module Scruffy::Components
       super(*args)
       
       self.components = []
-      if block
-        block.call(self.components)
-      end
+      block.call(self.components) if block
     end
 
     def draw(svg, bounds, options={})
       svg.g(options_for) {
         self.components.each do |component|
-            component.render(svg, 
-                             bounds_for( [bounds[:width], bounds[:height]], 
-                                         component.position, 
-                                         component.size ), 
-                             options)
+          component.render(svg, 
+            bounds_for([bounds[:width], bounds[:height]], 
+              component.position, 
+              component.size), 
+            options)
         end
       }
     end
     
     private
-      def options_for
-        options = {}
-        %w(skewX skewY).each do |option|
-          if @options[option.to_sym]
-            options[:transform] ||= ''
-            options[:transform] = options[:transform] + "#{option.to_s}(#{@options[option.to_sym]})"
-          end
+    def options_for
+      options = {}
+      %w(skewX skewY).each do |option|
+        if @options[option.to_sym]
+          options[:transform] ||= ''
+          options[:transform] = options[:transform] + "#{option.to_s}(#{@options[option.to_sym]})"
         end
-        
-        options
       end
+      options
+    end
   end
 end

data/lib/scruffy/formatters.rb

@@ -55,7 +55,7 @@ module Scruffy::Formatters
     attr_reader :proc
     
     def initialize(&block)
-      self.proc = block
+      @proc = block
     end
     
     def format(target, idx, options)

data/lib/scruffy/graph.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+  
 module Scruffy
   
   # ==Scruffy Graphs
@@ -70,15 +72,18 @@ module Scruffy
   #
   #   Of course, while you may be able to combine some things such as pie charts and line graphs, that
   #   doesn't necessarily mean they will make any logical sense together.  We leave those decisions up to you. :)
+
   class Graph
-    include Scruffy::Helpers::LayerContainer
+    extend Forwardable;
     
-    attr_accessor :title
-    attr_accessor :theme
-    attr_accessor :default_type
-    attr_accessor :point_markers
-    attr_accessor :value_formatter
-    attr_accessor :rasterizer
+    include Scruffy::Helpers::LayerContainer
+
+    # Delegating these getters to the internal state object.
+    def_delegators  :internal_state, :title, :theme, :default_type, 
+                    :point_markers, :value_formatter, :rasterizer
+                  
+    def_delegators  :internal_state, :title=, :theme=, :default_type=,
+                    :point_markers=, :value_formatter=, :rasterizer=
     
     attr_reader :renderer     # Writer defined below
     
@@ -174,5 +179,11 @@ module Scruffy
     def remove(id)
       renderer.remove(id)
     end
+    
+    private
+      def internal_state
+        @internal_state ||= GraphState.new
+      end
+      
   end
 end

data/lib/scruffy/graph_state.rb

@@ -0,0 +1,24 @@
+# ===GraphState
+#
+# Author:: Brasten Sager
+# Date:: September 27th, 2007
+#
+# State object for holding all of the graph's
+# settings.  Attempting to clean up the
+# graph interface a bit.
+
+module Scruffy
+  class GraphState
+
+    attr_accessor :title
+    attr_accessor :theme
+    attr_accessor :default_type
+    attr_accessor :point_markers
+    attr_accessor :value_formatter
+    attr_accessor :rasterizer
+    
+    def initialize
+      
+    end
+  end
+end

data/lib/scruffy/helpers.rb

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

data/lib/scruffy/helpers/canvas.rb

@@ -1,11 +1,12 @@
 module Scruffy::Helpers
+  
   # ==Scruffy::Helpers::Canvas
-  #
+  # 
   # Author:: Brasten Sager
   # Date:: August 16th, 2006
-  #
-  # Provides common methods for canvas objects.  Primarily used for providing spacial-type calculations
-  # where necessary.
+  # 
+  # Provides common methods for canvas objects.  Primarily used for providing
+  # spacial-type calculations where necessary.
   module Canvas
     attr_accessor :components
     
@@ -14,7 +15,7 @@ module Scruffy::Helpers
     end
     
     def component(id, components=self.components)
-      components.find { |elem| elem.id == id }
+      components.find {|elem| elem.id == id}
     end
     
     def remove(id, components=self.components)
@@ -22,18 +23,19 @@ module Scruffy::Helpers
     end
     
     protected
-      # Converts percentage values into actual pixe values based on the known render size.
-      #
-      # Returns a hash consisting of :x, :y, :width, and :height elements.
-      def bounds_for(canvas_size, position, size)
-        return nil if (position.nil? || size.nil?)
-        bounds = {}
-        bounds[:x] = canvas_size.first * (position.first / 100.to_f)
-        bounds[:y] = canvas_size.last  * (position.last  / 100.to_f)
-        bounds[:width] = canvas_size.first * (size.first / 100.to_f)
-        bounds[:height] = canvas_size.last * (size.last  / 100.to_f)
-        bounds
-      end
+    # Converts percentage values into actual pixel values based on the known
+    # render size.
+    # 
+    # Returns a hash consisting of :x, :y, :width, and :height elements.
+    def bounds_for(canvas_size, position, size)
+      return nil if (position.nil? || size.nil?)
+      bounds = {}
+      bounds[:x] = canvas_size.first * (position.first / 100.to_f)
+      bounds[:y] = canvas_size.last  * (position.last  / 100.to_f)
+      bounds[:width] = canvas_size.first * (size.first / 100.to_f)
+      bounds[:height] = canvas_size.last * (size.last  / 100.to_f)
+      bounds
+    end
   end # canvas
   
 end # scruffy::helpers