doubly_linkedlist 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47ad35ba5b5fce866c46f143f8d1adc8cd9230fb477ce3af85cc862c2f22d5e1
-  data.tar.gz: 2ef37aa5fc4465ea04328d3e8b1b091cfb1a79a8c421619ba65aa349832cf2f9
+  metadata.gz: 4e865f7e649d417e521eee62161eefad156b78713dfe2a980132165664929c45
+  data.tar.gz: 21e9e0fd3239a3abb074d5ddd25fd66449cf57dcd1c713959762ac3f43456369
 SHA512:
-  metadata.gz: c2555a7110da1148d3e0e141b9aacf62c8c1d981bac0278d8ea86ff3032fdecdfcee08dd953edc12e701966e7834e1f1533f264d32697d83892d649e6a451216
-  data.tar.gz: 7ef1c47806d9165fd861d626949b471e9e266b2ed3ea56dcf7b12098345c81a63ebfb2484ffafe734e019ab51b3735ded134c61e0f9b4203a5374c06f964be1b
+  metadata.gz: 6e004e644641a8c7f653bb910a897c4db89f8a78442b5a0f904c2fa5cc000d8e751a07aedcea003cd3ff76e007c59f68b614c52b660e51bca4ed6a31df66b477
+  data.tar.gz: c4126333e9b1ed4540137eb9e95ce2c96ae6a9417386a0e4399d9f1e2862c286ac24dc312f54584fc7906ffbd9841c79d5866ad3ad5f1eb5cd47d18626329292

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    doubly_linkedlist (0.2.0)
+    doubly_linkedlist (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # DoublyLinkedlist
 
-A Ruby implementation of the famous Doubly Linkedlist data structure following ruby idioms. A Linkedlist is efficient in many specific cases than other data structures such as Array.
+A Ruby implementation of the famous Doubly Linkedlist data structure with support to the Enumerable methods such as `each`, `to_a`, `map`, etc. following ruby idioms. Supports Queue operations as well as Stack operations. A Linkedlist is efficient in many specific cases than other data structures such as Array.
 
 ## Installation
 
@@ -124,7 +124,7 @@ list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
 list.count # => 5
 
 list.delete_at(1) # => "Some object"
-list # => [1, 40, 100, 40]
+list # => <DoublyLinkedlist::List: [1, 40, 100, 40]>
 list.count # => 4
 
 list.delete_at(6) # => nil
@@ -138,6 +138,23 @@ Converts the list object into an array object with all the node values.
 ```ruby
 list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
 
+```
+#### Enumerable Methods Support
+
+Supports the methods available in the Enumerable module such as `to_a`, `each`, `each_with_object`, `any?`, etc. For more information on available methods refer documentation for Ruby Enumerable Module.
+
+Some examples below,
+```ruby
+list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
+
+list.each { |obj| puts obj }
+# 1
+# Some object
+# 40
+# 100
+# 40
+# => nil
+
 arr = list.to_a
 arr.class # => Array
 arr # => [1, "Some object", 40, 100, 40]
@@ -154,7 +171,7 @@ increments and returns the count of nodes.
 list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
 
 list.push(25) # => 6
-list # => [25, 1, "Some object", 40, 100, 40]
+list # => <DoublyLinkedlist::List: [25, 1, "Some object", 40, 100, 40]>
 ```
 
 ##### #pop
@@ -166,7 +183,7 @@ list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
 
 list.pop # => 1
 list.count # => 4
-list # => ["Some object", 40, 100, 40]
+list # => <DoublyLinkedlist::List: ["Some object", 40, 100, 40]>
 ```
 
 #### Queue Operations
@@ -180,7 +197,7 @@ increments and returns the count of nodes.
 list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
 
 list.enqueue(25) # => 6
-list # => [1, "Some object", 40, 100, 40, 25]
+list # => <DoublyLinkedlist::List: [1, "Some object", 40, 100, 40, 25]>
 ```
 
 ##### #deque
@@ -192,7 +209,7 @@ list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
 
 list.deque # => 1
 list.count # => 4
-list # => ["Some object", 40, 100, 40]
+list # => <DoublyLinkedlist::List: ["Some object", 40, 100, 40]>
 ```
 
 Refer [documentation](https://rubydoc.info/gems/doubly_linkedlist/DoublyLinkedlist/) for more information.

data/doubly_linkedlist.gemspec

@@ -6,8 +6,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Anshab M K"]
   spec.email         = ["anshabmk@live.com"]
 
-  spec.summary       = %q{Ruby implementation of a Doubly Linkedlist data structure.}
-  spec.description   = %q{Doubly Linkedlist with faster and minimal interface.}
+  spec.summary       = %q{
+    An iterable, minimal Ruby implementation of a Doubly Linkedlist data structure.
+  }
+
+  spec.description   = %q{
+    A Ruby implementation of the famous Doubly Linkedlist data structure with support 
+    to the Enumerable methods such as `each`, `to_a`, `map`, etc. following ruby idioms. 
+    Supports Queue operations as well as Stack operations. A Linkedlist is efficient in 
+    many specific cases(eg:- Queue operations) than other data structures such as Array.
+  }
+
   spec.homepage      = "https://github.com/anshabmk/doubly_linkedlist/blob/master/README.md"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")

data/lib/doubly_linkedlist/list.rb

@@ -5,6 +5,8 @@ require 'doubly_linkedlist/node'
 module DoublyLinkedlist
   # Creates list with nodes
   class List
+    include Enumerable
+
     # @return [Integer] the number of nodes in the list.
     attr_reader :count
 
@@ -130,29 +132,37 @@ module DoublyLinkedlist
 
     alias :deque :pop
 
-    # Converts the list object into an array object with all the node values.
+    # Converts the list representation into a string.
     #
-    # @return [Array] the array object with node values as elements.
-    def to_a
-      item = @head
-      arr = []
+    # @return [String] the string object after converting the representation of list into string.
+    def to_s
+      str = "<#{self.class}: ["
 
-      while item do
-        arr.push(item.value)
-        item = item.next
+      each_with_index do |v, i|
+        str += v.to_s
+        str += ', ' unless i == (count - 1)
       end
 
-      arr
+      str + ']>'
     end
 
-    # Converts the array representation of list into a string.
+    alias :inspect :to_s
+
+    # Support for Enumerable methods.
     #
-    # @return [String] the string object after converting the array representation of list into string.
-    def to_s
-      to_a.to_s
-    end
+    # @params [Block] the block to be yielded on each item
+    # @return [Enumerator] the enumerator when no block is given
+    # @return [DoublyLinkedlist] the object after yielding block on every item
+    def each
+      return enum_for(:each) unless block_given?
 
-    alias :inspect :to_s
+      item = @head
+
+      while item do
+        yield item.value
+        item = item.next
+      end
+    end
 
     private
 

data/lib/doubly_linkedlist/version.rb

@@ -1,4 +1,4 @@
 module DoublyLinkedlist
   # Gem version
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doubly_linkedlist
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Anshab M K
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2020-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,7 +24,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-description: Doubly Linkedlist with faster and minimal interface.
+description: "\n    A Ruby implementation of the famous Doubly Linkedlist data structure
+  with support \n    to the Enumerable methods such as `each`, `to_a`, `map`, etc.
+  following ruby idioms. \n    Supports Queue operations as well as Stack operations.
+  A Linkedlist is efficient in \n    many specific cases(eg:- Queue operations) than
+  other data structures such as Array.\n  "
 email:
 - anshabmk@live.com
 executables: []
@@ -73,5 +77,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Ruby implementation of a Doubly Linkedlist data structure.
+summary: An iterable, minimal Ruby implementation of a Doubly Linkedlist data structure.
 test_files: []