meta_reports 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 444a74c33cfc1decb3b4d7876b1238a1428169da
-  data.tar.gz: 34dfb23512870e57cd31ff9f95adb9ea66527730
+  metadata.gz: 27a12febca4612c8f05d6e12f765657f2f6e49c5
+  data.tar.gz: 81d294309e4a203108ce5c29ce0933e05eddbc36
 SHA512:
-  metadata.gz: 706f15ea4d6287cae130aa6a83e0c919622c452253ff82b6f4e11a3f37bff1ae9639c18f31b26ec6ffd0edaae3f52c20dd3e4f05b442dccb4fb4f265a6a50076
-  data.tar.gz: 80318f873898149a3eb90f42ca6347fc71a4d2230691d93408555b7a99d156135656c83487c0122c3d0ca3410c916c8f9c5f7a3bf94683ccc8cf8bc41f25036a
+  metadata.gz: 200b4175aece9f9eef2fda927af223aacc38f0f3720e39a5b277e488aaea220c7bf2b5c2d41378edda7a17872d3a84c36bd13bb4887cea7707c1173942c4165a
+  data.tar.gz: 38f42bd8de5d7d93c7c6739338f941a135b5e656eac23ce42a90d495d3734c8871fb7d4941a5c2f5a46af3648201925f921585e41db071e05d07367d1f83b58a

data/README.md

@@ -117,6 +117,7 @@ The key component of MetaReports is the metadata format. This allows you to writ
   - **options:** The options for the whole table. If you are using a plain array, this hash must be the last item in the table.
     - **column_widths:** Column widths hash, used only on Prawn PDF output. 
     - **font_size:** Font size for content. Used on PDF and XLSX output.
+    - **group:** Group the header and table together on one page. This will throw an error if it cannot be fit on one page.
     - **row_classes:** A hash with keys specifying row number (0 first), and values being a string of classes. 
     - **table_header:** Defaults to true. First row in the table is a header row. Causes the row to be repeated on Prawn PDF tables if it breaks to another page.
 
@@ -150,59 +151,82 @@ 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 contains a corresponding class name it will have that color in HTML, PDF, and XLSX format. Currently it is only applied in the PDF and HTML formats. It is also intended to implement a means of specifying cell background and text color.
+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.
 
-An example COLORS hash is below:
+#### Declaring Colors
+
+Specify colors using the COLORS hash constnat in your MetaReports::Report class. An example COLORS hash is below:
 
 ```ruby
 COLORS = {
-  _even:                   'efefef',
-  _odd:                    'ffffff',
-  _yellow:                 ['ffffaa', 'ffffcc', 'f9f9a4', 'f9f9c6'],
-  tr____highlight:         '$_yellow_1 !important',
-  'a--hover' =>            ['ffcccc', 'ffc5c5']
+  even:                   'efefef',
+  odd:                    'ffffff',
+  yellow:                 ['ffffaa', 'ffffcc', 'f9f9a4', 'f9f9c6'],
+  highlight:              '$yellow_1 !important',
+  hover:                  ['ffcccc', 'ffc5c5']
 }
 ```
 
+#### Specifying colors for rows or cells
+
+To specify a color for a cell, use a hash and specify the color name in the class:
+
+```ruby
+table << [{content: "Colored cell", class: 'yellow'}]
+```
+
+To specify a color for a row, store the row's color in the table row_classes hash:
+
+```ruby
+table.row_classes[row] = 'yellow'
+```
+
+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:
+
+```ruby
+MetaReports::Base.inline_css = false
+```
+
+#### Export SCSS / CSS
+
 When you run `rake meta_reports:export_colors` task it exports two SCSS files, one including HTML styles, the other including SCSS variables (for your use in other files.) The export uses the following conventions:
 
 - The corresponding SASS variable will be named the same as the key (with $ prepended of course). If the value is an array, the variable names will be the class name plus a numerical suffix for each entry.
-- The corresponding CSS entry will use these conversions:
-  - '___' will be converted to to a space
-  - '__'  will be converted to a hash (id indicator)
-  - '_'   will be converted to a period (class indicator)
-  - '--'  (double dash) will be converted to to a colon (pseudo class)
+- The corresponding CSS entry will:
+  - be prefixed with 'tr.' to match table rows
   - arrays of values will be converted into nth-child rules to color consecutive rows
 
