modname 0.2.4 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0fa2d1f63b3777585a4202c0560d15b47c0c345b5c614015baed843d78f099
-  data.tar.gz: eb9bbbc814a25107ff88e4dae35ba29a1faebf9701c2af3d70a07a350d2e5eb1
+  metadata.gz: '08c89eeb3f25ef386045b8ee7ac0f52695b24b7491362f18ad0e71dec728a35c'
+  data.tar.gz: 442c1038cd4ea91b61e82612468506789fab3d5d9702d97135ec45673be99138
 SHA512:
-  metadata.gz: 909a24c120475377a6b323d56b4cf0ab1cb1a8b0d6b41a81eb1b241c8a13cbcf76bbbdaf028101456216d674dc2417e61a478113055838a6438cb646927f4ac1
-  data.tar.gz: b6686c14fad14cbd7025d39ef985e8ed6dfcb06f0bed43079ca0a01c53724498a4c124a39a592ea0f4906c2ab581779383bf0099c3184142c0d2fb3f4403294e
+  metadata.gz: 3e0e66eeb5c5c7bdde75c518f57ec348cbf686af0514e764fd2aeb508d157984b1faf739f3dfb5db55aa72905063c0602ae83557e6dbc35a929dce29bc2524a7
+  data.tar.gz: bee28f157f2963a03495a8b44271dc389d4b5923e5ada5be317bd78778e299cd8b66717425d7dbb5623280362bee385d81e3dd018567dfb615b514dc34ec2e96

data/lib/modname/banner.rb

@@ -11,6 +11,7 @@ Modname::HELP_BANNER = <<~HELP.freeze
        -e #{'|'.cyan} change file extensions
        -f #{'|'.cyan} force run; don't pre-check
        -r #{'|'.cyan} run modname recursively
+   --dirs #{'|'.cyan} also rename directory names
        -h #{'|'.cyan} show more help, examples
 HELP
 

data/lib/modname/modder.rb

@@ -5,7 +5,7 @@
 
 # any module including modder should implement:
 # @transfer => hash of file transfers to occur
-# @options => hash with :recurse and :force
+# @options => hash with :recurse, :force, and :dirs
 
 # extensions
 module Modder
@@ -13,10 +13,13 @@ module Modder
   def regex(args = [])
     match, trans = Modder.parse args
 
-    Modder.files(@options[:recurse]).each do |file|
-      new = file.sub Regexp.new(match), trans
+    Modder.files(@options[:recurse], dirs: @options[:dirs]).each do |file|
+      new = Modder.rename_base(file) do |base|
+        result = base.sub Regexp.new(match), trans
+        result.empty? ? base : result # no changes
+      end
 
-      next if new == file || new == '' # no changes
+      next if new.nil?
 
       @transfer[file] = new
     end
@@ -35,10 +38,10 @@ module Modder
       undercase_ext match
 
     else # move match extension to targeted
-      Modder.files(@options[:recurse]).each do |file|
-        new = file.sub(/#{match}$/, trans)
+      Modder.files(@options[:recurse], dirs: @options[:dirs]).each do |file|
+        new = Modder.rename_base(file) { |base| base.sub(/#{match}$/, trans) }
 
-        next if new == file # no changes
+        next if new.nil?
 
         @transfer[file] = new
       end
@@ -49,7 +52,7 @@ module Modder
 
   # top level wrapper for exts
   def undercase_ext(ext = '')
-    transfer = Modder.undercase_ext_get ext, @options[:recurse]
+    transfer = Modder.undercase_ext_get ext, @options[:recurse], dirs: @options[:dirs]
     Modder.undercase_ext_set ext, transfer, @options[:force]
   end
 end
@@ -71,15 +74,52 @@ class << Modder
     $stdin.gets.chomp.downcase[0] == 'y'
   end
 
-  # return a list of files to examine
-  def files(recurse)
-    if recurse
-      Dir['**/*'].select { |f| File.file?(f) }
-    else
-      Dir.entries(Dir.pwd).select { |f| File.file? f }
+  # return a list of files (and, optionally, directories) to examine.
+  # files always come first; directories are sorted deepest-first so a
+  # parent is only renamed after everything nested inside it.
+  # dotfiles/dotdirs (.git, etc.) are always excluded, matching Dir['**/*']'s
+  # default behavior in the recursive case
+  def files(recurse, dirs: false)
+    paths = recurse ? Dir['**/*'] : Dir.entries(Dir.pwd).reject { |f| f.start_with?('.') }
+    found, folders = Modder.classify(paths)
+
+    return found unless dirs
+
+    found + folders.sort_by { |f| -f.count('/') }
+  end
+
+  # split paths into [files, directories]; a single stat covers both checks
+  # per path, skipping entries that vanished mid-scan or are broken symlinks
+  def classify(paths)
+    paths.each_with_object([[], []]) do |f, (fs, ds)|
+      stat = Modder.safe_stat(f)
+      next unless stat
+
+      fs << f if stat.file?
+      ds << f if stat.directory?
     end
   end
 
+  # stat a path, returning nil (instead of raising) for entries that
+  # disappeared mid-scan or are broken symlinks
+  def safe_stat(file)
+    File.stat(file)
+  rescue Errno::ENOENT
+    nil
+  end
+
+  # apply a transformation to a file's basename only, preserving its directory.
+  # the block receives the basename and returns a new basename; returning it
+  # unchanged means no rename should happen, in which case nil is returned
+  def rename_base(file)
+    dir, base = File.split(file)
+    new_base = yield base
+
+    return nil if new_base == base
+
+    dir == '.' ? new_base : File.join(dir, new_base)
+  end
+
   # show the status of current files
   def status(transfer)
     if transfer.empty?
@@ -90,7 +130,9 @@ class << Modder
     end
   end
 
-  # rename all files
+  # rename all files. must run in insertion order: when directories are
+  # included, Modder.files places them deepest-first so a parent is never
+  # renamed before what's nested inside it
   def execute(transfer, force: false)
     transfer.each { |o, n| Modder.rename o, n, force }
   end
@@ -123,19 +165,40 @@ class << Modder
   end
 
   # get all extensions to change
-  def undercase_ext_get(ext, recurse)
+  def undercase_ext_get(ext, recurse, dirs: false)
     transfer = {}
     allexts = ext.empty?
-    Modder.files(recurse).each do |file|
-      ext = file.split('.').last if allexts
+    Modder.files(recurse, dirs: dirs).each do |file|
+      new = Modder.rename_base(file) do |base|
+        cur_ext = allexts ? base.split('.').last : ext
+        next base if cur_ext == base # no extension to change
+
+        base.sub(/#{cur_ext}$/i, cur_ext.downcase)
+      end
 
-      new = file.sub(/#{ext}$/i, ext.downcase)
-      next if new == file || ext == file # no changes or extension
+      next if new.nil?
 
       transfer[file] = new
     end
 
-    transfer
+    Modder.resolve_dir_renames(transfer)
+  end
+
+  # rewrite each target path so it reflects any ancestor directory renames
+  # also present in this transfer. undercase_ext_set flattens every entry to
+  # a bare temp name before restoring it, which loses the "renaming a
+  # directory carries its contents along" guarantee that Modder.execute
+  # otherwise gets for free from File.rename — so a nested file's precomputed
+  # target must have its renamed ancestor directory's NEW name spliced in
+  def resolve_dir_renames(transfer)
+    dir_renames = transfer.select { |k, _| File.directory?(k) }
+    return transfer if dir_renames.empty?
+
+    transfer.transform_values do |target|
+      dir_renames.reduce(target) do |path, (old_dir, new_dir)|
+        path.start_with?("#{old_dir}/") ? path.sub("#{old_dir}/", "#{new_dir}/") : path
+      end
+    end
   end
 
   # set all extensions to change
@@ -153,7 +216,8 @@ class << Modder
       final = {}
       temp = {}
 
-      # create hash temp map
+      # create hash temp map; iterating `transfer` preserves its deepest-first
+      # directory ordering, which `temp` needs to safely rename originals away
       transfer.each do |k, v|
         tempfile = (v.hash * v.object_id).abs.to_s
         final[tempfile] = v
@@ -161,7 +225,10 @@ class << Modder
       end
 
       Modder.execute temp
-      Modder.execute final
+      # `transfer`'s order is files-then-dirs-deepest-first (see Modder.files);
+      # reversing it gives dirs-shallowest-first-then-files, which is exactly
+      # what's needed to restore ancestors before anything nested inside them
+      Modder.execute(final.to_a.reverse)
       puts 'Modifications complete.'
     else
       puts 'No modifications done.'

data/lib/modname/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Modname
-  VERSION = '0.2.4'
+  VERSION = '1.0.1'
 end

data/lib/modname.rb

@@ -3,9 +3,9 @@
 # parse modname's command line args
 
 require 'colored'
-require 'modname/banner'
-require 'modname/modder'
-require 'modname/version'
+require_relative 'modname/banner'
+require_relative 'modname/modder'
+require_relative 'modname/version'
 
 # Modname is a versatile file naming tool for renaming groups of files
 module Modname
@@ -13,10 +13,7 @@ module Modname
   class << self
     def run(args) = Driver.new.run(args)
   end
-end
 
-# Modname module containing the CLI driver
-module Modname
   # Driver class handles command-line argument parsing and execution
   class Driver
     include Modder
@@ -24,7 +21,7 @@ module Modname
     attr_reader :options
 
     def initialize
-      @options = { force: false, recurse: false }
+      @options = { force: false, recurse: false, dirs: false }
       @transfer = {}
     end
 
@@ -52,24 +49,27 @@ module Modname
       end
     end
 
+    # boolean options toggled by a single flag with no argument
+    FLAGS = { '-f' => :force, '-r' => :recurse, '--dirs' => :dirs }.freeze
+
+    # flags that select which command to run
+    COMMANDS = {
+      '-e' => 'ext', '--ext' => 'ext',
+      '-h' => 'help', '--help' => 'help',
+      '-v' => 'version', '--version' => 'version'
+    }.freeze
+
     # parse out arguments
     def parse(args)
       opts = { cmd: 'file', args: [] }
 
       args.each do |opt|
-        case opt
-        when '-f'
-          @options[:force] = true
-        when '-r'
-          @options[:recurse] = true
-        when '-e', '--ext'
-          opts[:cmd] = 'ext'
-        when '-h', '--help'
-          opts[:cmd] = 'help'
-        when '-v', '--version'
-          opts[:cmd] = 'version'
-        else # command argument
-          opts[:args] << opt
+        if (flag = FLAGS[opt])
+          @options[flag] = true
+        elsif (cmd = COMMANDS[opt])
+          opts[:cmd] = cmd
+        else
+          opts[:args] << opt # command argument
         end
       end
 

data/readme.md

@@ -28,6 +28,7 @@ modname | rename files, fast
      -e | change file extensions
      -f | force run; don't pre-check
      -r | run modname recursively
+ --dirs | also rename directory names
      -h | show more help, examples
 
 commands
@@ -70,16 +71,14 @@ try running `gem install bundler`. Once that is done:
 Now, we should be able to build the gem locally. This will build the local
 modname gem and link it in your path, so you can playing around with `modname`.
 
-    rake build
+    just build
 
-This uses `rspec` and `rake` to run a suite of unit tests. To run the suite:
+This uses `rspec` and `just` to run a suite of unit tests. To run the suite:
 
-    rake
+    just spec
 
 
 ## todos
 
-- only try to rename filenames, not folders on recursive calls
 - figure out whats up with the extension globbing
-- apply optionally to directories as well
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modname
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.0.1
 platform: ruby
 authors:
 - Jeremy Warner
@@ -23,20 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -103,14 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.10
 specification_version: 4
 summary: a versatile file naming tool.
 test_files: []