naturally 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 439d055cbae1f4d8afcb90a30a3f651f45853416
-  data.tar.gz: 72dceab1d70edbb4de39d5e59d978b0dab927636
+  metadata.gz: e7f13718d03ab6f2f6e7d7fc6f3aa44683aa14ac
+  data.tar.gz: d0576fae7b11c7a543fb9a78d06a74805ee171ac
 SHA512:
-  metadata.gz: 21bc2087c933659dc45c69c41f602c433ce7259889426eb8de019dc6f23fd4fc06f634b69eb17197dba50573919eb3b7b63cf8d0b05d3b5595e210939fb98c4f
-  data.tar.gz: 4439601b147fa7e969f5c1d33585c1b79d29d0b6489a5f29b66d8c8c49e5a6fdbc90d39e03ae99713f48e3b6aa4cb0d45ee6feb6c90a06f1d524a0fb89cedca8
+  metadata.gz: b8dd2bf1648705cf27085b9e67900def932a3d470577dcaeee866c2a0e8461cc5aef5e26d57d8f43b1e262ac125603d6a32c1f135f26bca22d708a303d9262b3
+  data.tar.gz: ac2984cf0e59d68ec9c27a3b73a29e066c8f90e48749c5b67661b201a878758904f96087a21a8ae7987560184fb78793b2ea568c34e8c6ce7eb44e9132637d42

data/.gitignore

@@ -11,6 +11,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock
 
 # YARD artifacts
 .yardoc

data/README.md

