elskwid / enuma Goto Github PK

Bring in ideas from other libraries.

• https://github.com/raphaelr/nice_enum
• https://github.com/ddl1st/light_enum
• https://github.com/toplex/enum
• https://github.com/binarylogic/enumlogic
• https://github.com/sholden/enum
• https://github.com/capnregex/enum
• https://github.com/duelinmarkers/renum
• https://github.com/wallacyyy/mini_enum

For consideration from yinum (enum)

https://github.com/toplex/enum

• simple instance of an enumerator where name and values are parameters
• dot notation for values
• subscript (square bracket) notation for retrieving values
• retrieve multiple values using subscript [1,4]
• comparison of value to enum name
• attr_enum syntax for adding to a class

too many examples: see README

For consideration from nice_enum

https://github.com/raphaelr/nice_enum

• enums are instances of the enclosing class
• enumeration classes pass messages to underlying value
• auto values: if you leave of the value of the enum it is created as a sequential integer
• mix and match auto and explicit values
• iteration
• mix in enumerable
• arbitrary value attributes (hash)
• default attribute values
• add methods to enums (like struct style)

example:

class Number < Enum
  enum :Zero, 0, :squared => 0
  enum :One, 1, :note => "Average number of eyes per eyehole", :squared => 1
  enum :Five, 5, :note => "Number of digits per hand", :squared => 25
end

A gist of a recent enum-like thing being used in a project. https://gist.github.com/elskwid/7113427

For consideration from sholden/enum

https://github.com/sholden/enum

• lookup by symbol or number
• same subscript [square bracket] lookup for symbol or number
• #valid? to test for key existence
• #only method to return only values asked for
• #except method to return all but the values stipulated
• bitflag support - use bitwise operations

examples:

BitflagEnum.new(:global, :group, :user)
Enum.new(:jake, :finn, :princess_bubblegum, :peppermint_butler)

Partially extracted from a project in this gist: https://gist.github.com/elskwid/5811336

For consideration from binarylogic/enumlogic

https://github.com/binarylogic/enumlogic

• class method for definition (enum)
• _options method that returns hash for rails forms
• .valid? method to validate inclusion of the enum field in an AR model
• namespace option to namespace the methods with the field name
• boolean query methods to test enum

examples:

Computer.enum :kind, ["apple", "dell", "hp"], :namespace => true
Computer.enum :kind, ["apple", "dell", "hp"]
Computer.enum :kind, {"apple" => "Apple", "dell" => "Dell", "hp" => "HP"}

tick-tock

For consideration from light_enum

https://github.com/ddl1st/light_enum

• constant to access enums
• constant to access enum values array
• simple nested array syntax for declaration
• query methods like foo.status_0?
• accessor like foo.status_name

This one doesn't have much that I've considered before, putting it here for completeness.

example:

class Bar
  include ActiveModel::Validations
  include LightEnum
  attr_accessor :status,:published
  light_enum :status, ["Open","Close","Reopen",["Done","D"]],:validate => true
  light_enum :published,[["公开",1],["私人",2]]
end