VERSION bin/drsetup dynamic_reports-0.0.2.gem dynamic_reports-0.0.3.gem dynamic_reports.gemspec lib/dynamic_reports/resources/dynamic_reports.css lib/dynamic_reports/resources/dynamic_reports.js @@ -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 README.rdoc dynamic_reports-0.0.0.gem @@ -183,6 +183,12 @@ module DynamicReports def link(column, url, link_options=nil) links({:column => column, :url => url, :link_options => link_options}) end + + 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. # @@ -200,14 +206,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. lib/dynamic_reports/reports.rb @@ -47,7 +47,11 @@ module DynamicReports val = '' if column_object.is_a?(Hash) - column = column_object[:column] + if column_object.keys.include?(:column) + column = column_object[:column] + else + column = column_object.keys.first # => Josh shortcut :) + end else column = column_object end @@ -73,15 +77,6 @@ module DynamicReports val.blank? ? get_record_value(record,column) : val 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 def chart_url(chart,report) columns = chart.columns ? chart.columns : report.columns @@ -212,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 lib/dynamic_reports/templates.rb @@ -1,51 +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 .subreport_row td { - padding: 10px 10px 10px 20px; - background-color: #FFFFCC; - font-size: 95%; -} -.dynamic_report .subreport table tr td { - border: 1px dotted #CCCC99; - padding:3px 5px; - background-color: white; -} -.dynamic_report .subreport table tr th { - color: black; - background: #CCCCCC; - padding:3px; -} - -</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 %> @@ -58,7 +10,7 @@ <% if column.keys.include?(:heading) %> <%= options[:titleize] ? titleize(column[:heading]) : column[:heading] %> <% else %> - <%= options[:titleize] ? titleize(column[:column]) : column[:column] %> + <%= options[:titleize] ? titleize(column.values.first) : column.values.first %> <% end %> <% else %> <%= options[:titleize] ? titleize(column) : column %> @@ -87,5 +39,4 @@ </span> <% end %> </div> - </div> lib/dynamic_reports/views/default_report.html.erb @@ -1,46 +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: #666666; - padding:5px; - } - \.dynamic_report table tr td { - border: 1px solid #333333; - padding:3px 15px; - } - \.dynamic_report .report_charts { - width:100%; - } - \.dynamic_report .report_chart { - margin:15px; - } - \.dynamic_report .subreport_row td { - padding: 10px 10px 10px 20px; - background-color: #FFFFCC; - font-size: 95%; - } - \.dynamic_report .subreport table tr td { - border: 1px dotted #CCCC99; - padding:3px 5px; - background-color: white; - } - \.dynamic_report .subreport table tr th { - color: black; - background: #CCCCCC; - padding:3px; - } - .dynamic_report{ :id => report.class_name } - if report.title %h2.report_title @@ -59,7 +16,7 @@ - if column.keys.include?(:heading) = options[:titleize] ? titleize(column[:heading]) : column[:heading] -else - = options[:titleize] ? titleize(column[:column]) : column[:column] + = options[:titleize] ? titleize(column.values.first) : column.values.first -else = options[:titleize] ? titleize(column) : column %tbody.report_body lib/dynamic_reports/views/default_report.html.haml e5c369457c621911c717f12fdc4d984ca174b9a8 Joshua Lippiner jlippiner@joshua-lippiners-macbook-pro.local http://github.com/wayneeseguin/dynamic_reports/commit/35a07ccca4ecd56f42f1de223dabea1a684ce7d6 35a07ccca4ecd56f42f1de223dabea1a684ce7d6 2009-07-16T06:53:41-07:00 2009-07-16T06:53:41-07:00 Made styles and js resources. Created drsetup executable. Added heading shortcut af10cbdbbb6025c84c2b019886f1329033569bbd Joshua Lippiner jlippiner@joshua-lippiners-macbook-pro.local