naturally 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3c7fe0629f54a4f0418f2ef7bd0b698bac3ed282
-  data.tar.gz: 87063a64049efd21df9051ebf72b18cc4142e0b1
+SHA256:
+  metadata.gz: f7b3bdea2bec4624b2f0725d0e52e05d93cf0638fe8ddc42e8dd8c7b20696920
+  data.tar.gz: ddc8c8f12e62e604deb0d8345df5f29464051ca859834747d2a6db1d8f51c263
 SHA512:
-  metadata.gz: 6b5485915f455c893d8fc1fd0afd1116c602447e863a54cf8704fe42fb21269f71834d80369ed701389483d063293592b2b342226a608cea0804eda3298b6090
-  data.tar.gz: ff836d19c5b40dc8a79ae0f6e638dd3272ae51026b2ee3fe1dd7ee8a07e1e1d9ef9a4880a3b724ed193a92aa36d9816f12963c56b2c3c5cff26c0cbcf311d9c5
+  metadata.gz: 602b9798ae11958dd850f1f992a7217cf4b981ccdb7446899b410154c5e9d009318cbf8106232e4dc83c3ba7d06b37df148f3c96770f0165d259d92032e9872f
+  data.tar.gz: ee6d95f697088d3a6196f64b863dbac96cb2cfc5bf83357af029ed6aa00d0c49cd24345356d12c616ef2780d30785d2bd40a60c42c4321e07047f990094c9b60

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
+  - 2.4
+  - 2.5

data/README.md

@@ -1,10 +1,11 @@
 # 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)
+[![Gem Version](https://badge.fury.io/rb/naturally.png)](http://badge.fury.io/rb/naturally) [![Build Status](https://travis-ci.org/public-law/naturally.png)](https://travis-ci.org/public-law/naturally) 
+[![Maintainability](https://api.codeclimate.com/v1/badges/0ebf4ef97723f2622105/maintainability)](https://codeclimate.com/github/dogweather/naturally/maintainability)
 
 Natural (version number) sorting with support for **legal document numbering**, **college course codes**, and **Unicode**.
-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/).
+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 Public.Law post [Counting to 10 in Californian](https://blog.public.law/2012/08/07/counting-from-1-to-10-in-californian/).
 
-##Installation
+## Installation
 
 ```Shell
 $ gem install naturally
@@ -37,7 +38,7 @@ releases = [
 ]
 
 # Sort by version number
-sorted = Naturally.sort_by(releases, :version)
+sorted = Naturally.sort releases, by: :version
 
 # Check what we have
 expect(sorted.map(&:name)).to eq [

data/lib/naturally.rb

@@ -3,12 +3,20 @@ require 'naturally/segment'
 # A module which performs natural sorting on a variety of number
 # formats. (See the specs for examples.)
 module Naturally
-  # Perform a natural sort.
+  # Perform a natural sort. Supports two syntaxes:
+  #
+  # 1. sort(objects)  # Simple arrays
+  # 2. sort(objects, by: some_attribute)  # Complex objects
   #
   # @param [Array<String>] an_array the list of numbers to sort.
+  # @param [by] (optional) an attribute of the array by which to sort.
   # @return [Array<String>] the numbers sorted naturally.
-  def self.sort(an_array)
-    an_array.sort_by { |x| normalize(x) }
+  def self.sort(an_array, by:nil)
+    if by.nil?
+      an_array.sort_by { |x| normalize(x) }
+    else
+      self.sort_by(an_array, by)
+    end
   end
 
   # Sort an array of objects "naturally" by a given attribute.
@@ -25,9 +33,9 @@ module Naturally
     an_array.sort_by { |obj| normalize(obj.send(an_attribute)) }
   end
 
-  # Convert the given number an array of {Segment}s.
+  # Convert the given number to an array of {Segment}s.
   # This enables it to be sorted against other arrays
-  # by the standard #sort method.
+  # by the built-in #sort method.
   #
   # For example, '1.2a.3' becomes
   # [Segment<'1'>, Segment<'2a'>, Segment<'3'>]

data/lib/naturally/segment.rb

@@ -1,7 +1,8 @@
 module Naturally
   # An entity which can be compared to other like elements for
   # sorting. It's an object representing
-  # a value which implements the {Comparable} interface.
+  # a value which implements the {Comparable} interface which can
+  # convert itself to an array.
   class Segment
     include Comparable
 
@@ -25,7 +26,7 @@ module Naturally
     # @example a college course code
     #   Segment.new('MATH101').to_array #=> [:str, "MATH", 101]
     #
-    # @example Section 633a of the ADEA
+    # @example Section 633a of the U.S. Age Discrimination in Employment Act
     #   Segment.new('633a').to_array #=> [:int, 633, "a"]
     def to_array
       # TODO: Refactor, probably via polymorphism

data/lib/naturally/version.rb

@@ -1,4 +1,4 @@
 module Naturally
   # Gem version
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/naturally.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.version       = Naturally::VERSION
   gem.license       = 'MIT'
   gem.authors       = ["Robb Shecter"]
-  gem.email         = ["robb@weblaws.org"]
+  gem.email         = ["robb@public.law"]
   gem.summary       = %q{Sorts numbers according to the way people are used to seeing them.}
   gem.description   = %q{Natural Sorting with support for legal numbering, course numbers, and other number/letter mixes.}
   gem.homepage      = "http://github.com/dogweather/naturally"

data/spec/naturally_spec.rb

@@ -2,6 +2,7 @@
 require 'naturally'
 
 describe Naturally do
+  # Just a helper for these tests
   def it_sorts(opts = {})
     this = opts[:this]
     to_this = opts[:to_this]
@@ -9,59 +10,84 @@ describe Naturally do
     expect(actual).to eq(to_this)
   end
 
+
   describe '#sort' do
+    it 'supports a nicer by: syntax' 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')
+      ]
+
+      actual = Naturally.sort releases, by: :version
+
+      expect(actual.map(&:name)).to eq [
+                                      'Lucid Lynx',
+                                      'Maverick Meerkat',
+                                      'Precise Pangolin',
+                                      'Quantal Quetzal',
+                                      'Raring Ringtail',
+                                      'Saucy Salamander'
+                                    ]
+    end
+
+
     it 'sorts an array of strings nicely as if they were legal numbers' do
       it_sorts(
-        this: %w(676 676.1 676.11 676.12 676.2 676.3 676.9 676.10),
+        this:    %w(676 676.1 676.11 676.12 676.2 676.3 676.9 676.10),
         to_this: %w(676 676.1 676.2 676.3 676.9 676.10 676.11 676.12)
       )
     end
 
     it 'sorts a more complex list of strings' do
       it_sorts(
-        this: %w(350 351 352 352.1 352.5 353.1 354 354.3 354.4 354.45 354.5),
+        this:    %w(350 351 352 352.1 352.5 353.1 354 354.3 354.4 354.45 354.5),
         to_this: %w(350 351 352 352.1 352.5 353.1 354 354.3 354.4 354.5 354.45)
       )
     end
 
     it 'sorts when numbers have letters in them' do
       it_sorts(
-        this: %w(335 335.1 336a 336 337 337a 337.1 337.15 337.2),
+        this:    %w(335 335.1 336a 336 337 337a 337.1 337.15 337.2),
         to_this: %w(335 335.1 336 336a 337 337.1 337.2 337.15 337a)
       )
     end
 
     it 'sorts when numbers have unicode letters in them' do
       it_sorts(
-        this: %w(335 335.1 336a 336 337 337я 337.1 337.15 337.2),
+        this:    %w(335 335.1 336a 336 337 337я 337.1 337.15 337.2),
         to_this: %w(335 335.1 336 336a 337 337.1 337.2 337.15 337я)
       )
     end
 
     it 'sorts when letters have numbers in them' do
       it_sorts(
-        this: %w(PC1, PC3, PC5, PC7, PC9, PC10, PC11, PC12, PC13, PC14, PROF2, PBLI, SBP1, SBP3),
+        this:    %w(PC1, PC3, PC5, PC7, PC9, PC10, PC11, PC12, PC13, PC14, PROF2, PBLI, SBP1, SBP3),
         to_this: %w(PBLI, PC1, PC3, PC5, PC7, PC9, PC10, PC11, PC12, PC13, PC14, PROF2, SBP1, SBP3)
       )
     end
 
     it 'sorts when letters have numbers and unicode characters in them' do
       it_sorts(
-        this: %w(АБ4, АБ2, АБ10, АБ12, АБ1, АБ3, АД8, АД5, АЩФ12, АЩФ8, ЫВА1),
+        this:    %w(АБ4, АБ2, АБ10, АБ12, АБ1, АБ3, АД8, АД5, АЩФ12, АЩФ8, ЫВА1),
         to_this: %w(АБ1, АБ2, АБ3, АБ4, АБ10, АБ12, АД5, АД8, АЩФ8, АЩФ12, ЫВА1)
       )
     end
 
     it 'sorts double digits with letters correctly' do
       it_sorts(
-        this: %w(12a 12b 12c 13a 13b 2 3 4 5 10 11 12),
+        this:    %w(12a 12b 12c 13a 13b 2 3 4 5 10 11 12),
         to_this: %w(2 3 4 5 10 11 12 12a 12b 12c 13a 13b)
       )
     end
 
     it 'sorts double digits with unicode letters correctly' do
       it_sorts(
-        this: %w(12а 12б 12в 13а 13б 2 3 4 5 10 11 12),
+        this:    %w(12а 12б 12в 13а 13б 2 3 4 5 10 11 12),
         to_this: %w(2 3 4 5 10 11 12 12а 12б 12в 13а 13б)
       )
     end
@@ -75,28 +101,28 @@ describe Naturally do
 
     it 'sorts letters with digits correctly' do
       it_sorts(
-        this: %w(1 a 2 b 3 c),
+        this:    %w(1 a 2 b 3 c),
         to_this: %w(1 2 3 a b c)
       )
     end
 
     it 'sorts complex numbers with digits correctly' do
       it_sorts(
-        this: %w(1 a 2 b 3 c 1.1 a.1 1.2 a.2 1.3 a.3 b.1 ),
+        this:    %w(1 a 2 b 3 c 1.1 a.1 1.2 a.2 1.3 a.3 b.1 ),
         to_this: %w(1 1.1 1.2 1.3 2 3 a a.1 a.2 a.3 b b.1 c)
       )
     end
 
     it 'sorts complex mixes of numbers and digits correctly' do
       it_sorts(
-        this: %w( 1.a.1 1.1 ),
+        this:    %w( 1.a.1 1.1 ),
         to_this: %w( 1.1 1.a.1 )
       )
     end
 
     it 'sorts complex mixes of numbers and digits correctly' do
       it_sorts(
-        this: %w( 1a1 1aa aaa ),
+        this:    %w( 1a1 1aa aaa ),
         to_this: %w( 1aa 1a1 aaa )
       )
     end
@@ -104,7 +130,7 @@ describe Naturally do
 
   describe '#sort_naturally_by' do
     it 'sorts by an attribute' do
-      UbuntuVersion = Struct.new(:name, :version)
+      UbuntuVersion ||= Struct.new(:name, :version)
       releases = [
         UbuntuVersion.new('Saucy Salamander', '13.10'),
         UbuntuVersion.new('Raring Ringtail',  '13.04'),

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: naturally
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2018-06-03 00:00:00.000000000 Z
 dependencies: []
 description: Natural Sorting with support for legal numbering, course numbers, and
   other number/letter mixes.
 email:
-- robb@weblaws.org
+- robb@public.law
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -49,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Sorts numbers according to the way people are used to seeing them.