it-swarm.cn

Ruby中的枚举

在Ruby中实现枚举习惯的最佳方法是什么?我正在寻找一些我可以使用(几乎)像Java/C#枚举的东西。

299
auramo

两种方式。符号(:foo表示法)或常量(FOO表示法)。

当您想要增强可读性而不使用文字字符串乱丢代码时,符号是合适的。

postal_code[:minnesota] = "MN"
postal_code[:new_york] = "NY"

当您具有重要的基础值时,常量是合适的。只需声明一个模块来保存常量,然后在其中声明常量。

module Foo
  BAR = 1
  BAZ = 2
  BIZ = 4
end

flags = Foo::BAR | Foo::BAZ # flags = 3
294
mlibby

我很惊讶没有人提供类似下面的东西(从 _ rapi _ gem收获):

class Enum

  private

  def self.enum_attr(name, num)
    name = name.to_s

    define_method(name + '?') do
      @attrs & num != 0
    end

    define_method(name + '=') do |set|
      if set
        @attrs |= num
      else
        @attrs &= ~num
      end
    end
  end

  public

  def initialize(attrs = 0)
    @attrs = attrs
  end

  def to_i
    @attrs
  end
end

哪个可以这样使用:

class FileAttributes < Enum
  enum_attr :readonly,       0x0001
  enum_attr :hidden,         0x0002
  enum_attr :system,         0x0004
  enum_attr :directory,      0x0010
  enum_attr :archive,        0x0020
  enum_attr :in_rom,         0x0040
  enum_attr :normal,         0x0080
  enum_attr :temporary,      0x0100
  enum_attr :sparse,         0x0200
  enum_attr :reparse_point,  0x0400
  enum_attr :compressed,     0x0800
  enum_attr :rom_module,     0x2000
end

例:

>> example = FileAttributes.new(3)
=> #<FileAttributes:0x629d90 @attrs=3>
>> example.readonly?
=> true
>> example.hidden?
=> true
>> example.system?
=> false
>> example.system = true
=> true
>> example.system?
=> true
>> example.to_i
=> 7

这在数据库场景中很有用,或者在处理C样式常量/枚举时(在使用 _ ffi _ 时,RAPI广泛使用的情况)。

此外,您不必像使用散列类型解决方案那样担心会导致静默失败的拼写错误。

55
Charles

最常用的方法是使用符号。例如,而不是:

enum {
  FOO,
  BAR,
  BAZ
}

myFunc(FOO);

...你可以使用符号:

# You don't actually need to declare these, of course--this is
# just to show you what symbols look like.
:foo
:bar
:baz

my_func(:foo)

这比枚举更开放,但它与Ruby精神很吻合。

符号也表现得很好。例如,比较两个符号的相等性比比较两个字符串要快得多。

52
emk

我使用以下方法:

class MyClass
  MY_ENUM = [MY_VALUE_1 = 'value1', MY_VALUE_2 = 'value2']
end

我喜欢它具有以下优点:

  1. 它将视觉上的值分组为一个整体
  2. 它执行一些编译时检查(与仅使用符号相比)
  3. 我可以轻松访问所有可能值的列表:只需MY_ENUM
  4. 我可以轻松访问不同的值:MY_VALUE_1
  5. 它可以具有任何类型的值,而不仅仅是符号

