array-sort 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19712ae85993b11b3c6aa80b1b12557b3fe44081c736588fdb95491c888f9465
+  data.tar.gz: 52adc3ab55c79a36af340b7ba0276a3ea31a759f6e93224dc3496d8c13d34d4e
+SHA512:
+  metadata.gz: 2f001fcef739c8843ea6b6d66813123d5c51c8c8ba2bc9d7ba633859914270671701087cc93a85ec7a7591582eab0d7e757c1be3a1d3a77fc14ea183dd56174e
+  data.tar.gz: 64cafd15ee8abe2385debadd6f95659e2a7b35a8f7dfd9c61799ba1532baa62f24775089d505937ef36e4277be1c404135cee88cb4d55cef2624c003e9a307fc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Style/Documentation:
+  Enabled: false
+
+#Naming/FileName:
+#  Enabled: true
+
+Metrics/LineLength:
+  Max: 120
+
+Layout/TrailingWhitespace:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in array-sort.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    array-sort (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  array-sort!
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 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,69 @@
+# ArraySort
+
+ArraySort adds methods in the Ruby `Array` class that provides sorting methods using a few sorting algorithms.
+
+Currently, the following sorting algorithms are implemented:
+ * Bubble sort _(stable)_
+ * Heap sort _(unstable)_
+ * Insertion sort _(stable)_
+ * Merge sort _(stable)_
+ * Quicksort _(unstable)_
+
+Note that this gem does not overwrite `Array#sort`, `Array#sort!`, `Array#sort_by`, `Array#sort_by!`. Calling those
+methods will invoke the native sorting methods, which uses in-place quicksort algorithm and is unstable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'array-sort'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install array-sort
+
+## Usage
+
+All sort methods share the same signature of `Array#sort`, `Array#sort!`, `Array#sort_by` and `Array#sort_by!`. Simply
+change the names of the sorting methods to the following corresponding methods of a specific sorting algorithm:
+
+ * Bubble sort: `bubble_sort`, `bubble_sort!`, `bubble_sort_by`, `bubble_sort_by!`
+ * Heap sort: `heap_sort`, `heap_sort!`, `heap_sort_by`, `heap_sort_by!`
+ * Insertion sort: `insertion_sort`, `insertion_sort!`, `insertion_sort_by`, `insertion_sort_by!`
+ * Merge sort: `merge_sort`, `merge_sort!`, `merge_sort_by`, `merge_sort_by!`
+ * Quicksort: `quick_sort`, `quick_sort!`, `quick_sort_by`, `quick_sort_by!`
+ 
+See the official [Ruby documentation](https://ruby-doc.org/core-2.5.0/Array.html#method-i-sort) on how to use the native
+sorting methods of `Array`.
+
+For example, to sort an array using insertion sort:
+
+```ruby
+[3, 1, 2].insertion_sort # => [1, 2, 3]
+
+# The following two lines both produce [[1, 4], [2, 6], [3, 3]]
+[[3, 3], [1, 4], [2, 6]].insertion_sort { |a, b| a[0] <=> b[0] }
+[[3, 3], [1, 4], [2, 6]].insertion_sort_by { |e| e[0] }
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+[https://github.com/foxhatleo/array-sort](https://github.com/foxhatleo/array-sort). This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,10 @@
+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
+
+task :default => :test

data/array-sort.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'array/sort/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'array-sort'
+  spec.version       = ArraySort::VERSION
+  spec.authors       = ['Leo Liang']
+  spec.email         = ['developer@leoliang.com']
+
+  spec.summary       = 'Implementations of different sorting algorithms for Arrays.'
+  spec.description   = 'Implements sorting algorithms such as merge sort, bubble sort, insertion sort, etc. for Arrays.'
+  spec.homepage      = 'https://github.com/foxhatleo/array-sort'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'TODO: Set to \'http://mygemserver.com\''
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "array/sort"
+
+# 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/lib/array/sort.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'array/sort/version'
+require 'array/sort/helper'
+require 'array/sort/merge_sort'
+require 'array/sort/insertion_sort'
+require 'array/sort/heap_sort'
+require 'array/sort/bubble_sort'
+require 'array/sort/quick_sort'

data/lib/array/sort/bubble_sort.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class Array
+  def bubble_sort(&block)
+    dup.bubble_sort!(&block)
+  end
+
+  def bubble_sort!(&block)
+    return self if length <= 1
+    n = length
+    loop do
+      new_n = bubble_sort_check(n, &block)
+      n = new_n
+      break if n.zero?
+    end
+    self
+  end
+
+  def bubble_sort_by(&block)
+    if block_given?
+      dup.bubble_sort_by!(&block)
+    else
+      to_enum :bubble_sort_by
+    end
+  end
+
+  def bubble_sort_by!(&_block)
+    if block_given?
+      bubble_sort! do |a, b|
+        yield(a) <=> yield(b)
+      end
+    else
+      to_enum :bubble_sort_by!
+    end
+  end
+
+  private
+
+  def bubble_sort_check(length_checking, &block)
+    new_n = 0
+    (1...length_checking).each do |i|
+      next unless sort_compare(self[i - 1], self[i], &block).positive?
+      swap i - 1, i
+      new_n = i
+    end
+    new_n
+  end
+end

data/lib/array/sort/heap_sort.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+class Array
+  def heap_sort(&block)
+    dup.heap_sort!(&block)
+  end
+
+  def heap_sort!(&block)
+    return self if length <= 1
+    heapify(&block)
+    (length - 1).downto(1) do |end_|
+      swap(end_, 0)
+      sift_down(0, end_ - 1, &block)
+    end
+    self
+  end
+
+  def heap_sort_by(&block)
+    if block_given?
+      dup.heap_sort_by!(&block)
+    else
+      to_enum :heap_sort_by
+    end
+  end
+
+  def heap_sort_by!(&_block)
+    if block_given?
+      heap_sort! do |a, b|
+        yield(a) <=> yield(b)
+      end
+    else
+      to_enum :heap_sort_by!
+    end
+  end
+
+  private
+
+  def heapify(&block)
+    end_ = length - 1
+    (length / 2 - 1).downto(0) do |start|
+      sift_down(start, end_, &block)
+    end
+  end
+
+  def sift_down(start, end_, &block)
+    root = start
+    loop do
+      child = root * 2 + 1
+      break if child > end_
+      child += 1 if check_less_than_sibling(child, end_, &block)
+      break if check_max_heap_order(root, child, &block)
+      root = child
+    end
+  end
+
+  def check_less_than_sibling(child, end_, &block)
+    child + 1 <= end_ && sort_compare(self[child], self[child + 1], &block) == -1
+  end
+
+  def check_max_heap_order(root, child, &block)
+    return true unless sort_compare(self[root], self[child], &block) == -1
+    swap root, child
+    false
+  end
+end

data/lib/array/sort/helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class Array
+  # Swap two elements in the array, and returns +self+.
+  #
+  # @param index1 [Integer] The index of the first element.
+  # @param index2 [Integer] The index of the second element.
+  # @return [Array]
+  def swap(index1, index2)
+    raise ArgumentError, 'Index must be an integer.' unless index1.is_a?(Integer) && index2.is_a?(Integer)
+    self[index1], self[index2] = self[index2], self[index1] if index1 != index2
+    self
+  end
+
+  private
+
+  # Compare two elements.
+  #
+  # If a block is provided, it will be used to compare the two elements. If not, +<=>+ will be used.
+  def sort_compare(element1, element2, &_block)
+    if block_given?
+      yield element1, element2
+    else
+      element1 <=> element2
+    end
+  end
+
+  # Clear everything in +self+, and add all elements in +target+.
+  def become_clone_of(target)
+    clear
+    concat target
+  end
+end

data/lib/array/sort/insertion_sort.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class Array
+  def insertion_sort(&block)
+    dup.insertion_sort!(&block)
+  end
+
+  def insertion_sort!(&block)
+    return self if length <= 1
+    (1...length).each do |i|
+      i.downto(1) do |j|
+        break unless sort_compare(self[j - 1], self[j], &block) == 1
+        swap(j - 1, j)
+      end
+    end
+    self
+  end
+
+  def insertion_sort_by(&block)
+    if block_given?
+      dup.insertion_sort_by!(&block)
+    else
+      to_enum :insertion_sort_by
+    end
+  end
+
+  def insertion_sort_by!(&_block)
+    if block_given?
+      insertion_sort! do |a, b|
+        yield(a) <=> yield(b)
+      end
+    else
+      to_enum :insertion_sort_by!
+    end
+  end
+end

data/lib/array/sort/merge_sort.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class Array
+  def merge_sort(&block)
+    return dup if length <= 1
+    divided_parts = merge_sort_divide
+    part_a_sorted = divided_parts[0].merge_sort
+    part_b_sorted = divided_parts[1].merge_sort
+    merge_sort_merge part_a_sorted, part_b_sorted, &block
+  end
+
+  def merge_sort!(&block)
+    become_clone_of merge_sort(&block)
+  end
+
+  def merge_sort_by(&_block)
+    if block_given?
+      merge_sort do |a, b|
+        yield(a) <=> yield(b)
+      end
+    else
+      to_enum :merge_sort_by
+    end
+  end
+
+  def merge_sort_by!(&block)
+    if block_given?
+      become_clone_of merge_sort_by(&block)
+    else
+      to_enum :merge_sort_by!
+    end
+  end
+
+  private
+
+  def merge_sort_divide
+    mid = length / 2
+    part_a = self[0, mid]
+    part_b = self[mid..-1]
+    [part_a, part_b]
+  end
+
+  def merge_sort_merge(part_a, part_b, &block)
+    result = []
+    while part_a.length.positive? && part_b.length.positive?
+      result << (sort_compare(part_a.first, part_b.first, &block).positive? ? part_b : part_a).shift
+    end
+    result + part_a + part_b
+  end
+end

data/lib/array/sort/quick_sort.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Array
+  def quick_sort(&block)
+    return dup if length <= 1
+    left, right = self[1..-1].partition { |y| sort_compare(first, y, &block).positive? }
+    left.quick_sort + [first] + right.quick_sort
+  end
+
+  def quick_sort!(&block)
+    become_clone_of quick_sort(&block)
+  end
+
+  def quick_sort_by(&_block)
+    if block_given?
+      quick_sort do |a, b|
+        yield(a) <=> yield(b)
+      end
+    else
+      to_enum :quick_sort_by
+    end
+  end
+
+  def quick_sort_by!(&block)
+    if block_given?
+      become_clone_of quick_sort_by(&block)
+    else
+      to_enum :quick_sort_by!
+    end
+  end
+end

data/lib/array/sort/version.rb

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

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: array-sort
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leo Liang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Implements sorting algorithms such as merge sort, bubble sort, insertion
+  sort, etc. for Arrays.
+email:
+- developer@leoliang.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- array-sort.gemspec
+- bin/console
+- bin/setup
+- lib/array/sort.rb
+- lib/array/sort/bubble_sort.rb
+- lib/array/sort/heap_sort.rb
+- lib/array/sort/helper.rb
+- lib/array/sort/insertion_sort.rb
+- lib/array/sort/merge_sort.rb
+- lib/array/sort/quick_sort.rb
+- lib/array/sort/version.rb
+homepage: https://github.com/foxhatleo/array-sort
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Implementations of different sorting algorithms for Arrays.
+test_files: []