svg-graph 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c448a6423accd8618fa44587eeca0dc4f7b21ea99508c21dd95e5329cef59a5c
-  data.tar.gz: 4775e687abb3ebe350754e3287b925ab6b5d5624158664aacecfffc6cbcff680
+  metadata.gz: 9d2a4756bdc712df308bb715f9076bac952fbf64dd8d8b2900d9c424b30026b7
+  data.tar.gz: 5c3b12638b3eb65936f32a84e50f222113b2c7c4c0e6f69bbbd9c594c99bd6eb
 SHA512:
-  metadata.gz: 3ba65a950336a3718b7c0fd01ddcd55261911ac00542518914165e22388bdbafd834ed928980af8aa4ad75523ad8572110fb82ef5b933897243b2153d52aed38
-  data.tar.gz: 19166679a0a198b667c240162aeb2438f77662130a03cbf430b289804b286b0fcd0c7e743b245eaebe2e982110946482ec6da94a02e29cc15d633808b74d952d
+  metadata.gz: fd35db671d05e9f8c2559508a4ab7bf7bfd7d4582f6433fe4b93c2cd4f182c0692100f806cf3d72704ff4ec74a267ec2b319100df7704972c2ad46530ddc1978
+  data.tar.gz: 5216c72900a99522c7f49ac48166f85167bfecaf087c2d2e3891abfeaad44adbe378e1230cc87569d7e99ce9f1f4bd318de708eeff615218c23449c48f345dfd

data/History.txt

@@ -2,6 +2,21 @@ TODO / Backlog
 * refactor various hardcoded constant pixel offsets in Graph class to use named constants or variables
 * Fix bug in Plot where min/max_x/y_value are not respected, TODO
 
+=== 2.2.3 /
+
+=== 2.2.2 / 2023-04-30
+* fix line9 color typo in Line.rb [thanks, akostadinov #42]
+* anchor right y labels [thanks, akostadinov #44]
+* start line from first point, not 0 0 [thanks, akostadinov #43]
+
+=== 2.2.1 / 2020-12-25
+* Remove inline styling for data point labels and popups [thanks marnen, PR #23]
+* fix #29 text background not aligned close to axis due to missing anchors
+* add & document  :shape and :url hash keys for `add_data` [thanks t12nslookup, PR #32]
+* add custom datapoint support to Line graphs
+* Add white text behind popup text so that the black text is more readable [thanks t12nslookup, PR #30]
+* fix #19 rotated lables should no longer be cropped or overlapping
+
 === 2.2.0 / 2019-11-26
 * on top of 2.2.0.beta adds the following
 * Fixed Divizion by zero when data is 0,0 in Pie [thanks chrismedrdz, PR #16]

data/README.md

@@ -1,6 +1,11 @@
 SVG::Graph
 ============
 
+[![Build Status](https://travis-ci.com/lumean/svg-graph2.svg?branch=master)](https://travis-ci.com/lumean/svg-graph2)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0a2b2d977bb9a43f488a/maintainability)](https://codeclimate.com/github/lumean/svg-graph2/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0a2b2d977bb9a43f488a/test_coverage)](https://codeclimate.com/github/lumean/svg-graph2/test_coverage)
+[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/a5e00e98/svg-graph2)
+
 Description
 -----------
 This repo is the continuation of the original [SVG::Graph library](http://www.germane-software.com/software/SVG/SVG::Graph/) by Sean Russell. I'd 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)
@@ -106,14 +111,22 @@ Source: [C3js.rb](../master/examples/c3js.rb)
 
 [Link to Preview](https://cdn.rawgit.com/lumean/svg-graph2/master/examples/c3js.html)
 
-<iframe src="https://cdn.rawgit.com/lumean/svg-graph2/master/examples/c3js.html" width="600px"> </iframe>
-
-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
 -----
+* Test
+
+`bundle exec rake`
 
 * Build gem:
- *  gem build svg-graph.gemspec
+
+`gem build svg-graph.gemspec`
+
 * Install:
- *  gem install svg-graph-\<version>.gem
+
+`gem install svg-graph-\<version>.gem`
+
+Percy.io integration
+---
+https://docs.percy.io/docs/travis-ci
+https://docs.percy.io/docs/snapshot-cli-command

data/Rakefile

@@ -21,12 +21,22 @@
 #  self.remote_rdoc_dir = 'svg-graph'
 #end
 
-# run all unit tests with 'rake test'
-task default: %w[test]
+# by default run all unit tests with 'rake test'
+task default: [:test]
 
 task :test do
-  ruby "test/test_data_point.rb"
-  ruby "test/test_plot.rb"
-  ruby "test/test_svg_graph.rb"
-  ruby "test/test_graph.rb"
+  [
+    "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/DataPoint.rb

@@ -1,6 +1,8 @@
 # Allows to customize datapoint shapes
 class DataPoint
-  OVERLAY = "OVERLAY" unless defined?(OVERLAY)
+  # magic string that defines if a shape is intented to be overlayed to a default.
+  # this allowes to have strike through of a circle etc.
+  OVERLAY = "OVERLAY"
   DEFAULT_SHAPE = lambda{|x,y,line| ["circle", {
           "cx" => x,
           "cy" => y,
@@ -9,27 +11,33 @@ class DataPoint
         }]
       } unless defined? DEFAULT_SHAPE
   CRITERIA = [] unless defined? CRITERIA
-  
+
   # matchers are class scope. Once configured, each DataPoint instance will have
   # access to the same matchers
-  # @param matchers [Array] multiple arrays of the following form:
-  #     [ regex , 
+  # @param matchers [Array] multiple arrays of the following form 2 or 3 elements:
+  #     [ regex ,
   #       lambda taking three arguments (x,y, line_number for css)
-  #         -> return value of the lambda must be an array: [svg tag name,  Hash with attributes for the svg tag, e.g. "points" and "class"]
+  #         -> return value of the lambda must be an array: [svg tag name,
+  #            Hash with attributes for the svg tag, e.g. "points" and "class",
+  #              make sure to check source code of you graph type for valid css class.],
+  #       "OVERLAY" (magic string, if specified, puts the shape on top of existing datapoint)
   #     ]
   # @example
   #   DataPoint.configure_shape_criteria(
-  #     [/.*/, lambda{|x,y,line| ['polygon', {
-  #       "points" => "#{x-1.5},#{y+2.5} #{x+1.5},#{y+2.5} #{x+1.5},#{y-2.5} #{x-1.5},#{y-2.5}",
-  #       "class" => "dataPoint#{line}"
-  #       }]
+  #     [/.*/, lambda{|x,y,line|
+  #       [ 'polygon',
+  #         {
+  #         "points" => "#{x-1.5},#{y+2.5} #{x+1.5},#{y+2.5} #{x+1.5},#{y-2.5} #{x-1.5},#{y-2.5}",
+  #         "class" => "dataPoint#{line}"
+  #         }
+  #       ]
   #     }]
   #   )
   def DataPoint.configure_shape_criteria(*matchers)
     CRITERIA.push(*matchers)
   end
-  
-  # 
+
+  #
   def DataPoint.reset_shape_criteria
     CRITERIA.clear
   end
@@ -43,7 +51,11 @@ class DataPoint
     @y = y
     @line = line
   end
-  
+
+  # Returns different shapes depending on datapoint descriptions, if shape criteria have been configured.
+  # The definded criteria are evaluated in two stages, first the ones, which are note defined as overlay.
+  # then the "OVERLAY"
+  # @param datapoint_description [String] description or label of the current datapoint
   # @return [Array<Array>] see example
   # @example Return value
   #   # two dimensional array, the splatted (*) inner array can be used as argument to REXML::add_element
@@ -53,12 +65,12 @@ class DataPoint
   #   # for each svg we insert it to the graph
   #   dp.each {|s| @graph.add_element( *s )}
   #
-  def shape(description=nil)
-    # select all criteria with size 2, and collect rendered lambdas in an array 
+  def shape(datapoint_description=nil)
+    # select all criteria with size 2, and collect rendered lambdas in an array
     shapes = CRITERIA.select {|criteria|
       criteria.size == 2
     }.collect {|regexp, proc|
-      proc.call(@x, @y, @line) if description =~ regexp
+      proc.call(@x, @y, @line) if datapoint_description =~ regexp
     }.compact
     # if above did not render anything use the defalt shape
     shapes = [DEFAULT_SHAPE.call(@x, @y, @line)] if shapes.empty?
@@ -66,7 +78,7 @@ class DataPoint
     overlays = CRITERIA.select { |criteria|
       criteria.last == OVERLAY
     }.collect { |regexp, proc|
-      proc.call(@x, @y, @line) if description =~ regexp
+      proc.call(@x, @y, @line) if datapoint_description =~ regexp
     }.compact
 
     return shapes + overlays

data/lib/SVG/Graph/Graph.rb

@@ -103,6 +103,7 @@ module SVG
       # [number_format] '%.2f'
       def initialize( config )
         @config = config
+        # array of Hash
         @data = []
         #self.top_align = self.top_font = 0
         #self.right_align = self.right_font = 0
@@ -180,16 +181,38 @@ module SVG
       #     :data => data_sales_02,
       #     :title => 'Sales 2002'
       #   })
-      def add_data conf
-        @data = [] unless (defined? @data and !@data.nil?)
+      # @param conf [Hash] with the following keys:
+      #          :data [Array] mandatory
+      #          :title [String] mandatory name of data series for legend of graph
+      #          :description [Array<String>] (optional) if given, description for each datapoint (shown in popups)
+      #          :shape [Array<String>] (optional) if given, DataPoint shape is chosen based on this string instead of description
+      #          :url [Array<String>] (optional)  if given, link will be added to each datapoint
+      def add_data(conf)
+        @data ||= []
+        raise "No data provided by #{conf.inspect}" unless conf[:data].is_a?(Array)
+
+        add_data_init_or_check_optional_keys(conf, conf[:data].size)
+        @data << conf
+      end
 
-        if conf[:data] and conf[:data].kind_of? Array
-          @data << conf
-        else
-          raise "No data provided by #{conf.inspect}"
+      # Checks all optional keys of the add_data method
+      def add_data_init_or_check_optional_keys(conf, datasize)
+        conf[:description] ||= Array.new(datasize)
+        conf[:shape] ||= Array.new(datasize)
+        conf[:url] ||= Array.new(datasize)
+
+        if conf[:description].size != datasize
+          raise "Description for popups does not have same size as provided data: #{conf[:description].size} vs #{conf[:data].size/2}"
         end
-      end
 
+        if conf[:shape].size != datasize
+          raise "Shapes for points do not have same size as provided data: #{conf[:shape].size} vs #{conf[:data].size/2}"
+        end
+
+        if conf[:url].size != datasize
+          raise "URLs for points do not have same size as provided data: #{conf[:url].size} vs #{conf[:data].size/2}"
+        end
+      end
 
       # This method removes all data from the object so that you can
       # reuse it to create a new graph but with the same config options.
@@ -323,7 +346,7 @@ module SVG
       attr_accessor :rotate_x_labels
       #   This turns the Y axis labels by 90 degrees when true or by a custom
       #   amount when a numeric value is given.
-      #   Default is true, to turn on set to false.
+      #   Default is false, to turn on set to true or numeric value.
       attr_accessor :rotate_y_labels
       #   How many "steps" to use between displayed X axis labels,
       #   a step of one means display every label, a step of two results
@@ -436,17 +459,17 @@ module SVG
 
       protected
 
-      # implementation of quicksort
-      # used for Schedule and Plot
+      # implementation of a multiple array sort used for Schedule and Plot
       def sort( *arrys )
-        sort_multiple( arrys )
+        new_arrys = arrys.transpose.sort_by(&:first).transpose
+        new_arrys.each_index { |k| arrys[k].replace(new_arrys[k]) }
       end
 
       # Overwrite configuration options with supplied options.  Used
       # by subclasses.
       def init_with config
         config.each { |key, value|
-            self.send( key.to_s+"=", value ) if self.respond_to?  key
+          self.send( key.to_s+"=", value ) if self.respond_to?  key
         }
       end
 
@@ -468,12 +491,20 @@ module SVG
       # are not shown
       def max_y_label_width_px
         return 0 if !show_y_labels
-        if !rotate_y_labels
-          max_width = get_longest_label(get_y_labels).to_s.length * y_label_font_size * 0.6
-        else
-          max_width = y_label_font_size + 3
+        base_width = y_label_font_size + 3
+        if rotate_y_labels == true
+          self.rotate_y_labels = 90
+        end
+        if rotate_y_labels == false
+          self.rotate_y_labels = 0
+        end
+        # don't change rotate_y_label, if neither true nor false
+        label_width = get_longest_label(get_y_labels).to_s.length * y_label_font_size * 0.5
+        rotated_width = label_width * Math.cos( rotate_y_labels * Math::PI / 180).abs()
+        max_width = base_width + rotated_width
+        if stagger_y_labels
+          max_width += 5 + y_label_font_size
         end
-        max_width += 5 + y_label_font_size if stagger_y_labels
         return max_width
       end
 
@@ -520,37 +551,74 @@ module SVG
       end
 
       # Adds pop-up point information to a graph only if the config option is set.
-      def add_popup( x, y, label, style="" )
+      def add_popup( x, y, label, style="", url="" )
         if add_popups
           if( numeric?(label) )
             label = @number_format % label
           end
           txt_width = label.length * font_size * 0.6 + 10
           tx = (x+txt_width > @graph_width ? x-5 : x+5)
-          t = @foreground.add_element( "text", {
+          g = Element.new( "g" )
+          g.attributes["id"] = g.object_id.to_s
+          g.attributes["visibility"] = "hidden"
+
+          # First add the mask
+          t = g.add_element( "text", {
             "x" => tx.to_s,
             "y" => (y - font_size).to_s,
-            "class" => "dataPointLabel",
-            "visibility" => "hidden",
+            "class" => "dataPointPopupMask"
           })
-          t.attributes["style"] = "stroke-width: 2; fill: #000; #{style}"+
+          t.attributes["style"] = style +
             (x+txt_width > @graph_width ? "text-anchor: end;" : "text-anchor: start;")
           t.text = label.to_s
-          t.attributes["id"] = t.object_id.to_s
+
+          # Then add the text
+          t = g.add_element( "text", {
+            "x" => tx.to_s,
+            "y" => (y - font_size).to_s,
+            "class" => "dataPointPopup"
+          })
+          t.attributes["style"] = style +
+            (x+txt_width > @graph_width ? "text-anchor: end;" : "text-anchor: start;")
+          t.text = label.to_s
+
+          @foreground.add_element( g )
 
           # add a circle to catch the mouseover
-          @foreground.add_element( "circle", {
+          mouseover = Element.new( "circle" )
+          mouseover.add_attributes({
             "cx" => x.to_s,
             "cy" => y.to_s,
             "r" => "#{popup_radius}",
             "style" => "opacity: 0",
             "onmouseover" =>
-              "document.getElementById(#{t.object_id}).setAttribute('visibility', 'visible' )",
+              "document.getElementById(#{g.object_id.to_s}).style.visibility ='visible'",
             "onmouseout" =>
-              "document.getElementById(#{t.object_id}).setAttribute('visibility', 'hidden' )",
+              "document.getElementById(#{g.object_id.to_s}).style.visibility = 'hidden'",
+          })
+          if !url.nil?
+            href = Element.new("a")
+            href.add_attribute("xlink:href", url)
+            href.add_element(mouseover)
+            @foreground.add_element(href)
+          else
+            @foreground.add_element(mouseover)
+          end
+        elsif !url.nil?
+          # add a circle to catch the mouseover
+          mouseover = Element.new( "circle" )
+          mouseover.add_attributes({
+            "cx" => x.to_s,
+            "cy" => y.to_s,
+            "r" => "#{popup_radius}",
+            "style" => "opacity: 0",
           })
+          href = Element.new("a")
+          href.add_attribute("xlink:href", url)
+          href.add_element(mouseover)
+          @foreground.add_element(href)
         end # if add_popups
-      end # add_popup
+      end # def add_popup
 
       # returns the longest label from an array of labels as string
       # each object in the array must support .to_s
@@ -712,13 +780,14 @@ module SVG
           elsif x > @graph_width - textStr.length/2 * font_size
             style << "text-anchor: end;"
           end
-          # white background for better readability
-          @foreground.add_element( "text", {
+          # background for better readability
+          text = @foreground.add_element( "text", {
             "x" => x.to_s,
             "y" => y.to_s,
-            "class" => "dataPointLabel",
-            "style" => "#{style} stroke: #fff; stroke-width: 2;"
-          }).text = textStr
+            "class" => "dataPointLabelBackground",
+          })
+          text.text = textStr
+          text.attributes["style"] = style if style.length > 0
           # actual label
           text = @foreground.add_element( "text", {
             "x" => x.to_s,
@@ -831,18 +900,23 @@ module SVG
       def draw_y_labels
         stagger = y_label_font_size + 5
         label_height = field_height
+        label_width = max_y_label_width_px
         count = 0
         y_offset = @graph_height + y_label_offset( label_height )
-        y_offset += font_size/1.2 unless rotate_y_labels
+        y_offset += font_size/3.0
         for label in get_y_labels
           if show_y_labels
+            # x = 0, y = 0 is top left right next to graph area
             y = y_offset - (label_height * count)
-            x = rotate_y_labels ? 0 : -3
+            # instead of calculating the middle anchor position, simply use
+            # static offset and anchor end to right-align the labels. See line :936 below.
+            #x = -label_width/2.0 + y_label_font_size/2.0
+            x = 3
 
             if stagger_y_labels and count % 2 == 1
               x -= stagger
               @graph.add_element( "path", {
-                "d" => "M#{x} #{y} h#{stagger}",
+                "d" => "M0 #{y} h#{-stagger}",
                 "class" => "staggerGuideLine"
               })
             end
@@ -857,18 +931,14 @@ module SVG
               textStr = @number_format % label
             end
             text.text = textStr
-            if rotate_y_labels
-              degrees = 90
-              if numeric? rotate_y_labels
-                degrees = rotate_y_labels
-              end
-              text.attributes["transform"] = "translate( -#{font_size} 0 ) "+
+            # note text-anchor is at bottom of textfield
+            #text.attributes["style"] = "text-anchor: middle"
+            text.attributes["style"] = "text-anchor: end"
+            degrees = rotate_y_labels
+            text.attributes["transform"] = "translate( -#{font_size} 0 ) " +
                 "rotate( #{degrees} #{x} #{y} ) "
-              text.attributes["style"] = "text-anchor: middle"
-            else
-              text.attributes["y"] = (y - (y_label_font_size/2)).to_s
-              text.attributes["style"] = "text-anchor: end"
-            end
+            # text.attributes["y"] = (y - (y_label_font_size/2)).to_s
+
           end # if show_y_labels
           draw_y_guidelines( label_height, count ) if show_y_guidelines
           count += 1
@@ -1008,30 +1078,6 @@ module SVG
 
       private
 
-      def sort_multiple( arrys, lo=0, hi=arrys[0].length-1 )
-        if lo < hi
-          p = partition(arrys,lo,hi)
-          sort_multiple(arrys, lo, p-1)
-          sort_multiple(arrys, p+1, hi)
-        end
-        arrys
-      end
-
-      def partition( arrys, lo, hi )
-        p = arrys[0][lo]
-        l = lo
-        z = lo+1
-        while z <= hi
-          if arrys[0][z] < p
-            l += 1
-            arrys.each { |arry| arry[z], arry[l] = arry[l], arry[z] }
-          end
-          z += 1
-        end
-        arrys.each { |arry| arry[lo], arry[l] = arry[l], arry[lo] }
-        l
-      end
-
       def style
         if no_css
           styles = parse_css
@@ -1212,7 +1258,7 @@ module SVG
   font-weight: normal;
 }
 
-.dataPointLabel{
+.dataPointLabel, .dataPointLabelBackground, .dataPointPopup, .dataPointPopupMask{
   fill: #000000;
   text-anchor:middle;
   font-size: 10px;
@@ -1220,6 +1266,21 @@ module SVG
   font-weight: normal;
 }
 
+.dataPointLabelBackground{
+  stroke: #ffffff;
+  stroke-width: 2;
+}
+
+.dataPointPopupMask{
+  stroke: white;
+  stroke-width: 7;
+}
+
+.dataPointPopup{
+  fill: black;
+  stroke-width: 2;
+}
+
 .staggerGuideLine{
   fill: none;
   stroke: #000000;

data/lib/SVG/Graph/Line.rb

@@ -42,7 +42,7 @@ module SVG
     #
     # = Examples
     #
-    # http://www.germane-software/repositories/public/SVG/test/single.rb
+    # https://github.com/lumean/svg-graph2/blob/master/examples/line.rb
     #
     # = Notes
     # Only number of fileds datapoints will be drawn, additional data values
@@ -238,8 +238,9 @@ module SVG
             })
           end
 
+          matcher = /^(\S+ \S+) (.*)/.match lpath
           @graph.add_element("path", {
-            "d" => "M0 #@graph_height L" + lpath,
+            "d" => "M#{matcher[1]} L#{matcher[2]}",
             "class" => "line#{line}"
           })
 
@@ -249,17 +250,22 @@ module SVG
               next if cum_sum[i].nil?
               c = calc_coords(i, cum_sum[i], fieldwidth, fieldheight)
               if show_data_points
-                @graph.add_element( "circle", {
-                  "cx" => c[:x].to_s,
-                  "cy" => c[:y].to_s,
-                  "r" => "2.5",
-                  "class" => "dataPoint#{line}"
-                })
+                shape_selection_string = data[:description][i].to_s
+                if !data[:shape][i].nil?
+                  shape_selection_string = data[:shape][i].to_s
+                end
+                DataPoint.new(c[:x], c[:y], line).shape(shape_selection_string).each{|s|
+                  @graph.add_element( *s )
+                }
               end
 
               make_datapoint_text( c[:x], c[:y] - font_size/2, cum_sum[i] + minvalue)
               # number format shall not apply to popup (use .to_s conversion)
-              add_popup(c[:x], c[:y], (cum_sum[i] + minvalue).to_s)
+              descr = ""
+              if !data[:description][i].to_s.empty?
+                descr = ", #{data[:description][i].to_s}"
+              end
+              add_popup(c[:x], c[:y], (cum_sum[i] + minvalue).to_s + descr, "", data[:url][i].to_s)
             end
           end
 
@@ -314,7 +320,7 @@ module SVG
 }
 .line9{
 	fill: none;
-	stroke: #ccc6666;
+	stroke: #cc6666;
 	stroke-width: 1px;
 }
 .line10{

data/lib/SVG/Graph/Pie.rb

@@ -36,7 +36,7 @@ module SVG
     #
     # = Examples
     #
-    # http://www.germane-software/repositories/public/SVG/test/single.rb
+    # https://github.com/lumean/svg-graph2/blob/master/examples/pie.rb
     #
     # == See also
     #
@@ -343,7 +343,7 @@ module SVG
 
       def get_css
         return <<EOL
-.dataPointLabel{
+.dataPointLabel, .dataPointLabelBackground, .dataPointPopup{
 	fill: #000000;
 	text-anchor:middle;
 	font-size: #{datapoint_font_size}px;
@@ -351,6 +351,17 @@ module SVG
 	font-weight: normal;
 }
 
+.dataPointLabelBackground{
+  stroke: #ffffff;
+  stroke-width: 2;
+}
+
+.dataPointPopup{
+  fill: #000000;
+  visibility: hidden;
+  stroke-width: 2;
+}
+
 /* key - MUST match fill styles */
 .key1,.fill1{
 	fill: #ff0000;

data/lib/SVG/Graph/Plot.rb

@@ -55,14 +55,14 @@ module SVG
     #
     # = Examples
     #
-    # http://www.germane-software/repositories/public/SVG/test/plot.rb
+    # https://github.com/lumean/svg-graph2/blob/master/examples/plot.rb
     #
     # = Notes
     #
-    # The default stylesheet handles upto 10 data sets, if you
+    # 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 10 data sets as they will have no style and
+    # if you go over 12 data sets as they will have no style and
     # be in black.
     #
     # Unlike the other types of charts, data sets must contain x,y pairs:
@@ -164,10 +164,15 @@ module SVG
       #     :data => data_set2,
       #     :title => 'two points'
       #   })
+      # @param conf [Hash] with keys
+      #          :data [Array] of x,y pairs, one pair for each point
+      #          :title [String] mandatory name of data series for legend of graph
+      #          :description [Array<String>] (optional) if given, description for each datapoint (shown in popups)
+      #          :shape [Array<String>] (optional) if given, DataPoint shape is chosen based on this string instead of description
+      #          :url [Array<String>] (optional)  if given, link will be added to each datapoint
       def add_data(conf)
-	      @data ||= []
-        raise "No data provided by #{conf.inspect}" unless conf[:data] and
-          conf[:data].kind_of? Array
+        @data ||= []
+        raise "No data provided by #{conf.inspect}" unless conf[:data].is_a?(Array)
         # support array of arrays and flatten it
         conf[:data] = conf[:data].flatten
         # check that we have pairs of values
@@ -175,23 +180,23 @@ module SVG
           "The data provided contained an odd set of "+
           "data points" unless conf[:data].length % 2 == 0
 
+        # clear the min/max x/y range caches
+        clear_cache
+
         # remove nil values
         conf[:data] = conf[:data].compact
 
-        return if conf[:data].length == 0
+        return if conf[:data].length.zero?
 
-        conf[:description] ||= Array.new(conf[:data].size/2)
-        if conf[:description].size != conf[:data].size/2
-          raise "Description for popups does not have same size as provided data: #{conf[:description].size} vs #{conf[:data].size/2}"
-        end
+        add_data_init_or_check_optional_keys(conf, conf[:data].size / 2)
 
         x = []
         y = []
         conf[:data].each_index {|i|
           (i%2 == 0 ? x : y) << conf[:data][i]
         }
-        sort( x, y, conf[:description] )
-        conf[:data] = [x,y]
+        sort(x, y, conf[:description], conf[:shape], conf[:url])
+        conf[:data] = [x, y]
         # at the end data looks like:
         # [
         #   [all x values],
@@ -218,22 +223,40 @@ module SVG
         @border_right = label_right if label_right > @border_right
       end
 
-
       X = 0
       Y = 1
 
+      # procedure to clear all the cached variables used in working out the
+      # max and min ranges for the chart
+      def clear_cache
+        @max_x_cache = @min_x_cache = @max_y_cache = @min_y_cache = nil
+      end
+
       def max_x_range
+        return @max_x_cache unless @max_x_cache.nil?
+
+        # needs to be computed fresh when called, to cover the use-case:
+        # add_data -> burn -> add_data -> burn
+        # when values would be cached, the graph is not updated for second burning
         max_value = @data.collect{|x| x[:data][X][-1] }.max
         max_value = max_value > max_x_value ? max_value : max_x_value if max_x_value
-        max_value
+        @max_x_cache = max_value
+        @max_x_cache
       end
 
       def min_x_range
+        return @min_x_cache unless @min_x_cache.nil?
+
+        # needs to be computed fresh when called, to cover the use-case:
+        # add_data -> burn -> add_data -> burn
+        # when values would be cached, the graph is not updated for second burning
         min_value = @data.collect{|x| x[:data][X][0] }.min
         min_value = min_value < min_x_value ? min_value : min_x_value if min_x_value
-        min_value
+        @min_x_cache = min_value
+        @min_x_cache
       end
 
+      # calculate the min and max x value as well as the scale division used for the x-axis
       def x_label_range
         max_value = max_x_range
         min_value = min_x_range
@@ -246,11 +269,12 @@ module SVG
         end
         scale_range = max_value - min_value
 
-        scale_division = scale_x_divisions || (scale_range / 10.0)
+        # either use the given step size or by default do 9 divisions.
+        scale_division = scale_x_divisions || (scale_range / 9.0)
         @x_offset = 0
 
         if scale_x_integers
-          scale_division = scale_division < 1 ? 1 : scale_division.round
+          scale_division = scale_division < 1 ? 1 : scale_division.ceil
           @x_offset = min_value.to_f - min_value.floor
           min_value = min_value.floor
         end
@@ -258,10 +282,13 @@ module SVG
         [min_value, max_value, scale_division]
       end
 
+      # get array of values for the x axis divisions, assuming left-most value starts
+      # exactly where the graph starts.
       def get_x_values
         min_value, max_value, @x_scale_division = x_label_range
+        x_times = ((max_value-min_value)/@x_scale_division).round + 1
         rv = []
-        min_value.step( max_value + @x_scale_division , @x_scale_division ) {|v| rv << v}
+        x_times.times{|v| rv << (min_value + (v * @x_scale_division))}
         return rv
       end
       alias :get_x_labels :get_x_values
@@ -273,17 +300,25 @@ module SVG
                                                  # otherwise there is always 1 division unused
       end
 
-
       def max_y_range
+        return @max_y_cache unless @max_y_cache.nil?
+
         max_value = @data.collect{|x| x[:data][Y].max }.max
         max_value = max_value > max_y_value ? max_value : max_y_value if max_y_value
-        max_value
+        @max_y_cache = max_value
+        @max_y_cache
       end
 
       def min_y_range
+        return @min_y_cache unless @min_y_cache.nil?
+
+        # needs to be computed fresh when called, to cover the use-case:
+        # add_data -> burn -> add_data -> burn
+        # when values would be cached, the graph is not updated for second burning
         min_value = @data.collect{|x| x[:data][Y].min }.min
         min_value = min_value < min_y_value ? min_value : min_y_value if min_y_value
-        min_value
+        @min_y_cache = min_value
+        @min_y_cache
       end
 
       def y_label_range
@@ -298,11 +333,11 @@ module SVG
         end
         scale_range = max_value - min_value
 
-        scale_division = scale_y_divisions || (scale_range / 10.0)
+        scale_division = scale_y_divisions || (scale_range / 9.0)
         @y_offset = 0
 
         if scale_y_integers
-          scale_division = scale_division < 1 ? 1 : scale_division.round
+          scale_division = scale_division < 1 ? 1 : scale_division.ceil
           @y_offset = (min_value.to_f - min_value.floor).to_f
           min_value = min_value.floor
         end
@@ -314,7 +349,7 @@ module SVG
         min_value, max_value, @y_scale_division = y_label_range
         if max_value != min_value
           while (max_value - min_value) < @y_scale_division
-            @y_scale_division /= 10.0
+            @y_scale_division /= 9.0
           end
         end
         rv = []
@@ -333,9 +368,10 @@ module SVG
         else
           dx = (max - values[-1]).to_f / (values[-1] - values[-2])
         end
-        @graph_height.to_f / values.length
+        @graph_height.to_f / (values.length - 1)
       end
 
+      # calculates the x,y coordinates of a datapoint in the plot area
       def calc_coords(x, y)
         coords = {:x => 0, :y => 0}
         # scale the coordinates, use float division / multiplication
@@ -349,9 +385,7 @@ module SVG
         line = 1
 
         x_min = min_x_range
-        x_max = max_x_range
         y_min = min_y_range
-        y_max = max_y_range
 
         for data in @data
           x_points = data[:data][X]
@@ -384,12 +418,16 @@ module SVG
             x_points.each_index { |idx|
               c = calc_coords(x_points[idx] -  x_min, y_points[idx] -  y_min)
               if show_data_points
-                DataPoint.new(c[:x], c[:y], line).shape(data[:description][idx]).each{|s|
+                shape_selection_string = data[:description][idx].to_s
+                if !data[:shape][idx].nil?
+                  shape_selection_string = data[:shape][idx].to_s
+                end
+                DataPoint.new(c[:x], c[:y], line).shape(shape_selection_string).each{|s|
                   @graph.add_element( *s )
                 }
               end
               make_datapoint_text( c[:x], c[:y]-6, y_points[idx] )
-              add_popup(c[:x], c[:y], format( x_points[idx], y_points[idx], data[:description][idx]))
+              add_popup(c[:x], c[:y], format( x_points[idx], y_points[idx], data[:description][idx].to_s), "", data[:url][idx].to_s)
             }
           end
           line += 1
@@ -401,7 +439,7 @@ module SVG
         info = []
         info << (round_popups ? x.round : @number_format % x )
         info << (round_popups ? y.round : @number_format % y )
-        info << desc
+        info << desc if !desc.empty?
         "(#{info.compact.join(', ')})"
       end
 

data/lib/SVG/Graph/Schedule.rb

@@ -47,7 +47,7 @@ module SVG
     # 
     # = Examples
     #
-    # http://www.germane-software/repositories/public/SVG/test/schedule.rb
+    # https://github.com/lumean/svg-graph2/blob/master/examples/schedule.rb
     # 
     # = Notes
     # 

data/lib/SVG/Graph/TimeSeries.rb

@@ -4,20 +4,20 @@ require_relative 'Plot'
 module SVG
   module Graph
     # === For creating SVG plots of scalar temporal data
-    # 
+    #
     # = Synopsis
-    # 
+    #
     #   require 'SVG/Graph/TimeSeries'
-    #   
+    #
     #   # Data sets are x,y pairs
     #   projection = ["6/17/72", 11,    "1/11/72", 7,    "4/13/04", 11,
     #                "9/11/01", 9,    "9/1/85", 2,    "9/1/88", 1,    "1/15/95", 13]
     #   actual = ["8/1/73", 18,    "3/1/77", 15,    "10/1/98", 4,
     #             "5/1/02", 14,    "3/1/95", 6,    "8/1/91", 12,    "12/1/87", 6,
     #             "5/1/84", 17,    "10/1/80", 12]
-    #   
+    #
     #   title = "Ice Cream Cone Consumption"
-    #   
+    #
     #   graph = SVG::Graph::TimeSeries.new( {
     #     :width => 640,
     #     :height => 480,
@@ -39,31 +39,31 @@ module SVG
     #     :stagger_x_labels => true,
     #     :x_label_format => "%m/%d/%y",
     #   })
-    #   
+    #
     #   graph.add_data({
     #     :data => projection,
     #     :title => 'Projected',
     #     :template => '%d/%m/%y'
     #   })
-    #   
+    #
     #   graph.add_data({
     #     :data => actual,
     #     :title => 'Actual',
     #     :template => '%d/%m/%y'
     #   })
-    #   
+    #
     #   print graph.burn()
     #
     # = Description
-    # 
+    #
     # Produces a graph of temporal scalar data.
-    # 
+    #
     # = Examples
     #
-    # http://www.germane-software/repositories/public/SVG/test/timeseries.rb
-    # 
+    # https://github.com/lumean/svg-graph2/blob/master/examples/timeseries.rb
+    #
     # = Notes
-    # 
+    #
     # The default stylesheet handles upto 10 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
@@ -73,18 +73,18 @@ module SVG
     # Unlike the other types of charts, data sets must contain x,y pairs:
     #
     #   [ "12:30", 2 ]          # A data set with 1 point: ("12:30",2)
-    #   [ "01:00",2, "14:20",6] # A data set with 2 points: ("01:00",2) and 
-    #                           #                           ("14:20",6)  
+    #   [ "01:00",2, "14:20",6] # A data set with 2 points: ("01:00",2) and
+    #                           #                           ("14:20",6)
     #
-    # Note that multiple data sets within the same chart can differ in length, 
+    # Note that multiple data sets within the same chart can differ in length,
     # and that the data in the datasets needn't be in order; they will be ordered
     # by the plot along the X-axis.
-    # 
+    #
     # The dates must be parseable by DateTime#parse or DateTime#strptime, but otherwise can be
     # any order of magnitude (seconds within the hour, or years)
-    # 
+    #
     # = See also
-    # 
+    #
     # * SVG::Graph::Graph
     # * SVG::Graph::BarHorizontal
     # * SVG::Graph::Bar
@@ -117,9 +117,9 @@ module SVG
       # See Time::strformat, default: '%Y-%m-%d %H:%M:%S'
       attr_accessor :x_label_format
       # Use this to set the spacing between dates on the axis.  The value
-      # must be of the form 
+      # must be of the form
       # "\d+ ?(days|weeks|months|years|hours|minutes|seconds)?"
-      # 
+      #
       # EG:
       #
       #   graph.timescale_divisions = "2 weeks"
@@ -133,9 +133,9 @@ module SVG
       # Add data to the plot.
       #
       #   d1 = [ "12:30", 2 ]          # A data set with 1 point: ("12:30",2)
-      #   d2 = [ "01:00",2, "14:20",6] # A data set with 2 points: ("01:00",2) and 
-      #                                #                           ("14:20",6)  
-      #   graph.add_data( 
+      #   d2 = [ "01:00",2, "14:20",6] # A data set with 2 points: ("01:00",2) and
+      #                                #                           ("14:20",6)
+      #   graph.add_data(
       #     :data => d1,
       #     :title => 'One',
       #     :template => '%H:%M'  #template is optional
@@ -182,10 +182,10 @@ module SVG
       def get_x_labels
         get_x_values.collect { |v| Time.at(v).strftime( x_label_format ) }
       end
-      
+
       private
 
-      # Accepts date time as a string, number of seconds since the epoch, or Time 
+      # Accepts date time as a string, number of seconds since the epoch, or Time
       # object and returns a Time object. Raises an error if not a valid date time
       # representation.
       def parse_time(time, template)
@@ -249,15 +249,15 @@ module SVG
               step = amount
             end
             # only do this if division_units is not year or month. Those are done already above in the cases.
-            min.step( max, step ) {|v| rv << v} if step
+            min.step( max + (step/10), step ) {|v| rv << v} if step
             @x_scale_division = step if step
             return rv
           end
         end
-        min.step( max, @x_scale_division ) {|v| rv << v}
+        min.step( max + (@x_scale_division/10), @x_scale_division ) {|v| rv << v}
         return rv
       end # get_x_values
-      
+
     end # class TimeSeries
   end # module Graph
 end # module SVG

data/lib/svggraph.rb

@@ -1,6 +1,6 @@
 module SVG
   module Graph
-    VERSION = '2.2.0'
+    VERSION = '2.2.2'
 
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svg-graph
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Sean Russell
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-26 00:00:00.000000000 Z
+date: 2023-04-30 00:00:00.000000000 Z
 dependencies: []
 description: "Gem version of SVG:::Graph. SVG:::Graph is a pure Ruby library for generating
   charts,\nwhich are a type of graph where the values of one axis are not scalar.
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: SVG:::Graph is a pure Ruby library for generating charts, which are a type