linked 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 44eaaab09ac6111dd607d3cd52e35d2d072315bbc4614b7805254c8a7bab311a
-  data.tar.gz: 4672f6d56f0dde64a6fe12ecaefdf82d39795a957d97ccb55eb0558ffe23285d
+SHA1:
+  metadata.gz: d990f5f26ec08e5038257496d465b4435ad8a113
+  data.tar.gz: 7cb0f4acb27d81e950d99ef5dd9494f015d471c4
 SHA512:
-  metadata.gz: c94e42bee0a6717053ff3c33de9f36c03ab4ba24d35ddb3b387ed78a3e4a54898269eb62237117a05db4cf4c96b5555c376cc507cb2d8cc02aed1a80059f69a3
-  data.tar.gz: 479b9a24c6dc2a785993072e620695bebe35e9599cfb9f8842fd1a767d6783c5b0838f6ccd0abce247a155e416930fa76cc6c164cb6ae85e2e9aac23c7948c9f
+  metadata.gz: ef56ee302097e4b1a6240d38026cfbbd3d1a179777e7b5dbea23d490d10ed423c4fa3a19fbd159d5a43f2df63d732855283b7bfb7fb55ace4fb6fa5a6abe7244
+  data.tar.gz: 3c7236c0a480a14fa94ba4156c3606f4defdb400b4340ed173a3254a75dadba034f78d6cc0cc4ecf5cad7e5847f239318cd43a9b016330aff2a914023d0dd121

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -43,6 +43,7 @@ Metrics/BlockLength:
 Metrics/ModuleLength:
   Exclude:
     - 'test/**/*.rb'
