batch_rename 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48721868993417bc6fa05e903c312b6a86243be9
+  data.tar.gz: 84cd80c60c5560fd8a71bd0d9bde4497e7c2ed51
+SHA512:
+  metadata.gz: d26499f7b7d2d6220336f939421a064789f33d08ab6273e9e04eaea0fa41d66f2b0c9a714365b7762734f399f771f31e3a024abea5c64014c7b3384c6984a3ba
+  data.tar.gz: 33882775aa1b306e5971d518ee05de86bd4fa4542d948efdbf340d101a3ab6047da88e4d9ed764995bf791c1ecc45265e49faee8a28bcaaced7f65bca71136cf

data/.gitattributes

@@ -0,0 +1 @@
+*.gemspec diff

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in batch_rename.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2015, Claudia Pellegrino
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+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/README.md

@@ -0,0 +1,70 @@
+# batch_rename
+
+This gem provides a CLI command:
+
+> `batch-rename`
+
+to **bulk rename files** in OS X using an interactive text editor.
+
+
+## Background
+
+This gem was inspired by a question from StackExchange user [Yuriy Babenko](http://apple.stackexchange.com/users/71676) in June 2015 where he asked whether there was [an OS X app/way to batch rename files via a purely text interface](http://apple.stackexchange.com/questions/192984).
+
+
+## System requirements
+
+* This gem has been tested on **OS X Yosemite only.**  
+It should be trivial though to make it work on Windows, Linux, or OS X pre-Yosemite. PRs are welcome!
+
+* The gem **depends on DiffMerge** to be installed, a visual diff editor developed by SourceGear. See the next section for details.
+
+
+## Installation
+
+1. First, make sure you have [DiffMerge](https://sourcegear.com/diffmerge) installed. You can either download it from [SourceGear’s website](https://sourcegear.com/diffmerge/downloads.php) or via [Homebrew Cask](http://caskroom.io) (`brew cask install diffmerge`).
+
+2. Install the gem:
+
+```sh
+gem install batch_rename
+```
+
+
+## Usage
+
+1. Open Terminal.app.
+
+2. `cd` to the directory whose content you want to rename.
+
+3. Enter the command:
+
+```sh
+batch-rename
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/claui/batch_rename.
+
+
+## Credits
+
+The idea for batch_rename was taken from [a question](http://apple.stackexchange.com/questions/192984) by Yuriy Babenko on apple.stackexchange.com.
+
+
+## Legal notice
+
+This gem depends on the software DiffMerge to be installed, a product from [SourceGear, LLC](https://sourcegear.com).  
+SourceGear, LLC has no connection to batch_rename or to its author whatsoever. In particular, they do not endorse batch_rename or its usage.
+
+A separate [license agreement for DiffMerge](https://sourcegear.com/diffmerge/webhelp/chapter_sourcegearlicenseagreement.html) can be found on SourceGear’s website.
+
+
+## License
+
+Copyright (c) 2015, Claudia Pellegrino
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :test => :spec

data/batch_rename.gemspec

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'batch_rename/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "batch_rename"
+  spec.version       = BatchRename::VERSION
+  spec.licenses      = ["ISC"]
+  spec.authors       = ["Claudia"]
+  spec.email         = ["dieclau@eml.cc"]
+
+  spec.summary       = "Batch rename files in OS X using an interactive editor"
+  spec.description   = <<-EOF
+This gem provides a CLI command `batch-rename` to bulk rename files in OS&nbsp;X using an interactive text editor. It has been inspired by a question on Stack Exchange.
+  EOF
+  spec.homepage      = "http://github.com/claui/batch_rename"
+
+  all_files = `git ls-files -z`.split("")
+  spec_test_files, spec.files = all_files.partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = ["batch-rename"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/batch-rename

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'batch_rename/cli'
+
+BatchRename::CLI.run!

data/lib/batch_rename.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'shellwords'
+require 'tmpdir'
+
+require "batch_rename/catalog"
+require "batch_rename/editor"
+require "batch_rename/version"

data/lib/batch_rename/catalog.rb

@@ -0,0 +1,21 @@
+module BatchRename
+  class Catalog
+    attr_reader :section, :title, :diff_tmp_dir
+
+    def escaped_file_name
+      Shellwords.escape(file_name)
+    end
+
+    def file_name
+      "#{ diff_tmp_dir }/#{ section.capitalize } renaming.utf8"
+    end
+
+    private
+
+    def initialize(section, title, diff_tmp_dir)
+      @section = section
+      @title = title
+      @diff_tmp_dir = diff_tmp_dir
+    end
+  end
+end

data/lib/batch_rename/cli.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'batch_rename'
+
+module BatchRename
+  class CLI
+    EXIT_CODE_SUCCESS = 0
+    EXIT_CODE_FAILURE = 1
+
+    EDITOR = Editor::DiffMerge
+
+    INSTRUCTIONS = {
+      :before => "Original file names – do not edit the field below",
+      :after => "Rename your files below. Press ⌘S to save, ⌘Q to quit"
+    }
+
+    attr_reader :catalogs, :diff_tmp_dir
+
+    def self.run!
+      begin
+        CLI::new.run!
+        exit EXIT_CODE_SUCCESS
+      rescue Editor::EditorNotFoundError => e
+        warn e.message
+        exit EXIT_CODE_FAILURE
+      end
+    end
+
+    def run!
+      caption = "batch_rename v#{VERSION} - #{ Dir.pwd }"
+      write_catalog_files!
+
+      puts 'Launching graphical editor…'
+      result = EDITOR.new(catalogs, caption).launch!.result
+
+      puts "Renaming #{ result.modified_count } file(s)"
+      puts rename!(result)
+    end
+
+    private
+
+    def initialize
+      @diff_tmp_dir = Dir.mktmpdir('batch-rename-')
+
+      @catalogs = [
+        Catalog.new(:before, INSTRUCTIONS[:before], diff_tmp_dir),
+        Catalog.new(:after, INSTRUCTIONS[:after], diff_tmp_dir)
+      ]
+    end
+
+    def write_catalog_files!
+      `ls -A | tee #{ catalogs.map(&:escaped_file_name).join(' >') }`
+    end
+
+    def rename!(result)
+      result.modified_pairs
+        .map { |pair| pair.map(&Shellwords.method(:escape)) }
+        .map { |a, b| `mv -nv #{a} #{b}` }
+    end
+  end
+end

data/lib/batch_rename/editor.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module BatchRename
+  class Editor; end
+end
+
+require 'batch_rename/editor/editor_base'
+require 'batch_rename/editor/editor_not_found_error'
+require 'batch_rename/editor/result'
+
+require 'batch_rename/editor/diff_merge'

data/lib/batch_rename/editor/diff_merge.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module BatchRename
+  class Editor::DiffMerge < Editor::EditorBase
+    PATH = '/usr/local/bin/diffmerge'
+
+    def launch!
+      unless system(PATH, *args)
+        raise(Editor::EditorNotFoundError.new(PATH))
+      end
+      self
+    end
+
+    def args
+      args = ['--nosplash']
+      args << "-c=#{ caption }" if caption
+
+      catalogs.each_with_index do |catalog, index|
+        args << "-t#{ index+1 }=#{ catalog.title }"
+        args << catalog.file_name
+      end
+
+      args
+    end
+  end
+end

data/lib/batch_rename/editor/editor_base.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module BatchRename
+  class Editor::EditorBase
+    attr_reader :catalogs, :caption
+
+    def result
+      @result ||= Editor::Result.new(catalogs)
+    end
+
+    private
+
+    def initialize(catalogs, caption = nil)
+      @catalogs = catalogs
+      @caption = caption
+    end
+  end
+end

data/lib/batch_rename/editor/editor_not_found_error.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module BatchRename
+  class Editor::EditorNotFoundError < StandardError
+    attr_reader :path
+
+    def message
+      "Unable to launch \"#{ path }\"; is DiffMerge installed?"
+    end
+
+    private
+
+    def initialize(path)
+      @path = path
+    end
+  end
+end

data/lib/batch_rename/editor/result.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module BatchRename
+  class Editor::Result
+    attr_reader :catalogs
+
+    def total_count
+      pairs.length
+    end
+
+    def modified_count
+      modified_pairs.length
+    end
+
+    def pairs
+      @pairs = lines.reduce(&:zip)
+    end
+
+    def modified_pairs
+      @modified_pairs ||= pairs.select { |a| a.reduce(&:!=) }
+    end
+
+    def to_s
+      pairs.to_s
+    end
+
+    private
+
+    def initialize(catalogs)
+      @catalogs = catalogs
+    end
+
+    def lines
+      @lines ||= catalogs.map do |catalog|
+        File.open(catalog.file_name).each.map(&:chop)
+      end
+    end
+  end
+end

data/lib/batch_rename/version.rb

@@ -0,0 +1,3 @@
+module BatchRename
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: batch_rename
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Claudia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  This gem provides a CLI command `batch-rename` to bulk rename files in OS X using an interactive text editor. It has been inspired by a question on Stack Exchange.
+email:
+- dieclau@eml.cc
+executables:
+- batch-rename
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitattributes
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- batch_rename.gemspec
+- bin/batch-rename
+- lib/batch_rename.rb
+- lib/batch_rename/catalog.rb
+- lib/batch_rename/cli.rb
+- lib/batch_rename/editor.rb
+- lib/batch_rename/editor/diff_merge.rb
+- lib/batch_rename/editor/editor_base.rb
+- lib/batch_rename/editor/editor_not_found_error.rb
+- lib/batch_rename/editor/result.rb
+- lib/batch_rename/version.rb
+homepage: http://github.com/claui/batch_rename
+licenses:
+- ISC
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Batch rename files in OS X using an interactive editor
+test_files: []