linked-list 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a0280fdef3349b667cc6b932c6873c6b2e23c25
+  data.tar.gz: 57e230c91ee076d78d42e549dd562e3b6cdebffd
+SHA512:
+  metadata.gz: 30ba2f45bca37a529dd265f41b523dcdf69649d4b66ce6baa1dd650815c5139e7cea5b942de9d7dcfd3f9b69ed11ff4feca8cf46be89c3dab3b5baae9f37ed7d
+  data.tar.gz: 556a3fa2ec3a3497159a3b4a73bbdaab88719a9c01fc63f41c84b71c773675e0369c10ae0581524d06b9999c8612667fb1c96b67c99327cc4055dfba3906e6c0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in linked-list.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yury Velikanau
+
+MIT License
+
+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,67 @@
+[![Code Climate](https://codeclimate.com/github/spectator/linked-list.png)](https://codeclimate.com/github/spectator/linked-list)
+[![Build Status](https://secure.travis-ci.org/spectator/linked-list.png?branch=master)](http://travis-ci.org/spectator/linked-list)
+
+# LinkedList
+
+Ruby implementation of Linked List, following some Ruby idioms.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'linked-list'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install linked-list
+```
+
+## Usage
+
+```ruby
+object = Object.new # could be anything
+list = LinkedList::List.new
+
+list.push(object)
+list << object # same as `push`
+
+list.unshift(object)
+
+list.pop
+list.shift
+
+list.reverse
+list.reverse!
+
+list.each      # Enumerator object
+list.each { |e| puts e }
+
+list.first     # head of the list
+list.last      # tail of the list
+
+list.to_a
+```
+
+Please see `LinkedList::List` and `LinkedList::Node` for details.
+
+## TODO
+
+* Insert / delete in the middle
+* More readable `inspect`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs    << 'test'
+  t.pattern = 'test/*_test.rb'
+end
+
+task default: 'test'

data/lib/linked-list.rb

@@ -0,0 +1,3 @@
+require 'linked-list/conversions'
+require 'linked-list/node'
+require 'linked-list/list'

data/lib/linked-list/conversions.rb

@@ -0,0 +1,42 @@
+module LinkedList
+  module Conversions
+    module_function
+
+    # +Node()+ tries to convert its argument to +Node+ object by first calling
+    # +#to_node+, if that is not availabe then it will instantiate a new +Node+
+    # object.
+    #
+    # == Returns:
+    # New +Node+ object.
+    #
+    def Node(arg)
+      case arg
+      when ->(_arg) { _arg.respond_to?(:to_node) }
+        arg.to_node
+      else
+        Node.new(arg)
+      end
+    end
+
+    # +List()+ tries to conver its argument to +List+ object by first calling
+    # +#to_list+, if that is not availabe and its argument is an array (or can
+    # be convertd into array with +#to_ary+) then it will instantiate a new
+    # +List+ object making nodes from array elements. If none above applies,
+    # then a new +List+ will be instantiated with one node holding argument
+    # value.
+    #
+    # == Returns:
+    # New +List+ object.
+    #
+    def List(arg)
+      case arg
+      when ->(_arg) { _arg.respond_to?(:to_list) }
+        arg.to_list
+      when ->(_arg) { _arg.respond_to?(:to_ary) }
+        arg.to_ary.each_with_object(List.new) { |n, l| l.push(Node(n)) }
+      else
+        List.new.push(Node(arg))
+      end
+    end
+  end
+end

data/lib/linked-list/list.rb

@@ -0,0 +1,176 @@
+module LinkedList
+  class List
+    include Conversions
+
+    attr_reader  :length
+    alias_method :size, :length
+
+    def initialize
+      @head   = nil
+      @tail   = nil
+      @length = 0
+    end
+
+    # Returns the first element of the list or nil.
+    #
+    def first
+      @head && @head.data
+    end
+
+    # Returns the last element of the list or nil.
+    #
+    def last
+      @tail && @tail.data
+    end
+
+    # Pushes new nodes to the end of the list.
+    #
+    # == Parameters:
+    # node:: Any object, including +Node+ objects.
+    #
+    # == Returns:
+    # self of +List+ object.
+    #
+    def push(node)
+      node = Node(node)
+      @head ||= node
+
+      @tail.next = node if @tail
+      @tail = node
+
+      @length += 1
+      self
+    end
+    alias_method :<<, :push
+
+    # Pushes new nodes on top of the list.
+    #
+    # == Parameters:
+    # node:: Any object, including +Node+ objects.
+    #
+    # == Returns:
+    # self of +List+ object.
+    #
+    def unshift(node)
+      node = Node(node)
+      @tail ||= node
+
+      node.next = @head
+      @head = node
+
+      @length += 1
+      self
+    end
+
+    # Removes node from the end of the list.
+    #
+    # == Returns:
+    # Data stored in the node or nil.
+    #
+    def pop
+      return nil unless @head
+
+      node = @head
+      next_to_tail = nil
+      while(node = node.next)
+        next_to_tail = node unless node.next
+      end
+      @head = nil unless next_to_tail
+
+      tail = @tail
+      @tail = next_to_tail
+
+      @length -= 1
+      tail.data
+    end
+
+    # Removes node from the beginning of the list.
+    #
+    # == Returns:
+    # Data stored in the node or nil.
+    #
+    def shift
+      return nil unless @head
+
+      head = __shift
+      @tail = nil unless @head
+
+      @length -= 1
+      head.data
+    end
+
+    # Reverse list of nodes and returns new instance of the list.
+    #
+    # == Returns:
+    # New +List+ in reverse order.
+    #
+    def reverse
+      List(to_a).reverse!
+    end
+
+    # Reverses list of nodes in place.
+    #
+    # == Returns:
+    # self in reverse order.
+    #
+    def reverse!
+      return self unless @head
+
+      prev_node = __shift
+      prev_node.next = nil
+      @tail = prev_node
+
+      while(@head)
+        curr_node = __shift
+        curr_node.next = prev_node
+        prev_node = curr_node
+      end
+      @head = prev_node
+      self
+    end
+
+    # Iterates over nodes from top to bottom passing node data to the block if
+    # given. If no block given, returns +Enumerator+.
+    #
+    # == Returns:
+    # +Enumerator+ or yields data to the block stored in every node on the
+    # list.
+    #
+    def each
+      return to_enum(__callee__) unless block_given?
+      __each { |e| yield(e.data) }
+    end
+
+    # Converts list to array.
+    #
+    def to_a
+      each.to_a
+    end
+    alias_method :to_ary, :to_a
+
+    # Conversion function, see +Conversions.List+.
+    #
+    # == Returns:
+    # self
+    #
+    def to_list
+      self
+    end
+
+    private
+
+    def __shift
+      head = @head
+      @head = @head.next
+      head
+    end
+
+    def __each
+      next_node = @head
+      while(next_node)
+        yield next_node
+        next_node = next_node.next
+      end
+    end
+  end
+end

data/lib/linked-list/node.rb

@@ -0,0 +1,19 @@
+module LinkedList
+  class Node
+    attr_accessor :data, :next
+
+    def initialize(data)
+      @data = data
+      @next = nil
+    end
+
+    # Conversion function, see +Conversions.Node+.
+    #
+    # == Returns:
+    # self
+    #
+    def to_node
+      self
+    end
+  end
+end

data/lib/linked-list/version.rb

@@ -0,0 +1,5 @@
+module Linked
+  module List
+    VERSION = '0.0.7'
+  end
+end

data/linked-list.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'linked-list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'linked-list'
+  spec.version       = Linked::List::VERSION
+  spec.authors       = ['Yury Velikanau']
+  spec.email         = ['yury.velikanau@gmail.com']
+  spec.description   = %q{Ruby implementation of Linked List, following some Ruby idioms.}
+  spec.summary       = %q{Ruby implementation of Linked List, following some Ruby idioms.}
+  spec.homepage      = 'https://github.com/spectator/linked-list'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler',  '>= 1.3', '<= 2.0'
+  spec.add_development_dependency 'minitest', '>= 5.0', '<= 6.0'
+end

data/test/conversions_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+describe LinkedList::Conversions do
+  describe 'Node()' do
+    it 'returns self if node is given' do
+      node = create_node('foo')
+      assert_equal LinkedList::Conversions.Node(node), node
+    end
+
+    it 'returns new node' do
+      assert_instance_of LinkedList::Node,
+        LinkedList::Conversions.Node('foo')
+    end
+  end
+
+  describe 'List()' do
+    it 'returns self if list is given' do
+      list = create_list
+      assert_equal LinkedList::Conversions.List(list), list
+    end
+
+    it 'returns list with nodes made from array' do
+      list = LinkedList::Conversions.List([1, 2])
+      assert_equal [1, 2], [list.first, list.last]
+    end
+
+    it 'returns new list with one node' do
+      list = LinkedList::Conversions.List('foo')
+      assert_equal 'foo', list.first
+    end
+  end
+end

data/test/list_test.rb

@@ -0,0 +1,203 @@
+require 'test_helper'
+
+describe LinkedList::List do
+  let(:list)   { create_list }
+  let(:node_1) { create_node('foo') }
+  let(:node_2) { create_node('bar') }
+
+  describe 'instantiation' do
+    it 'assigns first to nil' do
+      assert_nil list.first
+    end
+
+    it 'assigns last to nil' do
+      assert_nil list.last
+    end
+
+    it 'has zero length' do
+      assert_equal 0, list.length
+    end
+  end
+
+  describe '#push' do
+    it 'last pushed node can be accessed with #last' do
+      list.push(node_1)
+      assert_equal node_1.data, list.last
+    end
+
+    it 'last pushed node data can be accessed with #first' do
+      list.push(node_1)
+      assert_equal node_1.data, list.first
+    end
+
+    it 'maintains first pushed node as first' do
+      list.push(node_1)
+      list.push(node_2)
+      assert_equal node_1.data, list.first
+    end
+
+    it 'sets reference to the next node' do
+      list.push(node_1)
+      list.push(node_2)
+      assert_equal node_1.next, node_2
+    end
+
+    it 'increases list length by 1' do
+      list.push(node_1)
+      assert_equal 1, list.length
+    end
+
+    it 'returns self' do
+      assert_equal list.push(node_1), list
+    end
+  end
+
+  describe '#unshift' do
+    it 'last pushed node can be accessed with #last' do
+      list.unshift(node_1)
+      assert_equal node_1.data, list.last
+    end
+
+    it 'last pushed node can be accessed with #first' do
+      list.unshift(node_1)
+      assert_equal node_1.data, list.first
+    end
+
+    it 'maintains first pushed node as last' do
+      list.unshift(node_1)
+      list.unshift(node_2)
+      assert_equal node_1.data, list.last
+    end
+
+    it 'sets reference to the next node' do
+      list.unshift(node_1)
+      list.unshift(node_2)
+      assert_equal node_2.next, node_1
+    end
+
+    it 'increases list length by 1' do
+      list.unshift(node_1)
+      assert_equal 1, list.length
+    end
+
+    it 'returns self' do
+      assert_equal list.unshift(node_1), list
+    end
+  end
+
+  describe '#pop' do
+    it 'returns nil if list is empty' do
+      assert_nil list.pop
+    end
+
+    it 'returns node from the end of the list' do
+      list.push(node_1)
+      list.push(node_2)
+      assert_equal node_2.data, list.pop
+    end
+
+    it 'sets #last to nil when all nodes are removed' do
+      list.push(node_1)
+      list.pop
+      assert_nil list.last
+    end
+
+    it 'sets #first to nil when all nodes are removed' do
+      list.push(node_1)
+      list.pop
+      assert_nil list.first
+    end
+
+    it 'reduces list length by 1' do
+      list.push(node_1)
+      list.pop
+      assert_equal 0, list.length
+    end
+  end
+
+  describe '#shift' do
+    it 'returns nil if list is empty' do
+      assert_nil list.shift
+    end
+
+    it 'returns node from the top of the list' do
+      list.push(node_1)
+      list.push(node_2)
+      assert_equal node_1.data, list.shift
+    end
+
+    it 'sets #last to nil when all nodes are removed' do
+      list.push(node_1)
+      list.shift
+      assert_nil list.last
+    end
+
+    it 'sets #first to nil when all nodes are removed' do
+      list.push(node_1)
+      list.shift
+      assert_nil list.first
+    end
+
+    it 'reduces list length by 1' do
+      list.push(node_1)
+      list.shift
+      assert_equal 0, list.length
+    end
+  end
+
+  describe '#reverse' do
+    it 'returns new empty list when receiver list is empty' do
+      refute_equal list, list.reverse
+    end
+
+    it 'returns new list in reverse order' do
+      list.push(node_1)
+      refute_equal list.reverse, list.reverse!
+    end
+
+    it 'reverses order of nodes' do
+      list.push(node_1)
+      list.push(node_2)
+      new_list = list.reverse
+      assert_equal %w(bar foo), [new_list.first, new_list.last]
+    end
+  end
+
+  describe '#reverse!' do
+    it 'returns self when list is empty' do
+      assert_equal list, list.reverse!
+    end
+
+    it 'reverses order of nodes' do
+      list.push(node_1)
+      list.push(node_2)
+      list.reverse!
+      assert_equal [node_2.data, node_1.data], [list.first, list.last]
+    end
+
+    it 'returns same object' do
+      list.push(node_1)
+      assert_equal list, list.reverse!
+    end
+  end
+
+  describe '#each' do
+    it 'returns enumerator if no block given' do
+      assert_instance_of Enumerator, list.each
+    end
+
+    it 'pass each node data to the block' do
+      list.push(node_1)
+      list.push(node_2)
+      nodes = []
+      list.each { |e| nodes << e }
+      assert_equal %w(foo bar), nodes
+    end
+  end
+
+  describe 'conversion' do
+    it '#to_list returns self' do
+      assert_equal list, list.to_list
+    end
+  end
+end

data/test/node_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+describe LinkedList::Node do
+  let(:node) { create_node('foo') }
+
+  describe 'instantiation' do
+    it 'assigns data' do
+      assert_equal 'foo', node.data
+    end
+
+    it 'assigns nil to next' do
+      assert_nil node.next
+    end
+  end
+
+  describe 'accessors' do
+    it '#data' do
+      node.data = 'bar'
+      assert_equal 'bar', node.data
+    end
+
+    it '#next' do
+      node.next = 'bar'
+      assert_equal 'bar', node.next
+    end
+  end
+
+  describe 'conversion' do
+    it '#to_node returns self' do
+      assert_equal node, node.to_node
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'linked-list'
+
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+class Minitest::Spec
+  def create_node(*args)
+    LinkedList::Node.new(*args)
+  end
+
+  def create_list(*args)
+    LinkedList::List.new(*args)
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: linked-list
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Yury Velikanau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Ruby implementation of Linked List, following some Ruby idioms.
+email:
+- yury.velikanau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/linked-list.rb
+- lib/linked-list/conversions.rb
+- lib/linked-list/list.rb
+- lib/linked-list/node.rb
+- lib/linked-list/version.rb
+- linked-list.gemspec
+- test/conversions_test.rb
+- test/list_test.rb
+- test/node_test.rb
+- test/test_helper.rb
+homepage: https://github.com/spectator/linked-list
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of Linked List, following some Ruby idioms.
+test_files:
+- test/conversions_test.rb
+- test/list_test.rb
+- test/node_test.rb
+- test/test_helper.rb
+has_rdoc: