Class: Datagrid::Filters::BaseFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/datagrid/filters/base_filter.rb

Overview

:nodoc:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(grid_class, name, options = {}, &block) ⇒ BaseFilter

Returns a new instance of BaseFilter.



8
9
10
11
12
13
 
# File 'lib/datagrid/filters/base_filter.rb', line 8

def initialize(grid_class, name, options = {}, &block)
  self.grid_class = grid_class
  self.name = name
  self.options = options
  self.block = block || default_filter_block
end

Instance Attribute Details

#block ⇒ Object

Returns the value of attribute block.



6
7
8
 
# File 'lib/datagrid/filters/base_filter.rb', line 6

def block
  @block
end

#grid_class ⇒ Object

Returns the value of attribute grid_class.



6
7
8
 
# File 'lib/datagrid/filters/base_filter.rb', line 6

def grid_class
  @grid_class
end

#name ⇒ Object

Returns the value of attribute name.



6
7
8
 
# File 'lib/datagrid/filters/base_filter.rb', line 6

def name
  @name
end

#options ⇒ Object

Returns the value of attribute options.



6
7
8
 
# File 'lib/datagrid/filters/base_filter.rb', line 6

def options
  @options
end

Class Method Details

.form_builder_helper_name ⇒ Object 



82
83
84
 
# File 'lib/datagrid/filters/base_filter.rb', line 82

def self.form_builder_helper_name
  :"datagrid_#{self.to_s.demodulize.underscore}"
end

Instance Method Details

#allow_blank? ⇒ Boolean

Returns:

  • (Boolean) 


74
75
76
 
# File 'lib/datagrid/filters/base_filter.rb', line 74

def allow_blank?
  options[:allow_blank]
end

#allow_nil? ⇒ Boolean

Returns:

  • (Boolean) 


70
71
72
 
# File 'lib/datagrid/filters/base_filter.rb', line 70

def allow_nil?
  options.has_key?(:allow_nil) ? options[:allow_nil] : options[:allow_blank]
end

#apply(grid_object, scope, value) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/datagrid/filters/base_filter.rb', line 23

def apply(grid_object, scope, value)
  return scope if unapplicable_value?(value)

  result = execute(value, scope, grid_object)
  return scope unless result
  unless grid_object.driver.match?(result)
    raise Datagrid::FilteringError, "Can not apply #{name.inspect} filter: result #{result.inspect} no longer match #{grid_object.driver.class}."
  end
  result
end

#default ⇒ Object 



56
57
58
59
 
# File 'lib/datagrid/filters/base_filter.rb', line 56

def default
  default = self.options[:default]
  default.respond_to?(:call) ? default.call : default
end

#default_filter(value, scope, grid) ⇒ Object 



93
94
95
96
97
98
99
100
101
 
# File 'lib/datagrid/filters/base_filter.rb', line 93

def default_filter(value, scope, grid)
  return nil if dummy?
  driver = grid.driver
  if !driver.has_column?(scope, name) && driver.to_scope(scope).respond_to?(name)
    driver.to_scope(scope).send(name, value)
  else
    default_filter_where(driver, scope, value)
  end
end

#default_filter_block ⇒ Object 



86
87
88
89
90
91
 
# File 'lib/datagrid/filters/base_filter.rb', line 86

def default_filter_block
  filter = self
  lambda do |value, scope, grid|
    filter.default_filter(value, scope, grid)
  end
end

#dummy? ⇒ Boolean

Returns:

  • (Boolean) 


107
108
109
 
# File 'lib/datagrid/filters/base_filter.rb', line 107

def dummy?
  options[:dummy]
end

#form_builder_helper_name ⇒ Object 



78
79
80
 
# File 'lib/datagrid/filters/base_filter.rb', line 78

def form_builder_helper_name
  self.class.form_builder_helper_name
end

#format(value) ⇒ Object 



103
104
105
 
# File 'lib/datagrid/filters/base_filter.rb', line 103

def format(value)
  value.nil? ? nil : value.to_s
end

#header ⇒ Object 



51
52
53
54
 
# File 'lib/datagrid/filters/base_filter.rb', line 51

def header
  options[:header] ||
    I18n.translate(self.name, :scope => "datagrid.#{grid_class.param_name}.filters", :default => self.name.to_s.humanize)
end

#multiple ⇒ Object 



61
62
63
64
 
# File 'lib/datagrid/filters/base_filter.rb', line 61

def multiple
  Datagrid::Utils.warn_once("Filter#multiple method is deprecated. Use Filter#multiple? instead")
  multiple?
end

#multiple? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/datagrid/filters/base_filter.rb', line 66

def multiple?
  self.options[:multiple]
end

#parse(value) ⇒ Object

Raises:

  • (NotImplementedError) 


15
16
17
 
# File 'lib/datagrid/filters/base_filter.rb', line 15

def parse(value)
  raise NotImplementedError, "#parse(value) suppose to be overwritten"
end

#parse_values(value) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/datagrid/filters/base_filter.rb', line 34

def parse_values(value)
  if multiple?
    normalize_multiple_value(value).map do |v|
      parse(v)
    end
  else
    if value.is_a?(Array)
      raise Datagrid::ArgumentError, "#{grid_class}##{name} filter can not accept Array argument. Use :multiple option."
    end
    parse(value)
  end
end

#separator ⇒ Object 



47
48
49
 
# File 'lib/datagrid/filters/base_filter.rb', line 47

def separator
  options[:multiple].is_a?(String) ? options[:multiple] : default_separator
end

#unapplicable_value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/datagrid/filters/base_filter.rb', line 19

def unapplicable_value?(value)
  value.nil? ? !allow_nil? : value.blank? && !allow_blank?
end