ds_101 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37b04a30b9345f90077db11dfe947aa34abeb9d5fe5ebceb853791d766aa103c
+  data.tar.gz: af1dd45e8659a4f3e95417d5e341d1c8d03c60d65e75409b7737b13d54548417
+SHA512:
+  metadata.gz: 6bbbc3b8c7c6383cc668189d63b65e77463bce3d944a4872f1347120801119664dcd9c6f7937d31aae954afc908f79c624dcb4af047226359591087e25eedf59
+  data.tar.gz: 85a2d57313a6be4a8058515d21f2d4664b69a9c418491512c04a4b6602b85097961086d2eb2f43b0cb50bc10b197e0e55e5941c6cf803146111c0b72d1a3a905

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-29
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 ShroukAbozeid
+
+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,54 @@
+# Ds101
+
+A Simple Implementation of Data Structure in Ruby.
+
+Currently Available Data Structures:
+
+- Linked List
+- Double Linked List
+
+## Installation
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+ after installing the gem, you can use available class and their methods.
+ Classes:
+ - `Ds101::LinkedList::SingleLinkedList`
+ - `Ds101::LinkedList::DoubleLinkedList`
+ 
+ Both classes has the following methods:
+ - `append`
+ - `remove`
+ - `remove_head`
+ - `clear`
+ - `to_a`
+ - `find`
+ - `find_by`
+ - `each`
+ - `concat`
+ - `init_from_arr`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 the created tag, 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/ShroukAbozeid/ds_101.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ds_101/linked_list/common.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Ds101
+  module LinkedList
+    module Common
+      def find(value)
+        current = head
+        current = current.next while current && current.value != value
+        current
+      end
+
+      def find_by(&block)
+        current = head
+        while current
+          return current if block.call(current)
+
+          current = current.next
+        end
+        nil
+      end
+
+      def each
+        current = head
+        while current
+          yield current
+          current = current.next
+        end
+      end
+
+      def concat(other_list)
+        other_list.each do |node|
+          append(node.value)
+        end
+      end
+
+      def to_a
+        arr = []
+        each do |node|
+          arr << node.value
+        end
+        arr
+      end
+
+      def clear
+        remove_head while length.positive?
+      end
+    end
+  end
+end

data/lib/ds_101/linked_list/double_linked_list.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "common"
+module Ds101
+  module LinkedList
+    class DoubleLinkedList
+      include Ds101::LinkedList::Common
+      attr_reader :head, :tail, :length
+
+      class Node
+        attr_accessor :value, :next, :prev
+
+        def initialize(value:, next_node: nil, prev_node: nil)
+          @value = value
+          @next = next_node
+          @prev = prev_node
+        end
+      end
+
+      def initialize
+        @head = nil
+        @tail = nil
+        @length = 0
+      end
+
+      def self.init_from_arr(arr)
+        list = DoubleLinkedList.new
+        arr.each do |value|
+          list.append(value)
+        end
+        list
+      end
+
+      def append(value)
+        node = Node.new(value: value)
+        if head.nil?
+          @head = node
+        else
+          tail.next = node
+          node.prev = tail
+        end
+        @tail = node
+        @length += 1
+        node
+      end
+
+      def remove(value)
+        return unless head
+        return remove_head if head.value == value
+
+        current = head
+        current = current.next while current&.next && current.next.value != value
+        return unless current&.next
+
+        if current.next == tail
+          @tail = current
+          @tail.next = nil
+        else
+          current.next = current.next.next
+          current.next.prev = current
+        end
+        @length -= 1
+      end
+
+      def remove_head
+        if head.next.nil?
+          @head = nil
+          @tail = nil
+        else
+          head.next.prev = nil
+          @head = head.next
+        end
+        @length -= 1
+      end
+    end
+  end
+end

data/lib/ds_101/linked_list/single_linked_list.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "common"
+module Ds101
+  module LinkedList
+    class SingleLinkedList
+      include Ds101::LinkedList::Common
+      attr_accessor :head, :tail, :length
+
+      def initialize
+        @head = nil
+        @tail = nil
+        @length = 0
+      end
+
+      def self.init_from_arr(arr)
+        list = SingleLinkedList.new
+        arr.each do |value|
+          list.append(value)
+        end
+        list
+      end
+
+      def append(value)
+        node = Node.new(value: value)
+        if head.nil?
+          @head = node
+        else
+          tail.next = node
+        end
+        @tail = node
+        @length += 1
+        node
+      end
+
+      def remove(value)
+        return unless head
+        return remove_head if head.value == value
+
+        current = head
+        current = current.next while current&.next && current.next.value != value
+        return unless current&.next
+
+        if current.next == tail
+          @tail = current
+        else
+          current.next = current.next.next
+        end
+        @length -= 1
+      end
+
+      def remove_head
+        if head.next.nil?
+          @head = nil
+          @tail = nil
+        else
+          @head = head.next
+        end
+        @length -= 1
+      end
+
+      class Node
+        attr_accessor :value, :next
+
+        def initialize(value:, next_node: nil)
+          @value = value
+          @next = next_node
+        end
+      end
+    end
+  end
+end

data/lib/ds_101/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ds101
+  VERSION = "0.1.0"
+end

data/lib/ds_101.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "ds_101/version"
+require "ds_101/linked_list/single_linked_list"
+require "ds_101/linked_list/double_linked_list"
+
+module Ds101
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/ds_101.rbs

@@ -0,0 +1,4 @@
+module Ds101
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ds_101
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ShroukAbozeid
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: 
+email:
+- shrouk.dev@proton.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ds_101.rb
+- lib/ds_101/linked_list/common.rb
+- lib/ds_101/linked_list/double_linked_list.rb
+- lib/ds_101/linked_list/single_linked_list.rb
+- lib/ds_101/version.rb
+- sig/ds_101.rbs
+homepage: https://github.com/ShroukAbozeid/ds_101
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ShroukAbozeid/ds_101
+  source_code_uri: https://github.com/ShroukAbozeid/ds_101
+  changelog_uri: https://github.com/ShroukAbozeid/ds_101/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: A Simple Implementation of Data Structure in Ruby
+test_files: []