Class: ActiveRemote::AttributeDefinition

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/active_remote/attribute_definition.rb

Overview

Represents an attribute for reflection

Examples:

Usage

AttributeDefinition.new(:amount)

Since:

  • 0.2.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ ActiveAttr::AttributeDefinition

Creates a new AttributeDefinition

Examples:

Create an attribute defintion

AttributeDefinition.new(:amount)

Parameters:

  • name (Symbol, String, #to_sym) —

    attribute name

  • options (Hash{Symbol => Object}) (defaults to: {}) —

    attribute options

Raises:

  • (TypeError)

Since:

  • 0.2.0



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/active_remote/attribute_definition.rb', line 55

def initialize(name, options={})
  raise TypeError, "can't convert #{name.class} into Symbol" unless name.respond_to? :to_sym
  @name = name.to_sym
  @options = options

  if @options[:type]
    typecaster = ::ActiveRemote::Typecasting::TYPECASTER_MAP[@options[:type]]
    fail ::ActiveRemote::UnknownType unless typecaster
    @options[:typecaster] = typecaster
  end
end

Instance Attribute Details

#name ⇒ Object (readonly)

The attribute name

Since:

  • 0.2.0



13
14
15
 
# File 'lib/active_remote/attribute_definition.rb', line 13

def name
  @name
end

Instance Method Details

#<=>(other) ⇒ -1, ...

Compare attribute definitions

Examples:

attribute_definition <=> other

Parameters:

  • other (ActiveAttr::AttributeDefinition, Object) —

    The other attribute definition to compare with.

Returns:

  • (-1, 0, 1, nil)

Since:

  • 0.2.1



26
27
28
29
30
 
# File 'lib/active_remote/attribute_definition.rb', line 26

def <=>(other)
  return nil unless other.instance_of? self.class
  return nil if name == other.name && options != other.options
  self.name.to_s <=> other.name.to_s
end

#[](key) ⇒ Object

Read an attribute option

Examples:

attribute_definition[:type]

Parameters:

  • key (Symbol) —

    The option key

Since:

  • 0.5.0



40
41
42
 
# File 'lib/active_remote/attribute_definition.rb', line 40

def [](key)
  @options[key]
end

#inspect ⇒ String

Returns the code that would generate the attribute definition

Examples:

Inspect the attribute definition

attribute.inspect

Returns:

  • (String) —

    Human-readable presentation of the attribute definition

Since:

  • 0.6.0



76
77
78
79
80
 
# File 'lib/active_remote/attribute_definition.rb', line 76

def inspect
  options_description = options.map { |key, value| "#{key.inspect} => #{value.inspect}" }.sort.join(", ")
  inspected_options = ", #{options_description}" unless options_description.empty?
  "attribute :#{name}#{inspected_options}"
end

#to_s ⇒ String

The attribute name

Returns:

  • (String) —

    the attribute name

Since:

  • 0.2.0



87
88
89
 
# File 'lib/active_remote/attribute_definition.rb', line 87

def to_s
  name.to_s
end

#to_sym ⇒ Symbol

The attribute name

Returns:

  • (Symbol) —

    the attribute name

Since:

  • 0.2.1



96
97
98
 
# File 'lib/active_remote/attribute_definition.rb', line 96

def to_sym
  name
end