non_empty_array 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c54d118eef824c4fffa241971f7c95b927f24597eab6eddc019a434be045160b
-  data.tar.gz: '053186e3e45956d92ee38c4a218228daa881c89c73de2e6b2172762b05283a8c'
+  metadata.gz: ac28ce826c76708775a75a8d582ecb0d9fb704a021f7a7de1e3723144e1203f0
+  data.tar.gz: fd08cdeaf999b788888c79486bd98d95c2b674fb5d3ea406d3d284cea6c06578
 SHA512:
-  metadata.gz: b8ebda3c33e1bf55e37f2b62bf62a08b1dd7d542fd7017244085084b5c2dc70df2a6cbb79af5f4885ab7a09bdb21637cce6f42e8ee1702be3df07356337e7fef
-  data.tar.gz: 6331e7a5f3e9d9bd9c1210c38e538e457ecd7a228dc2676fd53dff4ab2290425ea9eec7e0723721f77838b9cd8ddacd47170a77b1234b3f7c5820471d7c922be
+  metadata.gz: b9d39b0aa03cb003f34e108fe6bf0ef2dbd65a1bba04880e78482959b15f8e24807184b961ee171c5e57bcc461b2937cc97fb8e4dd02e681213bc2f8f6901532
+  data.tar.gz: 3c944d6220ee3bb008b25ce66a0c8cd407a4fecbe54e4c1df98abbc5351bbb989349839a917c03d6c4b9e85ccbef68c07818b5a2f9e0adc041e156fe5c6a6090

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    non_empty_array (1.1.0)
+    non_empty_array (1.1.1)
       sorbet-runtime (>= 0.5.5890)
 
 GEM

data/README.md

@@ -2,13 +2,19 @@
 
 # NonEmptyArray
 
-An [enumerable](https://ruby-doc.org/core-2.7.1/Enumerable.html) which is guaranteed to not be empty. E.g., `#first`
+An [enumerable](https://ruby-doc.org/core-2.7.1/Enumerable.html) which is guaranteed to have at least one element. E.g., `#first`
 will never fail.
 
-Additionally, three methods which give access:
+These four methods give non-empty-aware access:
 
-* `#tail`
+### Always succeed
+
+* `#first`
 * `#last`
+
+### May return an empty Array
+
+* `#tail`
 * `#all_but_last`
 
 And one method for mutating the list:
@@ -36,7 +42,16 @@ a = NonEmptyArray.new()  # => Ruby error - missing parameter
 ```ruby
 require 'non_empty_array'
 
-a = NonEmptyArray.new(100, [200, 300])
+a = NonEmptyArray.new('1000')  # Simplest way to create one
+a.count()       # => 1
+a.push('2000')
+a.count()       # => 2
+```
+
+```ruby
+require 'non_empty_array'
+
+a = NonEmptyArray.new(100, [200, 300]).  # Creating from both the head and tail
 
 # Methods from Enumerable
 a.count()         # => 3
@@ -44,11 +59,12 @@ a.max()           # => 300
 a.to_a()          # => [100, 200, 300]
 
 # Methods specific to NonEmptyArray
-a.last()          # => 300          Always succeeds - never returns a "no element" error.
+a.first()         # => 100          Always succeeds - never returns a "no element" error.
+a.last()          # => 300          Always succeeds
 a.all_but_last()  # => [100, 200]   A normal array, which may indeed be empty.
 a.push('400')
 a.all_but_last()  # => [100, 200, 300]
 a.tail()          # => [200, 300, 400]
 ```
 
-Influenced by [Haskell's NonEmpty List](https://hackage.haskell.org/package/base-4.14.0.0/docs/Data-List-NonEmpty.html).
+Influenced by [Haskell's NonEmpty List](https://hackage.haskell.org/package/base-4.14.0.0/docs/Data-List-NonEmpty.html).

data/lib/non_empty_array.rb

@@ -23,7 +23,9 @@ class NonEmptyArray
 
   sig { returns(T.untyped) }
   def last
-    @tail[-1] || @head
+    return @head if @tail.empty?
+
+    @tail[-1]
   end
 
   sig { returns(T::Array[T.untyped]) }

data/non_empty_array.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'non_empty_array'
-  spec.version       = '1.1.0'
+  spec.version       = '1.1.1'
   spec.authors       = ['Robb Shecter']
   spec.email         = ['robb@public.law']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: non_empty_array
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Robb Shecter