Class: Might::SortParameterDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/might/sort_parameter_definition.rb

Overview

Sorting parameter definition

Direct Known Subclasses

SortUndefinedParameter

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, as: name, reverse_direction: false) ⇒ SortParameterDefinition

Returns a new instance of SortParameterDefinition.

Parameters:

  • name (String) —

    of the field

  • as (String) (defaults to: name) —

    (#name) alias for the property

  • reverse_direction (Boolean) (defaults to: false) —

    (false) default sorting direction



20
21
22
23
24
 
# File 'lib/might/sort_parameter_definition.rb', line 20

def initialize(name, as: name, reverse_direction: false)
  @name = name.to_s
  @as = as.to_s
  @reverse_direction = reverse_direction
end

Instance Attribute Details

#as ⇒ String (readonly)

If the property name doesn’t match the name in the query string, use the :as option

Returns:

  • (String) 


11
12
13
 
# File 'lib/might/sort_parameter_definition.rb', line 11

def as
  @as
end

#name ⇒ String (readonly)

Returns:

  • (String) 


7
8
9
 
# File 'lib/might/sort_parameter_definition.rb', line 7

def name
  @name
end

#reverse_direction ⇒ Boolean (readonly) Also known as: reverse_direction?

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/might/sort_parameter_definition.rb', line 14

def reverse_direction
  @reverse_direction
end

Instance Method Details

#==(other) ⇒ Object 



33
34
35
36
37
 
# File 'lib/might/sort_parameter_definition.rb', line 33

def ==(other)
  other.is_a?(self.class) &&
    other.name == name &&
    other.as == as
end

#defined? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/might/sort_parameter_definition.rb', line 45

def defined?
  true
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/might/sort_parameter_definition.rb', line 29

def eql?(other)
  other.is_a?(self.class) && other.as == as
end

#undefined? ⇒ Boolean

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/might/sort_parameter_definition.rb', line 49

def undefined?
  !self.defined?
end

#validator ⇒ Object 



41
42
43
 
# File 'lib/might/sort_parameter_definition.rb', line 41

def validator
  SortValueValidator.build(self).new
end