dynamic_reports 0.0.1 → 0.0.4

data/HISTORY

@@ -1,2 +1,9 @@
+0.0.3
+  - Added jewler for github love.
+0.0.2
+  - Github compaitble gemspec
+  - Passing tests
+0.0.1
+  - Template fixups
 0.0.0
-  - Initial dynamic reports codebase.
+  - Initial dynamic reports codebase.

data/README

@@ -1,7 +1,7 @@
 = Dynamic Reports
 
   A dynamic reporting engine for Ruby / Rails
-
+  
 == Reports
   
   The dynamic reports gem was created to fill a HUGE hole that we felt existed in the 
@@ -114,32 +114,90 @@
         label_column "created_at"
     end
 
-== Stylizing
-
-  The reports are, by default, stylized with an inline style sheet.  The styles produce a nicely formatted grid with
-  a white on black header row and black on white columns with a gray border througout.
+== External Links
 
-  You can create your own styles by simply adding a class_name object to the report definition as such:
-
-    class OrdersReport < DynamicReports::Report
-      title "Orders Report"
-      subtitle "All orders recorded in database"
-      columns :total, :created_at
+  Dynamic Reports supports linking from any column within your table.  To add a link to a column, add the following 
+  to a report definition:
+  
+  link :column, url
+  
+  For example:
+  
+  class OrdersReport < DynamicReports::Report
+    title "Orders Report"
+    subtitle "All orders recorded in database"
+    columns :total, :created_at
+    
+    link :total, '/report/daily_sales'
+  end
+  
+  You can also pass parameters to the URL based on values from the underlying model.  To pass a parameter, surround the 
+  field name with {}.  The parameter does NOT need to be a displayed, column.  For example, you might want to pass 
+  an external link an ID column but not display this column on the table.  
+  
+  For example:
+  
+  class OrdersReport < DynamicReports::Report
+    title "Orders Report"
+    subtitle "All orders recorded in database"
+    columns :total, :created_at
+    
+    link :total, '/report/item_sales?id={id}'   # =>  Will substitute ID for the value of ID associated with that record
+  end
+  
+  
+== Subreports
 
-      class_name "my_class_name"
-    end
+  Dynamic Reports supports the display of a sub-report within any report.  This is accomplished using the jQuery library 
+  available at http://www.jquery.com.  
+  
+  Sub-reports are created using the same definition format that you would use to create a standard report.  The only 
+  difference is that it is displayed INLINE when an associated link is clicked.  
+  
+  A sub-report is defined using the same format as a LINK above, but is labeled as:
+  
+  subreport :column, url
+  
+  For example, if you wanted to show all sales and allow a user to click on a specific item to see all historic sales 
+  inline for just that item, you would do the following:
+  
+  IN CONTROLLER:
+  
+  def orders
+    @orders = Order.find(:all, :limit => 25)
+    render :text => OrdersReport.on(@orders).to_html, :layout => "application"
+  end
+  
+  def item_sales
+    @item_orders = Order.find_by_id(params[:id])
+    render :text => ItemSales.on(@orders).to_html, :layout => "application"
+  end
+  
+  REPORT DEFINITIONS
+  
+  class OrdersReport < DynamicReports::Report
+    title "Orders Report"
+    subtitle "All orders recorded in database"
+    columns :total, :created_at
+    
+    subreport :total, '/report/item_sales?id={id}'   # =>  Will substitute ID for the value of ID associated with that record
+  end
+  
+  class ItemSales < DynamicReports::Report
+    columns :item, :price, :created_at
+  end
+  
+  Subreports can also be nested.
+  
+== Rails Usage
 
-  This will cause DR to simply not include the inline style.  From there you can customer the styles using the
-  following sub-classes for your class name, for example:
+  The gem includes a stylesheet and javascript based on jQuery.  To add both to your Rails project, 
+  simply type "drsetup" from the project root.  This will add:
 
-    .my_class_name .report_title {}
-    .my_class_name .report_subtitle {}
-    .my_class_name table tr th {}
-    .my_class_name table tr td {}
-    .my_class_name .report_charts {}        // all charts are displayed within this div
-    .my_class_name .report_chart {}         // represents an individual chart
+  public/stylesheets/dynamic_reports.css  (controls style of dynamic reports)
+  public/javascripts/dynamic_reports.js   (controls display of subreports)
 
-== Rails Usage
+  You can then modify these files as you see fit.
   
   Inside the initializer block in config/environment.rb 
 
