natural_sort 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4eaf8c2b84481c81c04561961d96b2ae8691c06a
+  data.tar.gz: cf25e73d6eeb71dc9e1072c724ea814dd524e277
+SHA512:
+  metadata.gz: 8b0d846ad70d7bcafe66a32eda7f8b4be406288967ce34493eadc0591271ba8af1e9200caa9b3be0d7ebdf614693716b74baec7c9f7b3fefc989fcb307e64ccc
+  data.tar.gz: 7a48ce33aca18bbd35e3cc86d99156cc6af615200719f975ced0557fc8da5fe99283d66035318f3c4e23eff7281c61d0f7cae05084de1b4d11656d4006f6ce6e

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Pavel Pravosud
+
+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,76 @@
+# Natural Sort
+
+Natual sorting implementation in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "natural_sort"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install natural_sort
+
+## Usage
+
+```ruby
+require "natual_sort"
+
+list = ["a10", "a", "a20", "a1b", "a1a", "a2", "a0", "a1"]
+list.sort(&NatualSort) # => ["a", "a0", "a1", "a1a", "a1b", "a2", "a10", "a20"]
+```
+
+```ruby
+UbuntuRelease = Struct.new(:number, :name)
+
+ubuntu_releases = [
+  UbuntuRelease.new("9.04", "Jaunty Jackalope"),
+  UbuntuRelease.new("10.10", "Maverick Meerkat"),
+  UbuntuRelease.new("8.10", "Intrepid Ibex"),
+  UbuntuRelease.new("10.04.4", "Lucid Lynx"),
+  UbuntuRelease.new("9.10", "Karmic Koala"),
+]
+
+ubuntu_releases.sort_by { |v| NaturalSort(v.number) }
+# => [
+#   UbuntuRelease.new("8.10", "Intrepid Ibex"),
+#   UbuntuRelease.new("9.04", "Jaunty Jackalope"),
+#   UbuntuRelease.new("9.10", "Karmic Koala"),
+#   UbuntuRelease.new("10.04.4", "Lucid Lynx"),
+#   UbuntuRelease.new("10.10", "Maverick Meerkat")
+# ]
+```
+
+## Refinements
+
+If you're running ruby 2.1 or newer, you can use refinements.
+
+```ruby
+require "natural_sort/refinments"
+
+class MyClass
+  using NatualSort
+
+  list.natural_sort                        # => ["a", "a0", "a1", "a1a"...
+  ubuntu_releases.natual_sort_by(&:number) # => [ UbuntuRelease.new("8.10"...
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rwz/natural_sort.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

data/lib/natural_sort.rb

@@ -0,0 +1,24 @@
+require "natural_sort/version"
+
+module NaturalSort
+  module_function
+
+  autoload :Segment,         "natural_sort/segment"
+  autoload :SegmentedString, "natural_sort/segmented_string"
+
+  def to_proc
+    lambda(&method(:compare))
+  end
+
+  def sort(input)
+    input.sort(&self)
+  end
+
+  def compare(a, b)
+    SegmentedString.new(a) <=> SegmentedString.new(b)
+  end
+end
+
+def NaturalSort(input)
+  NaturalSort::SegmentedString.new(input)
+end

data/lib/natural_sort/refinements.rb

@@ -0,0 +1,17 @@
+require "set"
+
+module NaturalSort
+  [Array, Hash, Set].each do |klass|
+    refine klass do
+      def natural_sort
+        to_a.sort(&NaturalSort)
+      end
+
+      def natural_sort_by
+        to_a.sort_by do |element|
+          NaturalSort(yield(element))
+        end
+      end
+    end
+  end
+end

data/lib/natural_sort/segment.rb

@@ -0,0 +1,36 @@
+module NaturalSort
+  class Segment
+    include Comparable
+
+    NUMERIC = /\A\d+(?:\.\d+)?\z/
+    private_constant :NUMERIC
+
+    attr_reader :input
+
+    def initialize(input)
+      @input = input.to_s
+    end
+
+    def to_s
+      @input
+    end
+
+    def <=>(other)
+      if numeric? && other.numeric?
+        Rational(input) <=> Rational(other.to_s)
+      else
+        compare_chars(input, other.to_s)
+      end
+    end
+
+    def numeric?
+      NUMERIC === input
+    end
+
+    private
+
+    def compare_chars(a, b)
+      a == b.swapcase ? a <=> b : a.downcase <=> b.downcase
+    end
+  end
+end

data/lib/natural_sort/segmented_string.rb

@@ -0,0 +1,43 @@
+module NaturalSort
+  class SegmentedString
+    include Comparable
+
+    TOKENIZER = /\d+(?:\.\d+)?|\D/
+    private_constant :TOKENIZER
+
+    attr_reader :input
+
+    def initialize(input)
+      @input = input.to_s
+    end
+
+    def segments
+      @segments ||= tokens.map { |token| Segment.new(token) }
+    end
+
+    def <=>(other)
+      raise ArgumentError unless SegmentedString === other
+
+      other_segments = other.segments
+
+      segments.each_with_index do |segment, index|
+        other_segment = other_segments[index]
+        return 1 if other_segment.nil?
+        result = compare_segments(segment, other_segment)
+        return result unless result.zero?
+      end
+
+      other_segments.length > segments.length ? -1 : 0
+    end
+
+    private
+
+    def tokens
+      @tokens ||= input.scan(TOKENIZER)
+    end
+
+    def compare_segments(segment, other)
+      segment <=> other
+    end
+  end
+end

data/lib/natural_sort/version.rb

@@ -0,0 +1,3 @@
+module NaturalSort
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: natural_sort
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Pravosud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-03 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- pavel@pravosud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/natural_sort.rb
+- lib/natural_sort/refinements.rb
+- lib/natural_sort/segment.rb
+- lib/natural_sort/segmented_string.rb
+- lib/natural_sort/version.rb
+homepage: https://github.com/rwz/natural_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.5.1
+signing_key: 
+specification_version: 4
+summary: Natural sorting support for Ruby
+test_files: []