mmve 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff3cb10f46ee14137bfb99473ec4898d5c83acfc
-  data.tar.gz: 9bec858348ee596b1597096a0f6d7942bd98b765
+  metadata.gz: e49ee8d7e9c945585397a63e8be7d6b679fd01ed
+  data.tar.gz: 48c4f46ea97ddb0c19fee1fe5a5ff5a7185018e9
 SHA512:
-  metadata.gz: c8e5f51bccb5212f7e19cd204b1abc45ad6ef727bf031c0c5c95baa0127f4dcb341fa8d7dc5030a629285f8ca81558f4063aedc10270d4d7fa0d663be33e7006
-  data.tar.gz: 4aaac79acc5a36714df8c5032979dc51cdd0c2e7a35f2e4afe4281d4bcf516b883854a55db58320ae706ac7663a0ebad7af27c9b4d0697d57f1b869ea9170f68
+  metadata.gz: fbdca8890eea2a45ee55f07b0edb56469e53d76b39408c8dc1ec8c188871ba6702dd29848dad2810740a702af6ea4c3e414b59b531983805daffdb945d1d51a3
+  data.tar.gz: 0c9aa0f41cbcc9ee4374c10584f876e1bf9049c6eaa654813f4286faeced3a0d030289c0ba85681c17415a12b107cb378ee95328cf17f2dc02102956dc188e4e

data/README.md

@@ -2,19 +2,3 @@ MMVE
 ====
 
   Mass MV Edit: use your editor to move (rename) files.
-
-
-TODO
-----
-
-* Recurse directories:
-  - `-r some_dir` will rename `some_dir` entries.
-    `somedir/` could also be used
-  - `-rr some_dir` will rename all files found recursively in
-    `some_dir`
-
-* Handle conflicts in edited files
-
-* Make EDITOR configurable in the API, keep ENV['EDITOR'] as default.
-
-* Sort entries

data/bin/mmve

@@ -2,4 +2,4 @@
 
 require 'mmve'
 
-MMVE::CLI.new(ARGV).run!
+MMVE::CLI.run(ARGV)

data/lib/mmve.rb

@@ -1,4 +1,13 @@
+require 'baf/cli'
+
 require 'mmve/cli'
 require 'mmve/editor'
 require 'mmve/renamer'
 require 'mmve/version'
+
+module MMVE
+  Error                       = Class.new StandardError
+  RuntimeError                = Class.new Error
+  DestinationEntriesMismatch  = Class.new RuntimeError
+  DestructiveRename           = Class.new RuntimeError
+end

data/lib/mmve/cli.rb

@@ -1,31 +1,25 @@
 module MMVE
-  class CLI
-    USAGE = "Usage: #{File.basename $0} [ path ... ]".freeze
+  class CLI < Baf::CLI
+    USAGE = "Usage: #{File.basename $0} path [path ...]".freeze
 
-    def initialize arguments, stdout = $stdout
-      @arguments  = arguments
-      @stdout     = stdout
+    def initialize env, arguments, **opts
+      super
+      @editor   = opts[:editor] || Editor.new(ENV['EDITOR'])
+      @renamer  = opts[:renamer] || Renamer.new
     end
 
-    def run!
-      print_usage_and_exit if @arguments.include? '-h'
-      renamer.destinations = editor.edit renamer.sources
-      renamer.execute!
+    def setup
+      banner USAGE
+      flag_version MMVE::VERSION
     end
 
-    def editor
-      @editor ||= Editor.new ENV['EDITOR']
-    end
-
-    def renamer
-      @renamer ||= Renamer.new @arguments
+    def run
+      usage! unless arguments.any?
+      renamer.rename arguments, editor.edit(arguments)
     end
 
   private
 
-    def print_usage_and_exit
-      @stdout.puts USAGE
-      exit
-    end
+    attr_reader :editor, :renamer
   end
 end

data/lib/mmve/renamer.rb

@@ -1,17 +1,22 @@
 module MMVE
   class Renamer
-    attr_reader :sources
-    attr_accessor :destinations
-
-    def initialize paths
-      @sources      = paths
-      @destinations = @sources.dup
+    def initialize file: File
+      @file = file
     end
 
-    def execute!
-      [@sources, @destinations].transpose.each do |e|
-        File.rename *e if e.uniq.count == 2
+    def rename sources, destinations
+      fail DestinationEntriesMismatch if sources.size != destinations.size
+      [sources, destinations].transpose.each do |paths|
+        src, dst = paths
+        next if src == dst
+        fail DestructiveRename if sources.include? dst
+        fail DestructiveRename if file.exist? dst
+        file.rename *paths
       end
     end
+
+  private
+
+    attr_reader :file
   end
 end

data/lib/mmve/version.rb

@@ -1,3 +1,3 @@
 module MMVE
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: mmve
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Thibault Jouan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2017-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: baf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
-  type: :development
+        version: '0.11'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: baf-testing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '3.2'
 description: 'Mass MV Editor: move files with your favourite $EDITOR'
 email: tj@a13.fr
 executables:
@@ -74,32 +74,13 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Guardfile
-- LICENSE
 - README.md
-- Rakefile
 - bin/mmve
-- config/cucumber.yaml
-- 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:
 - BSD-3-Clause
@@ -120,8 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: mmve-0.1.2
+summary: Mass MV Editor
 test_files: []

data/.gitignore

@@ -1 +0,0 @@
-/tmp/

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/.travis.yml

@@ -1,42 +0,0 @@
-sudo: required
-dist: trusty
-language: c
-addons:
-  apt:
-    packages:
-      - realpath
-notifications:
-  email:
-    - tj+travis_mmve@a13.fr
-  on_success: never
-
-env:
-  - RUBYVER=2.4-stable
-  - RUBYVER=2.3-stable
-  - RUBYVER=2.2-stable
-  - RUBYVER=2.1-stable
-cache:
-  directories:
-    - ${HOME}/.gem/travis
-    - ${HOME}/usr
-  timeout: 3600
-
-before_install:
-  - sudo apt-get --purge remove ruby\*
-  - rm -rf ~/.bash*
-  - unset gem GEM_HOME GEM_PATH RUBYOPT IRBRC
-  - export PATH=/bin:/usr/bin RB=$HOME/usr/bin/ruby
-  - test -x $RB || wget http://ftp.ruby-lang.org/pub/ruby/ruby-${RUBYVER}.tar.xz
-  - test -x $RB || tar xfJ ruby-*.tar.xz
-  - test -x $RB || cd ruby-*
-  - test -x $RB || ./configure --prefix=$HOME/usr --disable-install-doc --with-out-ext=tk
-  - test -x $RB || (make && make install)
-  - echo "source 'https://rubygems.org'; gemspec" > ~/spec_deps.rb
-install:
-  - unset gem GEM_HOME GEM_PATH RUBYOPT IRBRC
-  - export GEM_HOME=~/.gem/travis GEM_PATH=~/.gem/travis
-  - export PATH=$GEM_HOME/bin:$HOME/usr/bin:/bin:/usr/bin
-  - cd $TRAVIS_BUILD_DIR
-  - gem install -g ~/spec_deps.rb
-script:
-  - MMVE_CI=yes RUBYOPT=-I$(realpath lib) rake

data/Guardfile

@@ -1,11 +0,0 @@
-guard :cucumber, cmd_additional_args: '--profile guard', all_on_start: false 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, cmd: 'rspec -f doc' 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

@@ -1,30 +0,0 @@
-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

@@ -1,11 +0,0 @@
-require 'cucumber/rake/task'
-require 'rspec/core/rake_task'
-
-
-task default: %i[features spec]
-
-Cucumber::Rake::Task.new :features do |t|
-  t.profile = 'quiet' if ENV.key? 'MMVE_CI'
-end
-
-RSpec::Core::RakeTask.new

data/config/cucumber.yaml

@@ -1,3 +0,0 @@
-default: --no-source
-guard: --format pretty --quiet
-quiet: --format progress

data/features/rename.feature

@@ -1,17 +0,0 @@
-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

@@ -1,3 +0,0 @@
-Given /^my editor is "([^"]+)"$/ do |editor|
-  set_environment_variable 'EDITOR', editor
-end

data/features/step_definitions/filesystem_steps.rb

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

data/features/support/env_aruba.rb

@@ -1,16 +0,0 @@
-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

@@ -1,23 +0,0 @@
-require 'cucumber/formatter/pretty'
-
-module Cucumber
-  module Ast
-    class DocString
-      alias :old_initialize :initialize
-
-      def initialize string, content_type
-        old_initialize string + $/, 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

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

data/mmve.gemspec

@@ -1,23 +0,0 @@
-require File.expand_path('../lib/mmve/version', __FILE__)
-
-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.license     = 'BSD-3-Clause'
-  s.homepage    = 'https://rubygems.org/gems/mmve'
-
-  s.authors     = 'Thibault Jouan'
-  s.email       = 'tj@a13.fr'
-
-  s.files       = `git ls-files`.split $/
-  s.executables = 'mmve'
-  s.extra_rdoc_files = %w[README.md]
-
-
-  s.add_development_dependency 'rake',      '~> 10.4'
-  s.add_development_dependency 'rspec',     '~> 3.2'
-  s.add_development_dependency 'cucumber',  '~> 1.3'
-  s.add_development_dependency 'aruba',     '~> 0.6'
-end

data/spec/mmve/cli_spec.rb

@@ -1,52 +0,0 @@
-RSpec.describe MMVE::CLI do
-  include ExitHelpers
-
-  let(:arguments) { %i[some arguments] }
-  let(:stdout)    { StringIO.new }
-  subject(:cli)   { described_class.new arguments, stdout }
-
-  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 <<-eoh
-Usage: rspec [ path ... ]
-        eoh
-      end
-
-      it 'exits successfully' do
-        expect { cli.run! }.to raise_error SystemExit do |e|
-          expect(e.status).to be 0
-        end
-      end
-    end
-  end
-end

data/spec/mmve/editor_spec.rb

@@ -1,76 +0,0 @@
-RSpec.describe MMVE::Editor do
-  let(:editor_command)  { 'some editor command' }
-  subject(:editor)      { described_class.new editor_command }
-
-  describe '#edit' do
-    let(:paths)     { %w[some_path other_path] }
-    let(:paths_str) { paths * $/ + $/ }
-
-    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

@@ -1,37 +0,0 @@
-RSpec.describe MMVE::Renamer do
-  let(:sources)       { %w[some_path other_path] }
-  let(:destinations)  { %w[renamed_path other_path] }
-  subject(:renamer)   { described_class.new sources }
-
-  it 'assigns destination paths equivalent to source paths' do
-    expect(renamer.destinations).to eq sources
-  end
-
-  it 'copies the assignated destinations paths' do
-    expect(renamer.destinations).not_to be sources
-  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

@@ -1,5 +0,0 @@
-require 'mmve'
-
-require 'support/exit_helpers'
-
-ENV['EDITOR'] = 'true'

data/spec/support/exit_helpers.rb

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