+  Max: 120
 
 Metrics/ParameterLists:
   CountKeywordArgs: false

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    linked (0.5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    docile (1.3.1)
+    json (2.1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redcarpet (3.4.0)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.3.2)
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  linked!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  redcarpet (~> 3.4)
+  rubocop (~> 0.52)
+  simplecov (~> 0.16)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.16.3

data/README.md

@@ -1,17 +1,11 @@
-# Linked
+# 🔗 Linked
 
 [![Gem Version](https://badge.fury.io/rb/linked.svg)](https://badge.fury.io/rb/linked)
 [![Build Status](https://travis-ci.org/seblindberg/ruby-linked.svg?branch=master)](https://travis-ci.org/seblindberg/ruby-linked)
 [![Coverage Status](https://coveralls.io/repos/github/seblindberg/ruby-linked/badge.svg?branch=master)](https://coveralls.io/github/seblindberg/ruby-linked?branch=master)
 [![Inline docs](http://inch-ci.org/github/seblindberg/ruby-linked.svg?branch=master)](http://inch-ci.org/github/seblindberg/ruby-linked)
 
-Yet another Linked List implementation for Ruby (hence the somewhat awkward name). The library is still under development. The intention is to
-
-1. nail down the functionality,
-2. start porting the methods over to c and finally
-3. try to optimize for speed, as much as possible.
-
-The project is still in phase 1.
+Yet another Linked List implementation for Ruby (hence the somewhat awkward name).
 
 ## Installation
 
@@ -63,7 +57,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/linked.
+Bug reports and pull requests are welcome on GitHub at https://github.com/seblindberg/ruby-linked.
 
 
 ## License

data/lib/linked.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+
 require 'linked/version'
 require 'linked/util'
+require 'linked/mutable'
 require 'linked/listable'
 require 'linked/item'
 require 'linked/list_enumerable'
@@ -9,5 +12,5 @@ require 'linked/list'
 
 # Linked List implementation.
 module Linked
-  private_constant :Util, :ListEnumerable
+  private_constant :Util
 end

data/lib/linked/item.rb

@@ -10,6 +10,7 @@ module Linked
 
     # The Item can hold an arbitrary object as its value and it will stay with
     # the item.
+    #
     # @return [Object] any object that is stored in the item.
     attr_accessor :value
 

data/lib/linked/list.rb

@@ -89,13 +89,7 @@ module Linked
     def pop
       return nil if empty?
 
-      if list_tail.first?
-        item = last
-        @_chain = nil
-        item
-      else
-        list_tail.delete
-      end
+      list_tail.first? ? last.tap { @_chain = nil } : list_tail.delete
     end
 
     # Insert an item at the beginning of the list. If the given object is not an
@@ -121,9 +115,7 @@ module Linked
       return nil if empty?
 
       if list_head.last?
-        item = @_chain
-        @_chain = nil
-        item
+        @_chain.tap { @_chain = nil }
       else
         old_head = list_head
         @_chain = list_head.next
@@ -173,6 +165,8 @@ module Linked
 
     alias inspect inspect_list
 
+    protected
+
     # Protected factory method for creating items compatible with the list. This
     # method is called whenever an arbitrary object is pushed or unshifted onto
     # the list and need to be wraped inside an Item.
@@ -182,37 +176,35 @@ module Linked
     # @param  args [Array<Object>] the arguments that are to be passed on to
     #   `Item.new`.
     # @return [Item] a new `Listable` item.
-    protected def create_item(*args)
+    def create_item(*args)
       Item.new(*args)
     end
 
+    private
+
     # Takes an arbitrary object and coerces it into an item compliant with the
     # list. If the object is already an item it will be used as is. Otherwise
     # #create_item will be called with the object as an argument.
     #
-    # @param  [#item, Object] the object to coerce.
+    # @param  object [#item, Object] the object to coerce.
     # @return [Listable] see `#create_item`.
-    private def coerce_item(object)
-      if object.respond_to? :item
-        object.item
-      else
-        create_item object
-      end
+    def coerce_item(object)
+      object.respond_to?(:item) ? object.item : create_item(object)
     end
 
     # Private method for clearing the list and bringing it to a pristine
     # state.
-    private def reset_list
+    def reset_list
       @_chain = nil
     end
 
     # Returns the first item item in the list, or nil if empty.
-    private def list_head
+    def list_head
       @_chain
     end
 
     # Returns an the last item in the list, or nil if empty.
-    private def list_tail
+    def list_tail
       @_chain.last_in_chain
     end
   end

data/lib/linked/list_enumerable.rb

@@ -22,6 +22,9 @@ module Linked
 
     # Iterates over each item in the list in reverse order. If a block is not
     # given an enumerator is returned.
+    #
+    # @yield  [Listable] each item in the list.
+    # @return [Enumerable] if no block is given.
     def reverse_each_item
       return to_enum(__method__) { count } unless block_given?
       return if empty?
@@ -37,12 +40,9 @@ module Linked
 
     # Access the first n item(s) in the list.
     #
-    # n - the number of items to return.
-    #
-    # Returns, for different values of n:
-    # n = nil) an item if the list contains one, or nil.
-    #  n >= 0) an array of between 0 and n items, depending on how many are in.
-    #          the list.
+    # @param  n [Integer] the number of items to return.
+    # @return [Listable] if n = nil.
+    # @return [Array<Listable>] if n >= 0.
     def first(n = nil)
       return list_head unless n
       raise ArgumentError, 'n cannot be negative' if n.negative?
@@ -54,12 +54,9 @@ module Linked
 
     # Access the first n item(s) in the list.
     #
-    # n - the number of items to return.
-    #
-    # Returns, for different values of n:
-    # n = nil) an item if the list contains one, or nil.
-    #  n >= 0) an array of between 0 and n items, depending on how many are in.
-    #          the list. The order is preserved.
+    # @param  n [Integer] the number of items to return.
+    # @return [Listable] if n = nil.
+    # @return [Array<Listable>] if n >= 0. The order is preserved.
     def last(n = nil)
       return empty? ? nil : list_tail unless n
       raise ArgumentError, 'n cannot be negative' if n.negative?

data/lib/linked/listable.rb

@@ -37,7 +37,9 @@ module Linked
   # Single items are denoted with capital letters (i), while chains are written
   # as multiple connected items (ii).
   module Listable
+    extend  Forwardable
     include Util
+    include Mutable
 
     # Creates a new item. Always make a call to super whenever overriding this
     # method in an including class.
@@ -64,33 +66,29 @@ module Linked
       self
     end
 
+    # @!method chain_head?
+    #
     # Returns true if no item come before this one. Note that the implementation
     # of this method is protected and publicly accessible through its alias
     # #first?.
     #
     # @return [true] if the item is the head of the chain.
     # @return [false] otherwise.
-    def chain_head?
-      # p @_chain_head.is_a? Numeric
-      # @_chain_head.is_a? Numeric
-      @_prev.chain_tail?
-    end
+    def_delegator :@_prev, :chain_tail?, :chain_head?
 
     alias first? chain_head?
-    protected :chain_head?
 
+    # @!method chain_tail?
+    #
     # Returns true if no item come after this one. Note that the implementation
     # of this method is protected and publicly accessible through its alias
     # #last?.
     #
     # @return [true] if the item is the tail of the chain.
     # @return [false] otherwise.
-    def chain_tail?
-      @_next.nil?
-    end
+    def_delegator :@_next, :nil?, :chain_tail?
 
     alias last? chain_tail?
-    protected :chain_tail?
 
     # Returns the first item in the chain. Note that the implementation of this
     # method is protected and publicly accessible through its aliases
@@ -103,7 +101,6 @@ module Linked
 
     alias first_in_chain chain_head
     alias chain chain_head
-    protected :chain_head
 
     # Returns the last item in the chain. Note that the implementation of this
     # method is protected and publicly accessible through its aliases
@@ -115,14 +112,11 @@ module Linked
     end
 
     alias last_in_chain chain_tail
-    protected :chain_tail
 
     # Returns the number of items in the current chain.
     #
     # @return [Integer] the number of items in the chain.
-    def chain_length
-      chain_head.chain_head!
-    end
+    def_delegator :chain_head, :chain_head!, :chain_length
 
     # Check if this object is in a chain.
     #
@@ -171,123 +165,6 @@ module Linked
 
     alias previous prev
 
-    # rubocop:disable Metrics/MethodLength
-
-    def append(object)
-      # Assume the given object to be the head of its chain
-      # B. If it is not, chain B will be split before the
-      # object, and the sub chain in which the object now is
-      # the head will be appended.
-      sub_chain_b_head = coerce object
-
-      # Grab the first item in this chain. We will need it
-      # later.
-      target_chain = chain_head
-
-      # Split chain B before the given object and grab the
-      # tail of that new sub chain.
-      sub_chain_b_tail = sub_chain_b_head.split_before_and_insert target_chain
-
-      # If we are the last item in our chain we need to
-      # notify the head that there is a new tail.
-      # Otherwise the next item in the list need to be
-      # linked up correctly.
-      if chain_tail?
-        target_chain.prev = sub_chain_b_tail
-      else
-        sub_chain_b_tail.next = next!
-        next!.prev = sub_chain_b_tail
-      end
-
-      # Connect sub chain B to this item
-      sub_chain_b_head.prev = self
-      self.next = sub_chain_b_head
-
-      sub_chain_b_tail
-    end
-
-    # rubocop:enable Metrics/MethodLength
-
-    # rubocop:disable Metrics/MethodLength
-
-    def prepend(object)
-      sub_chain_a_tail = coerce object
-
-      if chain_head?
-        sub_chain_a_tail.split_after_and_insert
-        sub_chain_a_tail.append self
-
-        return chain_head
-      end
-
-      target_chain = chain_head
-
-      sub_chain_a_head = sub_chain_a_tail.split_after_and_insert target_chain
-
-      prev!.next = sub_chain_a_head
-      sub_chain_a_head.prev = prev!
-
-      sub_chain_a_tail.next = self
-      self.prev = sub_chain_a_tail
-
-      sub_chain_a_head
-    end
-
-    # rubocop:enable Metrics/MethodLength
-
-    # rubocop:disable Metrics/MethodLength
-
-    # Remove an item from the chain. Note that calling #delete on the first item
-    # in a chain causes all subsequent items to be moved to a new chain.
-    #
-    # === Usage
-    # Example using the chain A <> B <> C
-    #
-    #   A.delete # => A | B <> C
-    #   B.delete # => B | A <> C
-    #   C.delete # => C | A <> B
-    #
-    # @return [self]
-    def delete
-      if chain_head?
-        split_after_and_insert
-      else
-        shrink
-
-        if chain_tail?
-          chain_head.prev = @_prev
-        else
-          @_next.prev = @_prev
-        end
-
-        @_prev.next = @_next
-      end
-
-      reset_item
-    end
-
-    # rubocop:enable Metrics/MethodLength
-
-    # Remove all items before this one in the chain.
-    #
-    # @return [nil] if this is the first item.
-    # @return [Listable] the first item in the chain that was just deleted.
-    def delete_before
-      prev!.split_after_and_insert unless chain_head?
-    end
-
-    # Remove all items after this one in the chain.
-    #
-    # @return [nil] if this is the lst item.
-    # @return [Listable] the first item in the chain that was just deleted.
-    def delete_after
-      return nil if chain_tail?
-
-      item = next!
-      item.split_before_and_insert
-      item
-    end
-
     # Iterates over each item before this, in reverse order. If a block is not
     # given an enumerator is returned.
     #
@@ -322,7 +199,10 @@ module Linked
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/PerceivedComplexity
 
     # Take n items and put them into a sorted array. If n is positive the array
     # will include this item, as well the n - 1 items following it in the chain.
@@ -363,7 +243,10 @@ module Linked
       res
     end
 
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/PerceivedComplexity
 
     # Due to the nature of listable objects the default #inspect method is
     # problematic. This basic replacement includes only the class name and the
@@ -397,13 +280,6 @@ module Linked
       @_next
     end
 
-    # Never call this method directly since it may corrupt the chain.
-    #
-    # Sets the value of the `next` field.
-    def next=(other)
-      @_next = other
-    end
-
     # Protected, unsafe accessor of the previous item in the chain. It is
     # preferable to use #prev, possibly in conjunction with #first?.
     #
@@ -413,13 +289,6 @@ module Linked
       @_prev
     end
 
-    # Never call this method directly since it may corrupt the chain.
-    #
-    # Sets the value of the `prev` field.
-    def prev=(other)
-      @_prev = other
-    end
-
     # Protected, unsafe accessor of the first item in the chain. It is
     # preferable to use #first.
     #
@@ -429,148 +298,6 @@ module Linked
       @_chain_head
     end
 
-    # Never call this method directly since it may corrupt the chain.
-    #
-    # Sets the value of the `first` field.
-
-    def chain_head=(other)
-      @_chain_head = other
-    end
-
-    # Never call this method directly since it may corrupt the chain. Grow the
-    # chain with n items.
-    #
-    # n - the number of items to increase the chain count with.
-    #
-    # Returns the updated chain count.
-
-    def grow(n = 1)
-      head = chain_head
-      head.chain_head = head.chain_head! + n
-    end
-
-    # Never call this method directly since it may corrupt the chain. Shrink the
-    # chain with n items.
-    #
-    # n - the number of items to decrease the chain count with.
-    #
-    # Returns the updated chain count.
-
-    def shrink(n = 1)
-      head = chain_head
-      head.chain_head = head.chain_head! - n
-    end
-
-    # Split the chain on this item and insert the latter part into the chain
-    # with head as its first item.
-    #
-    # Calling C.split_before_and_insert(.) yields the two chains (ii) and (iii)
-    #
-    #   A <> B <> C <> D    A <> B    C <> D
-    #         (i)            (ii)     (iii)
-    #
-    # Chain (ii) is guaranteed to be complete. Chain (iii) will however be left
-    # in an inclomplete state unless head_b == self (default). The first item in
-    # (iii) must then be connected to the one preceeding it.
-    #
-    # head_b - the head of a new chain that (iii) will be added to.
-    #
-    # Returns the last element of (iii).
-
-    def split_before_and_insert(head_b = self)
-      # Get the current chain head. It will remain the head
-      # of sub chain a (ii). If this item is the first then
-      # chain a will be empty.
-      chain_a_head = chain_head? ? nil : chain_head
-
-      # The head of sub chain b (iii) is self.
-      chain_b_head = self
-
-      # Find the tail of sub chain b by iterating over each
-      # item, starting with this one. Set the the new head
-      # of these while counting them.
-      chain_b_tail = self
-      chain_b_length = 1
-
-      loop do
-        chain_b_tail.chain_head = head_b
-        chain_b_tail = chain_b_tail.next
-        chain_b_length += 1
-      end
-
-      # If sub chain a is not empty it needs to be updated.
-      # Shrink its count by the number of items in sub
-      # chain b and complete it by connecting the head to
-      # the tail.
-      if chain_a_head
-        chain_a_head.shrink chain_b_length
-
-        chain_a_tail = chain_b_head.prev
-        chain_a_head.prev = chain_a_tail
-        chain_a_tail.next = nil
-      end
-
-      # Tell the new chain to grow. If sub chain b is to be
-      # the new head we can insert the count directly. We
-      # also complete the chain by connecting the head to
-      # the tail. The next field of the tail should already
-      # be nil.
-      if chain_b_head.equal? head_b
-        chain_b_head.chain_head = chain_b_length
-        chain_b_head.prev = chain_b_tail
-      else
-        head_b.grow chain_b_length
-      end
-
-      # Chain a is now either empty (nil) or completed.
-      # Chain b however is only complete if the given head
-      # is equal to self (default). If it is not chain b
-      # will need a) the next field of the tail set to the
-      # item after, unless nil, and b) the prev field of
-      # head set to the item before.
-
-      chain_b_tail
-    end
-
-    # TODO
-
-    def split_after_and_insert(head_a = chain_head)
-      # If this is not the last item in the chain, sub chain
-      # b will contain items. Use #split_before_and_insert
-      # to cut the chain after this one. This will complete
-      # chain b and update the item count of chain a.
-      next!.split_before_and_insert unless chain_tail?
-
-      chain_a_head = chain_head
-
-      # If the head of sub chain a is same as the target
-      # chain head
-      return chain_a_head if chain_a_head.equal? head_a
-
-      chain_a_length = chain_length
-
-      # Set the head field of all items, starting with the
-      # tail (self), moving backwards.
-      item = self
-
-      # Loop until we hit the first item.
-      loop do
-        item.chain_head = head_a
-        item = item.prev
-      end
-
-      # Tell the target chain to grow with the number of
-      # items in sub chain a.
-      head_a.grow chain_a_length
-
-      # Sub chain b is now either empty or complete. Sub
-      # chain a however is only complete if the target
-      # head is the same as the head of chain a. Otherwise
-      # the prev field of head and the next field of tail
-      # both need to be set correctly.
-      chain_a_head
-    end
-
     private
 
     # Convert the given object to a listable item. If the object responds to
@@ -600,5 +327,7 @@ module Linked
       @_next = nil
       @_prev = self
     end
+
+    protected :chain_head?, :chain_tail?, :chain_head, :chain_tail
   end
 end

data/lib/linked/mutable.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+
+module Linked
+  # This module collects all the methods that mutate a listable item.
+  module Mutable
+    # rubocop:disable Metrics/MethodLength
+
+    def append(object)
+      # Assume the given object to be the head of its chain
+      # B. If it is not, chain B will be split before the
+      # object, and the sub chain in which the object now is
+      # the head will be appended.
+      sub_chain_b_head = coerce object
+
+      # Grab the first item in this chain. We will need it
+      # later.
+      target_chain = chain_head
+
+      # Split chain B before the given object and grab the
+      # tail of that new sub chain.
+      sub_chain_b_tail = sub_chain_b_head.split_before_and_insert target_chain
+
+      # If we are the last item in our chain we need to
+      # notify the head that there is a new tail.
+      # Otherwise the next item in the list need to be
+      # linked up correctly.
+      if chain_tail?
+        target_chain.prev = sub_chain_b_tail
+      else
+        sub_chain_b_tail.next = next!
+        next!.prev = sub_chain_b_tail
+      end
+
+      # Connect sub chain B to this item
+      sub_chain_b_head.prev = self
+      self.next = sub_chain_b_head
+
+      sub_chain_b_tail
+    end
+
+    # rubocop:enable Metrics/MethodLength
+
+    # rubocop:disable Metrics/MethodLength
+
+    def prepend(object)
+      sub_chain_a_tail = coerce object
+
+      if chain_head?
+        sub_chain_a_tail.split_after_and_insert
+        sub_chain_a_tail.append self
+
+        return chain_head
+      end
+
+      target_chain = chain_head
+
+      sub_chain_a_head = sub_chain_a_tail.split_after_and_insert target_chain
+
+      prev!.next = sub_chain_a_head
+      sub_chain_a_head.prev = prev!
+
+      sub_chain_a_tail.next = self
+      self.prev = sub_chain_a_tail
+
+      sub_chain_a_head
+    end
+
+    # rubocop:enable Metrics/MethodLength
+
+    # rubocop:disable Metrics/MethodLength
+
+    # Remove an item from the chain. Note that calling #delete on the first item
+    # in a chain causes all subsequent items to be moved to a new chain.
+    #
+    # === Usage
+    # Example using the chain A <> B <> C
+    #
+    #   A.delete # => A | B <> C
+    #   B.delete # => B | A <> C
+    #   C.delete # => C | A <> B
+    #
+    # @return [self]
+    def delete
+      if chain_head?
+        split_after_and_insert
+      else
+        shrink
+
+        if chain_tail?
+          chain_head.prev = @_prev
+        else
+          @_next.prev = @_prev
+        end
+
+        @_prev.next = @_next
+      end
+
+      reset_item
+    end
+
+    # rubocop:enable Metrics/MethodLength
+
+    # Remove all items before this one in the chain.
+    #
+    # @return [nil] if this is the first item.
+    # @return [Listable] the first item in the chain that was just deleted.
+    def delete_before
+      prev!.split_after_and_insert unless chain_head?
+    end
+
+    # Remove all items after this one in the chain.
+    #
+    # @return [nil] if this is the lst item.
+    # @return [Listable] the first item in the chain that was just deleted.
+    def delete_after
+      return nil if chain_tail?
+
+      item = next!
+      item.split_before_and_insert
+      item
+    end
+
+    protected
+
+    # Never call this method directly since it may corrupt the chain.
+    #
+    # Sets the value of the `next` field.
+    def next=(other)
+      @_next = other
+    end
+
+    # Never call this method directly since it may corrupt the chain.
+    #
+    # Sets the value of the `prev` field.
+    def prev=(other)
+      @_prev = other
+    end
+
+    # Never call this method directly since it may corrupt the chain.
+    #
+    # Sets the value of the `first` field.
+    def chain_head=(other)
+      @_chain_head = other
+    end
+
+    # Never call this method directly since it may corrupt the chain. Grow the
+    # chain with n items.
+    #
+    # n - the number of items to increase the chain count with.
+    #
+    # Returns the updated chain count.
+    def grow(n = 1)
+      head = chain_head
+      head.chain_head = head.chain_head! + n
+    end
+
+    # Never call this method directly since it may corrupt the chain. Shrink the
+    # chain with n items.
+    #
+    # n - the number of items to decrease the chain count with.
+    #
+    # Returns the updated chain count.
+    def shrink(n = 1)
+      head = chain_head
+      head.chain_head = head.chain_head! - n
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+
+    # Split the chain on this item and insert the latter part into the chain
+    # with head as its first item.
+    #
+    # Calling C.split_before_and_insert(.) yields the two chains (ii) and (iii)
+    #
+    #   A <> B <> C <> D    A <> B    C <> D
+    #         (i)            (ii)     (iii)
+    #
+    # Chain (ii) is guaranteed to be complete. Chain (iii) will however be left
+    # in an inclomplete state unless head_b == self (default). The first item in
+    # (iii) must then be connected to the one preceeding it.
+    #
+    # head_b - the head of a new chain that (iii) will be added to.
+    #
+    # Returns the last element of (iii).
+    def split_before_and_insert(head_b = self)
+      # Get the current chain head. It will remain the head
+      # of sub chain a (ii). If this item is the first then
+      # chain a will be empty.
+      chain_a_head = chain_head? ? nil : chain_head
+
+      # The head of sub chain b (iii) is self.
+      chain_b_head = self
+
+      # Find the tail of sub chain b by iterating over each
+      # item, starting with this one. Set the the new head
+      # of these while counting them.
+      chain_b_tail = self
+      chain_b_length = 1
+
+      loop do
+        chain_b_tail.chain_head = head_b
+        chain_b_tail = chain_b_tail.next
+        chain_b_length += 1
+      end
+
+      # If sub chain a is not empty it needs to be updated.
+      # Shrink its count by the number of items in sub
+      # chain b and complete it by connecting the head to
+      # the tail.
+      if chain_a_head
+        chain_a_head.shrink chain_b_length
+
+        chain_a_tail = chain_b_head.prev
+        chain_a_head.prev = chain_a_tail
+        chain_a_tail.next = nil
+      end
+
+      # Tell the new chain to grow. If sub chain b is to be
+      # the new head we can insert the count directly. We
+      # also complete the chain by connecting the head to
+      # the tail. The next field of the tail should already
+      # be nil.
+      if chain_b_head.equal? head_b
+        chain_b_head.chain_head = chain_b_length
+        chain_b_head.prev = chain_b_tail
+      else
+        head_b.grow chain_b_length
+      end
+
+      # Chain a is now either empty (nil) or completed.
+      # Chain b however is only complete if the given head
+      # is equal to self (default). If it is not chain b
+      # will need a) the next field of the tail set to the
+      # item after, unless nil, and b) the prev field of
+      # head set to the item before.
+
+      chain_b_tail
+    end
+
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+    # rubocop:disable Metrics/MethodLength
+
+    # TODO
+
+    def split_after_and_insert(head_a = chain_head)
+      # If this is not the last item in the chain, sub chain
+      # b will contain items. Use #split_before_and_insert
+      # to cut the chain after this one. This will complete
+      # chain b and update the item count of chain a.
+      next!.split_before_and_insert unless chain_tail?
+
+      chain_a_head = chain_head
+
+      # If the head of sub chain a is same as the target
+      # chain head
+      return chain_a_head if chain_a_head.equal? head_a
+
+      chain_a_length = chain_length
+
+      # Set the head field of all items, starting with the
+      # tail (self), moving backwards.
+      item = self
+
+      # Loop until we hit the first item.
+      loop do
+        item.chain_head = head_a
+        item = item.prev
+      end
+
+      # Tell the target chain to grow with the number of
+      # items in sub chain a.
+      head_a.grow chain_a_length
+
+      # Sub chain b is now either empty or complete. Sub
+      # chain a however is only complete if the target
+      # head is the same as the head of chain a. Otherwise
+      # the prev field of head and the next field of tail
+      # both need to be set correctly.
+      chain_a_head
+    end
+
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/linked/util.rb

@@ -3,7 +3,9 @@
 module Linked
   # Collection of common utility methods.
   module Util
-    protected def object_identifier
+    protected
+
+    def object_identifier
       format '%s:0x%0x', self.class.name, object_id
     end
   end

data/lib/linked/version.rb

@@ -2,5 +2,5 @@
 
 module Linked
   # The current version number of the Linked library.
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

data/linked.gemspec

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)
@@ -25,14 +24,14 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  
+
   spec.metadata['yard.run'] = 'yri'
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
   spec.add_development_dependency 'rubocop', '~> 0.52'
-  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linked
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Sebastian Lindberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +121,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -131,6 +132,7 @@ files:
 - lib/linked/list.rb
 - lib/linked/list_enumerable.rb
 - lib/linked/listable.rb
+- lib/linked/mutable.rb
 - lib/linked/util.rb
 - lib/linked/version.rb
 - linked.gemspec
@@ -155,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Yet another linked list implementation in Ruby.