unnatural 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e73154b350d906339b8003056791db6c5f94e098
-  data.tar.gz: ed95cd6dee1227b8f55cce433998685fd1b2c4bb
+  metadata.gz: 9634e4ac888d2b64eb49af87a89cd124569a56bf
+  data.tar.gz: 65f819eddbaf0d32983aac0b874b506de6211112
 SHA512:
-  metadata.gz: d0c8774280f8fdba7f71b1b39bbe63b6558a9a1b4659807b33a7c8b4acbb0c441739184e9155e0b440479fa29981403aad18bf3fc983eaca01c5d2e4fc1c5426
-  data.tar.gz: 96c913547575eb192399c6074237748c3defb54032fc0f5d4f3644293ba24a81c846e91589398ac09c1b6e19ad575284e2dc57c96327c1795fc02ca27e4beae8
+  metadata.gz: 6b10ba4248e41c4295b8fb6117adbb7a1038e8f3812fceba905097fc17c58a32dae3b23d1704498aea796c06a21ce7c99e1e95fe26c7f73f9a7b4bd5bf0acaf8
+  data.tar.gz: 80c87c122827309aeb58c611cead2674052b577d33799e2301f97a3311ce1fc8a1e4b42c6920dcd38af99c4fa61e4a6af5d540b72ef2929b69224999518dc479

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-/lib/unnatural/fast_compare.so
+*.so
+*.o

data/.travis.yml

@@ -1,13 +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'
+  - jruby-1.7.20
+  - jruby-9.0.5.0
 before_install:
-  - if [ "jruby" != "$TRAVIS_RUBY_VERSION"  ]; then gem install bundler; fi
+  - gem install bundler
+cache:
+  - apt
+  - bundler

data/README.md

@@ -12,7 +12,7 @@ Unnatural defines a natural sort as one where:
 
 Unnatural does not (currently) provide support for:
 
-1. non-ASCII-compatible encoding
+1. non-ASCII-compatible encoding (although the pure ruby comparison functions seem to work)
 2. any number representation other than simple decimal integers
 3. whitespace insensitivity (i.e., one space and two spaces can be considered as different)
 
@@ -20,7 +20,7 @@ Unnatural provides four algorithms, all of which use Ruby's built-in quicksort a
 
 ### 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.
+Compares strings byte-by-byte. Comparison function implemented in C. Does not appear to sort unicode strings correctly. Much faster than any of the pure Ruby options. The default.
 
 ### Unnatural::Scan
 
@@ -32,7 +32,7 @@ Compares strings by spliting them into arrays of alternating string and integer
 
 ### 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.
+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. Recommended for sorting short unicode strings.
 
 ## Installation
 
@@ -96,7 +96,6 @@ 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
 ```
 

data/Rakefile

@@ -1,27 +1,27 @@
+require 'bundler/setup'
 require 'bundler/gem_tasks'
+
 require 'rake/testtask'
 
+require 'rake'
+require 'rake/clean'
+
+require 'ffi'
+require 'ffi-compiler/compile_task'
+
+CLEAN.include('ext/unnatural/*{.o,.log,.so,.bundle}')
+CLEAN.include('lib/**/*{.o,.log,.so,.bundle}')
+
 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
+desc 'FFI compiler'
+namespace 'ffi-compiler' do
+  FFI::Compiler::CompileTask.new('ext/unnatural/unnatural_ext')
 end
+task compile_ffi: ['ffi-compiler:default']
 
-task :benchmark do
-  require './test/benchmark.rb'
-end
-
-if RUBY_ENGINE == 'jruby'
-  task default: :test
-else
-  task default: [:compile, :test]
-end
+task default: [:clean, :compile_ffi, :test]

data/ext/unnatural/Rakefile

@@ -0,0 +1,3 @@
+require 'ffi-compiler/compile_task'
+
+FFI::Compiler::CompileTask.new('unnatural_ext')

data/ext/unnatural/unnatural_ext.c

@@ -0,0 +1,48 @@
+#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)
+
+int compare(char* a_str, int a_length, char* b_str, int b_length) {
+  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 -1;
+    if (!IS_DIGIT(a) &&  IS_DIGIT(b)) return +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 diff;
+
+      a_number = 0;
+      b_number = 0;
+      a_pos--;
+      b_pos--;
+    } else {
+      diff = UPCASE(a) - UPCASE(b);
+      if (diff != 0) return diff;
+    }
+  }
+
+  return a_length - b_length;
+}

data/lib/unnatural/fast.rb

@@ -1,21 +1,30 @@
-unless RUBY_ENGINE == 'jruby'
-  require 'unnatural/fast_compare'
+require 'ffi'
+require 'ffi-compiler/loader'
 
-  module Unnatural
-    module Fast
-      def self.sort(enumerable)
-        enumerable.sort { |a, b| compare(a, b) }
-      end
+module Unnatural
+  module Fast
+    module Ext
+      extend FFI::Library
+      ffi_lib FFI::Compiler::Loader.find('unnatural_ext')
+      attach_function :compare, [:string, :int, :string, :int], :int
+    end
 
-      def self.sort_by(enumerable)
-        raise ArgumentError, "Block expected but none given" unless block_given?
-        enumerable
-          .map { |e| [(yield e), e] }
-          .sort { |a, b| compare(a, b) }
-          .map { |ary| ary[1] }
-      end
+    def self.compare(a, b)
+      Ext.compare(a, a.size, b, b.size)
+    end
+
+    def self.sort(enumerable)
+      enumerable.sort { |a, b| compare(a, b) }
     end
-  end
 
-  Unnatural.algorithm ||= Unnatural::Fast
+    def self.sort_by(enumerable)
+      raise ArgumentError, 'Block expected but none given' unless block_given?
+      enumerable
+        .map { |e| [(yield e), e] }
+        .sort { |a, b| compare(a.first, b.first) }
+        .map { |ary| ary[1] }
+    end
+  end
 end
+
+Unnatural.algorithm ||= Unnatural::Fast

data/lib/unnatural/version.rb

@@ -1,3 +1,3 @@
 module Unnatural
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/unnatural.gemspec

@@ -14,18 +14,17 @@ Gem::Specification.new do |spec|
   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.files         = `git ls-files -z`.split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files        += Dir.glob('ext/unnatural/*')
   spec.require_paths = ['lib']
 
-  unless RUBY_ENGINE == 'jruby'
-    spec.extensions << 'ext/unnatural/extconf.rb'
-  end
+  spec.extensions = ['ext/unnatural/Rakefile']
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rake-compiler', '~>0.9'
+  spec.add_dependency 'ffi-compiler', '~> 1.0'
+  spec.add_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'benchmark-ips'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: unnatural
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Miller
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ffi-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ email:
 - bjmllr@gmail.com
 executables: []
 extensions:
-- ext/unnatural/extconf.rb
+- ext/unnatural/Rakefile
 extra_rdoc_files: []
 files:
 - ".gitignore"
@@ -97,8 +97,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- ext/unnatural/extconf.rb
-- ext/unnatural/fast_compare.c
+- ext/unnatural/Rakefile
+- ext/unnatural/unnatural_ext.c
 - lib/unnatural.rb
 - lib/unnatural/fast.rb
 - lib/unnatural/scan.rb

data/ext/unnatural/extconf.rb

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

data/ext/unnatural/fast_compare.c

@@ -1,77 +0,0 @@
-#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_arg, VALUE b_arg) {
-  VALUE a_value, b_value;
-  int a_length, b_length, a_pos, b_pos, a_number, b_number, diff;
-  char *a_str, *b_str, a, b;
-
-  if (RB_TYPE_P(a_arg, T_ARRAY)) {
-    a_value = rb_ary_entry(a_arg, 0);
-    b_value = rb_ary_entry(b_arg, 0);
-  } else {
-    a_value = a_arg;
-    b_value = b_arg;
-  }
-
-  a_length = RSTRING_LEN(a_value);
-  b_length = RSTRING_LEN(b_value);
-  a_str = RSTRING_PTR(a_value);
-  b_str = RSTRING_PTR(b_value);
-  a_pos = 0;
-  b_pos = 0;
-  a_number = 0;
-  b_number = 0;
-  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);
-}