naturalsort 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0 / 2007-12-14
+
+* Project creation

data/Manifest.txt

@@ -0,0 +1,9 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/natural_sort.rb
+lib/natural_sort_kernel.rb
+test/test_helper.rb
+test/test_natural_sort.rb
+test/test_natural_sort_kernel.rb

data/README.txt

@@ -0,0 +1,79 @@
+NaturalSort
+* Rubyforge Project http://rubyforge.org/projects/naturalsort
+* by Benjamin Francisoud http://benjamin.francisoud.googlepages.com
+
+== Description:
+  
+NaturalSort is a small and simple library to implements a natural or human alphabetical sort in ruby.
+
+Examples: 
+  ['a1', 'a11', 'a12', 'a2', 'a21'] => ['a1', 'a2', 'a11', 'a12','a21']
+  ['a', 'b', 'c', 'A', 'B', 'C']    => ['A', 'a', 'B', 'b', 'C', 'c']
+  ['x__2', 'x_1']                   => ['x_1', 'x__2']
+
+== Features:
+  
+* sort case insensitive
+* sort filename matching pattern "abc1", "abc12", "abc2" in the correct order
+* sort underscore insensitive
+
+== Synopsis:
+
+=== Usage N�1 - Add to your ruby default objects
+Add natural sort methods to ruby default object (Array, Hash, etc...)
+
+  require 'natural_sort_kernel'
+  
+  sorted = ['a', 'b', 'c', 'd', 'A', 'B', 'C', 'D'].alphanum_sort
+  sorted = ['a', 'b', 'c', 'd', 'A', 'B', 'C', 'D'].alpha_sort
+  sorted = ['a', 'b', 'c', 'd', 'A', 'B', 'C', 'D'].natural_sort
+  sorted = ['a', 'b', 'c', 'd', 'A', 'B', 'C', 'D'].sort_natural
+  ...
+Pick your favorite method name: NaturalSort
+
+=== Usage N�2  - Use only one method
+
+  require 'natural_sort'
+  
+  sorted = NaturalSort::naturalsort ['a', 'b', 'c', 'd', 'A', 'B', 'C', 'D']
+
+== Install:
+
+* sudo gem install natural_sort
+
+== Related Links
+
+Links related to the alphabetical sorting problem:
+* http://www.codinghorror.com/blog/archives/001018.html
+* http://sourcefrog.net/projects/natsort/
+* http://be2.php.net/natsort
+* http://www.wellho.net/forum/Programming-in-Python-and-Ruby/Python-Sort-Order.html
+* http://www.davekoelle.com/alphanum.html
+* http://rikkus.info/arch/sensible_sort.rb
+* http://weblog.masukomi.org/2007/12/10/alphabetical-asciibetical
+* http://nedbatchelder.com/blog/200712.html
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2007 Benjamin Francisoud
+
+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/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/natural_sort.rb'
+
+Hoe.new('naturalsort', NaturalSort::VERSION) do |p|
+  p.rubyforge_name = 'naturalsort'
+  p.author = 'Benjamin Francisoud'
+  p.email = 'pub.cog@gmail.com'
+  p.summary = 'NaturalSort is a small and simple library to implements a natural or human friendly alphabetical sort in ruby.'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = '' # Release to root
+  p.need_zip = true
+end
+
+# vim: syntax=Ruby

data/lib/natural_sort.rb

@@ -0,0 +1,73 @@
+# Sort elements in a natural / alphabetical / human friendly order.
+#     require 'natural_sort'
+#     
+#     NaturalSort::naturalsort ['a1', 'a12', 'a2']   #=> ['a1', 'a2', 'a12']
+# or
+#     require 'natural_sort_kernel'
+#     
+#     ['a', 'b', 'A', 'B'].natural_sort              #=> ['A', 'a', 'B', 'b']
+module NaturalSort
+  VERSION = '1.0.0'
+  
+  # call-seq:
+  #    NaturalSort::naturalsort(object)                     => array
+  # 
+  # Static method to sort.
+  # 
+  # *Usage*
+  #     naturalsort ['a1', 'a12', 'a2']         #=> ['a1', 'a2', 'a12']
+  # 
+  # <tt>object</tt> can by any object that has to_a and sort methods.
+  def self.naturalsort(object)
+    object.natural_sort
+  end
+  
+  # call-seq:
+  #    object.natural_sort                     => array
+  # 
+  # Main method to sort (other are just aliases).
+  # 
+  # *Usage*
+  #     require 'natural_sort'
+  #     include NaturalSort
+  #     
+  #     object.natural_sort         #=> ['a1', 'a2', 'a12']
+  # 
+  # <tt>object</tt> can by any object that has a method <tt>to_a</tt>
+  # 
+  # See <tt>natural_sort_kernel.rb</tt> to add natural sort methods to default ruby objects.
+  # Enumerable , Array, Range, Set, Hash
+  def natural_sort
+    sorted = to_a.sort do |a,b|
+      sa, sb = a.to_s, b.to_s
+      if ((sa.downcase <=> sb.downcase) == 0)
+        sa <=> sb
+      else
+        regexp = /(\D+)(\d+)/
+        ma, mb = regexp.match(sa), regexp.match(sb)
+        if (ma and mb)
+          l = [sa.size,sb.size].max
+          na, nb = format(ma, l), format(mb, l)
+          na <=> nb
+        else
+          sa.downcase <=> sb.downcase
+        end
+      end
+    end
+  end
+  
+  alias sort_natural natural_sort
+  alias sort_alpha natural_sort
+  alias alpha_sort natural_sort
+  alias sort_alphabetical natural_sort
+  alias alphabetical_sort natural_sort
+  alias sort_alphanum natural_sort
+  alias alphanum_sort natural_sort
+  
+  private
+  # format([a, 1], 3) => a001
+  # add leading zero
+  def format(match_data, length)
+    match_data[1].gsub("_", "").downcase + ("%0#{length}d" % match_data[2])
+  end
+end

