enum_class 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb01aaee4990bae960203ed343c56c3138dafc9d
+  data.tar.gz: fac9f38332e3d05bdd69346debd68dbac255d173
+SHA512:
+  metadata.gz: 519b31b4e7485d849ad9fd6c368ee996206d1f8109564bb420d8cf2fec6b8110e80754a746703476df985dba6ede49519d5214b7d0ff30d20d771c0ecb053b64
+  data.tar.gz: 3c297a574c757079148b82f891f5597e57e9d4b70da6a284a7575a6b2d8ae072029f21b5dc70455e96733f8ab1a9fb7b1af688c5c41665f059bffd7b6f5980a4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at michele.piccirillo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enum_class.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michele Piccirillo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,155 @@
+# EnumClass
+
+This gem is an attempt to provide a lightweight solution for __object-oriented enumerations in Ruby__. It consists
+in a single class (`Enum`), that can be subclassed to create enumerations and comes with no dependencies. It's similar
+in design to some [other](https://github.com/capnregex/enum) [gems](https://github.com/dblock/ruby-enum) available, but 
+it stemmed out from the necessity of handling reliably missing features like inheritance and instance methods of the enumerated 
+object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enum_class'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enum_class
+
+## Usage
+
+### Basic usage
+
+```ruby
+class Foo < Enum
+  value :A
+  value :B
+end
+
+Foo.inspect  # => Foo(A, B)
+
+# Instances are accessible as constants
+Foo::A.class # => Foo
+Foo::B.class # => Foo
+Foo::C       # => raises NameError
+
+# Enumerated values are implicitly ordered, depending on order of definition
+Foo::A == Foo::B # => false
+Foo::A < Foo::B  # => true
+
+# Instances can be retrieved by key
+Foo[:a]      # => Foo::A
+Foo['a']     # => Foo::A
+Foo.for('A') # => Foo::A
+Foo.for('X') # => raises KeyError
+
+Foo.new      # => raises an error
+
+# Helper methods
+Foo.a        # => Foo::A
+Foo.b        # => Foo::B
+
+Foo::A.a?    # => true
+Foo::A.b?    # => false
+```
+
+### Creating enums with a shortcut
+
+```ruby
+Bar = Enum.create(:a, :b, :c) # => Bar(A, B, C)
+```
+
+### Custom initializer
+```ruby
+class Foobar < Enum
+  def initialize(name)
+    @name = name
+  end
+
+  attr_reader :name
+
+  value :A, 'foo'
+  value :B, 'bar'
+end
+
+Foobar::A.name # => 'foo'
+Foobar::B.name # => 'bar'
+```
+
+### Inheritance
+
+```ruby
+class Base < Enum
+  value :A
+  value :B
+end
+
+class Child < Base
+  value :C
+end
+
+Base.inspect  # => Base(A, B)
+Child.inspect # => Child(A, B, C)
+```
+
+:warning: If you reopen the base class later, the changes won't be reflected in the child.
+The values to inherit are evaluated at the time of the class definition.
+
+### Advanced inheritance with custom initializer
+
+```ruby
+class Base < Enum
+  def initialize(name)
+    @name = name
+  end
+
+  attr_reader :name
+
+  value :A, 'foo'
+  value :B, 'bar'
+end
+
+class Child < Base
+  def initialize(name, number)
+    super(name)
+    @number = number
+  end
+
+  def initialize_from_superclass(superclass_enum_value)
+    super # default behavior is to copy all the instance variables
+    @number = superclass_enum_value.ord + 1
+  end
+
+  attr_reader :number
+
+  value :C, 'baz', 3
+end
+
+Child::C.name   # => 'baz'
+Child::C.number # => 3
+
+Child::B.name   # => 'bar'
+Child::B.number # => 2
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/LIQIDTechnology/enum_class. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "enum_class"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+
+require "pry"
+Pry.start
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/enum_class.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enum_class/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enum_class"
+  spec.version       = EnumClass::VERSION
+  spec.authors       = ["Michele Piccirillo"]
+  spec.email         = ["michele@liqid.de"]
+
+  spec.summary       = 'Object-oriented enumerations for Ruby'
+  spec.homepage      = "https://github.com/LIQIDTechnology/enum_class"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/enum.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+# An Enum is a class with a predefinite set of instances.
+# Instances have an implicit ordering (dependent on the order of definition), can be retrieved by key and be enumerated.
+#
+# @example Basic usage
+#   class Foo < Enum
+#     value :A
+#     value :B
+#   end
+#
+#   Foo.inspect  # => Foo(A, B)
+#
+#   # Instances are accessible as constants
+#   Foo::A.class # => Foo
+#   Foo::B.class # => Foo
+#   Foo::C       # => raises NameError
+#
+#   # Enumerated values are implicitly ordered, depending on order of definition
+#   Foo::A == Foo::B # => false
+#   Foo::A < Foo::B  # => true
+#
+#   # Instances can be retrieved by key
+#   Foo[:a]      # => Foo::A
+#   Foo['a']     # => Foo::A
+#   Foo.for('A') # => Foo::A
+#   Foo.for('X') # => raises KeyError
+#
+#   Foo.new      # => raises an error
+#
+#   # Helper methods
+#   Foo.a        # => Foo::A
+#   Foo.b        # => Foo::B
+#
+#   Foo::A.a?    # => true
+#   Foo::A.b?    # => false
+#
+# @example Creating enums with a shortcut
+#   Bar = Enum.create(:a, :b, :c) # => Bar(A, B, C)
+#
+# @example Custom initializer
+#   class Foobar < Enum
+#     def initialize(name)
+#       @name = name
+#     end
+#
+#     attr_reader :name
+#
+#     value :A, 'foo'
+#     value :B, 'bar'
+#   end
+#
+#   Foobar::A.name # => 'foo'
+#   Foobar::B.name # => 'bar'
+#
+# @example Inheritance
+#   class Base < Enum
+#     value :A
+#     value :B
+#   end
+#
+#   class Child < Base
+#     value :C
+#   end
+#
+#   Base.inspect # => Base(A, B)
+#   Child.inspect # => Child(A, B, C)
+#
+#   # NOTE: If you reopen the base class later, the changes won't be reflected in the child.
+#   # The values to inherit are evaluated at the time of the class definition
+#
+# @example Advanced inheritance with custom initializer
+#   class Base < Enum
+#     def initialize(name)
+#       @name = name
+#     end
+#
+#     attr_reader :name
+#
+#     value :A, 'foo'
+#     value :B, 'bar'
+#   end
+#
+#   class Child < Base
+#     def initialize(name, number)
+#       super(name)
+#       @number = number
+#     end
+#
+#     def initialize_from_superclass(superclass_enum_value)
+#       super # default behavior is to copy all the instance variables
+#       @number = superclass_enum_value.ord + 1
+#     end
+#
+#     attr_reader :number
+#
+#     value :C, 'baz', 3
+#   end
+#
+#   Child::C.name   # => 'baz'
+#   Child::C.number # => 3
+#
+#   Child::B.name   # => 'bar'
+#   Child::B.number # => 2
+class Enum
+  extend Forwardable
+  extend Enumerable
+  include Comparable
+
+  # Raised when a value is declared twice in an Enum
+  class DuplicateEnumKey < StandardError; end
+
+  # The key of this value in the enumeration
+  # @return [Symbol]
+  attr_reader :key
+
+  # Relative ordering index of the instance
+  # @return [Integer]
+  attr_reader :ord
+
+  # Returns a representation of this instance (e.g. `EnumName::VALUE_1`)
+  # @return [String]
+  def inspect
+    "#{self.class.name || 'Enum'}::#{key}"
+  end
+
+  def_delegators :key, :to_s
+
+  # (see Object#hash)
+  def hash
+    key.to_s.hash
+  end
+
+  # Tests the objects for equality.
+  # Two enum values are considered equal if they have the same key and belong to
+  # the same enumeration.
+  #
+  # @param other [Object] object to compare to
+  # @return [Boolean]
+  def ==(other)
+    return false if other.nil?
+    other = self.class.for(other) if other.is_a?(Symbol) || other.is_a?(String)
+    instance_of?(other.class) && key == other.key
+  end
+
+  alias eql? ==
+  alias to_sym key
+
+  # (see Comparable#<=>)
+  # Objects are compared based on their implicit ordering (order of definition).
+  # @see #ord
+  def <=>(other)
+    other = self.class.for(other) if other.is_a?(Symbol) || other.is_a?(String)
+    ord <=> other.ord
+  end
+
+  protected
+
+  # Initializes
+  def initialize_from_superclass(enum_value)
+    enum_value.instance_variables.each do |ivar|
+      instance_variable_set(ivar, enum_value.instance_variable_get(ivar))
+    end
+  end
+
+  class << self
+    extend Forwardable
+
+    # @param value [String, Symbol, Class]
+    # @return [self]
+    # @raise [KeyError] if there is no enumerated value with the specified key
+    def for(value)
+      return value if value.is_a? self.class
+      enum_key = value&.upcase&.to_sym
+      values.find(proc { raise KeyError, "Enumerated value not found: #{value.inspect}" }) { |v| v.key == enum_key }
+    end
+
+    # @return [Class]
+    def create(*keys)
+      Class.new(self).tap do |enum|
+        keys.each { |key| enum.value(key) }
+      end
+    end
+
+    alias [] for
+
+    def inspect
+      "#{name || 'Enum'}(#{values.map(&:to_s).join(', ')})"
+    end
+
+    def const_missing(sym)
+      self.for(sym)
+    rescue
+      super
+    end
+
+    def_delegators :values, :each, *Enumerable.instance_methods(false)
+
+    protected
+
+    def superclass_values
+      if superclass < Enum
+        superclass.values.map do |superclass_enum_value|
+          inherited_value = allocate
+          inherited_value.send(:initialize_from_superclass, superclass_enum_value)
+          inherited_value
+        end
+      else
+        SortedSet.new
+      end
+    end
+
+    def values
+      @values ||= SortedSet.new(superclass_values)
+    end
+
+    # Defines a value for the enumeration.
+    #
+    # @param key [Symbol] the name of the enumerated value. Will be a constant on the class
+    # @param args [Array] additional arguments, will be passed to the constructor when
+    #  instantiating the enumerated value.
+    # @return [void]
+    #
+    # @!macro [attach] value
+    #   @!attribute $1 [r] The value `$1` of the enumeration
+    #     @!scope class
+    #     @return [self] the singleton instance of the enumeration for this value
+    def value(key, *args)
+      key = key.to_s.upcase.to_sym
+      enum_value = send(:new, *args)
+      enum_value.instance_variable_set(:@key, key)
+
+      raise DuplicateEnumKey, "#{enum_value.inspect} is already defined" if values.include?(enum_value)
+
+      max_ord = values.max&.ord || -1
+      enum_value.instance_variable_set(:@ord, max_ord + 1)
+
+      values << enum_value
+
+      define_method("#{key.downcase}?") { @key == key }
+      define_singleton_method(key.to_s.downcase) { self.for(key) }
+    end
+  end
+
+  private_class_method :new
+end

data/lib/enum_class/version.rb

@@ -0,0 +1,3 @@
+module EnumClass
+  VERSION = "0.1.0"
+end

data/lib/enum_class.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'enum_class/version'
+require 'enum'
+
+module EnumClass
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: enum_class
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michele Piccirillo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- michele@liqid.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enum_class.gemspec
+- lib/enum.rb
+- lib/enum_class.rb
+- lib/enum_class/version.rb
+homepage: https://github.com/LIQIDTechnology/enum_class
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Object-oriented enumerations for Ruby
+test_files: []