ruby-enum 0.6.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4fc128cc7839208ced2d3cf393b21c82f3ebdfe6
-  data.tar.gz: ce5e04b5b1d5e9756a4b4f761bb1d8f127d9e24c
+SHA256:
+  metadata.gz: 26cee9efd34000cd0b004832d0eaae6ba5b90a3668c039b7490c3b7c0605e965
+  data.tar.gz: 4d5b7744d335dc558f3953d0b9ad27d38d44b7a40219cbd29ad3f360e7d54100
 SHA512:
-  metadata.gz: 56ad33d14d0cf9e59f2237387e79422ce7b4cfbaf65fa47162bf1d60e6e3efeb843e321b0fa56f69059bfcef0506f4b6f3faab5d0168cdc756f8ef6ca760f291
-  data.tar.gz: 4a5a8d5bf5b64eeb155f9d3f8b20d271e8d752dc52287e9623efff4db795ed23424cf084545946220b89724c3ac7882205c38bb604b98f79e0bf160f0e82455a
+  metadata.gz: 982371ddb8393adf84259e32f20df8e69de71c2084e5dcd49d52e30a3c17941a5321dcac5ecb6f2aa194486963037e61034609d05ec1c3e1681599fe59fdd936
+  data.tar.gz: a69948eefae40413871fc3f4c4d49b218428c86a13eeeaba256d903337fb7e1d972fb4689bd6bd8ab9c4c58ac44e414d49a4ee3ee2bdddaf9e23deed47fbcbc4

data/CHANGELOG.md

@@ -1,24 +1,50 @@
-### 0.6.0 (12/5/2016)
+### 0.9.0 (2021/01/21)
+
+* [#34](https://github.com/dblock/ruby-enum/pull/34): Added support for Ruby 3.0 - [@dblock](https://github.com/dblock).
+* [#29](https://github.com/dblock/ruby-enum/pull/29): Added superclass values when enumerating with `Ruby::Enum#values` - [@gi](https://github.com/gi).
+* [#30](https://github.com/dblock/ruby-enum/pull/30): Default value to key - [@gi](https://github.com/gi).
+* [#34](https://github.com/dblock/ruby-enum/pull/34): Replaced Travis-CI with Github Actions, added Danger PR linter - [@dblock](https://github.com/dblock).
+* [#37](https://github.com/dblock/ruby-enum/pull/37): Added code coverage - [@dblock](https://github.com/dblock).
+
+### 0.8.0 (2020/03/27)
+
+* [#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.2 (2017/03/15)
+
+* [#18](https://github.com/dblock/ruby-enum/pull/18): Added support for non constant definition - [@laertispappas](https://github.com/laertispappas).
+
+### 0.7.1 (2017/02/23)
+
+* [#16](https://github.com/dblock/ruby-enum/pull/16): Replaced `const_missing` with `const_set` - [@laertispappas](https://github.com/laertispappas).
+
+### 0.7.0 (2017/02/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/05/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/11/20)
 
 * [#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/06/29)
 
 * [#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/05/19)
 
 * [#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/05/15)
 
 * 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/05/14)
 
 * Initial public release, live-coded during [May 2013 NYC.rb](http://code.dblock.org/your-first-ruby-gem) - [@dblock](https://github.com/dblock).

data/Dangerfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+changelog.check!
+toc.check!

data/Gemfile

@@ -1,7 +1,19 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec
 
-gem 'rspec', '~> 3.4.0'
 gem 'rake'
-gem 'rubocop', '0.35.1'
+
+group :development, :test do
+  gem 'danger'
+  gem 'danger-changelog', '0.6.1'
+  gem 'danger-toc', '0.2.0'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '0.80.1'
+end
+
+group :test do
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -1,53 +1,136 @@
 PATH
   remote: .
   specs:
-    ruby-enum (0.6.0)
+    ruby-enum (0.9.0)
       i18n
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ast (2.3.0)
-    astrolabe (1.3.1)
-      parser (~> 2.2)
-    diff-lcs (1.2.5)
-    i18n (0.7.0)
-    parser (2.3.3.1)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    rainbow (2.1.0)
-    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)
+    activesupport (6.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    colored2 (3.1.2)
+    concurrent-ruby (1.1.7)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.2.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-changelog (0.6.1)
+      danger-plugin-api (~> 1.0)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    danger-toc (0.2.0)
+      activesupport
+      danger-plugin-api (~> 1.0)
+      kramdown
+    diff-lcs (1.3)
+    docile (1.3.5)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-net_http (1.0.0)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    minitest (5.14.3)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    no_proxy_fix (0.1.2)
+    octokit (4.20.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rchardet (1.8.0)
+    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.35.1)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.3.0, < 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)
-      tins (<= 1.6.0)
-    ruby-progressbar (1.8.1)
-    tins (1.6.0)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.2)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.6.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  danger
+  danger-changelog (= 0.6.1)
+  danger-toc (= 0.2.0)
   rake
-  rspec (~> 3.4.0)
-  rubocop (= 0.35.1)
+  rspec (~> 3.0)
+  rubocop (= 0.80.1)
   ruby-enum!
+  simplecov
 
 BUNDLED WITH
-   1.13.6
+   2.1.4

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2015 Daniel Doubrovkine.
+Copyright (c) 2013-2021 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,158 +2,270 @@ 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://github.com/dblock/ruby-enum/workflows/test/badge.svg?branch=master)](https://github.com/dblock/ruby-enum/actions)
 [![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).
+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).
+
+## Table of Contents
+
+- [Usage](#usage)
+  - [Constants](#constants)
+  - [Class Methods](#class-methods)
+  - [Default Value](#default-value)
+  - [Enumerating](#enumerating)
+    - [Iterating](#iterating)
+    - [Mapping](#mapping)
+    - [Reducing](#reducing)
+    - [Sorting](#sorting)
+  - [Hashing](#hashing)
+    - [Retrieving keys and values](#retrieving-keys-and-values)
+    - [Mapping keys to values](#mapping-keys-to-values)
+    - [Mapping values to keys](#mapping-values-to-keys)
+  - [Duplicate enumerator keys or duplicate values](#duplicate-enumerator-keys-or-duplicate-values)
+  - [Inheritance](#inheritance)
+- [Contributing](#contributing)
+- [Copyright and License](#copyright-and-license)
+- [Related Projects](#related-projects)
 
 ## Usage
 
+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
+class OrderState
   include Ruby::Enum
 
-  define :RED, "red"
-  define :GREEN, "green"
+  define :CREATED, 'created'
+  define :PAID, 'paid'
 end
 ```
 
-### Referencing
+``` ruby
+OrderState::CREATED # 'created'
+OrderState::PAID # 'paid'
+OrderState::UNKNOWN # raises Ruby::Enum::Errors::UninitializedConstantError
+OrderState.keys # [ :CREATED, :PAID ]
+OrderState.values # [ 'created', 'paid' ]
+OrderState.to_h # { :CREATED => 'created', :PAID => 'paid' }
+```
+
+### Class Methods
+
+Define enums, and reference them as class methods.
 
 ``` ruby
-Colors::RED # "red"
-Colors::GREEN # "green"
-Colors::UNDEFINED # raises Ruby::Enum::Errors::UninitializedConstantError
-Colors.keys # [ :RED, :GREEN ]
-Colors.values # [ "red", "green" ]
-Colors.to_h # { :RED => "red", :GREEN => "green" }
+class OrderState
+  include Ruby::Enum
+
+  define :created, 'created'
+  define :paid, 'paid'
+end
 ```
 
-### All `Enumerable` methods are supported.
+```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' }
+```
+
+### Default Value
+
+The value is optional. If unspecified, the value will default to the key.
+
+``` ruby
+class OrderState
+  include Ruby::Enum
+
+  define :UNSPECIFIED
+  define :unspecified
+end
+```
+
+``` ruby
+OrderState::UNSPECIFIED # :UNSPECIFIED
+OrderState.unspecified # :unspecified
+```
+
+### Enumerating
+
+Enums support all `Enumerable` methods.
 
 #### Iterating
 
 ``` ruby
-Colors.each do |key, enum|
-  # key and enum.key is :RED, :GREEN
-  # enum.value is "red", "green"
+OrderState.each do |key, enum|
+  # key and enum.key are :CREATED, :PAID
+  # enum.value is 'created', 'paid'
+end
+```
+
+``` ruby
+OrderState.each_key do |key|
+  # :CREATED, :PAID
+end
+```
+
+``` ruby
+OrderState.each_value do |value|
+  # 'created', 'paid'
 end
 ```
 
 #### Mapping
 
 ``` ruby
-Colors.map do |key, enum|
-  # key and enum.key is :RED, :GREEN
-  # enum.value is "red", "green"
+OrderState.map do |key, enum|
+  # key and enum.key are :CREATED, :PAID
+  # enum.value is 'created', 'paid'
   [enum.value, key]
 end
 
-# => [ ['red', :RED], ['green', :GREEN] ]
+# => [ ['created', :CREATED], ['paid', :PAID] ]
 ```
 
 #### Reducing
 
 ``` ruby
-Colors.reduce([]) do |arr, (key, enum)|
-  # key and enum.key is :RED, :GREEN
-  # enum.value is "red", "green"
+OrderState.reduce([]) do |arr, (key, enum)|
+  # key and enum.key are :CREATED, :PAID
+  # enum.value is 'created', 'paid'
   arr << [enum.value, key]
 end
 
-# => [ ['red', :RED], ['green', :GREEN] ]
+# => [ ['created', :CREATED], ['paid', :PAID] ]
 ```
 
 #### Sorting
+
 ``` ruby
-Colors.sort_by do |key, enum|
-  # key and enum.key is :RED, :GREEN
-  # enum.value is "red", "green"
-  enum.value
+OrderState.sort_by do |key, enum|
+  # key and enum.key are :CREATED, :PAID
+  # enum.value is 'created', 'paid'
+  enum.value.length
 end
 
-# => [ [:GREEN, #<Colors:...>], [:RED, #<Colors:...>] ]
+# => [[:PAID, #<OrderState:0x0 @key=:PAID, @value="paid">], [:CREATED, #<OrderState:0x1 @key=:CREATED, @value="created">]]
 ```
 
-### Several hash-like methods are supported.
+### Hashing
+
+Several hash-like methods are supported.
 
 #### Retrieving keys and values
 
 ``` ruby
-Colors.keys
-# => [:RED, :GREEN]
+OrderState.keys
+# => [:CREATED, :PAID]
 
-Colors.values
-# => ["red", "green"]
+OrderState.values
+# => ['created', 'paid']
 ```
 
 #### Mapping keys to values
 
 ``` ruby
-Colors.key?(:RED)
+OrderState.key?(:CREATED)
 # => true
 
-Colors.value(:RED)
-# => "red"
+OrderState.value(:CREATED)
+# => 'created'
 
-Colors.key?(:BLUE)
+OrderState.key?(:FAILED)
 # => false
 
-Colors.value(:BLUE)
+OrderState.value(:FAILED)
 # => nil
 ```
 
 #### Mapping values to keys
 
 ``` ruby
-Colors.value?('green')
+OrderState.value?('paid')
 # => true
 
-Colors.key('green')
-# => :GREEN
+OrderState.key('paid')
+# => :PAID
 
-Colors.value?('yellow')
+OrderState.value?('failed')
 # => false
 
-Colors.key('yellow')
+OrderState.key('failed')
 # => nil
 ```
 
+### Duplicate enumerator keys or duplicate values
 
-## Duplicate enumerator keys or duplicate values
+Defining duplicate enums raises `Ruby::Enum::Errors::DuplicateKeyError`.
 
-Defining duplicate enums will raise a `Ruby::Enum::Errors::DuplicateKeyError`. Moreover a duplicate
-value is not allowed. Defining a duplicate value will raise a `Ruby::Enum::Errors::DuplicateKeyError`.
-The following declarations will both raise an exception:
+```ruby
+class OrderState
+  include Ruby::Enum
+
+  define :CREATED, 'created'
+  define :CREATED, 'recreated' # raises DuplicateKeyError
+end
+```
+
+Defining a duplicate value raises `Ruby::Enum::Errors::DuplicateValueError`.
 
 ```ruby
-  class Colors
-    include Ruby::Enum
+class OrderState
+  include Ruby::Enum
 
-    define :RED, "red"
-    define :RED, "my red" # will raise a DuplicateKeyError exception
-  end
+  define :CREATED, 'created'
+  define :RECREATED, 'created' # raises DuplicateValueError
+end
+```
 
-  # The following will raise a DuplicateValueError
-  class Colots
-    include Ruby::Enum
+The `DuplicateValueError` exception is raised to be consistent with the unique key constraint. Since keys are unique, there needs to be a way to map values to keys using `OrderState.value('created')`.
 
-    define :RED, 'red'
-    define :SOME, 'red' # Boom
-  end
+### Inheritance
+
+When inheriting from a `Ruby::Enum` class, all defined enums in the parent class will be accessible in sub classes as well. Sub classes can also provide extra enums, as usual.
+
+``` ruby
+class OrderState
+  include Ruby::Enum
+
+  define :CREATED, 'CREATED'
+  define :PAID, 'PAID'
+end
+
+class ShippedOrderState < OrderState
+  define :PREPARED, 'PREPARED'
+  define :SHIPPED, 'SHIPPED'
+end
+```
+
+``` ruby
+ShippedOrderState::CREATED # 'CREATED'
+ShippedOrderState::PAID # 'PAID'
+ShippedOrderState::PREPARED # 'PREPARED'
+ShippedOrderState::SHIPPED # 'SHIPPED'
 ```
 
-The `DuplicateValueError` exception is thrown to be consistent with the unique key constraint.
-Since keys are unique there is no way to map values to keys using `Colors.key('red')`
+The `values` class method will enumerate the values from all base classes.
+
+``` ruby
+OrderState.values # ['CREATED', 'PAID']
+ShippedOrderState.values # ['CREATED', 'PAID', 'PREPARED', SHIPPED']
+```
 
 ## Contributing
 
-You're encouraged to contribute to this gem. See [CONTRIBUTING](CONTRIBUTING.md) for details.
+You're encouraged to contribute to ruby-enum. See [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## Copyright and License
 
-Copyright (c) 2013-2015, Daniel Doubrovkine and [Contributors](CHANGELOG.md).
+Copyright (c) 2013-2021, Daniel Doubrovkine and [Contributors](CHANGELOG.md).
 
 This project is licensed under the [MIT License](LICENSE.md).