naturally-unicode 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef97522f5ea4669b25bb4b97b4e7d6c6fe331f3b
+  data.tar.gz: 2cfd04486ff7f938d47af12b1f2d68db3ef8a2a8
+SHA512:
+  metadata.gz: 6610d5d63b5a1fa0c812a7eb6beac2457a8adb2f35f1d6c8158b7c52b5a69851c1760907bccddc4918c158f0b994655828972888b1ee5fcac5e9a14908bd5470
+  data.tar.gz: e342109988f022df63d13eab3f2a1d5cfb8f01b3590cc2592ac30bf7bd670043600a7d24f9dd93974b537c2b0511721488a6f9a06b078d751ce3fa4653bb0901

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.idea/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"

data/Gemfile

@@ -0,0 +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-unicode.gemspec
+gemspec

data/Gemfile.lock

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Robb Shecter
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# Naturally-unicode
+
+Natural (version number) sorting with added support for legal document numbering and unicode characters.
+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
+as *335.1, 336, 336a*, etc.
+
+`NaturallyUnicode` will also sort "numbers" in college course code format such as
+*MATH101, MATH102, ...*. See the specs for examples.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'naturally-unicode'
+
+And then execute:
+
+    $ bundle
+
+Or install it outside of bundler with:
+
+    $ gem install naturally-unicode
+
+
+## Usage
+
+```Ruby
+require 'naturally-unicode'
+
+# Sort a simple array of strings
+NaturallyUnicode.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',     '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| NaturallyUnicode.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">]
+```
+
+See [the spec for more examples](https://github.com/Loriowar/naturally-unicode/blob/master/spec/naturally_spec.rb).
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/naturally-unicode.rb

@@ -0,0 +1,76 @@
+require 'naturally-unicode/version'
+
+module NaturallyUnicode
+  # 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) }
+  end
+
+  # Convert the given number into an object that can be sorted
+  # 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/\p{Word}+/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
+
+    def initialize(v)
+      @val = v
+    end
+
+    def <=>(other)
+      if pure_integer? && other.pure_integer?
+        @val.to_i <=> other.val.to_i
+      elsif numbers_with_letters? || other.numbers_with_letters?
+        simple_normalize(@val) <=> simple_normalize(other.val)
+      elsif letters_with_numbers? || other.letters_with_numbers?
+        reverse_simple_normalize(@val) <=> reverse_simple_normalize(other.val)
+      else
+        @val <=> other.val
+      end
+    end
+
+    def pure_integer?
+      @val =~ /^\d+$/
+    end
+
+    def numbers_with_letters?
+      val =~ /^\d+\p{Alpha}+$/
+    end
+
+    def letters_with_numbers?
+      val =~ /^\p{Alpha}+\d+$/
+    end
+
+    def simple_normalize(n)
+      if n =~ /^(\d+)(\p{Alpha}+)$/
+        [$1.to_i, $2]
+      else
+        [n.to_i]
+      end
+    end
+
+    def reverse_simple_normalize(n)
+      if n =~ /^(\p{Alpha}+)(\d+)$/
+        [$1, $2.to_i]
+      else
+        [n.to_s]
+      end
+    end
+
+  end
+end

data/lib/naturally-unicode/version.rb

@@ -0,0 +1,3 @@
+module NaturallyUnicode
+  VERSION = "1.1.0"
+end

data/naturally-unicode.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'naturally-unicode/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'naturally-unicode'
+  gem.version       = NaturallyUnicode::VERSION
+  gem.authors       = ["Robb Shecter"]
+  gem.email         = ["robb@weblaws.org"]
+  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 and unicode characters}
+  gem.homepage      = "https://github.com/Loriowar/naturally-unicode"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/naturally-unicode_spec.rb

@@ -0,0 +1,107 @@
+require 'naturally-unicode'
+
+describe NaturallyUnicode do
+  describe '#sort' do
+    it 'sorts an 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 676.10]
+      b = %w[676 676.1 676.2 676.3 676.9 676.10 676.11 676.12]
+      NaturallyUnicode.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]
+      NaturallyUnicode.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]
+      NaturallyUnicode.sort(a).should == b
+    end
+
+    it 'sorts when numbers have letters in them' do
+      a = %w[335 335.1 336a 336 337 337a 337.1 337.15 337.2]
+      b = %w[335 335.1 336 336a 337 337.1 337.2 337.15 337a]
+      NaturallyUnicode.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я]
+      NaturallyUnicode.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]
+      NaturallyUnicode.sort(a).should == b
+    end
+
+    it 'sorts when letters have numbers and uncode 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]
+      NaturallyUnicode.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]
+      NaturallyUnicode.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б]
+      NaturallyUnicode.sort(a).should == b
+    end
+  end
+  
+  describe '#normalize' do
+    Thing = Struct.new(:number, :name)
+
+    it 'enables sorting objects by one particular attribute' do
+      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| NaturallyUnicode.normalize(o.number) }
+      sorted.map{|o| o.name}.should == %w[
+        color
+        opacity
+        lightness
+        size
+        shape
+        hardness
+        weight
+        ]
+    end
+
+    it 'enables sorting objects by one particular attribute which contain unicode characters' do
+      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| NaturallyUnicode.normalize(o.name) }
+      sorted.map{|o| o.name}.should == %w[
+        Брест
+        Будапешт
+        Васюки
+        Калуга
+        Киев
+        Москва
+        Париж
+        ]
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: naturally-unicode
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Robb Shecter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-13 00:00:00.000000000 Z
+dependencies: []
+description: Natural Sorting with support for legal numbering and unicode characters
+email:
+- robb@weblaws.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/naturally-unicode.rb
+- lib/naturally-unicode/version.rb
+- naturally-unicode.gemspec
+- spec/naturally-unicode_spec.rb
+homepage: https://github.com/Loriowar/naturally-unicode
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Sorts numbers according to the way people are used to seeing them.
+test_files:
+- spec/naturally-unicode_spec.rb
+has_rdoc: