doubly_linkedlist 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3cc844b329f52174ce3389f0c1fda4c8f91f96efd411c610154bcd0e044c9e2
-  data.tar.gz: aebc095efbd852f1cd4afe54edb332c92175eedc25044c79f3ecaa54aef8c13a
+  metadata.gz: 8fe67884195d2f09260a6a101925e79f8c1623866484e4b4de63d47e420b8f90
+  data.tar.gz: b6f40e44fcc95f1506198f9d5f97e285b841b5e522c6f31f40d14081fa4dade9
 SHA512:
-  metadata.gz: ece5e87b139f17bcbc881641134ed81c438aad6ffde6de6331fd15c8593d2423d5fb7156f73bd3fb43d2ba320a395ab205c41179bb88ee3068a4f65115f9986e
-  data.tar.gz: b9986da96197040ce1b028524c42ce5485b5b9f7c5696d489c6d4e4ca322d9eed9156ecb3111fe5c8006c84b1b15beae2985011a362fe22e1aa467899e3840fc
+  metadata.gz: 631816dbbab742313398e44be5a8fe77ddab8dec76152ce3ab6059f7809ac3932283bd27a4fe3ff58476a15f795fda65a6daa45cfbef8386d4771d6803e6794c
+  data.tar.gz: a43529f9173dcea56fda8f5322f07f9b44ebd5897ead5e9dc113c482d11fa792a89b886baabaf85b29beb957d4b3ebf274d157fea01344961efbca898994b20e

data/doubly_linkedlist.gemspec

@@ -8,13 +8,14 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Ruby implementation of a Doubly Linkedlist data structure.}
   spec.description   = %q{Doubly Linkedlist with faster and minimal interface.}
-  spec.homepage      = "https://github.com/anshabmk/doubly_linkedlist"
+  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")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/anshabmk/doubly_linkedlist"
-  spec.metadata["changelog_uri"] = "https://github.com/anshabmk/doubly_linkedlist"
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/doubly_linkedlist"
+  spec.metadata["changelog_uri"] = "https://github.com/anshabmk/doubly_linkedlist/releases"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/doubly_linkedlist.rb

@@ -1,15 +1,18 @@
 require "doubly_linkedlist/version"
 
+# Namespace for DoublyLinkedlist
 module DoublyLinkedlist
+  # Standard Error class
   class Error < StandardError; end
-  # Your code goes here...
 end
 
 require 'doubly_linkedlist/list'
 
 # Monkey patching a method to_list into the Array class.
-# Usage: ary.to_list -> list
 class Array
+  # Converts a given array into a linkedlist.
+  #
+  # @return [DoublyLinkedlist::List] the linkedlist object with array elements as node values.
   def to_list
     DoublyLinkedlist::List.new(self)
   end

data/lib/doubly_linkedlist/list.rb

@@ -3,17 +3,23 @@
 require 'doubly_linkedlist/node'
 
 module DoublyLinkedlist
+  # Creates list with nodes
   class List
+    # @return [Integer] the number of nodes in the list.
     attr_reader :count
 
-    # Initialize a DoublyLinkedlist::List object with the values passed in
+    # Initializes the object with nodes having the values passed in
     # the optional argument array.
+    #
+    # @param values [Array] the values of nodes
     def initialize(values = [])
       @count = 0
       build_list_from_array(values)
     end
 
     # Returns the value at the head of the list if present, nil otherwise.
+    #
+    # @return [Object, Nil] the node value object or nil.
     def head
       @head.value if @head
     end
@@ -21,6 +27,8 @@ module DoublyLinkedlist
     alias :first :head
 
     # Returns the value at the tail of the list if present, nil otherwise.
+    #
+    # @return [Object, Nil] the node value object or nil.
     def tail
       @tail.value if @tail
     end
@@ -28,7 +36,9 @@ module DoublyLinkedlist
     alias :last :tail
 
     # Returns the node object at the given index if present, nil otherwise.
-    # Signature: Integer -> Node
+    #
+    # @param index [Integer] the index where to look up.
+    # @return [Object, Nil] the value at the given index, or nil if index is out of range.
     def find_at(index)
       return if (index + 1) > count
 
