reporta-modules 0.0.1

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

@@ -0,0 +1,49 @@
+<!-- 
+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. 
+-->
+
+<table class="<%= class_name %>">
+  <thead>
+    <tr>
+      <% report.columns.each do |name, column| %>
+        <th class="<%= column.class_names %>">
+          <%= column.title %>
+        </th>
+      <% end %>
+    </tr>
+  </thead>
+  <tbody>
+    <% report.rows.each do |record| %>
+      <tr>
+        <% report.columns.each do |name, column| %>
+          <td class="<%= column.class_names %>">
+            <% if column.helper %>
+              <%= send(column.helper, record) %>
+            <% else %>
+              <%= report.value_for(record, name) %>
+            <% end %>
+          </td>
+        <% end %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/reporta-modules.rb

@@ -0,0 +1,15 @@
+require 'reporta/railtie' if defined?(Rails)
+module Reporta
+  extend ActiveSupport::Concern
+  extend ActiveSupport::Autoload
+  
+  # view model
+  autoload :Form, 'reporta/models/form'
+  autoload :Filter, 'reporta/models/filter'
+  autoload :Column, 'reporta/models/column'
+  autoload :Reportable, 'reporta/models/reportable'  
+  
+  autoload :ViewHelper, 'reporta/view_helper'
+  autoload :ChartjsHelper, 'reporta/chartjs_helper'
+  autoload :BoxHelper, 'reporta/box_helper'
+end

data/lib/reporta/box_helper.rb

@@ -0,0 +1,17 @@
+module Reporta
+  module BoxHelper
+    include ActionView::Helpers::NumberHelper
+    def readable_number(num)
+      num = num || 0
+      opts = {units: { thousand: 'K', million: 'M', billion: 'B'}}
+      number_to_human(num, opts)
+    end
+
+    def box_for(report, locals={})
+      locals.reverse_merge!(report: report)
+      render partial: 'reporta/reports/box', locals: locals
+    end
+  end
+end
+
+

data/lib/reporta/chartjs_helper.rb

@@ -0,0 +1,74 @@
+module Reporta
+  module ChartjsHelper
+    include ActionView::Helpers::NumberHelper
+    
+    def line_chart_for(report, x, y, locals={})
+      locals.reverse_merge!(
+        report: report, 
+        x: x,
+        y: y, 
+        prefix: report.class.to_s.demodulize, 
+        rows: report.rows,
+        color: '#46BFBD')
+      render partial: "reporta/reports/chartjs_line", locals: locals
+    end
+
+    def pie_chart_for(report, x, y, locals={})
+      locals.reverse_merge!(
+        report: report, 
+        x: x,
+        y: y, 
+        prefix: report.class.to_s.demodulize, 
+        rows: report.rows,
+        color: '#46BFBD')
+      render partial: "reporta/reports/chartjs_pie", locals: locals
+    end
+ 
+    def bar_chart_for(report, x, y, locals={})
+      locals.reverse_merge!(
+        report: report, 
+        x: x,
+        y: y, 
+        prefix: report.class.to_s.demodulize, 
+        rows: report.rows,
+        color: '#46BFBD')
+      render partial: "reporta/reports/chartjs_bar", locals: locals
+    end
+ 
+    def chart_pie_from_rows(rows, x, y)
+      return {datasets:'[]', colors: '{}'} if rows.blank?
+      chart = {colors: {}, datasets: ''}
+      data = []
+      rows.each do |row|
+        color = cycle(*colors)
+        value = row.send(y)
+        label = row.send(x) || "Unknown"
+        data << { label: "#{label.humanize}", value: value, color: color }
+        chart[:colors][row.send(x)] = color
+      end
+      chart[:datasets] = data.to_json
+      chart
+    end
+
+    def colors
+      ['#F38630', '#E0E4CC', '#69D2E7','#F7464A', '#E2EAE9', '#D4CCC5', '#949FB1', '#4D5360']
+    end
+ 
+    def labels_from_rows(rows, attr, length=11)
+      return [] if rows.empty?
+      rows.collect{|r| 
+        row = r.send(attr)
+        row = row.blank? ? 'Unknown' : row
+        truncate(row.to_s, length: length)}
+    end
+
+    def decimals_from_rows(rows, x, y, precision=2)
+      return [] if rows.blank?
+      rows.collect{|r| 
+        row = r.send(y)
+        row = row.blank? ? 0 : row 
+        number_with_precision(row.to_f, precision: precision).to_f }
+    end
+    
+  end
+end

data/lib/reporta/models/column.rb

@@ -0,0 +1,68 @@
+# 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.
+
+require 'ostruct'
+
+module Reporta
+  module Column
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :columns
+      self.columns = {}
+    end
+
+    module ClassMethods
+      def column(name, options={})
+        columns[name] = OpenStruct.new options.reverse_merge(
+          title: name.to_s.humanize
+        )
+      end
+    end
+
+    def value_for(record, column_name)
+      column = columns[column_name]
+
+      # Local method defined that matches the column name
+      if respond_to? column_name
+        self.send column_name, record
+
+      # Column has the data_chain option set
+      elsif column.data_chain
+        data_chain_result(record, column.data_chain)
+
+      # Call the column name method on the record
+      else
+        record.send column_name
+      end
+    end
+
+    private
+
+    def data_chain_result(record, data_chain)
+      data_chain = data_chain.to_s.split '.'
+      data_chain.reduce(record) do |obj, method|
+        obj.send method
+      end
+    end
+
+  end
+end

data/lib/reporta/models/filter.rb

@@ -0,0 +1,42 @@
+# 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.
+
+require 'ostruct'
+
+module Reporta
+  module Filter
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :filters
+      self.filters = {}
+    end
+
+    module ClassMethods
+      def filter(name, options={})
+        filters[name] = OpenStruct.new options.reverse_merge(
+          include_blank: true,
+          'boolean?' => (options[:as] == :boolean)
+        )
+      end
+    end
+  end
+end

data/lib/reporta/models/form.rb

@@ -0,0 +1,77 @@
+# 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.
+
+module Reporta
+  class Form
+    include ActiveModel::Validations
+    include ActiveModel::Conversion
+
+    attr_accessor :filters, :filter_applied, :params
+
+    validate do
+      filters.each do |name, options|
+        if options.required && send(name).blank?
+          # TODO: Allow for internationization of form validation errors
+          errors.add(name, "required")
+        end
+      end
+    end
+
+    def initialize(filters, values={})
+      @filters = filters
+      @params = values
+      self.class.send :attr_accessor, *filters.keys
+      self.filter_applied = values.any?
+      set_values filters, values
+    end
+
+    def filter_applied?
+      self.filter_applied
+    end
+
+    # This method is required so a Form instance can be passed into a form_for
+    # helper method
+    def persisted?
+      false
+    end
+
+    private
+
+    def set_values(filters, values)
+      filters.each do |name, filter|
+        value = values[name].present? ? values[name] : filter.default
+        value = convert_boolean(values[name]) if filter.boolean?
+
+        self.send "#{name}=", value
+      end
+    end
+
+    def convert_boolean(value)
+      if value == "0"
+        false
+      elsif value == "1"
+        true
+      else
+        !!value
+      end
+    end
+  end
+end

data/lib/reporta/models/reportable.rb

@@ -0,0 +1,50 @@
+# 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.
+
+module Reporta
+  module Reportable
+    extend ActiveSupport::Concern
+    include Filter
+    include Column
+
+    attr_accessor :form
+
+    def initialize(args={})
+      args ||= {}
+      @form = Reporta::Form.new filters, args
+      form.valid? if args.present?
+    end
+
+    def id
+      self.class.name.underscore
+    end
+
+    private
+
+    # Delegate any undefined message to the @form object.
+    # This allows you to call `report.start_date` to get the value of the
+    # `start_date` filter or assign a value using
+    # `report.start_date = '2013-01-01'`
+    def method_missing(*args, &block)
+      self.form.send(*args, &block)
+    end
+  end
+end

data/lib/reporta/railtie.rb

@@ -0,0 +1,8 @@
+require 'reporta/view_helper'
+module Reporta
+  class Railtie < Rails::Railtie
+    initializer "reporta.application_helper" do 
+      ActionView::Base.send :include, ViewHelper
+    end
+  end
+end

data/lib/reporta/version.rb

@@ -0,0 +1,3 @@
+module Reporta
+  VERSION = "0.0.1"
+end

data/lib/reporta/view_helper.rb

@@ -0,0 +1,38 @@
+# 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.
+
+module Reporta
+  module ViewHelper
+
+    def filters_for(report)
+      render partial: "reporta/reports/filters", locals: { report: report }
+    end
+
+    def table_for(report, locals={})
+      locals.reverse_merge!(report: report, class_name: '')
+      render partial: "reporta/reports/table", locals: locals
+    end
+
+    def chart_for(report, locals={})
+      render partial: "reporta/reports/chart", locals: { report: report }
+    end
+  end
+end