linked_lists 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 051b9202e1453821011079e89a87b543e43793e9a6444e4ec13d1b570ce9d091
+  data.tar.gz: 532365cb1268753b4b41eb5c081a0971771711f68ac1167f4996d56efd4ee3d8
+SHA512:
+  metadata.gz: ac45c59a26b80eac9f3b57d721e6d9242a1e8d50df82781f54760baba3bcfb5494941a3a7ceb173489b185d8f07168265c5ffe31e35834ac59604beda43c5659
+  data.tar.gz: 5c98d590c4bd92b18add5298b08c7d12fe1a0e1bd05a5a9f9e492156b76623ce48286fc5ce022cc9d40b478d4316ab8dc1c445cd91f5465bc14f86f7a3b7c65a

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  rubocop-espago: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/MissingElse:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-15
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in linked_lists.gemspec
+gemspec
+
+gem 'benchmark-ips' # benchmarks
+gem 'debug'
+gem 'minitest', '~> 5.0' # test framework
+gem 'rake', '~> 13.0' # automation scripts
+gem 'rake-compiler' # compiler for the native C extension
+gem 'rubocop-espago' # linter config
+gem 'solargraph' # Ruby language server
+gem 'yard' # documentation tool

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    linked_lists (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.0)
+    benchmark-ips (2.10.0)
+    debug (1.6.2)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    io-console (0.5.11)
+    irb (1.4.2)
+      reline (>= 0.3.0)
+    jaro_winkler (1.5.4)
+    json (2.6.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    minitest (5.16.3)
+    nokogiri (1.13.8-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rake-compiler (1.2.0)
+      rake
+    regexp_parser (2.6.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-espago (1.0.0)
+      rubocop
+    ruby-progressbar (1.11.0)
+    solargraph (0.47.2)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
+    tilt (2.0.11)
+    unicode-display_width (2.3.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  benchmark-ips
+  debug
+  linked_lists!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rake-compiler
+  rubocop-espago
+  solargraph
+  yard
+
+BUNDLED WITH
+   2.3.23

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Mateusz Drewniak
+
+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,70 @@
+# LinkedLists
+
+Adds the linked list structure to Ruby as a proper `Enumerable` class,
+like `Set` or `Array`.
+
+Has a similar set of methods to `Array` and `Set`.
+
+There are situations in which a linked list would be faster than an array.
+Shifting and unshifting elements for example.
+
+This library, for now, is implemented in Ruby which dwindles any performance
+benefits from using this data structure when compared to the native Ruby `Array`.
+
+I will reimplement it as a C extension, with the same API in the future.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add linked_lists
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install linked_lists
+
+## Usage
+
+There is a new data structure called `LinkedList` which may be used
+similarly to `Set` or `Array`.
+
+It is a proper `Enumerable`.
+
+```ruby
+list = LinkedList[1, 2, 3]
+list #=> #<LinkedList: {1, 2, 3}>
+list.shift #=> 1
+list #=> #<LinkedList: {2, 3}>
+list.unshift(:new) #=> #<LinkedList: {:new, 2, 3}>
+
+list.each do |value|
+    p value
+end
+# :new
+# 2
+# 3
+
+LinkedList[1, 2] + LinkedList[5,  'str'] #=> #<LinkedList: {1, 2, 5, 'str'}>
+
+LinkedList[10, 20, 30].map { |a| a * 2 } #=> #<LinkedList: {20, 40, 60}>
+list = LinkedList[10, 20, 30]
+list.map!(&:to_s)
+list #=> #<LinkedList: {"10", "20", "30"}>
+list.to_a #=> ["10", "20", "30"]
+
+LinkedList[:foo, nil, :bar, nil].compact #=> #<LinkedList: {:foo, :bar}>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/Verseth/linked_lists.
+
+## 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,24 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+::Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = ::FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+::RuboCop::RakeTask.new
+
+require 'rake/extensiontask'
+
+task build: :compile
+
+::Rake::ExtensionTask.new('linked_lists') do |ext|
+  ext.lib_dir = 'lib/linked_lists'
+end
+
+task default: %i[clobber compile test rubocop]

data/benchmark/append.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'benchmark_helper'
+
+COUNT = 1000
+
+def array_append
+  ary = []
+  COUNT.times { ary << _1 }
+end
+
+def list_append
+  linked_list = LinkedList.new
+  COUNT.times { linked_list << _1 }
+end
+
+Benchmark.ips do |x|
+  x.report('Array#append     ') { array_append }
+  x.report('LinkedList#append') { list_append }
+  x.compare!
+end
+
+# Ruby 3.1.2
+# Comparison:
+#    Array#append     :    30031.2 i/s
+#    LinkedList#append:       30.3 i/s - 989.63x  (± 0.00) slower

data/benchmark/benchmark_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+require 'benchmark/ips'
+require_relative '../lib/linked_lists'

data/benchmark/pop.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'benchmark_helper'
+
+COUNT = 10_000
+ARRAY = Array(0...COUNT)
+LIST = LinkedList.new(0...COUNT)
+
+
+def array_pop
+  while ARRAY.pop; end
+end
+
+def list_pop
+  while LIST.pop; end
+end
+
+Benchmark.bm do |x|
+  x.report('Array#pop     ') { array_pop }
+  x.report('LinkedList#pop') { list_pop }
+end
+
+# Ruby 3.1.2
+# user     system      total        real
+# Array#pop       0.000188   0.000022   0.000210 (  0.000207)
+# LinkedList#pop  2.771274   0.046929   2.818203 (  2.818997)

data/benchmark/shift.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'benchmark_helper'
+
+COUNT = 10_000
+ARRAY = Array(0...COUNT)
+LIST = LinkedList.new(0...COUNT)
+
+def array_shift
+  while ARRAY.shift; end
+end
+
+def list_shift
+  while LIST.shift; end
+end
+
+Benchmark.bm do |x|
+  x.report('Array#shift     ') { array_shift }
+  x.report('LinkedList#shift') { list_shift }
+end
+
+# Ruby 3.1.2
+# user     system      total        real
+# Array#shift       0.000198   0.000002   0.000200 (  0.000198)
+# LinkedList#shift  0.000909   0.000005   0.000914 (  0.000910)

data/benchmark/unshift.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'benchmark_helper'
+
+COUNT = 1000
+
+def array_unshift
+  ary = []
+  COUNT.times { ary.unshift _1 }
+end
+
+def list_unshift
+  linked_list = LinkedList.new
+  COUNT.times { linked_list.unshift _1 }
+end
+
+Benchmark.ips do |x|
+  x.report('Array#unshift     ') { array_unshift }
+  x.report('LinkedList#unshift') { list_unshift }
+  x.compare!
+end
+
+# Ruby 3.1.2
+# Comparison:
+#   Array#unshift     :    23358.6 i/s
+#   LinkedList#unshift:     4713.2 i/s - 4.96x  (± 0.00) slower

data/ext/linked_lists/extconf.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+create_makefile("linked_lists/linked_lists")

data/ext/linked_lists/linked_lists.c

@@ -0,0 +1,9 @@
+#include "linked_lists.h"
+
+VALUE rb_mLinkedLists;
+
+void
+Init_linked_lists(void)
+{
+  rb_mLinkedLists = rb_define_module("LinkedLists");
+}

data/ext/linked_lists/linked_lists.h

@@ -0,0 +1,6 @@
+#ifndef LINKED_LISTS_H
+#define LINKED_LISTS_H 1
+
+#include "ruby.h"
+
+#endif /* LINKED_LISTS_H */

data/lib/linked_lists/linked_list/node.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class LinkedList
+  # Represents a node of a singly linked list.
+  class Node
+    class << self
+      # @param value [Object] Value to be wrapped in a node.
+      # @return [self]
+      def wrap(value)
+        return value if value.is_a?(self)
+
+        new(value)
+      end
+
+      alias [] wrap
+    end
+
+    # @return [self, nil] Next node of the linked list.
+    attr_accessor :next
+    # @return [Object] The value stored by this node.
+    attr_accessor :value
+
+    # @param value [Object]
+    # @param next_node [self, nil]
+    def initialize(value = nil, next_node = nil)
+      @value = value
+      @next = next_node
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class} #{value.inspect}>"
+    end
+
+    # Inserts the given `objects` after `self`.
+    #
+    # Time complexity is *O(m)* where *m* is the length of given `objects`.
+    #
+    # @param objects [Object]
+    # @return [self]
+    def insert_after(*objects)
+      prev_node = self
+      objects.each do |obj|
+        new_node = self.class.new obj
+        new_node.next = prev_node.next
+        prev_node.next = new_node
+        prev_node = new_node
+      end
+
+      self
+    end
+
+    # Set this node as the head of
+    # a new linked list.
+    #
+    # @return [LinkedList]
+    def to_list
+      list = LinkedList.new
+      list.head = self
+      list
+    end
+  end
+end