unnatural 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 68ba2d1865588727050d496fb3b7a31ae0126504
-  data.tar.gz: 41df26e3c57b30782f1345df7d6b99c5cd1b0ab0
+SHA256:
+  metadata.gz: b3edc05b3b279add39a0b54112548568dc9a1ff96d77936737f57978912636ee
+  data.tar.gz: ce84b14bb28120e5806a1f370c05575ec949785fcaf3f80ffbe605d813021d3a
 SHA512:
-  metadata.gz: 49584ebd21ac6054f4b6b04ebd8012116bebc94bdee2b2205fc2e8e0ed4f2bba1a04d901775fa35c5280fa37166da6b5a47b88454bf249ad00c2b2680983b35a
-  data.tar.gz: 0fd83bc665b23760335b9da7894d13a29289bd27df96c4f05aefac0f6e762873b27f44d07d293e1d3fc40ccade012071dfe9c07b4d732bbd14b2c27e4a8f45f4
+  metadata.gz: 02c2352f379dca9e31acfe4b9f8194d47de3571bf72ad69f60a87f12b6fdc3ea16152fff533282e386235e8a88e4c1c01c06b685301dd77c7439a081b53477b0
+  data.tar.gz: 4ce0601e48bf2854be2c08e554258e5fca14b6ecc167a6f3da8c0dde6adde410ff8e4dd9c1e352ef1941939862f01c4f19b5b84b664329003e9234427d2de401

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - a
+    - b
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/SymbolArray:
+  EnforcedStyle: brackets

data/.travis.yml

@@ -4,8 +4,9 @@ rvm:
   - 2.1.10
   - 2.2.5
   - 2.3.1
-  - jruby-1.7.20
+  - jruby-1.7.27
   - jruby-9.0.5.0
+  - jruby-9.1.16.0
 before_install:
   - gem install bundler
 cache:

data/lib/unnatural.rb

@@ -1,5 +1,6 @@
 require 'unnatural/version'
 
+# A natural sort.
 module Unnatural
   def self.algorithms
     [:Substitution, :Split, :Scan, :Fast]
@@ -20,7 +21,7 @@ module Unnatural
   end
 
   def self.sort_by(enumerable)
-    raise ArgumentError, "Block expected but none given" unless block_given?
+    raise ArgumentError, 'Block expected but none given' unless block_given?
     @algorithm.sort_by(enumerable) { |*a| yield(*a) }
   end
 

data/lib/unnatural/fast.rb

@@ -2,7 +2,11 @@ require 'ffi'
 require 'ffi-compiler/loader'
 
 module Unnatural
+  # 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.
   module Fast
+    # module to hold the C function
     module Ext
       extend FFI::Library
       ffi_lib FFI::Compiler::Loader.find('unnatural_ext')

data/lib/unnatural/scan.rb

@@ -1,19 +1,27 @@
 require 'strscan'
 
 module Unnatural
+  # 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.
   module Scan
     def self.sort(enumerable)
       enumerable.sort { |a, b| compare(a, b) }
     end
 
     def self.sort_by(enumerable)
-      raise ArgumentError, "Block expected but none given" unless block_given?
+      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
 
+    # rubocop: disable Metrics/AbcSize
+    # rubocop: disable Metrics/CyclomaticComplexity
+    # rubocop: disable Metrics/MethodLength
+    # rubocop: disable Metrics/PerceivedComplexity
     def self.compare(a_string, b_string)
       if a_string.is_a?(Array) && b_string.is_a?(Array)
         a_string = a_string.first
@@ -57,5 +65,9 @@ module Unnatural
         return +1 if b.eos?
       end
     end
+    # rubocop: enable Metrics/AbcSize
+    # rubocop: enable Metrics/CyclomaticComplexity
+    # rubocop: enable Metrics/MethodLength
+    # rubocop: enable Metrics/PerceivedComplexity
   end
 end

data/lib/unnatural/split.rb

@@ -1,4 +1,6 @@
 module Unnatural
+  # Compares strings by spliting them into arrays of alternating string and
+  # integer values. Pure Ruby. Tends to be outperformed by the others.
   module Split
     SPLITTER = /(?<=\d)(?=\D)|(?<=\D)(?=\d)/
     PRED = ['0'.ord.pred.chr].freeze
@@ -8,7 +10,7 @@ module Unnatural
     end
 
     def self.sort_by(enumerable)
-      raise ArgumentError, "Block expected but none given" unless block_given?
+      raise ArgumentError, 'Block expected but none given' unless block_given?
       enumerable.sort_by { |s| split(yield s) }
     end
 

data/lib/unnatural/substitution.rb

@@ -1,4 +1,7 @@
 module Unnatural
+  # 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.
   module Substitution
     def self.sort(enumerable)
       largest = enumerable.map(&:size).max
@@ -6,7 +9,7 @@ module Unnatural
     end
 
     def self.sort_by(enumerable)
-      raise ArgumentError, "Block expected but none given" unless block_given?
+      raise ArgumentError, 'Block expected but none given' unless block_given?
       largest = enumerable.map { |e| yield e }.map(&:size).max
       enumerable.sort_by { |s| substitute((yield s), largest) }
     end

data/lib/unnatural/version.rb

@@ -1,3 +1,3 @@
 module Unnatural
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.3.2'.freeze
 end

data/unnatural.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'unnatural/version'
@@ -10,11 +10,12 @@ Gem::Specification.new do |spec|
   spec.email         = ['bjmllr@gmail.com']
 
   spec.summary       = 'A natural sort.'
-  spec.description   = 'A natural sort implementation with an emphasis on speed.'
+  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")
+  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']
@@ -22,9 +23,8 @@ Gem::Specification.new do |spec|
   spec.extensions = ['ext/unnatural/Rakefile']
 
   spec.add_dependency 'ffi-compiler', '~> 1.0'
-  spec.add_dependency 'rake', '>= 9', '< 12'
 
+  spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'benchmark-ips'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unnatural
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Ben Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-27 00:00:00.000000000 Z
+date: 2018-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-compiler
@@ -25,25 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '9'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '12'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '9'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +66,6 @@ dependencies:
     - - "~>"
       - !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
@@ -95,6 +75,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -132,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A natural sort.