ruby-enum 0.9.0 → 1.1.0

data/spec/ruby-enum/enum_spec.rb

@@ -2,30 +2,54 @@
 
 require 'spec_helper'
 
-class Colors
-  include Ruby::Enum
+describe Ruby::Enum do
+  class Colors
+    include Ruby::Enum
 
-  define :RED, 'red'
-  define :GREEN, 'green'
-end
+    define :RED, 'red'
+    define :GREEN, 'green'
+  end
 
-class FirstSubclass < Colors
-  define :ORANGE, 'orange'
-end
+  class FirstSubclass < Colors
+    define :ORANGE, 'orange'
+  end
 
-class SecondSubclass < FirstSubclass
-  define :PINK, 'pink'
-end
+  class SecondSubclass < FirstSubclass
+    define :PINK, 'pink'
+  end
+
+  class OtherSecondSubclass < FirstSubclass
+    include Ruby::Enum
+
+    define :MAGENTA, 'magenta'
+  end
 
-describe Ruby::Enum do
   it 'returns an enum value' do
     expect(Colors::RED).to eq 'red'
     expect(Colors::GREEN).to eq 'green'
   end
-  it 'raises UninitializedConstantError on an invalid constant' do
-    expect { Colors::ANYTHING }.to raise_error Ruby::Enum::Errors::UninitializedConstantError, /The constant Colors::ANYTHING has not been defined./
+
+  context 'when the i18n gem is loaded' do
+    it 'raises UninitializedConstantError on an invalid constant' do
+      expect do
+        Colors::ANYTHING
+      end.to raise_error Ruby::Enum::Errors::UninitializedConstantError, /The constant Colors::ANYTHING has not been defined./
+    end
   end
-  context '#each' do
+
+  context 'when the i18n gem is not loaded' do
+    before do
+      allow(described_class).to receive(:i18n).and_return(Ruby::Enum::I18nMock)
+    end
+
+    it 'raises UninitializedConstantError on an invalid constant' do
+      expect do
+        Colors::ANYTHING
+      end.to raise_error Ruby::Enum::Errors::UninitializedConstantError, /ruby.enum.errors.messages.uninitialized_constant.summary/
+    end
+  end
+
+  describe '#each' do
     it 'iterates over constants' do
       keys = []
       enum_keys = []
@@ -40,7 +64,8 @@ describe Ruby::Enum do
       expect(enum_values).to eq %w[red green]
     end
   end
-  context '#map' do
+
+  describe '#map' do
     it 'maps constants' do
       key_key_values = Colors.map do |key, enum|
         [key, enum.key, enum.value]
@@ -50,103 +75,211 @@ describe Ruby::Enum do
       expect(key_key_values[1]).to eq [:GREEN, :GREEN, 'green']
     end
   end
-  context '#parse' do
+
+  describe '#parse' do
     it 'parses exact value' do
       expect(Colors.parse('red')).to eq(Colors::RED)
     end
+
     it 'is case-insensitive' do
       expect(Colors.parse('ReD')).to eq(Colors::RED)
     end
+
     it 'returns nil for a null value' do
       expect(Colors.parse(nil)).to be_nil
     end
+
     it 'returns nil for an invalid value' do
       expect(Colors.parse('invalid')).to be_nil
     end
   end
-  context '#key?' do
+
+  describe '#key?' do
     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)
+        expect(Colors.key?(key)).to be(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)
+        expect(Colors.key?(key)).to be(true)
       end
     end
+
     it 'returns false for invalid keys' do
-      expect(Colors.key?(:NOT_A_KEY)).to eq(false)
+      expect(Colors.key?(:NOT_A_KEY)).to be(false)
     end
   end
-  context '#value' do
+
+  describe '#value' do
     it 'returns string values for keys' do
       Colors.each do |key, enum|
         expect(Colors.value(key)).to eq(enum.value)
       end
     end
+
     it 'returns nil for an invalid key' do
       expect(Colors.value(:NOT_A_KEY)).to be_nil
     end
   end
-  context '#value?' do
+
+  describe '#value?' do
     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)
+        expect(Colors.value?(value)).to be(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)
+        expect(Colors.value?(value)).to be(true)
       end
     end
+
     it 'returns false for invalid values' do
-      expect(Colors.value?('I am not a value')).to eq(false)
+      expect(Colors.value?('I am not a value')).to be(false)
     end
   end
-  context '#key' do
+
+  describe '#key' do
     it 'returns enum instances for values' do
-      Colors.each do |_, enum|
+      Colors.each do |_, enum| # rubocop:disable Style/HashEachMethods
         expect(Colors.key(enum.value)).to eq(enum.key)
       end
     end
+
     it 'returns nil for an invalid value' do
       expect(Colors.key('invalid')).to be_nil
     end
   end
-  context '#keys' do
+
+  describe '#keys' do
     it 'returns keys' do
       expect(Colors.keys).to eq(%i[RED GREEN])
     end
   end
-  context '#values' do
+
+  describe '#values' do
     it 'returns values' do
       expect(Colors.values).to eq(%w[red green])
     end
+
+    context 'when a subclass is defined' do
+      it 'returns all values' do
+        expect(FirstSubclass.values).to eq(%w[red green orange])
+      end
+    end
+
+    context 'when a subclass of a subclass is defined' do
+      it 'returns all values' do
+        expect(SecondSubclass.values).to eq(%w[red green orange pink])
+      end
+    end
+
+    context 'when a subclass of a subclass is defined with redundant module inclusion' do
+      it 'returns all values' do
+        expect(OtherSecondSubclass.values).to eq(%w[red green orange magenta])
+      end
+    end
   end
-  context '#to_h' do
+
+  describe '#to_h' do
     it 'returns a hash of key:values' do
       expect(Colors.to_h).to eq(RED: 'red', GREEN: 'green')
     end
   end
 
-  context 'on duplicate keys' do
-    it 'raises DuplicateKeyError' do
-      expect do
-        Colors.class_eval do
-          define :RED, 'some'
-        end
-      end.to raise_error Ruby::Enum::Errors::DuplicateKeyError, /The constant Colors::RED has already been defined./
+  context 'when a duplicate key is used' do
+    context 'when the i18n gem is loaded' do
+      it 'raises DuplicateKeyError' do
+        expect do
+          Colors.class_eval do
+            define :RED, 'some'
+          end
+        end.to raise_error Ruby::Enum::Errors::DuplicateKeyError, /The constant Colors::RED has already been defined./
+      end
+    end
+
+    context 'when the i18n gem is not loaded' do
+      before do
+        allow(described_class).to receive(:i18n).and_return(Ruby::Enum::I18nMock)
+      end
+
+      it 'raises DuplicateKeyError' do
+        expect do
+          Colors.class_eval do
+            define :RED, 'some'
+          end
+        end.to raise_error Ruby::Enum::Errors::DuplicateKeyError, /ruby.enum.errors.messages.duplicate_key.message/
+      end
     end
   end
 
-  context 'on duplicate values' do
-    it 'raises a DuplicateValueError' do
-      expect do
-        Colors.class_eval do
-          define :Other, 'red'
+  context 'when a duplicate value is used' do
+    context 'when the i18n gem is loaded' do
+      it 'raises a DuplicateValueError' do
+        expect do
+          Colors.class_eval do
+            define :Other, 'red'
+          end
+        end.to raise_error Ruby::Enum::Errors::DuplicateValueError, /The value red has already been defined./
+      end
+    end
+
+    context 'when the i18n gem is not loaded' do
+      before do
+        allow(described_class).to receive(:i18n).and_return(Ruby::Enum::I18nMock)
+      end
+
+      it 'raises a DuplicateValueError' do
+        expect do
+          Colors.class_eval do
+            define :Other, 'red'
+          end
+        end.to raise_error Ruby::Enum::Errors::DuplicateValueError, /ruby.enum.errors.messages.duplicate_value.summary/
+      end
+    end
+  end
+
+  describe 'Reloading enum definition' do
+    it 'can be lazy reloaded' do
+      class_body = proc do
+        include Ruby::Enum
+
+        define :BUZZ_CUT, 'buzz_cut'
+      end
+
+      hair_styles = Class.new(&class_body)
+
+      expect { hair_styles.class_eval(&class_body) }.not_to raise_error
+    end
+
+    context 'when a subclass is defined' do
+      it 'NEEDS to include Ruby::Enum explicitly to be lazy reloaded' do
+        hair_styles = Class.new do
+          include Ruby::Enum
+
+          define :BUZZ_CUT, 'buzz_cut'
+        end
+
+        broken_subclass_body = proc do
+          define :PONYTAIL, 'ponytail'
+        end
+        broken_subclass = Class.new(hair_styles, &broken_subclass_body)
+        expect { broken_subclass.class_eval(&broken_subclass_body) }
+          .to raise_error Ruby::Enum::Errors::DuplicateKeyError, /PONYTAIL/
+
+        subclass_body = proc do
+          include Ruby::Enum
+
+          define :PONYTAIL, 'ponytail'
         end
