mmve 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile-custom.rb
+/Gemfile.lock
+/tmp/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+eval File.read('Gemfile-custom.rb') if File.exist?('Gemfile-custom.rb')

data/Guardfile

@@ -0,0 +1,11 @@
+guard :cucumber, cli: '--format pretty --quiet' do
+  watch(%r{\Afeatures/.+\.feature\z})
+  watch(%r{\Afeatures/support/.+\.rb\z})                { 'features' }
+  watch(%r{\Afeatures/step_definitions/.+_steps\.rb\z}) { 'features' }
+end
+
+guard :rspec do
+  watch(%r{\Aspec/.+_spec\.rb\z})
+  watch(%r{\Alib/(.+)\.rb\z})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')    { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright 2013 Thibault Jouan. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+  * Neither the name of the software nor the names of its contributors
+    may be used to endorse or promote products derived from this
+    software without specific prior written permission.
+
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+desc 'Run all scenarios'
+Cucumber::Rake::Task.new(:features)
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec)
+
+
+task default: [:features, :spec]

data/bin/mmve

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'mmve'
+
+MMVE::CLI.new(ARGV).run!

data/features/rename.feature

@@ -0,0 +1,17 @@
+Feature: Rename files
+
+  Background:
+    Given the following files exists:
+      | some_file     |
+      | another_file  |
+
+  Scenario: renames files given as arguments when the editor modify file paths
+    Given my editor is "ed"
+    When I run `mmve some_file another_file` interactively
+    And I type "%s/some/renamed/"
+    And I type "wq"
+    Then the exit status must be 0
+    Then the following files must exist:
+      | renamed_file |
+      | another_file |
+    And the file "some_file" must not exist

data/features/step_definitions/editor_steps.rb

@@ -0,0 +1,3 @@
+Given(/^my editor is "(.*?)"$/) do |editor|
+  set_env('EDITOR', editor)
+end

data/features/step_definitions/filesystem_steps.rb

@@ -0,0 +1,3 @@
+Given(/^the following files exists:$/) do |paths|
+  paths.raw.flatten.each { |p| write_file p, '' }
+end

data/features/support/env_aruba.rb

@@ -0,0 +1,16 @@
+module Cucumber
+  class Runtime
+    alias :old_step_match :step_match
+
+    def step_match(step_name, name_to_report = nil)
+      if step_name.include? ' must '
+        name_to_report = step_name.dup
+        step_name.gsub! ' must ', ' should '
+      end
+
+      old_step_match(step_name, name_to_report)
+    end
+  end
+end
+
+require 'aruba/cucumber'

data/features/support/env_cucumber-doc_string.rb

@@ -0,0 +1,23 @@
+require 'cucumber/formatter/pretty'
+
+module Cucumber
+  module Ast
+    class DocString
+      alias :old_initialize :initialize
+
+      def initialize(string, content_type)
+        old_initialize(string + "\n", content_type)
+      end
+    end
+  end
+
+  module Formatter
+    class Pretty
+      alias :old_doc_string :doc_string
+
+      def doc_string(string)
+        old_doc_string(string.chomp)
+      end
+    end
+  end
+end

data/features/usage.feature

@@ -0,0 +1,9 @@
+Feature: CLI usage
+
+  Scenario: prints the usage when -h argument is given
+    When I run `mmve -h`
+    Then the exit status must be 0
+    And the output must contain exactly:
+      """
+      Usage: mmve [ path ... ]
+      """

data/lib/mmve.rb

@@ -0,0 +1,4 @@
+require 'mmve/cli'
+require 'mmve/editor'
+require 'mmve/renamer'
+require 'mmve/version'

data/lib/mmve/cli.rb

@@ -0,0 +1,31 @@
+module MMVE
+  class CLI
+    USAGE = "Usage: #{File.basename $0} [ path ... ]"
+
+    def initialize(arguments, stdout = $stdout)
+      @arguments  = arguments
+      @stdout     = stdout
+    end
+
+    def run!
+      print_usage_and_exit if @arguments.include? '-h'
+      renamer.destinations = editor.edit renamer.sources
+      renamer.execute!
+    end
+
+    def editor
+      @editor ||= Editor.new(ENV['EDITOR'])
+    end
+
+    def renamer
+      @renamer ||= Renamer.new(@arguments)
+    end
+
+    private
+
+    def print_usage_and_exit
+      @stdout.puts USAGE
+      exit
+    end
+  end
+end

data/lib/mmve/editor.rb

@@ -0,0 +1,29 @@
+module MMVE
+  class Editor
+    require 'tempfile'
+
+    def initialize(editor_command)
+      @editor_command = editor_command
+    end
+
+    def edit(paths)
+      edited_content = with_temp_file(paths * "\n" + "\n") { |f| edit_file f }
+      edited_content.split "\n"
+    end
+
+    def with_temp_file(content)
+      content_after = ''
+      Tempfile.open(File.basename($0 + '_')) do |f|
+        f.write content
+        f.rewind
+        yield f
+        content_after = f.read
+      end
+      content_after
+    end
+
+    def edit_file(file)
+      system(*@editor_command.split, file.path)
+    end
+  end
+end

