naturally 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faf607f415ddcf15c148739259c52e174b0b3b46
-  data.tar.gz: 1dc1552d7a19456bc2a94a7a5eea5fe27e034516
+  metadata.gz: e088049af46b6400067b7fee29e5fcf173f867c5
+  data.tar.gz: 0f2c8c9786b402bf168826b416229c725805744b
 SHA512:
-  metadata.gz: e8b3ff9491b77930b6f2aee7a839e1c7855d5df50808667704ba35a645cf35c98408a2949f51435e6782538b1ead608ec8b1cd320b93612ae0dfa7661195f615
-  data.tar.gz: 3b192cfda48fd177e3c3dc9575ec48d4ee856935d22723d7b0c740ba918b94d925886d04366c07860cb194a7bdd0091bd345e1bc987981ff49c50c978ffc6636
+  metadata.gz: d0e08aedc2dcaadc4af03ed0ebe01b2ae60bfa1d0f87d950aec091d0a4c52fe02c69ec0b0d398b34f147b5b85b2f587d55429a710e4cdbab500a0dbe2fd7a788
+  data.tar.gz: ff7350582be9a879f06069d96fca4a9e0429fd610fa212eea2390d4d8815c527eb9132d87590b4aa2bb2844f256433624b116dd6fcbbbedeb55954405ec35bf4

data/.travis.yml

@@ -1,6 +1,4 @@
 language: ruby
 rvm:
-  - "1.8.7"
-  - "1.9.2"
   - "1.9.3"
   - "2.0.0"

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    naturally (1.0.4)
+    naturally (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.2.4)
+    diff-lcs (1.2.5)
     rake (10.1.1)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)

data/lib/naturally/version.rb

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

data/lib/naturally.rb

@@ -1,26 +1,29 @@
-require "naturally/version"
+require 'naturally/version'
 
 module Naturally
-  
   # Perform a natural sort.
+  #
   # @param [Array<String>] an_array the list of numbers to sort.
   # @return [Array<String>] the numbers sorted naturally.
   def self.sort(an_array)
-    return an_array.sort_by{ |x| normalize(x) }
+    return an_array.sort_by { |x| normalize(x) }
   end  
 
   # Convert the given number into an object that can be sorted
-  # naturally. 
+  # naturally. This object is an array of {NumberElement} instances.
+  #
   # @param [String] number the number in complex form such as 1.2a.3.
   # @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/[0-9a-zA-Z]+/o).map { |i| NumberElement.new(i) }
   end
 
-
   private
 
+  # An entity which can be compared to other like elements for
+  # sorting in an array. It's an object representing
+  # a value which implements the {Comparable} interface.
   class NumberElement
     include Comparable
     attr_accessor :val
@@ -69,5 +72,4 @@ module Naturally
       end
     end
   end
-  
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naturally
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-02 00:00:00.000000000 Z
+date: 2014-01-18 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.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Sorts numbers according to the way people are used to seeing them.