Class: Protobuf::Enum
- Inherits:
-
SimpleDelegator
- Object
- SimpleDelegator
- Protobuf::Enum
- Includes:
- Optionable
- Defined in:
- lib/protobuf/enum.rb
Direct Known Subclasses
Google::Protobuf::FieldDescriptorProto::Label, Google::Protobuf::FieldDescriptorProto::Type, Google::Protobuf::FieldOptions::CType, Google::Protobuf::FileOptions::OptimizeMode, Rpc::DynamicDiscovery::BeaconType, Socketrpc::ErrorReason
Class Attribute Summary collapse
-
.enums ⇒ Object
readonly
Returns the value of attribute enums.
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#parent_class ⇒ Object
readonly
Returns the value of attribute parent_class.
-
#tag ⇒ Object
readonly
Returns the value of attribute tag.
Class Method Summary collapse
- .aliases_allowed? ⇒ Boolean
-
.all_tags ⇒ Object
Public: Get all integer tags defined by this enum.
-
.define(name, tag) ⇒ Object
Internal: DSL method to create a new Enum.
-
.enum_for_name(name) ⇒ Object
Public: Get the Enum associated with the given name.
-
.enum_for_tag(tag) ⇒ Object
Public: Get the Enum object corresponding to the given tag.
-
.enums_for_tag(tag) ⇒ Object
Public: Get an array of Enum objects with the given tag.
-
.fetch(candidate) ⇒ Object
Public: Get an Enum by a variety of type-checking mechanisms.
-
.name_for_tag(tag) ⇒ Object
Public: Get the Symbol name associated with the given number.
-
.valid_tag?(tag) ⇒ Boolean
Public: Check if the given tag is defined by this Enum.
-
.values ⇒ Object
Public: [DEPRECATED] Return a hash of Enum objects keyed by their :name.
Instance Method Summary collapse
-
#class ⇒ Object
Overriding the class so ActiveRecord/Arel visitor will visit the enum as a Fixnum.
-
#initialize(parent_class, name, tag) ⇒ Enum
constructor
Instance Methods.
- #inspect ⇒ Object
- #to_i ⇒ Object (also: #to_hash_value)
- #to_int ⇒ Object
- #to_s(format = :tag) ⇒ Object
-
#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).
Methods included from Optionable
Constructor Details
#initialize(parent_class, name, tag) ⇒ Enum
Instance Methods
244 245 246 247 248 249 |
# File 'lib/protobuf/enum.rb', line 244 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.
64 65 66 |
# File 'lib/protobuf/enum.rb', line 64 def enums @enums end |
Instance Attribute Details
#name ⇒ Object
Returns the value of attribute name.
238 239 240 |
# File 'lib/protobuf/enum.rb', line 238 def name @name end |
#parent_class ⇒ Object
Returns the value of attribute parent_class.
238 239 240 |
# File 'lib/protobuf/enum.rb', line 238 def parent_class @parent_class end |
#tag ⇒ Object
Returns the value of attribute tag.
238 239 240 |
# File 'lib/protobuf/enum.rb', line 238 def tag @tag end |
Class Method Details
.aliases_allowed? ⇒ Boolean
16 17 18 |
# File 'lib/protobuf/enum.rb', line 16 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.
35 36 37 |
# File 'lib/protobuf/enum.rb', line 35 def self. @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.
54 55 56 57 58 59 |
# File 'lib/protobuf/enum.rb', line 54 def self.define(name, tag) enum = new(self, name, tag) @enums ||= [] @enums << enum 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.
109 110 111 112 113 |
# File 'lib/protobuf/enum.rb', line 109 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.
122 123 124 |
# File 'lib/protobuf/enum.rb', line 122 def self.enum_for_tag(tag) enums_for_tag(tag).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.
85 86 87 88 89 |
# File 'lib/protobuf/enum.rb', line 85 def self.enums_for_tag(tag) enums.select do |enum| enum.to_i == tag.to_i end 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.
146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/protobuf/enum.rb', line 146 def self.fetch(candidate) case candidate when self then candidate when ::Numeric then enum_for_tag(candidate.to_i) when ::String, ::Symbol then enum_for_name(candidate) else nil 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.
190 191 192 |
# File 'lib/protobuf/enum.rb', line 190 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.
200 201 202 |
# File 'lib/protobuf/enum.rb', line 200 def self.valid_tag?(tag) tag.respond_to?(:to_i) && .include?(tag.to_i) end |
.values ⇒ Object
Public: [DEPRECATED] Return a hash of Enum objects keyed by their :name.
207 208 209 210 211 |
# File 'lib/protobuf/enum.rb', line 207 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
253 254 255 |
# File 'lib/protobuf/enum.rb', line 253 def class Fixnum end |
#inspect ⇒ Object
257 258 259 |
# File 'lib/protobuf/enum.rb', line 257 def inspect "\#<Protobuf::Enum(#{parent_class})::#{name}=#{tag}>" end |
#to_i ⇒ Object Also known as: to_hash_value
261 262 263 |
# File 'lib/protobuf/enum.rb', line 261 def to_i tag end |
#to_int ⇒ Object
265 266 267 |
# File 'lib/protobuf/enum.rb', line 265 def to_int tag.to_int end |
#to_s(format = :tag) ⇒ Object
269 270 271 272 273 274 275 276 277 278 |
# File 'lib/protobuf/enum.rb', line 269 def to_s(format = :tag) case format when :tag then to_i.to_s when :name then 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.
285 286 287 288 289 290 291 292 293 294 |
# File 'lib/protobuf/enum.rb', line 285 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 |