typesafe_enum 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e1176c5141f142b7273ea78e428250bdf6d1035a7d396e4eff850200c450f0e
-  data.tar.gz: 8348631d2f84b3a56f8008be1638b667544fa9a557cbbf8e75a0ea1a421bbaf0
+  metadata.gz: bb07ad036d64d6c64c976b86db50a4f94a33c85fb18410077551282ad2d32f51
+  data.tar.gz: 0c9a2342fa1163a2475fe0c7bb7656c333e678a66ae5be47b6beed9934cebd17
 SHA512:
-  metadata.gz: '0590bab7859bd8d61a2846814179553dab741911a0919f8c90446642af3991a75fc2d6ef3be8979eb2713e4b1860379b8acd4e978f708459ba006b8540a613fb'
-  data.tar.gz: a7135f565f5b37526e159acce7e4fdeee98f556d7acb02dce9b52fb38e7036fb38d2891954a3bb29d8cabfeb5dc72e4f8fad7e4486a6029ccb4dc424da0854f6
+  metadata.gz: 8a39483acf17f3a706dd61caa5cebd6c269789a23baf8b36ce0c7f3e4a870d3e0dc15b47753e268505417e00d769dea6d1e1719a9e5570fba5af9f8329da37ea
+  data.tar.gz: b02640de3559f49920ae311c6cd2b68411a78bd38763289cb87726c3c4989d0ed49c98a1f2d0450d9a8ef79b0782cca1f62968d61ea83ce61deff1978b24e267

data/.gitignore

@@ -1,6 +1,7 @@
 # IDEA
 
 .idea
