Class: Protobuf::Enum

Inherits:
SimpleDelegator
  • Object
show all
Defined in:
lib/protobuf/enum.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parent_class, name, tag) ⇒ Enum

Instance Methods



255
256
257
258
259
260
 
# File 'lib/protobuf/enum.rb', line 255

def initialize(parent_class, name, tag)
  self.parent_class = parent_class
  self.name = name
  self.tag = tag
  super(tag)
end

Class Attribute Details

.enums ⇒ Object (readonly)

Returns the value of attribute enums.



75
76
77
 
# File 'lib/protobuf/enum.rb', line 75

def enums
  @enums
end

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.



249
250
251
 
# File 'lib/protobuf/enum.rb', line 249

def name
  @name
end

#parent_class ⇒ Object

Returns the value of attribute parent_class.



249
250
251
 
# File 'lib/protobuf/enum.rb', line 249

def parent_class
  @parent_class
end

#tag ⇒ Object

Returns the value of attribute tag.



249
250
251
 
# File 'lib/protobuf/enum.rb', line 249

def tag
  @tag
end

Class Method Details

.aliases_allowed? ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/protobuf/enum.rb', line 15

def self.aliases_allowed?
  get_option(:allow_alias)
end

.all_tags ⇒ Object

Public: Get all integer tags defined by this enum.

Examples

class StateMachine < ::Protobuf::Enum set_option :allow_alias define :ON, 1 define :STARTED, 1 define :OFF, 2 end

StateMachine.all_tags #=> [ 1, 2 ]

Returns an array of unique integers.



34
35
36
 
# File 'lib/protobuf/enum.rb', line 34

def self.all_tags
  @all_tags ||= enums.map(&:to_i).uniq
end

.define(name, tag) ⇒ Object

Internal: DSL method to create a new Enum. The given name will become a constant for this Enum pointing to the new instance.

Examples

class StateMachine < ::Protobuf::Enum define :ON, 1 define :OFF, 2 end

StateMachine::ON #=> #StateMachine::ON=1 StateMachine::OFF #=> #StateMachine::OFF=2

Returns nothing.



53
54
55
56
57
58
59
60
61
 
# File 'lib/protobuf/enum.rb', line 53

def self.define(name, tag)
  enum = new(self, name, tag)
  @enums ||= []
  @enums << enum
  # defining a new field for the enum will cause cached @values and @mapped_enums
  # to be incorrect; reset them
  @mapped_enums = @values = nil
  const_set(name, enum)
end

.enum_for_name(name) ⇒ Object

Public: Get the Enum associated with the given name.

name - A string-like object. Case-sensitive.

Example

class StateMachine < ::Protobuf::Enum define :ON, 1 define :OFF, 2 end

StateMachine.enum_for_name(:ON) # => #StateMachine::ON=1 StateMachine.enum_for_name("ON") # => #StateMachine::ON=1 StateMachine.enum_for_name(:on) # => nil StateMachine.enum_for_name(:FOO) # => nil

Returns the Enum object with the given name or nil.



118
119
120
121
122
 
# File 'lib/protobuf/enum.rb', line 118

def self.enum_for_name(name)
  const_get(name)
rescue ::NameError
  nil
end

.enum_for_tag(tag) ⇒ Object

Public: Get the Enum object corresponding to the given tag.

tag - An object that responds to to_i.

Returns an Enum object or nil. If the tag corresponds to multiple Enums, the first enum defined will be returned.



131
132
133
 
# File 'lib/protobuf/enum.rb', line 131

def self.enum_for_tag(tag)
  tag && (mapped_enums[tag.to_i] || []).first
end

.enums_for_tag(tag) ⇒ Object

Public: Get an array of Enum objects with the given tag.

tag - An object that responds to to_i.

Examples

class StateMachine < ::Protobuf::Enum set_option :allow_alias define :ON, 1 define :STARTED, 1 define :OFF, 2 end

StateMachine.enums_for_tag(1) #=> [ #StateMachine::ON=1, #StateMachine::STARTED=1 ] StateMachine.enums_for_tag(2) #=> [ #StateMachine::OFF=2 ]

Returns an array with zero or more Enum objects or nil.



96
97
98
 
# File 'lib/protobuf/enum.rb', line 96

def self.enums_for_tag(tag)
  tag && mapped_enums[tag.to_i] || []
end

.fetch(candidate) ⇒ Object

Public: Get an Enum by a variety of type-checking mechanisms.

candidate - An Enum, Numeric, String, or Symbol object.

Example