符号可能更好,因为如果您在另一个类中使用它,则不必编写外部类的名称(MyClass::MY_VALUE_1

32
Alexey

如果您使用的是Rails 4.2或更高版本,则可以使用Rails枚举。

Rails现在默认有枚举,无需包含任何宝石。

这与Java,C++枚举非常相似(以及更多功能)。

引自 http://edgeapi.rubyonrails.org/classes/ActiveRecord/Enum.html

class Conversation < ActiveRecord::Base
  enum status: [ :active, :archived ]
end

# conversation.update! status: 0
conversation.active!
conversation.active? # => true
conversation.status  # => "active"

# conversation.update! status: 1
conversation.archived!
conversation.archived? # => true
conversation.status    # => "archived"

# conversation.update! status: 1
conversation.status = "archived"

# conversation.update! status: nil
conversation.status = nil
conversation.status.nil? # => true
conversation.status      # => nil
18
vedant

这是我在Ruby中使用枚举的方法。我是短暂而甜蜜的,不一定是最像C的。有什么想法吗?

module Kernel
  def enum(values)
    Module.new do |mod|
      values.each_with_index{ |v,i| mod.const_set(v.to_s.capitalize, 2**i) }

      def mod.inspect
        "#{self.name} {#{self.constants.join(', ')}}"
      end
    end
  end
end

States = enum %w(Draft Published Trashed)
=> States {Draft, Published, Trashed} 

States::Draft
=> 1

States::Published
=> 2

States::Trashed
=> 4

States::Draft | States::Trashed
=> 3
8
johnnypez

查看Ruby-enum gem, https://github.com/dblock/Ruby-enum

class Gender
  include Enum

  Gender.define :MALE, "male"
  Gender.define :FEMALE, "female"
end

Gender.all
Gender::MALE
8
dB.

我知道自从这个人发布这个问题以来已经有很长一段时间了,但是我有同样的问题而且这篇帖子没有给我答案。我想要一种简单的方法来查看数字代表什么,简单的比较,以及大多数ActiveRecord支持使用代表枚举的列进行查找。

我没有找到任何东西,所以我做了一个很棒的实现叫做 yinum 它允许我正在寻找的一切。制作了很多规格,所以我很确定这是安全的。

一些示例功能:

COLORS = Enum.new(:COLORS, :red => 1, :green => 2, :blue => 3)
=> COLORS(:red => 1, :green => 2, :blue => 3)
COLORS.red == 1 && COLORS.red == :red
=> true

class Car < ActiveRecord::Base    
  attr_enum :color, :COLORS, :red => 1, :black => 2
end
car = Car.new
car.color = :red / "red" / 1 / "1"
car.color
=> Car::COLORS.red
car.color.black?
=> false
Car.red.to_sql
=> "SELECT `cars`.* FROM `cars` WHERE `cars`.`color` = 1"
Car.last.red?
=> true
7
Oded Niv

也许最好的轻量级方法

module MyConstants
  ABC = Class.new
  DEF = Class.new
  GHI = Class.new
end

这样,值具有关联的名称,如Java/C#中所示:

MyConstants::ABC
=> MyConstants::ABC

要获得所有价值,你可以做到

MyConstants.constants
=> [:ABC, :DEF, :GHI] 

如果你想要枚举的序数值,你可以做到

MyConstants.constants.index :GHI
=> 2
5
Daniel Lubarov

如果您担心带有符号的拼写错误,请确保在使用不存在的密钥访问值时代码会引发异常。您可以使用fetch而不是[]来执行此操作:

my_value = my_hash.fetch(:key)

或者,如果提供不存在的密钥,则默认情况下使哈希引发异常:

my_hash = Hash.new do |hash, key|
  raise "You tried to access using #{key.inspect} when the only keys we have are #{hash.keys.inspect}"
end

如果哈希已存在,则可以添加异常提升行为:

my_hash = Hash[[[1,2]]]
my_hash.default_proc = proc do |hash, key|
  raise "You tried to access using #{key.inspect} when the only keys we have are #{hash.keys.inspect}"
end

通常,您不必担心常量的拼写错误。如果拼错常量名称,通常会引发异常。

5
Andrew Grimm

有人继续写了一个名为 Renum 的Ruby宝石。它声称获得了最接近Java/C#的行为。就我个人而言,我还在学习Ruby,当我想让一个特定的类包含静态枚举(可能是哈希)时,我感到有点震惊,因为谷歌并不是很容易找到它。

4
dlamblin

最近我们发布了一个 gem 实现 Ruby中的枚举 。在我的 帖子 你会找到你的问题的答案。我还描述了为什么我们的实现比现有实现更好(实际上在Ruby中有很多这种功能的实现,但作为宝石)。

3
ka8725

这完全取决于您如何使用Java或C#枚举。你如何使用它将决定你将在Ruby中选择的解决方案。

尝试使用原生的Set类型,例如:

>> enum = Set['a', 'b', 'c']
=> #<Set: {"a", "b", "c"}>
>> enum.member? "b"
=> true
>> enum.member? "d"
=> false
>> enum.add? "b"
=> nil
>> enum.add? "d"
=> #<Set: {"a", "b", "c", "d"}>
3
mislav

这似乎有点多余,但这是我使用过几次的方法论,特别是在我与xml或其他类似的东西集成的地方。

#model
class Profession
  def self.pro_enum
    {:BAKER => 0, 
     :MANAGER => 1, 
     :FIREMAN => 2, 
     :DEV => 3, 
     :VAL => ["BAKER", "MANAGER", "FIREMAN", "DEV"]
    }
  end
end

Profession.pro_enum[:DEV]      #=>3
Profession.pro_enum[:VAL][1]   #=>MANAGER

这给了我c#enum的严谨性,它与模型联系在一起。

2
jjk

符号是Ruby的方式。但是,有时需要与某些C代码或某些东西或Java相关联,以便为各种事物暴露一些枚举。


#server_roles.rb
module EnumLike

  def EnumLike.server_role
    server_Symb=[ :SERVER_CLOUD, :SERVER_DESKTOP, :SERVER_WORKSTATION]
    server_Enum=Hash.new
    i=0
    server_Symb.each{ |e| server_Enum[e]=i; i +=1}
    return server_Symb,server_Enum
  end

end

然后可以像这样使用它


require 'server_roles'

sSymb, sEnum =EnumLike.server_role()

foreignvec[sEnum[:SERVER_WORKSTATION]]=8

这当然可以是抽象的,你可以滚动我们自己的Enum类

2
Jonke

我已经实现了这样的枚举

module EnumType

  def self.find_by_id id
    if id.instance_of? String
      id = id.to_i
    end 
    values.each do |type|
      if id == type.id
        return type
      end
    end
    nil
  end

  def self.values
    [@ENUM_1, @ENUM_2] 
  end

  class Enum
    attr_reader :id, :label

    def initialize id, label
      @id = id
      @label = label
    end
  end

  @ENUM_1 = Enum.new(1, "first")
  @ENUM_2 = Enum.new(2, "second")

end

那么它易于操作

EnumType.ENUM_1.label

...

enum = EnumType.find_by_id 1

...

valueArray = EnumType.values
2
Masuschi

另一种解决方案是使用OpenStruct。它非常直接和干净。

https://Ruby-doc.org/stdlib-2.3.1/libdoc/ostruct/rdoc/OpenStruct.html

例:

# bar.rb
require 'ostruct' # not needed when using Rails

# by patching Array you have a simple way of creating a ENUM-style
class Array
   def to_enum(base=0)
      OpenStruct.new(map.with_index(base).to_h)
   end
end

class Bar

    MY_ENUM = OpenStruct.new(ONE: 1, TWO: 2, THREE: 3)
    MY_ENUM2 = %w[ONE TWO THREE].to_enum

    def use_enum (value)
        case value
        when MY_ENUM.ONE
            puts "Hello, this is ENUM 1"
        when MY_ENUM.TWO
            puts "Hello, this is ENUM 2"
        when MY_ENUM.THREE
            puts "Hello, this is ENUM 3"
        else
            puts "#{value} not found in ENUM"
        end
    end

end

# usage
foo = Bar.new    
foo.use_enum 1
foo.use_enum 2
foo.use_enum 9


# put this code in a file 'bar.rb', start IRB and type: load 'bar.rb'
2
Roger

大多数人使用符号(这是:foo_bar语法)。它们是一种独特的不透明值。符号不属于任何枚举式类型,因此它们并不是C枚举类型的忠实表示,但这非常好。

1
Jan Krüger

有时我只需要能够获取枚举值并识别其类似于Java世界的名称。

module Enum
     def get_value(str)
       const_get(str)
     end
     def get_name(sym)
       sym.to_s.upcase
     end
 end

 class Fruits
   include Enum
   Apple = "Delicious"
   MANGO = "Sweet"
 end

 Fruits.get_value('Apple') #'Delicious'
 Fruits.get_value('MANGO') # 'Sweet'

 Fruits.get_name(:Apple) # 'Apple'
 Fruits.get_name(:mango) # 'MANGO'

这对我来说就是enum的目的,并且保持它非常可扩展。您可以向Enum类添加更多方法,并且中提琴可以在所有已定义的枚举中免费获取它们。例如。 get_all_names和那样的东西。

1
dark_src
irb(main):016:0> num=[1,2,3,4]
irb(main):017:0> alph=['a','b','c','d']
irb(main):018:0> l_enum=alph.to_enum
irb(main):019:0> s_enum=num.to_enum
irb(main):020:0> loop do
irb(main):021:1* puts "#{s_enum.next} - #{l_enum.next}"
irb(main):022:1> end

输出:

1 - a
2 - b
3 - c
4 - d

1
Anu
module Status
  BAD  = 13
  GOOD = 24

  def self.to_str(status)
    for sym in self.constants
      if self.const_get(sym) == status
        return sym.to_s
      end
    end
  end

end


mystatus = Status::GOOD

puts Status::to_str(mystatus)

输出:

GOOD
1
Hossein

快速又脏,感觉就像C#:

class FeelsLikeAnEnum
  def self.Option_1() :option_1 end
  def self.Option_2() :option_2 end
  def self.Option_3() :option_3 end
end

像使用Enum一样使用它:

method_that_needs_options(FeelsLikeAnEnum.Option_1)
0
David Foley

我认为实现类似枚举的最佳方法是使用符号,因为它几乎表现为整数(当涉及到性能时,object_id用于进行比较);你不需要担心索引,它们在你的代码xD中看起来很整洁

0
goreorto

另一种方法是使用带有包含名称和值的哈希的Ruby类,如下面所述 RubyFleebie博客文章 。这允许您在值和常量之间轻松转换(特别是如果您添加一个类方法来查找给定值的名称)。

0
Philippe Monnet

另一种模仿枚举的方法,具有一致的平等处理(Dave Thomas无耻地采用)。允许打开枚举(很像符号)和封闭(预定义)枚举。

class Enum
  def self.new(values = nil)
    enum = Class.new do
      unless values
        def self.const_missing(name)
          const_set(name, new(name))
        end
      end

      def initialize(name)
        @enum_name = name
      end

      def to_s
        "#{self.class}::#@enum_name"
      end
    end

    if values
      enum.instance_eval do
        values.each { |e| const_set(e, enum.new(e)) }
      end
    end

    enum
  end
end

Genre = Enum.new %w(Gothic Metal) # creates closed enum
Architecture = Enum.new           # creates open enum

Genre::Gothic == Genre::Gothic        # => true
Genre::Gothic != Architecture::Gothic # => true
0
Daniel Doubleday

试试inum。 https://github.com/alfa-jpn/inum

class Color < Inum::Base
  define :RED
  define :GREEN
  define :BLUE
end
Color::RED 
Color.parse('blue') # => Color::BLUE
Color.parse(2)      # => Color::GREEN

查看更多 https://github.com/alfa-jpn/inum#usage

0
horun