-      end.to raise_error Ruby::Enum::Errors::DuplicateValueError, /The value red has already been defined./
+        more_hair_styles = Class.new(hair_styles, &subclass_body)
+
+        expect { more_hair_styles.class_eval(&subclass_body) }.not_to raise_error
+        expect(more_hair_styles.values).to eq(%w[buzz_cut ponytail])
+      end
     end
   end
 
@@ -176,32 +309,29 @@ describe Ruby::Enum do
     it 'contains its own enums' do
       expect(FirstSubclass::ORANGE).to eq 'orange'
     end
+
     it 'parent class should not have enums defined in child classes' do
       expect { Colors::ORANGE }.to raise_error Ruby::Enum::Errors::UninitializedConstantError
     end
-    context 'Given a 2 level depth subclass' do
-      subject { SecondSubclass }
+
+    context 'when defining a 2 level depth subclass' do
       it 'contains its own enums and all the enums defined in the parent classes' do
-        expect(subject::RED).to eq 'red'
-        expect(subject::GREEN).to eq 'green'
-        expect(subject::ORANGE).to eq 'orange'
-        expect(subject::PINK).to eq 'pink'
+        expect(SecondSubclass::RED).to eq 'red'
+        expect(SecondSubclass::GREEN).to eq 'green'
+        expect(SecondSubclass::ORANGE).to eq 'orange'
+        expect(SecondSubclass::PINK).to eq 'pink'
       end
 
       describe '#values' do
-        subject { SecondSubclass.values }
-
         it 'contains the values from all of the parent classes' do
-          expect(subject).to eq(%w[red green orange pink])
+          expect(SecondSubclass.values).to eq(%w[red green orange pink])
         end
       end
     end
 
     describe '#values' do
-      subject { FirstSubclass.values }
-
       it 'contains the values from the parent class' do
-        expect(subject).to eq(%w[red green orange])
+        expect(FirstSubclass.values).to eq(%w[red green orange])
       end
     end
   end
@@ -209,40 +339,40 @@ describe Ruby::Enum do
   describe 'default value' do
     class Default
       include Ruby::Enum
+
       define :KEY
     end
 
-    subject { Default::KEY }
-
     it 'equals the key' do
-      expect(subject).to eq(:KEY)
+      expect(Default::KEY).to eq(:KEY)
     end
   end
 
   describe 'non constant definitions' do
     class States
       include Ruby::Enum
+
       define :created, 'Created'
       define :published, 'Published'
       define :undefined
     end
-    subject { States }
+
     it 'behaves like an enum' do
-      expect(subject.created).to eq 'Created'
-      expect(subject.published).to eq 'Published'
-      expect(subject.undefined).to eq :undefined
+      expect(States.created).to eq 'Created'
+      expect(States.published).to eq 'Published'
+      expect(States.undefined).to eq :undefined
 
-      expect(subject.key?(:created)).to be true
-      expect(subject.key('Created')).to eq :created
+      expect(States.key?(:created)).to be true
+      expect(States.key('Created')).to eq :created
 
-      expect(subject.value?('Created')).to be true
-      expect(subject.value(:created)).to eq 'Created'
+      expect(States.value?('Created')).to be true
+      expect(States.value(:created)).to eq 'Created'
 
-      expect(subject.key?(:undefined)).to be true
-      expect(subject.key(:undefined)).to eq :undefined
+      expect(States.key?(:undefined)).to be true
+      expect(States.key(:undefined)).to eq :undefined
 
-      expect(subject.value?(:undefined)).to be true
-      expect(subject.value(:undefined)).to eq :undefined
+      expect(States.value?(:undefined)).to be true
+      expect(States.value(:undefined)).to eq :undefined
     end
   end
 end

data/spec/spec_helper.rb

@@ -4,8 +4,8 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rubygems'
 
-require 'simplecov'
-SimpleCov.start
+require 'coveralls'
+Coveralls.wear!
 
 require 'rspec'
 require 'ruby-enum'

data/spec_i18n/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec path: '../', name: 'ruby-enum'
+
+# This Gemfile should not include any gem that has i18n as a dependency.
+gem 'rake'
+gem 'rspec', '~> 3.0'

data/spec_i18n/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: %i[spec]