@@ -179,7 +237,7 @@
 == Thanks To
 
   * Daniel Neighman
-  * Kenneth Kalmer (And his friend :))
+  * Kenneth Kalmer & Nic Young
   * Yehuda Katz
 
   For their encouragement, feedback and advise.

data/README.rdoc

@@ -0,0 +1,247 @@
+= Dynamic Reports
+
+  A dynamic reporting engine for Ruby / Rails
+  
+== Reports
+  
+  The dynamic reports gem was created to fill a HUGE hole that we felt existed in the 
+  Ruby community - the ability to QUICKLY create stylized admin reports and charts for 
+  people to use to view key metrics and data. 
+
+  Sample uses include the ability to quickly display sales data if your an eShop, our 
+  site metrics if you are recording your own site visits, or user feedback if you are storing 
+  feedback in a model somewhere.
+
+  Basically, with DR you can create a stylized table of ANY information found in a model 
+  (kind of like looking at the grid output from a GUI query analyzer) as well as add Google 
+  Charts API powered line, pie, bar or column charts of any numeric data.  All this can 
+  be done by simply creating a report definition and feeding it your data.
+
+  While this library is usable in any Ruby application it was made mainly with Rails in mind.
+  Suppose we have an online store and we wish to add reporting to the admin area quickly and easily.
+  First we define a report in app/reports/orders_report.rb, something like:
+  
+    class OrdersReport < DynamicReports::Report
+      title "Orders Report"
+      subtitle "All orders recorded in database"
+      columns :total, :created_at
+    end
+  
+  Then in our admin/reports controller (this can be any controller) we define an action to deliver the report:
+  
+    def orders
+      @orders = Order.find(:all, :limit => 25)
+      render :text => OrdersReport.on(@orders).to_html, :layout => "application"
+    end
+    
+  This will render an html table containing some basic styling and containing the columns 'total' and 'created_at' from the order objects.
+  Note that the report Title will be "Orders Report" and it's name will be :orders_report
+  Report#on expects that it receives an object that responds to #each and
+  That each object that it iterates over is either a
+    * An object
+    * A Hash
+  that responds to a method / has keys for each column defined within the report.
+ 
+
+  Templating engines may also be specified, currently :erb and :haml are supported (we will soon be adding :csv and :pdf) like so:
+
+      render :text => OrdersReport.on(@orders).to_html(:engine => :haml), :layout => "application"
+
+  Note that erb is the default templating engine since it is available by default in Ruby.
+
+  Now let us extend our report definition to specify a template to use!
+
+    class OrdersReport < DynamicReports::Report
+      title "Orders Report"
+      subtitle "All orders recorded in database"
+      columns :total, :created_at
+
+      template :my_custom_template
+    end
+
+  This will look in app/views/reports/ for a template named "my_custom_template.html.erb" by default.
+  If you specify :engine => :haml then it will look for "my_custom_template.html.haml"
+
+  If you happen to have your report templates in a different location you can specify this as follows:
+
+    class OrdersReport < DynamicReports::Report
+       title "Orders Report"
+      subtitle "All orders recorded in database"
+      columns :total, :created_at
+
+      template :my_custom_template
+      views "app/views/admin/reports/"
+    end
+  
+  And DynamicReports will look for the specified template in app/views/reports as well as app/views/admin/reports.
+
+  It is also worth pointing out that you can have as many dynamic reports in a view as you wish, simply include
+  each report render where desired within the view.
+
+== Charts
+  
+  Charts can be defined on a report easily. Let's say we wish to chart the total versus the item quantity sold for our Orders Report exmaple:
+
+    class OrdersReport < DynamicReports::Report
+      title "Orders Report"
+      subtitle "All orders recorded in database"
+      columns :total, :created_at
+
+      chart :total_vs_quantity do
+        columns :total, :quantity
+        label_column "created_at"
+      end
+    end
+
+  This will render a *line* chart by default displaying the columns total and quantity.
+  Chart types may be specified easily:
+  
+        type :bar
+  
+  Available chart types are:
+
+    * :line (default)
+    * :bar
+    * :pie
+
+  Since DynamicReport's charts utilize the Google Chart API, you can easily extend each chart by passing a hash of chart options as part
+  of the block.  The options are appended onto the request to the API so they should follow the Google's API commands (http://code.google.com/apis/chart/)
+
+  For example, to add min, max and average labels to the example chart, you would do something like this:
+
+    chart :total_vs_quantity, {:chxt => "r", :chxl => "0:|min|average|max"} do
+        columns :total, :quantity
+        label_column "created_at"
+    end
+
+== External Links
+
+  Dynamic Reports supports linking from any column within your table.  To add a link to a column, add the following 
+  to a report definition:
+  
+  link :column, url
+  
+  For example:
+  
+  class OrdersReport < DynamicReports::Report
+    title "Orders Report"
+    subtitle "All orders recorded in database"
+    columns :total, :created_at
+    
+    link :total, '/report/daily_sales'
+  end
+  
+  You can also pass parameters to the URL based on values from the underlying model.  To pass a parameter, surround the 
+  field name with {}.  The parameter does NOT need to be a displayed, column.  For example, you might want to pass 
+  an external link an ID column but not display this column on the table.  
+  
+  For example:
+  
+  class OrdersReport < DynamicReports::Report
+    title "Orders Report"
+    subtitle "All orders recorded in database"
+    columns :total, :created_at
+    
+    link :total, '/report/item_sales?id={id}'   # =>  Will substitute ID for the value of ID associated with that record
+  end
+  
+  
+== Subreports
+
+  Dynamic Reports supports the display of a sub-report within any report.  This is accomplished using the jQuery library 
+  available at http://www.jquery.com.  
+  
+  Sub-reports are created using the same definition format that you would use to create a standard report.  The only 
+  difference is that it is displayed INLINE when an associated link is clicked.  
+  
+  A sub-report is defined using the same format as a LINK above, but is labeled as:
+  
+  subreport :column, url
+  
+  For example, if you wanted to show all sales and allow a user to click on a specific item to see all historic sales 
+  inline for just that item, you would do the following:
+  
+  IN CONTROLLER:
+  
+  def orders
+    @orders = Order.find(:all, :limit => 25)
+    render :text => OrdersReport.on(@orders).to_html, :layout => "application"
+  end
+  
+  def item_sales
+    @item_orders = Order.find_by_id(params[:id])
+    render :text => ItemSales.on(@orders).to_html, :layout => "application"
+  end
+  
+  REPORT DEFINITIONS
+  
+  class OrdersReport < DynamicReports::Report
+    title "Orders Report"
+    subtitle "All orders recorded in database"
+    columns :total, :created_at
+    
+    subreport :total, '/report/item_sales?id={id}'   # =>  Will substitute ID for the value of ID associated with that record
+  end
+  
+  class ItemSales < DynamicReports::Report
+    columns :item, :price, :created_at
+  end
+  
+  Subreports can also be nested.
+  
+== Rails Usage
+
+  The gem includes a stylesheet and javascript based on jQuery.  To add both to your Rails project, 
+  simply type "drsetup" from the project root.  This will add:
+
+  public/stylesheets/dynamic_reports.css  (controls style of dynamic reports)
+  public/javascripts/dynamic_reports.js   (controls display of subreports)
+
+  You can then modify these files as you see fit.
+  
+  Inside the initializer block in config/environment.rb 
+
+    config.gem "dynamic_reports"
+
+  Then define your reports (as exampled above) in app/reports/*_report.rb
+  If you would like to customize the default report simply create your report templates 
+  within app/views/reports/*_report.<content-type>.<engine>.
+
+  Two Rails features that we are currently working on are:
+
+    * generator
+    * render extensions
+
+== Optional Dependencies
+
+  We are currently examining solutions for csv, pdf and charting.
+
+    * Fastercsv     # csv
+    * Prawn         # pdf
+    * flying saucer # html => PDF - if jRuby available
+    * amcharts      # Charting, note that default is built in google charts.
+
+  These will be defined/implemented using DynamicReports plugin API (not implemented yet)
+  Which allows for user defined plugins of arbitrary types beyond html,csv,pdf,xml
+
+== Contact / Feedback
+
+  If you have any suggestions on improvement please send us an email.
+
+== Authors (alphabetically)
+
+  Joshua Lippiner (jlippiner@gmail.com)
+
+  Wayne E. Seguin (wayneeseguin@gmail.com, irc: wayneeseguin)
+
+== Thanks To
+
+  * Daniel Neighman
+  * Kenneth Kalmer & Nic Young
+  * Yehuda Katz
+
+  For their encouragement, feedback and advise.
+
+== Source
+  http://github.com/wayneeseguin/dynamic_reports
+

data/dynamic_reports.gemspec

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dynamic_reports}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Wayne E. Seguin", "Joshua Lippiner"]
+  s.date = %q{2009-07-01}
+  s.description = %q{Dynamic Ruby Reporting Engine with support for Charts.}
+  s.email = %q{wayneeseguin@gmail.com, jlippiner@gmail.com}
+  s.extra_rdoc_files = [
+    "README",
+     "README.rdoc"
+  ]
+  s.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"
+  ]
+  s.homepage = %q{http://dynamicreports.rubyforge.org/}
+  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{dynamicreports}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Dynamic Ruby Reporting Engine with support for Charts}
+  s.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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/dynamic_reports.rb

@@ -22,7 +22,14 @@ require "dynamic_reports/vendor/google_chart"
 # require "dynamic_reports/rails"
 # For now placing the code right here:
 if defined?(Rails)
-  # Load all defined reports. 
+  # ath_to_lib = File.join(Rails.root, "app")    #adjust if necessary
+  #   path_to_tree = "#{path_to_lib}/reports"
+  #   Dir["#{path_to_tree}/**/*.rb"].each { |fn|
+  #     fn =~ /^#{Regexp.escape(path_to_lib)}\/(.*)\.rb$/
+  #     require $1
+  #   }
+
+  # 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")
@@ -44,4 +51,3 @@ if defined?(Rails)
 
   # TODO: Generator
 end
