mvb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9a9dd9a37c9202b5016f54508d32d876b2baa95ab86f90355d9763427a6e79f
+  data.tar.gz: f40d7182c62000bcbd455d7e3a7c51d47ecc79ad17b1767ed20d88da1fd4c1a1
+SHA512:
+  metadata.gz: ac6bcf8e1d406b49e1a40b72fbaa6e1f1c3eed1e539b1a5e58b2e06d848e06f651ee1f077c4ee7445add1e884bbf8cc328920160fda21ee027a6c14992ccf472
+  data.tar.gz: 35388f1ba151d170dda9e4aa18f4bce064f02519a9c913f42a3411c932397c64d6c6ae66fc5eddeccf4da1a411f34eeea5f3c54dbfa70e7f6f8e04242bd1d87d

data/exe/mvb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+# Tienes una nota en Joplin. Léela.
+
+require 'optparse'
+require_relative '../lib/mvb'
+
+positional_args = []
+search          = nil
+replacement     = nil
+pattern         = nil
+force_rename    = false
+steps           = 1
+
+banner = <<~EOM
+Usage:
+  mvb [-s,--search] "PATTERN" [-r,--replacement] ["STRING"] [-f,--force]
+
+You can enter the arguments by option tags or by position. Tag options get precedence over positions.
+In positional options, first argument corresponds to the search pattern, and second, the replacement.
+
+The only required argument is the search pattern. If replacement is not given,
+the output is a list of the matched files.
+
+If both options are given (search and replacement), the output will consists
+of two columns: first column lists the current filenames matched by the search patterns,
+and second column their replacement counterpart. This will be a dry-run, though; no rename
+will be executed
+
+To execute the rename, add the --force (or -f) option.
+
+IMPORTANT: if you are going to use regex as pattern, it is strongly recommended
+to enclose it in double quotes in order to avoid conflicts between the regex
+special characters and the wildcards of the shell.
+
+SEQUENTIAL NUMBERING:
+On replacement string, you can introduce sequential numbering by using a "#" as placeholder along
+with an integer which will be the starting point. For example, if you use "image-#1" as replacement,
+the output will consist of: image-1, image-2, image-3, etc. until reached the last replacement item.
+You can use the option `-i` to set the steps of increments.
+
+EOM
+
+opt_parser = OptionParser.new do |opts|
+
+  opts.banner = banner
+
+  opts.on("-s", "--search PATTERN", "Search for files that match with PATTERN. If no replace PATTERN is given,
+    just list the matched files. Argument required, option tag is not required.") do |argument|
+    search = argument
+  end
+
+  opts.on("-r", "--replacement PATTERN", "Replace the matched files with given PATTERN. Optional.") do |argument|
+    replacement = argument
+  end
+
+  opts.on("-f", "--force", "Execute renaming") do
+    force_rename = true
+  end
+
+  opts.on("-i STEPS", "--steps=STEPS", "Steps of increment on sequential numbering." ) do |argument|
+    steps = argument.to_i if argument.to_i != 0
+  end
+
+  opts.on("-h", "--help", "Show this help message.") do
+    puts opts
+    exit
+  end
+
+end
+
+# Parse the options and store remaining arguments as positional
+begin
+  opt_parser.parse!
+
+# Error handling
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+  puts e.message
+  puts opt_parser
+  exit 1
+end
+
+# Set remaining arguments are positional
+positional_args = ARGV
+
+unless positional_args.empty?
+  unless search
+    search = positional_args[0]
+  end
+  unless replacement
+    replacement = positional_args[1]
+  end
+end
+
+pattern = /#{search}/ if search
+
+Mvb.rename_files(pattern, replacement, force_rename, steps)

data/lib/mvb/version.rb

@@ -0,0 +1,4 @@
+
+module Mvb
+    VERSION = "0.0.1"
+end

data/lib/mvb.rb

@@ -0,0 +1,111 @@
+
+require_relative "mvb/version"
+
+module Mvb
+    COLOR_RED = "\e[31m"
+    COLOR_GREEN = "\e[32m"
+    COLOR_RESET = "\e[0m"
+    PH = "#" # for "PlaceHolder"
+
+    # Find array of matching filenames based on regex parttern
+    def self.find_matching_files(pattern)
+        return [] if pattern.nil?
+        Dir.glob('*').select { |filename| filename.match?(pattern) }
+    end
+
+    # Print array of filenames
+    def self.print_filenames(filenames)
+        if filenames.empty?
+            puts "No match found."
+            return
+        end
+        filenames.each { |filename| puts "#{filename}"}
+    end
+
+    # Rename matched files according to search (regex) parttern, replacement, and force flag
+    # if force flag is not given, provide just a list (i.e dry-run)
+    def self.rename_files(search_pattern, replacement=nil, force_rename=false, steps=1)
+
+        # No search pattern given? Return nothing
+        if search_pattern == nil
+            puts "You have to provide at least one regex pattern.\nPlease check 'mvb --help' for command usage."
+            return
+        end
+
+        # Get array with matched files based on regex pattern
+        matched_files = find_matching_files(search_pattern)
+
+        # No match found on search pattern? Return nothing
+        if matched_files.empty?
+            puts "No match found."
+            return
+        end
+
+        # No replacement string given? Print only the matched filenames
+        if replacement == nil
+            print_filenames(matched_files)
+            return
+        end
+
+        # If replacement include the "#" placeholder, define the starting point (index)
+        if replacement.include?(PH)
+            placeholder_present = true
+            new_filenames = []
+
+            # The index will be equal to the number that is after the placeholder, e.g. "#2", index = 2
+            index = replacement[/(?<=#{PH})\d+/]
+            index = index.to_i
+
+            steps = 1 if steps == 0 or steps == nil # Just in case
+        end
+
+        # Here is where the renaming (or dry-run) happens...
+
+        puts "\n" # insert blank line between the command and the list of filenames
+
+        matched_files.each do |filename|
+            # Remember: "filename.gsub(...)" returns a copy of the filename with all the occurrences of a
+            # given regex pattern substituted for the second argument
+            new_filename = filename.gsub(search_pattern,replacement)
+
+            # If placeholder is present in new_filename, execute sequential numbering
+            if new_filename.include?(PH)
+                if new_filename[/#{PH}\d+/] != nil
+                    new_filename.gsub!(/#{PH}\d+/,index.to_s)
+                else
+                    new_filename.gsub!(PH,index.to_s)
+                end
+                index = index + steps
+            end
+
+            # List every filename along with their possible replacement
+            puts "#{COLOR_RED}#{filename}#{COLOR_RESET} --> #{COLOR_GREEN}#{new_filename}#{COLOR_RESET}"
+            
+            # If force flag is given, execute rename
+            if force_rename
+                if placeholder_present
+                    new_filename = new_filename + "_"
+                    File.rename(filename,new_filename)
+                    new_filenames.push(new_filename)
+                else
+                    File.rename(filename,new_filename)
+                end
+            end
+        end
+
+        if placeholder_present and force_rename
+            new_filenames.each do |filename|
+                File.rename(filename,filename.chomp("_"))
+            end
+        end
+
+
+        # Provide message if files were renamed or if it was a dry-run
+        if force_rename
+            puts "\nFiles renamed!"
+        else
+            puts "\nThis is a dry-run. No file has been renamed."
+        end
+    end
+
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: mvb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Manuel Fuenmayor
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-11 00:00:00.000000000 Z
+dependencies: []
+description: A gem to rename batch of files, with sequential numbering feature
+email: manuel.fuenmayor98@gmail.com
+executables:
+- mvb
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/mvb
+- lib/mvb.rb
+- lib/mvb/version.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.20
+signing_key:
+specification_version: 4
+summary: A script to rename batch of files
+test_files: []