dynamic_reports 0.0.0 → 0.0.1

data/README

@@ -22,6 +22,8 @@
   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
   
@@ -47,39 +49,47 @@
 
   Note that erb is the default templating engine since it is available by default in Ruby.
 
-  One may also surpress the default rendered styles you may specify that as an option as well:
-
-      render :text => OrdersReport.on(@orders).to_html(:style => false), :layout => "application"
-
   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 :orders_report
+
+      template :my_custom_template
     end
 
-  This will look in app/views/reports/ for a template named "orders_report.html.erb" by default. 
-  If you specify :engine => :haml then it will look for "orders_report.html.haml"
+  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 :orders_report
+
+      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
 
@@ -94,7 +104,40 @@
     * :bar
     * :pie
 
-  Other chart types are planned.
+  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
+
+== 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.
+
+  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
+
+      class_name "my_class_name"
+    end
+
+  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:
+
+    .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
 
 == Rails Usage
   

data/gemspec.rb

@@ -1,7 +1,7 @@
 require "rubygems"
 
 library="dynamic_reports"
-version="0.0.0"
+version="0.0.1"
 
 Gem::Specification::new do |spec|
   $VERBOSE             = nil
@@ -18,7 +18,7 @@ Gem::Specification::new do |spec|
   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  "gchartrb", ">= 0.8"
+  #spec.add_dependency  "", ">= 0.0"
   spec.extensions      << "extconf.rb" if File::exists?("extconf.rb")
   spec.rubyforge_project = library
 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, :style_name, :styles
+    attr_accessor :name, :title, :sub_title, :columns, :charts, :records, :template, :class_name, :styles
 
     # views accessor, array of view paths.
     def views
@@ -79,13 +79,13 @@ module DynamicReports
         options[:styles] ||= false
       end
 
-      def style_name(value = nil)
+      def class_name(value = nil)
         if value
-          options[:style_name] = value
-        elsif options[:style_name].empty?
-          options[:style_name] = self.to_s
+          options[:class_name] = value
+        elsif options[:class_name].empty?
+          options[:class_name] = self.to_s
         else
-          options[:style_name]
+          options[:class_name]
         end
       end
       

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

@@ -1,4 +1,4 @@
-<% if report.style_name.nil? %>
+<% if report.class_name.nil? %>
   <style type="text/css">
     .dynamic_report .report_title {
       font-size:16pt;
@@ -29,7 +29,7 @@
   </style>
 <% end %>
 
-<div id="<%= report.style_name %>" class="dynamic_report">
+<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 %>
   <table class="report" border="0" cellpadding="0" cellspacing="0">

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

@@ -1,4 +1,4 @@
-- if report.styles.nil?
+- if report.class_name.nil?
   %style{type => "text/css"}
     \.dynamic_report .report_title {
     font-size:16pt;
@@ -26,7 +26,7 @@
     margin:15px;
     }
 
-.dynamic_report{ :id => report.style_name }
+.dynamic_report{ :id => report.class_name }
   - if report.title
     %h2.report_title
       = report.title

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dynamic_reports
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
 - Wayne E. Seguin & Joshua Lippiner
@@ -36,7 +36,6 @@ files:
 - 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/default_chart.html.erb
 - lib/dynamic_reports/views/default_layout.html.erb
 - lib/dynamic_reports/views/default_report.html.erb
 - lib/dynamic_reports/views/default_report.html.haml