clark_kent 0.0.1 → 0.1.0

data/app/models/clark_kent/cloneable.rb

@@ -0,0 +1,18 @@
+module ClarkKent
+  module Cloneable
+    def cloneable_attributes
+      these_attrs = self.attributes.dup
+      these_attrs.delete('id')
+      these_attrs.delete('created_at')
+      these_attrs.delete('updated_at')
+      these_attrs
+    end
+
+    def reset_timestamps
+      updated_at = nil
+      created_at = nil
+      self
+    end
+
+  end
+end

data/app/models/clark_kent/date_filter_option.rb

@@ -0,0 +1,7 @@
+module ClarkKent
+  class DateFilterOption < ReportFilterOption
+    def filter_params
+      [param + '_from', param + '_until']
+    end
+  end
+end

data/app/models/clark_kent/number_filter_option.rb

@@ -0,0 +1,7 @@
+module ClarkKent
+  class NumberFilterOption < ReportFilterOption
+    def filter_params
+      [param]
+    end
+  end
+end

data/app/models/clark_kent/object_filter_option.rb

@@ -0,0 +1,7 @@
+module ClarkKent
+  class ObjectFilterOption < ReportFilterOption
+    def filter_params
+      [param]
+    end
+  end
+end

data/app/models/clark_kent/report.rb

@@ -2,12 +2,10 @@ module ClarkKent
   # load the builders
   Dir.glob(Rails.root.join('app/models/reporting/*.rb')) { |file| load file }
   class Report < ActiveRecord::Base
-
-    include Cloneable
+    include ClarkKent::Cloneable
 
     SortDirections = {'A->Z' => 'asc', 'Z->A' => 'desc'}
 
-    attr_accessible :resource_type, :name, :sharing_scope_id, :sharing_scope_type
     attr_accessor :summary_row_storage
 
     belongs_to :sharing_scope, polymorphic: true
@@ -80,6 +78,27 @@ module ClarkKent
       @resource_class ||= self.resource_type.constantize
     end
 
+    ## This ephemeral class allows us to create a row object that has the same attributes as the AR response
+    ## to the query, including all the custom columns defined in the resource class report config.
+    ## currently only used for the summary row, since we can't get that in the same AR query and have to
+    ## add it to the collection after the query returns.
+    def row_class
+      report_columns = self.report_columns
+      @row_class ||= Class.new do
+        report_columns.each do |report_column|
+          attr_accessor report_column.column_name.to_sym
+        end
+
+        def initialize params = {}
+          params.each { |key, value| send "#{key}=", value }
+        end
+
+        def [](key)
+          self.send key
+        end
+      end
+    end
+
     def sort_column
       @sort_column ||= self.report_columns.where("clark_kent_report_columns.report_sort is not NULL and clark_kent_report_columns.report_sort != ''").first
     end
@@ -88,7 +107,7 @@ module ClarkKent
       if self.sort_column
         sort_column_name = self.sort_column.column_name
         sort_direction = Report::SortDirections[sort_column.report_sort]
-        Map.new(order_column: sort_column_name, order_direction: sort_direction)
+        ReportSort.new(order_column: sort_column_name, order_direction: sort_direction)
       end
     end
 
@@ -127,6 +146,9 @@ module ClarkKent
         }.flatten.compact
     end
 
+    ## These are the built-in filter params that define this report. They are merged at a later
+    ## step with the runtime params entered by the user for a specific report run.
+    ## nb. the sorter column here may be overridden by a runtime sort if requested by the user.
     def report_filter_params
       Hash[*self.report_filters.map{|filter| filter.filter_match_params}.flatten].
         merge(order: self.sorter)
@@ -169,6 +191,8 @@ module ClarkKent
       self.resource_class::REPORT_FILTER_OPTIONS.select{|filter| 'date_filter' == filter.kind}.map{|filter| filter.param}
     end
 
+    ## These are the filters available for defining a report for this resource. They do not include date
+    ## filters as those only make sense at runtime, or in an auto-generated, timed emailed report.
     def available_filters
       self.available_email_filters.reject{|name| self.date_filter_names.include? name}
     end
@@ -177,6 +201,8 @@ module ClarkKent
       self.available_filters.map{|id| [self.filter_options_for(id).label,id]}
     end
 
