svg_charts 1.0

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/README.rdoc

@@ -0,0 +1,52 @@
+= SVGCharts
+
+Draw charts using SVG.
+
+== Installation
+
+  gem install svg_charts
+
+== Usage
+
+  # file.rb
+  require "rubygems"
+  require "svg_charts"
+
+  line_chart = SVGCharts::Line.new({
+    :height => 320,
+    :width => 680,
+    :y_retreat => 20,
+    :y_label => "Numbers",
+    :x_retreat => 20,
+    :x_label => "Letters",
+    :x_scale => ["A", "B", "C"],
+    :data => [10, 20, 30],
+    :data_color => "#000000"
+  })
+
+  @scale = line_chart.draw_scale
+  @chart = line_chart.draw_chart
+
+  # file.html
+  <svg width="680" height="350">
+    <%= @scale %>
+    <%= @chart %>
+  </svg>
+
+== Maintainer
+
+* Rogério Zambon (http://rogeriozambon.com)
+
+== Collaborators
+
+* André Ronix (http://www.linkedin.com/pub/andr%C3%A9-s-ronix/27/212/3b2)
+
+== 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/VERSION

@@ -0,0 +1 @@
+1.0

data/lib/charts/elements.rb

@@ -0,0 +1,25 @@
+module SVGElements
+  def line(params = {})
+    "<line x1=\"#{params[:x1]}\" y1=\"#{params[:y1]}\" x2=\"#{params[:x2]}\" y2=\"#{params[:y2]}\" stroke-width=\"#{params[:line_width]}\" stroke=\"#{params[:color]}\" />"
+  end
+
+  def line_dashed(params = {})
+    "<line x1=\"#{params[:x1]}\" y1=\"#{params[:y1]}\" x2=\"#{params[:x2]}\" y2=\"#{params[:y2]}\" stroke-width=\"#{params[:line_width]}\" stroke=\"#{params[:color]}\" stroke-dasharray=\"5,5\" />"
+  end
+
+  def circle(params = {})
+    "<circle cx=\"#{params[:x]}\" cy=\"#{params[:y]}\" r=\"#{params[:radius]}\" stroke=\"#{params[:line_color]}\" stroke-width=\"#{params[:line_width]}\" fill=\"#{params[:background]}\" />"
+  end
+
+  def rect(params = {})
+    "<rect x=\"#{params[:x]}\" y=\"#{params[:y]}\" width=\"#{params[:width]}\" height=\"#{params[:height]}\" fill=\"#{params[:color]}\" />"
+  end
+
+  def text(params = {})
+    "<text x=\"#{params[:x]}\" y=\"#{params[:y]}\" fill=\"#{params[:color]}\" font-size=\"#{params[:font_size]}\" font-weight=\"#{params[:font_weight]}\">#{params[:value]}</text>"
+  end
+
+  def text_with_rotation(params = {})
+    "<text x=\"#{params[:x]}\" y=\"#{params[:y]}\" fill=\"#{params[:color]}\" font-size=\"#{params[:font_size]}\" font-weight=\"#{params[:font_weight]}\" transform=\"rotate(#{params[:rotate]})\">#{params[:value]}</text>"
+  end
+end

data/lib/charts/line.rb

@@ -0,0 +1,147 @@
+module SVGCharts
+  class Line
+    include SVGElements
+
+    def initialize(options = {})
+      raise ArgumentError if options.empty?
+
+      [:width, :height, :y_retreat, :y_label, :x_retreat, :x_label, :x_scale, :data, :data_color].each do |key|
+        raise ArgumentError unless options.has_key?(key)
+      end
+
+      @width = options[:width]
+      @height = options[:height]
+
+      @y_retreat = options[:y_retreat]
+      @y_label = options[:y_label]
+
+      @x_retreat = options[:x_retreat]
+      @x_label = options[:x_label]
+      @x_scale = options[:x_scale]
+
+      @data = options[:data]
+      @data_color = options[:data_color]
+    end
+
+    def draw_scale
+      scales = ""
+
+      scales << line({
+        :x1 => @x_retreat - 8,
+        :x2 => @x_retreat - 8,
+        :y1 => @y_retreat - 2,
+        :y2 => @height + 13,
+        :line_width => 2,
+        :color => "#aaa"
+      })
+
+      scales << line({
+        :x1 => 0,
+        :x2 => @width,
+        :y1 => @height,
+        :y2 => @height,
+        :line_width => 2,
+        :color => "#aaa"
+      })
+
+      scales << text({
+        :x => @width/2 - (@y_label.length * 2),
+        :y => @height + 30,
+        :color => "#bbb",
+        :font_size => 11,
+        :font_weight => "bold",
+        :value => @x_label
+      })
+
+      scales << text_with_rotation({
+        :x => @height/2 - (@y_label.length * 2),
+        :y => 8,
+        :color => "#bbb",
+        :font_size => 11,
+        :font_weight => "bold",
+        :rotate => "270 #{@height/2} #{@height/2}",
+        :value => @y_label
+      })
+
+      scales
+    end
+
+    def draw_chart
+      calculate_coordinates
+
+      elements = ""
+
+      @coordinates.each_with_index do |coordinate, i|
+        elements << line({
+          :x1 => coordinate[0],
+          :x2 => coordinate[1],
+          :y1 => coordinate[2],
+          :y2 => coordinate[3],
+          :line_width => 1,
+          :color => "#999"
+        })
+
+        elements << line_dashed({
+          :x1 => coordinate[0],
+          :x2 => coordinate[0],
+          :y1 => @height,
+          :y2 => coordinate[2],
+          :line_width => 1,
+          :color => "#b9b9b9"
+        })
+
+        elements << circle({
+          :x => coordinate[0],
+          :y => coordinate[2],
+          :radius => 2,
+          :background => "#fff",
+          :line_width => 2,
+          :line_color => "#444"
+        })
+
+        elements << text({
+          :x => coordinate[0] - 10,
+          :y => coordinate[2] - 10,
+          :color => @data_color,
+          :font_size => 11,
+          :font_weight => "bold",
+          :value => @data[i]
+        })
+
+        elements << text({
+          :x => coordinate[0] - 5,
+          :y => @height + 12,
+          :color => "#999",
+          :font_size => 10,
+          :font_weight => "normal",
+          :value => @x_scale[i]
+        })
+      end
+
+      elements
+    end
+
+    private
+    def calculate_coordinates
+      @coordinates = []
+
+      y_positions = (@height - @y_retreat)/@data.max
+      x_positions = @width/@data.size
+
+      @data.each_with_index do |value, i|
+        x1 = @x_retreat + (x_positions * i)
+        y1 = @height - (y_positions * value)
+
+        unless @data[i + 1].nil?
+          x2 = @x_retreat + (x_positions * (i + 1))
+          y2 = @height - (y_positions * @data[i + 1])
+        else
+          x2 = x1
+          y2 = y1
+        end
+
+        @coordinates << [x1.abs, x2.abs, y1.abs, y2.abs]
+      end
+    end
+  end
+end

data/lib/svg_charts.rb

@@ -0,0 +1,2 @@
+require "charts/elements"
+require "charts/line"

data/spec/charts/line_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe SVGCharts::Line do
+  context "missing parameters" do
+    it "when hash empty" do
+      expect { chart = SVGCharts::Line.new }.to raise_error(ArgumentError)
+    end
+
+    it "when the hash keys is incomplete" do
+      options = {
+        :width => 300,
+        :height => 300
+      }
+
+      expect { chart = SVGCharts::Line.new options }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "when generated" do
+    before do
+      @options = {
+        :height => 320,
+        :width => 680,
+        :y_retreat => 20,
+        :y_label => "Numbers",
+        :x_retreat => 20,
+        :x_label => "Letters",
+        :x_scale => ["A", "B", "C"],
+        :data => [10, 20, 30],
+        :data_color => "#000000"
+      }
+    end
+
+    it "check chart values" do
+      line_chart = SVGCharts::Line.new(@options).draw_chart
+
+      values = line_chart.gsub( /<[^>]*>/, " ").split
+      values.should include("10")
+      values.should include("20")
+      values.should include("30")
+      values.should include("A")
+      values.should include("B")
+      values.should include("C")
+    end
+
+    it "check scale values" do
+      line_chart = SVGCharts::Line.new(@options).draw_scale
+
+      values = line_chart.gsub( /<[^>]*>/, " ").split
+      values.should include("Letters")
+      values.should include("Numbers")
+    end
+
+    def count_words(expression, target)
+      counter = 0
+
+      expression.split.each do |word|
+        counter += 1 if word.include? target
+      end
+
+      counter
+    end
+
+    it "check chart elements" do
+      line_chart = SVGCharts::Line.new(@options).draw_chart
+
+      count_words(line_chart, "<line").should == 6
+      count_words(line_chart, "<text").should == 6
+      count_words(line_chart, "<circle").should == 3
+    end
+
+    it "check scale elements" do
+      line_chart = SVGCharts::Line.new(@options).draw_scale
+
+      count_words(line_chart, "<line").should == 2
+      count_words(line_chart, "<text").should == 2
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+Dir[File.expand_path("../../lib/charts", __FILE__) + "/*.rb"].each { |file| require file }

data/svg_charts.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.authors = ["Rogério Zambon"]
+  s.date = "2013-01-25"
+  s.description = "Draw charts using SVG."
+  s.email = "rogeriozambon@gmail.com"
+  s.files = [
+    ".rspec",
+    "lib/charts/elements.rb",
+    "lib/charts/line.rb",
+    "lib/svg_charts.rb",
+    "spec/spec_helper.rb",
+    "spec/charts/line_spec.rb",
+    "VERSION",
+    "README.rdoc",
+    "svg_charts.gemspec"
+  ]
+  s.homepage = "http://github.com/rogeriozambon/svg_charts"
+  s.name = "svg_charts"
+  s.require_paths = ["lib"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.8.23")
+  s.summary = s.description
+  s.version = "1.0"
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: svg_charts
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Rogério Zambon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-25 00:00:00.000000000 Z
+dependencies: []
+description: Draw charts using SVG.
+email: rogeriozambon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- lib/charts/elements.rb
+- lib/charts/line.rb
+- lib/svg_charts.rb
+- spec/spec_helper.rb
+- spec/charts/line_spec.rb
+- VERSION
+- README.rdoc
+- svg_charts.gemspec
+homepage: http://github.com/rogeriozambon/svg_charts
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.23
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Draw charts using SVG.
+test_files: []