mass_rename 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7edd5c212e388cb8fc2a4428c7affeb4e08f3d38e4372fa4a5825fa27bffd968
-  data.tar.gz: 3ca138a9b6cad0152a66779bd385d5d2894e56b4ae3cb543986ca4be4df2cf82
+  metadata.gz: 88558a4ffaaa6213acef188079224f1d5d689a96551c83ff1dfc6b043b72feb0
+  data.tar.gz: fcf9cf9dbbbcfd429a940a24100dce9e1c2ce1cdcfc5a2c60f3bba7b6d3fa34a
 SHA512:
-  metadata.gz: 1a48a071f955e229d5cae832194275d894e4cfaa1c743a3150b71dc9060233acf2c9a0b0b56ad3e1b82590ff32c2bf53bf9760435f214708dacbbf58c28fa48a
-  data.tar.gz: d4bb6e97e20e244521e90adbbec332d33d77acbe5bcfe6f0c6655e7944d519e56fa996ff6ddbd837fa48c06f6f6e267dde8dab71870c6fba41ed2a714d0e44c1
+  metadata.gz: 2dff9b27f94844eb59530982664263bee4d1569cfdfb12039c9194d809f6b381cd0533987e3014f2cbc834346173b0f57597d5bf32a830fd7cd984ce0f63eeff
+  data.tar.gz: 7b85b80460931c08c427fed46435395ee0f7c2f05c5fa738b240b103a883191c3941681f555d401e14f8aaf5638798fb003b56c24dbb6325206b6aacf7e91627

data/.rubocop.yml

@@ -1,3 +1,3 @@
 inherit_from: .rubocop_todo.yml
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5

data/.rubocop_todo.yml

@@ -1,26 +1,36 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-09-22 22:01:45 -0700 using RuboCop version 0.50.0.
+# on 2018-07-25 09:19:19 -1000 using RuboCop version 0.58.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'mass_rename.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/IndentHeredoc:
+  Exclude:
+    - 'spec/mass_rename_spec.rb'
+
 # Offense count: 2
 # Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 35
-
-# Offense count: 6
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 120
+  Max: 116
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 15
+  Max: 24
 
 # Offense count: 1
 Style/Documentation:
@@ -28,3 +38,9 @@ Style/Documentation:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/mass_rename.rb'
+
+# Offense count: 29
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 121

data/README.md

@@ -30,11 +30,14 @@ Or install it yourself as:
         -v, --version                    Display version
         -h, --help                       Print this help
 
-The following example will recursively rename files matching the pattern "some_file_pattern_(\d)", capture the digit character,
-and rename all matching files with the replacement "\1_new_name", substituting the captured digit for "\1".
-```
-mass_rename --recursive -d target_dir -f "some_file_pattern_(\d)" -r "\1_new_name"
-```
+This tool is essentially a multi-string gsub, so treat the filter and replacement patterns the same as you would when
+using gsub -- capture groups and back references are very helpful!
+
+The following example will recursively rename files matching the pattern "some_file_pattern_(\d)", capture the digit 
+character, and rename all matching files with the replacement "\1_new_name", using a back reference for the captured 
+digit.
+
+    mass_rename --recursive -d target_dir -f "some_file_pattern_(\d)" -r "\1_new_name"
 
 ## Development
 

data/{exe → bin}/mass_rename

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'mass_rename'
 

data/lib/mass_rename.rb

@@ -6,74 +6,71 @@ require 'fileutils'
 require 'mass_rename/version'
 
 module MassRename
-  # Processes the provided options from the command line.
-  # Usage and effects for different options are given by running the script with the '-h' flag.
-  #
-  # @param args [Array] the arguments to the CLI
-  # @return [Hash] the arguments as a hash
-  def self.process_options(args)
-    options = {}
-    OptionParser.new do |parser|
-      parser.banner = 'Usage: mass_rename [options]'
+  class << self
+    # Processes the provided options from the command line.
+    # Usage and effects for different options are given by running the script with the '-h' flag.
+    #
+    # @param args [Array] the arguments to the CLI
+    # @return [Hash] the arguments as a hash
+    def process_options(args)
+      options = {}
+      OptionParser.new do |parser|
+        parser.banner = 'Usage: mass_rename [options]'
 
