array_utility 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66035a12a194d47cd799f876ff4570ed66949a95
-  data.tar.gz: b959f21f2dfb3fafe72c06a111c78ae5029ba8c5
+  metadata.gz: d3923c019b192cd8768cc54b5ea6f88ed15e4183
+  data.tar.gz: 67ec1a1527660a1f6109429b39ee48e8989bba46
 SHA512:
-  metadata.gz: cf392b49fdfe79f83fa3797b36698ae2b22b720bd48ee860b1210254413e93c22f8954d155e2ab4591f12ae8137bd19c914aed6c40f696a4a5c54cf6df4c3bc7
-  data.tar.gz: 0e52a964c661d96ba4958dc79ffac520bbdcc8ea17ee7696be3e22f87ef5735e98aa5e064e3a941b30ad2a7762d8fb6443171d8dc8d852f903c2f8d922a31986
+  metadata.gz: e7bd835df1b692ecc4f9f17dc72794bee69d25b16a750cabc33c3b66deb96af53c821aaff832480628b9e9e8e2060cdd7f9346732b30bc22b3afb77631aed97c
+  data.tar.gz: df392144b06ea2838c2f548114c1f1fdc0c0485d14f1595826a2c13477dfda3622943b8cd7d643d3032a4028cff81ef88df32ecddf432d5a64cfbca3b80fd19a

data/examples/examples.rb

@@ -0,0 +1,24 @@
+require_relative '../lib/array_utility'
+
+using ArrayUtility
+
+[1, 2, 3].next(2)
+# => 3
+
+[1, 2, 3].next(3)
+# => nil
+
+[1, 2, 3].before(2)
+# => 1
+
+[1, 2, 3].before(1)
+# => 3
+
+[1, 2, 3].prepend_capped(4, 3)
+# => [4, 1, 2]
+
+[1, 2, 3].prepend_capped(70, 4)
+# => [70, 1, 2, 3]
+
+[1, 2, 3].prepend_capped(6, 2)
+# => [6, 1]

data/lib/array_utility.rb

@@ -15,5 +15,19 @@ module ArrayUtility
     def before(single)
       self[index(single) - 1]
     end
+
+    # Puts a value at the start of an array, and deletes all values greater than
+    #   the cap.
+    # @param value [Any] The value to prepend.
+    # @param cap [Int] The maximum number of values in the array.
+    def prepend_capped(value, cap)
+      unshift(value)
+      if size > cap
+        drop(cap).each do |val|
+          delete(val)
+        end
+      end
+      self
+    end
   end
 end

data/spec/test_prepend_capped.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+require_relative '../lib/array_utility'
+
+class TestPrependCapped < Test::Unit::TestCase
+  using ArrayUtility
+  def test_prepend_capped
+    assert_equal([4, 1, 2], [1, 2, 3].prepend_capped(4, 3))
+    assert_equal([4, 1, 2], [1, 2].prepend_capped(4, 3))
+    assert_equal([4], [1, 2].prepend_capped(4, 1))
+  end
+end

metadata

@@ -1,26 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: array_utility
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies: []
 description: Some simple but very useful utilities for Array objects. It primarily
-  focuses on using the most efficient methods to get certain values from Arrays. Eventually
-  it may have methods for manipulating Arrays.
+  focuses on using the most efficient methods to get and modify certain values from
+  Arrays.
 email: elifosterwy@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- examples/examples.rb
 - lib/array_utility.rb
 - spec/test_before.rb
 - spec/test_next.rb
+- spec/test_prepend_capped.rb
 homepage: https://github.com/elifoster/array_utility
 licenses: []
 metadata: