meta_reports 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27a12febca4612c8f05d6e12f765657f2f6e49c5
-  data.tar.gz: 81d294309e4a203108ce5c29ce0933e05eddbc36
+  metadata.gz: 2db489ddaeda429073c17f55d72bbbaa8c8cdda5
+  data.tar.gz: 72dc2ba6d4bc8d0408e2521190ff11eceb46148e
 SHA512:
-  metadata.gz: 200b4175aece9f9eef2fda927af223aacc38f0f3720e39a5b277e488aaea220c7bf2b5c2d41378edda7a17872d3a84c36bd13bb4887cea7707c1173942c4165a
-  data.tar.gz: 38f42bd8de5d7d93c7c6739338f941a135b5e656eac23ce42a90d495d3734c8871fb7d4941a5c2f5a46af3648201925f921585e41db071e05d07367d1f83b58a
+  metadata.gz: 24af0db7ad1a94e4c8d713979bd86296c4eeb7cdf4773db2aab413cb19e44d63e55353f258e1ac185b1ac93a6c59849e85c65e0a13bc63411fa01a326bd909f3
+  data.tar.gz: 6c5f63fc7c69e6faf7c7b6fd6f12b7d5c5ba92efe7e85ed923b06798f101a0292da82fd66e18881ec583236ef1e90e0be72530c8e95409821c39035a2b1fb26a

data/README.md

@@ -8,7 +8,7 @@
 
 ##Description
 
-**MetaReports** is a [Rails](https://github.com/rails/rails) engine for reports. It provides a common metadata structure that can be exported in any desired format. If your report fits within the metadata convention you do not even need a template. However, it is very easy to create reports specific templates also.
+**MetaReports** provides [Rails](https://github.com/rails/rails) classes and templates for reports. It provides a common metadata structure that can be passed to the desired template format. If your report does not fit within the metadata convention it is very easy to create specific templates.
 
 MetaReports exports to HTML, PDF, and XLSX formats. [More are to come](#todo).
 
@@ -16,26 +16,11 @@ MetaReports exports to HTML, PDF, and XLSX formats. [More are to come](#todo).
 
 ##Provides
 
-- An ActiveRecord and other data models, a controller, and some generic views. 
+- Data models for holding template data.
 - Default views for all formats, that expect a title, subtitle, description, and one or more tables of data.
-- Use css classes for easy styling
+- Provides a [common color mechanism](#colors) to style rows and cells
 
-##Philosophy
-
-###Templates / data structures only
-
-There is a generator that [installs templates only](#install-templates-only). Then you can use the data structures and templates in whatever way you see fit as you write your own controllers / reports.
-
-###Rails engine
-
-The MetaReports engine is avowedly fat model. It is also ActiveRecord based. This could change if a better way makes sense.
-
-- **Fat model:** All reports are class methods in the MetaReports::Report class. This allows one to generate reports in various contexts without creating an instance (e.g. a mailer.) The reports themselves are meant to be pure data without formatting, except for class names, and html cell content if that is needed. 
-- **ActiveRecord:** Right now a database record is required in addition to the class method. So far this is for convenience in listing available reports and handling permissions. Someday, the code for a report might also be stored in a database, or an abstract description of a report with a web based query builder could be implemented. 
-
-###Thoughts on REST
-
-The class names / html content may broken out into helpers or a decorator pattern or something else in the future. It is difficult to think of a useful generic way to specify HTML content (e.g. an HTML link within a paragraph of text) outside of the report method itself. A reports controller already breaks strict REST ideology (where does a report belong that combines 5 models?) and unnecessary work for an ideology does not help create a useful tool.
+*Note:* Before 0.1.0 MetaReports provided an engine that served reports. The engine has been dropped. Look at the rspec/dummy app for one approach to serving reports.
 
 ##Usage
 
@@ -45,59 +30,26 @@ Add meta_reports your Gemfile:
 
 ```ruby
 gem 'meta_reports'
+gem 'prawn-table' # if you are using the latest prawn, table is not included
 ```
 
 Run the `bundle` command to install it.
 
-There are two ways to use MetaReports:
-
-1. Install the templates, partials, helpers, and models only. No ActiveRecord is used.
-2. Install and mount the engine. In addition to the above, you will have a controller,
-additional templates for creating forms, and an ActiveRecord model.
-
-####Install templates only
-
-After installing the gem, run the generator:
+Install the templates:
 
-    rails generate meta_reports:install_templates
+    bundle exec rails generate meta_reports:install_templates
 
-This copies over the meta_reports migration, model, views, and controller: 
+This copies over the meta_reports color model and the templates:
 
-- `app/models/meta_reports/base.rb`: The ActiveRecord base, should you need it
-- `app/models/meta_reports/data.rb`: The MetaReports::Data metadata model. Contains report data.
-- `app/models/meta_reports/table.rb`: The MetaReports::Table model for storing options and table data.
-- `app/models/meta_reports/report.rb`: The MetaReports::Report model for storing colors and, if you wish, report methods.
-- `app/helpers/meta_reports/reports_helper.rb`: MetaReports helper methods.
-- `app/views/meta_reports/reports/templates/*`: All templates.
+- `app/models/meta_reports/color.rb`: The MetaReports::Color model for storing colors.
+- `app/views/meta_reports/*`: All templates.
 
-####Install the engine
-
-After installing the gem, run the generator:
-
-    rails generate meta_reports:install_engine
-
-This copies over the meta_reports migration, model, views, and controller: 
-
-- `db/migrate/<timestamp>_create_meta_reports_reports.rb`
-- `app/models/meta_reports/report.rb`
-- `app/controllers/meta_reports/reports_controller.rb`
-- `app/views/meta_reports/reports/*`
-
-Run the migration:
-
-    rake db:migrate
-
-Add authentication/authorization to the reports controller if desired.
+Now create a data structure using MetaReports::Data and MetaReports::Table, and pass it off to the default templates.
 
 ###Writing a report
 
-- With templates installed:
-  - Use the models and helper methods to create report data. 
-  - Render it using the default templates, or any template of your own.
-- With the engine installed:
-  - Write the data method using a static method in the `app/models/meta_reports/report.rb` model. The method should accept the params hash as its single argument. It should return the data in the form of a MetaReports::Data object or a hash. 
-  - Create a new report record using the reports page. The name must match the data method name.
-  - If not using the default templates, write your own templates.
+- Use the models and helper methods to create report data. 
+- Render it using the default templates, or any template of your own.
 
 ###MetaData
 
@@ -112,6 +64,8 @@ The key component of MetaReports is the metadata format. This allows you to writ
   - **page_orientation:** :landscape or :portrait. Used on PDF and XLSX formats. 
   - **page_margin:** The page margin in pixels (72/inch), in single number or four value array format (top, right, bottom, left.) Used on PDF and XLSX formats. Specify XLSX header/footer margins by specifying a 5th and 6th value respectively.
   - **page_size:** The page size. Used on the PDF format. See the [Prawn documentation](http://prawn.majesticseacreature.com/docs/0.11.1/Prawn/Document/PageGeometry.html).
+  - **tables_blank:** What to display if the report has no tables. Defaults to 'No data found'.
+  - **conclusion:** Text to display below all tables.
 
 - **Table:** A MetaReports::Table instance, which is a thinly wrapped two dimensional array of cells.
   - **options:** The options for the whole table. If you are using a plain array, this hash must be the last item in the table.
@@ -151,11 +105,11 @@ Here is a simple example. See the [example class](spec/dummy/app/models/meta_rep
 
 ###Colors
 
-There is currently an incomplete implementation of shared colors. You will define your colors by name in the MetaReports::Report class in the COLORS hash constant. If a table row or cell contains a corresponding class name it will have that color in HTML and PDF. XLSX support is planned. It is also intended to implement a means of specifying cell text color.
+There is currently an incomplete implementation of shared colors. Define your colors by name in the MetaReports::Color class in the COLORS hash constant. If a table row or cell contains a corresponding class name it will have that color in HTML and PDF. XLSX support is planned. It is also intended to implement a means of specifying cell text color.
 
 #### Declaring Colors
 
-Specify colors using the COLORS hash constnat in your MetaReports::Report class. An example COLORS hash is below:
+Specify colors using the COLORS hash constant in your MetaReports::Report class. An example COLORS hash is below:
 
 ```ruby
 COLORS = {
@@ -185,10 +139,16 @@ Note the row number begins with zero, and excludes the header if enabled.
 
 #### Inline CSS
 
-MetaReports defaults to inline styling for HTML. If you wish to turn this off (and use either your own styles or the export below) set the following:
+MetaReports defaults to inline styling for HTML. You can use the rake task to create a CSS stylesheet with corresponding colors and class names. Each table must have inline_css set to false for this to occur: 
 
 ```ruby
-MetaReports::Base.inline_css = false
+MetaReports::Data.new do |d|
+  d.title = 'Class based row/cell background colors'
+  d.tables["Table 1"] = MetaReports::Table.new do |t|
+    t << %w{One simple row}
+    t.inline_css = false
+  end
+end
 ```
 
 #### Export SCSS / CSS
@@ -239,11 +199,11 @@ To export only the colors file, use the `meta_reports:export_colors_only` Rake t
 - Expand common colors to spreadsheets, and enable coloring of text / individual cells
 - Charts based on table data
 - More formats (e.g. csv, json, text)
-- Direct to email / print (using IPP) / fax
 - Improved metadata conventions
 
 ##Changelog
 
+- **0.1.0:** (09/08/14) Drop engine. Just models / templates. Breaking change if you were using the engine.
 - **0.0.5:** (11/16/13) Simplify color handling, color individual cells
 - **0.0.4:** (10/7/13) Colors rake task
 - **0.0.3:** (10/7/13) Template/model/helper generator
@@ -254,8 +214,6 @@ To export only the colors file, use the `meta_reports:export_colors_only` Rake t
 
 Fork the project on [github](https://github.com/straydogstudio/meta_reports 'straydogstudio / MetaReports on Github'), edit away, and pull.
 
-### Rspec, and generator testing
-
 ##Authors, License and Stuff
 
 Code by [Noel Peden](http://straydogstudio.com) and released under [MIT license](http://www.opensource.org/licenses/mit-license.php).

data/app/models/meta_reports/color.rb

@@ -0,0 +1,16 @@
+class MetaReports::Color
+
+  #
+  # Shared colors. The key is the class name, value is RGB in hex format
+  #
+  # Example: "highlight: 'ffcccc'" is 'tr.highlight {background: #ffcccc}' in CSS, and "$highlight: #ffcccc;"" as a SASS variable.
+  #
+
+  COLORS = {
+    even:                   'efefef',
+    odd:                    'ffffff',
+    yellow:                 ['ffffaa', 'ffffcc', 'f9f9a4', 'f9f9c6'],
+    highlight:          '$yellow_1 !important',
+  }
+
+end

data/{lib/generators/meta_reports/templates/views/templates → app/views/meta_reports}/_default.html.erb

@@ -17,7 +17,7 @@ report = @report if defined?(report).nil?
 	<%
 	table_names = report[:table_order] || report[:tables].keys.sort_by {|k| k.to_s}
 	table_names.each do |table_name| %>
-		<%= render partial: 'meta_reports/reports/templates/default_table', locals: {table_name: table_name, table: report[:tables][table_name]} %>
+		<%= render partial: 'meta_reports/default_table', locals: {table_name: table_name, table: report[:tables][table_name]} %>
 	<% end %>
 <% end %>
 

data/{spec/dummy/app/views/meta_reports/reports/templates → app/views/meta_reports}/_default_table.html.erb

@@ -6,12 +6,12 @@ table_class = table.options[:table_class].to_s if !defined?(table_class) || tabl
 <div class='list_container'>
 <%= content_tag(:table, :class => "table table-condensed #{table_class}") do %>
   <% unless @report[:table_header] == false %>
-    <%= content_tag(:thead, content_tag(:tr, table.to_a.shift.map { |h| html_cell(h, :th)}.join.html_safe ) ) %>
+    <%= content_tag(:thead, content_tag(:tr, table.to_a.shift.map { |h| html_cell(h, tag: :th, inline_css: table.options[:inline_css])}.join.html_safe ) ) %>
   <% end %>
   <tbody>
     <% table.to_a.each_with_index do |row, i|
       style = nil
-      if MetaReports::Base.inline_css && row_classes[i]
+      if table[:inline_css] && row_classes[i]
         color = nil
         row_classes[i].split(/\s+/).each do |token|
           if color = meta_report_color(token)
@@ -24,7 +24,7 @@ table_class = table.options[:table_class].to_s if !defined?(table_class) || tabl
       %>
       <%= content_tag(:tr, class: row_classes[i], style: style) do
         row.each do |cell|
-          %><%= html_cell(cell) %><%
+          %><%= html_cell(cell, inline_css: table.options[:inline_css]) %><%
         end
       end %>
     <% end %>

data/app/views/meta_reports/default.html.erb

@@ -0,0 +1 @@
+<%= render 'meta_reports/default', report: (defined?(report).nil? ? @report : report) %>

data/app/views/meta_reports/default.pdf.prawn

@@ -0,0 +1,37 @@
+@reports ||= [@report]
+@report  ||= @reports.first
+margin = @report[:page_margin] && [*@report[:page_margin]][0,4] || nil
+prawn_document(page_layout: @report[:page_orientation] || :portrait, page_size: @report[:page_size] || 'LETTER', margin: margin) do |pdf|
+
+  @reports.each do |report|
+    unless report == @report
+      margin = report[:page_margin] && [*report[:page_margin]][0,4] || nil
+      pdf.start_new_page layout: report[:page_orientation] || :portrait, size: report[:page_size] || 'LETTER', margin: margin 
+    end
+
+    render :partial => "meta_reports/default_header", :locals => { :pdf => pdf, :title => report[:title], :subtitle => report[:subtitle] }
+    pdf.font_size = report[:font_size] || 8
+    if report[:description]
+      pdf.move_up 5
+      pdf.text strip_tags(report[:description]), align: :center
+      pdf.move_down 15
+    end
+
+    table_names = report[:table_order] || report[:tables].keys.sort_by {|k| k.to_s}
+    table_names.each do |table_name|
+      table = report[:tables][table_name]
+      pdf.pad_bottom(25) do
+        if table[:group]
+          pdf.group do #if the table is larger than a page this will throw an error
+            render :partial => 'meta_reports/default_table', :locals => {:pdf => pdf, :title => table_name, :table => table}
+          end
+        else
+          render :partial => 'meta_reports/default_table', :locals => {:pdf => pdf, :title => table_name, :table => table}
+        end
+      end
+    end
+
+    render partial: "meta_reports/default_footer", locals: { pdf: pdf }
+
+  end #each report
+end #prawn document

data/{lib/generators/meta_reports/templates/views/templates → app/views/meta_reports}/default.xlsx.axlsx

@@ -12,7 +12,7 @@ wb.add_worksheet(name: @report[:title][0,31].gsub(/[:\/]/,'-'), page_margins: co
 	columns = first_table.blank? ? 12 : first_table.first.length
   last_column = to_xls_col(columns)
 
-	render :partial => "meta_reports/reports/templates/default_header", :locals => { :sheet => sheet, :title => @report[:title], :subtitle => @report[:subtitle], :columns => columns, :styles => styles }
+	render :partial => "meta_reports/default_header", :locals => { :sheet => sheet, :title => @report[:title], :subtitle => @report[:subtitle], :columns => columns, :styles => styles }
   if @report[:description]
     sheet.add_row [@report[:description]]
     this_rows = sheet.rows.length

data/lib/generators/meta_reports/install_templates_generator.rb

@@ -9,15 +9,10 @@ module MetaReports
 
       def install_models
         directory "app/models/meta_reports", "app/models/meta_reports"
-        copy_file "lib/generators/meta_reports/templates/models/report_non_activerecord.rb", "app/models/meta_reports/report.rb"
-      end
-
-      def install_helper
-        copy_file "app/helpers/meta_reports/reports_helper.rb", "app/helpers/meta_reports/reports_helper.rb"
       end
 
       def install_views
-        directory "lib/generators/meta_reports/templates/views/templates", "app/views/meta_reports/reports/templates"
+        directory "app/views/meta_reports", "app/views/meta_reports"
       end
     end
   end

data/lib/meta_reports.rb

@@ -1,4 +1,10 @@
-require "meta_reports/engine"
+require 'axlsx_rails'
+require 'prawn_rails'
+require 'meta_reports/data'
+require 'meta_reports/table'
+require 'meta_reports/helper'
 
 module MetaReports
 end
+
+require 'meta_reports/railtie' if defined?(Rails)

data/{app/models → lib}/meta_reports/data.rb

@@ -1,6 +1,7 @@
 class MetaReports::Data
   def initialize
     @hash = {tables: {}}
+    @id = rand(10000)
     yield self if block_given?
     self
   end
@@ -24,10 +25,18 @@ class MetaReports::Data
     @hash[key] = value
   end
 
+  def id
+    @hash[:id] || @hash[:title].to_s.downcase.gsub(/[^a-z]/,'_') || @id
+  end
+
   def tables
     @hash[:tables]
   end
 
+  def tables=(value)
+    @hash[:tables] = value
+  end
+
   def to_h
     @hash
   end

data/{app/helpers/meta_reports/reports_helper.rb → lib/meta_reports/helper.rb}

@@ -3,7 +3,6 @@ module MetaReports
     def meta_report_color(klass, row = 0)
       @meta_reports_colors ||= {}
       @meta_reports_colors[klass.to_sym] ||= begin
-        Rails.logger.info "getting color"
         color = MetaReports::Report::COLORS[klass.to_sym]
         return nil unless color
         if color.is_a? Array
@@ -33,11 +32,13 @@ module MetaReports
       page_margins
     end
 
-    def html_cell(cell, tag = :td)
+    def html_cell(cell, options = {})
+      tag = options[:tag] || :td
+      options[:inline_css].nil? && options[:inline_css] = true
       if cell.is_a? Hash
         tags = cell.reject {|k,v| k == :content || k == :html}
-        tags[:class] ||= 'textcenter'
-        if MetaReports::Base.inline_css
+        tags[:class] ||= options[:default_class]
+        if options[:inline_css]
           color = nil
           tags[:class].split(/\s+/).each do |token|
             if color = meta_report_color(token)
@@ -49,7 +50,7 @@ module MetaReports
         content_tag tag, (cell[:html] || cell[:content]).to_s.html_safe, tags
       elsif cell.is_a? Array
       else
-        content_tag tag, cell, :class => 'textcenter'
+        content_tag(tag, cell, :class => options[:default_class])
       end
     end
 
@@ -143,7 +144,7 @@ module MetaReports
         end
       else
         content_tag :span do
-         link_to title, meta_reports.short_form_path(report)
+         link_to title, report
         end
       end
     end

data/lib/meta_reports/railtie.rb

@@ -0,0 +1,7 @@
+module MetaReports
+  class Railtie < Rails::Railtie
+    initializer "meta_reports.view_helpers" do
+      ActionView::Base.send :include, ReportsHelper
+    end
+  end
+end

data/{app/models → lib}/meta_reports/table.rb

@@ -72,6 +72,10 @@ class MetaReports::Table
     @data
   end
 
+  def data=(value)
+    @data = value
+  end
+
   def unshift(val)
     @data.unshift(val)
   end

data/lib/meta_reports/version.rb

@@ -1,3 +1,3 @@
 module MetaReports
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/lib/tasks/meta_reports_tasks.rake

@@ -17,7 +17,7 @@ namespace :meta_reports do
     FileUtils.mkdir_p "app/assets/stylesheets/lib"
     File.open("app/assets/stylesheets/lib/metareports_color_variables.scss", "w") do |f| 
       printfl "\tVariables: "
-      MetaReports::Report::COLORS.each do |klass, value|
+      MetaReports::Color::COLORS.each do |klass, value|
         printfl "."
         klass = klass.to_s
         if value.is_a? Array
@@ -38,7 +38,7 @@ namespace :meta_reports do
     File.open("app/assets/stylesheets/lib/metareports_colors.scss", "w") do |f|
       f.puts "@import 'metareports_color_variables.scss';"
       print "\tCSS classes: "
-      MetaReports::Report::COLORS.each do |klass, color|
+      MetaReports::Color::COLORS.each do |klass, color|
         printfl "."
         #for now, colors are simply row colors
         #css_klass = klass.to_s.gsub(/___/,' ').gsub(/__/,'#').gsub(/_/,'.').gsub(/--/,':')

data/spec/ci.sh

@@ -1,2 +1,2 @@
 #!/usr/bin/env sh
-cd spec/dummy && bundle install --without debug && bundle exec rake db:create && bundle exec rake db:migrate && cd ../../ && bundle exec rspec spec
+cd spec/dummy && echo "bundle install" && bundle install --without debug && echo "rake db:create" && bundle exec rake db:create && echo "rake db:migrate" && bundle exec rake db:migrate && rm -rf app/models/meta_reports/color.rb app/views/meta_reports && bundle exec rails g meta_reports:install_templates && cd ../../ && echo "rspec spec" && bundle exec rspec spec