class Protobuf::Enum

Attributes

enums[R]
name[RW]

Attributes

parent_class[RW]

Attributes

tag[RW]

Attributes

to_hash_value[RW]

Attributes

to_i[RW]

Attributes

to_json_hash_value[RW]

Attributes

Public Class Methods

aliases_allowed?() click to toggle source
# File lib/protobuf/enum.rb, line 15
def self.aliases_allowed?
  get_option(:allow_alias)
end
all_tags() click to toggle source

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.

# File lib/protobuf/enum.rb, line 34
def self.all_tags
  @all_tags ||= enums.map(&:to_i).uniq
end
define(name, tag) click to toggle source

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.

# 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)
  mapped_enums
end
enum_for_name(name) click to toggle source

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.

# File lib/protobuf/enum.rb, line 119
def self.enum_for_name(name)
  const_get(name)
rescue ::NameError
  nil
end
enum_for_tag(tag) click to toggle source

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.
# File lib/protobuf/enum.rb, line 132
def self.enum_for_tag(tag)
  tag && (mapped_enums[tag.to_i] || []).first
end
enum_for_tag_integer(tag) click to toggle source
# File lib/protobuf/enum.rb, line 136
def self.enum_for_tag_integer(tag)
  (@mapped_enums[tag] || []).first
end
enums_for_tag(tag) click to toggle source

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.

# File lib/protobuf/enum.rb, line 97
def self.enums_for_tag(tag)
  tag && mapped_enums[tag.to_i] || []
end
fetch(candidate) click to toggle source

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.

# File lib/protobuf/enum.rb, line 160
def self.fetch(candidate)
  return enum_for_tag_integer(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() click to toggle source

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

# File lib/protobuf/enum.rb, line 66
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) click to toggle source

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.
# File lib/protobuf/enum.rb, line 206
def self.name_for_tag(tag)
  enum_for_tag(tag).try(:name)
end
new(parent_class, name, tag) click to toggle source

Instance Methods

Calls superclass method
# File lib/protobuf/enum.rb, line 260
def initialize(parent_class, name, tag)
  self.parent_class = parent_class
  self.name = name
  self.tag = tag
  super(tag)
end
valid_tag?(tag) click to toggle source

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

number - An object that responds to to_i.

Returns a boolean.

# File lib/protobuf/enum.rb, line 216
def self.valid_tag?(tag)
  tag.respond_to?(:to_i) && mapped_enums.key?(tag.to_i)
end
values() click to toggle source

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

# File lib/protobuf/enum.rb, line 223
def self.values
  @values ||= enums.each_with_object({}) do |enum, hash|
    hash[enum.name] = enum
  end
end

Public Instance Methods

==(other) click to toggle source

Custom equality method since otherwise identical values from different enums will be considered equal by Integer's equality method (or Fixnum's on Ruby < 2.4.0).

# File lib/protobuf/enum.rb, line 271
def ==(other)
  if other.is_a?(Protobuf::Enum)
    parent_class == other.parent_class && tag == other.tag
  elsif tag.class == other.class
    tag == other
  else
    false
  end
end
class() click to toggle source

Overriding the class so ActiveRecord/Arel visitor will visit the enum as an Integer.

# File lib/protobuf/enum.rb, line 284
def class
  # This is done for backward compatibility for < 2.4.0. This ensures that
  # if Ruby version >= 2.4.0, this will return Integer. If below, then will
  # return Fixnum.
  #
  # This prevents the constant deprecation warnings on Fixnum.
  tag.class
end
eql?(other) click to toggle source

Protobuf::Enum delegates methods to Fixnum, which has a custom hash equality method (`eql?`) This causes enum values to be equivalent when using `==`, `===`, `equals?`, but not `eql?`**:

2.3.7 :002 > ::Test::EnumTestType::ZERO.eql?(::Test::EnumTestType::ZERO)
 => false

However, they are equilvalent to their tag value:

2.3.7 :002 > ::Test::EnumTestType::ZERO.eql?(::Test::EnumTestType::ZERO.tag)
 => true

**The implementation changed in Ruby 2.5, so this only affects Ruby versions less than v2.4.

Use the hash equality implementation from Object#eql?, which is equivalent to == instead.

# File lib/protobuf/enum.rb, line 308
def eql?(other)
  self == other
end
inspect() click to toggle source
# File lib/protobuf/enum.rb, line 312
def inspect
  "\#<Protobuf::Enum(#{parent_class})::#{name}=#{tag}>"
end
to_int() click to toggle source
# File lib/protobuf/enum.rb, line 316
def to_int
  tag.to_int
end
to_json(*) click to toggle source

This fixes a reflection bug in JrJackson RubyAnySerializer that does not render Protobuf enums correctly because #to_json is not defined. It takes any number of arguments to support the JSON gem trying to pass an argument. NB: This method is required to return a string and not an integer.

# File lib/protobuf/enum.rb, line 325
def to_json(*)
  to_s
end
to_s(format = :tag) click to toggle source
# File lib/protobuf/enum.rb, line 329
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) { |self| ... } click to toggle source

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.

# File lib/protobuf/enum.rb, line 345
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