dynamic_reports-0.0.0.gem examples/rails/all_visitors_report.rb examples/rails/sales_report.rb.rb examples/rails/sample_controller.rb.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 - lib/dynamic_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 @@ -160,6 +160,29 @@ 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 # Method for instanciating a report instance on a set of given records. # lib/dynamic_reports/reports.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,49 @@ module DynamicReports end end + def linkcheck(record, column_object) + val = '' + + if column_object.is_a?(Hash) + column = column_object[:column] + 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 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 - 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 +102,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 +114,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 +141,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 +212,7 @@ module DynamicReports require engine.downcase end - - + + end end lib/dynamic_reports/templates.rb @@ -1,73 +1,91 @@ <% 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%; - } +<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> +.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 %> - <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 %> +<%= "<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"> +<thead class="report_header"> +<tr class="report_header_row"> +<% report.columns.each do |column| %> + <th> + <% if column.is_a?(Hash) %> + <% if column.keys.include?(:heading) %> + <%= options[:titleize] ? titleize(column[:heading]) : column[:heading] %> + <% else %> + <%= options[:titleize] ? titleize(column[:column]) : column[:column] %> + <% 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> + <%= (options[:commas] == true) ? commify(linkcheck(record,column)) : linkcheck(record,column) %> + </td> + <% 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> + </tbody> + </table> - <div class="report_charts"> - <% report.charts.to_a.each do |chart| %> - <span class="report_chart"> + <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> + </span> + <% end %> + </div> + </div> lib/dynamic_reports/views/default_report.html.erb @@ -12,11 +12,11 @@ } \.dynamic_report table tr th { color: white; - background: gray; + background: #666666; padding:5px; } \.dynamic_report table tr td { - border: 1px solid black; + border: 1px solid #333333; padding:3px 15px; } \.dynamic_report .report_charts { @@ -25,6 +25,21 @@ \.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 @@ -40,18 +55,20 @@ %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[:column]) : column[:column] + -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| lib/dynamic_reports/views/default_report.html.haml e5602c948098300993aed787da791a616541e750 e5c369457c621911c717f12fdc4d984ca174b9a8 Wayne E. Seguin wayneeseguin@gmail.com http://github.com/wayneeseguin/dynamic_reports/commit/1b4cf33adf3bac68919c76b9cbb4961b681941a7 1b4cf33adf3bac68919c76b9cbb4961b681941a7 2009-07-16T07:33:35-07:00 2009-07-16T07:33:35-07:00 Merge conflict resolution. 881f536e367ab1ad7043dce470a90fc60e1aebdf Wayne E. Seguin wayneeseguin@gmail.com