linked 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea4e0ba7b896f4e64d885d73066e65e4e08b49ea
-  data.tar.gz: 7913edd077d33d5a7b36982568d5b3cb46cc7c1e
+  metadata.gz: b8501da277d54cd430b7caec75a20df3670cf0a7
+  data.tar.gz: f027fcee69636bd7c3cef7a9b1d34d54d69d104e
 SHA512:
-  metadata.gz: 1467066f7e5af4ddc7eca82013d94777b956d7c93497502977fd776523e570bb7ae0d441940cb9a275f567c48750a50cff80881de98e1ca89c1592b7a5aff599
-  data.tar.gz: fac1a3393906af1c00f788fbc4e5eb30ab2b48e042190f898b43944a6ae4718baec62b9c0e0193537cc4f484f4a518f435abf0a7611bb5f28215d6aa8128b54f
+  metadata.gz: 8699f64f9331749e745ed4f793f1cc9b372459ac2c6644cc34dee7ae8baf8150682c19934a9017dc03fc3cd50da3f2806631c38301b8627340afa20a0d37fd55
+  data.tar.gz: a70747dae1d050e30229393e2df5cc8fc0075ae29fcb969233772083447e1071bcd179243ab1f5ce64bb45e77c35efe4e446cd608919407b68e465f8ce2b7bfe

data/lib/linked/item.rb

@@ -89,6 +89,16 @@ module Linked
     def last?
       @next.nil?
     end
+    
+    # Check if the item is in the given list.
+    #
+    # list - any object.
+    #
+    # Returns true if the item is part of the given list.
+
+    def in?(list)
+      @list.equal? list
+    end
 
     # Access the next item in the list. If this is the last one a StopIteration
     # will be raised, so that items may be iterated over safely in a loop.

data/lib/linked/list.rb

@@ -79,7 +79,7 @@ module Linked
     def first(n = 1)
       raise ArgumentError, 'n cannot be negative' if n < 0
 
-      return first_item_after eol, count, n unless block_given?
+      return first_item_after eol, n, count unless block_given?
 
       item = eol
       items_left = count
@@ -90,7 +90,7 @@ module Linked
         items_left -= 1
       end
 
-      first_item_after item, items_left, n
+      first_item_after item, n, items_left
     end
 
     # Access the last n item(s) in the list. The items will retain thier order.
@@ -109,7 +109,7 @@ module Linked
     def last(n = 1)
       raise ArgumentError, 'n cannot be negative' if n < 0
 
-      return last_item_before eol, count, n unless block_given?
+      return last_item_before eol, n, count unless block_given?
 
       item = eol
       items_left = count
@@ -120,7 +120,7 @@ module Linked
         items_left -= 1
       end
 
-      last_item_before item, items_left, n
+      last_item_before item, n, items_left
     end
 
     # Overrides the Enumerable#count method when given no argument to provide a
@@ -194,6 +194,18 @@ module Linked
       return nil if empty?
       first.delete
     end
+    
+    # Check if an item is in the list.
+    #
+    # item - Item, or any object that may be in the list.
+    #
+    # Returns true if the given item is in the list, otherwise false.
+    
+    def include?(item)
+      item.in? self
+    rescue NoMethodError
+      false
+    end
 
     # Iterates over each item in the list, either in normal or reverse order. If
     # a block is not given an enumerator is returned.
@@ -273,59 +285,68 @@ module Linked
       @item_count -= n
     end
 
-    # Private helper method that returns the first n items, starting just after
-    # item,  given that there are items_left items left. The following must hold
-    # for the output to be valid:
+    # Protected helper method that returns the first n items, starting just
+    # after item, given that there are items_left items left. Knowing the exact
+    # number of items left is not cruicial but does impact speed. The number
+    # should not be lower than the actual ammount. The following must
+    # hold for the output to be valid:
     # a) n > 0
     # b) there are at least items_left items left
     #
-    # item - the Item just before the item to start from
-    # items_left - the number of items left.
+    # item - the Item just before the item to start from.
     # n - the number of items to return.
+    # items_left - the number of items left.
     #
     # Returns, for different values of n:
     # n == 0) nil
     # n == 1) an item if items_left > 0 or nil
     #  n > 1) an array of items if items_left > 0 or an empty array
 
-    private def first_item_after(item, items_left, n)
+    protected def first_item_after(item, n, items_left = @item_count)
       # Optimize for these cases
       return nil if n == 0
+      return n > 1 ? [] : nil if item.next!.nil?
       return item.next if n == 1
+      
+      n = items_left if n > items_left
 
-      (n > items_left ? items_left : n).times.map { item = item.next }
+      arr = Array.new n
+      n.times { |i| arr[i] = item = item.next }
+      arr
     rescue StopIteration
-      n > 1 ? [] : nil
+      arr.compact! || arr
     end
 
-    # Private helper method that returns the last n items, ending just before
-    # item,  given that there are items_left items left. The following must hold
-    # for the output to be valid:
+    # Protected helper method that returns the last n items, ending just before
+    # item,  given that there are items_left items left. Knowing the exact
+    # number of items left is not cruicial but does impact speed. The number
+    # should not be lower than the actual ammount. The following must hold for
+    # the output to be valid:
     # a) n > 0
     # b) there are at least items_left items left
     #
     # item - the Item just after the item to start from.
-    # items_left - the number of items left.
     # n - the number of items to return.
+    # items_left - the number of items left.
     #
     # Returns, for different values of n:
     # n == 0) nil
     # n == 1) an item if items_left > 0 or nil
     #  n > 1) an array of items if items_left > 0 or an empty array
 
-    private def last_item_before(item, items_left, n)
+    protected def last_item_before(item, n, items_left = @item_count)
       # Optimize for these cases
       return nil if n == 0
+      return n > 1 ? [] : nil if item.prev!.nil?
       return item.prev if n == 1
 
-      # Truncate n if it is larger than the number of items
-      # left
-      n = (n > items_left ? items_left : n)
-      (n - 1).downto(0).with_object(Array.new n) do |i, arr|
-        arr[i] = item = item.prev
-      end
+      n = items_left if n > items_left
+      
+      arr = Array.new n
+      (n - 1).downto(0) { |i| arr[i] = item = item.prev }
+      arr
     rescue StopIteration
-      n > 1 ? [] : nil
+      arr.compact! || arr
     end
   end
 end

data/lib/linked/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Linked
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: linked
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Sebastian Lindberg