clark_kent 0.9.2 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fae2d9e072d39d8cd9d717477ed9ecf888230b22
-  data.tar.gz: 666e6483c2a7ff766b5aed1d2d6bf962d3734958
+  metadata.gz: cff67d05d931728a4d59a4a6fda5228dbd06eeff
+  data.tar.gz: b9d6e364e1cdd574c34f995b1a9434847886a476
 SHA512:
-  metadata.gz: 4702f55ad2e1dc631f7eb53cb6dfb37f32d757958843aad7b22f68dcdf90959da3bc401defbb2e6242b2b0ca8cc701aa8611edd516a351a8e0f6f948d9ca29c6
-  data.tar.gz: a1488c26ef2c42e4c49f7fd7b3b32d176fedb6487b82131f21b18a9f1ce8430f5c88e3c93e804b236fd217943ed4c54df5542b1345625af4361a7c6456ed267e
+  metadata.gz: f50b2f886b9d98d75cf32a5d854d3e2460173655834233764c80252504d8d217280fe8139cce95eb2b49bac5fd5893cc9759aa2da0f3461220db67a88bf9fc9e
+  data.tar.gz: 00600cad919cf0694d33cbd53e8ac4922078176c55279f3dd494c9edbb2a99b58cfc3a1a73a0f34d4dd28f383555f15e69b56f2d6f408c859cacc1a3e65281c2

data/app/models/clark_kent/report.rb

@@ -177,11 +177,11 @@ require 'aws-sdk-v1'
     end
 
     def filter_options_for(filter_name)
-      self.resource_class::REPORT_FILTER_OPTIONS.detect{|filter| filter.param == filter_name}
+      self.resource_class.report_filter_options.detect{|filter| filter.param == filter_name}
     end
 
     def column_options
-      @column_options ||= self.resource_class::REPORT_COLUMN_OPTIONS
+      @column_options ||= self.resource_class.report_column_options
     end
 
     def column_options_for(column_name)
@@ -200,7 +200,7 @@ require 'aws-sdk-v1'
     end
 
     def date_filter_names
-      self.resource_class::REPORT_FILTER_OPTIONS.select{|filter| 'date_filter' == filter.kind}.map{|filter| filter.param}
+      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
@@ -210,23 +210,23 @@ require 'aws-sdk-v1'
     end
 
     def available_filter_options
-      self.available_filters.map{|id| [self.filter_options_for(id).label,id]}
+      self.available_filters.map{|filter_name| [self.filter_options_for(filter_name).label,filter_name]}
     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| (viable_report_filters.map(&:filter_name)).include? name}
+      self.resource_class.report_definition_options.reject{|name| (viable_report_filters.map(&:filter_name)).include? name}
     end
 
     def collection_for(filter_name)
-      self.resource_class::REPORT_FILTER_OPTIONS.detect{|filter| filter.param == filter_name}.collection
+      self.filter_options_for(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| viable_report_filters.map(&:filter_name).exclude? filter.param}
+      self.resource_class.report_filter_options.select{|filter| viable_report_filters.map(&: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
@@ -253,7 +253,7 @@ require 'aws-sdk-v1'
     end
 
     def get_filter_class(params)
-      filter_option = self.resource_class::REPORT_FILTER_OPTIONS.detect{|filter| filter.param == params[:filter_name]}
+      filter_option = self.resource_class.report_filter_options.detect{|filter| filter.param == params[:filter_name]}
       "ClarkKent::Report#{filter_option.kind.camelcase}".constantize
     end
 

data/app/models/clark_kent/report_config.rb

@@ -1,19 +1,15 @@
 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
+    include ClarkKent::Reportable
+    def filter_config(params)
+      filter_option_class = ('ClarkKent::' + ((params[:kind] + '_option').camelcase)).constantize
+      filter_option_class.new(params)
     end
-    extend ClassMethods
-    def self.included( other )
-      other.extend( ClassMethods )
+
+    def column_config(params)
+      ClarkKent::ReportColumnConfig.new(params)
     end
+
   end
   class ReportColumnConfig
     attr_accessor :name, :order_sql, :custom_select, :link, :time_zone_column, :time_format, :summarizable, :includes, :joins, :extra_scopes, :where, :group

data/app/models/clark_kent/report_email.rb

@@ -86,7 +86,7 @@ module ClarkKent
     end
 
     def available_email_filters
-      self.resource_class::REPORT_DEFINITION_OPTIONS.reject{|name, label| (self.viable_report_filters.pluck(:filter_name) + self.report.viable_report_filters.pluck(:filter_name)).include? name}
+      self.resource_class.report_definition_options.reject{|name, label| (self.viable_report_filters.pluck(:filter_name) + self.report.viable_report_filters.pluck(:filter_name)).include? name}
     end
 
     def available_filters

data/app/models/clark_kent/reportable.rb

@@ -1,182 +1,174 @@
 module ClarkKent
 	module Reportable
-    def self.included(base)
-      base.extend ClassMethods
+    def chain_up(query, params)
+      params.each do |key,val|
+        arel_method_name = self.arel_method_for(key)
+        if arel_method_name.present? and self.respond_to? arel_method_name and val.present?
+          query = self.send(arel_method_name, query, key, val)
+        end
+      end
+      query = query.distinct if params[:distinct]
+      query
     end
 
-	  module ClassMethods
-
-	    def chain_up(query, params)
-	      params.each do |key,val|
-	        arel_method_name = self.arel_method_for(key)
-	        if arel_method_name.present? and self.respond_to? arel_method_name and val.present?
-	          query = self.send(arel_method_name, query, key, val)
-	        end
-	      end
-	      query = query.distinct if params[:distinct]
-	      query
-	    end
+    def required_date_params
+    	self.report_filter_options.select{|rfo| rfo.in_required_date_group}.map{|rfo| rfo.filter_params}.flatten.map(&:to_sym)
+    end
 
-	    def required_date_params
-	    	self::REPORT_FILTER_OPTIONS.select{|rfo| rfo.in_required_date_group}.map{|rfo| rfo.filter_params}.flatten.map(&:to_sym)
-	    end
+    def validate_params(params,report)
+    	if required_date_params.any?
+    		missing_params = required_date_params - params.select{|k,v| v.present? }.symbolize_keys.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 validate_params(params,report)
-	    	if required_date_params.any?
-	    		missing_params = required_date_params - params.select{|k,v| v.present? }.symbolize_keys.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
+	  def report(params,report,count = false)
+	  	@selects = []
+	  	@includes = []
+	  	@joins = []
+	  	@extra_scopes = []
+	  	@extra_filters = []
+	  	@groups = []
+	  	if 'ClarkKent::ReportEmail' == report.class.name
+	  		@report_email = report
+	  		report = @report_email.report
+	  	end
+	  	if count == false
+				report.select_clauses.each do |select_clause|
+					@selects.push select_clause
 			  end
+			end
+	    report.arel_includes.each do |arel_include|
+	    	@includes.push arel_include
 	    end
-
-		  def report(params,report,count = false)
-		  	@selects = []
-		  	@includes = []
-		  	@joins = []
-		  	@extra_scopes = []
-		  	@extra_filters = []
-		  	@groups = []
-		  	if 'ClarkKent::ReportEmail' == report.class.name
-		  		@report_email = report
-		  		report = @report_email.report
-		  	end
-		  	if count == false
-					report.select_clauses.each do |select_clause|
-						@selects.push select_clause
-				  end
-				end
-		    report.arel_includes.each do |arel_include|
-		    	@includes.push arel_include
-		    end
-		    report.arel_joins.each do |arel_join|
-		    	@joins.push arel_join
-		    end
-		    report.extra_scopes.each do |extra_scope|
-		    	@extra_scopes.push extra_scope
-		    end
-		    report.extra_filters.each do |extra_filter|
-		    	@extra_filters.push extra_filter
-		    end
-		    report.groups.each do |grouper|
-		    	@groups.push grouper
-		    end
-		    query = self.all
-		    if @report_email and @report_email.is_a? ClarkKent::ReportEmail
-					params = @report_email.report_filter_params.symbolize_keys!.merge(params.symbolize_keys)
-		    else
-					params = report.report_filter_params.symbolize_keys!.merge(params.symbolize_keys)
-				end
-		  	validate_params(params, report)
-		    params.each do |param_type,param_value|
-		      if param_value.present?
-	          arel_method_name = self.arel_method_for(param_type)
-		        if arel_method_name.present?
-		          query = self.send(arel_method_name, query, param_type, param_value)
-		          if report_column_options = column_options_for(param_type)
-			          if(report_column_options.joins.present?) && (@joins.exclude? report_column_options.joins)
-			          	@joins.push report_column_options.joins
-			          end
-								if(report_column_options.includes.present?) && (@includes.exclude? report_column_options.includes)
-									@includes.push report_column_options.includes
-			          end
-			          if (count == false) && (report_column_options.custom_select.present?) && (@selects.exclude? report_column_options.custom_select)
-			          	@selects.push report_column_options.custom_select
-			          end
-			        end
+	    report.arel_joins.each do |arel_join|
+	    	@joins.push arel_join
+	    end
+	    report.extra_scopes.each do |extra_scope|
+	    	@extra_scopes.push extra_scope
+	    end
+	    report.extra_filters.each do |extra_filter|
+	    	@extra_filters.push extra_filter
+	    end
+	    report.groups.each do |grouper|
+	    	@groups.push grouper
+	    end
+	    query = self.all
+	    if @report_email and @report_email.is_a? ClarkKent::ReportEmail
+				params = @report_email.report_filter_params.symbolize_keys!.merge(params.symbolize_keys)
+	    else
+				params = report.report_filter_params.symbolize_keys!.merge(params.symbolize_keys)
+			end
+	  	validate_params(params, report)
+	    params.each do |param_type,param_value|
+	      if param_value.present?
+          arel_method_name = self.arel_method_for(param_type)
+	        if arel_method_name.present?
+	          query = self.send(arel_method_name, query, param_type, param_value)
+	          if report_column_options = column_options_for(param_type)
+		          if(report_column_options.joins.present?) && (@joins.exclude? report_column_options.joins)
+		          	@joins.push report_column_options.joins
+		          end
+							if(report_column_options.includes.present?) && (@includes.exclude? report_column_options.includes)
+								@includes.push report_column_options.includes
+		          end
+		          if (count == false) && (report_column_options.custom_select.present?) && (@selects.exclude? report_column_options.custom_select)
+		          	@selects.push report_column_options.custom_select
+		          end
 		        end
-		      end
+	        end
+	      end
+	    end
+	    if @selects.any?
+	    	query = query.select("DISTINCT " + self.column_names.map{|cn| self.table_name + '.' + cn}.join(', '))
+	    	@selects.uniq.each do |selectable|
+		    	query = query.select(selectable)
 		    end
-		    if @selects.any?
-		    	query = query.select("DISTINCT " + self.column_names.map{|cn| self.table_name + '.' + cn}.join(', '))
-		    	@selects.uniq.each do |selectable|
-			    	query = query.select(selectable)
-			    end
-			  end
-			  if self.respond_to? :clark_kent_required_filters
-			  	query = self.send(:clark_kent_required_filters, query)
-			  end
-	    	@includes.uniq.each do |includeable|
-		    	query = query.includes(includeable)
-		    end if @includes.any?
-	    	@extra_scopes.uniq.each do |extra_scope|
-		    	query = query.send(extra_scope)
-		    end if @extra_scopes.any?
-	    	@extra_filters.uniq.each do |extra_filter|
-		    	query = query.where(extra_filter)
-		    end if @extra_filters.any?
-	    	@joins.uniq.each do |joinable|
-		    	query = query.joins(joinable).uniq
-		    end if @joins.any?
-	    	@groups.uniq.each do |grouper|
-		    	query = query.group(grouper)
-		    end if @groups.any?
-		    if count == true
-		    	return query.count
-				else
-					return query
-				end
-
 		  end
-
-		  def column_options_for(column_name)
-				self::REPORT_COLUMN_OPTIONS.detect{|co| column_name == co.name}
+		  if self.respond_to? :clark_kent_required_filters
+		  	query = self.send(:clark_kent_required_filters, query)
 		  end
+    	@includes.uniq.each do |includeable|
+	    	query = query.includes(includeable)
+	    end if @includes.any?
+    	@extra_scopes.uniq.each do |extra_scope|
+	    	query = query.send(extra_scope)
+	    end if @extra_scopes.any?
+    	@extra_filters.uniq.each do |extra_filter|
+	    	query = query.where(extra_filter)
+	    end if @extra_filters.any?
+    	@joins.uniq.each do |joinable|
+	    	query = query.joins(joinable).uniq
+	    end if @joins.any?
+    	@groups.uniq.each do |grouper|
+	    	query = query.group(grouper)
+	    end if @groups.any?
+	    if count == true
+	    	return query.count
+			else
+				return query
+			end
 
-		  def arel_method_for(param_type)
-		    method_name = self::AREL_METHODS[param_type.to_s]
-		    method_name ||= "#{param_type}_arel" if self.respond_to? "#{param_type}_arel"
-		    method_name
-		  end
+	  end
 
-		  def simple_equality_arel(query, field_name, match_value)
-		    query.
-		    where(field_name.to_sym => match_value)
-		  end
+	  def column_options_for(column_name)
+			self.report_column_options.detect{|co| column_name == co.name}
+	  end
 
-		  def before_date_arel(query, field_name, match_value)
-		  	query.
-		  	where("#{self.table_name}.#{field_name.to_s.sub(/_until/,'')} <= :date_limit", date_limit: match_value)
-		  end
+	  def arel_method_for(param_type)
+	    method_name = self.arel_methods[param_type.to_s]
+	    method_name ||= "#{param_type}_arel" if self.respond_to? "#{param_type}_arel"
+	    method_name
+	  end
 
-		  def after_date_arel(query, field_name, match_value)
-		  	query.
-		  	where("#{self.table_name}.#{field_name.to_s.sub(/_from/,'')} >= :date_limit", date_limit: match_value)
-		  end
+	  def simple_equality_arel(query, field_name, match_value)
+	    query.
+	    where(field_name.to_sym => 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 before_date_arel(query, field_name, match_value)
+	  	query.
+	  	where("#{self.table_name}.#{field_name.to_s.sub(/_until/,'')} <= :date_limit", date_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 after_date_arel(query, field_name, match_value)
+	  	query.
+	  	where("#{self.table_name}.#{field_name.to_s.sub(/_from/,'')} >= :date_limit", date_limit: match_value)
+	  end
 
-		  def order_arel(query, field_name, match_value)
-		  	if match_value.is_a? ClarkKent::ReportSort
-			  	order_column = match_value.order_column
-			  	order_direction = match_value.order_direction
-			  else
-			  	order_column, order_direction = match_value.split('-')
-			  end
-				column_info = column_options_for(order_column.to_sym)
-				if column_info.respond_to?(:order_sql) && column_info.order_sql.present?
-				  order_sql = column_info.order_sql
-			  	order_sql = "#{order_sql} #{order_direction}"
-			  	query = query.order(order_sql)
-			  	if column_info.respond_to? :includes
-			  		order_includes = column_info.includes
-		  			query = query.includes(order_includes).references(order_includes)
-		  		end
-		  		query
-			  else
-			  	query
-			  end
-		  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
 
-		end
+	  def order_arel(query, field_name, match_value)
+	  	if match_value.is_a? ClarkKent::ReportSort
+		  	order_column = match_value.order_column
+		  	order_direction = match_value.order_direction
+		  else
+		  	order_column, order_direction = match_value.split('-')
+		  end
+			column_info = column_options_for(order_column.to_sym)
+			if column_info.respond_to?(:order_sql) && column_info.order_sql.present?
+			  order_sql = column_info.order_sql
+		  	order_sql = "#{order_sql} #{order_direction}"
+		  	query = query.order(order_sql)
+		  	if column_info.respond_to? :includes
+		  		order_includes = column_info.includes
+	  			query = query.includes(order_includes).references(order_includes)
+	  		end
+	  		query
+		  else
+		  	query
+		  end
+	  end
 	end
 end

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

@@ -18,8 +18,6 @@
           label: false, include_blank: false %>
       </div>
       <div class="ih-row" <%= revealer_target_attrs("sharing_options") %>>
-            <%= ClarkKent.user_class_name %>
-
         <%= f.input :sharing_scope_id, as: :hidden, input_html: {value: current_user.id, data: {foo: ClarkKent.user_class_name}}, wrapper_html: revealer_option("sharing_options", trigger: ClarkKent.user_class_name).merge(id: "sharing_options_#{ClarkKent.user_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 %>