-This means '____' will be converted to a space and period (' .'), '_____' to ' #', and 'a--first-child' will become 'a:first-child'.
-
 Given the above example the generated `lib/metareports_color_variables.scss` SASS file will be:
 
 ```scss
-$_even: #efefef;
-$_odd: #ffffff;
-$_yellow_0: #ffffaa;
-$_yellow_1: #ffffcc;
-$_yellow_2: #f9f9a4;
-$_yellow_3: #f9f9c6;
-$tr____highlight: $_yellow_1;
-$a--hover_0: #ffcccc;
-$a--hover_1: #ffc5c5;
+$even: #efefef;
+$odd: #ffffff;
+$yellow_0: #ffffaa;
+$yellow_1: #ffffcc;
+$yellow_2: #f9f9a4;
+$yellow_3: #f9f9c6;
+$highlight: $_yellow_1;
+$hover_0: #ffcccc;
+$hover_1: #ffc5c5;
 ```
 
 And the generated `assets/stylesheets/lib/metareports_colors.scss` SASS file would be:
 
 ```scss
 @import 'metareports_color_variables.scss';
-.even { background: $_even; }
-.odd { background: $_odd; }
-.yellow:nth-child(4n+0) { background: $_yellow_0; }
-.yellow:nth-child(4n+1) { background: $_yellow_1; }
-.yellow:nth-child(4n+2) { background: $_yellow_2; }
-.yellow:nth-child(4n+3) { background: $_yellow_3; }
-tr .highlight { background: $_yellow_1 !important; }
-a:hover:nth-child(2n+0) { background: $a--hover_0; }
-a:hover:nth-child(2n+1) { background: $a--hover_1; }
+tr.even { background: $even; }
+tr.odd { background: $odd; }
+tr.yellow:nth-child(4n+0) { background: $yellow_0; }
+tr.yellow:nth-child(4n+1) { background: $yellow_1; }
+tr.yellow:nth-child(4n+2) { background: $yellow_2; }
+tr.yellow:nth-child(4n+3) { background: $yellow_3; }
+tr.highlight { background: $yellow_1 !important; }
+tr.hover:nth-child(2n+0) { background: $hover_0; }
+tr.hover:nth-child(2n+1) { background: $hover_1; }
 ```
 
 Note that you can specify `!important` and it will be reproduced in the CSS style.
@@ -212,7 +236,7 @@ To export only the colors file, use the `meta_reports:export_colors_only` Rake t
 
 ##TODO
 
-- Common colors: This needs a common color mechanism, where all outputs that support color can have the same row / cell / text color. Any input on this is appreciated.
+- 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
@@ -220,6 +244,7 @@ To export only the colors file, use the `meta_reports:export_colors_only` Rake t
 
 ##Changelog
 
+- **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
 - **0.0.2:** (9/29/13) Relax rails requirement, better testing

data/app/helpers/meta_reports/reports_helper.rb

@@ -1,22 +1,22 @@
 module MetaReports
   module ReportsHelper
     def meta_report_color(klass, row = 0)
-      color = MetaReports::Report::COLORS[klass.to_sym]
-      return nil unless color
-      if color.is_a? Array
-        # the trailing split first is to drop any !important directive
-        # color = color[row%color.length].to_s.split.first 
-        # the trailing gsub is to drop any !important directive
-        color = color[row%color.length].to_s.gsub(/\s.*$/,'')
-      end
-      if color.gsub!(/^\$/, '') # we have a variable
-        color = COLORS[color.to_sym]
+      @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
-          choice = color.gsub!(/Odd/,'') ? 1 : 0
-          color = color[choice]
+          # the trailing split first is to drop any !important directive
+          color = color[row%color.length].to_s.split.first 
+        end
+        if color.gsub!(/^\$/, '') # we have a variable
+          index = 0
+          index = $1 if color.gsub!(/_(\d+)$/,'')
+          color = meta_report_color(color, index)
         end
+        color
       end