-

data/lib/dynamic_reports/reports.rb

@@ -8,7 +8,7 @@ module DynamicReports
   class Report
     @@default_engine = "erb"
 
-    attr_accessor :name, :title, :sub_title, :columns, :charts, :records, :template, :class_name, :styles
+    attr_accessor :name, :title, :sub_title, :columns, :charts, :records, :template, :class_name, :styles, :links
 
     # views accessor, array of view paths.
     def views
@@ -24,7 +24,13 @@ module DynamicReports
       # Views setter and accessor.
       def views(*array)
         @views ||= ["#{File::dirname(File::expand_path(__FILE__))}/views/"]
-        array ? @views += array : @views
+        unless array.empty?
+          @views.unshift(array)
+          @views.flatten!
+          @views.uniq!
+        else
+          @views
+        end
       end
      
       # class level options accessor
@@ -100,7 +106,11 @@ module DynamicReports
       #   OrdersReport.template # => :orders
       #
       def template(value = nil)
-        value ? options[:template] = value : options[:template]
+        if value
+          @template = value
+          options[:template] = @template
+        end
+        @template ||= nil
       end
 
       # Accessor for columns
@@ -160,6 +170,50 @@ module DynamicReports
         chart_options = chart_options.shift || {}
         charts(Chart.configure(name, chart_options, &block))
       end