@@ -2,8 +2,8 @@
 [![Gem Version](https://badge.fury.io/rb/naturally.png)](http://badge.fury.io/rb/naturally) [![Build Status](https://travis-ci.org/dogweather/naturally.png)](https://travis-ci.org/dogweather/naturally) [![Code Climate](https://codeclimate.com/github/dogweather/naturally.png)](https://codeclimate.com/github/dogweather/naturally)
 
 Natural (version number) sorting with added support for legal document numbering.
-See [Sorting for Humans : Natural Sort Order](http://www.codinghorror.com/blog/2007/12/sorting-for-humans-natural-sort-order.html) and [Counting to 10 in Californian](http://www.weblaws.org/blog/2012/08/counting-from-1-to-10-in-californian/)
-for the motivations to make this library. This is also the kind of ordering you want if you're sorting version numbers.
+See Jeff Atwood's [Sorting for Humans: Natural Sort Order](http://www.codinghorror.com/blog/2007/12/sorting-for-humans-natural-sort-order.html) and the Weblaws.org post [Counting to 10 in Californian](http://www.weblaws.org/blog/2012/08/counting-from-1-to-10-in-californian/)
+for the motivations to make this library.
 
 The core of the search is [from here](https://github.com/ahoward/version_sorter). I then made
 several changes to handle the particular types of numbers that come up in statutes, such
@@ -37,14 +37,16 @@ require 'naturally'
 Naturally.sort(["1.1", "1.10", "1.2"])  # => ["1.1", "1.2", "1.10"]
 ```
 
-Usually, however, the library is used to sort an array of some kind of
-object:
+Usually the library is used to sort an array of objects:
 
 
 ```Ruby
   describe '#sort_naturally_by' do
     it 'sorts by an attribute' do
+      # Define a new simple object for storing Ubuntu versions
       UbuntuVersion = Struct.new(:name, :version)
+      
+      # Create an array
       releases = [
         UbuntuVersion.new('Saucy Salamander', '13.10'),
         UbuntuVersion.new('Raring Ringtail',  '13.04'),
@@ -53,7 +55,11 @@ object:
         UbuntuVersion.new('Quantal Quetzal',  '12.10'),
         UbuntuVersion.new('Lucid Lynx',       '10.04.4')
       ]
+      
+      # Sort by version number
       sorted = Naturally.sort_by(releases, :version)
+      
+      # Check what we have
       expect(sorted.map(&:name)).to eq [
         'Lucid Lynx',
         'Maverick Meerkat',
@@ -66,7 +72,7 @@ object:
   end
 ```
 
-See [the spec for more examples](https://github.com/dogweather/naturally/blob/master/spec/naturally_spec.rb).
+See [the spec for more examples](https://github.com/dogweather/naturally/blob/master/spec/naturally_spec.rb) of what Naturally can sort.
 
 
 ## Contributing

data/lib/naturally.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'naturally/version'
 
 module Naturally
@@ -7,7 +9,7 @@ module Naturally
   # @return [Array<String>] the numbers sorted naturally.
   def self.sort(an_array)
     return an_array.sort_by { |x| normalize(x) }
-  end  
+  end
 
   def self.sort_by(an_array, an_attribute)
     an_array.sort_by{|i| Naturally.normalize(i.send(an_attribute))}
@@ -20,7 +22,7 @@ module Naturally
   # @return [Array<NumberElement>] an array of NumberElements which is
   #         able to be sorted naturally via a normal 'sort'.
   def self.normalize(number)
-    number.to_s.scan(%r/[0-9a-zA-Z]+/o).map { |i| NumberElement.new(i) }
+    number.to_s.scan(%r/\p{Word}+/o).map { |i| NumberElement.new(i) }
   end
 
   private
@@ -49,7 +51,7 @@ module Naturally
         return reverse_simple_normalize(@val) <=> reverse_simple_normalize(other.val)
       end
 
-      return @val <=> other.val
+      @val <=> other.val
     end
 
     def either_is_letters_followed_by_numbers(other)
@@ -67,29 +69,30 @@ module Naturally
     def pure_integer?
       @val =~ /^\d+$/
     end
-    
+
     def numbers_with_letters?
-      val =~ /^\d+[a-zA-Z]+$/
+      val =~ /^\d+\p{Alpha}+$/
     end
 
     def letters_with_numbers?
-      val =~ /^[a-zA-Z]+\d+$/
+      val =~ /^\p{Alpha}+\d+$/
     end
-    
+
     def simple_normalize(n)
-      if n =~ /^(\d+)([a-zA-Z]+)$/
-        return [$1.to_i, $2]
+      if n =~ /^(\d+)(\p{Alpha}+)$/
+        [$1.to_i, $2]
       else 
-        return [n.to_i]
+        [n.to_i]
       end
     end
 
     def reverse_simple_normalize(n)
-      if n =~ /^([a-zA-Z]+)(\d+)$/
-        return [$1, $2.to_i]
+      if n =~ /^(\p{Alpha}+)(\d+)$/
+        [$1, $2.to_i]
       else
-        return [n.to_s]
+        [n.to_s]
       end
     end
+
   end
 end

data/lib/naturally/version.rb

@@ -1,3 +1,3 @@
 module Naturally
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

data/spec/naturally_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'naturally'
 
 describe Naturally do
@@ -20,17 +22,35 @@ describe Naturally do
       Naturally.sort(a).should == b
     end
 
+    it 'sorts when numbers have unicode letters in them' do
+      a = %w[335 335.1 336a 336 337 337я 337.1 337.15 337.2]
+      b = %w[335 335.1 336 336a 337 337.1 337.2 337.15 337я]
+      Naturally.sort(a).should == b
+    end
+
     it 'sorts when letters have numbers in them' do
       a = %w[PC1, PC3, PC5, PC7, PC9, PC10, PC11, PC12, PC13, PC14, PROF2, PBLI, SBP1, SBP3]
       b = %w[PBLI, PC1, PC3, PC5, PC7, PC9, PC10, PC11, PC12, PC13, PC14, PROF2, SBP1, SBP3]
       Naturally.sort(a).should == b
     end
-    
+
+    it 'sorts when letters have numbers and unicode characters in them' do
+      a = %w[АБ4, АБ2, АБ10, АБ12, АБ1, АБ3, АД8, АД5, АЩФ12, АЩФ8, ЫВА1]
+      b = %w[АБ1, АБ2, АБ3, АБ4, АБ10, АБ12, АД5, АД8, АЩФ8, АЩФ12, ЫВА1]
+      Naturally.sort(a).should == b
+    end
+
     it 'sorts double digits with letters correctly' do
       a = %w[12a 12b 12c 13a 13b 2 3 4 5 10 11 12]
       b = %w[2 3 4 5 10 11 12 12a 12b 12c 13a 13b]
       Naturally.sort(a).should == b
     end
+
+    it 'sorts double digits with unicode letters correctly' do
+      a = %w[12а 12б 12в 13а 13б 2 3 4 5 10 11 12]
+      b = %w[2 3 4 5 10 11 12 12а 12б 12в 13а 13б]
+      Naturally.sort(a).should == b
+    end
   end
   
   describe '#sort_naturally_by' do
@@ -54,5 +74,28 @@ describe Naturally do
         'Saucy Salamander'
       ]
     end
+
+    it 'sorts by an attribute which contains unicode characters' do
+      Thing = Struct.new(:number, :name)
+      objects = [
+        Thing.new('1.1', 'Москва'),
+        Thing.new('1.2', 'Киев'),
+        Thing.new('1.1.1', 'Париж'),
+        Thing.new('1.1.2', 'Будапешт'),
+        Thing.new('1.10', 'Брест'),
+        Thing.new('2.1', 'Калуга'),
+        Thing.new('1.3', 'Васюки')
+      ]
+      sorted = objects.sort_by{ |o| Naturally.normalize(o.name) }
+      sorted.map{|o| o.name}.should == %w[
+        Брест
+        Будапешт
+        Васюки
+        Калуга
+        Киев
+        Москва
+        Париж
+      ]
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naturally
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies: []
 description: Natural Sorting with support for legal numbering
 email:
@@ -20,7 +20,6 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,26 +0,0 @@
-PATH
-  remote: .
-  specs:
-    naturally (1.2.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.2.5)
-    rake (10.2.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  naturally!
-  rake (~> 10.0)
-  rspec (~> 2.0)