naturally 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e088049af46b6400067b7fee29e5fcf173f867c5
-  data.tar.gz: 0f2c8c9786b402bf168826b416229c725805744b
+  metadata.gz: b2fe9301244de764ea34a2f403745a4bbc11815d
+  data.tar.gz: 8b13bf9eb6958c150019c5d09e0d778bb953ddf6
 SHA512:
-  metadata.gz: d0e08aedc2dcaadc4af03ed0ebe01b2ae60bfa1d0f87d950aec091d0a4c52fe02c69ec0b0d398b34f147b5b85b2f587d55429a710e4cdbab500a0dbe2fd7a788
-  data.tar.gz: ff7350582be9a879f06069d96fca4a9e0429fd610fa212eea2390d4d8815c527eb9132d87590b4aa2bb2844f256433624b116dd6fcbbbedeb55954405ec35bf4
+  metadata.gz: b016f2539c1f2de5f3e47753d9122f1fec032e187e54f9723be8225c471f89f65b2bad005385acfe6cdbd554a924d778e29c1356120099d4da4c8a91ac9abc7a
+  data.tar.gz: 39bd27cd6fa8c287559cf906b210d6b6d33c731338a6b0a8431fc85a08ab3b8530fcdf0be1e5b5c7cd64823251eb0a093c9049c60de2c3016c0a85b66d7b292c

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
   - "1.9.3"
-  - "2.0.0"
+  - "2.0.0"
+  - "2.1.0"
+  - "2.1.1"

data/README.md

@@ -1,7 +1,7 @@
 # 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)
+[![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 sorting with added support for legal document numbering.
+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.
 
@@ -42,30 +42,28 @@ object:
 
 
 ```Ruby
-# Sort an array of objects by one attribute
-Thing = Struct.new(:number, :name)
-objects = [
-  Thing.new('1',     'USA'),
-  Thing.new('2',     'Canada'),
-  Thing.new('1.1',   'Oregon'),
-  Thing.new('1.2',   'Washington'),
-  Thing.new('1.1.1', 'Portland'),
-  Thing.new('1.10',  'Texas'),
-  Thing.new('2.1',   'British Columbia'),
-  Thing.new('1.3',   'California'),
-  Thing.new('1.1.2', 'Eugene')
-  ]
-objects.sort_by{ |o| Naturally.normalize(o.number) }
-
-# Results in:
-[<struct Thing number="1.1", name="Oregon">,
- <struct Thing number="1.1.1", name="Portland">,
- <struct Thing number="1.1.2", name="Eugene">,
- <struct Thing number="1.2", name="Washington">,
- <struct Thing number="1.3", name="California">,
- <struct Thing number="1.10", name="Texas">,
- <struct Thing number="2", name="Canada">,
- <struct Thing number="2.1", name="British Columbia">]
+  describe '#sort_naturally_by' do
+    it 'sorts by an attribute' do
+      UbuntuVersion = Struct.new(:name, :version)
+      releases = [
+        UbuntuVersion.new('Saucy Salamander', '13.10'),
+        UbuntuVersion.new('Raring Ringtail',  '13.04'),
+        UbuntuVersion.new('Precise Pangolin', '12.04.4'),
+        UbuntuVersion.new('Maverick Meerkat', '10.10'),
+        UbuntuVersion.new('Quantal Quetzal',  '12.10'),
+        UbuntuVersion.new('Lucid Lynx',       '10.04.4')
+      ]
+      sorted = Naturally.sort_by(releases, :version)
+      expect(sorted.map(&:name)).to eq [
+        'Lucid Lynx',
+        'Maverick Meerkat',
+        'Precise Pangolin',
+        'Quantal Quetzal',
+        'Raring Ringtail',
+        'Saucy Salamander'
+      ]
+    end
+  end
 ```
 
 See [the spec for more examples](https://github.com/dogweather/naturally/blob/master/spec/naturally_spec.rb).

data/lib/naturally.rb

@@ -9,6 +9,10 @@ module Naturally
     return an_array.sort_by { |x| normalize(x) }
   end  
 
+  def self.sort_by(an_array, an_attribute)
+    an_array.sort_by{|i| Naturally.normalize(i.send(an_attribute))}
+  end
+
   # Convert the given number into an object that can be sorted
   # naturally. This object is an array of {NumberElement} instances.
   #
@@ -33,17 +37,33 @@ module Naturally
     end
 
     def <=>(other)
-      if pure_integer? && other.pure_integer?
+      if both_are_integers_without_letters(other)
         return @val.to_i <=> other.val.to_i
-      elsif numbers_with_letters? || other.numbers_with_letters?
+      end
+
+      if either_is_numbers_followed_by_letters(other)
         return simple_normalize(@val) <=> simple_normalize(other.val)
-      elsif letters_with_numbers? || other.letters_with_numbers?
+      end
+
+      if either_is_letters_followed_by_numbers(other)
         return reverse_simple_normalize(@val) <=> reverse_simple_normalize(other.val)
-      else
-        return @val <=> other.val
       end
+
+      return @val <=> other.val
     end
-    
+
+    def either_is_letters_followed_by_numbers(other)
+      letters_with_numbers? || other.letters_with_numbers?
+    end
+
+    def either_is_numbers_followed_by_letters(other)
+      numbers_with_letters? || other.numbers_with_letters?
+    end
+
+    def both_are_integers_without_letters(other)
+      pure_integer? && other.pure_integer?
+    end
+
     def pure_integer?
       @val =~ /^\d+$/
     end
@@ -72,4 +92,4 @@ module Naturally
       end
     end
   end
-end
+end

data/lib/naturally/version.rb

@@ -1,3 +1,3 @@
 module Naturally
-  VERSION = "1.1.0"
+  VERSION = '1.2.0'
 end

data/spec/naturally_spec.rb

@@ -8,12 +8,6 @@ describe Naturally do
       Naturally.sort(a).should == b
     end
     
-    it 'sorts a smaller array of strings nicely as if they were legal numbers' do
-      a = %w[676 676.1 676.11 676.12 676.2 676.3 676.9]
-      b = %w[676 676.1 676.2 676.3 676.9 676.11 676.12]
-      Naturally.sort(a).should == b
-    end
-    
     it 'sorts a more complex list of strings' do
       a = %w[350 351 352 352.1 352.5 353.1 354 354.3 354.4 354.45 354.5]
       b = %w[350 351 352 352.1 352.5 353.1 354 354.3 354.4 354.5 354.45]
@@ -39,28 +33,26 @@ describe Naturally do
     end
   end
   
-  describe '#normalize' do
-    it 'enables sorting objects by one particular attribute' do
-      Thing = Struct.new(:number, :name)
-      objects = [
-        Thing.new('1.1', 'color'),
-        Thing.new('1.2', 'size'),
-        Thing.new('1.1.1', 'opacity'),
-        Thing.new('1.1.2', 'lightness'),
-        Thing.new('1.10', 'hardness'),
-        Thing.new('2.1', 'weight'),
-        Thing.new('1.3', 'shape')
-        ]
-      sorted = objects.sort_by{ |o| Naturally.normalize(o.number) }
-      sorted.map{|o| o.name}.should == %w[
-        color
-        opacity
-        lightness
-        size
-        shape
-        hardness
-        weight
-        ]
+  describe '#sort_naturally_by' do
+    it 'sorts by an attribute' do
+      UbuntuVersion = Struct.new(:name, :version)
+      releases = [
+        UbuntuVersion.new('Saucy Salamander', '13.10'),
+        UbuntuVersion.new('Raring Ringtail',  '13.04'),
+        UbuntuVersion.new('Precise Pangolin', '12.04.4'),
+        UbuntuVersion.new('Maverick Meerkat', '10.10'),
+        UbuntuVersion.new('Quantal Quetzal',  '12.10'),
+        UbuntuVersion.new('Lucid Lynx',       '10.04.4')
+      ]
+      sorted = Naturally.sort_by(releases, :version)
+      expect(sorted.map(&:name)).to eq [
+        'Lucid Lynx',
+        'Maverick Meerkat',
+        'Precise Pangolin',
+        'Quantal Quetzal',
+        'Raring Ringtail',
+        'Saucy Salamander'
+      ]
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naturally
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-18 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies: []
 description: Natural Sorting with support for legal numbering
 email:
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Sorts numbers according to the way people are used to seeing them.