enum_class 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb01aaee4990bae960203ed343c56c3138dafc9d
-  data.tar.gz: fac9f38332e3d05bdd69346debd68dbac255d173
+  metadata.gz: e0ea8d8e6d54a15a3c13af072ea7a9f82556623d
+  data.tar.gz: f42b49f63f8c8df27bc9024994bdab0cfab4e0e4
 SHA512:
-  metadata.gz: 519b31b4e7485d849ad9fd6c368ee996206d1f8109564bb420d8cf2fec6b8110e80754a746703476df985dba6ede49519d5214b7d0ff30d20d771c0ecb053b64
-  data.tar.gz: 3c297a574c757079148b82f891f5597e57e9d4b70da6a284a7575a6b2d8ae072029f21b5dc70455e96733f8ab1a9fb7b1af688c5c41665f059bffd7b6f5980a4
+  metadata.gz: 26a18e0989467083864440f46e803aee30dc1a21e2da5f6076639bfd73b35d63b6e18ced54a3ec735f58e85af0f427cb27a4f20080940444a891640cd8a20b4b
+  data.tar.gz: ec1c235732fa550ebb12a4ca80a90f407ad885ced8785017f7ea394d5242924218222adea318f4e307d10787cdbd4a4f95421e71e11eb515d48a9ab2d61cac5b

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -1,5 +1,11 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.1
+rvm:
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - jruby-9.1.5.0
 before_install: gem install bundler -v 1.12.4

data/README.md

@@ -1,10 +1,13 @@
-# EnumClass
+# Enum
 
-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.
+[![Gem Version](https://badge.fury.io/rb/enum_class.svg)](https://badge.fury.io/rb/enum_class)
+[![Build Status](https://travis-ci.org/LIQIDTechnology/enum_class.svg?branch=master)](https://travis-ci.org/LIQIDTechnology/enum_class)
+[![Coverage Status](https://coveralls.io/repos/github/LIQIDTechnology/enum_class/badge.svg?branch=master)](https://coveralls.io/github/LIQIDTechnology/enum_class?branch=master)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/enum_class/)
+[![Documentation coverage](https://inch-ci.org/github/LIQIDTechnology/enum_class.svg?branch=master)](https://inch-ci.org/github/LIQIDTechnology/enum_class)
+
+This gem is an attempt to provide a lightweight (< 300 LOC) 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 stemmed out from the necessity of handling reliably features like inheritance and support for instance methods on enumerated 
+objects, features that we couldn't find in other [similar](https://github.com/capnregex/enum) [gems](https://github.com/dblock/ruby-enum).
 
 ## Installation
 

data/enum_class.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "coveralls"
 end

data/lib/enum.rb

@@ -156,7 +156,17 @@ class Enum
 
   protected
 
-  # Initializes
+  # When an enumeration is subclassed, this method is called as a constructor instead of #{initialize}
+  # for building values in the child class corresponding to those present in the parent class.
+  #
+  # For the inherited values, #{initialize} is skipped and this method is called instead, receiving as
+  # parameter the value from the parent class.
+  #
+  # Subclasses should override this to provide custom behavior; the default implementation copies all the
+  # instance variables from the provided object to the newly instanciated one.
+  #
+  # @param enum_value [Enum] value of the parent enumeration
+  # @return [void]
   def initialize_from_superclass(enum_value)
     enum_value.instance_variables.each do |ivar|
       instance_variable_set(ivar, enum_value.instance_variable_get(ivar))
@@ -171,7 +181,7 @@ class Enum
     # @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
+      enum_key = value.nil? ? nil : value.upcase.to_sym
       values.find(proc { raise KeyError, "Enumerated value not found: #{value.inspect}" }) { |v| v.key == enum_key }
     end
 
@@ -184,10 +194,6 @@ class Enum
 
     alias [] for
 
-    def inspect
-      "#{name || 'Enum'}(#{values.map(&:to_s).join(', ')})"
-    end
-
     def const_missing(sym)
       self.for(sym)
     rescue
@@ -232,7 +238,7 @@ class Enum
 
       raise DuplicateEnumKey, "#{enum_value.inspect} is already defined" if values.include?(enum_value)
 
-      max_ord = values.max&.ord || -1
+      max_ord = values.max ? values.max.ord : -1
       enum_value.instance_variable_set(:@ord, max_ord + 1)
 
       values << enum_value
@@ -240,6 +246,12 @@ class Enum
       define_method("#{key.downcase}?") { @key == key }
       define_singleton_method(key.to_s.downcase) { self.for(key) }
     end
+
+    public
+
+    def inspect
+      "#{name || 'Enum'}(#{values.map(&:to_s).join(', ')})"
+    end
   end
 
   private_class_method :new

data/lib/enum_class.rb

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

data/lib/enum_class/version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# @!visibility private
 module EnumClass
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enum_class
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michele Piccirillo
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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
@@ -75,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -107,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Object-oriented enumerations for Ruby