ruby-enum 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26cee9efd34000cd0b004832d0eaae6ba5b90a3668c039b7490c3b7c0605e965
-  data.tar.gz: 4d5b7744d335dc558f3953d0b9ad27d38d44b7a40219cbd29ad3f360e7d54100
+  metadata.gz: aca947b7b06abbc0504549ab9fa43e99be4d3e0dc408a92b8e10efea700d9bf7
+  data.tar.gz: 7e57ab06229ac0552b984630493f04dd98a3579b7ca8151c819dc792417d505f
 SHA512:
-  metadata.gz: 982371ddb8393adf84259e32f20df8e69de71c2084e5dcd49d52e30a3c17941a5321dcac5ecb6f2aa194486963037e61034609d05ec1c3e1681599fe59fdd936
-  data.tar.gz: a69948eefae40413871fc3f4c4d49b218428c86a13eeeaba256d903337fb7e1d972fb4689bd6bd8ab9c4c58ac44e414d49a4ee3ee2bdddaf9e23deed47fbcbc4
+  metadata.gz: f626bd0c2c072f17734527253a8ae95e96dc0631779f6d56b398c540a9d63c3b41eb000647d276d81f859ae92f11e5a0a74e9966cf96f1796cad5ef172c42239
+  data.tar.gz: 2d58616dc04acf94a9a7e65029fe6422224717bb849cd07513782206ecc543b4d478a7d539b5fa1d434ab3b841430772406cd112438152541242d32a3081e38e

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 1.0.0 (2023/01/10)
+
+* [#41](https://github.com/dblock/ruby-enum/pull/41): Make i18n dependency optional - [@peterfication](https://github.com/peterfication).
+* [#43](https://github.com/dblock/ruby-enum/pull/43): Add exhaustive case matcher - [@peterfication](https://github.com/peterfication).
+* [#40](https://github.com/dblock/ruby-enum/pull/39): Enable new Rubocop cops and address/allowlist lints - [@petergoldstein](https://github.com/petergoldstein).
+* [#39](https://github.com/dblock/ruby-enum/pull/39): Require Ruby >= 2.7 - [@petergoldstein](https://github.com/petergoldstein).
+* [#38](https://github.com/dblock/ruby-enum/pull/38): Ensure Ruby >= 2.3 - [@ojab](https://github.com/ojab).
+
 ### 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).

data/Gemfile

@@ -11,7 +11,9 @@ group :development, :test do
   gem 'danger-changelog', '0.6.1'
   gem 'danger-toc', '0.2.0'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '0.80.1'
+  gem 'rubocop', '~> 1.0'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
 end
 
 group :test do

data/Gemfile.lock

@@ -1,43 +1,49 @@
 PATH
   remote: .
   specs:
-    ruby-enum (0.9.0)
-      i18n
+    ruby-enum (1.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (6.1.0)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    claide (1.0.3)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
+    claide (1.1.0)
     claide-plugins (0.9.2)
       cork
       nap
       open4 (~> 1.3)
     colored2 (3.1.2)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (8.2.1)
+    danger (9.4.2)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (>= 0.9.0, < 2.0)
+      faraday (>= 0.9.0, < 3.0)
       faraday-http-cache (~> 2.0)
-      git (~> 1.7)
+      git (~> 1.13)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
-      octokit (~> 4.7)
-      terminal-table (~> 1)
+      octokit (>= 4.0)
+      terminal-table (>= 1, < 4)
     danger-changelog (0.6.1)
       danger-plugin-api (~> 1.0)
     danger-plugin-api (1.0.0)
@@ -46,80 +52,102 @@ GEM
       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)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    drb (2.2.0)
       ruby2_keywords
-    faraday-http-cache (2.2.0)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-http-cache (2.5.0)
       faraday (>= 0.8)
-    faraday-net_http (1.0.0)
-    git (1.8.1)
+    faraday-net_http (3.0.2)
+    git (1.19.0)
+      addressable (~> 2.8)
       rchardet (~> 1.8)
-    i18n (1.8.7)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    kramdown (2.3.0)
+    json (2.7.1)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    minitest (5.14.3)
-    multipart-post (2.1.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
     nap (1.1.0)
     no_proxy_fix (0.1.2)
-    octokit (4.20.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
+    octokit (8.0.0)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
     open4 (1.3.4)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.24.0)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.1)
+      racc
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
     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)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
-      rexml
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.2)
-    sawyer (0.8.2)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.0)
+      rubocop (~> 1.33)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.26.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
       addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
-    simplecov (0.21.2)
+      faraday (>= 0.17.3, < 3)
+    simplecov (0.22.0)
       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)
+    simplecov_json_formatter (0.1.4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.6.1)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
+  arm64-darwin-21
   ruby
 
 DEPENDENCIES
@@ -128,9 +156,11 @@ DEPENDENCIES
   danger-toc (= 0.2.0)
   rake
   rspec (~> 3.0)
-  rubocop (= 0.80.1)
+  rubocop (~> 1.0)
+  rubocop-rake
+  rubocop-rspec
   ruby-enum!
   simplecov
 
 BUNDLED WITH
-   2.1.4
+   2.5.1

data/README.md

@@ -24,6 +24,9 @@ Enum-like behavior for Ruby, heavily inspired by [this](http://www.rubyfleebie.c
     - [Mapping values to keys](#mapping-values-to-keys)
   - [Duplicate enumerator keys or duplicate values](#duplicate-enumerator-keys-or-duplicate-values)
   - [Inheritance](#inheritance)
+  - [Exhaustive case matcher](#exhaustive-case-matcher)
+  - [I18n support](#i18n-support)
+- [Benchmarks](#benchmarks)
 - [Contributing](#contributing)
 - [Copyright and License](#copyright-and-license)
 - [Related Projects](#related-projects)
@@ -259,6 +262,62 @@ OrderState.values # ['CREATED', 'PAID']
 ShippedOrderState.values # ['CREATED', 'PAID', 'PREPARED', SHIPPED']
 ```
 
+### Exhaustive case matcher
+
+If you want to make sure that you cover all cases in a case stament, you can use the exhaustive case matcher: `Ruby::Enum::Case`. It will raise an error if a case/enum value is not handled, or if a value is specified that's not part of the enum. This is inspired by the [Rust Pattern Syntax](https://doc.rust-lang.org/book/ch18-03-pattern-syntax.html). If multiple cases match, all matches are being executed. The return value is the value from the matched case, or an array of return values if multiple cases matched.
+
+> NOTE: This will add checks at runtime which might lead to worse performance. See [benchmarks](#benchmarks).
+
+> NOTE: `:else` is a reserved keyword if you want to use `Ruby::Enum::Case`.
+
+```ruby
+class Color < OrderState
+  include Ruby::Enum
+  include Ruby::Enum::Case
+
+  define :RED, :red
+  define :GREEN, :green
+  define :BLUE, :blue
+  define :YELLOW, :yellow
+end
+```
+
+```ruby
+color = Color::RED
+Color.Case(color, {
+  [Color::GREEN, Color::BLUE] => -> { "order is green or blue" },
+  Color::YELLOW => -> { "order is yellow" },
+  Color::RED => -> { "order is red" },
+})
+```
+
+It also supports default/else:
+
+```ruby
+color = Color::RED
+Color.Case(color, {
+  [Color::GREEN, Color::BLUE] => -> { "order is green or blue" },
+  else: -> { "order is yellow or red" },
+})
+```
+
+### I18n support
+
+This gem has an optional dependency to `i18n`. If it's available, the error messages will have a nice description and can be translated. If it's not available, the errors will only contain the message keys.
+
+```ruby
+# Add this to your Gemfile if you want to have a nice error description instead of just a message key.
+gem "i18n"
+```
+
+## Benchmarks
+
+Benchmark scripts are defined in the [`benchmarks`](benchmarks) folder and can be run with Rake:
+
+```console
+rake benchmarks:case
+```
+
 ## Contributing
 
 You're encouraged to contribute to ruby-enum. See [CONTRIBUTING](CONTRIBUTING.md) for details.

data/Rakefile

@@ -16,3 +16,10 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
 task default: %i[rubocop spec]
+
+namespace :benchmark do
+  desc 'Run benchmark for the Ruby::Enum::Case'
+  task :case do
+    require_relative 'benchmarks/case'
+  end
+end

data/benchmarks/case.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'benchmark'
+require 'ruby-enum'
+
+##
+# Test enum
+class Color
+  include Ruby::Enum
+  include Ruby::Enum::Case
+
+  define :RED, :red
+  define :GREEN, :green
+  define :BLUE, :blue
+end
+
+puts 'Running 1.000.000 normal case statements'
+case_statement_time = Benchmark.realtime do
+  1_000_000.times do
+    case Color::RED
+    when Color::RED, Color::GREEN
+      'red or green'
+    when Color::BLUE
+      'blue'
+    end
+  end
+end
+
+puts 'Running 1.000.000 ruby-enum case statements'
+ruby_enum_time = Benchmark.realtime do
+  1_000_000.times do
+    Color.case(Color::RED,
+               {
+                 [Color::RED, Color::GREEN] => -> { 'red or green' },
+                 Color::BLUE => -> { 'blue' }
+               })
+  end
+end
+
+puts "ruby-enum case: #{ruby_enum_time.round(4)}"
+puts "case statement: #{case_statement_time.round(4)}"
+
+puts "ruby-enum case is #{(ruby_enum_time / case_statement_time).round(2)} times slower"