typesafe_enum 0.2.2 → 0.3.1

data/rakelib/coverage.rake

@@ -0,0 +1,11 @@
+require 'ci/reporter/rake/rspec'
+
+# Configure CI::Reporter report generation
+ENV['GENERATE_REPORTS'] ||= 'true'
+ENV['CI_REPORTS'] = 'artifacts/rspec'
+
+desc 'Run all specs in spec directory, with coverage'
+task coverage: ['ci:setup:rspec'] do
+  ENV['COVERAGE'] ||= 'true'
+  Rake::Task[:spec].invoke
+end

data/rakelib/gem.rake

@@ -0,0 +1,54 @@
+require 'rubygems/gem_runner'
+require 'typesafe_enum/module_info'
+
+gem_root_module = TypesafeEnum
+
+class << gem_root_module
+  def project_root
+    @project_root ||= File.expand_path('..', __dir__)
+  end
+
+  def artifacts_dir
+    return project_root unless ENV['CI']
+
+    @artifacts_dir ||= File.join(project_root, 'artifacts')
+  end
+
+  def gemspec_file
+    @gemspec_file ||= begin
+      gemspec_files = Dir.glob(File.expand_path('*.gemspec', project_root))
+      raise ArgumentError, "Too many .gemspecs: #{gemspec_files.join(', ')}" if gemspec_files.size > 1
+      raise ArgumentError, 'No .gemspec file found' if gemspec_files.empty?
+
+      gemspec_files[0]
+    end
+  end
+
+  def gemspec_basename
+    File.basename(gemspec_file)
+  end
+
+  def output_file
+    @output_file ||= begin
+      gem_name = File.basename(gemspec_file, '.*')
+      version = self::ModuleInfo::VERSION
+      basename = "#{gem_name}-#{version}.gem"
+      File.join(artifacts_dir, basename)
+    end
+  end
+
+  def output_file_relative
+    return File.basename(output_file) unless ENV['CI']
+
+    @output_file_relative ||= begin
+      artifacts_dir_relative = File.basename(artifacts_dir)
+      File.join(artifacts_dir_relative, File.basename(output_file))
+    end
+  end
+end
+
+desc "Build #{gem_root_module.gemspec_basename} as #{gem_root_module.output_file_relative}"
+task :gem do
+  args = ['build', gem_root_module.gemspec_file, "--output=#{gem_root_module.output_file}"]
+  Gem::GemRunner.new.run(args)
+end

data/rakelib/rubocop.rake

@@ -0,0 +1,18 @@
+require 'rubocop'
+require 'rubocop/rake_task'
+
+desc 'Run rubocop with HTML output'
+RuboCop::RakeTask.new(:rubocop) do |cop|
+  output = ENV['RUBOCOP_OUTPUT'] || 'artifacts/rubocop/index.html'
+  puts "Writing RuboCop inspection report to #{output}"
+
+  cop.verbose = false
+  cop.formatters = ['html']
+  cop.options = ['--out', output]
+end
+
+desc 'Run RuboCop with auto-correct, and output results to console'
+task :ra do
+  # b/c we want console output, we can't just use `rubocop:auto_correct`
+  RuboCop::CLI.new.run(['--safe-auto-correct'])
+end

data/rakelib/spec.rake

@@ -0,0 +1,2 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/spec/.rubocop.yml

@@ -1,5 +1,8 @@
 inherit_from: ../.rubocop.yml
 
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
 Style/ClassAndModuleChildren:
   Enabled: false
 

data/spec/unit/typesafe_enum/base_spec.rb

@@ -29,6 +29,19 @@ class Scale < TypesafeEnum::Base
   new :MEGA, 1_000_000
 end
 
+class Scheme < TypesafeEnum::Base
+  new :HTTP, 'http'
+  new :HTTPS, 'https'
+  new :EXAMPLE, 'example'
+  new :UNKNOWN, nil
+end
+
+module Super
+  module Modular
+    class Enum < TypesafeEnum::Base; end
+  end
+end
+
 module TypesafeEnum
   describe Base do
 
