svg-graph 1.0.5 → 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0a6c4dcff26a2412d42bb11f392ca6292afde8d
+  data.tar.gz: b91765dbbf54900ffeba3f665af1b17429e72d05
+SHA512:
+  metadata.gz: d63ea323203f76843f1ba2b07b1db9522b7619a871467064b7f06e87e9e4d55f94404a263d513c1d295e38f2377cec4beaba53549c30f4d8142a91cc6ef26550
+  data.tar.gz: e682a1ee1c37dfdad7f95a52942334ba3f0eee7a001779cf0fd696745f3a7cdb5a54f265312351365992a7602d984e1b003297e1987d4cae170b8c0c096f8032

data/History.txt

@@ -1,3 +1,21 @@
+TODO
+* fix axis titles positioning for timeseries and schedule graphs
+
+=== 2.0.0 / 2016-08-09
+* dropped support for ruby 1.8.7 [lumean]
+* Merge ErrBar graph from https://github.com/mondhs/svg-graph
+* Merge number formatting to have more readable floats from https://github.com/mondhs/svg-graph
+* fix warnings [lumean]
+* make TimeSeries and Schedule work with ruby >2.0 and the Date/DateTime stdlib [lumean]
+* dropped support for 'parsedate', instead TimeSeries and Schedule now accept a template to parse the date or time representation [lumean]
+* all ruby files in the test directory now run on ruby >2.0 and write output to files [lumean]
+* changed from autoload to static loading due to issues with unit-testing when the gem is not installed [lumean]
+* begin transition to minitest for tests [lumean]
+* merged fix for 100% pie graphs from https://github.com/endersstocker/svg-graph 
+* fix wrong margins for labels after merge of number formatting [lumean]
+* Add new option for locations for the axis titles (at the end of the axis instead of below / left from it) [lumean]
+* improved x-axis label location when x-axis marks are vertical and long [lumean]
+
 === 1.0.5 / 2011-09-03
 * enabled all svg_graph tests[liehann]
 

data/README.markdown

@@ -1,14 +1,98 @@
-SVG::Graph19
+SVG::Graph
 ============
 
 Description
 -----------
-This is a minor revision of the [SVG::Graph library](http://www.germane-software.com/software/SVG/SVG::Graph/) by Sean Russell with few minor touch-ups to make it run on Ruby 1.9.x and to have it [gem-installable](http://gemcutter.org/gems/svg-graph19).
+This is an effort to revive the [SVG::Graph library](http://www.germane-software.com/software/SVG/SVG::Graph/) by Sean Russell. I'd also like to thank Claudio Bustos for giving me permissions to continue publishing the gem under it's original name: [svg-graph](https://rubygems.org/gems/svg-graph)
 
-Warning
--------
-I'm not sure that all the parts of the original SVG library work as expected under 1.9.x too. Please notify me (via github messages or on the Issues section) if you find any bug.
+[Changelog](../master/History.txt)
+
+I'm maintaing in my free time, so I can't promise on any deadlines. Please notify me (via github messages or on the Issues section) if you find any bug.
+
+Contribute
+-----
+Pull requests are very welcome :-)
 
 Usage
 -----
-Yet to be written. Look at the original [SVG::Graph web page](http://www.germane-software.com/software/SVG/SVG::Graph/) for the moment (I'm not introducing new methods nor changing APIs, for the moment).
+
+For a complete list of configuration options please have a look at the source - most important [Graph.rb](../master/lib/SVG/Graph/Graph.rb), also checkout the subclasses (Pie, Bar, etc.) as they might provide additional options.
+
+You can require everything at once
+```ruby
+require 'svggraph'
+```
+or only the individual parts you need
+```ruby
+require 'SVG/Graph/Bar'
+require 'SVG/Graph/Line'
+...
+```
+
+In the following some examples to get you up to speed.
+
+### Bar
+```ruby
+require 'SVG/Graph/Bar'
+
+x_axis = ['1-10', '10-30', '30-50', '50-70', 'older']
+
+options = {  
+  :width             => 640,
+  :height            => 300,
+  :stack             => :side,  # the stack option is valid for Bar graphs only
+  :fields            => x_axis,
+  :graph_title       => "kg per head and year chocolate consumption",
+  :show_graph_title  => true,
+  :show_x_title      => true,
+  :x_title           => 'Age in years',
+  :show_y_title      => true,
+  :y_title           => 'kg/year',
+  :y_title_location  => :end,
+  :no_css            => true
+}
+
+male_data   = [2, 4, 6, 4, 2]
+female_data = [1, 5, 4, 5, 2.7]
+
+g = SVG::Graph::Bar.new(options)
+
+g.add_data( {
+    :data => female_data,
+    :title => "Female"
+  })
+g.add_data( {
+    :data => male_data,
+    :title => "Male"
+  })
+
+# graph.burn            # this returns a full valid xml document containing the graph  
+# graph.burn_svg_only   # this only returns the <svg>...</svg> node
+File.open('bar.svg', 'w') {|f| f.write(g.burn_svg_only)}
+```
+![example bar graph](https://cdn.rawgit.com/lumean/svg-graph2/master/examples/bar.svg)
+
+### BarHorizontal
+
+### ErrBar
+
+### Line
+
+### Pie
+
+### Plot
+
+### Schedule
+
+### TimeSeries
+
+
+Also have a look at the original [SVG::Graph web page](http://www.germane-software.com/software/SVG/SVG::Graph/), but note that this repository has already added some additional functionality, not available with the original.
+
+Build
+-----
+
+* Build gem:
+ *  gem build svg-graph.gemspec
+* Install:
+ *  gem install svg-graph-\<version>.gem

data/Rakefile

@@ -1,19 +1,31 @@
 # -*- ruby -*-
 # -*- coding: utf-8 -*-
-$:.unshift(File.dirname(__FILE__)+"/lib/")
 
-require 'rubygems'
-require 'hoe'
+# 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
 
-Hoe.plugin :git
-$:.unshift("./lib")
-require '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.rubyforge_name = 'ruby-statsample' # if different than 'svg_graph'
-  self.remote_rdoc_dir = 'svg-graph'
+# run all unit tests with 'rake test'
+task default: %w[test]
+
+task :test do
+  ruby "test/test_data_point.rb"
+  ruby "test/test_plot.rb"
+  ruby "test/test_svg_graph.rb"
 end

data/lib/SVG/Graph/Bar.rb

@@ -1,6 +1,6 @@
 require 'rexml/document'
-require 'SVG/Graph/Graph'
-require 'SVG/Graph/BarBase'
+require_relative 'Graph'
+require_relative 'BarBase'
 
 module SVG
   module Graph

data/lib/SVG/Graph/BarBase.rb

@@ -1,5 +1,5 @@
 require 'rexml/document'
-require 'SVG/Graph/Graph'
+require_relative 'Graph'
 
 module SVG
   module Graph
@@ -17,37 +17,38 @@ module SVG
     #
     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
+      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 )
-        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 )
+      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
-        protected
-        
-        def max_value
+      #   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
+      protected
+      
+      def max_value
         @data.collect{|x| x[:data].max}.max
-        end
+      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

data/lib/SVG/Graph/BarHorizontal.rb

@@ -1,5 +1,5 @@
 require 'rexml/document'
-require 'SVG/Graph/BarBase'
+require_relative 'BarBase'
 
 module SVG
   module Graph

data/lib/SVG/Graph/ErrBar.rb

@@ -0,0 +1,189 @@
+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 ErrBar < BarBase
+      include REXML
+
+        def initialize config
+            raise "fields was not supplied or is empty" unless config[:errorBars] &&
+            config[:errorBars].kind_of?(Array) &&
+            config[:errorBars].length > 0 
+            super
+        end 
+
+
+      # See Graph::initialize and BarBase::set_defaults
+      def set_defaults 
+        super
+        self.top_align = self.top_font = 1
+      end
+
+      protected
+
+      def get_x_labels
+        @config[:fields]
+      end
+
+      def get_y_labels
+        maxvalue = max_value
+        minvalue = min_value
+        range = maxvalue - minvalue
+
+        top_pad = range == 0 ? 10 : range / 20.0
+        scale_range = (maxvalue + top_pad) - minvalue
+
+        scale_division = scale_divisions || (scale_range / 10.0)
+
+        if scale_integers
+          scale_division = scale_division < 1 ? 1 : scale_division.round
+        end
+
+        rv = []
+        maxvalue = maxvalue%scale_division == 0 ? 
+          maxvalue : maxvalue + scale_division
+        minvalue.step( maxvalue, 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 =  (@graph_height.to_f - font_size*2*top_font) / 
+                          (get_y_labels.max - get_y_labels.min)
+        bargap = bar_gap ? (fieldwidth < 10 ? fieldwidth / 2 : 10) : 0
+
+        bar_width = fieldwidth - (bargap *2)
+        bar_width /= @data.length if stack == :side
+        #x_mod = (@graph_width-bargap)/2 - (stack==:side ? bar_width/2 : 0)
+ 
+        bottom = @graph_height
+
+        field_count = 0
+        @config[:fields].each_index { |i|
+          dataset_count = 0
+          for dataset in @data
+          
+            # cases (assume 0 = +ve):
+            #   value  min  length
+            #    +ve   +ve  value - min
+            #    +ve   -ve  value - 0
+            #    -ve   -ve  value.abs - 0
+          
+            value = dataset[:data][i]
+            
+            left = (fieldwidth * field_count)
+            left += bargap
+         
+            
+            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}"
+            })
+
+		
+			
+			threshold = @config[:errorBars][i] * unit_size
+			middlePointErr = left+bar_width/2
+			upperErr = top+threshold
+			bottomErr = top-threshold
+			withthErr = bar_width/4
+			
+            @graph.add_element( "line", {
+              "x1" => middlePointErr.to_s,
+              "y1" => upperErr.to_s,
+              "x2" => middlePointErr.to_s,
+              "y2" => bottomErr.to_s,
+              "style" => "stroke:rgb(0,0,0);stroke-width:1"
+            })
+            
+            @graph.add_element( "line", {
+              "x1" => (middlePointErr-withthErr).to_s,
+              "y1" => upperErr.to_s,
+              "x2" => (middlePointErr+withthErr).to_s,
+              "y2" => upperErr.to_s,
+              "style" => "stroke:rgb(0,0,0);stroke-width:1"
+            })
+            @graph.add_element( "line", {
+              "x1" => (middlePointErr-withthErr).to_s,
+              "y1" => bottomErr.to_s,
+              "x2" => (middlePointErr+withthErr).to_s,
+              "y2" => bottomErr.to_s,
+              "style" => "stroke:rgb(0,0,0);stroke-width:1"
+            })
+            
+            make_datapoint_text(left + bar_width/2.0, top - 6, value.to_s)
+            dataset_count += 1
+          end
+          field_count += 1
+        }
+      end
+    end
+  end
+end