unnatural 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9634e4ac888d2b64eb49af87a89cd124569a56bf
-  data.tar.gz: 65f819eddbaf0d32983aac0b874b506de6211112
+SHA256:
+  metadata.gz: d30faac6de21215a8cb100e0621352ee6322e9559929b50c497aaa0c3a949765
+  data.tar.gz: 2faa48bf01a8117b96d150f62b00c8a9213cfb0210607dcefd8ded4bb5bb9ff9
 SHA512:
-  metadata.gz: 6b10ba4248e41c4295b8fb6117adbb7a1038e8f3812fceba905097fc17c58a32dae3b23d1704498aea796c06a21ce7c99e1e95fe26c7f73f9a7b4bd5bf0acaf8
-  data.tar.gz: 80c87c122827309aeb58c611cead2674052b577d33799e2301f97a3311ce1fc8a1e4b42c6920dcd38af99c4fa61e4a6af5d540b72ef2929b69224999518dc479
+  metadata.gz: be87f01ba42c62c779f5d77a2e86d252ef92d0e42a84d579f3b5462d051db55f502b84d01fce2ff3948f529e8e078a0a1a667e2d45b1304c55773bab1513c62d
+  data.tar.gz: d10fe9672a0402a334aeb9211c5963657388bd085657ef39f26d3aef5e444e6dcc3ff6f3a054959f874828970bf1f97da3e17f4484f8cc58cada814345dfdd79

data/.github/workflows/ruby.yml

@@ -0,0 +1,40 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+        - '2.1'
+        - '2.2'
+        - '2.3'
+        - '2.4'
+        - '2.5'
+        - '2.6'
+        - '2.7'
+        - '3.0'
+        - '3.1'
+        - jruby-9.1.17.0
+        - jruby-9.2.21.0
+        - jruby-9.3.6.0
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      # https://github.com/ruby/setup-ruby#versioning
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

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/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.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

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/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,7 @@ Gem::Specification.new do |spec|
   spec.extensions = ['ext/unnatural/Rakefile']
 
   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'
+  spec.add_development_dependency 'minitest', '~> 5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unnatural
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Miller
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-27 00:00:00.000000000 Z
+date: 2022-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-compiler
@@ -25,33 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +52,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
@@ -88,8 +60,9 @@ extensions:
 - ext/unnatural/Rakefile
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -110,7 +83,7 @@ homepage: https://github.com/bjmllr/unnatural
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,9 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A natural sort.
 test_files: []

data/.travis.yml

@@ -1,13 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
-  - jruby-1.7.20
-  - jruby-9.0.5.0
-before_install:
-  - gem install bundler
-cache:
-  - apt
-  - bundler