+      
+      # Return an array of links defined for the report.
+      def links(object=nil)
+        options[:links] ||= []
+        options[:links] << object if object
+        options[:links]
+      end
+      
+      # Define a link for the report
+      #
+      # Pass parameters within {}.  Parameters are replaced with the row values 
+      # from passed records.  You do NOT need to include a parameter value as a 
+      # report column for it to be used in a link. For example, you might 
+      # want to generate a link with an ID field in it but not display that id 
+      # in the actual report.  Just include {id} to do this.
+      #
+      # Example:
+      #
+      # link :visits, '/reports/{visit}/details?date={recorded_at}'
+      #
+      def link(column, url, link_options=nil)
+        links({:column => column, :url => url, :link_options => link_options})
+      end
+      
+      # Define an inline subreport for the report
+      #
+      # Pass parameters within {}.  Parameters are replaced with the row values 
+      # from passed records.  You do NOT need to include a parameter value as a 
+      # report column for it to be used in a link. For example, you might 
+      # want to generate a subreport with an ID field in it but not display that id 
+      # in the actual report.  Just include {id} to do this.
+      #
+      # Example:
+      #
+      # subreport :visits, '/reports/{visit}/details?date={recorded_at}'
+      #
+      # The subreport should be created using the same report definition style 
+      # that you use for any other report.  
+      # 
+      def subreport(column, url, link_options=nil)
+        link_options ||= {}
+        link_options.merge!({:class => 'sub_report_link'}) 
+        links({:column => column, :url => url, :link_options => link_options})
+      end
 
       # Method for instanciating a report instance on a set of given records.
       #