-      color
     end
 
     def convert_margins_to_xlsx(margins)
@@ -37,6 +37,15 @@ module MetaReports
       if cell.is_a? Hash
         tags = cell.reject {|k,v| k == :content || k == :html}
         tags[:class] ||= 'textcenter'
+        if MetaReports::Base.inline_css
+          color = nil
+          tags[:class].split(/\s+/).each do |token|
+            if color = meta_report_color(token)
+              break
+            end
+          end
+          tags[:style] = "background-color: ##{color}"
+        end
         content_tag tag, (cell[:html] || cell[:content]).to_s.html_safe, tags
       elsif cell.is_a? Array
       else
@@ -66,11 +75,19 @@ module MetaReports
           if data[i][j].is_a? Hash
             [:html, :title, :id].each {|sym| data[i][j].delete(sym)}
             _class = data[i][j].delete(:class)
-            [:right, :left, :center].each do |sym|
-              set_style(styling, sym, i, j) if _class =~ /\b#{sym}\b|[^a-z]#{sym}/i
-            end
-            if _class =~ /\bbold\b|\bstrong\b/
-              set_style(styling, :bold, i, j)
+            unless _class.blank?
+              [:right, :left, :center].each do |sym|
+                set_style(styling, sym, i, j) if _class =~ /\b#{sym}\b|[^a-z]#{sym}/i
+              end
+              if _class =~ /\bbold\b|\bstrong\b/
+                set_style(styling, :bold, i, j)
+              end
+              _class.to_s.split(/\s+/).each do |token|
+                if color = meta_report_color(token)
+                  set_style(styling, :cell_bg_colors, i, j, color)
+                  break
+                end
+              end
             end
             unless data[i][j][:image] || data[i][j][:content].is_a?(String)
               data[i][j][:content] = data[i][j][:content].to_s
@@ -143,9 +160,9 @@ module MetaReports
       links.join(' ').html_safe
     end
 
-    def set_style(styling, style, row, col)
+    def set_style(styling, style, row, col, val = nil)
       styling[style] ||= []
-      styling[style] << [row,col]
+      styling[style] << (val ? [row,col,val] : [row,col])
     end
 
     def to_xls_col(column)

data/app/models/meta_reports/base.rb

@@ -1,6 +1,9 @@
 class MetaReports::Base < ActiveRecord::Base
-  attr_accessible :description, :direct, :group, :name, :target, :title, :views, :formats_mask
+  attr_accessible :description, :direct, :group, :name, :target, :title, :views, :formats_mask, :formats
   validates_presence_of :name, :title, :group
+
+  cattr_accessor :inline_css
+  @@inline_css = true
   
   self.table_name = "meta_reports_reports"
 
@@ -68,4 +71,9 @@ class MetaReports::Base < ActiveRecord::Base
     even:                   'efefef',
     odd:                    'ffffff',
   }
+
+  # Sorry, God doesn't help self.helpers, which is why you need it
+  def self.helpers
+    ApplicationController.helpers
+  end
 end

data/config/routes.rb

@@ -2,8 +2,10 @@ MetaReports::Engine.routes.draw do
   root to: "reports#index"
 
   get 'reports/file/:dir' => 'reports#file', as: 'file'
-  resources :reports
+  get 'new' => 'reports#new', as: 'short_new'
+  post 'reports' => 'reports#create', as: 'normal_create'
   match ':id(.:format)' => 'reports#show', as: 'short_show', via: [:get, :post]
   get ':id/edit' => 'reports#edit', as: 'short_edit'
   get ':id/form' => 'reports#form', as: 'short_form'
+  resources :reports
 end

data/lib/generators/meta_reports/templates/models/report.rb

@@ -3,26 +3,14 @@ class MetaReports::Report < MetaReports::Base
   #
   # Shared colors. The key is the class name, value is RGB in hex format
   #
-  # When you run the meta_reports:export_colors Rake task, the key changes as follows: 
-  #  * In the SASS CSS file:
-  #    - '___' will be changed to ' '
-  #    -  '__' will be changed to '#'
-  #    -   '_' will be changed to '.'
-  #    -  '--' will be changed to ':'
-  #    - an array of values will be changed to nth-child rules for consecutive rows
-  #  * In the SASS variables file:
-  #    - the variable name will be the same as the key
-  #    - an array of values will be changed into variables whose name is the class name plus a numerical suffix for each entry
-  #
-  # Example: 'tr____highlight' is 'tr .highlight {}' in CSS, and $tr____highlight as a SASS variable.
+  # 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'],
-    tr____highlight:          '$_yellow_1 !important',
-    'a--hover' =>            ['ffcccc', 'ffc5c5']
+    even:                   'efefef',
+    odd:                    'ffffff',
+    yellow:                 ['ffffaa', 'ffffcc', 'f9f9a4', 'f9f9c6'],
+    highlight:          '$yellow_1 !important',
   }
 
 

data/lib/generators/meta_reports/templates/models/report_non_activerecord.rb

@@ -3,26 +3,14 @@ class MetaReports::Report
   #
   # Shared colors. The key is the class name, value is RGB in hex format
   #
-  # When you run the meta_reports:export_colors Rake task, the key changes as follows: 
-  #  * In the SASS CSS file:
-  #    - '___' will be changed to ' '
-  #    -  '__' will be changed to '#'
-  #    -   '_' will be changed to '.'
-  #    -  '--' will be changed to ':'
-  #    - an array of values will be changed to nth-child rules for consecutive rows
-  #  * In the SASS variables file:
-  #    - the variable name will be the same as the key
-  #    - an array of values will be changed into variables whose name is the class name plus a numerical suffix for each entry
-  #
-  # Example: 'tr____highlight' is 'tr .highlight {}' in CSS, and $tr____highlight as a SASS variable.
+  # 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'],
-    tr____highlight:          '$_yellow_1 !important',
-    'a--hover' =>            ['ffcccc', 'ffc5c5']
+    even:                   'efefef',
+    odd:                    'ffffff',
+    yellow:                 ['ffffaa', 'ffffcc', 'f9f9a4', 'f9f9c6'],
+    highlight:          '$yellow_1 !important',
   }
 
 

data/lib/generators/meta_reports/templates/views/_form.html.erb

@@ -39,6 +39,15 @@
     <%= f.label :target %><br />
     <%= f.text_field :target %>
   </div>
+  <div class="field">
+    <% formats = @report.formats %>
+    <% for format in MetaReports::Base::FORMATS.sort %>
+      <%= check_box_tag "report[formats][]", format, formats.include?(format) %>
+      <span class='bold'><%= format.humanize %></span>
+      <br />
+    <% end %>
+    <%= hidden_field_tag "report[formats][]", "" %>
+  </div>
   <div class="actions">
     <%= f.submit %>
   </div>

data/lib/generators/meta_reports/templates/views/templates/_default_header.pdf.prawn

@@ -7,7 +7,6 @@ pdf.text '(123) 456-7890', :size => 8
 
 pdf.move_up 35
 pdf.pad_bottom(10) do
-  logger.info "title: #{title.inspect}"
   pdf.text title, :size => 18, :align => :center if title
   pdf.text subtitle, :size => 12, :align => :center if subtitle
 end

data/lib/generators/meta_reports/templates/views/templates/_default_header.xlsx.axlsx

@@ -1,17 +1,11 @@
 wb = sheet.workbook
 styles = {} unless defined?(styles)
-unless styles[:bold]
-  styles[:bold] = wb.styles.add_style :b => true
-end
-unless styles[:title]
-	styles[:title] = wb.styles.add_style :sz => 14, :alignment => { :horizontal => :center}, :b => true
-end
-unless styles[:subtitle]
-	styles[:subtitle] = wb.styles.add_style :sz => 12, :alignment => { :horizontal => :center}, :b => true
-end	
+styles[:bold]     ||= wb.styles.add_style :b => true
+styles[:title]    ||= wb.styles.add_style :sz => 14, :alignment => { :horizontal => :center}, :b => true
+styles[:subtitle] ||= wb.styles.add_style :sz => 12, :alignment => { :horizontal => :center}, :b => true
+columns           ||= 8
+subtitle          ||= ''
 