data/lib/natural_sort_kernel.rb

@@ -0,0 +1,47 @@
+# Add natural sorting method to default Kernel ruby objects.
+require File.dirname(__FILE__) + '/natural_sort.rb'
+require 'set'
+
+# Add NaturalSort methods.
+#     require 'natural_sort_kernel'
+#     
+#     ['a1', 'a12', 'a2'].alphanum_sort         #=> ['a1', 'a2', 'a12']
+#     ['a', 'b', 'A', 'B'].alphanum_sort        #=> ['A', 'a', 'B', 'b']
+module Enumerable
+  include NaturalSort
+end
+
+# Add NaturalSort methods.
+#     require 'natural_sort_kernel'
+#     
+#     ['a1', 'a12', 'a2'].alphanum_sort         #=> ['a1', 'a2', 'a12']
+#     ['a', 'b', 'A', 'B'].alphanum_sort        #=> ['A', 'a', 'B', 'b']
+class Array
+  include NaturalSort
+end
+
+# Add NaturalSort methods.
+#     require 'natural_sort_kernel'
+#     
+#     (1..21).alphanum_sort         #=> [1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 3, 4, 5, 6, 7, 8, 9]
+class Range
+  include NaturalSort
+end
+
+# Add NaturalSort methods.
+#     require 'set'
+#     require 'natural_sort_kernel'
+#     
+  #     Set.new(['a', 'b', 'c', 'd', 'A', 'B', 'C', 'D']).alphanum_sort         #=> ['A', 'a', 'B', 'b', 'C', 'c', 'D', 'd']
+class Set
+  include NaturalSort
+end
+
+# Add NaturalSort methods.
+#     require 'natural_sort_kernel'
+#     
+#     { "a" => "value", "b" => "value", "c" => "value", "d" => "value", "A" => "value", "B" => "value", "C" => "value", "D" => "value" }.alphanum_sort
+#     => [["A", "value"], ["a", "value"], ["B", "value"], ["b", "value"], ["C", "value"], ["c", "value"], ["D", "value"], ["d", "value"]]
+class Hash
+  include NaturalSort
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+
+module NaturalSort
+  Base = ['a', 'b', 'c', 'd', 'A', 'B', 'C', 'D']
+  BaseSorted = ['A', 'a', 'B', 'b', 'C', 'c', 'D', 'd']
+end

data/test/test_natural_sort.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require File.dirname(__FILE__) + '/../lib/natural_sort.rb'
+
+class MyClass
+  include NaturalSort
+  
+  def initialize(array = Base)
+    @array = array
+  end
+  
+  def to_a
+    @array
+  end
+end
+
+# Test without include
+class TestNaturalSortSelf < Test::Unit::TestCase
+  def test_self
+    assert_equal NaturalSort::BaseSorted, NaturalSort::naturalsort(NaturalSort::Base)
+  end
+end
+
+# Test using include
+class TestNaturalSort < Test::Unit::TestCase
+  include NaturalSort
+  
+  def setup
+    @obj = MyClass.new
+  end
+  
+  def test_alias
+    assert_equal BaseSorted, (@obj.sort_natural)
+    assert_equal BaseSorted, (@obj.sort_alpha)
+    assert_equal BaseSorted, (@obj.alpha_sort)
+    assert_equal BaseSorted, (@obj.sort_alphabetical)
+    assert_equal BaseSorted, (@obj.alphabetical_sort)
+  end
+  
+  def test_case_sensitive
+    sorted = @obj.natural_sort
+    assert_equal BaseSorted, sorted
+  end
+  
+  def test_mixed
+    obj = MyClass.new ['a1', 'a12', 'A11', 'a2', 'a10', 'A3', 'a21', 'A29']
+    assert_equal ['a1', 'a2', 'A3', 'a10', 'A11', 'a12', 'a21', 'A29'], obj.natural_sort
+  end
+  
+  def test_numbers
+    obj = MyClass.new ['a1', 'a12', 'a11', 'a2', 'a10', 'a3', 'a21', 'a29']
+    assert_equal ['a1', 'a2', 'a3', 'a10', 'a11', 'a12', 'a21', 'a29'], obj.natural_sort
+  end
+end

