Class: Mutations::InputFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/mutations/input_filter.rb

Direct Known Subclasses

AdditionalFilter, ArrayFilter, HashFilter, ModelFilter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ InputFilter

Returns a new instance of InputFilter.



9
10
11
 
# File 'lib/mutations/input_filter.rb', line 9

def initialize(opts = {})
  self.options = (self.class.default_options || {}).merge(opts)
end

Instance Attribute Details

#options ⇒ Object

Returns the value of attribute options.



7
8
9
 
# File 'lib/mutations/input_filter.rb', line 7

def options
  @options
end

Class Method Details

.default_options ⇒ Object 



3
4
5
 
# File 'lib/mutations/input_filter.rb', line 3

def self.default_options
  @default_options ||= {}
end

Instance Method Details

#default ⇒ Object 



23
24
25
 
# File 'lib/mutations/input_filter.rb', line 23

def default
  options[:default]
end

#discard_empty? ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/mutations/input_filter.rb', line 32

def discard_empty?
  options[:discard_empty]
end

#discard_invalid? ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/mutations/input_filter.rb', line 36

def discard_invalid?
  options[:discard_invalid]
end

#discard_nils? ⇒ Boolean

Only relevant for optional params

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/mutations/input_filter.rb', line 28

def discard_nils?
  !options[:nils]
end

#filter(data) ⇒ Object

returns -> [sanitized data, error] If an error is returned, then data will be nil



15
16
17
 
# File 'lib/mutations/input_filter.rb', line 15

def filter(data)
  [data, nil]
end

#has_default? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/mutations/input_filter.rb', line 19

def has_default?
  options.has_key?(:default)
end