report_engine 1.2.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bastien Vaucher
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= report_engine
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Bastien Vaucher. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "report_engine"
+    gem.summary = "Report engine specific to the teneo app"
+    gem.description = "Layer on top of prawn and the html renderer to generate reports for Novalis::teneo"
+    gem.email = "bastien.vaucher@gmail.com"
+    gem.homepage = "http://github.com/bastien/report_engine"
+    gem.authors = ["Bastien Vaucher", "Jacob Atzen"]
+    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "report_engine #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.2.4

data/lib/report_engine.rb

@@ -0,0 +1,50 @@
+require 'prawn'
+require 'prawn/layout'
+require 'active_support/inflector'
+
+
+# Dir.glob(File.dirname(__FILE__) + '/report_engine/*.rb').each do |filename|
+#   require filename
+# end
+# 
+# Dir.glob(File.dirname(__FILE__) + '/report_engine/pdf/*.rb').each do |filename|
+#   require filename
+# end
+# 
+# Dir.glob(File.dirname(__FILE__) + '/report_engine/html/*.rb').each do |filename|
+#   require filename
+# end
+
+require File.dirname(__FILE__) + '/report_engine/canvas_factory.rb'
+require File.dirname(__FILE__) + '/report_engine/pdf_canvas.rb'
+require File.dirname(__FILE__) + '/report_engine/html_canvas.rb'
+require File.dirname(__FILE__) + '/report_engine/page.rb'
+require File.dirname(__FILE__) + '/report_engine/google_chart.rb'
+require File.dirname(__FILE__) + '/report_engine/horizontal_chart.rb'
+require File.dirname(__FILE__) + '/report_engine/table.rb'
+require File.dirname(__FILE__) + '/report_engine/sub_table.rb'
+require File.dirname(__FILE__) + '/report_engine/text.rb'
+require File.dirname(__FILE__) + '/report_engine/footer.rb'
+require File.dirname(__FILE__) + '/report_engine/question_stats.rb'
+require File.dirname(__FILE__) + '/report_engine/list.rb'
+require File.dirname(__FILE__) + '/report_engine/container.rb'
+require File.dirname(__FILE__) + '/report_engine/report.rb'
+require File.dirname(__FILE__) + '/report_engine/pdf/list.rb'
+require File.dirname(__FILE__) + '/report_engine/pdf/container.rb'
+require File.dirname(__FILE__) + '/report_engine/pdf/text.rb'
+require File.dirname(__FILE__) + '/report_engine/pdf/table.rb'
+require File.dirname(__FILE__) + '/report_engine/pdf/sub_table.rb'
+require File.dirname(__FILE__) + '/report_engine/pdf/section.rb'
+require File.dirname(__FILE__) + '/report_engine/pdf/question_stats.rb'
+require File.dirname(__FILE__) + '/report_engine/pdf/google_chart.rb'
+require File.dirname(__FILE__) + '/report_engine/html/list.rb'
+require File.dirname(__FILE__) + '/report_engine/html/container.rb'
+require File.dirname(__FILE__) + '/report_engine/html/text.rb'
+require File.dirname(__FILE__) + '/report_engine/html/table.rb'
+require File.dirname(__FILE__) + '/report_engine/html/sub_table.rb'
+require File.dirname(__FILE__) + '/report_engine/html/section.rb'
+require File.dirname(__FILE__) + '/report_engine/html/question_stats.rb'
+require File.dirname(__FILE__) + '/report_engine/html/google_chart.rb'
+
+module ReportEngine
+end

data/lib/report_engine/canvas_factory.rb

@@ -0,0 +1,13 @@
+module ReportEngine
+  class CanvasFactory
+    class << self
+      def build(format)
+        case format
+        when :pdf: PdfCanvas.new
+        when :html: HtmlCanvas.new
+        else raise "Unknown Canvas format"
+        end
+      end
+    end
+  end
+end

data/lib/report_engine/container.rb

@@ -0,0 +1,4 @@
+module ReportEngine
+  class Container < List
+  end
+end

data/lib/report_engine/footer.rb

@@ -0,0 +1,13 @@
+module ReportEngine
+  class Footer
+    def initialize(canvas, elements)
+      @canvas = canvas
+      point = [canvas.pdf.bounds.right-30, canvas.pdf.bounds.bottom + 15]
+      @footer = canvas.pdf.repeat(:all, :dynamic => true) do
+        elements.each do |element|
+          canvas.paint(element[:type], element)
+        end
+      end
+    end
+  end
+end

data/lib/report_engine/google_chart.rb

@@ -0,0 +1,59 @@
+require "open-uri"
+require 'gchart'
+
+module ReportEngine
+  class GoogleChart
+    def initialize(canvas, options)
+      @canvas       = canvas
+      @data         = options[:data]
+      @scale_labels = options[:scale_labels]
+      @x_label      = options[:x_label]
+      @y_label      = options[:y_label]
+      @grouped      = options[:grouped].nil? ? true : options[:grouped]
+      @colors       = options[:colors] || ['97172E','EE8C9E']
+      @show_marker  = options[:show_marker]
+    end
+    
+    def generate_url
+      max = @data.max
+      chart = ::GChart.bar do |g|
+        g.grouped = @grouped
+        g.data = @data #values.map{|v| v * 100.0 / max }
+        g.colors = @colors
+        g.width  = 520
+        g.height = 140
+        g.orientation = :vertical
+        g.axis(:left) do |a|
+          a.labels = [@y_label] #["%"]
+          a.label_positions = [100]
+          a.text_color = :black
+        end
+        g.axis(:bottom) do |a|
+          a.labels = @scale_labels # ["0-10","10-20","20-30","30-40","40-50","50-60","60-70","70-80","80-90","90-100"]
+          a.text_color = :black
+        end
+        g.axis(:bottom) do |a|
+          a.labels = [@x_label] # ["Procentil"]
+          a.label_positions = [100]
+          a.text_color = :black
+        end
+        extra = {"chbh" => "a,5,10", "chds" => "0,#{max_value}"}
+        extra.update("chbh" => "r,5,10") if @data.flatten.size < 3
+        if @show_marker
+          if @data.first.is_a? Array
+            extra.update("chm" => @data.size.times.map{|i| "N,000000,#{i},-1,11" }.join('|'))
+          else
+            extra.update("chm" => "N,000000,0,-1,11")
+          end
+        end
+        g.extras = extra
+      end
+      chart.to_url
+    end
+    
+    def max_value
+      @data.flatten.max
+    end
+  
+  end
+end

data/lib/report_engine/horizontal_chart.rb

@@ -0,0 +1,43 @@
+require "open-uri"
+require 'gchart'
+
+module ReportEngine
+  class HorizontalChart
+    
+    def initialize(options)
+      @reference = options[:reference]
+      @labels = options[:labels]
+      @values = options[:values]
+    end
+    
+    def generate_url
+      chart = GChart.bar do |g|
+        g.colors = ['3A94EE']
+        g.width  = 600
+        g.height = 160
+        g.max = 100
+        g.data = @values
+        g.orientation = :horizontal
+         g.axis(:left) do |a|
+            a.labels = @labels
+            a.text_color = :black
+          end
+        g.axis(:bottom) do |a|
+          a.labels = [0, 100]
+          a.label_positions = [0,100]
+          a.text_color = :black
+        end
+        if @reference
+          g.axis(:bottom) do |a|
+            a.labels = [@reference]
+            a.label_positions = [@reference]
+            a.text_color = :red
+          end
+        end
+        g.extras = {"chm" => "#{"h,FF0000,0,#{@reference/100.0},1|" if @reference}N,000000,0,-1,11"}
+      end
+      chart.to_url
+    end
+    
+  end
+end

data/lib/report_engine/html/container.rb

@@ -0,0 +1,9 @@
+module ReportEngine
+  module Html
+    class Container < ReportEngine::Container
+      def add_list_element(element)
+        @canvas.paint(element.delete(:type), element)
+      end
+    end
+  end
+end

data/lib/report_engine/html/google_chart.rb

@@ -0,0 +1,9 @@
+module ReportEngine
+  module Html
+    class GoogleChart < ReportEngine::GoogleChart
+      def render
+        generate_url
+      end
+    end
+  end
+end

data/lib/report_engine/html/list.rb

@@ -0,0 +1,18 @@
+module ReportEngine
+  module Html
+    class List < ReportEngine::List
+      def add_list_element(element)
+        @canvas.paint(element.delete(:type), element)
+        @canvas.add_content " " unless element == @elements.last
+      end
+
+      def add_list_start
+        @canvas.add_content("<ul>")
+      end
+
+      def add_list_end
+        @canvas.add_content("</ul>")
+      end
+    end
+  end
+end

data/lib/report_engine/html/question_stats.rb

@@ -0,0 +1,29 @@
+module ReportEngine
+  module Html
+    class QuestionStats < ReportEngine::QuestionStats
+      @@odd = "even"
+      
+      def render
+        @canvas.add_content(["<li id='question_#{@id}' class='#{swap_odd}'>",
+          "<div class='sort col index'>#{@index}</div>",
+          "<div class='sort col question'>#{@text}</div>",
+          "<div class='clear'></div>",
+          "<div id='question_details_#{@id}_tab' class='question_details'>",
+          "<img src='#{@canvas.paint(@chart[:type], @chart)}'/>"].join(' '))
+        @canvas.paint(@details[:type], @details)
+        @canvas.add_content("</div></li>")
+      end
+      
+      # Alternates between 'odd' and 'even'
+      #
+      def swap_odd
+        if @@odd == "odd"
+          @@odd = "even"
+        else
+          @@odd = "odd"
+        end
+      end
+      
+    end
+  end
+end

data/lib/report_engine/html/section.rb

@@ -0,0 +1,16 @@
+module ReportEngine
+  module Html
+    class Section < ReportEngine::Page
+      def print_title
+        @canvas.add_content("<li><h3>#{@title}</h3></li>")
+      end
+      
+      def print_content
+        @elements.each do |element|
+          @canvas.paint(element.delete(:type), element)
+          # @canvas.add_content(element.render_html)
+        end
+      end
+    end
+  end
+end

data/lib/report_engine/html/sub_table.rb

@@ -0,0 +1,14 @@
+module ReportEngine
+  module Html
+    class SubTable < ReportEngine::Html::Table
+      def render
+        render_headers + render_lines
+      end
+      
+      def render_headers
+        render_line(@x_headers, 'table_sub_heading')
+      end
+      
+    end
+  end
+end

data/lib/report_engine/html/table.rb

@@ -0,0 +1,77 @@
+module ReportEngine
+  module Html
+    class Table < ReportEngine::Table
+    
+      # renders an html table
+      #
+      def render
+        if !@x_label.nil? && !@y_label.nil?
+          @canvas.add_content( "<h2 class='axes'>#{@axis_title}</h2>
+          <ul class='axes_list'>
+            <li class='x_axis'>#{@x_label}</li>
+            <li class='y_axis'>#{@y_label}</li>
+          </ul>"  )
+        end
+        @canvas.add_content("<table>")
+        @canvas.add_content(render_headers)
+        if @data.first.is_a? Hash
+          @data.each.map{|sub_table| @canvas.add_content(ReportEngine::Html::SubTable.new(@canvas, sub_table).render) }
+        else
+          @canvas.add_content("<tbody>#{ render_lines }</tbody>")
+        end
+        @canvas.add_content("</table>")
+        if !@legends.nil?
+          @canvas.add_content("<ul class='legends'>
+            #{@legends.map{|l| "<li>#{l}</li>"}}
+          </ul>")
+        end
+      end
+
+      # renders the header of an html table
+      #
+      def render_headers
+        if @y_headers && !@data.first.is_a?(ReportEngine::SubTable)
+          add_y_headers
+        end
+        if @x_headers
+          "<thead>
+            <tr>
+              #{@x_headers.map{|header| "<th>#{header}</th>" }}
+            </tr>
+          </thead>"
+        else
+          ""
+        end
+      end
+
+      # Alternates between 'odd' and 'even'
+      #
+      def swap_odd
+        if @odd == "odd"
+          @odd = "even"
+        else
+          @odd = "odd"
+        end
+      end
+
+      # renders all the lines in the html table
+      #
+      def render_lines
+        @data.map{|line| render_line(line, swap_odd) }.join(' ')
+      end
+
+      # renders a line in an html table
+      #
+      def render_line(line, html_class = nil)
+        "<tr #{ "class='#{html_class}'" if html_class}>#{render_cells(line)}</tr>"
+      end
+
+      # renders cells within a line in a html table
+      #
+      def render_cells(line)
+        line.map{|cell| "<td>#{cell}</td>" }
+      end
+    
+    end
+  end
+end