RubyでEnumを実装する方法は？

Rubyで列挙型イディオムを実装する最良の方法は何ですか？私はJava / C＃列挙型のように（ほとんど）使用できるものを探しています。

二つの方法。記号（: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

次のようなものを提供している人がいないことに驚いています（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スタイルの定数/列挙型（RAPIが広範囲に使用するFFIを使用する場合と同様）を処理するときにうまく機能します。

また、ハッシュタイプのソリューションを使用する場合のように、タイプミスがサイレント障害を引き起こすことを心配する必要はありません。

これを行う最も慣用的な方法は、シンボルを使用することです。たとえば、次の代わりに：

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の精神によく適合します。

シンボルも非常によく機能します。たとえば、2つのシンボルが等しいかどうかを比較すると、2つの文字列を比較するよりもはるかに高速です。

私は次のアプローチを使用します：

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）

Rails 4.2以降を使用している場合は、Rails列挙型を使用できます。

Railsにはデフォルトで列挙型があり、gemを含める必要はありません。

これは、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

これが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

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

おそらく、最良の軽量アプローチは

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

男がこの質問を投稿してから長い時間が経過していることはわかっていますが、同じ質問があり、この投稿からは答えが得られませんでした。数値が何を表しているかを簡単に確認できる方法、簡単な比較、そして列挙型を表す列を使用したルックアップのすべての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

記号のタイプミスが心配な場合は、存在しないキーで値にアクセスするときにコードで例外が発生することを確認してください。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

通常、定数を使用したタイプミスの安全性について心配する必要はありません。定数名のスペルを間違えると、通常は例外が発生します。

誰かが先に進んで、レナムと呼ばれるルビーの宝石を書いた。最も近いJava / C＃のような動作を取得すると主張しています。個人的にはまだRubyを学習していますが、特定のクラスに静的列挙型（おそらくハッシュ）を含めたいと思ったときに少しショックを受けました。

すべては、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"}>

最近、RubyでEnumsを実装するgemをリリースしました。私の投稿では、あなたの質問に対する答えを見つけるでしょう。また、実装が既存の実装よりも優れている理由についても説明しました（実際、Rubyにはまだこの機能の実装がgemとして数多くあります）。

別のソリューションは、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'

シンボルはルビーの方法です。ただし、場合によっては、列挙型をさまざまなものに公開する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クラスをロールすることができます

そのような列挙型を実装しました

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

これは少し不必要に思えますが、これは私が数回使用した方法論であり、特に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

これにより、ac＃enumの厳密さが得られ、モデルに関連付けられます。

ほとんどの人は記号を使用します（それが:foo_bar構文です）。それらは一種のユニークな不透明な値です。シンボルは列挙型の型に属していないため、Cの列挙型を忠実に表したものではありませんが、これはかなり優れています。

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

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

enumの値をフェッチしてその名前を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クラスにメソッドを追加すると、violaは定義されたすべての列挙型でそれらを無料で取得できます。例えば。get_all_namesなど。

別のアプローチは、次のRubyFleebieブログ投稿で説明されているように、名前と値を含むハッシュを持つRubyクラスを使用することです。これにより、値と定数の間で簡単に変換できます（特に、クラスメソッドを追加して、指定された値の名前を検索する場合）。

型のような列挙を実装する最善の方法は、シンボルを使用することだと思います。インデックス作成について心配する必要はありません。コードxDで本当にきれいに見えます

一貫性のある等価処理で列挙型を模倣する別の方法（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

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