fnando-chart 0.0.1

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nando Vieira
+
+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/README.markdown

@@ -0,0 +1,178 @@
+Chart
+=====
+
+Chart is a wrapper for the excellent [ChartDirector](http://www.advsofteng.com/) library. 
+It does not cover all charts; only those I need!
+
+Supported charts: grouped bars
+
+Installation
+------------
+
+### Installing ChartDirector
+
+1. Download ChartDirector for Ruby at <http://www.advsofteng.com/download.html>
+2. Extract the files
+3. Run `ruby install.rb`
+
+### Installing Chart
+
+You can use it as gem or plugin:
+
+	sudo gem install fnando-chart --source=http://gems.github.com
+	
+or
+
+	script/plugin install git://github.com/fnando/chart.git
+
+Usage
+-----
+
+Just require the Chart library.
+
+	require "chart"
+
+### Bars
+
+	# set some data
+	data  = [3600.99, 1479.00, 900.10]
+
+	chart = Chart::Bar.new({
+	  :width => 400,
+	  :height => 240,
+	  :data => data,
+	  :margins   => [50, 25],
+	  :plot_area => [320, 180],
+	  :labels => %w(Ruby Python Erlang),
+	  :multicolor => false
+	})
+
+	chart.write("bar.png")
+
+Result:
+
+![Bars chart](http://f.simplesideias.com.br/chart/bar.png)
+
+### Multicolor Bars
+
+	# set some data
+	data  = [3600.99, 1479.00, 900.10]
+
+	chart = Chart::Bar.new({
+	  :width => 400,
+	  :height => 240,
+	  :legend => %w(Ruby Python Erlang),
+	  :data => data,
+	  :margins   => [50, 25],
+	  :plot_area => [320, 180],
+	  :labels => %w(Jan Feb Mar),
+	  :multicolor => true
+	})
+
+	chart.write("multicolorbar.png")
+
+Result:
+
+![Multicolor Bars chart](http://f.simplesideias.com.br/chart/multicolorbar.png)
+
+### Grouped Bars
+
+	# set some data
+	in_data  = [3600.99, 1479.00, 900.10]
+	out_data = [728.77, 356.98, 1100.00]
+
+	chart = Chart::GroupedBar.new({
+	  :width => 400,
+	  :height => 240,
+	  :colors => [Chart::GREEN, Chart::RED],
+	  :legend => %w(In Out),
+	  :data => [in_data, out_data],
+	  :margins   => [50, 25],
+	  :plot_area => [320, 180],
+	  :labels => %w(Jan Feb Mar)
+	})
+
+	chart.write("groupedbar.png")
+
+Result:
+
+![Grouped Bars chart](http://f.simplesideias.com.br/chart/groupedbar.png)
+
+### Pie
+
+	# set some data
+	data    = [1000, 500, 300, 30]
+
+	# set the legend
+	legend  = ["Ruby", "Python", "Erlang", "PHP"]
+
+	chart = Chart::Pie.new({
+	  :width      => 400,
+	  :height     => 250,
+	  :data       => data,
+	  :margins    => [150, 130],
+	  :legend     => legend,
+	  :radius     => 80,
+	  :position   => [310, 80], # [legend_x, legend_y]
+	  :label_format => "${value|2,.}\n({percent}%)"
+	})
+
+	chart.write("pie.png")
+
+Result:
+
+![Pie chart](http://f.simplesideias.com.br/chart/pie.png)
+
+To hide the pie label, just set the `label_format` to `nil`:
+
+	# set some data
+	data    = [1000, 500, 300, 30]
+
+	# set the legend
+	legend  = ["Ruby", "Python", "Erlang", "PHP"]
+
+	chart = Chart::Pie.new({
+	  :width      => 400,
+	  :height     => 250,
+	  :data       => data,
+	  :margins    => [150, 130],
+	  :legend     => legend,
+	  :radius     => 80,
+	  :position   => [310, 80], # [legend_x, legend_y]
+	  :label_format => nil
+	})
+
+	chart.write("pie_without_labels.png")
+
+Result:
+
+![Pie chart without label](http://f.simplesideias.com.br/chart/pie_without_labels.png)
+
+MAINTAINER
+----------
+
+* Nando Vieira ([http://simplesideias.com.br](http://simplesideias.com.br))
+
+LICENSE:
+--------
+
+(The MIT License)
+
+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

@@ -0,0 +1,78 @@
+require 'rake'
+
+PKG_FILES = %w(init.rb Rakefile chart.gemspec License.txt README.markdown) + 
+  Dir["lib/**/*"]
+
+spec = Gem::Specification.new do |s|
+  s.name = "chart"
+  s.version = "0.0.1"
+  s.summary = "A simple ChartDirector wrapper"
+  s.authors = ["Nando Vieira"]
+  s.email = ["fnando.vieira@gmail.com"]
+  s.homepage = "http://github.com/fnando/chart"
+  s.description = ""
+  s.has_rdoc = false
+  s.files = PKG_FILES
+	
+  s.add_dependency "rubigen"
+end
+
+namespace :gem do
+  # Thanks to the Merb project for this code.
+  desc "Update Github Gemspec"
+  task :update_gemspec do
+    skip_fields = %w(new_platform original_platform specification_version loaded required_ruby_version rubygems_version platform)
+    
+    result = "# WARNING : RAKE AUTO-GENERATED FILE. DO NOT MANUALLY EDIT!\n"
+    result << "# RUN : 'rake gem:update_gemspec'\n\n"
+    result << "Gem::Specification.new do |s|\n"
+    
+    spec.instance_variables.each do |ivar|
+      value = spec.instance_variable_get(ivar)
+      name  = ivar.split("@").last
+      next if name == "date"
+      
+      next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
+      if name == "dependencies"
+        value.each do |d|
+          dep, *ver = d.to_s.split(" ")
+          result <<  "  s.add_dependency #{dep.inspect}, #{ver.join(" ").inspect.gsub(/[()]/, "").gsub(", runtime", "")}\n"
+        end
+      else
+        case value
+        when Array
+          value =  name != "files" ? value.inspect : value.inspect.split(",").join(",\n")
+        when FalseClass
+        when TrueClass
+        when Fixnum
+        when String
+          value = value.inspect
+        else
+          value = value.to_s.inspect
+        end
+        result << "  s.#{name} = #{value}\n"
+      end
+    end
+    
+    result << "end"
+    File.open(File.join(File.dirname(__FILE__), "#{spec.name}.gemspec"), "w"){|f| f << result}
+  end
+  
+  desc "Build gem"
+  task :build => [:update_gemspec] do
+    system "rm *.gem"
+    system "gem build #{spec.instance_variable_get('@name')}.gemspec"
+  end
+  
+  desc "Install gem"
+  task :install => [:update_gemspec, :build] do
+    system "sudo gem install #{spec.instance_variable_get('@name')}"
+  end
+end
+
+desc "Run all specs"
+task :spec do
+  Dir.glob("spec/chart/*_spec.rb").each do |file| 
+    system "ruby #{file} -c"
+  end
+end

data/chart.gemspec

@@ -0,0 +1,27 @@
+# WARNING : RAKE AUTO-GENERATED FILE. DO NOT MANUALLY EDIT!
+# RUN : 'rake gem:update_gemspec'
+
+Gem::Specification.new do |s|
+  s.authors = ["Nando Vieira"]
+  s.require_paths = ["lib"]
+  s.required_rubygems_version = ">= 0"
+  s.has_rdoc = false
+  s.files = ["init.rb",
+ "Rakefile",
+ "chart.gemspec",
+ "License.txt",
+ "README.markdown",
+ "lib/chart",
+ "lib/chart/bar.rb",
+ "lib/chart/base.rb",
+ "lib/chart/grouped_bar.rb",
+ "lib/chart/pie.rb",
+ "lib/chart.rb"]
+  s.email = ["fnando.vieira@gmail.com"]
+  s.version = "0.0.1"
+  s.homepage = "http://github.com/fnando/chart"
+  s.name = "chart"
+  s.summary = "A simple ChartDirector wrapper"
+  s.add_dependency "rubigen", ">= 0"
+  s.bindir = "bin"
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/lib/chart"

data/lib/chart/bar.rb

@@ -0,0 +1,35 @@
+module Chart
+  class Bar < Base
+    def instantiate
+      # instantiate a new chart
+      @object = ChartDirector::XYChart.new(@width, @height) if @width && @height
+    end
+    
+    def generate
+      # set the plot area
+      @object.setPlotArea(@margins[0], @margins[1], @plot_area[0], @plot_area[1], 0xe9e9e9, 0xf5f5f5)
+      
+      # set the legend position
+      @object.addLegend(@margins[0], 0, false, "normal", 8).setBackground(ChartDirector::Transparent)
+      
+      # set the top margin
+      @object.yAxis.setTopMargin(@plot_top_margin)
+      
+      # set the labels
+      @object.xAxis.setLabels(@labels)
+      
+      # add data to layer
+      if @multicolor
+        @object.addBarLayer3(@data, @colors, @legend, 0)
+      else
+        @object.addBarLayer(@data, @colors.first)
+      end
+    end
+    
+    private
+      def defaults!
+        super
+        @colors = Chart::COLORS
+      end
+  end
+end

data/lib/chart/base.rb

@@ -0,0 +1,102 @@
+module Chart
+  # set some color constants
+  GREEN = 0x5EC200
+  RED   = 0xE05257
+  
+  COLORS = [
+    0x719CE4,
+    0xFF8F00,
+    0x94CB47,
+    0xff3333,
+    0x7412C5,
+    0x78722F,
+    0xFFE921,
+    0x666666,
+    0x7F2548,
+    0xcccccc,
+    0x990000,
+    0x0B66AF,
+    0xFF0066,
+    0xBBD6E3,
+    0xBEB1D2
+  ]
+  
+  class Base
+    # Set the chart width
+    attr_accessor :width
+    
+    # Set the chart height
+    attr_accessor :height
+    
+    # Set the labels
+    attr_writer :labels
+    
+    # Set the chart legend
+    attr_writer :legend
+    
+    # Set the chart data
+    attr_accessor :data
+    
+    # Set the plot area
+    attr_accessor :plot_area
+    
+    # Set the chart left-top margins
+    attr_accessor :margins
+    
+    # Set bar colors
+    attr_accessor :colors
+    
+    # Set if bar is multicolor
+    attr_accessor :multicolor
+    
+    # Set plot top margin
+    attr_accessor :plot_top_margin
+    
+    # Set position
+    attr_accessor :position
+    
+    # Set radius
+    attr_accessor :radius
+    
+    # Set label format
+    attr_accessor :label_format
+    
+    # The ChartDirector object
+    attr_accessor :object
+    
+    # Initialize a new chart object. Specify the
+    # chart attributes by providing a hash.
+    def initialize(options={})
+      defaults!
+      options.each {|name, value| send("#{name}=", value)}
+      instantiate
+    end
+    
+    # Save the chart image to the specified path
+    def write(path)
+      generate
+      @object.makeChart(path)
+    end
+    
+    # Wrapper to the ActionView helpers
+    def helper
+      Helper.instance
+    end
+    
+    # Labels attribute reader
+    def labels
+      @labels
+    end
+    
+    # Legend attribute reader
+    def legend
+      @legend
+    end
+    
+    private
+      # Set the chart defaults; should be overwritten.
+      def defaults!
+        @plot_top_margin = 50
+      end
+  end
+end

data/lib/chart/grouped_bar.rb

@@ -0,0 +1,30 @@
+module Chart
+  class GroupedBar < Base
+    def instantiate
+      # instantiate a new chart
+      @object = ChartDirector::XYChart.new(@width, @height) if @width && @height
+    end
+    
+    def generate
+      # set the plot area
+      @object.setPlotArea(@margins[0], @margins[1], @plot_area[0], @plot_area[1], 0xe9e9e9, 0xf5f5f5)
+      
+      # set the legend position
+      @object.addLegend(@margins[0], 0, false, "normal", 8).setBackground(ChartDirector::Transparent)
+      
+      # set the top margin
+      @object.yAxis.setTopMargin(@plot_top_margin)
+      
+      # set the labels
+      @object.xAxis.setLabels(@labels)
+      
+      # create the layer
+      layer = @object.addBarLayer2(ChartDirector::Side, 0)
+      
+      # add data to layer
+      @data.each_with_index do |data, index|
+        layer.addDataSet(data, @colors[index], legend[index])
+      end
+    end
+  end
+end

data/lib/chart/pie.rb

@@ -0,0 +1,41 @@
+module Chart
+  class Pie < Base
+    def instantiate
+      # instantiate a new chart
+      @object = ChartDirector::PieChart.new(@width, @height) if @width && @height
+    end
+    
+    def generate
+      # set the pie size and position
+      @object.setPieSize(@margins[0], @margins[1], @radius)
+      
+      # set data and labels
+      @object.setData(@data, @legend)
+      
+      # set label format
+      @object.setLabelFormat(@label_format)
+      
+      # hide label format if is nil
+      @object.setLabelStyle("normal", 8, ChartDirector::Transparent) if @label_format.nil?
+      
+      # add legend box
+      @object.addLegend(@position[0], @position[1])
+      
+      # set colors
+      @object.setColors2(ChartDirector::DataColor, @colors)
+      
+      # set label position
+      @object.setLabelPos(15, ChartDirector::LineColor)
+      
+      # set label line color
+      @object.setJoinLine(0x666666)
+    end
+    
+    private
+      def defaults!
+        super
+        @colors = Chart::COLORS
+        @label_format = "{percent}%"
+      end
+  end
+end

data/lib/chart.rb

@@ -0,0 +1,11 @@
+require "chartdirector"
+
+base_dir = File.dirname(__FILE__) + "/chart"
+files = %w(
+  base
+  bar
+  grouped_bar
+  pie
+)
+
+files.each {|file| require "#{base_dir}/#{file}" }

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: fnando-chart
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubigen
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: 
+- fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- init.rb
+- Rakefile
+- chart.gemspec
+- License.txt
+- README.markdown
+- lib/chart
+- lib/chart/bar.rb
+- lib/chart/base.rb
+- lib/chart/grouped_bar.rb
+- lib/chart/pie.rb
+- lib/chart.rb
+has_rdoc: false
+homepage: http://github.com/fnando/chart
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simple ChartDirector wrapper
+test_files: []
+