-columns  = columns || 8
-subtitle = subtitle || ''
 sheet.add_row ["Company Name, Address"] + ['']*(columns-3) + [Date.today().to_s, Time.now().strftime("%I:%M")], :style => styles[:bold]
 sheet.add_row [' '] * columns
 sheet.add_row [title], :style => styles[:title]

data/lib/generators/meta_reports/templates/views/templates/_default_table.html.erb

@@ -4,16 +4,25 @@ table_class = table.options[:table_class].to_s if !defined?(table_class) || tabl
 %>
 <%= content_tag(:h4, table_name) %>
 <div class='list_container'>
-<%= content_tag(:table, :class => "table #{table_class}") do %>
+<%= 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 ) ) %>
   <% end %>
   <tbody>
-    <% table.to_a.each_with_index do |row, i| %>
-      <%
-      row_class = "#{cycle('odd','even')} #{row_classes[i]}".strip
+    <% table.to_a.each_with_index do |row, i|
+      style = nil
+      if MetaReports::Base.inline_css && row_classes[i]
+        color = nil
+        row_classes[i].split(/\s+/).each do |token|
+          if color = meta_report_color(token)
+            break
+          end
+        end
+        style = "background-color: ##{color}"
+        #TODO: handle bold, alignment
+      end
       %>
-      <%= content_tag(:tr, :class => row_class) do
+      <%= content_tag(:tr, class: row_classes[i], style: style) do
         row.each do |cell|
           %><%= html_cell(cell) %><%
         end

data/lib/generators/meta_reports/templates/views/templates/_default_table.pdf.prawn

@@ -5,6 +5,7 @@ styling = {}
 column_widths = {} if !defined?(column_widths) || column_widths.blank?
 font_size = table[:font_size] || 8
 table_header = table[:table_header] != false
+row_offset = table_header ? 1 : 0
 pdf.table prep_pdf_table(table, styling), :header => table_header, :row_colors => ["EEEEEE", "FFFFFF"], :width => pdf.bounds.width, :cell_style => {:padding => 2, :size => font_size, :align => :center} do |t|
   t.cells.borders = []
   t.style t.row(0), :borders => [:bottom], :background_color => "DDDDDD", :font_style => :bold
@@ -17,7 +18,10 @@ pdf.table prep_pdf_table(table, styling), :header => table_header, :row_colors =
     t.style t.row(cell[0]).column(cell[1]), :font_style => :bold
   end
   styling[:row_colors].each do |row, color|
-    t.style t.row(row), :background_color => color
+    t.style t.row(row+row_offset), :background_color => color
+  end
+  styling[:cell_bg_colors].to_a.each do |cell|
+    t.style t.row(cell[0]).column(cell[1]), :background_color => cell[2]
   end
   if styling[:column_widths]
     t.column_widths = styling[:column_widths]

data/lib/generators/meta_reports/templates/views/templates/default.pdf.prawn

@@ -1,5 +1,5 @@
 margin = @report[:page_margin] && [*@report[:page_margin]][0,4] || nil
-prawn_document(page_orientation: @report[:page_orientation] || :portrait, page_size: @report[:page_size] || 'LETTER', margin: margin) do |pdf|
+prawn_document(page_layout: @report[:page_orientation] || :portrait, page_size: @report[:page_size] || 'LETTER', margin: margin) do |pdf|
 
 render :partial => "meta_reports/reports/templates/default_header", :locals => { :pdf => pdf, :title => @report[:title], :subtitle => @report[:subtitle] }
 pdf.font_size = @report[:font_size] || 8
@@ -13,11 +13,13 @@ 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
-    # TODO: provide option to 'group' all or one table
-    # this forces a table to stay together on one page. throws an error if a table is larger than a page.
-  	# pdf.group do
+    if table[:group]
+      pdf.group do #if the table is larger than a page this will throw an error
+        render :partial => 'meta_reports/reports/templates/default_table', :locals => {:pdf => pdf, :title => table_name, :table => table}
+      end
+    else
   		render :partial => 'meta_reports/reports/templates/default_table', :locals => {:pdf => pdf, :title => table_name, :table => table}
-    # end
+    end
   end
 end