doubly_linkedlist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3cc844b329f52174ce3389f0c1fda4c8f91f96efd411c610154bcd0e044c9e2
+  data.tar.gz: aebc095efbd852f1cd4afe54edb332c92175eedc25044c79f3ecaa54aef8c13a
+SHA512:
+  metadata.gz: ece5e87b139f17bcbc881641134ed81c438aad6ffde6de6331fd15c8593d2423d5fb7156f73bd3fb43d2ba320a395ab205c41179bb88ee3068a4f65115f9986e
+  data.tar.gz: b9986da96197040ce1b028524c42ce5485b5b9f7c5696d489c6d4e4ca322d9eed9156ecb3111fe5c8006c84b1b15beae2985011a362fe22e1aa467899e3840fc

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in doubly_linkedlist.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    doubly_linkedlist (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  doubly_linkedlist!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doubly_linkedlist'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install doubly_linkedlist
+
+## Usage
+
+#### Initialization
+
+There are two different ways to initialize a linkedlist including one which converting an array into a list by calling `to_list` method on the array object.
+
+You can find the examples below.
+
+```ruby
+    # You can pass an array as argument which
+    # will be the created list's node values.
+    list = DoublyLinkedlist.new([obj1, obj2, ...])
+
+    # Argument is optional. If not given,
+    # a empty list is created.
+    list1 = DoublyLinkedlist.new
+```
+#### Methods
+
+```ruby
+    list.count # => returns the number of nodes in the list
+
+    list.head # => returns the node value at the list's head. (Alias: first)
+
+    list.tail # => returns the node value at the list's tail. (Alias: last)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/anshabmk/doubly_linkedlist. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/anshabmk/doubly_linkedlist/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DoublyLinkedlist project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/anshabmk/doubly_linkedlist/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "doubly_linkedlist"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/doubly_linkedlist.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/doubly_linkedlist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doubly_linkedlist"
+  spec.version       = DoublyLinkedlist::VERSION
+  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.homepage      = "https://github.com/anshabmk/doubly_linkedlist"
+  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"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/lib/doubly_linkedlist.rb

@@ -0,0 +1,16 @@
+require "doubly_linkedlist/version"
+
+module DoublyLinkedlist
+  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
+  def to_list
+    DoublyLinkedlist::List.new(self)
+  end
+end

data/lib/doubly_linkedlist/list.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'doubly_linkedlist/node'
+
+module DoublyLinkedlist
+  class List
+    attr_reader :count
+
+    # Initialize a DoublyLinkedlist::List object with the values passed in
+    # the optional argument array.
+    def initialize(values = [])
+      @count = 0
+      build_list_from_array(values)
+    end
+
+    # Returns the value at the head of the list if present, nil otherwise.
+    def head
+      @head.value if @head
+    end
+
+    alias :first :head
+
+    # Returns the value at the tail of the list if present, nil otherwise.
+    def tail
+      @tail.value if @tail
+    end
+
+    alias :last :tail
+
+    # Returns the node object at the given index if present, nil otherwise.
+    # Signature: Integer -> Node
+    def find_at(index)
+      return if (index + 1) > count
+
+      item = @head
+      index.times { item = item.next }
+      item.value
+    end
+
+    # Returns the leftmost index of the value present in the list.
+    # Returns nil if the value is not present.
+    # Signature: Type(node_value) -> Integer
+    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
+    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.
+    def insert(value)
+      new_node = Node.new(value)
+      @head.prev = new_node if @head
+      new_node.next = @head
+      @tail = new_node unless @tail
+      @head = new_node
+      @count += 1
+    end
+
+    alias :push :insert
+
+    # Inserts a node with the given value into the tail of the list,
+    # increments and returns the count of nodes.
+    def enqueue(value)
+      new_node = Node.new(value)
+      @head = new_node unless @head
+      @tail.next = new_node if @tail
+      new_node.prev = @tail
+      @tail = new_node
+      @count += 1
+    end
+
+    # 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)
+    def delete_at(index)
+      return if (index + 1) > count
+
+      if index.zero?
+        deleted = @head
+        @head = @head.next
+      else
+        prev_item = @head
+
+        (index - 1).times { prev_item = prev_item.next }
+
+        deleted = prev_item.next
+        prev_item.next = deleted.next
+        @tail = prev_item if prev_item.next.nil?
+      end
+
+      @count -= 1
+      deleted.value
+    end
+
+    # Pops out and returns the node_value at head.
+    def pop
+      delete_at(0)
+    end
+
+    alias :deque :pop
+
+    # Converts the list object into an array object with all the node values.
+    def to_a
+      item = @head
+      arr = []
+
+      while item do
+        arr.push(item.value)
+        item = item.next
+      end
+
+      arr
+    end
+
+    # Converts the array representation of list into a string.
+    def to_s
+      to_a.to_s
+    end
+
+    alias :inspect :to_s
+
+    private
+
+    # Enqueue nodes one by one with the values given as an array into the list.
+    def build_list_from_array(values)
+      values.each { |v| enqueue(v) }
+    end
+
+    def find_index(start_index, start_item, item_iterator_name, step)
+      i = start_index
+      item = start_item
+
+      while item do
+        return i if item.value == value
+
+        item = item.send(item_iterator_name)
+        i += step
+      end
+    end
+  end
+end

data/lib/doubly_linkedlist/node.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DoublyLinkedlist
+  class Node
+    attr_reader :value
+    attr_accessor :next, :prev
+
+    def initialize(value)
+      @value = value
+    end
+  end
+end

data/lib/doubly_linkedlist/version.rb

@@ -0,0 +1,3 @@
+module DoublyLinkedlist
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: doubly_linkedlist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anshab M K
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Doubly Linkedlist with faster and minimal interface.
+email:
+- anshabmk@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doubly_linkedlist.gemspec
+- lib/doubly_linkedlist.rb
+- lib/doubly_linkedlist/list.rb
+- lib/doubly_linkedlist/node.rb
+- lib/doubly_linkedlist/version.rb
+homepage: https://github.com/anshabmk/doubly_linkedlist
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/anshabmk/doubly_linkedlist
+  source_code_uri: https://github.com/anshabmk/doubly_linkedlist
+  changelog_uri: https://github.com/anshabmk/doubly_linkedlist
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of a Doubly Linkedlist data structure.
+test_files: []