wayneeseguin-dynamic_reports 0.0.2

data/lib/dynamic_reports/vendor/google_chart/scatter_chart.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/base'
+module GoogleChart
+  
+  # Generates a Scatter chart.
+  # 
+  # ==== Example
+  #      sc = GoogleChart::ScatterChart.new('320x200',"Scatter Chart")
+  #      sc.data "Scatter Set", [[1,1,], [2,2], [3,3], [4,4]]
+  #      sc.point_sizes [10,15,30,55]
+  #      puts sc.to_url  
+  class ScatterChart < Base
+    
+    # Initializes the Scatter Chart with a +chart_size+ (in WIDTHxHEIGHT format) and a +chart_title+
+    def initialize(chart_size='300x200', chart_title=nil) # :yield: self
+      super(chart_size, chart_title)
+      self.chart_type = :s
+      self.show_legend = false
+      @point_sizes = []
+      yield self if block_given?
+    end
+    
+    def process_data
+      # Interleave X and Y co-ordinate data
+      encoded_data = join_encoded_data([encode_data(x_data[0],max_x_value), encode_data(y_data[0],max_y_value)])
+      # Add point sizes data if it exists
+      unless @point_sizes.empty?
+        encoded_data = join_encoded_data([encoded_data, encode_data(@point_sizes)])
+      end
+      return encoded_data
+    end
+    
+    # Specify the data point sizes of the Scatter chart (optional). The data point sizes are scaled with this data set.
+    def point_sizes(values)            
+      @point_sizes = values
+    end
+    
+  end
+end

data/lib/dynamic_reports/vendor/google_chart/venn_diagram.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/base'
+module GoogleChart
+    # Generates a Venn Diagram.
+    #        
+    # Supply three vd.data statements of label, size, color for circles A, B, C. Then, intersections with four values:
+    # * the first value specifies the area of A intersecting B
+    # * the second value specifies the area of B intersecting C
+    # * the third value specifies the area of C intersecting A
+    # * the fourth value specifies the area of A intersecting B intersecting C
+    #
+    #      vd = GoogleChart::VennDiagram.new("320x200", 'Venn Diagram') 
+    #      vd.data "Blue", 100, '0000ff'
+    #      vd.data "Green", 80, '00ff00'
+    #      vd.data "Red",   60, 'ff0000'
+    #      vd.intersections 30,30,30,10
+    #      puts vd.to_url  
+    class VennDiagram < Base
+      
+        # Initializes the Venn Diagram with a +chart_size+ (in WIDTHxHEIGHT format) and a +chart_title+
+        def initialize(chart_size='300x200', chart_title=nil) # :yield: self
+            super(chart_size, chart_title)
+            self.chart_type = :v
+            @intersections = []
+            yield self if block_given? 
+        end
+         
+        def process_data          
+          encode_data(@data + @intersections)
+        end
+         
+        # Specify the intersections of the circles in the Venn Diagram. See the Rdoc for class for sample
+        def intersections(*values)            
+          @intersections = values
+        end
+    end
+end

data/lib/dynamic_reports/vendor/google_chart.rb

@@ -0,0 +1,11 @@
+%w(
+    base
+    pie_chart
+    line_chart
+    bar_chart
+    venn_diagram
+    scatter_chart
+    financial_line_chart    
+).each do |filename|
+    require File.dirname(__FILE__) + "/google_chart/#{filename}"
+end

data/lib/dynamic_reports/views/default_layout.html.erb

@@ -0,0 +1 @@
+<%= yield %>

data/lib/dynamic_reports/views/default_report.html.erb

@@ -0,0 +1,73 @@
+<% if report.class_name.nil? %>
+  <style type="text/css">
+    .dynamic_report .report_title {
+      font-size:16pt;
+      font-weight:bold;
+      margin:10px 0px;
+    }
+    .dynamic_report .report_sub_title {
+      font-size:14pt;
+      color:black;
+      margin:10px 0px;
+    }
+    .dynamic_report table tr th {
+      color: white;
+      background: gray;
+      padding:5px;
+    }
+    .dynamic_report table tr td {
+      border: 1px solid black;
+      padding:3px 15px;
+    }
+    .dynamic_report .report_charts {
+      width:100%;
+    }
+
+    .dynamic_report .report_chart {
+      margin:15px;
+    }
+  </style>
+<% end %>
+
+<div id="<%= report.class_name %>" class="dynamic_report">
+  <%= "<div class='report_title'>#{report.title}</div>" if report.title %>
+  <%= "<div class='report_sub_title'>#{report.sub_title}</div>" if report.sub_title %>
+  <table class="report" border="0" cellpadding="0" cellspacing="0">
+    <thead class="report_header">
+      <tr class="report_header_row">
+        <% report.columns.each do |column| %>
+          <th>
+            <%= options[:titleize] ? titleize(column) : column %>
+          </th>
+        <% end %>
+      </tr>
+    </thead>
+    <tbody class="report_body">
+      <% report.records.each do |record| %>
+        <tr class="report_row">
+          <% report.columns.each do |column| %>
+            <td>
+              <% if record.is_a?(Hash) %>
+                <%= (options[:commas] == true) ? commify(record[column]) : record[column] %>
+              <% elsif record.respond_to?(column.to_sym) %>
+                <%= (options[:commas] == true) ? commify(record.send(column.to_sym)) : record.send(column.to_sym) %>
+              <% else %>
+                <%= column %>
+              <% end %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+
+  <div class="report_charts">
+    <% report.charts.to_a.each do |chart| %>
+      <span class="report_chart">
+        <%=  "<img src='#{chart_url(chart,report)}' alt='#{chart.name}'>" %>
+      </span>
+    <% end %>
+  </div>
+
+</div>
+

data/lib/dynamic_reports/views/default_report.html.haml

@@ -0,0 +1,62 @@
+- if report.class_name.nil?
+  %style{type => "text/css"}
+    \.dynamic_report .report_title {
+    font-size:16pt;
+    font-weight:bold;
+    margin:10px 0px;
+    }
+    \.dynamic_report .report_sub_title {
+    font-size:14pt;
+    color:black;
+    margin:10px 0px;
+    }
+    \.dynamic_report table tr th {
+    color: white;
+    background: gray;
+    padding:5px;
+    }
+    \.dynamic_report table tr td {
+    border: 1px solid black;
+    padding:3px 15px;
+    }
+    \.dynamic_report .report_charts {
+    width:100%;
+    }
+    \.dynamic_report .report_chart {
+    margin:15px;
+    }
+
+.dynamic_report{ :id => report.class_name }
+  - if report.title
+    %h2.report_title
+      = report.title
+
+  - if report.sub_title
+    %h3.report_sub_title
+      = report.sub_title
+
+  %table.report{ :cellspacing => "0", :border => "0", :cellpadding => "0" }
+    %thead.report_header
+      %tr.report_header_row
+        - report.columns.each do |column|
+          %th
+            = options[:titleize] ? titleize(column) : column
+    %tbody.report_body
+      - report.records.each do |record|
+        %tr.report_row
+          - report.columns.each do |column|
+            %td
+              - if record.is_a?(Hash)
+                = (options[:commas] == true) ? commify(record[column]) : record[column]
+              - elsif record.respond_to?(column.to_sym)
+                = (options[:commas] == true) ? commify(record.send(column.to_sym)) : record.send(column.to_sym)
+              - else
+                = column
+
+  - if report.charts && report.charts.class === Hash
+    - report.charts.each_pair do |name, chart|
+      .chart
+        %h2
+          = name
+        %img{:src => chart_url(chart), :alt => name}
+

data/lib/dynamic_reports/views.rb

@@ -0,0 +1,30 @@
+module DynamicReports
+  class View
+
+    include Templates
+
+    attr_accessor :template, :views, :report
+    @@cached_templates = {}
+    @template = {}
+    @views    = {}
+
+    def options
+      @options ||= {}
+    end
+
+    def initialize(report)
+      @template = report.template
+      @report   = report
+      @views    = report.views
+    end
+
+    class << self
+      def cached_templates
+        @@cached_templates
+      end
+    end
+
+    # TODO: Investigate if we can remove the need for caller_locations here?
+    def self.caller_locations ; [] ; end
+  end
+end

data/lib/dynamic_reports.rb

@@ -0,0 +1,47 @@
+# :include: README
+
+# Library Files
+module DynamicReports
+  @@default_view_paths = ["#{File::dirname(File::expand_path(__FILE__))}/dynamic_reports/views/"]
+  def self.default_view_paths
+    @@default_view_paths
+  end
+  def self.default_view_paths=(paths)
+    @@default_view_paths = paths
+  end
+end
+
+require "dynamic_reports/charts"
+require "dynamic_reports/reports"
+require "dynamic_reports/templates"
+require "dynamic_reports/views"
+require "dynamic_reports/vendor/google_chart"
+
+
+# TODO: Figure out why this will not load:
+# require "dynamic_reports/rails"
+# For now placing the code right here:
+if defined?(Rails)
+  # Load all defined reports. 
+  # Question: How to get Rails to reload files other than ones matching the requested constant...
+  #Dir.glob("#{File.join(Rails.root, "app", "reports")}/*.rb").each { |file| require file }
+  ActiveSupport::Dependencies.load_paths << File.join(Rails.root, "app", "reports")
+  # Question: Should we allow for report directory nesting ?
+
+  # Set default views directory
+  # TODO: These should be added to Rails views directories?
+  DynamicReports.default_view_paths += [
+    File.join(Rails.root, "app", "views", "reports"),
+    File.join(Rails.root, "app", "views", "layouts")
+  ]
+
+  # TODO: Render extension
+
+  # TODO: AR extensions:
+  #       has_report :daily, :columns => [...], :options => {...}, :title => ...
+  #         Which will generate a report object DailyReport with the given definition.
+  #         Everything after the name corresponds to options available in the configuration block.
+
+  # TODO: Generator
+end
+

data/test/dynamic_reports/charts_test.rb

@@ -0,0 +1,61 @@
+class ChartsTest < Test::Unit::TestCase
+  context "charts" do
+    setup do
+      class TheReport < DynamicReports::Report
+        chart :the_chart_name, :an => "option", :another => "option" do
+          title "awesome report!"
+          type :svg
+          height "350"
+          width "250"
+          columns :pageviews
+          label_column "created_at"
+        end
+        chart :the_other_chart_name do
+          title "Some other chart"
+        end
+      end
+    end
+
+    should "allow specification of options to the chart beyond it's attributes." do
+      hash = {
+          :name => :the_chart_name, 
+          :an => "option", 
+          :type => :svg,
+          :another => "option",
+          :title=>"awesome report!",
+          :height=>"350",
+          :width=>"250",
+          :columns=>[:pageviews],
+          :label_column => "created_at"
+        }
+        assert_equal hash, TheReport.chart_with_name(:the_chart_name).options
+    end
+
+    should "allow setting their name" do
+      assert_equal :the_chart_name, TheReport.chart_with_name(:the_chart_name).name
+    end
+
+    should "allow setting their title" do
+      assert_equal "awesome report!", TheReport.chart_with_name(:the_chart_name).title
+    end
+
+    should "allow setting their type" do
+      assert_equal :svg, TheReport.chart_with_name(:the_chart_name).type
+    end
+    
+    should "allow setting their width" do
+      assert_equal "250" ,TheReport.chart_with_name(:the_chart_name).width
+    end
+
+    should "allow setting their height" do
+      assert_equal "350", TheReport.chart_with_name(:the_chart_name).height
+    end
+    
+    should "allow definition of multiple charts" do
+      #require "ruby-debug" ; debugger
+      assert_contains TheReport.charts[0].name, :the_chart_name
+      assert_contains TheReport.charts[1].name, :the_other_chart_name
+    end
+
+  end
+end

data/test/dynamic_reports/reports_test.rb

@@ -0,0 +1,77 @@
+class ReportsTest < Test::Unit::TestCase
+  context "a report" do
+
+    setup do
+      class TheReport < DynamicReports::Report
+        name  "The Report!"
+        title "Daily Report"
+        sub_title "Happens every day, ya!"
+        columns :recorded_at, :viewed_on, :pageviews_count, :visits_count, :conversions_count
+
+        chart :visits do
+          title "testing chart"
+          columns :visits
+          type "line"
+        end
+      end
+      @array_records  = DynamicReports::Test::ArrayRecords.generate(TheReport, :count => 10)
+      @object_records = DynamicReports::Test::ObjectRecords.generate(TheReport, :count => 10)
+    end
+
+    should "allow setting the title of a report" do
+      assert_equal "Daily Report", TheReport.title
+    end
+
+    should "allow setting the sub title of a report" do
+      assert_equal "Happens every day, ya!", TheReport.sub_title
+    end
+    
+    should "allow setting the columns to report on" do
+      assert_equal [:recorded_at, :viewed_on, :pageviews_count, :visits_count, :conversions_count], TheReport.columns
+    end
+
+    should "return an instantiated report .on is called" do
+      assert_kind_of DynamicReports::Report, 
+        TheReport.on(@array_records)
+    end
+
+    should "An instantiated report should return html table report when to_html is called" do
+      assert_match(/<table class="report"/, TheReport.on(@array_records).to_html)
+    end
+
+    should "An instantiated report should contain the rendered chart that was defined" do
+      assert_match(/class="report_charts"/, TheReport.on(@array_records).to_html)
+    end
+    
+    context "Report with templates and views specified" do
+      setup do
+        class SpecificTemplateReport < DynamicReports::Report
+          name  "A report with specified template!"
+          title "Specify Template Report"
+          sub_title "template is 'other_template'"
+          columns :recorded_at, :viewed_on, :pageviews_count, :visits_count, :conversions_count
+          template :specific_template
+          views "#{File::dirname(File::expand_path(__FILE__))}/views/"
+        end
+        @array_records  = DynamicReports::Test::ArrayRecords.generate(SpecificTemplateReport, :count => 10)
+        @object_records = DynamicReports::Test::ObjectRecords.generate(SpecificTemplateReport, :count => 10)
+      end
+
+      should "allow setting of the views directories" do
+        assert_contains SpecificTemplateReport.views, 
+          "#{File::dirname(File::expand_path(__FILE__))}/views/"
+      end
+
+      should "the instance should have the same views as the class" do
+        assert_contains SpecificTemplateReport.on(@array_records).views, 
+          "#{File::dirname(File::expand_path(__FILE__))}/views/"
+      end
+
+      should "render with the specified template, from the specified views directory" do
+        assert_equal "This is the specified template!", 
+          SpecificTemplateReport.on(@array_records).to_html.strip
+      end
+    end
+  end
+
+end

data/test/dynamic_reports/templates_test.rb

@@ -0,0 +1,3 @@
+class TemplatesTest < Test::Unit::TestCase
+
+end

data/test/dynamic_reports/views_test.rb

@@ -0,0 +1,5 @@
+class ReportsTest < Test::Unit::TestCase
+  context "View" do
+
+  end
+end

data/test/dynamic_reports.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "test/unit/testsuite"
+require "test/unit/ui/console/testrunner"
+#require "test/unit/color"
+require "shoulda"
+require "zentest"
+
+# Libraries
+require "dynamic_reports"
+require "test/test_helper"
+
+# Test files.
+require "test/dynamic_reports/charts_test"
+require "test/dynamic_reports/reports_test"
+require "test/dynamic_reports/views_test"
+
+require "test/unit"

data/test/test_helper.rb

@@ -0,0 +1,64 @@
+require "ostruct"
+
+module DynamicReports
+  module Test
+
+    class ArrayRecords
+      def self.generate(report, *options)
+        records = []
+        options = options.shift || {}
+        (0..(options[:count].to_i)).each do |index|
+          hash = {}
+          report.columns.each do |column|
+            hash[column.to_s] = 
+            case column.to_s
+            when /_at$/
+              (DateTime.now-100)+index
+            when /_on$/
+              (Date.today-100)+index
+            when /_id$/,/_count$/
+              rand(10000)
+            else
+              column
+            end
+          end
+          records << hash
+        end
+        records
+      end
+    end
+
+    class ObjectRecords
+      def self.generate(report,*options)
+        records = []
+        options = options.shift || {}
+        (0..(options[:count].to_i)).each do |index|
+          object = OpenStruct.new(report.columns)
+          report.columns.each do |column|
+            value = case column.to_s
+            when /_at$/
+              (DateTime.now-100)+index
+            when /_on$/
+              (Date.today-100)+index
+            when /_id$/,/_count$/
+              rand(10000)
+            else
+              column
+            end
+    
+            object.send(column.to_sym, value)
+    
+            records << object
+          end
+          records
+        end
+      end 
+    end
+    
+    class ARRecords
+      def self.generate(*options)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: wayneeseguin-dynamic_reports
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Wayne E. Seguin
+- Joshua Lippiner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Dynamic Ruby Reporting Engine with support for Charts.
+email: wayneeseguin@gmail.com, jlippiner@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- README.rdoc
+files: 
+- HISTORY
+- README
+- dynamic_reports.gemspec
+- lib/dynamic_reports.rb
+- lib/dynamic_reports/charts.rb
+- lib/dynamic_reports/reports.rb
+- lib/dynamic_reports/templates.rb
+- lib/dynamic_reports/vendor/google_chart.rb
+- lib/dynamic_reports/vendor/google_chart/bar_chart.rb
+- lib/dynamic_reports/vendor/google_chart/base.rb
+- lib/dynamic_reports/vendor/google_chart/financial_line_chart.rb
+- lib/dynamic_reports/vendor/google_chart/line_chart.rb
+- lib/dynamic_reports/vendor/google_chart/pie_chart.rb
+- lib/dynamic_reports/vendor/google_chart/scatter_chart.rb
+- lib/dynamic_reports/vendor/google_chart/venn_diagram.rb
+- lib/dynamic_reports/views.rb
+- lib/dynamic_reports/views/default_layout.html.erb
+- lib/dynamic_reports/views/default_report.html.erb
+- lib/dynamic_reports/views/default_report.html.haml
+- README.rdoc
+has_rdoc: false
+homepage: http://dynamicreports.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dynamicreports
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Dynamic Ruby Reporting Engine with support for Charts
+test_files: 
+- test/dynamic_reports/charts_test.rb
+- test/dynamic_reports/reports_test.rb
+- test/dynamic_reports/templates_test.rb
+- test/dynamic_reports/views_test.rb
+- test/dynamic_reports.rb
+- test/factories/records.rb
+- test/test_helper.rb