linked-list 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a0280fdef3349b667cc6b932c6873c6b2e23c25
-  data.tar.gz: 57e230c91ee076d78d42e549dd562e3b6cdebffd
+  metadata.gz: 5cf89e62ce52b53b8f7662c7b33b13376ef92ae6
+  data.tar.gz: fa7edc99d8406550a2904270bb19cbcfa5029050
 SHA512:
-  metadata.gz: 30ba2f45bca37a529dd265f41b523dcdf69649d4b66ce6baa1dd650815c5139e7cea5b942de9d7dcfd3f9b69ed11ff4feca8cf46be89c3dab3b5baae9f37ed7d
-  data.tar.gz: 556a3fa2ec3a3497159a3b4a73bbdaab88719a9c01fc63f41c84b71c773675e0369c10ae0581524d06b9999c8612667fb1c96b67c99327cc4055dfba3906e6c0
+  metadata.gz: 27a447dcf94c2b742d113ede66a551956c54c66d0fd58ca9197b4febafc2fab0cd2b25d80e5fa3ebf998782f439a00f85af770b4a264e2ac4ced99f8e0f0b5e5
+  data.tar.gz: 51f4fe4ffacd1db48697fa9eb6cbef9972f8bab3cf2e1f0b14929d99d3dd4cb9532a0d001a2edbbcb8eda8a08d0561cd59e8398e69033fa27ef9c6fdb922ca41

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+cache: bundler

data/README.md

@@ -1,5 +1,7 @@
 [![Code Climate](https://codeclimate.com/github/spectator/linked-list.png)](https://codeclimate.com/github/spectator/linked-list)
 [![Build Status](https://secure.travis-ci.org/spectator/linked-list.png?branch=master)](http://travis-ci.org/spectator/linked-list)
+[![Gem Version](https://badge.fury.io/rb/linked-list.png)](http://badge.fury.io/rb/linked-list)
+[![Coverage Status](https://coveralls.io/repos/spectator/linked-list/badge.png)](https://coveralls.io/r/spectator/linked-list)
 
 # LinkedList
 
@@ -48,15 +50,43 @@ list.each { |e| puts e }
 list.first     # head of the list
 list.last      # tail of the list
 
+list.length
+list.size      # same as `length`
+
 list.to_a
 ```
 
-Please see `LinkedList::List` and `LinkedList::Node` for details.
+Another way to instantiate `List` or `Node` is to use conversion functions.
+First, include `LinkedList::Conversions` module to your class
+
+```ruby
+class Foo
+  include LinkedList::Conversions
+end
+```
+
+Now anywhere in your class you can use the following methods
+
+```ruby
+Node(object)           # will return new `Node` object
+List(object)           # will return new `List` object with one `Node` object
+List([object, object]) # will return new `List` object with two `Node` objects
+```
+
+Please see `LinkedList::List`, `LinkedList::Node`, and
+`LinkedList::Conversions` for details.
 
 ## TODO
 
 * Insert / delete in the middle
-* More readable `inspect`
+
+## Tests
+
+Run test with
+
+```shell
+$ rake
+```
 
 ## Contributing
 

data/lib/linked-list/list.rb

@@ -29,7 +29,7 @@ module LinkedList
     # node:: Any object, including +Node+ objects.
     #
     # == Returns:
-    # self of +List+ object.
+    # +self+ of +List+ object.
     #
     def push(node)
       node = Node(node)
@@ -49,7 +49,7 @@ module LinkedList
     # node:: Any object, including +Node+ objects.
     #
     # == Returns:
-    # self of +List+ object.
+    # +self+ of +List+ object.
     #
     def unshift(node)
       node = Node(node)
@@ -62,7 +62,7 @@ module LinkedList
       self
     end
 
-    # Removes node from the end of the list.
+    # Removes data from the end of the list.
     #
     # == Returns:
     # Data stored in the node or nil.
@@ -84,7 +84,7 @@ module LinkedList
       tail.data
     end
 
-    # Removes node from the beginning of the list.
+    # Removes data from the beginning of the list.
     #
     # == Returns:
     # Data stored in the node or nil.
@@ -111,7 +111,7 @@ module LinkedList
     # Reverses list of nodes in place.
     #
     # == Returns:
-    # self in reverse order.
+    # +self+ in reverse order.
     #
     def reverse!
       return self unless @head
@@ -148,10 +148,14 @@ module LinkedList
     end
     alias_method :to_ary, :to_a
 
+    def inspect
+      sprintf('#<%s:%#x %s>', self.class, self.__id__, to_a.inspect)
+    end
+
     # Conversion function, see +Conversions.List+.
     #
     # == Returns:
-    # self
+    # +self+
     #
     def to_list
       self
@@ -162,6 +166,7 @@ module LinkedList
     def __shift
       head = @head
       @head = @head.next
+      head.next = nil
       head
     end
 

data/lib/linked-list/version.rb

@@ -1,5 +1,5 @@
 module Linked
   module List
-    VERSION = '0.0.7'
+    VERSION = '0.0.8'
   end
 end

data/linked-list.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'bundler',  '>= 1.3', '<= 2.0'
   spec.add_development_dependency 'minitest', '>= 5.0', '<= 6.0'
+  spec.add_development_dependency 'coveralls'
 end

data/test/list_test.rb

@@ -195,6 +195,21 @@ describe LinkedList::List do
     end
   end
 
+  describe '#inspect' do
+    it 'includes class name' do
+      assert_match(/LinkedList::List/, list.inspect)
+    end
+
+    it 'includes object id' do
+      assert_match(/#{list.object_id.to_s(16)}/, list.inspect)
+    end
+
+    it 'includes node values' do
+      list.push(node_1)
+      assert_match(/foo/, list.inspect)
+    end
+  end
+
   describe 'conversion' do
     it '#to_list returns self' do
       assert_equal list, list.to_list

data/test/test_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'linked-list'
 
 gem 'minitest'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linked-list
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Yury Velikanau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-08 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -64,6 +64,20 @@ dependencies:
     - - <=
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby implementation of Linked List, following some Ruby idioms.
 email:
 - yury.velikanau@gmail.com
@@ -107,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Ruby implementation of Linked List, following some Ruby idioms.