linked 0.4.0 → 0.5.1

data/lib/linked/util.rb

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

data/lib/linked/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Linked
-  VERSION = '0.4.0'
+  # The current version number of the Linked library.
+  VERSION = '0.5.1'
 end

data/linked.gemspec

@@ -1,26 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'linked/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "linked"
+  spec.name          = 'linked'
   spec.version       = Linked::VERSION
-  spec.authors       = ["Sebastian Lindberg"]
-  spec.email         = ["seb.lindberg@gmail.com"]
+  spec.authors       = ['Sebastian Lindberg']
+  spec.email         = ['seb.lindberg@gmail.com']
 
-  spec.summary       = %q{Yet another linked list implementation in Ruby.}
-  spec.description   = %q{Yes, there are a lot of linked list implementaions out there but I wrote my own all the same. This library is ment to be subclassed/included by other objects that that behave like linked lists.}
-  spec.homepage      = "https://github.com/seblindberg/ruby-linked"
-  spec.license       = "MIT"
+  spec.summary       = 'Yet another linked list implementation in Ruby.'
+  spec.description   = 'Yes, there are a lot of linked list implementaions ' \
+                       'out there but I wrote my own all the same. This ' \
+                       'library is ment to be subclassed/included by other ' \
+                       'objects that that behave like linked lists.'
+  spec.homepage      = 'https://github.com/seblindberg/ruby-linked'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  
+  spec.metadata['yard.run'] = 'yri'
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  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.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Sebastian Lindberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Yes, there are a lot of linked list implementaions out there but I wrote
   my own all the same. This library is ment to be subclassed/included by other objects
   that that behave like linked lists.
@@ -76,6 +118,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -86,14 +129,16 @@ files:
 - lib/linked.rb
 - lib/linked/item.rb
 - lib/linked/list.rb
-- lib/linked/list/eol.rb
+- lib/linked/list_enumerable.rb
 - lib/linked/listable.rb
+- lib/linked/util.rb
 - lib/linked/version.rb
 - linked.gemspec
 homepage: https://github.com/seblindberg/ruby-linked
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -110,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Yet another linked list implementation in Ruby.

data/lib/linked/list/eol.rb

@@ -1,84 +0,0 @@
-module Linked
-  class List
-    # End Of List
-    #
-    # This class implements a special list item that is placed at both the end
-    # and the beginning of a chain of listable items to form a list. The naming
-    # (end of list) comes from the fact that this object, by returning true for
-    # calls to #nil?, signifies the end of a list of Items. In both directions
-    # as a matter of fact, which is why the head and tail objects defined by
-    # Item are combined into one.
-    #
-    # In a nutshell, the structure looks something like this:
-    #
-    #   +-------------------- EOL --------------------+
-    #   | (head)                               (tail) |
-    #   +---------------------------------------------+
-    #     ^ +-- Item 1 ---+         +-- Item N ---+ ^
-    #     +-| prev | next |<- ... ->| prev | next |-+
-    #       +------+------+         +------+------+
-
-    class EOL
-      include Listable
-
-      # Calling #delete on the EOL is not supported and would break the
-      # connection between the list and its items.
-
-      undef delete
-
-      # Creates a new enf-of-list, as part of a list, with no items yet added to
-      # it.
-      #
-      # list - a List object.
-
-      def initialize(list)
-        super()
-        self.list = list
-        reset
-      end
-
-      # EOL objects will return true when asked if they are nil. This is
-      # foremost an implementation detail to comply with the requirements of the
-      # Item class, but also logical in the sense that end-of-list objects are
-      # not really part of the list, and should therefore be considered nil.
-      #
-      # Returns true.
-
-      def nil?
-        true
-      end
-
-      # Inserts one or more items at the end of the list.
-      #
-      # See Item#append for more details.
-
-      def append(object)
-        empty? ? super : prev!.append(object)
-      end
-
-      # Inserts one or more items at the beginning of the list.
-      #
-      # See Item#append for more details.
-
-      def prepend(object)
-        empty? ? super : next!.prepend(object)
-      end
-
-      # Private helper to reset the EOL to its initial state. This method should
-      # never be called directly as it leaves the both the list and the items in
-      # an inconsistant state.
-
-      private def reset
-        self.prev = self.next = self
-      end
-
-      # Private helper to check if the item chain is empty.
-      #
-      # Return true if the chain is empty, otherwise nil.
-
-      private def empty?
-        prev!.equal? self
-      end
-    end
-  end
-end