@@ -38,6 +51,15 @@ module TypesafeEnum
         expect(enum).to be_a(Suit)
       end
 
+      it 'allows nil values' do
+        expect do
+          class ::NilValues < Base
+            new :NONE, nil
+          end
+        end.not_to raise_error
+        expect(::NilValues.to_a).not_to be_empty
+      end
+
       it 'insists symbols be symbols' do
         expect do
           class ::StringKeys < Base
@@ -80,6 +102,18 @@ module TypesafeEnum
         expect(::DuplicateValues.find_by_key(:ALSO_SPADES)).to be_nil
       end
 
+      it 'disallows duplicate nil values' do
+        expect do
+          class ::DuplicateNilValues < Base
+            new :NONE, nil
+            new :NULL, nil
+          end.to raise_error(NameError)
+          expect(::DuplicateNilValues.to_a).to eq([::DuplicateNilValues::NONE])
+          expect(::DuplicateNilValues::NONE.value).to be_nil
+          expect(::DuplicateNilValues.find_by_key(:NULL)).to be_nil
+        end
+      end
+
       it 'disallows nil keys' do
         expect do
           class ::NilKeys < Base
@@ -93,8 +127,8 @@ module TypesafeEnum
         class ::IdenticalInstances < Base
           new :SPADES, 'spades'
         end