-      parser.on('-d', '--dir NAME', 'Select a different working directory') do |dir_name|
-        options[:directory] = dir_name
-      end
+        parser.on('-d', '--dir NAME', 'Select a different working directory') do |dir_name|
+          options[:directory] = dir_name
+        end
 
-      parser.on('-f', '--filter PATTERN', 'Filter files using a regular expression') do |regex|
-        options[:filter] = Regexp.new(regex)
-      end
+        parser.on('-f', '--filter PATTERN', 'Filter files using a regular expression') do |regex|
+          options[:filter] = Regexp.new(regex)
+        end
 
-      parser.on('-r', '--replace PATTERN', 'Replace matched file names with a replacement string') do |replacement|
-        options[:replacement] = replacement
-      end
+        parser.on('-r', '--replace PATTERN', 'Replace matched file names with a replacement string') do |replacement|
+          options[:replacement] = replacement
+        end
 
-      parser.on('--recursive', 'Select files in the target directory and all its subdirectories') do |recursive|
-        options[:recursive] = recursive
-      end
+        parser.on('--recursive', 'Select files in the target directory and all its subdirectories') do |recursive|
+          options[:recursive] = recursive
+        end
 
-      parser.on('-v', '--version', 'Display version') do
-        puts MassRename::VERSION
-      end
+        parser.on('-v', '--version', 'Display version') do
+          puts MassRename::VERSION
+        end
 
-      parser.on('-h', '--help', 'Print this help') do
-        puts parser
-      end
+        parser.on('-h', '--help', 'Print this help') do
+          puts parser
+        end
 
-      parser.parse!(args)
+        parser.parse!(args)
+      end
+      options
     end
-    options
-  end
 
-  # Returns a list of file names matching a pattern, optionally recursive.
-  #
-  # @param options [Hash] the options returned by {MassRename#process_options}
-  # @return [Array<String>] the files matching the filter
-  def self.file_list(options)
-    Dir.glob(options[:recursive] ? '**/*' : '*').select do |path|
-      path =~ options[:filter]
+    # Returns a list of file names matching a pattern, optionally recursive.
+    #
+    # @param options [Hash] the options returned by {MassRename#process_options}
+    # @return [Array<String>] the files matching the filter
+    def file_list(options)
+      Dir.glob(options[:recursive] ? '**/*' : '*').select { |path| path =~ options[:filter] }
     end
-  end
 
-  # Renames a file according to a pattern. The format of the replacement pattern is what you'd
-  # pass to +String#gsub+.
-  #
-  # @param path [String] the path of the file to rename
-  # @param options [Hash] the options returned by {MassRename#process_options}
-  def self.rename(path, options)
-    new_path = path.gsub(options[:filter], options[:replacement])
-    FileUtils.mv(path, new_path)
-  end
+    # Renames a file according to a pattern. The format of the replacement pattern is what you'd
+    # pass to +String#gsub+.
+    #
+    # @param path [String] the path of the file to rename
+    # @param options [Hash] the options returned by {MassRename#process_options}
+    def rename(path, options)
+      FileUtils.mv(path, path.gsub(options[:filter], options[:replacement]))
+    end
 
-  # Main entry point for this library. Processes the given options and then renames files
-  # matching the filter according to the given replacement string.
-  #
-  # @param args [Array<String>] arguments to parse. Equal to ARGV if you're not doing anything fancy.
-  def self.run(args)
-    options = MassRename.process_options(args)
-    Dir.chdir(options[:directory]) if options[:directory]
-    MassRename.file_list(options).each do |path|
-      MassRename.rename(path, options)
+    # Main entry point for this library. Processes the given options and then renames files
+    # matching the filter according to the given replacement string.
+    #
+    # @param args [Array<String>] arguments to parse. Equal to ARGV if you're not doing anything fancy.
+    def run(args)
+      options = MassRename.process_options(args)
+      Dir.chdir(options[:directory]) if options[:directory]
+      MassRename.file_list(options).each { |path| MassRename.rename(path, options) }
     end
   end
 end

data/lib/mass_rename/version.rb

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

data/mass_rename.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path("../lib/mass_rename/version", __FILE__)
+require File.expand_path('lib/mass_rename/version', File.dirname(__FILE__))
 
 Gem::Specification.new do |spec|
   spec.name          = 'mass_rename'
@@ -11,18 +11,17 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/lucis-fluxum/mass_rename'
   spec.license       = 'MIT'
 
-  spec.platform      = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 1.9'
+  spec.required_ruby_version = '>= 1.9.3'
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = `git ls-files -z -- spec/*`.split("\x0")
+  spec.executables   = ['mass_rename']
 
   spec.metadata['yard.run'] = 'yri'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'codecov'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'codecov'
   spec.add_development_dependency 'yard'
 end

data/spec/mass_rename_spec.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe MassRename do
+  it 'has a version number' do
+    expect(MassRename::VERSION).not_to be nil
+  end
+
+  describe '.process_options' do
+    let(:usage) do
+      <<-USAGE
+Usage: mass_rename [options]
+    -d, --dir NAME                   Select a different working directory
+    -f, --filter PATTERN             Filter files using a regular expression
+    -r, --replace PATTERN            Replace matched file names with a replacement string
+        --recursive                  Select files in the target directory and all its subdirectories
+    -v, --version                    Display version
+    -h, --help                       Print this help
+      USAGE
+    end
+
+    describe 'parses -d, --dir' do
+      %w[-d --dir].each do |arg|
+        context "#{arg} with value" do
+          subject { MassRename.process_options([arg, 'some_dir']) }
+          it('returns options hash with directory') { is_expected.to eq(directory: 'some_dir') }
+        end
+
+        context "#{arg} without value" do
+          subject { -> { MassRename.process_options([arg]) } }
+          it('raises an error') { is_expected.to raise_error(OptionParser::MissingArgument) }
+        end
+      end
+    end
+
+    describe 'parses -f, --filter' do
+      %w[-f --filter].each do |arg|
+        context "#{arg} with value" do
+          subject { MassRename.process_options([arg, '\w+[0-9]+']) }
+          it('returns options hash with filter') { is_expected.to eq(filter: /\w+[0-9]+/) }
+        end
+
+        context "#{arg} without value" do
+          subject { -> { MassRename.process_options([arg]) } }
+          it('raises an error') { is_expected.to raise_error(OptionParser::MissingArgument) }
+        end
+      end
+    end
+
+    describe 'parses -r, --replace' do
+      %w[-r --replace].each do |arg|
+        context "#{arg} with value" do
+          subject { MassRename.process_options([arg, 'something \1 \2']) }
+          it('returns options hash with filter') { is_expected.to eq(replacement: 'something \1 \2') }
+        end
+
+        context "#{arg} without value" do
+          subject { -> { MassRename.process_options([arg]) } }
+          it('raises an error') { is_expected.to raise_error(OptionParser::MissingArgument) }
+        end
+      end
+    end
+
+    it 'parses -v, --version' do
+      %w[-v --version].each do |arg|
+        expect { MassRename.process_options([arg]) }.to output("#{MassRename::VERSION}\n").to_stdout
+      end
+    end
+
+    it 'parses -h, --help' do
+      %w[-h --help].each do |arg|
+        expect { MassRename.process_options([arg]) }.to output(usage).to_stdout
+      end
+    end
+  end
+
+  describe '.file_list' do
+    before(:all) do
+      Dir.chdir('spec/fixtures')
+    end
+
+    [true, false].product([/example file \d\.txt/, nil]).each do |recursive, filter|
+      context "recursive: #{recursive}, filter: #{filter.inspect}" do
+        subject { MassRename.file_list(recursive: recursive, filter: filter) }
+        let(:files) { Array.new(10) { |n| "example file #{n}.txt" } }
+        let(:nested_files) { Array.new(5) { |n| "some_dir/example file #{n}.txt" } }
+
+        if !filter.nil? && recursive
+          it('returns a list of filenames (recursive)') { is_expected.to match_array(nested_files + files) }
+        elsif !filter.nil? && !recursive
+          it('returns a list of filenames (non-recursive)') { is_expected.to match_array(files) }
+        else
+          it('returns empty array') { is_expected.to be_empty }
+        end
+      end
+    end
+
+    after(:all) do
+      Dir.chdir('../../')
+    end
+  end
+
+  describe '.rename' do
+    let(:options) { { filter: /example (.*) (\d)/, replacement: 'renamed \1 #00\2' } }
+
+    it 'renames a file with replacement string' do
+      10.times do |n|
+        MassRename.rename("spec/fixtures/example file #{n}.txt", options)
+        expect(File).to exist("spec/fixtures/renamed file #00#{n}.txt")
+      end
+    end
+
+    after(:each) do
+      reset_fixtures
+    end
+  end
+
+  describe '.run' do
+    let(:files) { Array.new(10) { |n| "file ##{n} renamed.txt" } }
+    let(:nested_files) { Array.new(5) { |n| "some_dir/file ##{n} renamed.txt" } }
+
+    subject { MassRename.file_list(recursive: false, filter: /file #\d renamed\.txt/) }
+    let(:options) { ['-d', 'spec/fixtures', '-f', 'example (.*) (\d)', '-r', '\1 #\2 renamed'] }
+    it 'renames multiple files (non-recursive)' do
+      MassRename.run(options)
+      is_expected.to match_array(files)
+    end
+
+    subject { MassRename.file_list(recursive: true, filter: /file #\d renamed\.txt/) }
+    let(:options_recursive) { ['-d', 'spec/fixtures', '-f', 'example (.*) (\d)', '-r', '\1 #\2 renamed', '--recursive'] }
+    it 'renames multiple files (recursive)' do
+      MassRename.run(options_recursive)
+      is_expected.to match_array(nested_files + files)
+    end
+
+    after(:each) do
+      Dir.chdir('../../')
+      reset_fixtures
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start
+
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+require 'bundler/setup'
+require 'mass_rename'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def reset_fixtures
+  FileUtils.rm_r(Dir.glob('spec/fixtures/*'))
+  10.times { |n| FileUtils.touch "spec/fixtures/example file #{n}.txt" }
+  Dir.mkdir('spec/fixtures/some_dir')
+  5.times { |n| FileUtils.touch "spec/fixtures/some_dir/example file #{n}.txt" }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mass_rename
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Luc Street
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2018-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -112,11 +112,28 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/mass_rename
 - bin/setup
-- exe/mass_rename
 - lib/mass_rename.rb
 - lib/mass_rename/version.rb
 - mass_rename.gemspec
+- spec/fixtures/example file 0.txt
+- spec/fixtures/example file 1.txt
+- spec/fixtures/example file 2.txt
+- spec/fixtures/example file 3.txt
+- spec/fixtures/example file 4.txt
+- spec/fixtures/example file 5.txt
+- spec/fixtures/example file 6.txt
+- spec/fixtures/example file 7.txt
+- spec/fixtures/example file 8.txt
+- spec/fixtures/example file 9.txt
+- spec/fixtures/some_dir/example file 0.txt
+- spec/fixtures/some_dir/example file 1.txt
+- spec/fixtures/some_dir/example file 2.txt
+- spec/fixtures/some_dir/example file 3.txt
+- spec/fixtures/some_dir/example file 4.txt
+- spec/mass_rename_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/lucis-fluxum/mass_rename
 licenses:
 - MIT
@@ -130,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -142,4 +159,21 @@ rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Mass rename files.
-test_files: []
+test_files:
+- spec/fixtures/example file 0.txt
+- spec/fixtures/example file 1.txt
+- spec/fixtures/example file 2.txt
+- spec/fixtures/example file 3.txt
+- spec/fixtures/example file 4.txt
+- spec/fixtures/example file 5.txt
+- spec/fixtures/example file 6.txt
+- spec/fixtures/example file 7.txt
+- spec/fixtures/example file 8.txt
+- spec/fixtures/example file 9.txt
+- spec/fixtures/some_dir/example file 0.txt
+- spec/fixtures/some_dir/example file 1.txt
+- spec/fixtures/some_dir/example file 2.txt
+- spec/fixtures/some_dir/example file 3.txt
+- spec/fixtures/some_dir/example file 4.txt
+- spec/mass_rename_spec.rb
+- spec/spec_helper.rb