@@ -177,14 +231,6 @@ module DynamicReports
       def on(records)
         new(records, @options)
       end
-
-      #--
-      # Methods for definining a sub report
-      #def link_column
-      #end
-      #def link_rows
-      #end
-
     end
 
     # Instantiate the report on a set of records.
@@ -201,10 +247,15 @@ module DynamicReports
     def initialize(records, *new_options)
       new_options  = new_options.shift || {}
       @records = records
-      @views = []
-      @views << new_options.delete(:views) if new_options[:views]
-      @views += self.class.views
+
+      @views = self.class.views
+      @views.unshift(new_options.delete(:views)) if new_options[:views]
+      @views.flatten!
+      @views.uniq!
+
+      @template = self.class.template
       @template = new_options.delete(:template) if new_options[:template]
+
       @options = self.class.options.merge!(new_options)
       @options.each_pair do |key,value|
         if key == "chart"
@@ -233,6 +284,7 @@ module DynamicReports
       options = (options.shift || {}).merge!(@options || {})
       # todo: if rails is loaded set the default engine: dynamicreports::report.default_engine
       engine  = options.delete(:engine) || @@default_engine
+      options[:template] = self.class.template
       view.__send__("#{engine}", options)
     end
 

data/lib/dynamic_reports/templates.rb

@@ -32,7 +32,7 @@ module DynamicReports
 
     # TODO: Add Report Helpers for injection
     def titleize(object)
-      object.to_s.split('_').each{ |word| word.capitalize! }.join(' ') 
+      object.to_s.split('_').each{ |word| word.capitalize! }.join(' ')
     end
 
     def commify(object)
@@ -43,9 +43,44 @@ module DynamicReports
       end
     end
 
+    def linkcheck(record, column_object)
+      val = ''
+
+      if column_object.is_a?(Hash)
+        if column_object.keys.include?(:column)
+          column = column_object[:column] 
+        else
+          column = column_object.keys.first # => Josh shortcut :)
+        end
+      else
+        column = column_object
+      end
+
+      report.links.each do |link|
+        if link[:column] == column
+          url = link[:url]
+          url.scan(/\{(\w+)\}/).each do |parameter|
+            parameter = parameter.to_s
+            url = url.gsub("{#{parameter}}", CGI::escape(get_record_value(record, parameter.to_sym).to_s))
+          end
+
+          url_attribute_str = []
+          link[:link_options].keys.each do |key|
+            url_attribute_str << "#{key}='#{link[:link_options][key]}'"
+          end if link[:link_options]
+          
+          val = "<a href='#{url}' #{url_attribute_str.join(' ')}>#{get_record_value(record,column)}</a>"
+          break
+        end if link[:column]
+      end if report.links
+
+      val.blank? ? get_record_value(record,column) : val
+    end
+
+
     def chart_url(chart,report)
       columns = chart.columns ? chart.columns : report.columns
-      chart_type = chart.type.nil? ?  :line : chart.type.to_sym 
+      chart_type = chart.type.nil? ?  :line : chart.type.to_sym
       case chart_type
       when :line
         Charts.line_chart(chart,columns,report)
@@ -62,7 +97,7 @@ module DynamicReports
     end
 
     private
-    
+
     def render(engine, template, options={}, locals={})
       # merge app-level options
       options = self.class.send(engine).merge(options) if self.class.respond_to?(engine)
@@ -74,7 +109,7 @@ module DynamicReports
       content_type = options.delete(:content_type)
       locals = options.delete(:locals) || locals || {}
       locals.merge!(:report => @report, :options => options || {})
-      
+
       # render template
       data, options[:filename], options[:line] = lookup_template(engine, template, views, content_type)
       output = __send__("render_#{engine}", template, data, options, locals)
@@ -101,7 +136,7 @@ module DynamicReports
           lookup_template(engine, cached[:template], views, content_type, cached[:filename], cached[:line])
         else
           filename = "#{template}.#{content_type}.#{engine}"
-          dir = views.to_a.detect do |view| 
+          dir = views.to_a.detect do |view|
             ::File.exists?(::File.join(view, filename))
           end
           if dir
@@ -172,7 +207,15 @@ module DynamicReports
       require engine.downcase
     end
 
- 
-    
+     def get_record_value(record, column)
+        if record.is_a?(Hash)
+          record[column]
+        elsif record.respond_to?(column.to_sym)
+          record.send(column.to_sym)
+        else
+          column
+        end
+      end
+
   end
 end

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

@@ -1,34 +1,3 @@
-<% 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_subtitle {
-      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_subtitle'>#{report.sub_title}</div>" if report.sub_title %>
@@ -36,38 +5,38 @@
     <thead class="report_header">
       <tr class="report_header_row">
         <% report.columns.each do |column| %>
-          <th>
-            <%= options[:titleize] ? titleize(column) : column %>
-          </th>
+        <th>
+          <% if column.is_a?(Hash) %>
+          <% if column.keys.include?(:heading) %>
+          <%= options[:titleize] ? titleize(column[:heading]) : column[:heading] %>
+          <% else %>
+          <%= options[:titleize] ? titleize(column.values.first) : column.values.first  %>
+          <% end %>
+          <% else %>
+          <%= options[:titleize] ? titleize(column) : column %>
+          <% end %>
+        </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>
+      <tr class="report_row">
+        <% report.columns.each do |column| %>
+        <td>
+          <%= (options[:commas] == true) ? commify(linkcheck(record,column)) : linkcheck(record,column) %>
+        </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>
+    <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

@@ -1,31 +1,3 @@
-- 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_subtitle {
-    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
@@ -40,18 +12,19 @@
       %tr.report_header_row
         - report.columns.each do |column|
           %th
-            = options[:titleize] ? titleize(column) : column
+            - if column.is_a?(Hash) 
+              - if column.keys.include?(:heading)            
+                = options[:titleize] ? titleize(column[:heading]) : column[:heading]
+              -else
+                = options[:titleize] ? titleize(column.values.first) : column.values.first              
+            -else
+              = 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
+              = (options[:commas] == true) ? commify(linkcheck(record,column)) : linkcheck(record,column)
 
   - if report.charts && report.charts.class === Hash
     - report.charts.each_pair do |name, chart|
@@ -59,4 +32,3 @@
         %h2
           = name
         %img{:src => chart_url(chart), :alt => name}
-

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/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/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

@@ -1,33 +1,37 @@
 --- !ruby/object:Gem::Specification 
 name: dynamic_reports
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors: 
-- Wayne E. Seguin & Joshua Lippiner
+- Wayne E. Seguin
+- Joshua Lippiner
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-06-26 00:00:00 -04:00
+date: 2009-07-01 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Dynamic Ruby Reporting Engine with support for Charts
+description: Dynamic Ruby Reporting Engine with support for Charts.
 email: wayneeseguin@gmail.com, jlippiner@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
+- README.rdoc
 files: 
 - HISTORY
 - README
-- gemspec.rb
+- 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
@@ -35,19 +39,19 @@ files:
 - 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/vendor/google_chart.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
-- lib/dynamic_reports/views.rb
-- lib/dynamic_reports.rb
+- README.rdoc
 has_rdoc: true
-homepage: http://github.com/wayneeseguin/direct_reports
+homepage: http://dynamicreports.rubyforge.org/
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -64,10 +68,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: dynamic_reports
-rubygems_version: 1.3.3
+rubyforge_project: dynamicreports
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
-summary: dynamic_reports
-test_files: []
-
+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

data/gemspec.rb

@@ -1,24 +0,0 @@
-require "rubygems"
-
-library="dynamic_reports"
-version="0.0.1"
-
-Gem::Specification::new do |spec|
-  $VERBOSE             = nil
-  spec.name            = library
-  spec.summary         = library
-  spec.version         = version
-  spec.description     = "Dynamic Ruby Reporting Engine with support for Charts"
-  spec.platform        = Gem::Platform::RUBY
-  spec.files           = ["HISTORY", "README", "gemspec.rb", Dir::glob("lib/**/**")].flatten
-  spec.executables     = Dir::glob("bin/*").map{ |script| File::basename script }
-  spec.require_path    = "lib"
-  spec.has_rdoc        = File::exist?("doc")
-  spec.author          = "Wayne E. Seguin & Joshua Lippiner"
-  spec.email           = "wayneeseguin@gmail.com, jlippiner@gmail.com"
-  spec.homepage        = "http://github.com/wayneeseguin/direct_reports"
-  # spec.test_suite_file = "test/#{library}.rb" if File::directory?("test")
-  #spec.add_dependency  "", ">= 0.0"
-  spec.extensions      << "extconf.rb" if File::exists?("extconf.rb")
-  spec.rubyforge_project = library
-end