tlconnor-scruffy 0.2.17

data/CHANGES.txt

@@ -0,0 +1,115 @@
+= Scruffy Changelog
+
+== 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)
+* Got pie charts working
+* Added rough capability for legend to run vertically (better for Pie chart)
+* Added some checks in the Pie initializer so that you simply pass a Hash of
+  name => values, instead of adding PieSlices in a block.
+* Added a simplistic unit test that outputs a pie and line chart in PNG & SVG.
+* Quite a lot of hard-wired values in here. Whole thing needs a spring clean.
+
+== 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)
+
+* Mostly documentation.
+* Added Builder 2.0 dependency to gem spec.
+* Removed minimum size hack in RMagickRasterizer, for now.
+
+
+== Version 0.2.0
+(August 14th, 2006)
+
+- Lots of changes, hold on tight:
+
+* Redesigned rendering system to a component-based design.
+  All objects on the canvas are components that can be re-arranged via renderers.
+* Created default renderer for basic Gruff-like layout.
+* Added Reversed and Cubed renderers to demonstrate the customization abilities (plus, they're cool).
+* Added Split renderer.
+* Created Viewport component to help with Cubed.
+	- Viewport lets you scale it's inner components and move around the
+	  graph.  Its components' sizes and positions are relative to the viewport,
+	  not the graph.
+* Set title to respect marker color if available.
+* Respects :to option in Graph#render for SVG output to file.
+* Stacked layer type -- accepts layers which it then uses to create a stacked graph.  Such as Bar graphs
+  and Area graphs.
+* Abstracted out layer_container functionality to helper module (for stacked graph)
+* Renamed value_transformers to value_formatters.
+* Refined Value Formatters.
+	- Created default: Number.
+	- Respects float precision
+	- Allows for "auto-precision", which will use the largest precision (up to a customizable limit)
+	  necessary to portray the values correctly.  ie: 5.1, 6.32, 7.142  becomes   '5.100', '6.320', '7.142'
+* Modified Legend component, Layers, and Graph component to respect categories.
+	- ie:  Creating a Bar layer with :category => :sales and a Graph with :category => :qa will result in
+	  the Bay layer not being displayed.  Allows for more than one Graph viewport on a screen with different
+	  layers.
+* Improved rasterizing at smaller sizes( < 300px) by rasterizing the image at a larger size first, then
+  allowing RMagick to resize the image with specific filtering/blurring.  Actually looks better than just
+  rasterizing the SVG at the small size from the beginning.
+* Fixed Opacity on stacked graphs.
+* Added Style (invisible) components to allow for CSS styling. (Not recommended, however.)
+* Added Label component for arbitrary text.
+* Created Theme object in place of theme hash.
+
+== Version 0.1.0
+(August 11th, 2006)
+
+* First public release!
+* Legend rendering
+* Rasterizing graph to multiple image types (graph.render :as => 'PNG')
+
+== Version 0.0.12
+(August 10th, 2006)
+This is not a public release.
+
+* Rearranged Layers into a better class/module arrangement.
+
+== Version 0.0.11
+(August 10th, 2006)
+This is not a public release.
+
+* Fixed gem issue.
+
+== Version 0.0.10
+(August 10th, 2006)
+
+This is not a public release.
+
+
+* Removed bogus changelog.
+
+
+== Version 0.0.9
+(August 10th, 2006)
+
+This is not a public release.
+
+* Initial release.
+* Standard renderer.
+* Marker transformers: currency, percentages.
+* Basic Graphs: Area, Bar, Line.
+* Advanced Graphs: Average, AllSmiles.
+* Initial documentation.

data/LICENCE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2006 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.
+
+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.

data/Manifest.txt

@@ -0,0 +1,74 @@
+CHANGES.txt
+LICENCE.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/scruffy.rb
+lib/scruffy/components.rb
+lib/scruffy/components/background.rb
+lib/scruffy/components/base.rb
+lib/scruffy/components/data_markers.rb
+lib/scruffy/components/graphs.rb
+lib/scruffy/components/grid.rb
+lib/scruffy/components/label.rb
+lib/scruffy/components/legend.rb
+lib/scruffy/components/style_info.rb
+lib/scruffy/components/title.rb
+lib/scruffy/components/value_markers.rb
+lib/scruffy/components/viewport.rb
+lib/scruffy/formatters.rb
+lib/scruffy/graph.rb
+lib/scruffy/graph_state.rb
+lib/scruffy/helpers.rb
+lib/scruffy/helpers/canvas.rb
+lib/scruffy/helpers/layer_container.rb
+lib/scruffy/helpers/marker_helper.rb
+lib/scruffy/helpers/meta.rb
+lib/scruffy/helpers/point_container.rb
+lib/scruffy/layers.rb
+lib/scruffy/layers/all_smiles.rb
+lib/scruffy/layers/area.rb
+lib/scruffy/layers/average.rb
+lib/scruffy/layers/bar.rb
+lib/scruffy/layers/box.rb
+lib/scruffy/layers/base.rb
+lib/scruffy/layers/line.rb
+lib/scruffy/layers/multi.rb
+lib/scruffy/layers/multi_bar.rb
+lib/scruffy/layers/pie.rb
+lib/scruffy/layers/pie_slice.rb
+lib/scruffy/layers/scatter.rb
+lib/scruffy/layers/sparkline_bar.rb
+lib/scruffy/layers/stacked.rb
+lib/scruffy/rasterizers.rb
+lib/scruffy/rasterizers/batik_rasterizer.rb
+lib/scruffy/rasterizers/rmagick_rasterizer.rb
+lib/scruffy/renderers.rb
+lib/scruffy/renderers/base.rb
+lib/scruffy/renderers/cubed.rb
+lib/scruffy/renderers/cubed3d.rb
+lib/scruffy/renderers/empty.rb
+lib/scruffy/renderers/pie.rb
+lib/scruffy/renderers/reversed.rb
+lib/scruffy/renderers/sparkline.rb
+lib/scruffy/renderers/split.rb
+lib/scruffy/renderers/standard.rb
+lib/scruffy/renderers/axis_legend.rb
+lib/scruffy/themes.rb
+lib/scruffy/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/scruffy/graph_spec.rb
+spec/scruffy/layers/base_spec.rb
+spec/scruffy/layers/line_spec.rb
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/graph_creation_test.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,66 @@
+= 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
+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)
+
+== PROBLEMS:
+
+* 0.2.3 version has missing legend text when rendering to bitmap. This is strange because the text is there in the SVG before it goes to RMagick.
+
+== SYNOPSIS:
+
+    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 => "line_test.svg"
+    graph.render  :width => 300, :height => 200,
+      :to => "line_test.png", :as => 'png'
+
+== REQUIREMENTS:
+
+* Needs RMagick and Magic installed, if you wish to render to bitmap.
+
+== INSTALL:
+
+* sudo gem install scruffy
+
+
+== LICENSE:
+
+See Licence.txt

data/lib/scruffy.rb

@@ -0,0 +1,30 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# ===Scruffy Graphing Library for Ruby
+#
+# Author:: Brasten Sager
+# Date:: August 5th, 2006
+#
+# For information on generating graphs using Scruffy, see the
+# documentation in Scruffy::Graph.
+#
+# For information on creating your own graph types, see the
+# documentation in Scruffy::Layers::Base.
+module Scruffy
+end
+  
+require 'rubygems'
+gem 'builder', '>= 2.0'
+require 'builder'
+
+require 'scruffy/helpers'
+require 'scruffy/graph_state'
+require 'scruffy/graph'
+require 'scruffy/themes'
+require 'scruffy/version'
+require 'scruffy/formatters'
+require 'scruffy/rasterizers'
+require 'scruffy/layers'
+require 'scruffy/components'
+require 'scruffy/renderers'

data/lib/scruffy/components.rb

@@ -0,0 +1,22 @@
+# ===Scruffy Components
+#
+# Author:: Brasten Sager
+# Date:: August 16th, 2006
+#
+# Components make up the visual elements of a Scruffy graph.
+#
+# For examples, see Scruffy::Components::Base.
+module Scruffy::Components; end
+
+require 'scruffy/components/base'
+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'
+require 'scruffy/components/style_info'
+require 'scruffy/components/viewport'
+require 'scruffy/components/label'

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

@@ -0,0 +1,24 @@
+module Scruffy
+  module Components
+    class Background < Base
+      def draw(svg, bounds, options={})
+        fill = nil
+        case options[:theme].background
+        when Symbol, String
+          fill = options[:theme].background.to_s
+        when Array
+          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])
+              svg.stop(:offset => '95%', 'stop-color' => options[:theme].background[1])
+            }
+          }
+        end
+
+        # Render background (maybe)
+        svg.rect(:width => bounds[:width], :height => bounds[:height], :x => "0", :y => "0", :fill => fill) unless fill.nil?
+      end
+    end
+  end
+end

data/lib/scruffy/components/base.rb

@@ -0,0 +1,57 @@
+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
+      
+      # In terms of percentages:  [10, 10] == 10% by 10%
+      attr_accessor :position
+      attr_accessor :size
+      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
+      
+      def render(svg, bounds, options={})
+        if @visible
+          unless bounds.nil?
+            @render_height = bounds[:height]
+        
+            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))
+          end
+        end
+      end
+      
+      def draw(svg, bounds, options={})
+        # Override this if visual component
+      end
+
+      def process(svg, options={})
+        # Override this NOT a visual component
+      end
+      
+      protected
+        def relative(pct)
+          @render_height * ( pct / 100.to_f )
+        end
+    end
+  end
+end

data/lib/scruffy/components/data_markers.rb

@@ -0,0 +1,41 @@
+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?
+          dx = bounds[:width].to_f / (options[:max_key] - options[:min_key] + 1)
+          (0...options[:point_markers].size).map do |idx| 
+            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
+        end
+      end   # draw
+      
+    end   # class
+
+  end
+end