-        expected_msg = /ignoring redeclaration of IdenticalInstances::SPADES with value spades/
-        expect(::IdenticalInstances).to receive(:warn).with(a_string_matching(expected_msg))
+        expected_msg = /ignoring redeclaration of IdenticalInstances::SPADES with value "spades" \(source: .*base_spec.rb:[0-9]+:in `new'\)/
+        expect(::IdenticalInstances).to receive(:warn).once.with(expected_msg)
         class ::IdenticalInstances < Base
           new :SPADES, 'spades'
         end
@@ -111,6 +145,31 @@ module TypesafeEnum
       it 'is private' do
         expect { Tarot.new(:PENTACLES) }.to raise_error(NoMethodError)
       end
+
+      it 'can be overridden' do
+        class ::Extras < Base
+          attr_reader :x1
+          attr_reader :x2
+
+          def initialize(key, x1, x2)
+            super(key)
+            @x1 = x1
+            @x2 = x2
+          end
+
+          new(:AB, 'a', 'b') do
+            def x3
+              'c'
+            end
+          end
+        end
+
+        expect(Extras::AB.key).to eq(:AB)
+        expect(Extras::AB.value).to eq('ab')
+        expect(Extras::AB.x1).to eq('a')
+        expect(Extras::AB.x2).to eq('b')
+        expect(Extras::AB.x3).to eq('c')
+      end
     end
 
     describe :to_a do
@@ -126,13 +185,13 @@ module TypesafeEnum
     end
 
     describe :size do
-      it 'returns the number of enum instnaces' do
+      it 'returns the number of enum instances' do
         expect(Suit.size).to eq(4)
       end
     end
 
     describe :count do
-      it 'returns the number of enum instnaces' do
+      it 'returns the number of enum instances' do
         expect(Suit.count).to eq(4)
       end
 
@@ -146,7 +205,7 @@ module TypesafeEnum
     end
 
     describe :each do
-      it 'iterates the enum values' do
+      it 'iterates the enum instances' do
         expected = [Suit::CLUBS, Suit::DIAMONDS, Suit::HEARTS, Suit::SPADES]
         index = 0
         Suit.each do |s|
@@ -156,6 +215,42 @@ module TypesafeEnum
       end
     end
 
+    describe :keys do
+      it 'returns all keys of all instances' do
+        expect(Suit.keys).to eq(%i[CLUBS DIAMONDS HEARTS SPADES])
+      end
+    end
+
+    describe :values do
+      it 'returns all values of all instances' do
+        expect(Suit.values).to eq(%w[clubs diamonds hearts spades])
+      end
+
+    end
+
+    describe :each_key do
+      it 'iterates the enum keys' do
+        expected = %i[CLUBS DIAMONDS HEARTS SPADES]
+        index = 0
+        Suit.each_key do |s|
+          expect(s).to eq(expected[index])
+          index += 1
+        end
+      end
+
+    end
+
+    describe :each_value do
+      it 'iterates the enum values' do
+        expected = %w[clubs diamonds hearts spades]
+        index = 0
+        Suit.each_value do |s|
+          expect(s).to eq(expected[index])
+          index += 1
+        end
+      end
+    end
+
     describe :each_with_index do
       it 'iterates the enum values with indices' do
         expected = [Suit::CLUBS, Suit::DIAMONDS, Suit::HEARTS, Suit::SPADES]
@@ -302,6 +397,20 @@ module TypesafeEnum
           expect(s.value).to eq(expected[index])
         end
       end
+
+      it 'returns an explicit value' do
+        expected = [10, 100, 1000, 1_000_000]
+        Scale.each_with_index do |s, index|
+          expect(s.value).to eq(expected[index])
+        end
+      end
+
+      it 'supports nil values' do
+        expected = ['http', 'https', 'example', nil]
+        Scheme.each_with_index do |s, index|
+          expect(s.value).to eq(expected[index])
+        end
+      end
     end
 
     describe :key do
@@ -324,10 +433,10 @@ module TypesafeEnum
     describe :to_s do
       it 'provides an informative string' do
         aggregate_failures 'informative string' do
-          [Suit, Tarot, RGBColor, Scale].each do |ec|
+          [Suit, Tarot, RGBColor, Scale, Scheme].each do |ec|
             ec.each do |ev|
               result = ev.to_s
-              [ec.to_s, ev.key, ev.ord, ev.value].each do |info|
+              [ec.to_s, ev.key, ev.ord, ev.value.inspect].each do |info|
                 expect(result).to include(info.to_s)
               end
             end
@@ -374,6 +483,44 @@ module TypesafeEnum
           expect(Scale.find_by_value(s.value)).to be(s)
         end
       end
+
+      it 'supports enums with explicit nil values' do
+        Scheme.each do |s|
+          expect(Scheme.find_by_value(s.value)).to be(s)
+        end
+      end
+    end
+
+    describe :find_by_value! do
+      it 'maps values to enum instances' do
+        values = %w[clubs diamonds hearts spades]
+        expected = Suit.to_a
+        values.each_with_index do |n, index|
+          expect(Suit.find_by_value!(n)).to be(expected[index])
+        end
+      end
+
+      it 'throws EnumValidationError for invalid values' do
+        expect { Suit.find_by_value!('wands') }.to raise_error(Exceptions::EnumValidationError)
+      end
+
+      it 'supports enums with symbol values' do
+        RGBColor.each do |c|
+          expect(RGBColor.find_by_value!(c.value)).to be(c)
+        end
+      end
+
+      it 'supports enums with integer values' do
+        Scale.each do |s|
+          expect(Scale.find_by_value!(s.value)).to be(s)
+        end
+      end
+
+      it 'supports enums with explicit nil values' do
+        Scheme.each do |s|
+          expect(Scheme.find_by_value!(s.value)).to be(s)
+        end
+      end
     end
 
     describe :find_by_value_str do
@@ -400,6 +547,44 @@ module TypesafeEnum
           expect(Scale.find_by_value_str(s.value.to_s)).to be(s)
         end
       end
+
+      it 'supports enums with explicit nil values' do
+        Scheme.each do |s|
+          expect(Scheme.find_by_value_str(s.value)).to be(s)
+        end
+      end
+    end
+
+    describe :find_by_value_str! do
+      it 'maps string values to enum instances' do
+        values = %w[clubs diamonds hearts spades]
+        expected = Suit.to_a
+        values.each_with_index do |n, index|
+          expect(Suit.find_by_value_str!(n)).to be(expected[index])
+        end
+      end
+
+      it 'throws EnumValidationError for invalid values' do
+        expect { Suit.find_by_value_str!('wands') }.to raise_error(Exceptions::EnumValidationError)
+      end
+
+      it 'supports enums with symbol values' do
+        RGBColor.each do |c|
+          expect(RGBColor.find_by_value_str!(c.value.to_s)).to be(c)
+        end
+      end
+
+      it 'supports enums with integer values' do
+        Scale.each do |s|
+          expect(Scale.find_by_value_str!(s.value.to_s)).to be(s)
+        end
+      end
+
+      it 'supports enums with explicit nil values' do
+        Scheme.each do |s|
+          expect(Scheme.find_by_value_str!(s.value)).to be(s)
+        end
+      end
     end
 
     describe :find_by_ord do
@@ -422,6 +607,13 @@ module TypesafeEnum
       end
     end
 
+    describe :class_name do
+      it 'returns the demodulized class name' do
+        expect(Super::Modular::Enum.send(:class_name)).to eq 'Enum'
+        expect(Suit.send(:class_name)).to eq 'Suit'
+      end
+    end
+
     it 'supports case statements' do
       def pip(suit)
         case suit

data/typesafe_enum.gemspec

@@ -7,10 +7,10 @@ require 'uri'
 require 'typesafe_enum/module_info'
 
 Gem::Specification.new do |spec|
-  spec.name          = TypesafeEnum::NAME
-  spec.version       = TypesafeEnum::VERSION
+  spec.name          = TypesafeEnum::ModuleInfo::NAME
+  spec.version       = TypesafeEnum::ModuleInfo::VERSION
   spec.authors       = ['David Moles']
-  spec.email         = ['david.moles@ucop.edu']
+  spec.email         = ['dmoles@berkeley.edu']
   spec.summary       = 'Typesafe enum pattern for Ruby'
   spec.description   = 'A gem that implements the typesafe enum pattern in Ruby'
   spec.license       = 'MIT'
@@ -23,9 +23,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.add_development_dependency 'ci_reporter_rspec', '~> 1.0'
+  spec.add_development_dependency 'colorize', '~> 0.8'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'rubocop', '~> 0.80'
+  spec.add_development_dependency 'rubocop', '0.91'
   spec.add_development_dependency 'simplecov', '~> 0.18'
   spec.add_development_dependency 'simplecov-console', '~> 0.7'
   spec.add_development_dependency 'yard', '~> 0.9', '>= 0.9.12'

metadata

@@ -1,35 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: typesafe_enum
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - David Moles
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2022-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: ci_reporter_rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -48,16 +70,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: '0.91'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: '0.91'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -108,12 +130,22 @@ dependencies:
         version: 0.9.12
 description: A gem that implements the typesafe enum pattern in Ruby
 email:
-- david.moles@ucop.edu
+- dmoles@berkeley.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
+- ".idea/.rakeTasks"
+- ".idea/codeStyles/Project.xml"
+- ".idea/codeStyles/codeStyleConfig.xml"
+- ".idea/go.imports.xml"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/typesafe_enum.iml"
+- ".idea/vcs.xml"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
@@ -125,7 +157,13 @@ files:
 - Rakefile
 - lib/typesafe_enum.rb
 - lib/typesafe_enum/base.rb
+- lib/typesafe_enum/class_methods.rb
+- lib/typesafe_enum/exceptions.rb
 - lib/typesafe_enum/module_info.rb
+- rakelib/coverage.rake
+- rakelib/gem.rake
+- rakelib/rubocop.rake
+- rakelib/spec.rake
 - spec/.rubocop.yml
 - spec/spec_helper.rb
 - spec/unit/typesafe_enum/base_spec.rb
@@ -134,7 +172,7 @@ homepage: https://github.com/dmolesUC/typesafe_enum
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,15 +180,15 @@ 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: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Typesafe enum pattern for Ruby
 test_files: