# encoding: UTF-8 require 'wice/wice_grid_misc.rb' require 'wice/wice_grid_core_ext.rb' require 'wice/grid_renderer.rb' require 'wice/table_column_matrix.rb' require 'wice/active_record_column_wrapper.rb' require 'wice/helpers/wice_grid_view_helpers.rb' require 'wice/helpers/wice_grid_misc_view_helpers.rb' require 'wice/helpers/wice_grid_serialized_queries_view_helpers.rb' require 'wice/helpers/wice_grid_view_helpers.rb' require 'wice/helpers/js_calendar_helpers.rb' require 'wice/grid_output_buffer.rb' require 'wice/wice_grid_controller.rb' require 'wice/wice_grid_spreadsheet.rb' require 'wice/wice_grid_serialized_queries_controller.rb' require 'wice/columns/column_processor_index.rb' require 'wice/columns.rb' require 'kaminari.rb' ActionController::Base.send(:helper_method, :wice_grid_custom_filter_params) module Wice class WiceGridEngine < ::Rails::Engine #:nodoc: initializer "wice_grid_railtie.configure_rails_initialization" do |app| ActiveSupport.on_load :action_controller do ActionController::Base.send(:include, Wice::Controller) end ActiveSupport.on_load :active_record do ActiveRecord::ConnectionAdapters::Column.send(:include, ::Wice::WiceGridExtentionToActiveRecordColumn) ActiveRecord::Base.send(:include, ::Wice::MergeConditions) end ActiveSupport.on_load :action_view do ::ActionView::Base.class_eval { include Wice::GridViewHelper } [ActionView::Helpers::AssetTagHelper, ActionView::Helpers::TagHelper, ActionView::Helpers::JavaScriptHelper, ActionView::Helpers::FormTagHelper].each do |m| JsCalendarHelpers.send(:include, m) end Columns.load_column_processors require 'wice/wice_grid_serialized_query.rb' # It is here only until this pull request is pulled: https://github.com/amatsuda/kaminari/pull/267 require 'wice/kaminari_monkey_patching.rb' end end end class WiceGrid attr_reader :klass, :name, :resultset, :custom_order, :query_store_model #:nodoc: attr_reader :ar_options, :status, :export_to_csv_enabled, :csv_file_name, :csv_field_separator, :saved_query #:nodoc: attr_writer :renderer #:nodoc: attr_accessor :output_buffer, :view_helper_finished, :csv_tempfile #:nodoc: # core workflow methods START def initialize(klass_or_relation, controller, opts = {}) #:nodoc: @controller = controller @relation = klass_or_relation @klass = klass_or_relation.is_a?(ActiveRecord::Relation) ? klass_or_relation.klass : klass_or_relation unless @klass.kind_of?(Class) && @klass.ancestors.index(ActiveRecord::Base) raise WiceGridArgumentError.new("ActiveRecord model class (second argument) must be a Class derived from ActiveRecord::Base") end # validate :with_resultset & :with_paginated_resultset [:with_resultset, :with_paginated_resultset].each do |callback_symbol| unless [NilClass, Symbol, Proc].index(opts[callback_symbol].class) raise WiceGridArgumentError.new(":#{callback_symbol} must be either a Proc or Symbol object") end end opts[:order_direction].downcase! if opts[:order_direction].kind_of?(String) # validate :order_direction if opts[:order_direction] && ! (opts[:order_direction] == 'asc' || opts[:order_direction] == :asc || opts[:order_direction] == 'desc' || opts[:order_direction] == :desc) raise WiceGridArgumentError.new(":order_direction must be either 'asc' or 'desc'.") end # options that are understood @options = { :conditions => nil, :csv_file_name => nil, :csv_field_separator => Defaults::CSV_FIELD_SEPARATOR, :custom_order => {}, :enable_export_to_csv => Defaults::ENABLE_EXPORT_TO_CSV, :group => nil, :include => nil, :joins => nil, :name => Defaults::GRID_NAME, :order => nil, :order_direction => Defaults::ORDER_DIRECTION, :page => 1, :per_page => Defaults::PER_PAGE, :saved_query => nil, :total_entries => nil, :with_paginated_resultset => nil, :with_resultset => nil } # validate parameters opts.assert_valid_keys(@options.keys) @options.merge!(opts) @export_to_csv_enabled = @options[:enable_export_to_csv] @csv_file_name = @options[:csv_file_name] @csv_field_separator = @options[:csv_field_separator] case @name = @options[:name] when String when Symbol @name = @name.to_s else raise WiceGridArgumentError.new("name of the grid should be a string or a symbol") end raise WiceGridArgumentError.new("name of the grid can only contain alphanumeruc characters") unless @name =~ /^[a-zA-Z\d_]*$/ @table_column_matrix = TableColumnMatrix.new @table_column_matrix.default_model_class = @klass @ar_options = {} @status = HashWithIndifferentAccess.new if @options[:order] @options[:order] = @options[:order].to_s @options[:order_direction] = @options[:order_direction].to_s @status[:order_direction] = @options[:order_direction] @status[:order] = @options[:order] end @status[:total_entries] = @options[:total_entries] @status[:per_page] = @options[:per_page] @status[:page] = @options[:page] @status[:conditions] = @options[:conditions] @status[:f] = @options[:f] process_loading_query process_params @ar_options_formed = false end # A block executed from within the plugin to process records of the current page. # The argument to the callback is the array of the records. See the README for more details. def with_paginated_resultset(&callback) @options[:with_paginated_resultset] = callback end # A block executed from within the plugin to process all records browsable through # all pages with the current filters. The argument to # the callback is a lambda object which returns the list of records when called. See the README for the explanation. def with_resultset(&callback) @options[:with_resultset] = callback end def process_loading_query #:nodoc: @saved_query = nil if params[name] && params[name][:q] @saved_query = load_query(params[name][:q]) params[name].delete(:q) elsif @options[:saved_query] if @options[:saved_query].is_a? ActiveRecord::Base @saved_query = @options[:saved_query] else @saved_query = load_query(@options[:saved_query]) end else return end unless @saved_query.nil? params[name] = HashWithIndifferentAccess.new if params[name].blank? [:f, :order, :order_direction].each do |key| if @saved_query.query[key].blank? params[name].delete(key) else params[name][key] = @saved_query.query[key] end end end end def process_params #:nodoc: if this_grid_params @status.merge!(this_grid_params) @status.delete(:export) unless self.export_to_csv_enabled end end def declare_column(column_name, model, custom_filter_active, table_alias, filter_type) #:nodoc: if model # this is an included table column = @table_column_matrix.get_column_by_model_class_and_column_name(model, column_name) raise WiceGridArgumentError.new("Column '#{column_name}' is not found in table '#{model.table_name}'!") if column.nil? main_table = false table_name = model.table_name else column = @table_column_matrix.get_column_in_default_model_class_by_column_name(column_name) if column.nil? raise WiceGridArgumentError.new("Column '#{column_name}' is not found in table '#{@klass.table_name}'! " + "If '#{column_name}' belongs to another table you should declare it in :include or :join when initialising " + "the grid, and specify :model in column declaration.") end main_table = true table_name = @table_column_matrix.default_model_class.table_name end if column conditions_generator = ActiveRecordColumnWrapper.new(column, @status[:f], main_table, table_alias, custom_filter_active, filter_type) conditions, current_parameter_name = conditions_generator.wg_initialize_request_parameters if @status[:f] && conditions.blank? @status[:f].delete(current_parameter_name) end @table_column_matrix.add_condition(column, conditions) [column, table_name , main_table] else nil end end def form_ar_options(opts = {}) #:nodoc: return if @ar_options_formed @ar_options_formed = true unless opts[:forget_generated_options] # validate @status[:order_direction] @status[:order_direction] = case @status[:order_direction] when /desc/i 'desc' when /asc/i 'asc' else '' end # conditions if @table_column_matrix.generated_conditions.size == 0 @status.delete(:f) end @ar_options[:conditions] = klass.send(:merge_conditions, @status[:conditions], * @table_column_matrix.conditions ) # conditions processed if (! opts[:skip_ordering]) && @status[:order] @ar_options[:order] = add_custom_order_sql(complete_column_name(@status[:order])) @ar_options[:order] += ' ' + @status[:order_direction] end @ar_options[:joins] = @options[:joins] @ar_options[:include] = @options[:include] @ar_options[:group] = @options[:group] if self.output_html? @ar_options[:per_page] = @status[:per_page] @ar_options[:page] = @status[:page] @ar_options[:total_entries] = @status[:total_entries] if @status[:total_entries] end end # TO DO: what to do with other @ar_options values? def read #:nodoc: form_ar_options @klass.unscoped do @resultset = if self.output_csv? || all_record_mode? # @relation.find(:all, @ar_options) @relation. includes(@ar_options[:include]). joins( @ar_options[:joins]). order( @ar_options[:order]). where( @ar_options[:conditions]) else # p @ar_options @relation. page( @ar_options[:page]). per( @ar_options[:per_page]). includes(@ar_options[:include]). joins( @ar_options[:joins]). order( @ar_options[:order]). where( @ar_options[:conditions]) end end invoke_resultset_callbacks end # core workflow methods END # Getters def filter_params(view_column) #:nodoc: column_name = view_column.attribute_name_fully_qualified_for_all_but_main_table_columns if @status[:f] && @status[:f][column_name] @status[:f][column_name] else {} end end def resultset #:nodoc: self.read unless @resultset # database querying is late! @resultset end def each #:nodoc: self.read unless @resultset # database querying is late! @resultset.each do |r| yield r end end def ordered_by?(column) #:nodoc: return nil if @status[:order].blank? if column.main_table && ! offs = @status[:order].index('.') @status[:order] == column.attribute else @status[:order] == column.table_alias_or_table_name + '.' + column.attribute end end def ordered_by #:nodoc: @status[:order] end def order_direction #:nodoc: @status[:order_direction] end def filtering_on? #:nodoc: not @status[:f].blank? end def filtered_by #:nodoc: @status[:f].nil? ? [] : @status[:f].keys end def filtered_by?(view_column) #:nodoc: @status[:f].nil? ? false : @status[:f].has_key?(view_column.attribute_name_fully_qualified_for_all_but_main_table_columns) end def get_state_as_parameter_value_pairs(including_saved_query_request = false) #:nodoc: res = [] unless status[:f].blank? Wice::WgHash.parameter_names_and_values(status[:f], [name, 'f']).collect do |param_name, value| if value.is_a?(Array) param_name_ar = param_name + '[]' value.each do |v| res << [param_name_ar, v] end else res << [param_name, value] end end end if including_saved_query_request && @saved_query res << ["#{name}[q]", @saved_query.id ] end [:order, :order_direction].select{|parameter| status[parameter] }.collect do |parameter| res << ["#{name}[#{parameter}]", status[parameter] ] end res end def count #:nodoc: form_ar_options(:skip_ordering => true, :forget_generated_options => true) @relation.count(:conditions => @ar_options[:conditions], :joins => @ar_options[:joins], :include => @ar_options[:include], :group => @ar_options[:group]) end alias_method :size, :count def empty? #:nodoc: self.count == 0 end # with this variant we get even those values which do not appear in the resultset def distinct_values_for_column(column) #:nodoc: res = column.model.select("distinct #{column.name}").order("#{column.name} asc").collect{|ar| ar[column.name] }.reject{|e| e.blank?}.map{|i|[i,i]} end def distinct_values_for_column_in_resultset(messages) #:nodoc: uniq_vals = Set.new resultset_without_paging_without_user_filters.each do |ar| v = ar.deep_send(*messages) uniq_vals << v unless v.nil? end return uniq_vals.to_a.map{|i| if i.is_a?(Array) && i.size == 2 i elsif i.is_a?(Hash) && i.size == 1 i.to_a.flatten else [i,i] end }.sort{|a,b| a[0]<=>b[0]} end def output_csv? #:nodoc: @status[:export] == 'csv' end def output_html? #:nodoc: @status[:export].blank? end def all_record_mode? #:nodoc: @status[:pp] end def dump_status #:nodoc: " params: #{params[name].inspect}\n" + " status: #{@status.inspect}\n" + " ar_options #{@ar_options.inspect}\n" end # Returns the list of objects browsable through all pages with the current filters. # Should only be called after the +grid+ helper. def all_pages_records raise WiceGridException.new("all_pages_records can only be called only after the grid view helper") unless self.view_helper_finished resultset_without_paging_with_user_filters end # Returns the list of objects displayed on current page. Should only be called after the +grid+ helper. def current_page_records raise WiceGridException.new("current_page_records can only be called only after the grid view helper") unless self.view_helper_finished @resultset end protected def invoke_resultset_callback(callback, argument) #:nodoc: case callback when Proc callback.call(argument) when Symbol @controller.send(callback, argument) end end def invoke_resultset_callbacks #:nodoc: invoke_resultset_callback(@options[:with_paginated_resultset], @resultset) invoke_resultset_callback(@options[:with_resultset], self.active_relation_for_resultset_without_paging_with_user_filters) end def add_custom_order_sql(fully_qualified_column_name) #:nodoc: custom_order = if @options[:custom_order].has_key?(fully_qualified_column_name) @options[:custom_order][fully_qualified_column_name] else if view_column = @renderer[fully_qualified_column_name] view_column.custom_order else nil end end if custom_order.blank? if ActiveRecord::ConnectionAdapters.const_defined?(:SQLite3Adapter) && ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::SQLite3Adapter) fully_qualified_column_name.strip.split('.').map{|chunk| ActiveRecord::Base.connection.quote_table_name(chunk)}.join('.') else ActiveRecord::Base.connection.quote_table_name(fully_qualified_column_name.strip) end else if custom_order.is_a? String custom_order.gsub(/\?/, fully_qualified_column_name) elsif custom_order.is_a? Proc custom_order.call(fully_qualified_column_name) else raise WiceGridArgumentError.new("invalid custom order #{custom_order.inspect}") end end end def complete_column_name(col_name) #:nodoc: if col_name.index('.') # already has a table name col_name else # add the default table "#{@klass.table_name}.#{col_name}" end end def params #:nodoc: @controller.params end def this_grid_params #:nodoc: params[name] end def resultset_without_paging_without_user_filters #:nodoc: form_ar_options @klass.unscoped do @relation.joins(@ar_options[:joins]). includes(@ar_options[:include]). group(@ar_options[:group]). where(@options[:conditions]) end end # not used right now # def count_resultset_without_paging_without_user_filters #:nodoc: # form_ar_options # @klass.unscoped do # @relation.count( # :joins => @ar_options[:joins], # :include => @ar_options[:include], # :group => @ar_options[:group], # :conditions => @options[:conditions] # ) # end # end def resultset_without_paging_with_user_filters #:nodoc: @klass.unscoped do active_relation_for_resultset_without_paging_with_user_filters.all end end def active_relation_for_resultset_without_paging_with_user_filters #:nodoc: form_ar_options relation = nil @klass.unscoped do relation = @relation. where(@ar_options[:conditions]). joins(@ar_options[:joins]). includes(@ar_options[:include]). order(@ar_options[:order]) end relation end def load_query(query_id) #:nodoc: @query_store_model ||= Wice::get_query_store_model query = @query_store_model.find_by_id_and_grid_name(query_id, self.name) Wice::log("Query with id #{query_id} for grid '#{self.name}' not found!!!") if query.nil? query end end # routines called from WiceGridExtentionToActiveRecordColumn (ActiveRecord::ConnectionAdapters::Column) or ConditionsGeneratorColumn classes module GridTools #:nodoc: class << self def special_value(str) #:nodoc: str =~ /^\s*(not\s+)?null\s*$/i end # create a Time instance out of parameters def params_2_datetime(par) #:nodoc: return nil if par.blank? params = [par[:year], par[:month], par[:day], par[:hour], par[:minute]].collect{|v| v.blank? ? nil : v.to_i} begin Time.local(*params) rescue ArgumentError, TypeError nil end end # create a Date instance out of parameters def params_2_date(par) #:nodoc: return nil if par.blank? params = [par[:year], par[:month], par[:day]].collect{|v| v.blank? ? nil : v.to_i} begin Date.civil(*params) rescue ArgumentError, TypeError nil end end end end end