class StateMachine < ::Protobuf::Enum set_option :allow_alias define :ON, 1 define :STARTED, 1 define :OFF, 2 end

StateMachine.fetch(StateMachine::ON) # => #StateMachine::ON=1 StateMachine.fetch(:ON) # => #StateMachine::ON=1 StateMachine.fetch("STARTED") # => #StateMachine::STARTED=1 StateMachine.fetch(1) # => [ #StateMachine::ON=1, #StateMachine::STARTED=1 ]

Returns an Enum object or nil.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/protobuf/enum.rb', line 155

def self.fetch(candidate)
  return enum_for_tag(candidate) if candidate.is_a?(::Integer)

  case candidate
  when self
    candidate
  when ::Numeric
    enum_for_tag(candidate.to_i)
  when ::String, ::Symbol
    enum_for_name(candidate)
  else
    nil
  end
end

.mapped_enums ⇒ Object

Internal: A mapping of enum number -> enums defined used for speeding up our internal enum methods.



65
66
67
68
69
70
 
# File 'lib/protobuf/enum.rb', line 65

def self.mapped_enums
  @mapped_enums ||= enums.each_with_object({}) do |enum, hash|
    list = hash[enum.to_i] ||= []
    list << enum
  end
end

.name_for_tag(tag) ⇒ Object

Public: Get the Symbol name associated with the given number.

number - An object that responds to to_i.

Examples

# Without aliases class StateMachine < ::Protobuf::Enum define :ON, 1 define :OFF, 2 end

StateMachine.name_for_tag(1) # => :ON StateMachine.name_for_tag(2) # => :OFF StateMachine.name_for_tag(3) # => nil

# With aliases class StateMachine < ::Protobuf::Enum set_option :allow_alias define :STARTED, 1 define :ON, 1 define :OFF, 2 end

StateMachine.name_for_tag(1) # => :STARTED StateMachine.name_for_tag(2) # => :OFF

Returns the symbol name of the enum constant given it's associated tag or nil. If the given tag has multiple names associated (due to allow_alias) the first defined name will be returned.



201
202
203
 
# File 'lib/protobuf/enum.rb', line 201

def self.name_for_tag(tag)
  enum_for_tag(tag).try(:name)
end

.valid_tag?(tag) ⇒ Boolean

Public: Check if the given tag is defined by this Enum.

number - An object that responds to to_i.

Returns a boolean.

Returns:

  • (Boolean) 


211
212
213
 
# File 'lib/protobuf/enum.rb', line 211

def self.valid_tag?(tag)
  tag.respond_to?(:to_i) && mapped_enums.key?(tag.to_i)
end

.values ⇒ Object

Public: [DEPRECATED] Return a hash of Enum objects keyed by their :name.



218
219
220
221
222
 
# File 'lib/protobuf/enum.rb', line 218

def self.values
  @values ||= enums.each_with_object({}) do |enum, hash|
    hash[enum.name] = enum
  end
end

Instance Method Details

#class ⇒ Object

Overriding the class so ActiveRecord/Arel visitor will visit the enum as a Fixnum



264
265
266
 
# File 'lib/protobuf/enum.rb', line 264

def class
  Fixnum
end

#inspect ⇒ Object 



268
269
270
 
# File 'lib/protobuf/enum.rb', line 268

def inspect
  "\#<Protobuf::Enum(#{parent_class})::#{name}=#{tag}>"
end

#to_i ⇒ Object Also known as: to_hash_value 



272
273
274
 
# File 'lib/protobuf/enum.rb', line 272

def to_i
  tag
end

#to_int ⇒ Object 



276
277
278
 
# File 'lib/protobuf/enum.rb', line 276

def to_int
  tag.to_int
end

#to_s(format = :tag) ⇒ Object 



280
281
282
283
284
285
286
287
288
289
 
# File 'lib/protobuf/enum.rb', line 280

def to_s(format = :tag)
  case format
  when :tag
    to_i.to_s
  when :name
    name.to_s
  else
    to_i.to_s
  end
end

#try(*args, &block) ⇒ Object

Re-implement try in order to fix the problem where the underlying fixnum doesn't respond to all methods (e.g. name or tag). If we respond to the first argument, __send__ the args. Otherwise, delegate the try call to the underlying vlaue fixnum.



296
297
298
299
300
301
302
303
304
305
 
# File 'lib/protobuf/enum.rb', line 296

def try(*args, &block)
  case
  when args.empty? && block_given?
    yield self
  when respond_to?(args.first)
    __send__(*args, &block)
  else
    @tag.try(*args, &block)
  end
end