svg-graph-test 0.0.1

data/README.txt

@@ -0,0 +1,89 @@
+= SVG::Graph
+
+http://www.germane-software.com/software/SVG/SVG::Graph/
+
+== AUTHOR
+
+Sean E. Russell <serATgermaneHYPHENsoftwareDOTcom>
+Copyright 2004 Sean E. Russell
+This software is available under the Ruby license[LICENSE.txt]
+
+== DEVELOPERS
+
+* Claudio Bustos <clbustos_AT_gmail_DOT_com
+* Liehann Loots <liehhanl_AT_gmail_DOT_com
+* Piergiuliano Bossi <pgbossi_AT_gmail_DOT_com
+
+== DESCRIPTION:
+
+This is a  revision of the [SVG::Graph library](http://www.germane-software.com/software/SVG/SVG::Graph/) by Sean Russell with touch-ups to make it run on Ruby 1.9.x and be gem-installable. See History.txt for other changes
+
+SVG:::Graph is a pure Ruby library for generating charts, which are a type of graph where the values of one axis are not scalar. SVG::Graph has a verry similar API to the Perl library SVG::TT::Graph, and the resulting charts also look the same. This isn't surprising, because SVG::Graph started as a loose port of SVG::TT::Graph, although the internal code no longer resembles the Perl original at all.
+
+== FEATURES
+
+* Tested for Ruby versions 1.8.6, 1.8.7 and 1.9.*
+
+We are not sure that all the parts of the original SVG library work as expected under 1.9.x too. Please notify via github messages or on the Issues section if you find any bug.
+
+== LICENSE:
+
+(The Ruby Licence)
+
+SVG::Graph is copyrighted free software by Sean Russell <ser@germane-software.com>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see GPL.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/Rakefile

@@ -0,0 +1,42 @@
+# -*- ruby -*-
+# -*- coding: utf-8 -*-
+
+# TODO
+#
+#require 'rubygems'
+#require 'hoe'
+#
+#Hoe.plugin :git
+#
+#require_relative 'lib/svggraph'
+#
+#Hoe.spec 'svg-graph' do
+#  self.version=SVG::Graph::VERSION
+#  self.developer('Sean Russell', 'ser_AT_germane-software.com')
+#  self.developer('Claudio Bustos', 'clbustos_AT_gmail.com')
+#  self.developer('Liehann Loots','liehhanl_AT_gmail.com')
+#  self.developer('Piergiuliano Bossi','pgbossi_AT_gmail.com')
+#  self.developer('Manuel Widmer','m-widmer_AT_gmx.com')
+#  self.rubyforge_name = 'ruby-statsample' # if different than 'svg_graph'
+#  self.remote_rdoc_dir = 'svg-graph'
+#end
+
+# by default run all unit tests with 'rake test'
+task default: [:test]
+
+task :test do
+  [
+    "test/test_data_point.rb",
+    "test/test_plot.rb",
+    "test/test_svg_graph.rb",
+    "test/test_graph.rb",
+    "test/run_examples_and_percy.io.rb"
+  ].each do |file|
+    # exec all above scripts (with simplecov if env is set)
+    args = file
+    if ENV['COVERAGE']
+      args = '-r ./test/simplecov ' + file
+    end
+    ruby args
+  end
+end

data/lib/SVG/Graph/Bar.rb

@@ -0,0 +1,154 @@
+require 'rexml/document'
+require_relative 'Graph'
+require_relative 'BarBase'
+
+module SVG
+  module Graph
+    # === Create presentation quality SVG bar graphs easily
+    #
+    # = Synopsis
+    #
+    #   require 'SVG/Graph/Bar'
+    #
+    #   fields = %w(Jan Feb Mar);
+    #   data_sales_02 = [12, 45, 21]
+    #
+    #   graph = SVG::Graph::Bar.new(
+    #     :height => 500,
+    #     :width => 300,
+    #     :fields => fields
+    #   )
+    #
+    #   graph.add_data(
+    #     :data => data_sales_02,
+    #     :title => 'Sales 2002'
+    #   )
+    #
+    #   print "Content-type: image/svg+xml\r\n\r\n"
+    #   print graph.burn
+    #
+    # = Description
+    #
+    # This object aims to allow you to easily create high quality
+    # SVG[http://www.w3c.org/tr/svg bar graphs. You can either use the default
+    # style sheet or supply your own. Either way there are many options which
+    # can be configured to give you control over how the graph is generated -
+    # with or without a key, data elements at each point, title, subtitle etc.
+    #
+    # = Notes
+    #
+    # The default stylesheet handles upto 12 data sets, if you
+    # use more you must create your own stylesheet and add the
+    # additional settings for the extra data sets. You will know
+    # if you go over 12 data sets as they will have no style and
+    # be in black.
+    #
+    # = Examples
+    #
+    # * http://germane-software.com/repositories/public/SVG/test/test.rb
+    #
+    # = See also
+    #
+    # * SVG::Graph::Graph
+    # * SVG::Graph::BarHorizontal
+    # * SVG::Graph::Line
+    # * SVG::Graph::Pie
+    # * SVG::Graph::Plot
+    # * SVG::Graph::TimeSeries
+    class Bar < BarBase
+      include REXML
+
+      protected
+
+      def get_x_labels
+        @config[:fields]
+      end
+
+      def get_y_labels
+        maxvalue = max_value
+        minvalue = min_value
+        range = maxvalue - minvalue
+        # add some padding on top of the graph
+        if range == 0
+          maxvalue += 10
+        else
+          maxvalue += range / 20.0
+        end
+        scale_range = maxvalue - minvalue
+
+        @y_scale_division = scale_divisions || (scale_range / 10.0)
+
+        if scale_integers
+          @y_scale_division = @y_scale_division < 1 ? 1 : @y_scale_division.round
+        end
+
+        rv = []
+        if maxvalue%@y_scale_division != 0
+          maxvalue = maxvalue + @y_scale_division
+        end
+        minvalue.step( maxvalue, @y_scale_division ) {|v| rv << v}
+        return rv
+      end
+
+      def x_label_offset( width )
+        width / 2.0
+      end
+
+      def draw_data
+        minvalue = min_value
+        fieldwidth = field_width
+
+        unit_size = field_height
+        bargap = bar_gap ? (fieldwidth < 10 ? fieldwidth / 2 : 10) : 0
+
+        bar_width = fieldwidth - bargap
+        bar_width /= @data.length if stack == :side
+
+        bottom = @graph_height
+
+        field_count = 0
+        @config[:fields].each_index { |i|
+          dataset_count = 0
+          for dataset in @data
+            total = 0
+            dataset[:data].each {|x|
+              total += x
+            }
+
+            # cases (assume 0 = +ve):
+            #   value  min  length
+            #    +ve   +ve  value - min
+            #    +ve   -ve  value - 0
+            #    -ve   -ve  value.abs - 0
+
+            value = dataset[:data][i] / @y_scale_division.to_f
+
+            left = (fieldwidth * field_count)
+
+            length = (value.abs - (minvalue > 0 ? minvalue : 0)) * unit_size
+            # top is 0 if value is negative
+            top = bottom - (((value < 0 ? 0 : value) - minvalue) * unit_size)
+            left += bar_width * dataset_count if stack == :side
+
+            @graph.add_element( "rect", {
+              "x" => left.to_s,
+              "y" => top.to_s,
+              "width" => bar_width.to_s,
+              "height" => length.to_s,
+              "class" => "fill#{dataset_count+1}"
+            })
+            value_string = ""
+            value_string += (@number_format % dataset[:data][i]) if show_actual_values
+            percent = 100.0 * dataset[:data][i] / total
+            value_string += " (" + percent.round.to_s + "%)" if show_percent
+            make_datapoint_text(left + bar_width/2.0, top - font_size/2, value_string)
+            # number format shall not apply to popup (use .to_s conversion)
+            add_popup(left + bar_width/2.0, top , value_string)
+            dataset_count += 1
+          end
+          field_count += 1
+        }
+      end
+    end
+  end
+end

data/lib/SVG/Graph/BarBase.rb

@@ -0,0 +1,149 @@
+require 'rexml/document'
+require_relative 'Graph'
+
+module SVG
+  module Graph
+		# = Synopsis
+		#
+		# A superclass for bar-style graphs.  Do not attempt to instantiate
+		# directly; use one of the subclasses instead.
+		#
+    # = Author
+    #
+    # Sean E. Russell <serATgermaneHYPHENsoftwareDOTcom>
+		#
+    # Copyright 2004 Sean E. Russell
+		# This software is available under the Ruby license[LICENSE.txt]
+    #
+    class BarBase < SVG::Graph::Graph
+			# Ensures that :fields are provided in the configuration.
+      def initialize config
+        raise "fields was not supplied or is empty" unless config[:fields] &&
+        config[:fields].kind_of?(Array) &&
+        config[:fields].length > 0
+        super
+      end
+
+      # In addition to the defaults set in Graph::initialize, sets
+      # [bar_gap] true
+      # [stack] :overlap
+      def set_defaults
+        init_with( :bar_gap => true, :stack => :overlap, :show_percent => false, :show_actual_values => true)
+      end
+
+      #   Whether to have a gap between the bars or not, default
+      #   is true, set to false if you don't want gaps.
+      attr_accessor :bar_gap
+      #   How to stack data sets.  :overlap overlaps bars with
+      #   transparent colors, :top stacks bars on top of one another,
+      #   :side stacks the bars side-by-side. Defaults to :overlap.
+      attr_accessor :stack
+      # If true, display the percentage value of each bar. Default: false
+      attr_accessor :show_percent
+      # If true, display the actual field values in the data labels. Default: true
+      attr_accessor :show_actual_values
+      protected
+
+      # space in px between x-labels, we override the Graph version because
+      # we need the extra space (i.e. don't subtract 1 from get_x_labels.length)
+      def field_width
+        # don't use -1 otherwise bar is out of bounds
+        @graph_width.to_f / ( get_x_labels.length )
+      end
+
+      def max_value
+        @data.collect{|x| x[:data].max}.max
+      end
+
+      def min_value
+        min = 0
+        if min_scale_value.nil?
+          min = @data.collect{|x| x[:data].min}.min
+          # by default bar should always start from zero unless there are negative values
+          min = min > 0 ? 0 : min
+        else
+          min = min_scale_value
+        end
+        return min
+      end
+
+      def get_css
+        return <<EOL
+/* default fill styles for multiple datasets (probably only use a single dataset on this graph though) */
+.key1,.fill1{
+	fill: #ff0000;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 0.5px;
+}
+.key2,.fill2{
+	fill: #0000ff;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+.key3,.fill3{
+	fill: #00ff00;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+.key4,.fill4{
+	fill: #ffcc00;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+.key5,.fill5{
+	fill: #00ccff;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+.key6,.fill6{
+	fill: #ff00ff;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+.key7,.fill7{
+	fill: #00ffff;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+.key8,.fill8{
+	fill: #ffff00;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+.key9,.fill9{
+	fill: #cc6666;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+.key10,.fill10{
+	fill: #663399;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+.key11,.fill11{
+	fill: #339900;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+.key12,.fill12{
+	fill: #9966FF;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;
+}
+EOL
+      end
+    end
+  end
+end

data/lib/SVG/Graph/BarHorizontal.rb

@@ -0,0 +1,155 @@
+require 'rexml/document'
+require_relative 'BarBase'
+
+module SVG
+  module Graph
+    # === Create presentation quality SVG horitonzal bar graphs easily
+    #
+    # = Synopsis
+    #
+    #   require 'SVG/Graph/BarHorizontal'
+    #
+    #   fields = %w(Jan Feb Mar)
+    #   data_sales_02 = [12, 45, 21]
+    #
+    #   graph = SVG::Graph::BarHorizontal.new({
+    #     :height => 500,
+    #     :width => 300,
+    #     :fields => fields,
+    #   })
+    #
+    #   graph.add_data({
+    #     :data => data_sales_02,
+    #     :title => 'Sales 2002',
+    #   })
+    #
+    #   print "Content-type: image/svg+xml\r\n\r\n"
+    #   print graph.burn
+    #
+    # = Description
+    #
+    # This object aims to allow you to easily create high quality
+    # SVG horitonzal bar graphs. You can either use the default style sheet
+    # or supply your own. Either way there are many options which can
+    # be configured to give you control over how the graph is
+    # generated - with or without a key, data elements at each point,
+    # title, subtitle etc.
+    #
+    # = Examples
+    #
+    # * http://germane-software.com/repositories/public/SVG/test/test.rb
+    #
+    # = See also
+    #
+    # * SVG::Graph::Graph
+    # * SVG::Graph::Bar
+    # * SVG::Graph::Line
+    # * SVG::Graph::Pie
+    # * SVG::Graph::Plot
+    # * SVG::Graph::TimeSeries
+    #
+    # == Author
+    #
+    # Sean E. Russell <serATgermaneHYPHENsoftwareDOTcom>
+    #
+    # Copyright 2004 Sean E. Russell
+    # This software is available under the Ruby license[LICENSE.txt]
+    #
+    class BarHorizontal < BarBase
+      # In addition to the defaults set in BarBase::set_defaults, sets
+      # [rotate_y_labels] true
+      # [show_x_guidelines] true
+      # [show_y_guidelines] false
+      def set_defaults
+        super
+        init_with(
+          :rotate_y_labels    => true,
+          :show_x_guidelines  => true,
+          :show_y_guidelines  => false
+        )
+        # self.right_align = self.right_font = 1
+      end
+
+      protected
+
+      def get_x_labels
+        maxvalue = max_value
+        minvalue = min_value
+        range = maxvalue - minvalue
+        top_pad = range == 0 ? 10 : range / 20.0
+        scale_range = (maxvalue + top_pad) - minvalue
+
+        @x_scale_division = scale_divisions || (scale_range / 10.0)
+
+        if scale_integers
+          @x_scale_division = @x_scale_division < 1 ? 1 : @x_scale_division.round
+        end
+
+        rv = []
+        #if maxvalue%@x_scale_division != 0
+        #  maxvalue = maxvalue + @x_scale_division
+        #end
+        minvalue.step( maxvalue, @x_scale_division ) {|v| rv << v}
+        return rv
+      end
+
+      def get_y_labels
+        @config[:fields]
+      end
+
+      def y_label_offset( height )
+        height / -2.0
+      end
+
+      def draw_data
+        minvalue = min_value
+        fieldheight = field_height
+
+        bargap = bar_gap ? (fieldheight < 10 ? fieldheight / 2 : 10) : 0
+
+        bar_height = fieldheight - bargap
+        bar_height /= @data.length if stack == :side
+        y_mod = (bar_height / 2) + (font_size / 2)
+        field_count = 1
+
+        @config[:fields].each_index { |i|
+          dataset_count = 0
+          for dataset in @data
+            total = 0
+            dataset[:data].each {|x|
+              total += x
+            }
+            value = dataset[:data][i]
+
+            top = @graph_height - (fieldheight * field_count) + (bargap/2)
+            top += (bar_height * dataset_count) if stack == :side
+            # cases (assume 0 = +ve):
+            #   value  min  length          left
+            #    +ve   +ve  value.abs - min minvalue.abs
+            #    +ve   -ve  value.abs - 0   minvalue.abs
+            #    -ve   -ve  value.abs - 0   minvalue.abs + value
+            length = (value.abs - (minvalue > 0 ? minvalue : 0))/@x_scale_division.to_f * field_width
+            left = (minvalue.abs + (value < 0 ? value : 0))/@x_scale_division.to_f * field_width
+
+            @graph.add_element( "rect", {
+              "x" => left.to_s,
+              "y" => top.to_s,
+              "width" => length.to_s,
+              "height" => bar_height.to_s,
+              "class" => "fill#{dataset_count+1}"
+            })
+            value_string = ""
+            value_string += (@number_format % dataset[:data][i]) if show_actual_values
+            percent = 100.0 * dataset[:data][i] / total
+            value_string += " (" + percent.round.to_s + "%)" if show_percent
+            make_datapoint_text(left+length+5, top+y_mod, value_string, "text-anchor: start; ")
+            # number format shall not apply to popup (use .to_s conversion)
+            add_popup(left+length, top+y_mod , value_string)
+            dataset_count += 1
+          end
+          field_count += 1
+        }
+      end
+    end
+  end
+end