@@ -39,20 +49,27 @@ module DoublyLinkedlist
 
     # Returns the leftmost index of the value present in the list.
     # Returns nil if the value is not present.
-    # Signature: Type(node_value) -> Integer
+    #
+    # @param value [Object] the node value for which to be looked up.
+    # @return [Integer, Nil] the index of the value passed in, or nil if value is not present.
     def index(value)
       find_index(0, @head, :next, 1)
     end
 
     # Returns the rightmost index of value present in the list.
     # Returns nil if the value is not present.
-    # Signature: Type(node_value) -> Integer
+    #
+    # @param value [Object] the node value for which to be looked up.
+    # @return [Integer, Nil] the index of the value passed in, or nil if value is not present.
     def rindex(value)
       find_index(count - 1, @tail, :prev, -1)
     end
 
     # Inserts a node with the given value into the head of the list,
     # increments and returns the count of nodes.
+    #
+    # @param value [Object] the node value to be inserted into the list.
+    # @return [Integer] the number of nodes after insertion.
     def insert(value)
       new_node = Node.new(value)
       @head.prev = new_node if @head
@@ -66,6 +83,9 @@ module DoublyLinkedlist
 
     # Inserts a node with the given value into the tail of the list,
     # increments and returns the count of nodes.
+    #
+    # @param value [Object] the node value to be enqueued into the list.
+    # @return [Integer] the number of nodes after insertion.
     def enqueue(value)
       new_node = Node.new(value)
       @head = new_node unless @head
@@ -78,7 +98,9 @@ module DoublyLinkedlist
     # Deletes the node at a given index and returns the value present in the
     # deleted node.
     # Returns nil if the given index is out of range.
-    # Signature: int -> Type(deleted_node.value)
+    #
+    # @param index [Integer] the index at which node has to be deleted.
+    # @return [Object] the deleted node value.
     def delete_at(index)
       return if (index + 1) > count
 
@@ -99,7 +121,9 @@ module DoublyLinkedlist
       deleted.value
     end
 
-    # Pops out and returns the node_value at head.
+    # Pops out and returns the node_value at the list head.
+    #
+    # @return [Object] the popped out node value.
     def pop
       delete_at(0)
     end
@@ -107,6 +131,8 @@ module DoublyLinkedlist
     alias :deque :pop
 
     # Converts the list object into an array object with all the node values.
+    #
+    # @return [Array] the array object with node values as elements.
     def to_a
       item = @head
       arr = []
@@ -120,6 +146,8 @@ module DoublyLinkedlist
     end
 
     # Converts the array representation of list into a string.
+    #
+    # @return [String] the string object after converting the array representation of list into string.
     def to_s
       to_a.to_s
     end

data/lib/doubly_linkedlist/node.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
 module DoublyLinkedlist
+  # Creates a node with value and links to next/previous nodes.
   class Node
+    # @return [Object] the node value.
     attr_reader :value
+
+    # @return [Node] the next/previous node object.
     attr_accessor :next, :prev
 
+    # Initializes a node with the given object as its value.
+    #
+    # @param value [Object] the value to be set as node value.
     def initialize(value)
       @value = value
     end

data/lib/doubly_linkedlist/version.rb

@@ -1,3 +1,4 @@
 module DoublyLinkedlist
-  VERSION = "0.1.0"
+  # Gem version
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doubly_linkedlist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anshab M K
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-01 00:00:00.000000000 Z
+date: 2020-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -47,13 +47,14 @@ files:
 - lib/doubly_linkedlist/list.rb
 - lib/doubly_linkedlist/node.rb
 - lib/doubly_linkedlist/version.rb
-homepage: https://github.com/anshabmk/doubly_linkedlist
+homepage: https://github.com/anshabmk/doubly_linkedlist/blob/master/README.md
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/anshabmk/doubly_linkedlist
+  homepage_uri: https://github.com/anshabmk/doubly_linkedlist/blob/master/README.md
   source_code_uri: https://github.com/anshabmk/doubly_linkedlist
-  changelog_uri: https://github.com/anshabmk/doubly_linkedlist
+  documentation_uri: https://rubydoc.info/gems/doubly_linkedlist
+  changelog_uri: https://github.com/anshabmk/doubly_linkedlist/releases
 post_install_message: 
 rdoc_options: []
 require_paths: