reportbuilder 1.2.5 → 1.3.0

data/lib/reportbuilder/graph/html_flot.rb

@@ -0,0 +1,149 @@
+class ReportBuilder
+  class Graph
+    # Flot Wrapper
+    class HtmlFlot < ElementBuilder
+      def generate()
+        @builder.js(ReportBuilder::DATA_DIR+"/flot/excanvas.min.js")
+
+        @builder.js(ReportBuilder::DATA_DIR+"/flot/jquery.min.js")
+        @builder.js(ReportBuilder::DATA_DIR+"/flot/jquery.flot.min.js")
+        
+        anchor=@builder.graph_entry(@element.name)
+        out="<a name='#{anchor}'></a><div id='graph_#{anchor}' style='width:#{@element.width}px; height:#{@element.height}px'> </div>"
+        out << "<script>\n$.plot($('#graph_#{anchor}'),"
+        out << @builder.parse_js(flot_series)+",\n" 
+        out << @builder.parse_js(flot_options)+"\n);"
+out+="</script>"
+        
+        @builder.html(out)
+      end
+      def set_type(opt,v)
+        case v
+        when :line
+          opt[:lines][:show]=true        
+        when :pie
+          raise "doesn't supported on flot"
+        when :scatter
+          opt[:lines][:show]=false
+          opt[:points][:show]=true
+        when :bar
+          opt[:lines][:show]=false
+          opt[:bars][:show]=true
+        when :histogram
+          opt[:lines][:show]=false
+          opt[:bars][:show]=true
+          opt[:bars][:align]="center"
+        else
+          raise "Type doesn't exists"
+        end
+      end
+      
+      
+      def hash_to_camel(h)
+        out=Hash.new
+        h.each do |k,v|
+          out[to_camel(k)]=v
+        end
+        out
+      end
+      def to_camel(k)
+        k.to_s.gsub(/_([a-z])/) {|s| s.upcase[1]}.to_sym
+      end
+      
+      def flot_options
+        opts=Hash.new
+        opts[:title]=@element.title
+        opts[:axesDefaults]=axes_defaults if @element.axes_defaults.size>0
+        opts[:xaxis]=xaxis
+        opts[:yaxis]=yaxis
+        opts[:series]= series_defaults if @element.series_defaults.size>0
+        opts[:legend]=legend  if @element.legend.size>0
+        opts[:grid]=grid if @element.grid.size>0
+        opts
+      end
+      
+      
+      
+      def axes_defaults
+        hash_to_camel(@element.axes_defaults)
+      end
+      def xaxis
+        hash_to_camel(@element.xaxis)
+      end
+      def yaxis
+        hash_to_camel(@element.yaxis)
+      end
+      def legend
+        lo=@element.legend
+        lo.delete(:position) if lo[:position] and !["ne","nw","se","sw"].include? lo[:position]
+        hash_to_camel(lo)
+      end
+      def series_defaults
+        series_js(@element.series_defaults)
+      end
+      def grid
+        replace={}
+        out=Hash.new
+        @element.grid.each do |k,v|
+          if replace.include? k
+            out[replace[k]]=v
+          else
+            out[to_camel(k)]=v
+          end
+        end
+        out
+      end
+      
+      def process_type(out_opt, k,v)
+        out_opt[:color]=v[:color] if !out_opt[:color]
+        out_opt[:shadowSize]=v[:shadow_depth] if v[:shadow_depth]
+        prev=out_opt[k]
+        if prev and prev.is_a? Hash
+          out_opt[k]=out_opt[k].merge(hash_to_camel(v))
+        else
+          out_opt[k]=hash_to_camel(v)
+        end
+      end
+      def series_js(in_opt)
+        out_opt=Hash.new        
+        out_opt[:lines]=Hash.new
+        out_opt[:points]=Hash.new
+        out_opt[:bars]=Hash.new
+        in_opt.each_pair do |k,v|
+          case k
+            when :type
+              set_type(out_opt, v)
+            when :bars
+              v.delete(:width) # Uses width as number of ticks
+              process_type(out_opt, k,v)
+            when :markers
+              process_type(out_opt, k,v)
+              out_opt[:points]=out_opt.delete(:markers)
+            when :lines
+              v[:line_width]=v[:width] if v[:width]
+              process_type(out_opt, k,v)
+            else
+              out_opt[to_camel(k)]=v
+          end
+        end
+        [:lines, :points, :bars].each do |v|
+          out_opt.delete(v) if out_opt[v].size==0
+        end
+        out_opt
+      end
+      # Transform data options on jqPlot ones
+      def flot_series
+        dv=@element.series_data
+        i=0
+        own_options=@element.series_options.map do |in_opt|
+          out_opt=Hash.new
+          out_opt[:data]=dv[i]
+          i+=1
+          out_opt.merge(series_js(in_opt))
+        end
+        own_options
+      end
+      
+    end
+  end
+end

data/lib/reportbuilder/graph/html_jqplot.rb

@@ -0,0 +1,145 @@
+class ReportBuilder
+  class Graph
+    # @element and @builder
+    class HtmlJqplot < ElementBuilder
+      def generate()
+        @builder.js(ReportBuilder::DATA_DIR+"/jqplot/excanvas.min.js")
+
+        @builder.js(ReportBuilder::DATA_DIR+"/jqplot/jquery-1.4.2.min.js")
+        @builder.js(ReportBuilder::DATA_DIR+"/jqplot/jquery.jqplot.min.js")
+        @builder.css(ReportBuilder::DATA_DIR+"/jqplot/jquery.jqplot.css")
+        anchor=@builder.graph_entry(@element.name)
+        out="<a name='#{anchor}'></a><div id='graph_#{anchor}' style='width:#{@element.width}px; height:#{@element.height}px'> </div>"
+        out+="
+<script>
+$.jqplot('graph_#{anchor}', #{@builder.parse_js(@element.series_data)},
+"+@builder.parse_js(jqplot_options)+");
+</script>"
+        
+        @builder.html(out)
+      end
+      def jqplot_options
+        opts=Hash.new
+        opts[:title]=@element.title
+        opts[:series]=series_options
+        opts[:axesDefaults]=axes_defaults if @element.axes_defaults.size>0
+        if @element.xaxis.size>0 or @element.yaxis.size>0
+          opts[:axes]={:xaxis=>xaxis, :yaxis=>yaxis}
+        end
+        opts[:seriesDefaults]= series_defaults if @element.series_defaults.size>0
+        opts[:legend]=legend  if @element.legend.size>0
+        opts[:grid]=grid if @element.grid.size>0
+        opts
+      end
+      
+      def set_type(opt,v)
+        case v
+        when :line
+        when :pie
+          @builder.js(ReportBuilder::DATA_DIR+"/jqplot/plugins/jqplot.pieRenderer.min.js")
+          opt[:renderer]="$.jqplot.PieRenderer".to_sym
+        when :scatter
+          opt[:showLine]=false
+          opt[:showMarker]=true
+        when :bar
+          @builder.js(ReportBuilder::DATA_DIR+"/jqplot/plugins/jqplot.categoryAxisRenderer.min.js")
+          @builder.js(ReportBuilder::DATA_DIR+"/jqplot/plugins/jqplot.barRenderer.min.js")
+          opt[:renderer]="$.jqplot.BarRenderer".to_sym
+        else
+          raise "Type doesn't exists"
+        end
+      end
+      def axes_defaults
+        hash_to_camel(@element.axes_defaults)
+      end
+      def xaxis
+        hash_to_camel(@element.xaxis)
+      end
+      def yaxis
+        hash_to_camel(@element.yaxis)
+      end
+      def legend
+        lo=@element.legend
+        lo[:location]=lo.delete(:position) if lo[:position] 
+        hash_to_camel(lo)
+      end
+      def series_defaults
+        series_js(@element.series_defaults)
+      end
+      def grid
+        replace={:show=>:drawGridLine, :color=>:gridLineColor, :background_color=>:background}
+        out=Hash.new
+        @element.grid.each do |k,v|
+          if replace.include? k
+            out[replace[k]]=v
+          else
+            out[to_camel(k)]=v
+          end
+        end
+        out
+      end
+      def hash_to_camel(h)
+        out=Hash.new
+        h.each do |k,v|
+          out[to_camel(k)]=v
+        end
+        out
+      end
+      def to_camel(k)
+        k.to_s.gsub(/_([a-z])/) {|s| s.upcase[1,1]}.to_sym
+      end
+      def series_js(in_opt)
+        out_opt=Hash.new
+        out_opt[:markerOptions]=Hash.new
+        out_opt[:rendererOptions]=Hash.new
+        in_opt.each_pair do |k,v|
+          case k
+            when :type
+              set_type(out_opt, v)
+            when :lines
+              out_opt[:showLines]=v[:show] if v[:show]              
+              v.each do |k1,v1|
+                out_opt[to_camel(k1)]=v1
+              end
+            when :markers
+              out_opt[:showMarker]=v[:show] if v[:show]
+              v.each do |k1,v1|
+                out_opt[:markerOptions][to_camel(k1)]=v1
+              end
+            when :bars
+              v.each do |k1,v1|
+                k1=("bar_"+k1.to_s) if [:padding, :margin, :direction, :width].include? k1
+                out_opt[:rendererOptions][to_camel(k1)]=v1
+              end              
+            when :color
+              if in_opt[:type]
+                set_color(in_opt[:type], out_opt,v)
+              else
+                out_opt[k]=v
+              end
+            else
+              out_opt[k]=v
+          end
+        end
+        out_opt
+      end
+      def set_color(t,out_opt,v)
+        case t
+          when :line
+            out_opt[:color]=v
+          when :scatter
+            out_opt[:markerOptions][:color]=v
+          when :bar
+            out_opt[:rendererOptions][:color]=v
+        end
+      end
+
+      # Transform data options on jqPlot ones
+      def series_options
+        @element.series_options.map do |in_opt|
+          series_js(in_opt)
+        end
+      end
+    end
+  end
+end

