naturalsort 1.1.1 → 1.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzVkY2U1YzA2YjJkMDNjNGNmNGZlMjM4NTBkZGU0MjY0OWMxMzE5OA==
+  data.tar.gz: !binary |-
+    NWQzNzM1ODExZmQ5MDkzYzVkODZlZWQ5N2FiNjhmNDU5N2I2Yjc3Yg==
+SHA512:
+  metadata.gz: !binary |-
+    MDNhMTkyNWRiMGY0MGUwMzA2MDc5Yjg0ZjRmZTUzZWRiMzEzMjcyYmNmYzQ3
+    YWI0MGU1ODYzNDhmOTIzMDc0N2E3YWFlNDZiNDIxMmYyYjI0MTc2YmNjMWU0
+    ZWQzMDMzMjA5YzkxOGI1NmI1YjY4ZTExZDQ3MDg1Mzg4MjU3NzI=
+  data.tar.gz: !binary |-
+    MWFmMmNhZmIxZjY2ZGNhODVkOTZiMzU2Y2I4NGM4NmVmNjM4ZGM5OTQ0ZDY3
+    Zjg1YTZlZmIxMWJjNjM3YTBhMTkxYWUwMzMxOGIzZTg3ZjJjNTdjNzAxYjUy
+    ZWY1MWM4OTExNzFiOTJlMzJhOWQyZDQ3ZTIzYmMwNTgzZTQzZjY=

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+## 1.2.0 - 2013-10-10
+
+* DEPRECATION: deprecate `NaturalSort.naturalsort` and replace with `NaturalSort.sort`
+* Use `Array(object)` instead of `object.to_a` for implicit Array conversion
+* Remove unused private instance methods which were aliased to class methods
+* Make regexp objects as module constants
+* Reorganize directory/require structure to match conventions used in other gems. Core sorting functions are moved to new `NaturalSort::Engine` module.
+* Kernel: Only include into `Set` if Set is defined
+* Kernel: `Range#natural_sort` is now an alias to `Range#to_a`
+* Test: Upgrade to use Minitest gem
+* Test: Improve readability by using `%w()` syntax for arrays
+* Documentation: Convert all code documentation to TomDoc format
+* Admin: Remove rdoc generator which was not working
+* Admin: Add files .gitignore, Gemfile, gemspec, and cleanup Rakefile
+* Admin: Add Travis and CodeClimate
+* Admin: Migrate to Github
+
+## 1.1.1 - 2010-07-21
+
+* Fix typo error in some unit test
+* Remove copy/paste between naturalsort and natural_sort methods
+* Added samples in rdoc
+* Adding contribution from Sobe http://pastie.caboo.se/139803 (thanks mate)
+* Sort complex text list (see test_natural_sort_kernel.rb:107))
+* Fix more complex [string][number] pattern like:
+   ```ruby
+   ["x2-y08", "x2-g8", "x2-y7", "x8-y8"].natural_sort => ["x2-g8", "x2-y7", "x2-y08", "x8-y8"]
+   ["x02-y08", "x02-g8", "x2-y7", "x8-y8"].natural_sort => ["x02-g8", "x2-y7", "x02-y08", "x8-y8"]
+   ```
+* Fix bug in Range ordering:
+   ```ruby
+   (1..21).natural_sort => [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]
+   ```
+
+## 1.1.0 - 2008-01-08
+
+* Improve documentation to get better google results
+* Remove alias methods: `sort_natural`, `sort_alpha`, `alpha_sort`, `sort_alphabetical`, `alphabetical_sort`, `sort_alphanum`, `alphanum_sort`
+
+## 1.0.1 - 2007-12-18
+
+* Fix problem using as a static method
+* Refactoring code
+
+## 1.0.0 - 2007-12-14
+
+* Project creation

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+(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/README.md

@@ -0,0 +1,130 @@
+# NaturalSort
+
+[![Build Status](https://secure.travis-ci.org/johnnyshields/naturalsort.png?branch=master)](http://travis-ci.org/johnnyshields/naturalsort)
+[![Code Climate](https://codeclimate.com/github/johnnyshields/naturalsort.png)](https://codeclimate.com/github/johnnyshields/naturalsort)
+
+NaturalSort is a simple library which implements a natural, human-friendly alphanumeric sort in Ruby.
+
+#### Fork from RubyForge-hosted NaturalSort gem
+
+This Github repo `johnyshields/naturalsort` is an update of the Benjamin Francisoud's original NaturalSort gem,
+hosted on RubyForge at http://rubyforge.org/projects/naturalsort. It has been forked from version 1.1.1
+which was released on 2010-07-21. The first new release from this Github repo is version 1.2.0.
+
+## Examples
+
+```ruby
+   %w(a1 a11 a12 a2 a21).natural_sort  #=>  %w(a1 a2 a11 a12 a21)
+   %w(a b c A B C).natural_sort        #=>  %w(A a B b C c)
+   %w(x__2 x_1).natural_sort           #=>  %w(x_1 x__2)
+   %w(x2-y08 x2-g8 x2-y7 x8-y8).natural_sort    #=>  %w(x2-g8 x2-y7 x2-y08 x8-y8)
+   %w(x02-y08 x02-g8 x2-y7 x8-y8).natural_sort  #=>  %w(x02-g8 x2-y7 x02-y08 x8-y8)
+```
+
+## Features
+
+* Sort case insensitive
+* Sort underscore insensitive
+* Sort filename matching patterns
+* Sort mixed alpha and numeric "abc1", "abc12", "abc2", "a1b2" in correct order
+
+## Install
+
+#### With Bundler
+
+In your `Gemfile`:
+
+```ruby
+gem 'naturalsort'
+```
+
+or to optionally extend Ruby native objects:
+
+```ruby
+gem 'naturalsort', :require => 'natural_sort_kernel'
+```
+
+#### From Command Line
+
+```cmd
+$ gem install naturalsort
+```
+
+## Usage
+
+#### Extend Ruby native enumerable objects
+
+`require 'natural_sort_kernel'` adds `natural_sort` methods to all native Ruby enumerable objects (Array, Hash, etc...)
+
+```ruby
+   require 'natural_sort_kernel'
+
+   sorted = %w(a b c A B C).natural_sort
+```
+
+#### Use as a module function
+
+```ruby
+   require 'natural_sort'  # unless using Bundler
+
+   sorted = NaturalSort.sort %w(a b c d A B C D)
+```
+
+#### Use comparator function as a standalone
+
+Adds `natural_sort` methods to Ruby native enumerable objects (Array, Hash, etc...)
+
+```ruby
+   person_1 = Person.new('Moe')
+   person_2 = Person.new('Larry')
+   person_3 = Person.new('Curly')
+
+   [person_1, person_2, person_3].sort{|a,b| NaturalSort.comparator(a.name, b.name)}  #=> [person_3, person_2, person_1]
+
+   sorted = %w(a b c A B C).natural_sort
+```
+
+#### Include into your own objects
+
+Can be used to add `#natural_sort` method to on any enumerable object or any object which implements `#to_a`
+
+```ruby
+   class TodoList < Array
+     include NaturalSort
+   end
+
+   todo_list = TodoList.new
+   todo_list << 'Wash car'
+   todo_list << 'Water plants'
+   todo_list << 'Feed dog'
+
+   todo_list.natural_sort  #=> ['Feed dog', 'Wash car', 'Water plants']
+```
+
+## Authors
+
+* [Benjamin Francisoud](http://www.google.com/profiles/benjamin.francisoud)
+* [Johnny Shields](http://github.com/johnnyshields) (version 1.2.0+)
+
+## Contributing
+
+Fork -> Patch -> Spec -> Push -> Pull Request
+
+## Related Links
+
+Links related to the natural 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#e20071211T054956
+
+## License
+
+Copyright (c) 2007 Benjamin Francisoud
+
+Licensed under the MIT License. Refer to LICENSE for details.

data/Rakefile

@@ -1,30 +1,13 @@
-# -*- ruby -*-
+#!/usr/bin/env rake
+# -*- mode: ruby -*-
 
 require 'rubygems'
-require 'hoe'
 require './lib/natural_sort.rb'
+require 'rake/testtask'
 
-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
-
-SVN = 'svn+ssh://cogito@rubyforge.org/var/svn/naturalsort'
+task :default => :test
 
-task :svn_branch => [:clean] do
-  `svn delete #{SVN}/branches/1.X -m "cleanup branch"`
-  `svn copy #{SVN}/trunk #{SVN}/branches/1.X -m "create branch"`
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
 end
-
-task :svn_tag do
-  `svn copy #{SVN}/trunk #{SVN}/tags/#{NaturalSort::VERSION} -m "create tag"`
-end
-
-# vim: syntax=Ruby

data/lib/natural_sort.rb

@@ -1,102 +1,4 @@
-# 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.1.1'
-  
-  # call-seq:
-  #    NaturalSort::naturalsort(object)                     => array
-  # 
-  # Static method to sort.
-  # 
-  # *Usage*
-  #     NaturalSort::naturalsort ['a1', 'a12', 'a2']     #=> ['a1', 'a2', 'a12']
-  # 
-  # <tt>object</tt> can by any object that has to_a method.
-  def self.naturalsort(object)
-    sorted = object.to_a.sort do |a,b|
-      sa, sb = a.to_s, b.to_s
-      if ((sa.downcase <=> sb.downcase) == 0) then sa <=> sb
-      else
-        na, nb = check_regexp(sa, sb)
-        na <=> nb
-      end
-    end
-  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
-    NaturalSort::naturalsort(to_a)
-  end
-  
-  private
-  
-  def self.check_regexp(sa, sb)
-    regexp = /(^|\D+)(\d+|(\D$))/
-    ma, mb = multireg(regexp,sa), multireg(regexp,sb)
-    it = 0
-    equal = 0
-    ret = ["",""]
-    numeric = /(\d+)/
-    while (it < [ma.size,mb.size].min) and (equal==0) 
-      if (ma[it] and mb[it]) and (ma[it][1] and mb[it][1]) \
-         and (numeric.match ma[it][0] and numeric.match mb[it][0])
-        l = [ma[it][2].size,mb[it][2].size].max
-        ret = [format(ma[it], l), format(mb[it], l)]
-      else 
-        ret = [ma[it][0].downcase, mb[it][0].downcase]
-      end
-      equal = ret[0] <=> ret[1]
-      it+=1
-    end
-    return ret[0], ret[1]
-  end
-  
-  def check_regexp(sa, sb)
-    NaturalSort::check_regexp(sa, sb)
-  end
-  
-  # format([a, 1], 3) => a001
-  # add leading zero
-  def self.format(match_data, length)
-    match_data[1].gsub("_", "").downcase + ("%0#{length}d" % match_data[2].to_i)
-  end
-  
-  def format(match_data, length)
-    NaturalSort::format(match_data, length)
-  end
-  
-  # return an array with
-  # rgpx  matchdata on str
-  def self.multireg rgpx, str
-    result = []
-    while rgpx.match str
-        result.push rgpx.match(str)
-        str = rgpx.match(str).post_match
-    end
-    result
-  end
-    
-  def multireg rgpx, str
-    NaturalSort::multireg(rgpx, str)
-  end
-end
+
+require 'natural_sort/version'
+require 'natural_sort/engine'
+require 'natural_sort/base'

data/lib/natural_sort/base.rb

@@ -0,0 +1,68 @@
+# Public: The public interface for NaturalSort module
+# For method descriptions refer to NaturalSort::Engine
+#
+# Examples
+#
+#  require 'natural_sort'
+#  NaturalSort.sort ['a1', 'a12', 'a2']  #=> ['a1', 'a2', 'a12']
+#
+#  # or
+#
+#  require 'natural_sort_kernel'
+#  ['a', 'b', 'A', 'B'].natural_sort     #=> ['A', 'a', 'B', 'b']
+module NaturalSort
+
+  class << self
+    extend Forwardable
+
+    # Public: sort
+    #
+    # Signature
+    #
+    #   NaturalSort.sort(object)
+    #
+    # Refer to NaturalSort::Engine.sort
+    def_delegator :'NaturalSort::Engine', :sort
+
+    # Public: comparator
+    #
+    # Signature
+    #
+    #   NaturalSort.comparator(a, b)
+    #
+    # Refer to NaturalSort::Engine.comparator
+    def_delegator :'NaturalSort::Engine', :comparator
+
+    # Deprecated: Alias to NaturalSort.sort. Was deprecated in version 1.2.0.
+    # To be removed in version 2.0.0 (according to semver)
+    #
+    # object - the object to sort, which must either be an Enumerable or implement #to_a to be meaningful.
+    #
+    # Returns a sorted version of the object.
+    def naturalsort(object)
+      warn('NaturalSort.naturalsort is deprecated and will be removed. Use NaturalSort.sort instead')
+      NaturalSort::Engine.sort(object)
+    end
+  end
+
+  # Public: Main method to sort (other are just aliases). To be used when including
+  # NaturalSort into another object. Delegates to NaturalSort::Engine.sort
+  #
+  # Note that the object must either be an Enumerable or implement #to_a to be meaningful.
+  #
+  # Returns a sorted version of the object.
+  #
+  # Examples
+  #
+  #   require 'natural_sort'
+  #
+  #   class MyObject
+  #     include NaturalSort
+  #     def to_a
+  #       ['a3, a2, a1']
+  #     end
+  #   end
+  def natural_sort
+    NaturalSort::Engine.sort(self)
+  end
+end