naturally 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6b9503d643f2bc2e137219f9572cff2e930a5565c55155d4204e2a77023f1b1
-  data.tar.gz: 8ba1b7379a6a5b13dc4487d8c2946e46484cc46853acf792ae0502e2debba830
+  metadata.gz: 9438825196cf2910c3580ac61f37ff9a38faa29df8c113268ccf2835ecc0736b
+  data.tar.gz: 7ea180458e34813435963b22fbed22e68a28c0d8ff025bf471116dc576e5eb88
 SHA512:
-  metadata.gz: e7a58a43c54c821703e9eedc9455a37433d7c80cca3ccb1eeaafed11f43e5095a48e11cebb0d421d1bf36116f73a336b3ad78b5ce904895becb739e36d8655a4
-  data.tar.gz: a78a9c67ed7267bdb77eb2f7cb5fd5de79b22fe8297aaf634b2f30370ad00c401f22ea7ee4cc5949f3439995ea57aed86f69badfe7400731c78da27110005349
+  metadata.gz: f74680fdecc119d32b2ad624f819972086961dd9d394b86f5f0897ec414a0fa12d1eec9902c0a207106423a011f7fedf8f277c90f91ffb053c2afeaa952925cc
+  data.tar.gz: f5f5979bb76c14ed2e5494043090d091eb17b5684930006291dfe7fb19c43544b629c0f84ec003d412c20e540075b7100f51309fd2c6113fb99f38f34bfa20ba

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

@@ -61,6 +61,39 @@ expect(sorted.map(&:name)).to eq [
 [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
 
 The algorithm capitalizes on Ruby's array comparison behavior:

data/lib/naturally/version.rb

@@ -1,4 +1,4 @@
 module Naturally
   # Gem version
-  VERSION = '2.2.2'
+  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/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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: naturally
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Robb Shecter
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md