data/spec_i18n/spec/i18n_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module I18n
+  class Colors
+    include Ruby::Enum
+
+    define :RED, 'red'
+    define :GREEN, 'green'
+  end
+end
+
+describe Ruby::Enum do
+  context 'when the i18n gem is not loaded' do
+    it 'raises UninitializedConstantError on an invalid constant' do
+      expect do
+        I18n::Colors::ANYTHING
+      end.to raise_error Ruby::Enum::Errors::UninitializedConstantError, /ruby.enum.errors.messages.uninitialized_constant.summary/
+    end
+
+    context 'when a duplicate key is used' do
+      before do
+        allow(described_class).to receive(:i18n).and_return(Ruby::Enum::I18nMock)
+      end
+
+      it 'raises DuplicateKeyError' do
+        expect do
+          I18n::Colors.class_eval do
+            define :RED, 'some'
+          end
+        end.to raise_error Ruby::Enum::Errors::DuplicateKeyError, /ruby.enum.errors.messages.duplicate_key.message/
+      end
+    end
+
+    context 'when a duplicate value is used' do
+      before do
+        allow(described_class).to receive(:i18n).and_return(Ruby::Enum::I18nMock)
+      end
+
+      it 'raises a DuplicateValueError' do
+        expect do
+          I18n::Colors.class_eval do
+            define :Other, 'red'
+          end
+        end.to raise_error Ruby::Enum::Errors::DuplicateValueError, /ruby.enum.errors.messages.duplicate_value.summary/
+      end
+    end
+  end
+end

data/spec_i18n/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+
+require 'rubygems'
+
+require 'rspec'
+require 'ruby-enum'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby-enum
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-31 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2026-06-20 00:00:00.000000000 Z
+dependencies: []
 description:
 email: dblock@dblock.org
 executables: []
@@ -40,6 +26,7 @@ files:
 - RELEASING.md
 - Rakefile
 - UPGRADING.md
+- benchmarks/case.rb
 - coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc.png
 - coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc_disabled.png
 - coverage/assets/0.12.3/DataTables-1.10.20/images/sort_both.png
@@ -69,10 +56,41 @@ files:
 - coverage/assets/0.12.3/images/ui-icons_cd0a0a_256x240.png
 - coverage/assets/0.12.3/loading.gif
 - coverage/assets/0.12.3/magnify.png
+- coverage/assets/0.13.2/DataTables-1.10.20/images/sort_asc.png
+- coverage/assets/0.13.2/DataTables-1.10.20/images/sort_asc_disabled.png
+- coverage/assets/0.13.2/DataTables-1.10.20/images/sort_both.png
+- coverage/assets/0.13.2/DataTables-1.10.20/images/sort_desc.png
+- coverage/assets/0.13.2/DataTables-1.10.20/images/sort_desc_disabled.png
+- coverage/assets/0.13.2/application.css
+- coverage/assets/0.13.2/application.js
+- coverage/assets/0.13.2/colorbox/border.png
+- coverage/assets/0.13.2/colorbox/controls.png
+- coverage/assets/0.13.2/colorbox/loading.gif
+- coverage/assets/0.13.2/colorbox/loading_background.png
+- coverage/assets/0.13.2/favicon_green.png
+- coverage/assets/0.13.2/favicon_red.png
+- coverage/assets/0.13.2/favicon_yellow.png
+- coverage/assets/0.13.2/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.13.2/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.13.2/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.13.2/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.13.2/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.13.2/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.13.2/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.13.2/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.13.2/images/ui-icons_222222_256x240.png
+- coverage/assets/0.13.2/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.13.2/images/ui-icons_454545_256x240.png
+- coverage/assets/0.13.2/images/ui-icons_888888_256x240.png
+- coverage/assets/0.13.2/images/ui-icons_cd0a0a_256x240.png
+- coverage/assets/0.13.2/loading.gif
+- coverage/assets/0.13.2/magnify.png
 - coverage/index.html
 - lib/config/locales/en.yml
 - lib/ruby-enum.rb
 - lib/ruby-enum/enum.rb
+- lib/ruby-enum/enum/case.rb
+- lib/ruby-enum/enum/i18n_mock.rb
 - lib/ruby-enum/errors/base.rb
 - lib/ruby-enum/errors/duplicate_key_error.rb
 - lib/ruby-enum/errors/duplicate_value_error.rb
@@ -80,14 +98,21 @@ files:
 - lib/ruby-enum/version.rb
 - lib/ruby_enum.rb
 - pkg/ruby-enum-0.8.0.gem
+- pkg/ruby-enum-0.9.0.gem
 - ruby-enum.gemspec
+- spec/ruby-enum/enum/case_spec.rb
 - spec/ruby-enum/enum_spec.rb
 - spec/ruby-enum/version_spec.rb
 - spec/spec_helper.rb
+- spec_i18n/Gemfile
+- spec_i18n/Rakefile
+- spec_i18n/spec/i18n_spec.rb
+- spec_i18n/spec/spec_helper.rb
 homepage: http://github.com/dblock/ruby-enum
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -96,14 +121,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Enum-like behavior for Ruby.