circular_linked 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eaddc29746a2d99c05aadcf1e490004f23683178dc49afd5293656c3edceded
-  data.tar.gz: 3c906b3079d972ceadad706bcb3cf93749600c24d3b4ebbad7f91cd19df91555
+  metadata.gz: 2ee4718ad6b13d0e668d8f05e492b7f598bd71d283ce08f2a8ba74375de0d9b0
+  data.tar.gz: 3179b128f466ad9903afb558cb8e267df7efda588276038a6181e5968a65d251
 SHA512:
-  metadata.gz: d583d18873400eec464d1d708aa3b1d4791c1cc38af6b824a2b9f904be4633882b42eaeda58627608159e6da40f58eed5051824c38cc03f34ca6051b187f513b
-  data.tar.gz: 2034ffcd127a04c5d6b1e4a9fce71580b4caddddf6c92525399fb57e036a8ab931ee4f4e3a72e2e792732894fdfb1578fcbdc6ee707436b4df7d271a08a7344e
+  metadata.gz: 4750dd9ec7c3f4d67eae36551866d5c46c2a82f0224e681f4fe23147c5b8848068426a2f957f3efaaaf54ef2d40907274c24e394f50d3bc00a7b14ec079ef53a
+  data.tar.gz: 508684fdb577837bef65dba842aca84e4dc8973631196e0d99870cd917f2bb25b617cf2eb6d6f0974c9bcc48037a582733afd4aa288c19c574cfc268005ae622

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.gem/
+Gemfile.lock

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Gabriela Matos Guedes
+
+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,75 @@
+# Circular Linked List
+
+Implementation for the circular linked list data structure for Ruby.
+
+List is composed by nodes, which have each one a value and a next item.
+
+## Installation
+
+Just add to your Gemfile:
+
+```
+gem "circular_linked"
+```
+
+Then
+
+```
+$ bundle install
+```
+
+Or you can install the gem directly from terminal:
+
+```
+$ gem install circular_linked
+```
+
+## Usage
+
+```ruby
+items_list = CircularLinked::List.new(1, 2, 3)
+empty_list = CircularLinked::List.new
+
+items_list.head #=> #<Node:0x... @value=1 ...
+empty_list.head #=> nil
+
+items_list.add(4) # List now have nodes with the values: 1, 2, 3, 4
+
+items_list.last_node #=> 4
+empty_list.last_node #=> nil
+
+items_list.find(2) #=> #<Node:0x... @value=2 ...
+empty_list.find(2) #=> nil
+
+items_list.remove(3) # List now have nodes with the values: 1, 2, 4
+empty_list.remove(3) # List remains empty
+
+items_list.items_value #=> [1,2,4]
+empty_list.items_value #=> []
+
+items_list.length #=> 3
+empty_list.length #=> 0
+
+items_list.each {|node| puts node.value }
+#=> 1
+#=> 2
+#=> 4
+empty_list.each {|node| puts node.value }
+#=>
+```
+
+## Development
+
+Just run `bundle install` to install the dependencies and you are ready.
+
+## Tests
+
+To run the specs, after installing the dependecies as said above, you can just run in the main folder:
+
+```
+$ rspec .
+```
+
+## Contributing
+
+Feel free to open pull requests/issues or to fork this repo.

data/circular_linked.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name        = 'circular_linked'
+  s.version     = '0.1.1'
+  s.summary     = 'Circular Linked List implementation'
+  s.description = 'Provides a circular linked list data structure for Ruby with the most common methods'
+  s.authors     = ['Gabriela Guedes']
+  s.email       = 'gabriela.guedes.gmg@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/GabrielaGuedes/circular_linked'
+  s.license       = 'MIT'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circular_linked
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Gabriela Guedes
@@ -17,14 +17,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
+- LICENSE
+- README.md
+- circular_linked.gemspec
 - lib/circular_linked.rb
 - lib/circular_linked/list.rb
 - lib/circular_linked/node.rb
 - spec/circular_linked/list_spec.rb
 - spec/circular_linked/node_spec.rb
-homepage: 
+homepage: https://github.com/GabrielaGuedes/circular_linked
 licenses:
 - MIT
 metadata: {}