scruffy 0.2.2 → 0.2.3

data/CHANGES

@@ -1,4 +1,12 @@
 = Scruffy Changelog
+== 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)

data/History.txt

@@ -0,0 +1,104 @@
+= Scruffy Changelog
+== 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/License.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,105 @@
+CHANGES
+History.txt
+License.txt
+MIT-LICENSE
+Manifest.txt
+PostInstall.txt
+README
+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/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/base.rb
+lib/scruffy/layers/line.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/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
+test/test_scruffy.rb
+website/images/blank.gif.html
+website/images/graphs/all_smiles.png
+website/images/graphs/bar_test.png
+website/images/graphs/bar_test.svg
+website/images/graphs/line_test.png
+website/images/graphs/line_test.svg
+website/images/graphs/multi_test.png
+website/images/graphs/multi_test.svg
+website/images/graphs/pie_test.png
+website/images/graphs/pie_test.svg
+website/images/graphs/split_test.png
+website/images/graphs/split_test.svg
+website/images/graphs/stacking_test.png
+website/images/graphs/stacking_test.svg
+website/images/header.png
+website/images/header_gradient.png
+website/images/overlay.png
+website/images/scruffy.png
+website/index.html
+website/index.txt
+website/javascripts/application.js
+website/javascripts/controls.js
+website/javascripts/dragdrop.js
+website/javascripts/effects.js
+website/javascripts/lightbox.js
+website/javascripts/prototype.js
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/lightbox.css
+website/stylesheets/screen.css
+website/stylesheets/scruffy.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,6 @@
+For more information on scruffy, see http://scruffy.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.txt

@@ -0,0 +1,66 @@
+= scruffy
+
+* scruffy.rubyforge.org
+
+Author:: Brasten Sager (brasten@nagilum.com)
+Date:: July 8, 2008
+
+== DESCRIPTION:
+
+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.
+
+== 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:
+
+(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.
+
+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/Rakefile

@@ -1,104 +1,108 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/contrib/rubyforgepublisher'
-require 'lib/scruffy'
-require 'spec'
-require 'diff/lcs'
-require 'spec/rake/spectask'
-
-PKG_NAME = "scruffy"
-PKG_VERSION   = Scruffy::VERSION
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-PKG_FILES = FileList[
-  '[A-Z]*',
-  'lib/**/*.rb', 
-  'spec/**/*.rb'
-]
-
-desc 'Runs all RSpec specs - translated with test2spec from our own tests'
-Spec::Rake::SpecTask.new do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-desc "Deploy docs to RubyForge" 
-task :rdoc_deploy => [:rdoc] do
-  dirs = %w{doc}
-  onserver = "brasten@rubyforge.org:/var/www/gforge-projects/scruffy" 
-  dirs.each do | dir|
-    `scp -r "#{`pwd`.chomp}/#{dir}" "#{onserver}"`
-  end
-end
-
-# Genereate the RDoc documentation
-Rake::RDocTask.new { |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title    = "Scruffy - Graphing Library for Ruby"
-#  rdoc.options << '--line-numbers --inline-source --main README --accessor adv_attr_accessor=M'
-#  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
-  rdoc.rdoc_files.include('README', 'CHANGES', 'MIT-LICENSE')
-  rdoc.rdoc_files.include('lib/scruffy.rb')
-  rdoc.rdoc_files.include('lib/scruffy/*.rb')
-  rdoc.rdoc_files.include('lib/scruffy/layers/*.rb')
-  rdoc.rdoc_files.include('lib/scruffy/renderers/*.rb')
-  rdoc.rdoc_files.include('lib/scruffy/components/*.rb')
-  rdoc.rdoc_files.include('lib/scruffy/helpers/*.rb')
-  rdoc.rdoc_files.include('lib/scruffy/rasterizers/*.rb')
-}
-
-spec = Gem::Specification.new do |s|
-  s.name = PKG_NAME
-  s.version = PKG_VERSION
-  s.author = "Brasten Sager" 
-  s.email = "brasten@nagilum.com"
-  s.homepage = "http://scruffy.rubyforge.org"
-  s.summary = "A powerful, clean graphing library for Ruby."
-  s.add_dependency('builder', '>= 2.0')  
-  s.description = <<-EOF
-    Scruffy is a Ruby library for generating powerful graphs.  It is based on
-    SVG, allowing for powerful, clean code, as well as a good foundation for
-    future features.
-  EOF
-
-  s.files = PKG_FILES.to_a
-  s.has_rdoc = true
-  s.rubyforge_project = "scruffy"
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
-end
-
-task :verify_user do
-  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
-end
-
-task :verify_password do
-  raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
-end
-
-desc "Publish gem+tgz+zip on RubyForge. You must make sure lib/version.rb is aligned with the CHANGELOG file"
-task :publish_packages => [:verify_user, :verify_password, :package] do
-  require 'meta_project'
-  require 'rake/contrib/xforge'
-  release_files = FileList[
-    "pkg/#{PKG_FILE_NAME}.gem",
-    "pkg/#{PKG_FILE_NAME}.tgz",
-    "pkg/#{PKG_FILE_NAME}.zip",
-    "pkg/#{PKG_FILE_NAME}.gem.md5",
-    "pkg/#{PKG_FILE_NAME}.tgz.md5",
-    "pkg/#{PKG_FILE_NAME}.zip.md5"
-  ]
-
-  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new(PKG_NAME)) do |xf|
-    # Never hardcode user name and password in the Rakefile!
-    xf.user_name = ENV['RUBYFORGE_USER']
-    xf.password = ENV['RUBYFORGE_PASSWORD']
-    xf.files = release_files.to_a
-    xf.release_name = "Scruffy #{PKG_VERSION}"
-  end
-end
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+#
+#require 'rubygems'
+#require 'rake'
+#require 'rake/testtask'
+#require 'rake/rdoctask'
+#require 'rake/packagetask'
+#require 'rake/gempackagetask'
+#require 'rake/contrib/rubyforgepublisher'
+#require 'lib/scruffy'
+#require 'spec'
+#require 'diff/lcs'
+#require 'spec/rake/spectask'
+#
+#PKG_NAME = "scruffy"
+#PKG_VERSION   = Scruffy::VERSION::STRING
+#PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+#PKG_FILES = FileList[
+#  '[A-Z]*',
+#  'lib/**/*.rb', 
+#  'spec/**/*.rb'
+#]
+#
+#desc 'Runs all RSpec specs (set RCOV=true for coverage output)'
+#Spec::Rake::SpecTask.new do |t|
+#  t.spec_files = FileList['spec/**/*_spec.rb']
+#  t.rcov = ENV['RCOV']
+#end
+#
+#desc "Deploy docs to RubyForge" 
+#task :rdoc_deploy => [:rdoc] do
+#  dirs = %w{doc}
+#  onserver = "brasten@rubyforge.org:/var/www/gforge-projects/scruffy" 
+#  dirs.each do | dir|
+#    `scp -r "#{`pwd`.chomp}/#{dir}" "#{onserver}"`
+#  end
+#end
+#
+## Genereate the RDoc documentation
+#Rake::RDocTask.new { |rdoc|
+#  rdoc.rdoc_dir = 'doc'
+#  rdoc.title    = "Scruffy - Graphing Library for Ruby"
+##  rdoc.options << '--line-numbers --inline-source --main README --accessor adv_attr_accessor=M'
+##  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+#  rdoc.rdoc_files.include('README', 'CHANGES', 'MIT-LICENSE')
+#  rdoc.rdoc_files.include('lib/scruffy.rb')
+#  rdoc.rdoc_files.include('lib/scruffy/*.rb')
+#  rdoc.rdoc_files.include('lib/scruffy/layers/*.rb')
+#  rdoc.rdoc_files.include('lib/scruffy/renderers/*.rb')
+#  rdoc.rdoc_files.include('lib/scruffy/components/*.rb')
+#  rdoc.rdoc_files.include('lib/scruffy/helpers/*.rb')
+#  rdoc.rdoc_files.include('lib/scruffy/rasterizers/*.rb')
+#}
+#
+#spec = Gem::Specification.new do |s|
+#  s.name = PKG_NAME
+#  s.version = PKG_VERSION
+#  s.author = AUTHOR
+#  s.email = "brasten@nagilum.com"
+#  s.homepage = "http://scruffy.rubyforge.org"
+#  s.summary = "A powerful, clean graphing library for Ruby."
+#  s.add_dependency('builder', '>= 2.0')  
+#  s.description = <<-EOF
+#    Scruffy is a Ruby library for generating powerful graphs.  It is based on
+#    SVG, allowing for powerful, clean code, as well as a good foundation for
+#    future features.
+#  EOF
+#
+#  s.files = PKG_FILES.to_a
+#  s.has_rdoc = true
+#  s.rubyforge_project = "scruffy"
+#end
+#
+#Rake::GemPackageTask.new(spec) do |pkg|
+#  pkg.need_zip = true
+#  pkg.need_tar = true
+#end
+#
+#task :verify_user do
+#  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
+#end
+#
+#task :verify_password do
+#  raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
+#end
+#
+#desc "Publish gem+tgz+zip on RubyForge. You must make sure lib/version.rb is aligned with the CHANGELOG file"
+#task :publish_packages => [:verify_user, :verify_password, :package] do
+#  require 'meta_project'
+#  require 'rake/contrib/xforge'
+#  release_files = FileList[
+#    "pkg/#{PKG_FILE_NAME}.gem",
+#    "pkg/#{PKG_FILE_NAME}.tgz",
+#    "pkg/#{PKG_FILE_NAME}.zip"
+#  ]
+#
+#  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new(PKG_NAME)) do |xf|
+#    # Never hardcode user name and password in the Rakefile!
+#    xf.user_name = ENV['RUBYFORGE_USER']
+#    xf.password = ENV['RUBYFORGE_PASSWORD']
+#    xf.files = release_files.to_a
+#    xf.release_name = "Scruffy #{PKG_VERSION}"
+#  end
+#end