Method: Wice::WiceGrid#initialize

Defined in:
lib/wice_grid.rb

#initialize(klass_or_relation, controller, opts = {}) ⇒ WiceGrid

core workflow methods START

Raises:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/wice_grid.rb', line 77

def initialize(klass_or_relation, controller, opts = {})  #:nodoc:
  @controller = controller

  @relation = klass_or_relation
  @klass = if @relation.is_a?(Class) && @relation.ancestors.index(ActiveRecord::Base)
    klass_or_relation
  else
    klass_or_relation.klass
  end

  unless @klass.is_a?(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] = opts[:order_direction].downcase if opts[:order_direction].is_a?(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

  begin
    # options that are understood
    @options = {
      conditions:                 nil,
      csv_file_name:              nil,
      csv_field_separator: ConfigurationProvider.value_for(:CSV_FIELD_SEPARATOR),
      csv_encoding:               ConfigurationProvider.value_for(:CSV_ENCODING),
      custom_order:               {},
      enable_export_to_csv: ConfigurationProvider.value_for(:ENABLE_EXPORT_TO_CSV),
      group:                      nil,
      include:                    nil,
      joins:                      nil,
      name:                       ConfigurationProvider.value_for(:GRID_NAME),
      order:                      nil,
      order_direction:            ConfigurationProvider.value_for(:ORDER_DIRECTION),
      page:                       1,
      page_method_name:           ConfigurationProvider.value_for(:PAGE_METHOD_NAME),
      per_page:                   ConfigurationProvider.value_for(:PER_PAGE),
      saved_query:                nil,
      with_paginated_resultset:   nil,
      with_resultset:             nil,
      use_default_scope:          ConfigurationProvider.value_for(:USE_DEFAULT_SCOPE)
    }
  rescue NameError
    raise NameError.new('A constant is missing in wice_grid_config.rb: ' + $ERROR_INFO.message +
      '. This can happen when you upgrade the WiceGrid to a newer version with a new configuration constant. ' \
      'Add the constant manually or re-run `bundle exec rails g wice_grid:install`.')
  end
  # 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]
  @csv_encoding = @options[:csv_encoding]

  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[:per_page]      = @options[:per_page]
  @status[:page]          = @options[:page]
  @status[:conditions]    = @options[:conditions]
  @status[:f]             = @options[:f]

  fix_facebook_bug
  process_loading_query
  process_params

  @ar_options_formed = false
end