unnatural 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee0b35ed79162c58be6d1ed2af2022d18f19615d
+  data.tar.gz: 4be5c919b28dd739b6d1cc4f9c2d8d01d49b6411
+SHA512:
+  metadata.gz: 41c9475d5c6f7fb41dd962ddb1a11a2d5ac212d3186028a0d4b0c248efa91c8489a37f8973f9acbb2324e4fac62b14cdaee08990bb16b5530cf7c6e8c521cff2
+  data.tar.gz: 5c19f5a7b5a05715d2967ea03104b3f3a7649d09bb7bac3476ea4d018707779f4f9ebd533ba8529fcb6e7ada69375a403aee9ec86017dbfdbc7c1d1eb719b1a9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/lib/unnatural/fast_compare.so

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+matrix:
+  include:
+    - rvm: jruby
+      env: JRUBY_OPTS='-Xcompat.version=2.0'
+before_install:
+  - if [ "jruby" != "$TRAVIS_RUBY_VERSION"  ]; then gem install bundler; fi

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bjmllr@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unnatural.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ben Miller
+
+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,134 @@
+# Unnatural
+
+[![Gem Version](https://badge.fury.io/rb/unnatural.svg)](https://rubygems.org/gems/unnatural)
+[![Build Status](https://travis-ci.org/bjmllr/unnatural.svg)](https://travis-ci.org/bjmllr/unnatural)
+
+A natural sort for Ruby.
+
+Unnatural defines a natural sort as one where:
+
+1. comparison is case-insensitive
+2. consecutive sequences of digits are compared according to their numeric value (not their ascii values)
+
+Unnatural does not (currently) provide support for:
+
+1. non-ASCII-compatible encoding
+2. any number representation other than simple decimal integers
+3. whitespace insensitivity (i.e., one space and two spaces can be considered as different)
+
+Unnatural provides four algorithms, all of which use Ruby's built-in quicksort as the fundamental sort algorithm. All four modules provide module methods `.sort` for simply sorting an enumerable, and `.compare` for spaceship-operator-style comparison.
+
+### Unnatural::Fast
+
+Compares strings byte-by-byte. Comparison function implemented in C. Much faster than any of the pure Ruby options. The default, except on JRuby. Not available on JRuby.
+
+### Unnatural::Scan
+
+Compares strings using a `StringScanner`. Pure ruby. Tends to be outperformed by `Unnatural::Substitution` and `Unnatural::Split` when sorting short strings via the global sort function, but its comparison function is the fastest of the pure-ruby algorithms.
+
+### Unnatural::Split
+
+Compares strings by spliting them into arrays of alternating string and integer values. Pure Ruby. Tends to be outperformed by the others.
+
+### Unnatural::Substitution
+
+Compares strings by zero-padding integer sequences such that all are the same length. Pure Ruby. Tends to be outperformed by `Unnatural::Scan` on longer strings. The default on JRuby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unnatural'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unnatural
+
+## Usage
+
+Sorting an enumerable of strings:
+
+```ruby
+require 'unnatural'
+sorted = Unnatural.sort(some_array_of_strings)
+```
+
+Defining the comparison method for a class explicitly:
+
+```ruby
+require 'unnatural'
+
+class User
+  def <=>(other)
+    Unnatural.compare(name, other.name)
+  end
+end
+```
+
+Or by defining `#to_str` and using Unnatural as a mix-in:
+
+```ruby
+# this is equivalent to the last example
+
+class User
+  include Unnatural
+
+  def to_str
+    name
+  end
+end
+```
+
+The default can be changed throughout an application:
+
+```ruby
+# use Scan instead of Fast
+# (or, if on JRruby, use Scan instead of Substitution)
+Unnatural.algorithm = Unnatural::Scan
+```
+
+Or you can use the `.compare` and `.sort` functions for an algorithm's module directly:
+
+```ruby
+sorted_short_strings = Unnatural::Substitution.sort(some_short_strings)
+sorted_long_strings = Unnatural::Scan.sort(some_long_strings)
+
+class User
+  def <=>(other)
+    Unnatural::Scan.compare(name, other.name)
+  end
+end
+```
+
+## See Also
+
+There are two other natural sort gems:
+
+https://github.com/dogweather/naturally
+
+https://github.com/johnnyshields/naturalsort
+
+Unnatural took test cases from each one.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bjmllr/unnatural. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rake/extensiontask'
+spec = Gem::Specification.load('unnatural.gemspec')
+Rake::ExtensionTask.new do |ext|
+  ext.name = 'fast_compare'
+  ext.ext_dir = 'ext/unnatural'
+  ext.lib_dir = 'lib/unnatural'
+  ext.gem_spec = spec
+end
+
+task :benchmark do
+  require './test/benchmark.rb'
+end
+
+if RUBY_ENGINE == 'jruby'
+  task default: :test
+else
+  task default: [:compile, :test]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'unnatural'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/unnatural/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+extension_name = 'unnatural/fast_compare'
+dir_config(extension_name)
+create_makefile(extension_name)

data/ext/unnatural/fast_compare.c

@@ -0,0 +1,66 @@
+#include <ruby.h>
+
+static VALUE rb_mUnnatural;
+static VALUE rb_mFast;
+
+#define DIGIT_TO_I(C) (C - '0')
+#define IS_DIGIT(C) ('0' <= C && C <= '9')
+#define IS_LOWER(C) ('a' <= C && C <= 'z')
+#define UPCASE(C)   (IS_LOWER(C) ? C - ('a' - 'A') : C)
+
+VALUE compare(VALUE self, VALUE a_value, VALUE b_value) {
+  int a_length = RSTRING_LEN(a_value);
+  int b_length = RSTRING_LEN(b_value);
+  char* a_str = RSTRING_PTR(a_value);
+  char* b_str = RSTRING_PTR(b_value);
+  int a_pos = 0;
+  int b_pos = 0;
+  int a_number = 0;
+  int b_number = 0;
+  char a, b;
+  int diff = 0;
+
+  for (a_pos = 0, b_pos = 0; a_pos < a_length && b_pos < b_length; a_pos++, b_pos++) {
+    a = a_str[a_pos];
+    b = b_str[b_pos];
+
+    if ( IS_DIGIT(a) && !IS_DIGIT(b)) return INT2FIX(-1);
+    if (!IS_DIGIT(a) &&  IS_DIGIT(b)) return INT2FIX(+1);
+
+    if (IS_DIGIT(a) && IS_DIGIT(b)) {
+      while (IS_DIGIT(a)) {
+        a_number = a_number * 10 + DIGIT_TO_I(a);
+        a_pos++;
+        a = a_str[a_pos];
+      }
+
+      while (IS_DIGIT(b)) {
+        b_number = b_number * 10 + DIGIT_TO_I(b);
+        b_pos++;
+        b = b_str[b_pos];
+      }
+
+      diff = a_number - b_number;
+      if (diff != 0) return INT2FIX(diff);
+
+      a_number = 0;
+      b_number = 0;
+      a_pos--;
+      b_pos--;
+    } else {
+      diff = UPCASE(a) - UPCASE(b);
+      if (diff != 0) return INT2FIX(diff);
+    }
+  }
+
+  diff = a_length - b_length;
+  if (diff != 0) return INT2FIX(diff);
+
+  return INT2FIX(0);
+}
+
+void Init_fast_compare() {
+  rb_mUnnatural = rb_define_module("Unnatural");
+  rb_mFast = rb_define_module_under(rb_mUnnatural, "Fast");
+  rb_define_singleton_method(rb_mFast, "compare", compare, 2);
+}

data/lib/unnatural.rb

@@ -0,0 +1,36 @@
+require 'unnatural/version'
+
+module Unnatural
+  def self.algorithms
+    [:Substitution, :Split, :Scan, :Fast]
+      .select { |name| const_defined?(name) }
+      .map { |name| const_get(name) }
+  end
+
+  def self.algorithm
+    @algorithm
+  end
+
+  def self.algorithm=(mod)
+    @algorithm = mod
+  end
+
+  def self.sort(enumerable)
+    @algorithm.sort(enumerable)
+  end
+
+  def self.compare(a, b)
+    @algorithm.compare(a, b)
+  end
+
+  def <=>(other)
+    Unnatural.compare(to_str, other.to_str)
+  end
+end
+
+require 'unnatural/fast'
+
+Unnatural.algorithm ||= begin
+                          require 'unnatural/substitution'
+                          Unnatural::Substitution
+                        end

data/lib/unnatural/fast.rb

@@ -0,0 +1,13 @@
+unless RUBY_ENGINE == 'jruby'
+  require 'unnatural/fast_compare'
+
+  module Unnatural
+    module Fast
+      def self.sort(enumerable)
+        enumerable.sort { |a, b| compare(a, b) }
+      end
+    end
+  end
+
+  Unnatural.algorithm ||= Unnatural::Fast
+end

data/lib/unnatural/scan.rb

@@ -0,0 +1,48 @@
+require 'strscan'
+
+module Unnatural
+  module Scan
+    def self.sort(enumerable)
+      enumerable.sort { |a, b| compare(a, b) }
+    end
+
+    def self.compare(a_string, b_string)
+      a = StringScanner.new(a_string)
+      b = StringScanner.new(b_string)
+
+      loop do
+        a_number = a.scan(/\d+/)
+        b_number = b.scan(/\d+/)
+
+        if a_number.nil? && b_number.nil?
+        # move on
+        elsif a_number.nil?
+          return +1
+        elsif b_number.nil?
+          return -1
+        else
+          compare = a_number.to_i <=> b_number.to_i
+          return compare unless compare == 0
+        end
+
+        a_segment = a.scan(/\D+/)
+        b_segment = b.scan(/\D+/)
+
+        if a_segment.nil? && b_segment.nil?
+        # move on
+        elsif a_segment.nil?
+          return -1
+        elsif b_segment.nil?
+          return +1
+        else
+          compare = a_segment.casecmp(b_segment)
+          return compare unless compare == 0
+        end
+
+        return 0 if a.eos? && b.eos?
+        return -1 if a.eos?
+        return +1 if b.eos?
+      end
+    end
+  end
+end

data/lib/unnatural/split.rb

@@ -0,0 +1,20 @@
+module Unnatural
+  module Split
+    SPLITTER = /(?<=\d)(?=\D)|(?<=\D)(?=\d)/
+    PRED = ['0'.ord.pred.chr].freeze
+
+    def self.sort(enumerable)
+      enumerable.sort_by { |s| split(s) }
+    end
+
+    def self.compare(a, b)
+      split(a) <=> split(b)
+    end
+
+    def self.split(string)
+      array = string.downcase.split(SPLITTER)
+      array = PRED + array if ('0'..'9').cover?(array[0])
+      array.map.with_index { |e, i| i.odd? ? e.to_i : e }
+    end
+  end
+end

data/lib/unnatural/substitution.rb

@@ -0,0 +1,20 @@
+module Unnatural
+  module Substitution
+    def self.sort(enumerable)
+      largest = enumerable.map(&:size).max
+      enumerable.sort_by { |s| substitute(s, largest) }
+    end
+
+    def self.compare(a, b)
+      largest = a.size < b.size ? b.size : a.size
+      substitute(a, largest) <=> substitute(b, largest)
+    end
+
+    def self.substitute(string, size)
+      format_string = "%0#{size}d"
+      string.downcase.gsub(/\d+/) do |m|
+        format(format_string, m.gsub(/^0+(?=[1-9])/, ''))
+      end
+    end
+  end
+end

data/lib/unnatural/version.rb

@@ -0,0 +1,3 @@
+module Unnatural
+  VERSION = '0.1.0'.freeze
+end

data/unnatural.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unnatural/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'unnatural'
+  spec.version       = Unnatural::VERSION
+  spec.authors       = ['Ben Miller']
+  spec.email         = ['bjmllr@gmail.com']
+
+  spec.summary       = 'A natural sort.'
+  spec.description   = 'A natural sort implementation with an emphasis on speed.'
+  spec.homepage      = 'https://github.com/bjmllr/unnatural'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  unless RUBY_ENGINE == 'jruby'
+    spec.extensions << 'ext/unnatural/extconf.rb'
+  end
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler', '~>0.9'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'benchmark-ips'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: unnatural
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Miller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A natural sort implementation with an emphasis on speed.
+email:
+- bjmllr@gmail.com
+executables: []
+extensions:
+- ext/unnatural/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/unnatural/extconf.rb
+- ext/unnatural/fast_compare.c
+- lib/unnatural.rb
+- lib/unnatural/fast.rb
+- lib/unnatural/scan.rb
+- lib/unnatural/split.rb
+- lib/unnatural/substitution.rb
+- lib/unnatural/version.rb
+- unnatural.gemspec
+homepage: https://github.com/bjmllr/unnatural
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A natural sort.
+test_files: []