meta_reports 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0103cf12f7263900625b165f723814ae925631a
-  data.tar.gz: 1fa51dacb00f12e33d97fd30bc12ab5a710d1247
+  metadata.gz: 183b24506be1116a9d39a68487dd42a62faff299
+  data.tar.gz: c39766e84b3a4c341a24523431cdc90623c8c2e3
 SHA512:
-  metadata.gz: 79e20859f1c5bce940148a04d1efa0d8f24656c79bb7fdeb1bd1e03a2365be69aebd03e4946940a1fab08fd6bbd1f7d6caf9f6f694f4101da3754579e869ff22
-  data.tar.gz: 6da7d629504e5271ddac5a4ada0f2d5b620aa20f137cb236542d8503d0815857220a437028478f74066607d86c7bb52ead806b08da7544b9b88c7335008a3379
+  metadata.gz: 322e5a34703a417265c797d50278ff25b10e2f7aba3082742f86feb3bc96f68ba2a911e230d0f0d69ee2635d1e495d5f9aac296853b650a8b740d28b9939168e
+  data.tar.gz: 1d4765a6fffbebb7e78eb960d0539ccbaa26ad1627723bd92495db778bd98c9991fce6331bf09932e48fa775abc5e8293cce962c6a2b7165cd3f6c630ca5e7f4

data/Guardfile

@@ -7,6 +7,7 @@ guard 'rspec', :version => 2, zeus: false, parallel: false, all_on_start: false,
   watch(%r{^app/models/meta_reports/(.+)\.rb$})                   { |m| "spec/models/#{m[1]}_spec.rb" }
   watch(%r{^app/controllers/meta_reports/(.+)_(controller)\.rb$}) { |m| "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb" }
   watch('lib/generators/meta_reports/install_generator.rb')       { "spec/generators/install_spec.rb" }
+  watch('lib/generators/meta_reports/install_templates_generator.rb') { "spec/generators/install_templates_spec.rb" }
   watch('spec/dummy/app/controllers/application_controller.rb')   { "spec/controllers" }
   # dummy app 
   watch(%r{^spec/dummy/app/(.+)\.rb$})                            { |m| "spec/#{m[1]}_spec.rb" }

data/README.md

@@ -22,7 +22,9 @@ MetaReports exports to HTML, PDF, and XLSX formats. [More are to come](#todo).
 
 ##Philosophy
 
-MetaReports is avowedly fat model. It is also ActiveRecord based. This could change if a better way makes sense. 
+MetaReports is avowedly fat model. It is also ActiveRecord based. This could change if a better way makes sense.
+
+**NOTE:** 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, and write your own controllers / reports.
 
 - **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. 
@@ -41,9 +43,32 @@ gem 'meta_reports'
 
 Run the `bundle` command to install it.
 
-Now run the generator:
+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:
+
+    rails generate meta_reports:install_templates
+
+This copies over the meta_reports migration, model, views, and controller: 
+
+- `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.
+- `app/helpers/meta_reports/reports_helper.rb`: MetaReports helper methods.
+- `app/views/meta_reports/reports/templates/*`: All templates.
+
+####Install the engine
+
+After installing the gem, run the generator:
 
-    rails generate meta_reports:install
+    rails generate meta_reports:install_engine
 
 This copies over the meta_reports migration, model, views, and controller: 
 
@@ -60,9 +85,13 @@ Add authentication/authorization to the reports controller if desired.
 
 ###Writing a report
 
-- 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.
+- 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.
 
 ###MetaData
 
@@ -139,6 +168,7 @@ For HTML, necessary styles will either be injected into the HTML output, or a ra
 
 ##Changelog
 
+- **0.0.3:** (10/7/13) Template/model/helper generator
 - **0.0.2:** (9/29/13) Relax rails requirement, better testing
 - **0.0.1:** (9/29/13) Initial release
 

data/app/helpers/meta_reports/reports_helper.rb

@@ -1,5 +1,24 @@
 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]
+        if color.is_a? Array
+          choice = color.gsub!(/Odd/,'') ? 1 : 0
+          color = color[choice]
+        end
+      end
+      color
+    end
+
     def convert_margins_to_xlsx(margins)
       margins = [*margins].compact.map {|val| val/72.0}
       page_margins = {}
@@ -37,7 +56,7 @@ module MetaReports
       row_classes = opts[:row_classes] || {}
       row_colors = {}
       row_classes.each do |i, klass|
-        if color = MetaReports::Report.color(klass, i)
+        if color = meta_report_color(klass, i)
           row_colors[i] = color
         end
       end
@@ -53,9 +72,11 @@ module MetaReports
             if _class =~ /\bbold\b|\bstrong\b/
               set_style(styling, :bold, i, j)
             end
-            unless data[i][j][:image]
-              data[i][j][:content] = data[i][j][:content].to_s unless data[i][j][:content].is_a? String
+            unless data[i][j][:image] || data[i][j][:content].is_a?(String)
+              data[i][j][:content] = data[i][j][:content].to_s
             end
+          elsif !data[i][j].is_a?(String)
+            data[i][j] = data[i][j].to_s
           end
         end
       end
@@ -83,7 +104,8 @@ module MetaReports
       data
     end
 
-    def report_link(report, title = report.title)
+    def meta_report_link(report, title = report.title)
+      return nil unless report
       if report.direct
         content_tag :span do
           links = []
@@ -109,7 +131,8 @@ module MetaReports
       end
     end
 
-    def report_alt_links(report, params)
+    def meta_report_alt_links(report, params)
+      return nil unless report
       links = []
       if report.format? :pdf
         links << link_to(image_tag('meta_reports/print.png'), params.merge({:format => :pdf}), :target => '_blank')

data/app/models/meta_reports/base.rb

@@ -14,25 +14,6 @@ class MetaReports::Base < ActiveRecord::Base
 
   FORMATS = %w[html pdf xlsx]
 
-  def self.color(klass, row = 0)
-    color = 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]
-      if color.is_a? Array
-        choice = color.gsub!(/Odd/,'') ? 1 : 0
-        color = color[choice]
-      end
-    end
-    color
-  end
-
   def self.format_mask(format)
     1 << (FORMATS.index(format.to_s) || -1)
   end

data/lib/generators/meta_reports/{install_generator.rb → install_engine_generator.rb}

@@ -2,7 +2,7 @@ require 'rails/generators'
 
 module MetaReports
   module Generators
-    class InstallGenerator < Rails::Generators::Base
+    class InstallEngineGenerator < Rails::Generators::Base
       source_root File.expand_path('../templates', __FILE__)
       
       desc 'Copy meta_reports migration, models, controllers, and views.'

data/lib/generators/meta_reports/install_templates_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+module MetaReports
+  module Generators
+    class InstallTemplatesGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../..', __FILE__)
+      
+      desc 'Copy meta_reports templates.'
+
+      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"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+class MetaReports::Report
+
+  #
+  # Shared colors. The key is the class name, value is RGB in hex format
+  #
+
+  COLORS = {
+    even:                   'efefef',
+    odd:                    'ffffff',
+  }
+
+
+  #
+  # Reports
+  #
+
+  def self.example_report(params)
+    {title: 'Example Report', subtitle: 'this is a test report', tables: {'Table 1' => [['One','Two','Three'],[1,2,3]]}}
+    MetaReports::Data.new do |d|
+      d.title = 'Example Report'
+      d.subtitle = 'Of the Testing Kind'
+      d.description = 'This is a test report.'
+      d.tables["Table 1"] = MetaReports::Table.new do |t|
+        t << ['One', 'Two', 'Three']
+        t << [1, 2, 3]
+      end
+    end
+  end
+
+end

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

@@ -23,7 +23,7 @@
     <td><%= report.direct %></td>
     <td><%= report.views %></td>
     <td><%= report.target %></td>
-    <td><%= report_link(report, 'Show') %></td>
+    <td><%= meta_report_link(report, 'Show') %></td>
     <td><%= link_to 'Edit', edit_report_path(report) %></td>
     <td><%= link_to 'Destroy', report, method: :delete, data: { confirm: 'Are you sure?' } %></td>
   </tr>

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

@@ -8,7 +8,7 @@ report = @report if defined?(report).nil?
 	%>
 	<%= content_tag(:h3, title.html_safe) if title %>
 	<div>
-    <%= report_alt_links(report[:report], params) %>
+    <%= meta_report_alt_links(report[:report], params) %>
     <% if report[:description] %><br><p class='description'><%= report[:description] %></p><% end %>
   </div>
 
@@ -21,6 +21,6 @@ report = @report if defined?(report).nil?
 	<% end %>
 <% end %>
 
-<% unless request.xhr? %>
+<% unless request.xhr? || report[:report].nil? %>
 	<%= link_to 'Reports', '/meta_reports' %>
 <% end -%>

data/lib/meta_reports/version.rb

@@ -1,3 +1,3 @@
 module MetaReports
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/dummy/app/views/meta_reports/reports/index.html.erb

@@ -23,7 +23,7 @@
     <td><%= report.direct %></td>
     <td><%= report.views %></td>
     <td><%= report.target %></td>
-    <td><%= report_link(report, 'Show') %></td>
+    <td><%= meta_report_link(report, 'Show') %></td>
     <td><%= link_to 'Edit', edit_report_path(report) %></td>
     <td><%= link_to 'Destroy', report, method: :delete, data: { confirm: 'Are you sure?' } %></td>
   </tr>

data/spec/dummy/app/views/meta_reports/reports/templates/_default.html.erb

@@ -8,7 +8,7 @@ report = @report if defined?(report).nil?
 	%>
 	<%= content_tag(:h3, title.html_safe) if title %>
 	<div>
-    <%= report_alt_links(report[:report], params) %>
+    <%= meta_report_alt_links(report[:report], params) %>
     <% if report[:description] %><br><p class='description'><%= report[:description] %></p><% end %>
   </div>
 

data/spec/dummy/log/development.log

@@ -22832,3 +22832,87 @@ Completed 200 OK in 8ms (Views: 7.1ms | ActiveRecord: 0.3ms)
    (0.2ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.2ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.2ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.2ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.2ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.2ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.2ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.2ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction

data/spec/generators/{install_spec.rb → install_engine_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'fileutils'
 
-describe 'meta_reports:install', disabled: false do
+describe 'meta_reports:install_engine', disabled: false do
   before :all do
     Dir.chdir(Rails.root) do
       FileUtils.cp "config/routes_empty.rb", "config/routes.rb"

data/spec/generators/install_templates_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe 'meta_reports:install_templates', disabled: false do
+  it "should generate views" do
+    subject.should generate("app/models/meta_reports")
+    subject.should generate("app/models/meta_reports/base.rb")
+    subject.should generate("app/models/meta_reports/data.rb")
+    subject.should generate("app/models/meta_reports/report.rb")
+    subject.should generate("app/models/meta_reports/table.rb")
+    subject.should generate("app/views/meta_reports/reports/templates")
+    subject.should generate("app/views/meta_reports/reports/templates/_default.html.erb")
+    subject.should generate("app/views/meta_reports/reports/templates/_default_footer.pdf.prawn")
+    subject.should generate("app/views/meta_reports/reports/templates/_default_table.html.erb")
+    subject.should generate("app/views/meta_reports/reports/templates/_default_table.pdf.prawn")
+    subject.should generate("app/views/meta_reports/reports/templates/default.html.erb")
+    subject.should generate("app/views/meta_reports/reports/templates/default.pdf.prawn")
+    subject.should generate("app/views/meta_reports/reports/templates/default.xlsx.axlsx")
+    subject.should generate("app/helpers/meta_reports/reports_helper.rb")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meta_reports
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Noel Peden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -254,8 +254,10 @@ files:
 - app/models/meta_reports/table.rb
 - config/routes.rb
 - db/migrate/20130801071213_create_meta_reports_reports.rb
-- lib/generators/meta_reports/install_generator.rb
+- lib/generators/meta_reports/install_engine_generator.rb
+- lib/generators/meta_reports/install_templates_generator.rb
 - lib/generators/meta_reports/templates/models/report.rb
+- lib/generators/meta_reports/templates/models/report_non_activerecord.rb
 - lib/generators/meta_reports/templates/views/_form.html.erb
 - lib/generators/meta_reports/templates/views/edit.html.erb
 - lib/generators/meta_reports/templates/views/forms/_form_example.html.erb
@@ -364,7 +366,8 @@ files:
 - spec/dummy/tmp/cache/assets/test/sprockets/e858c95fa595e319dac0065d49982967
 - spec/dummy/tmp/cache/assets/test/sprockets/f7cbd26ba1d28d48de824f0e94586655
 - spec/features/dummy_spec.rb
-- spec/generators/install_spec.rb
+- spec/generators/install_engine_spec.rb
+- spec/generators/install_templates_spec.rb
 - spec/models/data_spec.rb
 - spec/models/table_spec.rb
 - spec/spec_helper.rb
@@ -483,7 +486,8 @@ test_files:
 - spec/dummy/tmp/cache/assets/test/sprockets/e858c95fa595e319dac0065d49982967
 - spec/dummy/tmp/cache/assets/test/sprockets/f7cbd26ba1d28d48de824f0e94586655
 - spec/features/dummy_spec.rb
-- spec/generators/install_spec.rb
+- spec/generators/install_engine_spec.rb
+- spec/generators/install_templates_spec.rb
 - spec/models/data_spec.rb
 - spec/models/table_spec.rb
 - spec/spec_helper.rb