+    ## This is the full set of filter options for defining a report, including the date filters for
+    ## an automatic, timed, emailed report.
     def available_email_filters
       self.resource_class::REPORT_DEFINITION_OPTIONS.reject{|name| (self.report_filters.pluck(:filter_name)).include? name}
     end
@@ -185,10 +211,14 @@ module ClarkKent
       self.resource_class::REPORT_FILTER_OPTIONS.detect{|filter| filter.param == filter_name}.collection
     end
 
+    ## These are the filters available at runtime, ie. not including the ones set to define this report.
+    ## If updating the report, this is the set available to add as new report definition filters.
     def custom_filters
       self.resource_class::REPORT_FILTER_OPTIONS.select{|filter| self.report_filters.pluck(:filter_name).exclude? filter.param}
     end
 
+    ## This is the set of columns not chosed to use in the report. These are the ones available to add
+    ## when updating a report.
     def available_columns
       self.resource_class::REPORT_COLUMN_OPTIONS.keys.reject{|column| self.report_columns.pluck(:column_name).include? column.to_s}
     end
@@ -202,7 +232,11 @@ module ClarkKent
     end
 
     def resource_type_pretty
-      self.resource_class.prettify_name.pluralize
+      if self.resource_class.respond_to? :prettify_name
+        self.resource_class.prettify_name.pluralize
+      else
+        self.resource_class.name.humanize
+      end
     end
 
     def get_filter_class(params)
@@ -220,7 +254,7 @@ module ClarkKent
       row_array = self.report_columns.map do |report_column|
         [report_column.column_name,report_column.calculate_summary(rows.map{|row| row.send(report_column.column_name)})]
       end
-      Map.new(row_array.to_h)
+      row_class.new(row_array.to_h)
     end
 
     def summary_row?
@@ -269,4 +303,13 @@ module ClarkKent
     end
 
   end
+
+  class ReportSort
+    attr_accessor :order_column, :order_direction
+
+    def initialize params = {}
+      params.each { |key, value| send "#{key}=", value }
+    end
+  end
+
 end

data/app/models/clark_kent/report_column.rb

@@ -1,9 +1,9 @@
 module ClarkKent
 	class ReportColumn < ActiveRecord::Base
-	  include Cloneable
+	  include ClarkKent::Cloneable
 
 		SummaryMethods = ['total','average']
-		attr_accessible :report_id, :column_name, :column_order, :report_sort, :summary_method
+
 		belongs_to :report
 
 		scope :sorted, -> { order("clark_kent_report_columns.column_order") }
@@ -14,11 +14,38 @@ module ClarkKent
 
 		def calculate_summary(values)
 			return nil unless self.summary_method.present?
-			values.send self.summary_method
+			calculator.new(values).calculate
 		end
 
 		def summarizable?
-			report.column_options_for(self.column_name).respond_to? :summarizable
+			report.column_options_for(self.column_name).summarizable
+		end
+
+		def calculator
+			('ClarkKent::' + summary_method.camelcase + 'Calculator').constantize
 		end
+
+	end
+
+	class AbstractCalculator
+    def initialize values
+    	@values = values
+    end
+	end
+
+	class TotalCalculator < AbstractCalculator
+    def calculate
+    	@values.sum
+    end
+	end
+
+	class AverageCalculator < AbstractCalculator
+    def calculate
+    	if @values.length < 1
+        return nil
+      else
+        return (@values.sum.to_f / @values.length)
+      end
+    end
 	end
 end

data/app/models/clark_kent/report_config.rb

@@ -0,0 +1,24 @@
+module ClarkKent
+  module ReportConfig
+    module ClassMethods
+      def filter_config(params)
+        filter_option_class = ('ClarkKent::' + ((params[:kind] + '_option').camelcase)).constantize
+        filter_option_class.new(params)
+      end
+
+      def column_config(params)
+        ClarkKent::ReportColumnConfig.new(params)
+      end
+    end
+    extend ClassMethods
+    def self.included( other )
+      other.extend( ClassMethods )
+    end
+  end
+  class ReportColumnConfig
+    attr_accessor :custom_select, :order_sql, :summarizable
+    def initialize params = {}
+      params.each { |key, value| send "#{key}=", value }
+    end
+  end
+end

data/app/models/clark_kent/report_date_filter.rb

@@ -20,8 +20,6 @@ module ClarkKent
 
     before_save :handle_filter_value
 
-    attr_accessible :kind_of_day, :offset, :duration
-
     def filter_match_params
       [[self.begin_param_name,self.begin_date],[self.end_param_name,self.end_date]]
     end

data/app/models/clark_kent/report_email.rb

@@ -1,6 +1,6 @@
 module ClarkKent
   class ReportEmail < ActiveRecord::Base
-    include Cloneable
+    include ClarkKent::Cloneable
 
     SEND_TIMES = {
       'Mondays' => 'Monday',
@@ -19,7 +19,6 @@ module ClarkKent
     has_many :user_report_emails, dependent: :destroy
     has_many :users, through: :user_report_emails
 
-    attr_accessible :report_id, :when_to_send, :name
 
     def self.send_emails_for_today
       today = Date.ih_today

data/app/models/clark_kent/report_filter.rb

@@ -1,9 +1,8 @@
 module ClarkKent
 	class ReportFilter < ActiveRecord::Base
-	  include Cloneable
+	  include ClarkKent::Cloneable
 
 	  attr_accessor :filter_value_1, :filter_value_2
-		attr_accessible :filter_value_1, :filter_value_2, :report_id, :filter_name, :filter_value, :filterable_id, :filterable_type, :type
 		belongs_to :filterable, polymorphic: true
 
 		def filter_match_params

data/app/models/clark_kent/report_filter_error.rb

@@ -0,0 +1,4 @@
+module ClarkKent
+  class ReportFilterError < StandardError
+  end
+end

data/app/models/clark_kent/report_filter_option.rb

@@ -1,15 +1,11 @@
 module ClarkKent
 	class ReportFilterOption
-	  include Cloneable
 
-		attr_accessor :param, :label, :collection, :kind, :select
-		def initialize(params)
-			self.param = params[:param] if params[:param].present?
-			self.label = params[:label] if params[:label].present?
-			self.collection = params[:collection] if params[:collection].present?
-			self.kind = params[:kind] if params[:kind].present?
-			self.select = params[:select] if params[:select].present?
-		end
+		attr_accessor :param, :label, :collection, :kind, :select, :in_required_date_group
+
+    def initialize params = {}
+      params.each { |key, value| send "#{key}=", value }
+    end
 
 		def label
 			@label || @param

data/app/models/clark_kent/report_number_filter.rb

@@ -1,8 +1,5 @@
 module ClarkKent
   class ReportNumberFilter < ReportFilter
-    include Cloneable
-
-  	attr_accessible :max_value, :min_value
 
     def filter_match_params
       [[self.min_param_name,self.min_value],[self.max_param_name,self.max_value]]

data/app/models/clark_kent/reportable.rb

@@ -15,7 +15,22 @@ module ClarkKent
 	      query
 	    end
 
+	    def required_date_params
+	    	self::REPORT_FILTER_OPTIONS.select{|rfo| rfo.in_required_date_group}.map{|rfo| rfo.filter_params}.flatten
+	    end
+
+	    def validate_params(params,report)
+	    	if required_date_params.any?
+	    		missing_params = required_date_params - params.select{|k,v| v.present? }.keys
+	    		# a bit clunky, it only requires any 2 date filters. It would be better to require at least one pair of before/after filters
+	    		if missing_params.length > (required_date_params.length - 2)
+			    	raise ClarkKent::ReportFilterError.new("At least one date range is required.")
+			    end
+			  end
+	    end
+
 		  def report(params,report,count = false)
+		  	validate_params(params, report)
 		  	@selects = []
 		  	@includes = []
 		  	@joins = []
@@ -48,9 +63,9 @@ module ClarkKent
 		    end
 		    query = self.all
 		    if @report_email and @report_email.is_a? ClarkKent::ReportEmail
-					params = @report_email.report_filter_params.symbolize_keys!.merge(params)
+					params = @report_email.report_filter_params.symbolize_keys!.merge(params.symbolize_keys)
 		    else
-					params = report.report_filter_params.symbolize_keys!.merge(params)
+					params = report.report_filter_params.symbolize_keys!.merge(params.symbolize_keys)
 				end
 		    params.each do |param_type,param_value|
 		      if param_value.present?
@@ -121,8 +136,18 @@ module ClarkKent
 		  	where("#{self.table_name}.#{field_name.to_s.sub(/_from/,'')} >= :date_limit", date_limit: match_value)
 		  end
 
+		  def above_number_arel(query, field_name, match_value)
+		  	query.
+		  	where("#{self.table_name}.#{field_name.to_s.sub(/_above/,'')} >= :lower_limit", lower_limit: match_value)
+		  end
+
+		  def below_number_arel(query, field_name, match_value)
+		  	query.
+		  	where("#{self.table_name}.#{field_name.to_s.sub(/_below/,'')} <= :upper_limit", upper_limit: match_value)
+		  end
+
 		  def order_arel(query, field_name, match_value)
-		  	if match_value.is_a? Map
+		  	if match_value.is_a? ClarkKent::ReportSort
 			  	order_column = match_value.order_column
 			  	order_direction = match_value.order_direction
 			  else

data/app/models/clark_kent/resource_option.rb

@@ -0,0 +1,10 @@
+module ClarkKent
+  class ResourceOption
+    attr_accessor :id, :name
+
+    def initialize params = {}
+      params.each { |key, value| send "#{key}=", value }
+    end
+
+  end
+end

data/app/models/clark_kent/sharing_scope_kind.rb

@@ -17,19 +17,45 @@ module ClarkKent
       self.all.detect{|ssk| klass_name == ssk.class_name}
     end
 
+    def self.has_some(thing)
+      if thing.present?
+        if thing.respond_to? :any?
+          thing.any?
+        else
+          true
+        end
+      else
+        false
+      end
+    end
+
     def self.custom
       all.select{|ssk| ['everyone',ClarkKent.user_class_name.underscore].exclude? ssk.type}
     end
 
+    def self.custom_for_user(user)
+      custom.select{|ssk| has_some(ssk.associated_containers_for(user)) }
+    end
+
     def self.select_options
       return @sharing_scope_options if @sharing_scope_options
       @sharing_scope_options = {}
-      self.all.each do |sharing_scope|
-        @sharing_scope_options[sharing_scope.human_name] = sharing_scope.class_name
+      self.all.each do |sharing_scope_kind|
+        @sharing_scope_options[sharing_scope_kind.human_name] = sharing_scope_kind.class_name
       end
       @sharing_scope_options
     end
 
+    def self.select_options_for_user(user)
+      sharing_scope_options = {}
+      self.all.each do |sharing_scope_kind|
+        if custom.exclude?(sharing_scope_kind) || has_some(sharing_scope_kind.associated_containers_for(user))
+          sharing_scope_options[sharing_scope_kind.human_name] = sharing_scope_kind.class_name
+        end
+      end
+      sharing_scope_options
+    end
+
     def initialize(class_name,user_association = nil)
       if 'Everyone' == class_name
         @class_name = ''
@@ -63,8 +89,16 @@ module ClarkKent
       when ClarkKent.user_class_name.underscore
         [ClarkKent::SharingScope.new(user,self)]
       else
-        associated_containers_for(user).map do |associated_container|
-          ClarkKent::SharingScope.new(associated_container,self)
+        if associated_containers_for(user).respond_to? :map
+          associated_containers_for(user).map do |associated_container|
+            ClarkKent::SharingScope.new(associated_container,self)
+          end
+        else
+          if associated_containers_for(user).present?
+            [ClarkKent::SharingScope.new(associated_containers_for(user),self)]
+          else
+            []
+          end
         end
       end
     end

data/app/models/clark_kent/string_filter_option.rb

@@ -0,0 +1,7 @@
+module ClarkKent
+  class StringFilterOption < ReportFilterOption
+    def filter_params
+      [param]
+    end
+  end
+end

data/app/models/clark_kent/user_report_email.rb

@@ -1,14 +1,12 @@
 module ClarkKent
 	class UserReportEmail < ActiveRecord::Base
-		belongs_to :user
+		belongs_to :user, class_name: ClarkKent.user_class_name
 		belongs_to :report_email
 
-		attr_accessible :email, :report_email_id
-
 	  validates_with UserEmailValidator
 
 		def email=(address)
-			self.user = User.where("lower(users.email) = lower(:email)",email: address).first
+			self.user = ClarkKent.user_class.where("lower(#{ClarkKent.user_class_name.underscore.pluralize}.email) = lower(:email)",email: address).first
 			self.errors.add(:email, "Couldn't find a user with that email addres") unless self.user.present?
 		end
 

data/app/views/clark_kent/report_columns/_form.html.erb

@@ -27,7 +27,7 @@
     </div>
     <div class="ih-span one-fifth">
       <% if !report_column.new_record? and report_column.summarizable? %>
-        <%= f.input :summary_method, collection: ReportColumn::SummaryMethods %>
+        <%= f.input :summary_method, collection: ClarkKent::ReportColumn::SummaryMethods %>
       <% else %>
         &nbsp;
       <% end %>

data/app/views/clark_kent/reports/_edit.html.erb

@@ -16,15 +16,19 @@
     <div class="ih-span one-quarter">
       <div class="ih-row">sharing</div>
       <div class="ih-row">
-        <%= f.input :sharing_scope_type, collection: ClarkKent::SharingScopeKind.select_options,
+        <%= f.input :sharing_scope_type, collection: ClarkKent::SharingScopeKind.select_options_for_user(current_user),
           input_html: {data: {revealer: true, sub_type: "FormFieldRevealer", revealer_children_id: "sharing_options"}},
           label: false, include_blank: false %>
       </div>
       <div class="ih-row" data-revealer-target="sharing_options">
         <%= f.input :sharing_scope_id, as: :hidden, input_html: {value: current_user.id}, wrapper_html: {'data-revealer_id' => "sharing_options", 'data-revealer-trigger' => ClarkKent.user_class_name, id: "sharing_options_#{ClarkKent.user_class_name}"} %>
-        <% ClarkKent::SharingScopeKind.custom.each do |sharing_scope_kind| %>
-          <%= f.input :sharing_scope_id, collection: sharing_scope_kind.associated_containers_for(current_user), label: false, include_blank: false,
-            wrapper_html: {'data-revealer_id' => "sharing_options", 'data-revealer-trigger' => sharing_scope_kind.class_name, id: "sharing_options_#{sharing_scope_kind.class_name}"} %>
+        <% ClarkKent::SharingScopeKind.custom_for_user(current_user).each do |sharing_scope_kind| %>
+          <% if sharing_scope_kind.associated_containers_for(current_user).respond_to? :each %>
+            <%= f.input :sharing_scope_id, collection: sharing_scope_kind.associated_containers_for(current_user), label: false, include_blank: false,
+              wrapper_html: {'data-revealer_id' => "sharing_options", 'data-revealer-trigger' => sharing_scope_kind.class_name, id: "sharing_options_#{sharing_scope_kind.class_name}"} %>
+          <% else %>
+            <%= f.input :sharing_scope_id, as: :hidden, input_html: {value: sharing_scope_kind.associated_containers_for(current_user).id}, wrapper_html: {'data-revealer_id' => "sharing_options", 'data-revealer-trigger' => sharing_scope_kind.associated_containers_for(current_user).class.name, id: "sharing_options_#{sharing_scope_kind.associated_containers_for(current_user).class.name}"} %>
+          <% end %>
         <% end %>
         <%= f.input :sharing_scope_id, as: :hidden, input_html: {value: ''},
           wrapper_html: {'data-revealer_id' => "sharing_options", 'data-revealer-trigger' => "", id: "sharing_options_"} %>

data/app/views/clark_kent/reports/show.html.erb

@@ -1,6 +1,11 @@
 <h1><%= @report.name %></h1>
 <%= link_to "&larr; back to report index".html_safe, reports_url, id: 'report_index' %>
 
+<% if @errors %>
+	<div class="error">
+		<%= @errors %>
+	</div>
+<% end %>
 <div class="ih-row margin-top">
 	<form action="<%= report_url(@report) %>" method="get">
 		<% @report.custom_filters.each do |filter| %>

data/db/migrate/20131226170042_create_clark_kent_report_filter.rb

@@ -0,0 +1,17 @@
+class CreateClarkKentReportFilter < ActiveRecord::Migration
+  def change
+    create_table :clark_kent_report_filters do |t|
+    	t.integer :filterable_id
+      t.string :filterable_type, :string, default: 'ClarkKent::Report'
+    	t.string :filter_name
+    	t.string :filter_value
+      t.string :type
+      t.string :duration
+      t.string :kind_of_day
+      t.string :offset
+      t.timestamps
+    end
+  	add_index :clark_kent_report_filters, :filterable_id
+    add_index :clark_kent_report_filters, :filterable_type
+  end
+end

data/db/migrate/20131226170112_create_clark_kent_report_column.rb

@@ -0,0 +1,12 @@
+class CreateClarkKentReportColumn < ActiveRecord::Migration
+  def change
+    create_table :clark_kent_report_columns do |t|
+    	t.integer :report_id
+    	t.string :column_name
+    	t.integer :column_order
+    	t.string :report_sort
+      t.string :summary_method
+    end
+  	add_index :clark_kent_report_columns, :report_id
+  end
+end

data/db/migrate/20140114010048_create_clark_kent_report_emails.rb

@@ -0,0 +1,9 @@
+class CreateClarkKentReportEmails < ActiveRecord::Migration
+  def change
+    create_table :clark_kent_report_emails do |t|
+    	t.integer :report_id
+    	t.string :when_to_send
+      t.string :name
+    end
+  end
+end

data/db/migrate/20140129051754_create_clark_kent_user_report_email.rb

@@ -0,0 +1,7 @@
+class CreateClarkKentUserReportEmail < ActiveRecord::Migration
+  def change
+    create_table :clark_kent_user_report_emails do |t|
+    	t.integer ClarkKent.user_class_name.underscore + '_id', :report_email_id
+    end
+  end
+end

data/db/migrate/20150304233739_create_clark_kent_reports.rb

@@ -8,5 +8,7 @@ class CreateClarkKentReports < ActiveRecord::Migration
 
       t.timestamps
     end
+    add_index :clark_kent_reports, :sharing_scope_type
+    add_index :clark_kent_reports, :sharing_scope_id
   end
 end

data/lib/clark_kent/version.rb

@@ -1,3 +1,3 @@
 module ClarkKent
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/clark_kent.rb

@@ -1,16 +1,18 @@
 require "clark_kent/engine"
+require 'simple_form'
+require 'thin_man'
 
 module ClarkKent
   mattr_accessor  :resource_options, :user_class_name, :other_sharing_scopes, :base_controller,
                   :custom_report_links
 
   def self.config(options)
-    @@resource_options = options[:resource_options]
+    @@resource_options = options[:resource_options].map{|option_hash| ClarkKent::ResourceOption.new option_hash}
     @@user_class_name = options[:user_class_name]
     @@other_sharing_scopes = options[:other_sharing_scopes]
     base_controller_name = options[:base_controller_name]
     @@base_controller = base_controller_name.constantize
-    @@custom_report_links = options[:custom_report_links]
+    @@custom_report_links = options[:custom_report_links] || []
   end
 
   def self.user_class

data/test/_print_report.html.erb_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe "manage/reports/_print_report.html.erb" do
+  it "displays the print button with the modal" do
+    rows = nil
+
+    assign(:rows, rows)
+    render partial: "manage/reports/print_report", locals: { rows: rows }
+
+    expect(rendered).to eq("")
+  end
+
+  it "displays the print button with the modal" do
+    rows = mock()
+    rows.stubs(:count).returns(50)
+    rows.stubs(:total_count).returns(51)
+    assign(:rows, rows)
+    render partial: "manage/reports/print_report", locals: { rows: rows }
+
+    expect(rendered).to have_selector("div#print_report_modal")
+  end
+
+  it "displays just the print button" do
+    rows = mock()
+    rows.stubs(:count).returns(50)
+    rows.stubs(:total_count).returns(49)
+    assign(:rows, rows)
+    render partial: "manage/reports/print_report", locals: { rows: rows }
+
+    expect(rendered).not_to have_selector("div#print_report_modal")
+  end
+end