ruby-enum 0.6.0 → 0.9.0

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
@@ -10,6 +12,8 @@ module Ruby
     def self.included(base)
       base.extend Enumerable
       base.extend ClassMethods
+
+      base.private_class_method(:new)
     end
 
     module ClassMethods
@@ -18,36 +22,30 @@ module Ruby
       # === Parameters
       # [key] Enumerator key.
       # [value] Enumerator value.
-      def define(key, value)
+      def define(key, value = key)
         @_enum_hash ||= {}
         @_enums_by_value ||= {}
 
         validate_key!(key)
         validate_value!(value)
 
-        new_instance = new(key, value)
-        @_enum_hash[key] = new_instance
-        @_enums_by_value[value] = new_instance
-      end
+        store_new_instance(key, value)
 
-      def validate_key!(key)
-        return unless @_enum_hash.key?(key)
-
-        fail Ruby::Enum::Errors::DuplicateKeyError, name: name, key: key
+        if upper?(key.to_s)
+          const_set key, value
+        else
+          define_singleton_method(key) { value }
+        end
       end
 
-      def validate_value!(value)
-        return unless @_enums_by_value.key?(value)
-
-        fail Ruby::Enum::Errors::DuplicateValueError, name: name, value: value
+      def store_new_instance(key, value)
+        new_instance = new(key, value)
+        @_enum_hash[key] = new_instance
+        @_enums_by_value[value] = new_instance
       end
 
       def const_missing(key)
-        if @_enum_hash[key]
-          @_enum_hash[key].value
-        else
-          fail Ruby::Enum::Errors::UninitializedConstantError, name: name, key: key
-        end
+        raise Ruby::Enum::Errors::UninitializedConstantError, name: name, key: key
       end
 
       # Iterate over all enumerated values.
@@ -89,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.
@@ -110,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.
@@ -120,7 +118,29 @@ module Ruby
 
       # Returns all enum values.
       def values
-        @_enum_hash.values.map(&:value)
+        result = @_enum_hash.values.map(&:value)
+
+        if superclass < Ruby::Enum
+          superclass.values + result
+        else
+          result
+        end
+      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
@@ -128,6 +148,24 @@ module Ruby
           [key, enum.value]
         end]
       end
+
+      private
+
+      def upper?(s)
+        !/[[:upper:]]/.match(s).nil?
+      end
+
+      def validate_key!(key)
+        return unless @_enum_hash.key?(key)
+
+        raise Ruby::Enum::Errors::DuplicateKeyError, name: name, key: key
+      end
+
+      def validate_value!(value)
+        return unless @_enums_by_value.key?(value)
+
+        raise Ruby::Enum::Errors::DuplicateValueError, name: name, value: value
+      end
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ruby
   module Enum
     module Errors
@@ -37,7 +39,7 @@ module Ruby
         #
         # Returns a localized error message string.
         def translate(key, options)
-          ::I18n.translate("#{BASE_KEY}.#{key}", { locale: :en }.merge(options)).strip
+          ::I18n.translate("#{BASE_KEY}.#{key}", **{ locale: :en }.merge(options)).strip
         end
 
         # Create the problem.

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.6.0'
+    VERSION = '0.9.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
@@ -7,6 +9,14 @@ class Colors
   define :GREEN, 'green'
 end
 
+class FirstSubclass < Colors
+  define :ORANGE, 'orange'
+end
+
+class SecondSubclass < FirstSubclass
+  define :PINK, 'pink'
+end
+
 describe Ruby::Enum do
   it 'returns an enum value' do
     expect(Colors::RED).to eq 'red'
@@ -25,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
@@ -55,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
@@ -75,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
@@ -96,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
@@ -129,4 +149,100 @@ describe Ruby::Enum do
       end.to raise_error Ruby::Enum::Errors::DuplicateValueError, /The value red has already been defined./
     end
   end
+
+  describe 'Given a class that has not defined any enums' do
+    class EmptyEnums
+      include Ruby::Enum
+    end
+    it do
+      expect { EmptyEnums::ORANGE }.to raise_error Ruby::Enum::Errors::UninitializedConstantError
+    end
+  end
+
+  context 'when a constant is redefined in a global namespace' do
+    before do
+      RED = 'black'
+    end
+
+    it { expect(Colors::RED).to eq 'red' }
+  end
+
+  describe 'Subclass behavior' do
+    it 'contains the enums defined in the parent class' do
+      expect(FirstSubclass::GREEN).to eq 'green'
+      expect(FirstSubclass::RED).to eq 'red'
+    end
+
+    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 }
+      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'
+      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])
+        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])
+      end
+    end
+  end
+
+  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)
+    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(subject.key?(:created)).to be true
+      expect(subject.key('Created')).to eq :created
+
+      expect(subject.value?('Created')).to be true
+      expect(subject.value(:created)).to eq 'Created'
+
+      expect(subject.key?(:undefined)).to be true
+      expect(subject.key(:undefined)).to eq :undefined
+
+      expect(subject.value?(:undefined)).to be true
+      expect(subject.value(:undefined)).to eq :undefined
+    end
+  end
 end

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,6 +1,12 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rubygems'
+
+require 'simplecov'
+SimpleCov.start
+
 require 'rspec'
 require 'ruby-enum'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-enum
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2021-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: dblock@dblock.org
 executables: []
 extensions: []
@@ -32,12 +32,44 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Dangerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
 - README.md
 - RELEASING.md
 - Rakefile
+- UPGRADING.md
+- 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
+- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc.png
+- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc_disabled.png
+- coverage/assets/0.12.3/application.css
+- coverage/assets/0.12.3/application.js
+- coverage/assets/0.12.3/colorbox/border.png
+- coverage/assets/0.12.3/colorbox/controls.png
+- coverage/assets/0.12.3/colorbox/loading.gif
+- coverage/assets/0.12.3/colorbox/loading_background.png
+- coverage/assets/0.12.3/favicon_green.png
+- coverage/assets/0.12.3/favicon_red.png
+- coverage/assets/0.12.3/favicon_yellow.png
+- coverage/assets/0.12.3/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.12.3/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.12.3/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.12.3/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.12.3/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.12.3/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.12.3/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.12.3/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.12.3/images/ui-icons_222222_256x240.png
+- coverage/assets/0.12.3/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.12.3/images/ui-icons_454545_256x240.png
+- coverage/assets/0.12.3/images/ui-icons_888888_256x240.png
+- 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/index.html
 - lib/config/locales/en.yml
 - lib/ruby-enum.rb
 - lib/ruby-enum/enum.rb
@@ -47,6 +79,7 @@ files:
 - lib/ruby-enum/errors/uninitialized_constant_error.rb
 - lib/ruby-enum/version.rb
 - lib/ruby_enum.rb
+- pkg/ruby-enum-0.8.0.gem
 - ruby-enum.gemspec
 - spec/ruby-enum/enum_spec.rb
 - spec/ruby-enum/version_spec.rb
@@ -55,7 +88,7 @@ homepage: http://github.com/dblock/ruby-enum
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -70,9 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Enum-like behavior for Ruby.
 test_files: []