data/test/test_natural_sort_kernel.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require File.dirname(__FILE__) + '/../lib/natural_sort_kernel.rb'
+
+class TestEnum
+  include Enumerable
+  def to_a
+    NaturalSort::Base
+  end
+end
+
+class TestNaturalSortKernel < Test::Unit::TestCase
+  
+  def test_empty
+    assert_equal(['', ''], ['', ''].natural_sort)
+  end
+  
+  def test_enum
+    enum = TestEnum.new
+    assert_equal NaturalSort::BaseSorted, enum.alphanum_sort
+  end
+  
+  def test_array
+    assert_equal NaturalSort::BaseSorted, NaturalSort::Base.alphanum_sort
+    assert_equal NaturalSort::BaseSorted, NaturalSort::Base.alpha_sort
+    assert_equal NaturalSort::BaseSorted, NaturalSort::Base.sort_natural
+  end
+  
+  def test_range
+    expected = [1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 3, 4, 5, 6, 7, 8, 9]
+    assert_equal expected, (1..21).alphanum_sort
+  end
+  
+  def test_set
+    set = Set.new NaturalSort::Base
+    assert_equal NaturalSort::BaseSorted, set.alphanum_sort
+  end
+  
+  def test_hash
+    expected = [["A", "value"], ["a", "value"], ["B", "value"], ["b", "value"],
+                ["C", "value"], ["c", "value"], ["D", "value"], ["d", "value"]]
+    hash = { "a" => "value", "b" => "value", "c" => "value", "d" => "value", "A" => "value", "B" => "value", "C" => "value", "D" => "value" }
+    assert_equal expected, hash.alphanum_sort
+  end
+  
+    def test_identical_simple
+      assert_equal(['x', 'x'], ['x', 'x'].natural_sort)
+    end
+
+    def test_identical_two_groups
+      assert_equal(['x1', 'x1'], ['x1', 'x1'].natural_sort)
+    end
+
+    def test_ordered_simple
+      assert_equal(['x', 'y'], ['x', 'y'].natural_sort)
+    end
+
+    def test_ordered_simple_start_backwards
+      assert_equal(['x', 'y'], ['y', 'x'].natural_sort)
+    end
+
+    def test_ordered_two_groups
+      assert_equal(['x1', 'x2'], ['x1', 'x2'].natural_sort)
+    end
+
+    def test_ordered_two_groups_start_backwards
+      assert_equal(['x1', 'x2'], ['x2', 'x1'].natural_sort)
+    end
+
+    def test_ordered_two_groups_separated
+      assert_equal(['x_1', 'x_2'], ['x_2', 'x_1'].natural_sort)
+    end
+
+    def test_ordered_two_groups_separated_different_distances
+      assert_equal(['x_1', 'x__2'], ['x__2', 'x_1'].natural_sort)
+    end
+
+    def test_ordered_two_groups_separated_different_distances_swapped
+      assert_equal(['x__1', 'x_2'], ['x_2', 'x__1'].natural_sort)
+    end
+
+    def test_three_groups
+      assert_equal(
+        ['hello 2 world', 'hello world', 'hello world 2'],
+        ['hello world', 'hello world 2', 'hello 2 world'].natural_sort
+      )
+    end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: naturalsort
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-12-17 00:00:00 +01:00
+summary: NaturalSort is a small and simple library to implements a natural or human friendly alphabetical sort in ruby.
+require_paths: 
+- lib
+email: pub.cog@gmail.com
+homepage: "* Rubyforge Project http://rubyforge.org/projects/naturalsort"
+rubyforge_project: naturalsort
+description: "Examples:  ['a1', 'a11', 'a12', 'a2', 'a21'] => ['a1', 'a2', 'a11', 'a12','a21'] ['a', 'b', 'c', 'A', 'B', 'C']    => ['A', 'a', 'B', 'b', 'C', 'c'] ['x__2', 'x_1']                   => ['x_1', 'x__2']  == Features:  * sort case insensitive * sort filename matching pattern \"abc1\", \"abc12\", \"abc2\" in the correct order * sort underscore insensitive  == Synopsis:  === Usage N\xB01 - Add to your ruby default objects Add natural sort methods to ruby default object (Array, Hash, etc...)"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Benjamin Francisoud
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/natural_sort.rb
+- lib/natural_sort_kernel.rb
+- test/test_helper.rb
+- test/test_natural_sort.rb
+- test/test_natural_sort_kernel.rb
+test_files: 
+- test/test_helper.rb
+- test/test_natural_sort.rb
+- test/test_natural_sort_kernel.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: