renamr 1.0.15 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b39e4e5a0e8eb0a2858888181609bcdddfdc71ab315de810bb7c23b6fb626ff0
-  data.tar.gz: 40d581dd0b0351db79c896ced04446bf5cf5d2af0ec2ae186f044bb499b09cff
+  metadata.gz: aa2277535f12269fea504e41087d5d20d762ccec138969cac71f399fa845b0f2
+  data.tar.gz: 9eae0471d031870cc7a44586d5634b4f1e31464c1b573dd923e1bbb9207c7108
 SHA512:
-  metadata.gz: 03b888d15545d19a1e7ad552ebf416d51cf0d0c8dd3c11a547e2b07d467aa733bc64b888340aa7886136d1eadae811b2210db973f38e6c6f4301756c22daa83d
-  data.tar.gz: ad1d1388214aa414ee34fa7f73823f82ff240d31695453fb920f09a218aa8c144754b38f669c7b4f06f43735719e8b1433cb32447d5994a1528847abb01a4e34
+  metadata.gz: bfc1abe2a3672e9461e40fde27bc58d5d0b0a9f91fce0c37f77d7132adcdf2787914d8f5b2fccbde8da53425626743e627b329633f9435eda870cdf171cce0bf
+  data.tar.gz: '095378848bee64538adcc2979b54b75527643060ed226390c7dfb476be82b347e4fcb8ec35f52f8a2c1d508b343942173b8c4ca530086b9e7c1e4794c3a091e0'

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2020-2025 David Rabkin
+Copyright 2020-2026 David Rabkin
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
 

data/README.adoc

@@ -8,7 +8,6 @@
 :img-rake: https://github.com/rdavid/renamr/actions/workflows/rake.yml/badge.svg
 :img-rubocop: https://github.com/rdavid/renamr/actions/workflows/rubocop.yml/badge.svg
 :img-style: https://img.shields.io/badge/code_style-rubocop-brightgreen.svg
-:img-test: https://github.com/rdavid/renamr/actions/workflows/test.yml/badge.svg
 :url-cv: http://cv.rabkin.co.il
 :url-gem: https://badge.fury.io/rb/renamr
 :url-hoc: https://hitsofcode.com/view/github/rdavid/renamr?branch=master
@@ -18,7 +17,6 @@
 :url-rubocop: https://github.com/rdavid/renamr/actions/workflows/rubocop.yml
 :url-ruby: https://www.ruby-lang.org/en/documentation/installation
 :url-style: https://github.com/rubocop/rubocop
-:url-test: https://github.com/rdavid/renamr/actions/workflows/test.yml
 :url-vale: https://vale.sh
 :url-yamllint: https://github.com/adrienverge/yamllint
 
@@ -28,7 +26,6 @@ image:{img-rake}[rake,link={url-rake}]
 image:{img-rubocop}[rubocop,link={url-rubocop}]
 image:{img-gem}[gem version,link={url-gem}]
 image:{img-style}[code style,link={url-style}]
-image:{img-test}[test,link={url-test}]
 image:{img-hoc}[hits of code,link={url-hoc}]
 image:{img-license}[license,link={url-license}]
 
@@ -36,16 +33,17 @@ toc::[]
 
 == About
 
-`renamr` organizes file and directory names.
+`renamr` normalizes file and directory names.
+It rewrites them with lowercase English letters, digits, and hyphens in place
+of spaces and other symbols.
 
 == Installation
-The tool is designed to operate on macOS, GNU/Linux, Windows, and Unix-like
-operating systems.
-It is packaged as a Gem and requires Ruby version 3.2 or later.
-If you do not have the appropriate version on your platform, refer to
-{url-ruby}[Installing Ruby].
+The tool runs on macOS, GNU/Linux, and other Unix-like operating systems, as
+well as Windows.
+It is packaged as a Ruby gem and requires Ruby 3.2 or later.
+If your platform lacks a suitable Ruby, see {url-ruby}[Installing Ruby].
 
-Utilize this command for installing the package:
+Install the gem with:
 
 [,sh]
 ----
@@ -54,7 +52,7 @@ gem install renamr
 
 == Updating
 
-Utilize this command for updating the package:
+Update the gem with:
 
 [,sh]
 ----
@@ -66,17 +64,17 @@ gem update renamr
 [,sh]
 ----
 renamr [options]
-  -a, --act          Real renaming.
-  -r, --rec          Passes recursively.
-  -l, --lim          Limits name length.
-  -m, --mod          Prepends modification time.
-  -d, --dir dir      Directory to rename.
-  -s, --src src      A string to substitute.
-  -t, --dst dst      A string to replace to.
-  -w, --wid wid      Width of the table.
-  -p, --pre str,beg  A string to prepend to started from beg.
-  -c, --cut pos,len  Removes len symbols from pos.
-  -v, --version      Shows version.
+  -a, --act              Performs actual renaming.
+  -c, --cut pos,len      Removes len characters starting at pos.
+  -d, --dir dir          Directory to process.
+  -l, --lim              Limits file name length.
+  -m, --mod              Prepends file modification time.
+  -p, --prepend str,beg  Prepends a string.
+  -r, --rec              Processes directories recursively.
+  -s, --src src          String to replace.
+  -t, --dst dst          Replacement string.
+  -v, --version          Shows the version.
+  -w, --wid wid          Output table width.
 ----
 
 == Example
@@ -86,9 +84,12 @@ renamr [options]
 renamr -d <source>
 ----
 
-It renames all files in `source` by default pattern: 26 English letters, 10 numbers, minus for spaces and other symbols.
+This previews new names for all files in `source` using the default character
+set: the 26 English letters, 10 digits, and hyphens in place of spaces and
+other symbols.
+Adding `-a` performs the actual renaming.
 
 == License
 
-`renamr` is copyright {url-cv}[David Rabkin] and available under a
+`renamr` is copyright {url-cv}[David Rabkin] and is available under the
 {url-license}[Zero-Clause BSD license].

data/bin/renamr

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 #
-# This script renames files in given directory by specific rules.
+# Renames files in a directory using configured rules.
 
 require_relative '../lib/renamr'
 

data/lib/renamr/action.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 module Renamr
-  # An interface for actions implementation.
+  # Defines the interface for action implementations.
   class Action
     def do(src)
-      raise "Undefined method Action.do is called with #{src}."
+      raise "Action.do must be overridden, called with #{src}."
     end
 
     def set(src) end

data/lib/renamr/ascii_validator.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # Checks if the resulted string has only ASCII symbols.
+  # Checks whether the resulting string contains only ASCII characters.
   class ASCIIValidatorAction < Action
     def do(src)
       ascii = src.chars.select(&:ascii_only?).join
-      raise "String #{src} has non-ASCII symbols." if src != ascii
+      raise "String #{src} contains non-ASCII characters." if src != ascii
 
       src
     end

data/lib/renamr/auto_localization.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require 'i18n'
 require_relative 'action'
 
 module Renamr
-  # Automatic localization.
+  # Performs automatic localization using I18n transliteration.
   class AutoLocalizationAction < Action
     def initialize
-      super()
+      super
       I18n.config.available_locales = :en
     end
 

data/lib/renamr/char.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # All special symbols besides some (., &, $) are replaced by minus.
+  # Replaces special symbols with hyphens, except `.`, `&`, and `$`.
   class CharAction < Action
     SYM = ' (){},~–\'![]_#@=„“”"`—+‘’;·‡«»%…'.chars.to_set.freeze
 

data/lib/renamr/configurator.rb

@@ -1,57 +1,66 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require 'optparse'
 
 module Renamr
-  # Handles input parameters.
+  # Parses and validates command-line options.
   class Configurator
     DIC = [
-      ['-a', '--act',     'Real renaming.',              :act],
-      ['-r', '--rec',     'Passes recursively.',         :rec],
-      ['-l', '--lim',     'Limits name length.',         :lim],
-      ['-m', '--mod',     'Prepends modification time.', :mod],
-      ['-d', '--dir dir', 'Directory to rename.',        :dir],
-      ['-s', '--src src', 'A string to substitute.',     :src],
-      ['-t', '--dst dst', 'A string to replace to.',     :dst],
-      ['-w', '--wid wid', 'Width of the table.',         :wid]
+      ['-a', '--act',     'Performs actual renaming.',          :act],
+      ['-d', '--dir dir', 'Directory to process.',              :dir],
+      ['-l', '--lim',     'Limits file name length.',           :lim],
+      ['-m', '--mod',     'Prepends file modification time.',   :mod],
+      ['-r', '--rec',     'Processes directories recursively.', :rec],
+      ['-s', '--src src', 'String to replace.',                 :src],
+      ['-t', '--dst dst', 'Replacement string.',                :dst],
+      ['-w', '--wid wid', 'Output table width.',                :wid]
     ].freeze
 
+    def add_simple(opt, key)
+      f, p, d = DIC.find { |_, _, _, k| k == key }
+      opt.on(f, p, d) { |i| @options[key] = i }
+    end
+
     def add_cut(opt)
-      opt.on('-c', '--cut pos,len', Array, 'Removes symbols from pos.') do |l|
+      msg = 'Removes len characters starting at pos.'
+      opt.on('-c', '--cut pos,len', Array, msg) do |l|
         @options[:pos] = l[0]
         @options[:len] = l[1]
       end
     end
 
     def add_prepend(opt)
-      opt.on('-p', '--prepend str,beg', Array, 'Prepend a string.') do |l|
+      opt.on('-p', '--prepend str,beg', Array, 'Prepends a string.') do |l|
         @options[:pre] = l[0]
         @options[:beg] = l[1].nil? ? 0 : l[1].to_i
       end
     end
 
     def add_version(opt)
-      opt.on('-v', '--version', 'Show version.') do
+      opt.on('-v', '--version', 'Shows the version.') do
         puts "#{File.basename($PROGRAM_NAME)} #{VERSION} #{DATE}"
         exit
       end
     end
 
     def add(opt)
+      add_simple(opt, :act)
       add_cut(opt)
+      %i[dir lim mod].each { |k| add_simple(opt, k) }
       add_prepend(opt)
+      %i[rec src dst].each { |k| add_simple(opt, k) }
       add_version(opt)
+      add_simple(opt, :wid)
     end
 
     def initialize
       @options = {}
       OptionParser.new do |o|
         o.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options]."
-        DIC.each { |f, p, d, k| o.on(f, p, d) { |i| @options[k] = i } }
         add(o)
       end.parse!
       validate
@@ -65,7 +74,7 @@ module Renamr
 
         @options[:dir] = File.expand_path(dir)
       end
-      raise "Width of the table should exceeds 14 symbols: #{wid}." if wid < 15
+      raise "Table width must be at least 15 characters: #{wid}." if wid < 15
     end
 
     def act?
@@ -114,7 +123,8 @@ module Renamr
 
     def wid
       if @options[:wid].nil?
-        # Reads current terminal width.
+
+        # Reads the current terminal width.
         wid = `tput cols`
         wid.to_s.empty? ? 79 : wid.to_i
       else

data/lib/renamr/date.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require 'date'
 require_relative 'action'
 
 module Renamr
-  # Replaces any valid date, e.g. 2020-11-02 or 02-11-2020 with 20201102.
+  # Replaces valid dates (for example, 2020-11-02 or 02-11-2020) with 20201102.
   class DateAction < Action
     REG = /(\d+)-(\d+)-(\d+)/
     PAT = ['%m-%d-%Y', '%d-%m-%Y', '%Y-%m-%d', '%Y-%d-%m'].freeze
@@ -25,7 +25,7 @@ module Renamr
       PAT.each do |pat|
         return Date.strptime(sub, pat)
       rescue ArgumentError
-        # Nothing to do.
+        # Tries the next date pattern.
       end
       nil
     end

data/lib/renamr/downcase.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # All names should be downcased.
+  # Converts names to lowercase.
   class DowncaseAction < Action
     def do(src)
       src.downcase

data/lib/renamr/factory.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'ascii_validator'
@@ -21,15 +21,15 @@ require_relative 'trim'
 require_relative 'truncate'
 
 module Renamr
-  # Produces actions for certain directories.
+  # Builds an action pipeline for a directory.
   class ActionsFactory
-    LIMIT = 143 # Synology eCryptfs limitation.
+    LIMIT = 143 # Matches the Synology eCryptfs limitation.
 
     def initialize(cfg)
       @cfg = cfg
     end
 
-    def produce(dir) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def produce(dir) # rubocop:disable Metrics/AbcSize
       if @cfg.lim?
         [
           OmitAction.new(LIMIT),
@@ -37,7 +37,7 @@ module Renamr
         ]
       else
         [
-          PointAction.new(dir), # Should be the first.
+          PointAction.new(dir), # Runs first.
           @cfg.pos.nil? ? nil : RemoveAction.new(@cfg.pos, @cfg.len),
           @cfg.src.nil? ? nil : SubstituteAction.new(@cfg.src, @cfg.dst),
           ManualLocalizationAction.new,

data/lib/renamr/manual_localization.rb

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # Manual localization.
+  # Transliterates accented Latin characters to their ASCII equivalents.
   class ManualLocalizationAction < Action
-    SRC = 'ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđ'\
-          'ÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏ'\
-          'ìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅ'\
-          'ņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝ'\
-          'ŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝ'\
+    SRC = 'ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđ' \
+          'ÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏ' \
+          'ìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅ' \
+          'ņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝ' \
+          'ŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝ' \
           'ýÿŶŷŸŹźŻżŽž'
-    DST = 'AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDd'\
-          'EEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIII'\
-          'iiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnN'\
-          'nNnnNnOOOOOOooooooOoOoOoRrRrRrSsSs'\
-          'SsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwY'\
+    DST = 'AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDd' \
+          'EEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIII' \
+          'iiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnN' \
+          'nNnnNnOOOOOOooooooOoOoOoRrRrRrSsSs' \
+          'SsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwY' \
           'yyYyYZzZzZz'
 
     def do(src)

data/lib/renamr/omit.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # Omits file names shorter than limit.
+  # Skips file names shorter than the limit.
   class OmitAction < Action
     def initialize(lim)
       super()

data/lib/renamr/point.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # All points besides extension are replaced by minus.
+  # Replaces dots with hyphens, except for the file extension separator.
   class PointAction < Action
     def initialize(dir)
       super()

data/lib/renamr/prepend.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # Prepends user patter.
+  # Inserts a user-provided string at the given position.
   class PrependAction < Action
     def initialize(beg, pre) # rubocop:disable Lint/MissingSuper
       raise 'beg cannot be nil.' if beg.nil?
-      raise 'ins cannot be nil.' if pre.nil?
+      raise 'pre cannot be nil.' if pre.nil?
 
       @beg = beg
       @pre = pre

data/lib/renamr/prepend_date.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # Prepends file modification datestamp.
+  # Prepends the file modification date.
   class PrependDateAction < Action
     def initialize(dir)
       super()

data/lib/renamr/remove.rb

@@ -1,28 +1,27 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # Removes symbols between left and right positions.
+  # Removes a substring by 1-based position and length.
   class RemoveAction < Action
     def initialize(pos, len)
       super()
-      raise 'len cannot bi nil.' if len.nil?
+      raise 'len cannot be nil.' if len.nil?
+      raise 'len must be positive.' unless len.to_i.positive?
       raise 'pos cannot be nil.' if pos.nil?
-      raise 'pos has to be positive.' unless pos.to_i.positive?
+      raise 'pos must be positive.' unless pos.to_i.positive?
 
       @pos = pos.to_i
       @len = len.to_i
     end
 
     def do(src)
-      return src[@len..] if @pos == 1
-
-      src[0..@pos - 1] + src[@pos + @len..]
+      src[0...(@pos - 1)] + (src[(@pos - 1 + @len)..] || '')
     end
   end
 end

data/lib/renamr/renamer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require 'fileutils'
@@ -10,7 +10,7 @@ require_relative 'factory'
 require_relative 'reporter'
 
 module Renamr
-  # Renames file by certain rules.
+  # Renames files using configured rules.
   class Renamer
     def initialize
       @cfg = Configurator.new
@@ -29,20 +29,21 @@ module Renamr
           rep.add(File.basename(src), File.basename(dst))
         rescue StandardError => e
           rep.add(File.basename(src), e)
-          puts e.backtrace.join("\n\t")
-                .sub("\n\t", ": #{e}#{e.class ? " (#{e.class})" : ''}\n\t")
+          msg = ": #{e}"
+          msg += " (#{e.class})" if e.class
+          msg += "\n\t#{e.backtrace.join("\n\t")}"
+          puts msg
         end
       end
       rep.do
     end
 
     def unique(dat, nme)
-      dst = []
-      dat.each { |_, d| dst << File.basename(d) } # rubocop:disable Style/HashEachMethods
+      dst = dat.map { |_, d| File.basename(d) }
       return nme unless dst.include?(nme)
 
       ext = File.extname(nme)
-      0.step do |i| # Infinitive loop with index.
+      0.step do |i| # Iterates indefinitely with an index.
         n = ext.nil? ? "#{nme}-#{i}" : "#{File.basename(nme, ext)}-#{i}#{ext}"
         return n unless dst.include?(n)
       end
@@ -53,7 +54,8 @@ module Renamr
 
       dat = []
       act = @fac.produce(dir)
-      # Doesn't include hidden files.
+
+      # Skips hidden files.
       Dir.entries(dir).reject { |f| f.start_with?('.') }.sort.each do |nme|
         src = File.join(dir, nme)
         do_dir(src) if @cfg.rec? && File.directory?(src)

data/lib/renamr/reporter.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require 'terminal-table'
 require_relative 'action'
+require_relative 'timer'
 require_relative 'utils'
 
 module Renamr
-  # Formats and prints output data.
+  # Formats and prints rename results.
   # rubocop:disable Style/ClassVars
   class Reporter
     @@tim = Timer.new

data/lib/renamr/rutoen.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'

data/lib/renamr/substitute.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # Substitutes a string with a string.
+  # Replaces one string with another.
   class SubstituteAction < Action
     def initialize(src, dst)
       super()
       raise 'src cannot be nil.' if src.nil?
 
-      # The action works after PointAction. All points are replaces with minus.
+      # This action runs after PointAction, so dots are already hyphens.
       @src = p2m(src)
       @dst = dst.nil? ? '-' : p2m(dst)
     end

data/lib/renamr/timer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2026 David Rabkin
+# SPDX-License-Identifier: 0BSD
+
+# Measures elapsed time and reports it in a human-readable form.
+class Timer
+  DIC = [
+    [60,   :seconds, :second],
+    [60,   :minutes, :minute],
+    [24,   :hours,   :hour],
+    [1000, :days,    :day]
+  ].freeze
+
+  def initialize
+    @sta = Time.now
+  end
+
+  def read
+    humanize(Time.now - @sta)
+  end
+
+  def humanize(sec)
+    return 'less than a second' if sec < 1
+
+    DIC.filter_map do |cnt, nms, nm1|
+      next if sec <= 0
+
+      sec, n = sec.divmod(cnt)
+      next if n.to_i.zero?
+
+      "#{n.to_i} #{n.to_i == 1 ? nm1 : nms}"
+    end.reverse.join(' ')
+  end
+end

data/lib/renamr/trim.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # Replaces multiple minuses to single. Trims minuses.
+  # Collapses consecutive hyphens and removes hyphens next to dots and at
+  # the edges.
   class TrimAction < Action
     def do(src)
-      src.gsub!(/-+/, '-')
+      src.squeeze!('-')
       src.gsub!('-.', '.')
       src.gsub!('.-', '.')
       src.gsub!(/^-|-$/, '') unless src == '-'

data/lib/renamr/truncate.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'action'
 
 module Renamr
-  # Limits file length.
+  # Truncates file names that exceed the length limit, preserving the
+  # extension.
   class TruncateAction < Action
     def initialize(lim)
       super()
@@ -21,7 +22,7 @@ module Renamr
 
       ext = File.extname(src)
       len = ext.length
-      dst = len >= @lim ? ext[0..@lim - 1] : src[0..@lim - 1 - len] << ext
+      dst = len >= @lim ? ext[0..(@lim - 1)] : src[0..(@lim - 1 - len)] << ext
       dst.gsub!(/-$/, '')
       dst.gsub!('-.', '.')
       dst

data/lib/renamr/utils.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require 'ellipsized'
 
-# All methods are static.
+# Provides utility methods.
 class Utils
   class << self
     def trim(src, lim)
@@ -14,32 +14,3 @@ class Utils
     end
   end
 end
-
-# Returns string with humanized time interval.
-class Timer
-  DIC = [
-    [60,   :seconds, :second],
-    [60,   :minutes, :minute],
-    [24,   :hours,   :hour],
-    [1000, :days,    :day]
-  ].freeze
-
-  def initialize
-    @sta = Time.now
-  end
-
-  def read
-    humanize(Time.now - @sta)
-  end
-
-  def humanize(sec)
-    return 'less than a second' if sec < 1
-
-    DIC.map do |cnt, nms, nm1|
-      next if sec <= 0
-
-      sec, n = sec.divmod(cnt)
-      "#{n.to_i} #{n.to_i != 1 ? nms : nm1}"
-    end.compact.reverse.join(' ')
-  end
-end

data/lib/renamr/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2020-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2020-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 module Renamr
-  VERSION = '1.0.15'
-  DATE = '2025-07-23'
+  VERSION = '1.0.16'
+  DATE = '2026-07-12'
 end

data/lib/renamr.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2018-2025 David Rabkin
+# vi: et lbr sw=2 ts=2 tw=79 wrap
+# SPDX-FileCopyrightText: 2018-2026 David Rabkin
 # SPDX-License-Identifier: 0BSD
 
 require_relative 'renamr/renamer'

metadata

@@ -1,15 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: renamr
 version: !ruby/object:Gem::Version
-  version: 1.0.15
+  version: 1.0.16
 platform: ruby
 authors:
 - David Rabkin
 bindir: bin
 cert_chain: []
-date: 2025-07-23 00:00:00.000000000 Z
-dependencies: []
-description: "    Renamr organises multiple files and directories.\n"
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ellipsized
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: |2
+      Renamr normalizes file and directory names. It rewrites them with
+      lowercase English letters, digits, and hyphens in place of spaces and
+      other symbols.
 email: david@rabkin.co.il
 executables:
 - renamr
@@ -18,19 +63,8 @@ extra_rdoc_files:
 - LICENSE
 - README.adoc
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/actionlint.yml"
-- ".github/workflows/rake.yml"
-- ".github/workflows/rubocop.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
 - LICENSE
-- LICENSES/0BSD.txt
 - README.adoc
-- REUSE.toml
-- Rakefile
 - bin/renamr
 - lib/renamr.rb
 - lib/renamr/action.rb
@@ -51,19 +85,19 @@ files:
 - lib/renamr/reporter.rb
 - lib/renamr/rutoen.rb
 - lib/renamr/substitute.rb
+- lib/renamr/timer.rb
 - lib/renamr/trim.rb
 - lib/renamr/truncate.rb
 - lib/renamr/utils.rb
 - lib/renamr/version.rb
-- renamr.gemspec
-- test/test_char.rb
-- test/test_date.rb
-- test/test_trim.rb
 homepage: https://github.com/rdavid/renamr
 licenses:
 - 0BSD
 metadata:
+  bug_tracker_uri: https://github.com/rdavid/renamr/issues
+  homepage_uri: https://github.com/rdavid/renamr
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/rdavid/renamr
 rdoc_options: []
 require_paths:
 - lib
@@ -78,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.4
 specification_version: 4
-summary: File and directory names organiser
+summary: File and directory name normalizer
 test_files: []

data/.github/dependabot.yml

@@ -1,13 +0,0 @@
-# SPDX-FileCopyrightText: 2023-2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
----
-version: 2
-updates:
-  - package-ecosystem: github-actions
-    directory: /
-    schedule:
-      interval: daily
-  - package-ecosystem: bundler
-    directory: /
-    schedule:
-      interval: daily

data/.github/workflows/actionlint.yml

@@ -1,25 +0,0 @@
-# SPDX-FileCopyrightText: 2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
----
-name: actionlint
-# yamllint disable rule:line-length
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  actionlint:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - name: Download actionlint
-        id: get_actionlint
-        run: bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
-        shell: bash
-      - name: Check workflow files
-        run: ${{ steps.get_actionlint.outputs.executable }} -color
-        shell: bash

data/.github/workflows/rake.yml

@@ -1,27 +0,0 @@
-# SPDX-FileCopyrightText: 2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
----
-name: rake
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  rake:
-    strategy:
-      matrix:
-        os: [ubuntu-24.04, macos-15, windows-2022]
-        ruby: [3.2, 3.3, 3.4]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - run: bundle config set --global path "$(pwd)/vendor/bundle"
-      - run: bundle install --no-color
-      - run: bundle exec rake

data/.github/workflows/rubocop.yml

@@ -1,34 +0,0 @@
-# SPDX-FileCopyrightText: 2023-2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
----
-name: rubocop
-'on':
-  pull_request:
-    branches: [master]
-jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@472790540115ce5bd69d399a020189a8c87d641f
-        with:
-          ruby-version: 3.2
-      - name: Install Code Scanning integration
-        run: bundle add code-scanning-rubocop --version 0.6.1 --skip-install
-      - name: Install dependencies
-        run: bundle install
-      - name: Rubocop run
-        run: |
-          bash -c "
-            bundle exec rubocop \
-              --require code_scanning \
-              --format CodeScanning::SarifFormatter \
-              -o rubocop.sarif
-            [[ $? -ne 2 ]]
-          "
-      - name: Upload Sarif output
-        uses: github/codeql-action/upload-sarif@v3
-        with:
-          sarif_file: rubocop.sarif

data/.github/workflows/test.yml

@@ -1,20 +0,0 @@
-# SPDX-FileCopyrightText: 2023-2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
----
-name: test
-'on': push
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: docker://github/super-linter:v2.1.1
-        env:
-          VALIDATE_ALL_CODEBASE: true
-          VALIDATE_ANSIBLE: false
-      - uses: fsfe/reuse-action@v5
-      - uses: crate-ci/typos@master
-      - uses: ibiqlik/action-yamllint@v3
-        with:
-          file_or_dir: .github/*.yml .github/workflows/*.yml
-          strict: true

data/.gitignore

@@ -1,7 +0,0 @@
-coverage/
-Gemfile.lock
-.idea/
-*.gem
-.bundle/
-.DS_Store
-rdoc/

data/.travis.yml

@@ -1,14 +0,0 @@
-# SPDX-FileCopyrightText: 2023-2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
----
-language: ruby
-rvm:
-  - ~>3.2
-branches:
-  only:
-    - master
-install:
-  - bundle install
-script:
-  - set -e
-  - bundle exec rake

data/Gemfile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2020-2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
-
-source 'https://rubygems.org'
-gem 'date'
-gem 'ellipsized'
-gem 'fileutils'
-gem 'i18n'
-gem 'minitest'
-gem 'pidfile'
-gem 'rake'
-gem 'rubocop'
-gem 'terminal-table'

data/LICENSES/0BSD.txt

@@ -1,5 +0,0 @@
-Copyright 2020-2025 David Rabkin
-
-Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/REUSE.toml

@@ -1,11 +0,0 @@
-# SPDX-FileCopyrightText: 2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
-version = 1
-[[annotations]]
-path = [
-	".gitignore",
-	"README.adoc",
-]
-precedence = "override"
-SPDX-FileCopyrightText = "2025 David Rabkin"
-SPDX-License-Identifier = "0BSD"

data/Rakefile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2020-2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
-
-task default: %w[test]
-
-task :test do
-  ruby 'test/test_char.rb'
-  ruby 'test/test_date.rb'
-  ruby 'test/test_trim.rb'
-end

data/renamr.gemspec

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: 2023-2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
-
-$LOAD_PATH.unshift File.expand_path('lib', __dir__)
-
-require 'renamr'
-
-Gem::Specification.new do |s|
-  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-  s.required_ruby_version = '>=3.2'
-  s.name = 'renamr'
-  s.version = Renamr::VERSION
-  s.date = Renamr::DATE
-  s.summary = 'File and directory names organiser'
-  s.description = <<-HERE
-    Renamr organises multiple files and directories.
-  HERE
-  s.license = '0BSD'
-  s.author = 'David Rabkin'
-  s.email = 'david@rabkin.co.il'
-  s.homepage = 'https://github.com/rdavid/renamr'
-  s.files = `git ls-files`.split($RS)
-  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.extra_rdoc_files = ['LICENSE', 'README.adoc']
-  s.metadata['rubygems_mfa_required'] = 'true'
-end

data/test/test_char.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2020-2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
-
-require 'minitest/autorun'
-require_relative '../lib/renamr/char'
-
-class TestChar < Minitest::Test
-  def setup
-    @act = Renamr::CharAction.new
-  end
-
-  def test_act
-    assert_equal('-' * 32,
-                 @act.do(' (){},~–\'![]_#@=„“”"`—+‘’;·‡«»%…'.dup))
-  end
-end

data/test/test_date.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2020-2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
-
-require 'minitest/autorun'
-require_relative '../lib/renamr/date'
-
-# Test DateAction class.
-class TestChar < Minitest::Test
-  def setup
-    @act = Renamr::DateAction.new
-  end
-
-  def good
-    assert_equal('1 20201031 bar', @act.do('1 31-10-2020 bar'.dup))
-    assert_equal('2 20201031 bar', @act.do('2 10-31-2020 bar'.dup))
-    assert_equal('3 20201031 bar', @act.do('3 2020-10-31 bar'.dup))
-    assert_equal('4 20201031 bar', @act.do('4 2020-31-10 bar'.dup))
-  end
-
-  def bad
-    assert_equal('5 2nd Nov 2020 bar', @act.do('5 2nd Nov 2020 bar'.dup))
-    assert_equal('6 1-1-1-1 bar', @act.do('6 1-1-1-1 bar'.dup))
-  end
-
-  def test_act
-    good
-    bad
-  end
-end

data/test/test_trim.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-# vi:ts=2 sw=2 tw=79 et lbr wrap
-# SPDX-FileCopyrightText: 2020-2025 David Rabkin
-# SPDX-License-Identifier: 0BSD
-
-require 'minitest/autorun'
-require_relative '../lib/renamr/trim'
-
-class TestTrim < Minitest::Test
-  def setup
-    @act = Renamr::TrimAction.new
-  end
-
-  def test_act
-    assert_equal('-', @act.do('-'.dup))
-    assert_equal('-', @act.do('--'.dup))
-    assert_equal('1', @act.do('1-'.dup))
-    assert_equal('1', @act.do('-1'.dup))
-    assert_equal('1-1', @act.do('-1--1-'.dup))
-  end
-end