mass_rename 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67811d7df2574827a308984a745bec79c8130b78
+  data.tar.gz: 51c7ee70bb86e67346f7d99b7cc3567a02be92ba
+SHA512:
+  metadata.gz: e385312a95ded03ab02b0cabdb9bf700e2359f88a0fadf2f79ca9f1973efc1e5cae6d6e8107b7762dfcb9b74166e149f1bb2cc7f15bf5995bd421b5fe28c13b5
+  data.tar.gz: 85c3af91e51876ae4bae69c6dca1871313f10f38510d8d79270f6430d06754f83fa87111302d86c2a270e7e2a8d556068815ac8b87267a242ea47192eef982ba

data/.gitignore

@@ -0,0 +1,13 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

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

data/.rubocop_todo.yml

@@ -0,0 +1,30 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-09-22 22:01:45 -0700 using RuboCop version 0.50.0.
+# 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: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 35
+
+# Offense count: 6
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 120
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 15
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/mass_rename.rb'

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.4
+
+notifications:
+  email:
+    recipients:
+      - secure: "BIcuEkLfJjpVKlkmjvUR21zrS+7Q1aYsurjZmIHauR0PDl0K7XmoNQtz09b4Ee+1hVzLV3gScDmUYpeVTWE7erBBZVYnNcSV2zIV4sVtAiCx2Aoi9xpGOVb+vop4o89+2RLzy2Wp9dFfcE1C5/IVytvFdS7x4ERFS7SgjzT7M2kS0L2mpGQg7ykky97HdjyjFuEGHfcN2B9gm+U5EQDFRfAeNkHeC4R3jygwsMGq1nhUeiAgzqaHRx+jcwe0NLgoEuw/fN3GJ5VosvxjqIx70sjJQayN8NvRmmaMLVWa1TZxBSV548O9CVlsxJNvERNneDhex83OYBPL/YfPxUkVGiufGI8TWnkQZJSOylnZN3F2BL2wURLyOIK1w/DYlWykLCcJpVKHBt6pw0VZ8Y1ZPgjDmlJxS5NRRyuRNcgTYhZt1ShRr9QlzMcZzTE4vJfHJ5dmIMWGHPSOyy1434vlYvAPK7yXGOquSIYqDPCsZ0Eu15ShwSp728eJraBBGY1GDYPlXeluescq3PmSpuTZCdAxXKdmHT4BsEi4Jrax64DBpfiBXMHLWeid+6sxOHxN6A3Ehdhy2Tt8gdJJDex6Bx9qVAPx91Scm3knw+4zpeOjAZPcQdPl+CN/zX0wQWuDbrBCpEsZYU6rToJH9xtQ8bI3OvI8AYWYGrrpDN/Txzs="
+    on_success: never
+    on_failure: always

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mass_rename.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lucas Street
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# mass_rename
+[![Build Status](https://travis-ci.org/lucis-fluxum/mass_rename.svg?branch=master)](https://travis-ci.org/lucis-fluxum/mass_rename) [![codecov](https://codecov.io/gh/lucis-fluxum/mass_rename/branch/master/graph/badge.svg)](https://codecov.io/gh/lucis-fluxum/mass_rename)
+
+Filter and mass rename files in a directory or subdirectories with regular expressions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mass_rename', git: 'https://github.com/lucis-fluxum/mass_rename.git'
+```
+
+And then execute:
+
+    $ bundle
+
+## 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
+
+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"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lucis-fluxum/mass_rename.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mass_rename'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/mass_rename

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'mass_rename'
+
+MassRename.run(ARGV)

data/lib/mass_rename/version.rb

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

data/lib/mass_rename.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'optparse'
+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]'
+
+      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('-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('-v', '--version', 'Display version') do
+        puts MassRename::VERSION
+      end
+
+      parser.on('-h', '--help', 'Print this help') do
+        puts parser
+      end
+
+      parser.parse!(args)
+    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]
+    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
+
+  # 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)
+    end
+  end
+end

data/mass_rename.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mass_rename/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mass_rename'
+  spec.version       = MassRename::VERSION
+  spec.author        = 'Luc Street'
+  spec.summary       = 'Mass rename files.'
+  spec.description   = 'Filter and rename multiple files in a directory or subdirectories with regular expressions.'
+  spec.homepage      = 'https://github.com/lucis-fluxum/mass_rename'
+  spec.license       = 'MIT'
+
+  spec.platform      = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 1.9'
+  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.metadata['yard.run'] = 'yri'
+
+  spec.add_development_dependency 'bundler'
+  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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: mass_rename
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Luc Street
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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
+    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: simplecov
+  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: codecov
+  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: yard
+  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'
+description: Filter and rename multiple files in a directory or subdirectories with
+  regular expressions.
+email: 
+executables:
+- mass_rename
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/mass_rename
+- lib/mass_rename.rb
+- lib/mass_rename/version.rb
+- mass_rename.gemspec
+homepage: https://github.com/lucis-fluxum/mass_rename
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Mass rename files.
+test_files: []