data/lib/mmve/renamer.rb

@@ -0,0 +1,17 @@
+module MMVE
+  class Renamer
+    attr_reader :sources
+    attr_writer :destinations
+
+    def initialize(paths)
+      @sources      = paths
+      @destinations = @sources.dup
+    end
+
+    def execute!
+      [@sources, @destinations].transpose.each do |e|
+        File.rename(*e) if e.uniq.count == 2
+      end
+    end
+  end
+end

data/lib/mmve/version.rb

@@ -0,0 +1,3 @@
+module MMVE
+  VERSION = '0.1.0'
+end

data/mmve.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH << lib unless $LOAD_PATH.include? lib
+require 'mmve/version'
+
+Gem::Specification.new do |s|
+  s.name    = 'mmve'
+  s.version = MMVE::VERSION
+  s.summary = "mmve-#{MMVE::VERSION}"
+  s.description = 'Mass MV Editor: move files with your favourite $EDITOR'
+  s.homepage = 'https://rubygems.org/gems/mmve'
+
+  s.authors = 'Thibault Jouan'
+  s.email   = 'tj@a13.fr'
+
+  s.files       = `git ls-files`.split $/
+  s.test_files  = s.files.grep /\A(spec|features)\//
+  s.executables = s.files.grep(/\Abin\//) { |f| File.basename(f) }
+
+
+  s.add_dependency 'net-ssh'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'rake'
+end

data/spec/mmve/cli_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe MMVE::CLI do
+  include ExitHelpers
+
+  let(:arguments) { [:some, :arguments] }
+  let(:stdout)    { StringIO.new }
+  subject(:cli)   { MMVE::CLI.new(arguments, stdout) }
+
+  describe '#initialize' do
+    it 'assigns the arguments' do
+      expect(cli.instance_eval { @arguments }).to eq arguments
+    end
+
+    it 'assigns the standard output' do
+      expect(cli.instance_eval { @stdout }).to eq stdout
+    end
+
+    context 'when no stdout is specified' do
+      subject(:cli) { MMVE::CLI.new(arguments) }
+
+      it 'assigns $stdout as a default standard output' do
+        expect(cli.instance_eval { @stdout }).to be $stdout
+      end
+    end
+  end
+
+  describe '#run!' do
+    it 'edits the renamer source paths' do
+      renamer = double('renamer').as_null_object
+      allow(cli).to receive(:renamer) { renamer }
+      expect(cli.editor).to receive(:edit).with(cli.renamer.sources)
+      cli.run!
+    end
+
+    it 'assigns the edited source paths as the renamer destination paths' do
+      editor = double('editor')
+      allow(cli).to receive(:editor) { editor }
+      allow(editor).to receive(:edit) { arguments }
+      expect(cli.renamer).to receive(:destinations=).with(arguments)
+      cli.run!
+    end
+
+    it 'executes the renamer' do
+      editor = double('editor').as_null_object
+      allow(cli).to receive(:editor) { editor }
+      expect(cli.renamer).to receive(:execute!)
+      cli.run!
+    end
+
+    context 'when one of the arguments is -h' do
+      let(:arguments) { %w[-h] }
+
+      it 'prints the usage' do
+        trap_exit { cli.run! }
+        expect(stdout.string).to eq MMVE::CLI::USAGE + "\n"
+      end
+
+      it 'exits successfully' do
+        expect { cli.run! }.to raise_error(SystemExit) do |e|
+          expect(e.code).to be 0
+        end
+      end
+    end
+  end
+
+  describe '#editor' do
+    it 'builds an editor with current $EDITOR' do
+      expect(MMVE::Editor).to receive(:new).with(ENV['EDITOR'])
+      cli.editor
+    end
+
+    it 'returns the editor' do
+      editor = double('editor')
+      allow(MMVE::Editor).to receive(:new) { editor }
+      expect(cli.editor).to be editor
+    end
+  end
+
+  describe '#renamer' do
+    it 'builds a renamer with the paths given as argument' do
+      expect(MMVE::Renamer).to receive(:new).with(arguments)
+      cli.renamer
+    end
+
+    it 'returns the renamer' do
+      renamer = double('renamer')
+      allow(MMVE::Renamer).to receive(:new) { renamer }
+      expect(cli.renamer).to be renamer
+    end
+  end
+end

data/spec/mmve/editor_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe MMVE::Editor do
+  let(:editor_command)  { 'some editor command' }
+  subject(:editor)      { MMVE::Editor.new(editor_command) }
+
+  describe '#initialize' do
+    it 'assigns the editor command' do
+      expect(editor.instance_eval { @editor_command }).to eq editor_command
+    end
+  end
+
+  describe '#edit' do
+    let(:paths)     { %w[some_path other_path] }
+    let(:paths_str) { paths * "\n" + "\n" }
+
+    it 'creates a temporary file with the paths as content' do
+      expect(editor)
+        .to receive(:with_temp_file).with(paths_str).and_return(paths_str)
+      editor.edit(paths)
+    end
+
+    it 'sends the edit_file message with the temporary file' do
+      expect(editor).to receive(:edit_file).with(any_args())
+      editor.edit(paths)
+    end
+
+    it 'returns the edited file paths as a list' do
+      allow(editor).to receive(:with_temp_file) { paths_str }
+      expect(editor.edit(paths)).to eq paths
+    end
+  end
+
+  describe '#with_temp_file' do
+    let(:content) { "some_content\n" }
+
+    it 'opens a temporary file' do
+      expect(Tempfile).to receive(:open).with('rspec_')
+      editor.with_temp_file(content) { }
+    end
+
+    it 'it writes the content to the file' do
+      file = double('file').as_null_object
+      allow(Tempfile).to receive(:open).and_yield(file)
+      expect(file).to receive(:write).with(content)
+      editor.with_temp_file(content) { }
+    end
+
+    it 'yields the block with the file as argument' do
+      file = double('file').as_null_object
+      allow(Tempfile).to receive(:open).and_yield(file)
+      expect { |b| editor.with_temp_file(content, &b) }.to yield_with_args(file)
+    end
+
+    it 'returns the temporary file content after yielding the block' do
+      new_content = "new_content\n"
+      expect(
+        editor.with_temp_file(content) { |f| File.write f.path, new_content }
+      ).to eq new_content
+    end
+  end
+
+  describe '#edit_file' do
+    let(:file) { double('file', path: 'some_path') }
+
+    it 'executes the editor command with the file path as argument' do
+      expect(editor).to receive(:system).with(*editor_command.split, file.path)
+      editor.edit_file(file)
+    end
+  end
+end

data/spec/mmve/renamer_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe MMVE::Renamer do
+  let(:sources)       { %w[some_path other_path] }
+  let(:destinations)  { %w[renamed_path other_path] }
+  subject(:renamer)   { MMVE::Renamer.new(sources) }
+
+  describe '#initialize' do
+    it 'assigns the source paths' do
+      expect(renamer.instance_eval { @sources }).to eq sources
+    end
+
+    it 'assigns destination paths equivalent to source paths' do
+      expect(renamer.instance_eval { @destinations }).to eq sources
+    end
+
+    it 'copies the assignated destinations paths' do
+      expect(renamer.instance_eval { @destinations }).to_not be sources
+    end
+  end
+
+  describe '#sources' do
+    it 'returns the source paths' do
+      expect(renamer.sources).to eq sources
+    end
+  end
+
+  describe '#destinations=' do
+    it 'assigns the destination paths' do
+      renamer.destinations = destinations
+      expect(renamer.instance_eval { @destinations }).to eq destinations
+    end
+  end
+
+  describe '#execute!' do
+    context 'when destinations differs from sources' do
+      before do
+        renamer.destinations = destinations
+      end
+
+      it 'renames the sources to the destinations' do
+        expect(File)
+          .to receive(:rename).with(sources.first, destinations.first)
+        renamer.execute!
+      end
+    end
+
+    context 'when destinations are the same as sources' do
+      let(:destinations) { sources }
+
+      it 'renames nothing' do
+        expect(File).not_to receive(:rename)
+        renamer.execute!
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'mmve'
+
+require 'support/exit_helpers'

data/spec/support/exit_helpers.rb

@@ -0,0 +1,6 @@
+module ExitHelpers
+  def trap_exit
+    yield
+  rescue SystemExit
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: mmve
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Thibault Jouan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Mass MV Editor: move files with your favourite $EDITOR'
+email: tj@a13.fr
+executables:
+- mmve
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- Rakefile
+- bin/mmve
+- features/rename.feature
+- features/step_definitions/editor_steps.rb
+- features/step_definitions/filesystem_steps.rb
+- features/support/env_aruba.rb
+- features/support/env_cucumber-doc_string.rb
+- features/usage.feature
+- lib/mmve.rb
+- lib/mmve/cli.rb
+- lib/mmve/editor.rb
+- lib/mmve/renamer.rb
+- lib/mmve/version.rb
+- mmve.gemspec
+- spec/mmve/cli_spec.rb
+- spec/mmve/editor_spec.rb
+- spec/mmve/renamer_spec.rb
+- spec/spec_helper.rb
+- spec/support/exit_helpers.rb
+homepage: https://rubygems.org/gems/mmve
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: mmve-0.1.0
+test_files:
+- features/rename.feature
+- features/step_definitions/editor_steps.rb
+- features/step_definitions/filesystem_steps.rb
+- features/support/env_aruba.rb
+- features/support/env_cucumber-doc_string.rb
+- features/usage.feature
+- spec/mmve/cli_spec.rb
+- spec/mmve/editor_spec.rb
+- spec/mmve/renamer_spec.rb
+- spec/spec_helper.rb
+- spec/support/exit_helpers.rb
+has_rdoc: