meta_reports 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 183b24506be1116a9d39a68487dd42a62faff299
-  data.tar.gz: c39766e84b3a4c341a24523431cdc90623c8c2e3
+  metadata.gz: 444a74c33cfc1decb3b4d7876b1238a1428169da
+  data.tar.gz: 34dfb23512870e57cd31ff9f95adb9ea66527730
 SHA512:
-  metadata.gz: 322e5a34703a417265c797d50278ff25b10e2f7aba3082742f86feb3bc96f68ba2a911e230d0f0d69ee2635d1e495d5f9aac296853b650a8b740d28b9939168e
-  data.tar.gz: 1d4765a6fffbebb7e78eb960d0539ccbaa26ad1627723bd92495db778bd98c9991fce6331bf09932e48fa775abc5e8293cce962c6a2b7165cd3f6c630ca5e7f4
+  metadata.gz: 706f15ea4d6287cae130aa6a83e0c919622c452253ff82b6f4e11a3f37bff1ae9639c18f31b26ec6ffd0edaae3f52c20dd3e4f05b442dccb4fb4f265a6a50076
+  data.tar.gz: 80318f873898149a3eb90f42ca6347fc71a4d2230691d93408555b7a99d156135656c83487c0122c3d0ca3410c916c8f9c5f7a3bf94683ccc8cf8bc41f25036a

data/Guardfile

@@ -8,6 +8,7 @@ guard 'rspec', :version => 2, zeus: false, parallel: false, all_on_start: false,
   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('lib/tasks/meta_reports_tasks.rake')                      { "spec/tasks/meta_reports_rake_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,14 +22,20 @@ 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.
+###Templates / data structures only
 
-**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.
+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. 
-- **Non ActiveRecord:** A non ActiveRecord implementation and install generator will be implemented. 
-- **That pesky formatting:** 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.
+
+###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.
 
 ##Usage
 
@@ -60,7 +66,7 @@ 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/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.
 
@@ -72,7 +78,7 @@ After installing the gem, run the generator:
 
 This copies over the meta_reports migration, model, views, and controller: 
 
-- `db/migrate/<number>_create_meta_reports_reports.rb`
+- `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/*`
@@ -144,19 +150,65 @@ Here is a simple example. See the [example class](spec/dummy/app/models/meta_rep
 
 ###Colors
 
-There is currently an imperfect 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 format. HTML is not far away. 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 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.
+
+An example COLORS hash is below:
 
 ```ruby
 COLORS = {
-  even:                   'efefef',
-  odd:                    'ffffff',
-  attention:              'ff9999 !important',
+  _even:                   'efefef',
+  _odd:                    'ffffff',
+  _yellow:                 ['ffffaa', 'ffffcc', 'f9f9a4', 'f9f9c6'],
+  tr____highlight:         '$_yellow_1 !important',
+  'a--hover' =>            ['ffcccc', 'ffc5c5']
 }
 ```
 
-Note that you can specify `!important` and it will be reproduced in the HTML style.
+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)
+  - 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;
+```
+
+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; }
+```
+
+Note that you can specify `!important` and it will be reproduced in the CSS style.
 
-For HTML, necessary styles will either be injected into the HTML output, or a rake task will be created that will generate an appropriate css file to be included in the layout. I have the latter solution working in a test app, but it is not working as a generic rake task.
+To export only the variables file, use the `meta_reports:export_color_variables` Rake task. 
+To export only the colors file, use the `meta_reports:export_colors_only` Rake task. 
 
 ##TODO
 
@@ -168,6 +220,7 @@ For HTML, necessary styles will either be injected into the HTML output, or a ra
 
 ##Changelog
 
+- **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
 - **0.0.1:** (9/29/13) Initial release

data/lib/generators/meta_reports/install_engine_generator.rb

@@ -13,6 +13,10 @@ module MetaReports
         end
       end
       
+      def install_controller
+        copy_file "controllers/reports_controller.rb", "app/controllers/meta_reports/reports_controller.rb"
+      end
+
       def install_model
         copy_file "models/report.rb", "app/models/meta_reports/report.rb"
       end

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

@@ -3,10 +3,26 @@ 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.
+  #
 
   COLORS = {
-    even:                   'efefef',
-    odd:                    'ffffff',
+    _even:                   'efefef',
+    _odd:                    'ffffff',
+    _yellow:                 ['ffffaa', 'ffffcc', 'f9f9a4', 'f9f9c6'],
+    tr____highlight:          '$_yellow_1 !important',
+    'a--hover' =>            ['ffcccc', 'ffc5c5']
   }
 
 
@@ -23,6 +39,7 @@ class MetaReports::Report < MetaReports::Base
       d.tables["Table 1"] = MetaReports::Table.new do |t|
         t << ['One', 'Two', 'Three']
         t << [1, 2, 3]
+        t << [4, "#{params[:disco]} Moo", 'No Way!']
       end
     end
   end

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

@@ -3,10 +3,26 @@ 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.
+  #
 
   COLORS = {
-    even:                   'efefef',
-    odd:                    'ffffff',
+    _even:                   'efefef',
+    _odd:                    'ffffff',
+    _yellow:                 ['ffffaa', 'ffffcc', 'f9f9a4', 'f9f9c6'],
+    tr____highlight:          '$_yellow_1 !important',
+    'a--hover' =>            ['ffcccc', 'ffc5c5']
   }
 
 
@@ -23,6 +39,7 @@ class MetaReports::Report
       d.tables["Table 1"] = MetaReports::Table.new do |t|
         t << ['One', 'Two', 'Three']
         t << [1, 2, 3]
+        t << [4, "#{params[:disco]} Moo", 'No Way!']
       end
     end
   end

data/lib/meta_reports/version.rb

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

data/lib/tasks/meta_reports_tasks.rake

@@ -1,4 +1,59 @@
-# desc "Explaining what the task does"
-# task :meta_reports do
-#   # Task goes here
-# end
+def process_value(val)
+  ret = val =~ /^\$/ ? val : '#' + val
+  ret.gsub /\s*\;$/, ''
+end
+
+def printfl(str)
+  print str
+  $stdout.flush
+end
+
+namespace :meta_reports do
+  desc "export both color variables and the colors sass files"
+  task :export_colors => [:export_color_variables, :export_colors_only]
+
+  desc "export the colors file"
+  task :export_colors_only => :environment 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|
+        printfl "."
+        klass = klass.to_s
+        if value.is_a? Array
+          count = -1
+          value.each_with_index do |val, i|
+            f.puts "$#{klass}_#{i}: #{process_value(val.split.first)};"
+          end
+        else
+          f.puts "$#{klass}: #{process_value(value.split.first)};"
+        end
+      end
+      puts " Done"
+    end
+  end
+
+  desc "export the colors variable file"
+  task :export_color_variables => :environment 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|
+        printfl "."
+        css_klass = klass.to_s.gsub(/___/,' ').gsub(/__/,'#').gsub(/_/,'.').gsub(/--/,':')
+        if color.is_a? Array
+          len = color.length
+          color.each_with_index do |val, i|
+            f.puts "#{css_klass}:nth-child(#{len}n+#{i}) { background: $#{klass}_#{i}; }"
+          end
+        elsif color.to_s =~ /^\s*\$/
+          f.puts "#{css_klass} { background: #{color}; }"
+        else
+          f.puts "#{css_klass} { background: $#{klass}; }"
+        end
+      end
+      puts " Done"
+
+    end 
+  end
+end

data/spec/dummy/app/assets/stylesheets/lib/metareports_color_variables.scss

@@ -0,0 +1,9 @@
+$_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;

data/spec/dummy/app/assets/stylesheets/lib/metareports_colors.scss

@@ -0,0 +1,10 @@
+@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; }

data/spec/dummy/app/controllers/meta_reports/reports_controller.rb

@@ -0,0 +1,91 @@
+require_dependency "meta_reports/application_controller"
+
+module MetaReports
+  class ReportsController < ApplicationController
+    # remember to add authentication/authorization. E.g:
+      # before_filter :require_user
+      # load_and_authorize_resource
+
+    def index
+      @reports = Report.order("meta_reports_reports.title") || []
+    end
+
+    def show
+      if params[:id].to_s =~ /^\d+$/
+        _report = Report.find(params[:id])
+      elsif Report.respond_to?(params[:id])
+        _report = Report.find_by_name(params[:id])
+      else
+        redirect_to root_url, notice: 'That report does not exist'
+        return
+      end
+      @report = _report.run(params)
+      template = {template: "meta_reports/reports/templates/" + (@report[:template] || "default") }
+
+      respond_to do |format|
+        format.html { render template }
+        format.pdf { render template }
+        format.xlsx { render template }
+      end
+      _report.view
+    end
+
+    def new
+      @report = Report.new
+    end
+
+    def edit
+      @report = Report.find params[:id]
+    end
+
+    def create
+      @report = Report.new(params[:report])
+      if @report.save
+        flash[:notice] = 'Report was successfully created.'
+        redirect_to(edit_report_path(@report))
+      else
+        render action: "new"
+      end
+    end
+
+    def update
+      @report = Report.find params[:id]
+      if @report.update_attributes(params[:meta_report])
+        flash[:notice] = 'Report was successfully updated.'
+        redirect_to(edit_report_path(@report))
+      else
+        format.html { render action: "edit" }
+      end
+    end
+
+    def destroy
+      @report = Report.find params[:id]
+      @report.destroy
+      flash[:notice] = 'Report was successfully deleted.'
+      
+      redirect_to root_url
+    end
+
+    def file
+      dir = params[:dir].to_sym
+      path = Report::FILE_DIRS[dir] + params[:file].gsub(/\/../,'')
+      if File.exists?(path)
+        send_file path, type: "application/pdf", x_sendfile: true, disposition: 'inline'
+      else
+        puts "file doesn't exist: #{path}"
+      end
+    end
+
+    def form
+      if params[:id].to_s =~ /^\d+$/
+        @report = Report.find(params[:id])
+      elsif Report.respond_to?(params[:id])
+        @report = Report.find_by_name(params[:id])
+      else
+        redirect_to reports_url, notice: 'That report does not exist'
+        return
+      end
+      render "meta_reports/reports/forms/form"
+    end
+  end
+end

data/spec/dummy/app/models/meta_reports/report.rb

@@ -3,12 +3,28 @@ 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.
+  #
 
   COLORS = {
-    even:                   'efefef',
-    odd:                    'ffffff',
+    _even:                   'efefef',
+    _odd:                    'ffffff',
+    _yellow:                 ['ffffaa', 'ffffcc', 'f9f9a4', 'f9f9c6'],
+    tr____highlight:          '$_yellow_1 !important',
+    'a--hover' =>            ['ffcccc', 'ffc5c5']
   }
-  
+
 
   #
   # Reports