ruby-enum 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 47e52bdfbc7d70944470141e18c1629d058326c0
-  data.tar.gz: 3992c7e739aea0799d6adc820e03b6bba5f17357
+SHA256:
+  metadata.gz: 828a267d2038050652f611d901ef0039355a1cbc73dffb9174751333bfd98a0d
+  data.tar.gz: 10172c5b07f0eeeacb0c0d8a5902e4bb691003419dcad6f71f93893969410a43
 SHA512:
-  metadata.gz: 79c51dec06a07ccb4b6bcbbfd18101798e885674bf0d3f6e95e7833f70c8d99485a87739d6e6b644f3f7d34e8488417b116aa3a6d4c2311343cb8fdd597eca46
-  data.tar.gz: a532c64b93a9ec0a44b68db66a81f6b206ee9d65c40f156ce91da89fd00a6124a61e2b59a1bc902ace03580cb79a74b4a09fdb77a4e5c0a2172c8f7dca81c035
+  metadata.gz: c782b4bc5071e684ec45a00b58ef705b0a46a008d7b67e485ee0881bc7bbe4deca1e5abd6dd86db493b535040db9456a9b848d945bef4a126eed9db26c5ac8fb
+  data.tar.gz: 1c5df9425c445ab3cfdaca44b29d53437ba0519d59144a9dad00d155a1d586615783b64e2c35bf73ab87a4b9c9df193707b3ae7a31782cc0b699ec98b1151068

data/CHANGELOG.md

@@ -1,36 +1,42 @@
-### 0.7.2 (15/3/2017)
+### 0.8.0 (2020/3/27)
 
-* [#18](https://github.com/dblock/ruby-enum/pull/18): Adds support for non constant definition - [@laertispappas](https://github.com/laertispappas).
+* [#22](https://github.com/dblock/ruby-enum/pull/22): Added `Ruby::Enum#each_key` and `Ruby::Enum#each_value` - [@dblock](https://github.com/dblock).
+* [#22](https://github.com/dblock/ruby-enum/pull/22): Dropped support for Ruby 2.2 - [@dblock](https://github.com/dblock).
+* [#22](https://github.com/dblock/ruby-enum/pull/22): Upgraded RuboCop to 0.80.1 - [@dblock](https://github.com/dblock).
 
-### 0.7.1 (23/2/2017)
+### 0.7.2 (2017/3/15)
 
-* [#16](https://github.com/dblock/ruby-enum/pull/16): Replaces const_missing method in favor of const_set - [@laertispappas](https://github.com/laertispappas).
+* [#18](https://github.com/dblock/ruby-enum/pull/18): Added support for non constant definition - [@laertispappas](https://github.com/laertispappas).
 
-### 0.7.0 (21/2/2017)
+### 0.7.1 (2017/2/23)
 
-* [#3](https://github.com/dblock/ruby-enum/pull/13): Adds support for sub classing an Enum - [@laertispappas](https://github.com/laertispappas).
+* [#16](https://github.com/dblock/ruby-enum/pull/16): Replaced `const_missing` with `const_set` - [@laertispappas](https://github.com/laertispappas).
 
-### 0.6.0 (12/5/2016)
+### 0.7.0 (2017/2/21)
+
+* [#3](https://github.com/dblock/ruby-enum/pull/13): Added support for subclassing an Enum - [@laertispappas](https://github.com/laertispappas).
+
+### 0.6.0 (2016/5/12)
 
 * [#12](https://github.com/dblock/ruby-enum/pull/12): A `Ruby::Enum::Errors::DuplicateKeyError` or a `Ruby::Enum::Errors::DuplciateKeyValyeError` will now be raised when duplicate keys / values are defined - [@laertispappas](https://github.com/laertispappas).
 
-### 0.5.0 (11/20/2015)
+### 0.5.0 (2015/20/11)
 
 * [#8](https://github.com/dblock/ruby-enum/pull/8): Added `Ruby::Enum#key`, `Ruby::Enum#value`, `Ruby::Enum#key?`, and `Ruby::Enum#value?` - [@dmolesUC3](https://github.com/dmolesUC3).
 
-### 0.4.0 (6/29/2014)
+### 0.4.0 (2014/29/6)
 
 * [#5](https://github.com/dblock/ruby-enum/pull/5): Mixed in `Enumerable` - [@kgann](https://github.com/kgann).
 
-### 0.3.0 (5/19/2014)
+### 0.3.0 (2014/19/5)
 
 * [#4](https://github.com/dblock/ruby-enum/pull/4): Added `Ruby::Enum#map` - [@ArnaudRinquin](https://github.com/ArnaudRinquin).
 
-### 0.2.1 (5/15/2013)
+### 0.2.1 (2013/15/5)
 
 * Added `Ruby::Enum#values`, `Ruby::Enum#keys` and `Ruby::Enum#to_h` - [@dblock](https://github.com/dblock).
 * A `Ruby::Enum::Errors::UninitializedConstantError` will now be raised when referencing an undefined enum - [@dblock](https://github.com/dblock).
 
-### 0.1.0 (5/14/2013)
+### 0.1.0 (2013/14/5)
 
 * Initial public release, live-coded during [May 2013 NYC.rb](http://code.dblock.org/your-first-ruby-gem) - [@dblock](https://github.com/dblock).

data/Gemfile

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec
 
 gem 'rake'
-gem 'rspec', '~> 3.4.0'
-gem 'rubocop', '0.47.1'
+
+group :development, :test do
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '0.80.1'
+end

data/Gemfile.lock

@@ -1,53 +1,56 @@
 PATH
   remote: .
   specs:
-    ruby-enum (0.7.2)
+    ruby-enum (0.8.0)
       i18n
 
 GEM
   remote: http://rubygems.org/
   specs:
     ast (2.4.0)
-    concurrent-ruby (1.0.5)
-    diff-lcs (1.2.5)
-    i18n (1.0.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    powerpack (0.1.1)
-    rainbow (2.2.2)
-      rake
-    rake (11.3.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    rubocop (0.47.1)
-      parser (>= 2.3.3.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    unicode-display_width (1.3.0)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   rake
-  rspec (~> 3.4.0)
-  rubocop (= 0.47.1)
+  rspec (~> 3.0)
+  rubocop (= 0.80.1)
   ruby-enum!
 
 BUNDLED WITH
-   1.15.3
+   2.1.2

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2016 Daniel Doubrovkine.
+Copyright (c) 2013-2020 Daniel Doubrovkine.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,17 +2,18 @@ Ruby::Enum
 ==========
 
 [![Gem Version](http://img.shields.io/gem/v/ruby-enum.svg)](http://badge.fury.io/rb/ruby-enum)
-[![Build Status](http://img.shields.io/travis/dblock/ruby-enum.svg)](https://travis-ci.org/dblock/ruby-enum)
-[![Dependency Status](https://gemnasium.com/dblock/ruby-enum.svg)](https://gemnasium.com/dblock/ruby-enum)
+[![Build Status](https://travis-ci.org/dblock/ruby-enum.svg?branch=master)](https://travis-ci.org/dblock/ruby-enum)
 [![Code Climate](https://codeclimate.com/github/dblock/ruby-enum.svg)](https://codeclimate.com/github/dblock/ruby-enum)
 
 Enum-like behavior for Ruby, heavily inspired by [this](http://www.rubyfleebie.com/enumerations-and-ruby) and improved upon [another blog post](http://code.dblock.org/how-to-define-enums-in-ruby).
 
 ## Usage
 
-Enums can be defined and accessed either as constants or class methods. For example below we have two Ruby::Enum classes
-where the first one (Colors) defines its enums and references them as constants. The second class (State) defines and
-references its enums as class methods.
+Enums can be defined and accessed either as constants or class methods, which is a matter of preference.
+
+### Constants
+
+Define enums and reference them as constants.
 
 ``` ruby
 class Colors
@@ -21,18 +22,8 @@ class Colors
   define :RED, "red"
   define :GREEN, "green"
 end
-
-# or for versions >= 0.7.2
-class State
-  include Ruby::Enum
-
-  define :created, 'Created'
-  define :published, 'Published'
-end
 ```
 
-### Referencing
-
 ``` ruby
 Colors::RED # "red"
 Colors::GREEN # "green"
@@ -40,16 +31,33 @@ Colors::UNDEFINED # raises Ruby::Enum::Errors::UninitializedConstantError
 Colors.keys # [ :RED, :GREEN ]
 Colors.values # [ "red", "green" ]
 Colors.to_h # { :RED => "red", :GREEN => "green" }
+```
+
+### Class Methods
+
+Define enums reference them as class methods.
+
+``` ruby
+class OrderState
+  include Ruby::Enum
+
+  define :created, 'Created'
+  define :paid, 'Paid'
+end
+```
 
-State.created # "Created"
-State.published # "Published"
-State.undefined # NoMethodError is raised
-State.keys # [ :created, :published ]
-State.values # ["Created", "Published"]
-State.to_h # { :created => 'Created', :published => 'Published' }
+```ruby
+OrderState.created # "Created"
+OrderState.paid # "Paid"
+OrderState.undefined # NoMethodError is raised
+OrderState.keys # [ :created, :paid ]
+OrderState.values # ["Created", "Paid"]
+OrderState.to_h # { :created => 'Created', :paid => 'Paid' }
 ```
 
-### All `Enumerable` methods are supported.
+### Enumerating
+
+All `Enumerable` methods are supported.
 
 #### Iterating
 
@@ -60,6 +68,18 @@ Colors.each do |key, enum|
 end
 ```
 
+``` ruby
+Colors.each_key do |key|
+  # :RED, :GREEN
+end
+```
+
+``` ruby
+Colors.each_value do |value|
+  # "red", "green"
+end
+```
+
 #### Mapping
 
 ``` ruby
@@ -95,7 +115,9 @@ end
 # => [ [:GREEN, #<Colors:...>], [:RED, #<Colors:...>] ]
 ```
 
-### Several hash-like methods are supported.
+### Hashing
+
+Several hash-like methods are supported.
 
 #### Retrieving keys and values
 
@@ -139,7 +161,6 @@ Colors.key('yellow')
 # => nil
 ```
 
-
 ### Duplicate enumerator keys or duplicate values
 
 Defining duplicate enums will raise a `Ruby::Enum::Errors::DuplicateKeyError`. Moreover a duplicate
@@ -177,7 +198,7 @@ You're encouraged to contribute to this gem. See [CONTRIBUTING](CONTRIBUTING.md)
 
 ## Copyright and License
 
-Copyright (c) 2013-2016, Daniel Doubrovkine and [Contributors](CHANGELOG.md).
+Copyright (c) 2013-2020, Daniel Doubrovkine and [Contributors](CHANGELOG.md).
 
 This project is licensed under the [MIT License](LICENSE.md).
 

data/RELEASING.md

@@ -1,6 +1,6 @@
 # Releasing Ruby-Enum
 
-There're no hard rules about when to release ruby-enum. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+There're no hard rules about when to release ruby-enum. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
 
 ### Release
 
@@ -58,7 +58,7 @@ Next Release
 
 Increment the third version number in [lib/ruby-enum/version.rb](lib/ruby-enum/version.rb).
 
-Comit your changes.
+Commit your changes.
 
 ```
 git add CHANGELOG.md lib/ruby-enum/version.rb

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/gem_tasks'
 
@@ -13,4 +15,4 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]

data/lib/ruby-enum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'i18n'
 
 require 'ruby-enum/version'

data/lib/ruby-enum/enum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ruby
   module Enum
     attr_reader :key, :value
@@ -85,7 +87,7 @@ module Ruby
       # Returns the corresponding enum instance or nil.
       def value(k)
         enum = @_enum_hash[k]
-        enum.value if enum
+        enum&.value
       end
 
       # Whether the specified value exists in this enum.
@@ -106,7 +108,7 @@ module Ruby
       # Returns the corresponding key symbol or nil.
       def key(v)
         enum = @_enums_by_value[v]
-        enum.key if enum
+        enum&.key
       end
 
       # Returns all enum keys.
@@ -119,6 +121,22 @@ module Ruby
         @_enum_hash.values.map(&:value)
       end
 
+      # Iterate over all enumerated values.
+      # Required for Enumerable mixin
+      def each_value(&_block)
+        @_enum_hash.each_value do |v|
+          yield v.value
+        end
+      end
+
+      # Iterate over all enumerated keys.
+      # Required for Enumerable mixin
+      def each_key(&_block)
+        @_enum_hash.each_value do |v|
+          yield v.key
+        end
+      end
+
       def to_h
         Hash[@_enum_hash.map do |key, enum|
           [key, enum.value]

data/lib/ruby-enum/errors/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ruby
   module Enum
     module Errors
@@ -26,7 +28,7 @@ module Ruby
 
         private
 
-        BASE_KEY = 'ruby.enum.errors.messages'.freeze #:nodoc:
+        BASE_KEY = 'ruby.enum.errors.messages' #:nodoc:
 
         # Given the key of the specific error and the options hash, translate the
         # message.

data/lib/ruby-enum/errors/duplicate_key_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ruby
   module Enum
     module Errors

data/lib/ruby-enum/errors/duplicate_value_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ruby
   module Enum
     module Errors

data/lib/ruby-enum/errors/uninitialized_constant_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ruby
   module Enum
     module Errors

data/lib/ruby-enum/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Ruby
   module Enum
-    VERSION = '0.7.2'.freeze
+    VERSION = '0.8.0'
   end
 end

data/lib/ruby_enum.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'ruby-enum'

data/ruby-enum.gemspec

@@ -1,4 +1,6 @@
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'ruby-enum/version'
 
 Gem::Specification.new do |s|

data/spec/ruby-enum/enum_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 class Colors
@@ -33,9 +35,9 @@ describe Ruby::Enum do
         enum_keys << enum.key
         enum_values << enum.value
       end
-      expect(keys).to eq [:RED, :GREEN]
-      expect(enum_keys).to eq [:RED, :GREEN]
-      expect(enum_values).to eq %w(red green)
+      expect(keys).to eq %i[RED GREEN]
+      expect(enum_keys).to eq %i[RED GREEN]
+      expect(enum_values).to eq %w[red green]
     end
   end
   context '#map' do
@@ -63,8 +65,13 @@ describe Ruby::Enum do
     end
   end
   context '#key?' do
-    it 'returns true for valid keys' do
-      Colors.keys.each do |key|
+    it 'returns true for valid keys accessed directly' do
+      Colors.keys.each do |key| # rubocop:disable Style/HashEachMethods
+        expect(Colors.key?(key)).to eq(true)
+      end
+    end
+    it 'returns true for valid keys accessed via each_keys' do
+      Colors.each_key do |key|
         expect(Colors.key?(key)).to eq(true)
       end
     end
@@ -83,8 +90,13 @@ describe Ruby::Enum do
     end
   end
   context '#value?' do
-    it 'returns true for valid values' do
-      Colors.values.each do |value|
+    it 'returns true for valid values accessed directly' do
+      Colors.values.each do |value| # rubocop:disable Style/HashEachMethods
+        expect(Colors.value?(value)).to eq(true)
+      end
+    end
+    it 'returns true for valid values accessed via each_value' do
+      Colors.each_value do |value|
         expect(Colors.value?(value)).to eq(true)
       end
     end
@@ -104,12 +116,12 @@ describe Ruby::Enum do
   end
   context '#keys' do
     it 'returns keys' do
-      expect(Colors.keys).to eq([:RED, :GREEN])
+      expect(Colors.keys).to eq(%i[RED GREEN])
     end
   end
   context '#values' do
     it 'returns values' do
-      expect(Colors.values).to eq(%w(red green))
+      expect(Colors.values).to eq(%w[red green])
     end
   end
   context '#to_h' do
@@ -149,7 +161,7 @@ describe Ruby::Enum do
 
   context 'when a constant is redefined in a global namespace' do
     before do
-      RED = 'black'.freeze
+      RED = 'black'
     end
 
     it { expect(Colors::RED).to eq 'red' }

data/spec/ruby-enum/version_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Ruby::Enum do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rubygems'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-enum
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2020-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -47,7 +47,6 @@ files:
 - lib/ruby-enum/errors/uninitialized_constant_error.rb
 - lib/ruby-enum/version.rb
 - lib/ruby_enum.rb
-- pkg/ruby-enum-0.6.0.gem
 - ruby-enum.gemspec
 - spec/ruby-enum/enum_spec.rb
 - spec/ruby-enum/version_spec.rb
@@ -71,8 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Enum-like behavior for Ruby.