+/out/
 
 # Ruby defaults
 

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 0.2.2 (23 April 2020)
+
+- Implement [`Enumerable`](https://ruby-doc.org/core-2.6.5/Enumerable.html)
+
 ## 0.2.1 (12 March 2020)
 
 - Update to Rake 12.3.3

data/README.md

@@ -14,23 +14,25 @@ with syntax loosely inspired by [Ruby::Enum](https://github.com/dblock/ruby-enum
 - [Basic usage](#basic-usage)
 - [Ordering](#ordering)
 - [String representations](#string-representations)
+- [Enumerable](#enumerable)
 - [Convenience methods on enum classes](#convenience-methods-on-enum-classes)
-    - [::to\_a](#to_a)
-    - [::size](#size)
-    - [::each, ::each\_with\_index, and ::map](#each-each_with_index-and-map)
-    - [::find\_by\_key, ::find\_by\_value, ::find\_by\_ord](#find_by_key-find_by_value-find_by_ord)
-    - [::find\_by\_value\_str](#find_by_value_str)
+   - [#to_a](#to_a)
+   - [#size](#size)
+   - [#each, <code>#each_with_index</code>, <code>#map</code> and <code>#flat_map</code>](#each-each_with_index-map-and-flat_map)
+   - [#find_by_key, <code>#find_by_value</code>, <code>#find_by_ord</code>](#find_by_key-find_by_value-find_by_ord)
+   - [#find_by_value_str](#find_by_value_str)
 - [Enum classes with methods](#enum-classes-with-methods)
 - [Enum instances with methods](#enum-instances-with-methods)
-- [How is this different from Ruby::Enum?](#how-is-this-different-from-rubyenum)
+- [How is this different from <a href="https://github.com/dblock/ruby-enum">Ruby::Enum</a>?](#how-is-this-different-from-rubyenum)
 - [How is this different from java.lang.Enum?](#how-is-this-different-from-javalangenum)
-    - [Clunkier syntax](#clunkier-syntax)
-    - [No special switch/case support](#no-special-switchcase-support)
-    - [No serialization support](#no-serialization-support)
-    - [No support classes](#no-support-classes)
-    - [Enum classes are not closed](#enum-classes-are-not-closed)
+   - [Clunkier syntax](#clunkier-syntax)
+   - [No special switch/<code>case</code> support](#no-special-switchcase-support)
+   - [No serialization support](#no-serialization-support)
+   - [No support classes](#no-support-classes)
+   - [Enum classes are not closed](#enum-classes-are-not-closed)
 - [Contributing](#contributing)
 
+
 ## Basic usage
 
 Create a new enum class and a set of instances:
@@ -199,9 +201,19 @@ Suit::DIAMONDS.to_s
 
 It can of course be overridden.
 
+## `Enumerable`
+
+As of version 0.2.2, `TypesafeEnum` classes implement
+[`Enumerable`](https://ruby-doc.org/core-2.6.5/Enumerable.html),
+so they support methods such as
+[`#find`](https://ruby-doc.org/core-2.6.5/Enumerable.html#method-i-find),
+[`#select`](https://ruby-doc.org/core-2.6.5/Enumerable.html#method-i-select), 
+and  [`#reduce`](https://ruby-doc.org/core-2.6.5/Enumerable.html#method-i-reduce),
+in addition to the convenience methods called out specifically below.
+
 ## Convenience methods on enum classes
 
-### `::to_a`
+### `#to_a`
 
 Returns an array of the enum instances in declaration order:
 
@@ -210,7 +222,7 @@ Tarot.to_a
 # => [#<Tarot:0x007fd4db30eca8 @key=:CUPS, @value="Cups", @ord=0>, #<Tarot:0x007fd4db30ebe0 @key=:COINS, @value="Coins", @ord=1>, #<Tarot:0x007fd4db30eaf0 @key=:WANDS, @value="Wands", @ord=2>, #<Tarot:0x007fd4db30e9b0 @key=:SWORDS, @value="Swords", @ord=3>]
 ```
 
-### `::size`
+### `#size`
 
 Returns the number of enum instances:
 
@@ -219,7 +231,7 @@ Suit.size
 # => 4
 ```
 
-### `::each`, `::each_with_index`, and `::map`
+### `#each`, `#each_with_index`, `#map` and `#flat_map`
 
 Iterate over the set of enum instances:
 
@@ -238,9 +250,12 @@ Suit.each_with_index { |s, i| puts "#{i}: #{s.key}" }
 
 Suit.map(&:value)
 # => ["clubs", "diamonds", "hearts", "spades"]
+
+Suit.flat_map { |s| [s.key, s.value] }
+# => [:CLUBS, "clubs", :DIAMONDS, "diamonds", :HEARTS, "hearts", :SPADES, "spades"]
 ```
 
-### `::find_by_key`, `::find_by_value`, `::find_by_ord`
+### `#find_by_key`, `#find_by_value`, `#find_by_ord`
 
 Look up an enum instance based on its key, value, or ordinal:
 
@@ -253,7 +268,7 @@ Tarot.find_by_ord(3)
 # => #<Tarot:0x007faab19fd810 @key=:SWORDS, @value="Swords", @ord=3>
 ```
 
-### `::find_by_value_str`
+### `#find_by_value_str`
 
 Look up an enum instance based on the string form of its value (as returned by `to_s`) --
 useful for, e.g., XML or JSON mapping of enums with non-string values:

data/lib/typesafe_enum/base.rb

@@ -8,6 +8,7 @@ module TypesafeEnum
     include Comparable
 
     class << self
+      include Enumerable
 
       # Returns an array of the enum instances in declaration order
       # @return [Array<self>] All instances of this enum, in declaration order
@@ -18,32 +19,16 @@ module TypesafeEnum
       # Returns the number of enum instances
       # @return [Integer] the number of instances
       def size
-        as_array ? as_array.length : 0
+        as_array.size
       end
 
       # Iterates over the set of enum instances
       # @yield [self] Each instance of this enum, in declaration order
-      # @return [Array<self>] All instances of this enum, in declaration order
+      # @return [Enumerator<self>] All instances of this enum, in declaration order
       def each(&block)
         to_a.each(&block)
       end
 
-      # Iterates over the set of enum instances
-      # @yield [self, Integer] Each instance of this enum, in declaration order,
-      #   with its ordinal index
-      # @return [Array<self>] All instances of this enum, in declaration order
-      def each_with_index(&block)
-        to_a.each_with_index(&block)
-      end
-
-      # Iterates over the set of enum instances
-      # @yield [self] Each instance of this enum, in declaration order
-      # @return [Array] An array containing the result of applying `&block`
-      #   to each instance of this enum, in instance declaration order
-      def map(&block)
-        to_a.map(&block)
-      end
-
       # Looks up an enum instance based on its key
       # @param key [Symbol] the key to look up
       # @return [self, nil] the corresponding enum instance, or nil

data/lib/typesafe_enum/module_info.rb

@@ -5,7 +5,7 @@ module TypesafeEnum
   NAME = 'typesafe_enum'
 
   # The version of this gem
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 
   # The copyright notice for this gem
   COPYRIGHT = 'Copyright (c) 2020 The Regents of the University of California'

data/spec/unit/typesafe_enum/base_spec.rb

@@ -32,8 +32,8 @@ end
 module TypesafeEnum
   describe Base do
 
-    describe '::new' do
-      it ' news a constant enum value' do
+    describe :new do
+      it 'news a constant enum value' do
         enum = Suit::CLUBS
         expect(enum).to be_a(Suit)
       end
@@ -113,7 +113,7 @@ module TypesafeEnum
       end
     end
 
-    describe '::to_a' do
+    describe :to_a do
       it 'returns the values as an array' do
         expect(Suit.to_a).to eq([Suit::CLUBS, Suit::DIAMONDS, Suit::HEARTS, Suit::SPADES])
       end
@@ -125,13 +125,27 @@ module TypesafeEnum
       end
     end
 
-    describe '::size' do
+    describe :size do
       it 'returns the number of enum instnaces' do
         expect(Suit.size).to eq(4)
       end
     end
 
-    describe '::each' do
+    describe :count do
+      it 'returns the number of enum instnaces' do
+        expect(Suit.count).to eq(4)
+      end
+
+      it 'counts items' do
+        expect(Suit.count(Suit::SPADES)).to eq(1)
+      end
+
+      it 'counts items that match a predicate' do
+        expect(Suit.count { |s| s.value.length == 6 }).to eq(2)
+      end
+    end
+
+    describe :each do
       it 'iterates the enum values' do
         expected = [Suit::CLUBS, Suit::DIAMONDS, Suit::HEARTS, Suit::SPADES]
         index = 0
@@ -142,7 +156,7 @@ module TypesafeEnum
       end
     end
 
-    describe '::each_with_index' do
+    describe :each_with_index do
       it 'iterates the enum values with indices' do
         expected = [Suit::CLUBS, Suit::DIAMONDS, Suit::HEARTS, Suit::SPADES]
         Suit.each_with_index do |s, index|
@@ -151,14 +165,21 @@ module TypesafeEnum
       end
     end
 
-    describe '::map' do
+    describe :map do
       it 'maps enum values' do
         all_keys = Suit.map(&:key)
         expect(all_keys).to eq(%i[CLUBS DIAMONDS HEARTS SPADES])
       end
     end
 
-    describe '#<=>' do
+    describe :flat_map do
+      it 'flatmaps enum values' do
+        result = Tarot.flat_map { |t| [t.key, t.value] }
+        expect(result).to eq([:CUPS, 'Cups', :COINS, 'Coins', :WANDS, 'Wands', :SWORDS, 'Swords'])
+      end
+    end
+
+    describe :<=> do
       it 'orders enum instances' do
         Suit.each_with_index do |s1, i1|
           Suit.each_with_index do |s2, i2|
@@ -168,7 +189,7 @@ module TypesafeEnum
       end
     end
 
-    describe '#==' do
+    describe :== do
       it 'returns true for identical instances, false otherwise' do
         Suit.each do |s1|
           Suit.each do |s2|
@@ -202,7 +223,7 @@ module TypesafeEnum
       # rubocop:enable Security/MarshalLoad
     end
 
-    describe '#!=' do
+    describe :!= do
       it 'returns false for identical instances, true otherwise' do
         Suit.each do |s1|
           Suit.each do |s2|
@@ -224,7 +245,7 @@ module TypesafeEnum
       end
     end
 
-    describe '#hash' do
+    describe :hash do
       it 'gives consistent values' do
         Suit.each do |s1|
           Suit.each do |s2|
@@ -264,7 +285,7 @@ module TypesafeEnum
       end
     end
 
-    describe '#eql?' do
+    describe :eql? do
       it 'is consistent with #hash' do
         Suit.each do |s1|
           Suit.each do |s2|
@@ -274,7 +295,7 @@ module TypesafeEnum
       end
     end
 
-    describe '#value' do
+    describe :value do
       it 'returns the string value of the enum instance' do
         expected = %w[clubs diamonds hearts spades]
         Suit.each_with_index do |s, index|
@@ -283,7 +304,7 @@ module TypesafeEnum
       end
     end
 
-    describe '#key' do
+    describe :key do
       it 'returns the symbol key of the enum instance' do
         expected = %i[CLUBS DIAMONDS HEARTS SPADES]
         Suit.each_with_index do |s, index|
@@ -292,7 +313,7 @@ module TypesafeEnum
       end
     end
 
-    describe '#ord' do
+    describe :ord do
       it 'returns the ord value of the enum instance' do
         Suit.each_with_index do |s, index|
           expect(s.ord).to eq(index)
@@ -300,7 +321,7 @@ module TypesafeEnum
       end
     end
 
-    describe '#to_s' do
+    describe :to_s do
       it 'provides an informative string' do
         aggregate_failures 'informative string' do
           [Suit, Tarot, RGBColor, Scale].each do |ec|
@@ -315,7 +336,7 @@ module TypesafeEnum
       end
     end
 
-    describe '::find_by_key' do
+    describe :find_by_key do
       it 'maps symbol keys to enum instances' do
         keys = %i[CLUBS DIAMONDS HEARTS SPADES]
         expected = Suit.to_a
@@ -329,7 +350,7 @@ module TypesafeEnum
       end
     end
 
-    describe '::find_by_value' do
+    describe :find_by_value do
       it 'maps values to enum instances' do
         values = %w[clubs diamonds hearts spades]
         expected = Suit.to_a
@@ -355,7 +376,7 @@ module TypesafeEnum
       end
     end
 
-    describe '::find_by_value_str' do
+    describe :find_by_value_str do
       it 'maps string values to enum instances' do
         values = %w[clubs diamonds hearts spades]
         expected = Suit.to_a
@@ -381,7 +402,7 @@ module TypesafeEnum
       end
     end
 
-    describe '::find_by_ord' do
+    describe :find_by_ord do
       it 'maps ordinal indices to enum instances' do
         Suit.each do |s|
           expect(Suit.find_by_ord(s.ord)).to be(s)
@@ -436,5 +457,9 @@ module TypesafeEnum
 
       expect(Operation.map { |op| op.eval(39, 23) }).to eq([39 + 23, 39 - 23])
     end
+
+    it 'is an Enumerable' do
+      expect(Suit).to be_an(Enumerable)
+    end
   end
 end

data/typesafe_enum.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rubocop', '~> 0.80'
-  spec.add_development_dependency 'simplecov', '~> 0.9.2'
-  spec.add_development_dependency 'simplecov-console', '~> 0.2.0'
+  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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesafe_enum
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -64,28 +64,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Typesafe enum pattern for Ruby