reporta-modules 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24231287130d42d72c0e84992b2bea414f81289b
+  data.tar.gz: 6d19674561f3ae544758cb1f11ddbb096429f471
+SHA512:
+  metadata.gz: 25052bfc227fda62f69bb12aba5b783b9a74681153c4c2922b8c013c866a67f11a598d356f39e2411887356797a700465cbd1cbd821538ea6f7fe159c1ca0bec
+  data.tar.gz: 74616e062c0781180563f51f2fa82c4bd75a6df85e15afb5e16e3c9108bb8f1e48224444173191e397700acc53c68f4d0823309c6187b2ea8abf3b3dc7e6a1ff

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Alvin S.J. Ng 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,203 @@
+# Reporta Modules
+
+__reporta-modules__ is a Rails gem packed with modules and helpers to help you build your reports. 
+
+It is also a fork from the original [__reporta__](github.com/uts/reporta) Rails engine gem. 
+
+## Installation
+
+Add Reporta to your Gemfile
+
+```ruby
+gem 'reporta-modules'
+```
+
+Generate default view templates in your project  
+`$ rails generate reporta:views` 
+
+Turn any plain Ruby class into a Reporta class by including `Reporta::Reportable`
+
+```ruby
+class YourReport
+  include Reporta::Reportable
+end
+```
+
+## Basic Example
+
+### View Model
+
+```ruby
+class ProjectReport
+  include Reporta::Reportable
+
+  filter :start_date, default: '2013-01-01', required: true
+  filter :finish_date, default: '2013-12-13', required: true
+
+  column :name
+  column :created_at
+
+  def rows
+    Project.where(created_at: start_date..finish_date)
+  end
+end
+```
+
+### Controller
+
+```ruby
+class ProjectReportsController < ApplicationController
+  def show
+    @report = ProjectsReport.new(params[:reporta_form])
+  end
+end
+```
+
+### View
+
+```erb
+<%= filters_for @report %>
+<%= table_for @report %>
+```
+
+
+
+## Reporta Modules
+
+### Reporta::Reportable
+
+`Reporta::Reportable` module added some DSL for your covenience to create your report's [__view model/object__](http://blog.codeclimate.com/blog/2012/10/17/7-ways-to-decompose-fat-activerecord-models/).
+
+#### Filters
+
+Report are normally generated based on some filter or a certain criteria.  
+For example: 
+
+```ruby
+class ProjectReport
+  include Reporta::Reportable
+
+  filter :start_date, as: :date, default: '2013-01-01', required: true 
+  filter :finish_date, as: :date, default: '2013-12-31', required: true
+  filter :status, collection: Status.all, include_blank: false
+  filter :exclude_deleted, as: :boolean, default: false
+  
+  # required method
+  def rows 
+    # use filters above to manipulate the results
+    projects = Project.where(created_at: start_date..finish_date)
+      .where(status: status)
+    projects = projects.where(deleted_at: nil) if exclude_deleted
+    projects
+  end
+end
+```
+
+**Filter Options**
+
+* `required` - set to `true` to force a field to be set. Defaults to `false`.
+* `collection` - setting a collection will force the filter to render as a select input.
+* `include_blank` - only has an affect if a collection is set. defaults to `true`.
+* `as` - set the type of field to render. Available values are `:boolean`, `:string`, `:check_boxes`, `:radio`, `:date`. Defaults to `:string`.
+* `default` - set the default value for the filter.
+* `label` - set the label of display
+
+#### Columns
+
+When is comes to displaying the report you will generally want to display a subset of data from the rows, custom calculations or maybe some associated data. Here's a quick example of defining a variety of columns.
+
+```ruby
+class ProjectReport
+  include Reporta::Reportable
+
+  column :name
+  column :formatted_date, title: 'Created at'
+  column :manager, data_chain: 'manager.full_name'
+  column :cost, class_names: 'sum currency'
+
+  def rows
+    Projects.all
+  end
+
+  def formatted_date(project)
+    project.created_at.strftime("%b %d, %Y")
+  end
+end
+```
+
+**Column Options**
+
+* `title` - set a custom title for the colum. Defaults to the column name
+* `data_chain` - provide a chain of methods to call in order to fetch the data.
+* `class_names` - these classes will be applied to the column to allow for custom styling or Javascript hooks.
+* `helper` - format your column
+
+### Required Methods
+
+As a very minimum you need to define the `rows` method which will return the rows that are displayed in the report. 
+
+```ruby
+class ProjectReport
+  include Reporta::Reportable
+
+  def rows
+    Project.all
+  end
+end
+```
+
+
+#### Default View Templates
+
+In order to render the results of your report there are a variety of different ways to access and display the data. If you have any filters defined you will probably want to display a form for the user to enter parameters into.
+
+The `filters_for` helper generates a basic form based on the filters you have defined.
+
+```erb
+<%= filters_for @report %>
+```
+If we look at how `filters_for` is created you can see the underlying data structures used to render the form.
+
+```erb
+<%= form_for @report.form do |f| %>
+  <% @report.filters.each do |filter| %>
+    <%= f.label filter.name %>
+    <%= f.text_field filter.name %>
+  <% end %>
+  <%= f.submit %>
+<% end %>
+```
+To display the results of the report you can simply use the `table_for` helper method.
+
+```erb
+<%= table_for @report %>
+```
+Or for more detailed control you can build the table yourself.
+
+```erb
+<table>
+  <thead>
+  	<tr>
+      <% @report.columns.each do |column| %>
+        <th class="#{column.class_names}">
+       	  <%= column.title %>
+        </th>
+      <% end %>
+    </tr>
+  </thead>
+  <tbody>
+    <% @report.rows.each do |record| %>
+      <tr>
+        <% @report.columns.each do |column| %>
+          <th class="#{column.class_names}">
+            <%= @report.value_for(record, column) %>
+          </th>
+        <% end %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+```
+
+## License  
+see MIT-LICENSE 

data/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs = ["lib", "spec"]
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+
+task default: :test

data/lib/generators/reporta/views_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/base'
+
+module Reporta
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      public_task :copy_views
+
+      def copy_views
+        view_directory :reports
+      end
+      
+      def view_directory(name, _target_path = nil)
+        directory name.to_s, _target_path || "#{target_path}/#{name}" do |content|
+          content
+        end
+      end
+
+      def target_path
+        @target_path ||= "app/views/reporta"
+      end
+    end
+  end
+end

data/lib/generators/templates/reports/_box.html.erb

@@ -0,0 +1,48 @@
+<div class="well">
+  <div class="reporta-box">
+    <span class="box-icon <%=report.icon_bg %>" >
+      <!-- uses FontAwesome -->
+      <i class="fa <%=report.fa_icon %>"></i>
+    </span>
+    <span class="box-info">
+      <p class="value"><%= raw report.value %></p>
+      <p class="title"><%= raw report.description %></p>
+    </span>
+  </div>
+</div>
+<!--
+<style>
+.reporta-box .box-icon{
+  display: block;
+  float: left;
+  margin: 0 10px 10px 0;
+  width: 65px;
+  height: 65px;
+  border-radius: 50%;
+  vertical-align: middle;
+  text-align: center;
+  font-size: 35px;
+  line-height: 65px;
+}
+.reporta-box i.fa{
+  line-height: 35px;
+  text-align:center;
+  color: white;
+}
+
+.reporta-box .box-info p{
+  margin:0;
+}
+
+.reporta-box .box-info .value{
+  color: #767676;
+  font-size: 30px;
+}
+
+.reporta-box .box-info .title{
+  color: #999999;
+  font-size: 14px;
+}
+</style>
+-->
+

data/lib/generators/templates/reports/_chartjs_bar.html.erb

@@ -0,0 +1,31 @@
+<canvas id="<%=prefix.to_s.camelize %>BarChart"></canvas>
+<% content_for :script do %>
+// uses JQuery
+$(function(){
+  "use strict";
+  var data = {
+    labels : <%=raw labels_from_rows(rows, x).to_json %>,
+    datasets : [
+    <% y = [y] if !y.is_a?(Array) %>
+    <% lines = y.map do |k| 
+      "{
+        fillColor : '#{color}',
+        strokeColor : '#{color}',
+        pointColor : '#{color}',
+        pointStrokeColor : '#fff',
+        data : #{raw decimals_from_rows(rows, x, k).to_json}
+      }"
+    end.join(',') %>
+    <%=raw lines %>
+    ]
+  };
+
+  var ctx = document.getElementById("<%=prefix.to_s.camelize %>BarChart").getContext("2d");
+  
+  // uses Chartjs
+  var chart = new Chart(ctx).Bar(data, {responsive: true});
+  <%= yield :chartjs_script %>  
+});
+
+<% end %>
+

data/lib/generators/templates/reports/_chartjs_line.html.erb

@@ -0,0 +1,33 @@
+<canvas id="<%=prefix.to_s.camelize %>LineChart"></canvas>
+<% content_for :script do %>
+  
+// uses JQuery
+$(function(){
+  "use strict";
+
+  var data = {
+    labels : <%=raw labels_from_rows(rows, x).to_json %>,
+    datasets : [
+    <% y = [y] if !y.is_a?(Array) %>
+    <% lines = y.map do |k| 
+      "{
+        fillColor : '#{color}',
+        strokeColor : '#{color}',
+        pointColor : '#{color}',
+        pointStrokeColor : '#fff',
+        data : #{raw decimals_from_rows(rows, x, k).to_json}
+      }"
+    end.join(',') %>
+    <%=raw lines %>
+    ]
+  };
+
+  var ctx = document.getElementById("<%=prefix.to_s.camelize %>LineChart").getContext("2d");
+  
+  // uses Chartjs
+  var chart = new Chart(ctx).Line(data, {responsive: true});
+  <%= yield :chartjs_script %>  
+});
+
+<% end %>
+

data/lib/generators/templates/reports/_chartjs_pie.html.erb

@@ -0,0 +1,19 @@
+<div class="col-md-6">
+  <canvas id="<%=prefix.to_s.camelize %>PieChart" ></canvas>
+</div>
+<div class="col-md-6">
+  <div id="<%=prefix.to_s.camelize%>PieChartLegend"></div>
+</div>
+<% chart = chart_pie_from_rows(rows, x, y) %>
+<% content_for :script do %>
+$(function(){
+  "use strict";
+
+  var data = <%=raw chart[:datasets] %>;
+  var ctx = document.getElementById("<%=prefix.to_s.camelize %>PieChart").getContext("2d");
+  var chart = new Chart(ctx).Pie(data, {responsive: true});
+  $('#<%=prefix.to_s.camelize %>PieChartLegend').html(chart.generateLegend());
+  <%= yield :chartjs_script %>  
+});
+<% end %>
+

data/lib/generators/templates/reports/_filters.html.erb

@@ -0,0 +1,100 @@
+<!-- 
+Copyright 2013-2014 University of Technology, Sydney (github.com/uts)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
+-->
+
+<%= form_for report.form, url: request.path, html:{class: 'form-horizontal well'} do |f| %>
+  <% 
+      non_advanced = report.filters.select{|k,o| !o.advanced} 
+      advanced = report.filters.select{|k,o| o.advanced }
+  %>
+  <% [non_advanced, advanced].each do |filters| %>
+    <div id="<%=raw('form-advanced" style="display:none') if filters == advanced%>">
+      <% filters.each do |name, options| %>
+
+        <% label_name = options.label || ("#{name.to_s.humanize} #{'*' if options.required}") %>
+        <div class='form-group'> 
+          <%#Collection field%>
+          <% if options.collection %>
+            <%= f.label name, label_name, class: 'col-sm-2 control-label' %>
+            <div class='col-sm-10'>
+              <% html_opts = options.include_blank ? {include_blank: options.include_blank} : {} %>
+              <%= f.select name, options_for_select(options.collection, f.object.send(name)), html_opts, required: options.required, multiple: options.multiple%>
+            </div>
+  
+          <%#Boolean field%>
+          <% elsif options.boolean? %>
+            <div class="col-sm-offset-2 col-sm-10">  
+              <label>
+                <%= f.check_box name %> <%=label_name %>
+              </label>
+            </div>
+      
+          <%#Date field%>
+          <% elsif options.as == :date %>
+            <%= f.label name, label_name, class: 'col-sm-2 control-label text-left' %>
+            <div class="col-sm-10">
+              <%= f.text_field name, required: options.required, class: "#{name}-datepicker" %>
+            </div>
+            <!--           
+              // uses JQuery
+              $(function(){
+                // uses JQueryUI
+                $('input.<%=name.to_s%>-datepicker').datepicker({
+                    changeMonth: true, changeYear: true, dateFormat: 'yy-mm-dd'
+                });
+              });
+            -->
+    
+          <%#Text field%>
+          <% else %>
+            <%= f.label name, label_name, class: 'col-sm-2 control-label text-left' %>
+            <div class="col-sm-10">
+              <%= f.text_field name, required: options.required %>
+            </div>
+          <% end %>
+        </div>
+  
+        <% if report.form.errors[name].any? %>
+          <%= report.form.errors[name].to_sentence %>
+        <% end %>
+        <% end %>
+      </div>
+  
+      <% if advanced.present? && non_advanced == filters %>
+        <div class="form-group">
+          <div class="col-sm-offset-2 col-sm-10">
+            <a href="#" id='toggle-advanced'>Show Advanced Options</a>
+          </div>
+        </div>
+      <% end %>
+      
+    <% end %>
+   
+    <div class="form-group">
+      <div class="col-sm-offset-2 col-sm-10">
+        <%= f.button 'Apply', class: 'btn btn-primary' %>
+        <%= link_to 'Reset all', request.original_url, class: 'btn btn-default' %>
+      </div>
+    </div>
+
+  <% end %>
+