naturally 1.0.3 → 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 779c19dc2b8a8008edc6044aea5dd581d04fd231
+  data.tar.gz: 51fc1ee3a6591b169e3823d38c26df50bb58c7ab
+SHA512:
+  metadata.gz: 49b59c6d73db65805dc0e3d86fe7d8508e889d4634d0c9604e7fba9422e552c7dca242cdf34b0f8a534d912a3d1406a1d30d2d0ad6c7275c224871efc0087d85
+  data.tar.gz: 5d996f19d784d877090477bc82e340035506f2f9dbebf4acc03156f43e84740459e9c2b8cc7602f9ea8e866191d229a3acee3b887a1b4456b54560df207ad3f3

data/.travis.yml

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

data/Gemfile

@@ -1,4 +1,9 @@
 source 'https://rubygems.org'
 
+group :test do
+  gem 'rspec', '~> 2.0'
+  gem 'rake', '~> 10.0'
+end
+
 # Specify your gem's dependencies in naturally.gemspec
 gemspec

data/README.md

@@ -1,8 +1,9 @@
 # Naturally
+[![Build Status](https://travis-ci.org/dogweather/naturally.png)](https://travis-ci.org/dogweather/naturally)
 
-Natural sorting with support for legal document numbering. 
-See [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.
+Natural 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.
 
 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
@@ -19,7 +20,7 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it outside of bundler with:
 
     $ gem install naturally
 
@@ -27,28 +28,41 @@ Or install it yourself as:
 ## Usage
 
 ```Ruby
+require 'naturally'
+
 # Sort a simple array of strings
 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:
 
+
+```Ruby
 # Sort an array of objects by one attribute
 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')
+  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) }
-# => [#<struct Thing number="1.1", name="color">,
-      #<struct Thing number="1.1.1", name="opacity">,
-      #<struct Thing number="1.1.2", name="lightness">,
-      #<struct Thing number="1.2", name="size">,
-      #<struct Thing number="1.3", name="shape">,
-      #<struct Thing number="1.10", name="hardness">,
-      #<struct Thing number="2.1", name="weight">]
+
+# 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">]
 ```
 
 See [the spec for more examples](https://github.com/dogweather/naturally/blob/master/spec/naturally_spec.rb).

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/naturally.rb

@@ -9,10 +9,10 @@ module Naturally
     return an_array.sort_by{ |x| normalize(x) }
   end  
 
-  # Convert the given number into and object that can be sorted
+  # Convert the given number into an object that can be sorted
   # naturally. 
   # @param [String] number the number in complex form such as 1.2a.3.
-  # @return [Array<NumberElement>] an array of NumberElements which are
+  # @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)}
@@ -32,7 +32,7 @@ module Naturally
     def <=>(other)
       if pure_integer? && other.pure_integer?
         return @val.to_i <=> other.val.to_i
-      elsif mixed? || other.mixed?
+      elsif numbers_with_letters? || other.numbers_with_letters?
         return simple_normalize(@val) <=> simple_normalize(other.val)
       else
         return @val <=> other.val
@@ -43,7 +43,7 @@ module Naturally
       @val =~ /^\d+$/
     end
     
-    def mixed?
+    def numbers_with_letters?
       val =~ /^\d+[a-zA-Z]+$/
     end
     

data/lib/naturally/version.rb

@@ -1,3 +1,3 @@
 module Naturally
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naturally
 version: !ruby/object:Gem::Version
-  version: 1.0.3
-  prerelease: 
+  version: 1.0.4
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-15 00:00:00.000000000 Z
+date: 2013-09-19 00:00:00.000000000 Z
 dependencies: []
 description: Natural Sorting with support for legal numbering
 email:
@@ -19,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -29,27 +29,26 @@ files:
 - spec/naturally_spec.rb
 homepage: http://github.com/dogweather/naturally
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Sorts numbers according to the way people are used to seeing them.
 test_files:
 - spec/naturally_spec.rb