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



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

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) 


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

def as
  @as
end

#name ⇒ String (readonly)

Returns:

  • (String) 


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

def name
  @name
end

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

Returns:

  • (Boolean) 


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

def reverse_direction
  @reverse_direction
end

Instance Method Details

#==(other) ⇒ Object 



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

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

#defined? ⇒ Boolean

Returns:

  • (Boolean) 


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

def defined?
  true
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#undefined? ⇒ Boolean

Returns:

  • (Boolean) 


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

def undefined?
  !self.defined?
end

#validator ⇒ Object 



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

def validator
  SortValueValidator.build(self).new
end