data/lib/reportbuilder/image.rb

@@ -1,89 +1,189 @@
-# Creates an Image
-# 
-class ReportBuilder::Image
-  @@n=1
-  attr_reader :name
-  def initialize(filename, options={})
-    if !options.has_key? :name
-      @name="Image #{@@n}"
-      @@n+=1
-    else
-      @name=options[:name]
-    end
-    default_options={
-      :alt=>@name,
-      :chars => [ 'W', 'M', '$', '@', '#', '%', '^', 'x', '*', 'o', '=', '+',
-      ':', '~', '.', ' ' ],
-      :font_rows => 8,
-      :font_cols => 4
-    }
-    @options=default_options.merge(options)
-    @filename=filename
-  end
-  # Based on http://rubyquiz.com/quiz50.html
-  def report_building_text(builder)
-   
-      require 'RMagick'
-
-    img = Magick::Image.read(@filename).first
-
-    # Resize too-large images. The resulting image is going to be
-    # about twice the size of the input, so if the original image is too
-    # large we need to make it smaller so the ASCII version won't be too
-    # big. The `change_geometry' method computes new dimensions for an
-    # image based on the geometry argument. The '320x320>' argument says
-    # "If the image is too big to fit in a 320x320 square, compute the
-    # dimensions of an image that will fit, but retain the original aspect
-    # ratio. If the image is already smaller than 320x320, keep the same
-    # dimensions."
-    img.change_geometry('320x320>') do |cols, rows|
-      img.resize!(cols, rows) if cols != img.columns || rows != img.rows
+require 'digest/md5'
+class ReportBuilder
+  # Abstract class for an image
+  class Image
+    @@n=1
+    attr_accessor :name
+    attr_accessor :alt
+    attr_accessor :chars
+    attr_accessor :font_rows
+    attr_accessor :font_cols
+    attr_accessor :width
+    attr_accessor :height
+    attr_accessor :type
+    attr_reader :filename
+    attr_reader :url
+    attr_reader :id
+    
+    def initialize(options=Hash.new)
+      @id=Digest::MD5.hexdigest(Time.new.to_f.to_s)      
+      @type=nil
+      if !options.has_key? :name
+        @name="Image #{@@n}"
+        @@n+=1
+      else
+        @name=options[:name]
+      end
+      
+      default_options={
+        :alt=>@name,
+        :chars => [ 'W', 'M', '$', '@', '#', '%', '^', 'x', '*', 'o', '=', '+',
+        ':', '~', '.', ' ' ],
+        :font_rows => 8,
+        :font_cols => 4,
+        :width=>400,
+        :height=>300
+      }
+      @options=default_options.merge(options)
+      @options.each {|k,v|
+        self.send("#{k}=",v) if self.respond_to? k
+      }
+    end 
+    # Get image_magick version of the image
+    def image_magick
+      raise "Must be implemented"
     end
-
-    # Compute the image size in ASCII "pixels" and resize the image to have
-    # those dimensions. The resulting image does not have the same aspect
-    # ratio as the original, but since our "pixels" are twice as tall as
-    # they are wide we'll get our proportions back (roughly) when we render.
-    pr = img.rows / @options[:font_rows]
-    pc = img.columns / @options[:font_cols]
-    img.resize!(pc, pr)
-
-    img = img.quantize(@options[:chars].size, Magick::GRAYColorspace)
-    img = img.normalize
-
-    out=""
-    # Draw the image surrounded by a border. The `view' method is slow but
-    # it makes it easy to address individual pixels. In grayscale images,
-    # all three RGB channels have the same value so the red channel is as
-    # good as any for choosing which character to represent the intensity of
-    # this particular pixel.
-    border = '+' + ('-' * pc) + '+'
-    out += border+"\n"
-    img.view(0, 0, pc, pr) do |view|
-      pr.times do |i|
-        out+= '|'
-        pc.times do |j|
-          out+= @options[:chars][view[i][j].red / (2**16/@options[:chars].size)]
+    # Based on http://rubyquiz.com/quiz50.html
+    def report_building_text(builder)
+      if ReportBuilder.has_rmagick?
+        # get image_magick version of image
+        img = image_magick
+        # Resize too-large images. The resulting image is going to be
+        # about twice the size of the input, so if the original image is too
+        # large we need to make it smaller so the ASCII version won't be too
+        # big. The `change_geometry' method computes new dimensions for an
+        # image based on the geometry argument. The '320x320>' argument says
+        # "If the image is too big to fit in a 320x320 square, compute the
+        # dimensions of an image that will fit, but retain the original aspect
+        # ratio. If the image is already smaller than 320x320, keep the same
+        # dimensions."
+        img.change_geometry('320x320>') do |cols, rows|
+          img.resize!(cols, rows) if cols != img.columns || rows != img.rows
         end
-        out+= '|'+"\n"
+    
+        # Compute the image size in ASCII "pixels" and resize the image to have
+        # those dimensions. The resulting image does not have the same aspect
+        # ratio as the original, but since our "pixels" are twice as tall as
+        # they are wide we'll get our proportions back (roughly) when we render.
+        pr = img.rows / font_rows
+        pc = img.columns / font_cols
+        img.resize!(pc, pr)
+    
+        img = img.quantize(chars.size, Magick::GRAYColorspace)
+        img = img.normalize
+    
+        out=""
+        # Draw the image surrounded by a border. The `view' method is slow but
+        # it makes it easy to address individual pixels. In grayscale images,
+        # all three RGB channels have the same value so the red channel is as
+        # good as any for choosing which character to represent the intensity of
+        # this particular pixel.
+        border = '+' + ('-' * pc) + '+'
+        out += border+"\n"
+        img.view(0, 0, pc, pr) do |view|
+          pr.times do |i|
+            out+= '|'
+            pc.times do |j|
+              out+= chars[view[i][j].red / (2**16 / chars.size)]
+            end
+            out+= '|'+"\n"
+          end
+        end
+        out+= border
+        builder.preformatted(out)
+      else
+        raise "Requires RMagick"
+      end
+    end
+    # Generate the code for images on html
+    def generate_tag_html(builder)
+      if @type=='svg'
+        builder.html("
+          <div class='image'>
+          <!--[if IE]>
+          <embed class='svg' height='#{@options[:height]}' src='#{@url}' width='#{@options[:width]}'></embed>
+          <![endif]-->
+            <object class='svg' data='#{@url}' height='#{@options[:height]}' type='image/svg+xml' width='#{@options[:width]}'></object>
+        </div>")
+      else
+        builder.html("<img src='#{@url}' alt='#{@options[:alt]}' />")
+      end
+    end
+    def create_file(directory)
+      raise "Must be implemented" 
+    end
+    def report_building_html(builder)
+      create_file(builder.directory)
+      generate_tag_html(builder)
+    end
+    # return filename
+    def generate_raster_from_svg(dir)
+      
+      out_file="#{dir}/#{@id}.png"
+      `rsvg '#{filename}' #{out_file}`
+      out_file
+    end
+    def report_building_rtf(builder)
+      require 'tmpdir'
+      directory=Dir::mktmpdir
+      create_file(directory)
+      raise "Not implemented on RTF::Document. Use gem install clbustos-rtf for support" unless builder.rtf.respond_to? :image
+      if @type=='svg'
+        builder.rtf.image(generate_raster_from_svg(directory))
+      else
+        builder.rtf.image(filename)
       end
     end
-    out+= border
-    builder.preformatted(out)
   end
-  def report_building_rtf(builder)
-    raise "Not implemented on RTF::Document. Use gem install thecrisoshow-ruby-rtf for support" unless builder.rtf.respond_to? :image
-    builder.rtf.image(@filename)
+  
+  class ImageBlob < Image
+    attr_accessor :blob
+    def initialize(blob, options=Hash.new)
+      super(options)
+      @blob=blob      
+      if !@type
+        if blob[0,40]=~/<svg/
+          @type='svg'
+        else
+          @type='jpg'
+        end
+      end
+    end
+    def image_magick
+      Magick::Image.from_blob(@blob)
+    end
+    def create_file(directory)
+      FileUtils.mkdir_p directory+"/images"
+      @filename=directory+"/images/"+@id+"."+@type
+      @url="images/"+@id+"."+@type
+      File.open(@filename,"w") do |fp|
+        fp.write @blob
+      end
+      @filename
+    end
+    
   end
-  def report_building_html(builder)
-    basedir=builder.directory+"/images"
-    out=basedir+"/"+File.basename(@filename)
-    if(File.exists? @filename)
-      if !File.exists? out
+  
+  class ImageFilename < Image
+    def initialize(filename, options=Hash.new)
+      super(options)
+      @filename=filename
+      File.basename(@filename)=~/\.(.+)$/
+      @type=File.basename($1)
+    end
+    def image_magick
+      Magick::Image.read(@filename).first
+    end
+    def create_file(directory)
+      basedir=directory+"/images"
+      out=basedir+"/"+File.basename(@filename)
+      @url="images/#{File.basename(@filename)}"
+      if(File.exists? @filename)
         FileUtils.mkdir_p basedir
-        FileUtils.cp @filename, out
+        if (!File.exists? out or (File.mtime(out) < File.mtime(@filename)))
+          FileUtils.cp @filename, out
+        end
       end
     end
-    builder.html("<img src='images/#{File.basename(@filename)}' alt='#{@options[:alt]}' />")
   end
 end