wayneeseguin-dynamic_reports 0.0.3 → 0.0.4

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

@@ -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/dynamic_reports.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dynamic_reports}
-  s.version = "0.0.3"
+  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"]

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
@@ -170,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.
       #
@@ -187,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.

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,73 +1,42 @@
-<% 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 %>
+  <%= "<div class='report_subtitle'>#{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>
+        <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_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
@@ -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}
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wayneeseguin-dynamic_reports
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Wayne E. Seguin
@@ -46,6 +46,7 @@ files:
 - README.rdoc
 has_rdoc: false
 homepage: http://dynamicreports.rubyforge.org/
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --inline-source
@@ -67,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dynamicreports
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Dynamic Ruby Reporting Engine with support for Charts