pbosetti-flotr 1.3.4 → 1.3.5

data/README.markdown

@@ -18,12 +18,11 @@ The following code produces the flotr.html file located in the root project fold
 
     # Push data into the two series
     100.times do |i| 
-      sin.data << [i, Math::sin(Math::PI / 100 * i)]
-      cos.data << [i, Math::cos(Math::PI / 100 * i)]
+      sin << [i, Math::sin(Math::PI / 100 * i)]
+      cos << [i, Math::cos(Math::PI / 100 * i)]
     end
 
-    plot << sin
-    plot << cos
+    plot << sin << cos
     plot.show
 
 At the moment, the Flotr::Plot.plot method automatically opens the plot within a browser window under OS X and Windows. On other platforms (Linux) you have to open the generated file by hands.

data/examples/sincos.rb

@@ -10,8 +10,8 @@ sin = Flotr::Data.new(:label => "Sin(x)", :color => "red")
 cos = Flotr::Data.new(:label => "Cos(x)", :color => "blue")
 
 100.times do |i| 
-  cos.data << [i, Math::cos(Math::PI / 100 * i)]
-  sin.data << [i, Math::sin(Math::PI / 100 * i)]
+  cos << [i, Math::cos(Math::PI / 100 * i)]
+  sin << [i, Math::sin(Math::PI / 100 * i)]
 end
 
 plot = Flotr::Plot.new("Test plot")

data/lib/flotr.rb

@@ -13,16 +13,28 @@ class String
   end
 end
 
+=begin rdoc
+  Flotr namespace.
+=end
 module Flotr
   BASENAME = File.dirname(__FILE__)
   OUTPUT_FILE = "flotr.html"
   STD_TEMPLATE = "zooming.rhtml"
   
+  
+=begin rdoc
+  Series to be plotted are instance of the Flotr::Data class. Initialize a new
+  Data object with a set of OPTIONS, then add points with the << method.
+=end
   class Data
     OPTIONS = [:color, :label, :lines, :bars, :points, :hints, :shadowSize]
     attr_accessor *OPTIONS
     attr_accessor :data
     
+=begin rdoc
+  Creates a new serie of points. opts is a Hash with a subset of the keys
+  given in OPTIONS.
+=end
     def initialize(opts={})
       @data = []
       opts.each do |k,v|
@@ -34,6 +46,9 @@ module Flotr
       end
     end
     
+=begin rdoc
+  Provides a JavaScript-formatted description of the data array.
+=end
     def inspect
       options = ""
       OPTIONS.each do |o|
@@ -44,17 +59,32 @@ module Flotr
       "{ #{options}data: #{@data.inspect}}"
     end
     
+=begin rdoc
+  Adds other to the data array. other must be a two element array like [0,0].
+=end
     def <<(other)
+      other = other.to_a
+      raise ArgumentError unless other[0].kind_of? Numeric
+      raise ArgumentError unless other[1].kind_of? Numeric
       @data << other
     end
     
   end
   
+=begin rdoc
+  The Plot object. Serves as a container for the data series (Data objects)
+  and for the plot options. Call the plot/show methods to generate the 
+  plot file Flotr::OUTPUT_FILE.
+=end  
   class Plot
     attr_accessor :series, :title, :comment, :template, :options
     attr_accessor :width, :height
     attr_accessor :label, :xlim, :ylim
     
+=begin rdoc
+  Creates a new plot. You only have to provide a title for the plot, that
+  will (probably) be used as a page title by the active template.
+=end
     def initialize(title = "Flotr Plot")
       @title = title
       @template = "#{BASENAME}/#{STD_TEMPLATE}"
@@ -64,14 +94,28 @@ module Flotr
       @label = @xlim = @ylim = {}
     end
     
+=begin rdoc
+  Lists the available standard templates. These are .rhtml files located in
+  the lib floder inside the gem. The extension .rhtml is dropped.
+=end
     def std_templates
       Dir.glob("#{BASENAME}/*.rhtml").map {|f| File.basename(f, ".rhtml")}
     end
     
+=begin rdoc
+  Selects the active template. It has to be one of those included in the
+  result of the std_templates method.
+=end
     def std_template=(template)
+      raise "Template #{template} does not exist!" unless self.std_templates.include?(template) 
       @template = "#{BASENAME}/#{template}.rhtml"
     end
-    
+
+=begin rdoc
+  Returns the currently selected standard template, or nil if the active
+  template is a custom one. Use Plot#template=(full/path/to/template.rhtml)
+  to set a custom template.
+=end
     def std_template
       if File.dirname(@template) == BASENAME
         File.basename(@template, ".rhtml")
@@ -80,6 +124,10 @@ module Flotr
       end
     end
     
+=begin rdoc
+  Generates the html file containing the plot and fires up a preferred
+  browser window with the plot loaded.
+=end
     def plot
       eruby = Erubis::Eruby.new(File.read(@template))
       File.open(OUTPUT_FILE, 'w') do |f|
@@ -97,6 +145,10 @@ module Flotr
     
     alias show plot
     
+=begin rdoc
+  Adds a Data serie to the Plot. It also returns self, so multiple calls
+  can be concatenated as in plot << series1 << series2 << series3.
+=end
     def <<(serie)
       if serie.instance_of? Data
         @series << serie
@@ -105,6 +157,9 @@ module Flotr
       end
     end
     
+=begin rdoc
+  Provides a JavaScript-formatted description of the all the series.
+=end
     def inspect
       data = @series.map {|s| s.inspect}
       "[ #{data*', '} ]"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pbosetti-flotr
 version: !ruby/object:Gem::Version 
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors: 
 - Paolo Bosetti
@@ -41,7 +41,7 @@ files:
 - lib/layout.css
 - lib/zooming.rhtml
 - examples/sincos.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/pbosetti/flotr
 post_install_message: 
 rdoc_options: