naturally 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71953ca154c0b7db095ccc5f8f877afed7142eb0bcf59a5118779ba2c8f79aa1
-  data.tar.gz: 302ae86df325c4e526e1b8158dc669c497b27ae9b5ffe60d32bdcb206285eb46
+  metadata.gz: 9438825196cf2910c3580ac61f37ff9a38faa29df8c113268ccf2835ecc0736b
+  data.tar.gz: 7ea180458e34813435963b22fbed22e68a28c0d8ff025bf471116dc576e5eb88
 SHA512:
-  metadata.gz: c7f607e695090c2d12a67b1410960312fbc4d9b7d046f1dea91513653fd00da13e01ebf92c1405efdb498a32029baae4733ddd022cee78becf67db7b4988bedd
-  data.tar.gz: 3110d73168c9797628ad7490e1713785921abbce1651d54e9d8e1e2c6e2c65d9e5cbf77ad1c8b693ac49d2d4a7741ffb1198480f17a1f4b1fa9af2ca264d4c5f
+  metadata.gz: f74680fdecc119d32b2ad624f819972086961dd9d394b86f5f0897ec414a0fa12d1eec9902c0a207106423a011f7fedf8f277c90f91ffb053c2afeaa952925cc
+  data.tar.gz: f5f5979bb76c14ed2e5494043090d091eb17b5684930006291dfe7fb19c43544b629c0f84ec003d412c20e540075b7100f51309fd2c6113fb99f38f34bfa20ba

data/.travis.yml

@@ -2,3 +2,5 @@ language: ruby
 rvm:
   - 2.4
   - 2.5
+  - 2.6
+  - 2.7

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.3.0] - 2025-06-11
+
+### Added
+- New `#sort_filenames` method for sorting filenames with underscores and dots as separators
+- Dots are given higher priority than underscores in filename sorting
+- Comprehensive test coverage for filename sorting scenarios
+
+### Changed
+- Updated README with documentation and examples for the new `#sort_filenames` method
+
+## [2.2.2] - Previous Release
+
+### Notes
+- Previous stable release
+- Included support for natural sorting with legal numbering, course codes, and Unicode
+- Maintained compatibility with Ruby 2.0+
+
+## Historical Releases
+
+For releases prior to 2.2.2, please refer to the git commit history.
+
+---
+
+**Note**: This changelog was introduced in version 2.3.0. Future releases will document all changes here.

data/README.md

@@ -1,9 +1,13 @@
 # Naturally
-[![Gem Version](https://badge.fury.io/rb/naturally.png)](http://badge.fury.io/rb/naturally) [![Build Status](https://travis-ci.org/public-law/naturally.png)](https://travis-ci.org/public-law/naturally) 
-[![Maintainability](https://api.codeclimate.com/v1/badges/0ebf4ef97723f2622105/maintainability)](https://codeclimate.com/github/dogweather/naturally/maintainability)
+[![Gem Version](https://badge.fury.io/rb/naturally.svg)](https://badge.fury.io/rb/naturally)
 
-Natural ("version number") sorting with support for **legal document numbering**, **college course codes**, and **Unicode**.
-See Jeff Atwood's [Sorting for Humans: Natural Sort Order](http://www.codinghorror.com/blog/2007/12/sorting-for-humans-natural-sort-order.html) and the Public.Law post [Counting to 10 in Californian](https://blog.public.law/2012/08/07/counting-from-1-to-10-in-californian/).
+Natural ("version number") sorting with support for:
+
+* **legal document numbering**,
+* **college course codes**, and
+* **Unicode**.
+
+See Jeff Atwood's [Sorting for Humans: Natural Sort Order](https://blog.codinghorror.com/sorting-for-humans-natural-sort-order/) and my post [Counting to 10 in Californian](https://blog.public.law/2012/08/07/counting-from-1-to-10-in-californian/).
 
 ## Installation
 
@@ -41,7 +45,7 @@ releases = [
 ]
 
 # Sort by version number
-sorted = Naturally.sort releases, by: :version
+sorted = Naturally.sort(releases, by: :version)
 
 # Check what we have
 expect(sorted.map(&:name)).to eq [
@@ -54,7 +58,40 @@ expect(sorted.map(&:name)).to eq [
 ]
 ```
 
-[More examples are in the specs](https://github.com/dogweather/naturally/blob/master/spec/naturally_spec.rb).
+[More examples are in the specs](https://github.com/public-law/naturally/blob/master/spec/naturally_spec.rb).
+
+
+## `#sort_filenames`
+
+Sorts filenames naturally, treating underscores and dots as separators. Useful for sorting files like images or documents that use numbers, underscores, and dots in their names.
+
+```ruby
+files = [
+  'abc_2.tif',
+  'abc_1_a.tif',
+  'abc_1.zzz',
+  'abc_1_xyz.abc',
+  'abc_2a.tif',
+  'abc.2.tif',
+  'abc.1_a.tif',
+  'abc_2.abc',
+  'abc_1_xyz.abc'
+]
+Naturally.sort_filenames(files)
+# => [
+#   "abc.1_a.tif",
+#   "abc.2.tif",
+#   "abc_1.zzz",
+#   "abc_1_a.tif",
+#   "abc_1_xyz.abc",
+#   "abc_1_xyz.abc",
+#   "abc_2.abc",
+#   "abc_2.tif",
+#   "abc_2a.tif"
+# ]
+```
+
+This method gives higher priority to dots than underscores, so files like `abc.1_a.tif` will come before `abc.2.tif`.
 
 
 ## Implementation Notes

data/lib/naturally/version.rb

@@ -1,4 +1,4 @@
 module Naturally
   # Gem version
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/lib/naturally.rb

@@ -49,6 +49,16 @@ module Naturally
     tokens.map { |t| Segment.new(t) }
   end
 
+  # Natural sort for filenames, treating underscores and dots as separators.
+  # Dots are given higher priority by inserting a '0' segment, as in user workaround.
+  # See Issue #24.
+  def self.sort_filenames(array)
+    array.sort_by do |filename|
+      # Replace '.' with '.0.' to give dot higher priority, then split on dot or underscore
+      filename.to_s.gsub('.', '.0.').split(/[\._]/).map { |t| Segment.new(t) }
+    end
+  end
+
   private
   # Sort an array of objects "naturally", yielding each object
   # to the block to obtain the sort key.

data/naturally.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["robb@public.law"]
   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, course numbers, and other number/letter mixes.}
-  gem.homepage      = "http://github.com/dogweather/naturally"
+  gem.homepage      = "http://github.com/public-law/naturally"
   gem.required_ruby_version = '>= 2.0'
 
   gem.files         = `git ls-files`.split($/)

data/spec/naturally_spec.rb

@@ -208,4 +208,16 @@ describe Naturally do
       ]
     end
   end
+
+  describe '#sort_filenames' do
+    it 'sorts filenames with underscores and dots as separators' do
+      expect(Naturally.sort_filenames(['abc_2.tif', 'abc_1_a.tif'])).to eq(["abc_1_a.tif", "abc_2.tif"])
+      expect(Naturally.sort_filenames(['abc_1.zzz', 'abc_1_xyz.abc'])).to eq(["abc_1.zzz", "abc_1_xyz.abc"])
+      expect(Naturally.sort_filenames(['abc_2a.tif', 'abc_1_a.tif'])).to eq(["abc_1_a.tif", "abc_2a.tif"])
+      expect(Naturally.sort_filenames(['abc.2.tif', 'abc.1_a.tif'])).to eq(["abc.1_a.tif", "abc.2.tif"])
+      expect(Naturally.sort_filenames(['abc_2.tif', 'abc_1.tif'])).to eq(["abc_1.tif", "abc_2.tif"])
+      expect(Naturally.sort_filenames(['abc_2.tif', 'abc_1_a.tif'])).to eq(["abc_1_a.tif", "abc_2.tif"])
+      expect(Naturally.sort_filenames(['abc_2.abc', 'abc_1_xyz.abc'])).to eq(["abc_1_xyz.abc", "abc_2.abc"])
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: naturally
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Robb Shecter
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Natural Sorting with support for legal numbering, course numbers, and
   other number/letter mixes.
@@ -20,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -29,11 +29,10 @@ files:
 - lib/naturally/version.rb
 - naturally.gemspec
 - spec/naturally_spec.rb
-homepage: http://github.com/dogweather/naturally
+homepage: http://github.com/public-law/naturally
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -48,8 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Sorts numbers according to the way people are used to seeing them.
 test_files: