nrename 0.2.0 → 0.2.1

data/README.md

@@ -67,6 +67,8 @@ Options:
     -X, --execute                    Do actual work
     -R, --recursive                  Process given directories recursively
     -N, --numbers-only               Leave only numbers in file name
+    -D, --rename-dirs                Rename only directories instead of regular files
+        --renumber                   Renumber files from starting from 1 and on
         --regexp REGEXP              Use REGEXP to match filenames
     -v, --[no-]verbose               Run verbosely
     -h, --help                       Display this message

data/features/options_processing.feature

@@ -28,7 +28,7 @@ Feature: Options processing
     Then the exit status should be 1
     And the stderr should contain "no_dir is not a valid directory."
 
-  Scenario: Passing file instead of directory
+  Scenario: Passing regular file instead of directory
     Given an empty file named "foo"
     When I run `nrename foo`
     Then the exit status should be 1

data/features/renaming_files.feature

@@ -3,7 +3,7 @@ Feature: Renaming files
   As a user
   I want program to rename files correctly
 
-  Scenario: Renaming files in specified directory
+  Scenario: Renaming regular files in specified directory
     Given a directory named "dir"
     And the following empty files inside directory "dir":
     | 1.txt    |
@@ -14,11 +14,28 @@ Feature: Renaming files
     When I run `nrename -X dir`
     Then the exit status should be 0
     And the following files should exist inside directory "dir":
-    | 001.txt  |
-    | 010.txt  |
-    | 023.txt  |
-    | 101.txt  |
-    | 200.txt  |
+    | 001.txt |
+    | 010.txt |
+    | 023.txt |
+    | 101.txt |
+    | 200.txt |
+
+  Scenario: Renaming directories in specified directory
+    Given a directory named "dir"
+    And the following directories inside directory "dir":
+    | 1    |
+    | 10   |
+    | 0023 |
+    | 101  |
+    | 200  |
+    When I run `nrename -DX dir`
+    Then the exit status should be 0
+    And the following directories should exist inside directory "dir":
+    | 001 |
+    | 010 |
+    | 023 |
+    | 101 |
+    | 200 |
 
   Scenario: Dry-run
     Given a directory named "dir"
@@ -35,23 +52,23 @@ Feature: Renaming files
     | 10.txt   |
     | 0023.txt |
     And the following files should not exist:
-    | 01.txt   |
-    | 23.txt   |
+    | 01.txt |
+    | 23.txt |
 
   Scenario: Renaming files in multiple directories
     Given a directory named "foo"
     And a directory named "bar"
     And the following empty files inside directory "foo":
-    | 1.txt    |
-    | 010.txt  |
+    | 1.txt   |
+    | 010.txt |
     And the following empty files inside directory "bar":
     | 33.txt    |
     | 01234.txt |
     And I run `nrename -X foo bar`
     Then the exit status should be 0
     And the following files should exist inside directory "foo":
-    | 01.txt   |
-    | 10.txt   |
+    | 01.txt |
+    | 10.txt |
     And the following files should exist inside directory "bar":
     | 0033.txt |
     | 1234.txt |
@@ -60,16 +77,16 @@ Feature: Renaming files
     Given a directory named "foo"
     And a directory named "bar"
     And the following empty files inside directory "foo":
-    | 1.txt    |
-    | 010.txt  |
+    | 1.txt   |
+    | 010.txt |
     And the following empty files inside directory "bar":
     | 33.txt    |
     | 01234.txt |
     And I run `nrename -XR .`
     Then the exit status should be 0
     And the following files should exist inside directory "foo":
-    | 01.txt   |
-    | 10.txt   |
+    | 01.txt |
+    | 10.txt |
     And the following files should exist inside directory "bar":
     | 0033.txt |
     | 1234.txt |
@@ -105,3 +122,37 @@ Feature: Renaming files
     | 003_01.txt |
     | 003_10.txt |
     | 003_23.txt |
+
+  Scenario: Renaming files from scratch
+    Given a directory named "dir"
+    And the following empty files inside directory "dir":
+    | 1.txt    |
+    | 10.txt   |
+    | 0023.txt |
+    | 101.txt  |
+    | 200.txt  |
+    When I run `nrename -X --renumber dir`
+    Then the exit status should be 0
+    And the following files should exist inside directory "dir":
+    | 1.txt |
+    | 2.txt |
+    | 3.txt |
+    | 4.txt |
+    | 5.txt |
+
+  Scenario: Renaming files from scratch in right order
+    Given a directory named "dir"
+    And the following files with content inside directory "dir":
+    | 1.txt    | first  |
+    | 10.txt   | second |
+    | 0023.txt | third  |
+    | 101.txt  | fourth |
+    | 200.txt  | fifth  |
+    When I run `nrename -X --renumber dir`
+    Then the exit status should be 0
+    And the following files with content should exist inside directory "dir":
+    | 1.txt | first  |
+    | 2.txt | second |
+    | 3.txt | third  |
+    | 4.txt | fourth |
+    | 5.txt | fifth  |

data/features/support/env.rb

@@ -3,26 +3,14 @@ require 'fileutils'
 
 ENV['PATH'] = "#{File.expand_path __FILE__, '../../../bin'}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
 
-Given(/^the following empty files inside directory "([^"]*)":$/) do |directory, files|
-  files.raw.each do |file_row|
-    write_file "#{directory}/#{file_row[0]}", ''
-  end
-end
-
-Then(/^the stdout should match \/([^\/]*)\/$/) do |expected|
-  assert_matching_output expected, all_stdout
-end
-
-Then(/^the following files should exist inside directory "([^"]*)":$/) do |directory, files|
-  files.raw.each do |file_row|
-    check_file_presence ["#{directory}/#{file_row[0]}"], true
-  end
-end
+application_root = File.expand_path('../../..', __FILE__)
 
+# Account for slow JVM startup.
 Before do
-  @aruba_timeout_seconds = 10             # account for slow JVM startup
+  @aruba_timeout_seconds = 10
 end
 
+# Remove aruba's temporary directory after each scenario.
 After do
-  FileUtils.rm_rf File.expand_path('../../../tmp', __FILE__)
+  FileUtils.rm_rf File.expand_path 'tmp', application_root
 end

data/lib/nrename/directory.rb

@@ -7,20 +7,29 @@ module Nrename
     extend Forwardable
 
     def_delegator :numbered_files, :empty?
-    def_delegator :Nrename, :options
+    def_delegator Nrename, :options
 
     def initialize(dir)
       @dir = Pathname.new dir
     end
 
+    def directories
+      @dir.children.select &:directory?
+    end
+
+    def regular_files
+      @dir.children.select &:file?
+    end
+
     def files
-      @dir.children.reject &:directory?
+      options.rename_dirs ? directories : regular_files
     end
 
     def numbered_files
       @numbered_files ||= files.
         select { |file| file.basename.to_s =~ options.pattern }.
-        map &(NumberedFile.method :new)
+        map { |file| NumberedFile.new file }.
+        sort_by(&:number)
     end
 
     def num_field_length
@@ -28,13 +37,32 @@ module Nrename
     end
 
     def max_number
-      numbered_files.map(&:number).max
+      if options.renumber
+        numbered_files.size
+      else
+        numbered_files.map(&:number).max
+      end
     end
 
-    def normalize
+    def renumber
+      numbered_files.each_with_index do |file, idx|
+
+        # Force 1-based indexing (could use Enumerator#with_index with
+        # argument, but that would be incompatible with ruby-1.8).
+        idx += 1
+
+        file.normalize num_field_length, idx
+      end
+    end
+
+    def fix_numbers
       numbered_files.each do |file|
         file.normalize num_field_length
       end
     end
+
+    def normalize
+      options.renumber ? renumber : fix_numbers
+    end
   end
 end

data/lib/nrename/numbered_file.rb

@@ -4,23 +4,28 @@ require 'forwardable'
 
 module Nrename
   class NumberedFile
-    attr_reader :path, :number_length
+    attr_reader :path, :number_length, :override_number
 
     extend Forwardable
 
-    def_delegator :Nrename, :options
+    def_delegator Nrename, :options
 
     def initialize(path)
       @path = path
     end
 
     def number
-      path.basename.to_s[options.pattern, 1].to_i
+      override_number || path.basename.to_s[options.pattern, 1].to_i
     end
 
-    def normalize(length)
+    def normalize(length, override_number = nil)
       @number_length = length
-      new_name = normalized_path
+      @override_number = override_number
+
+      rename_to normalized_path
+    end
+
+    def rename_to(new_name)
       return if path == new_name
 
       FileUtils.mv path, new_name, {

data/lib/nrename/options.rb

@@ -2,6 +2,7 @@ require 'forwardable'
 require 'optparse'
 require 'ostruct'
 require 'set'
+require 'shellwords'
 require 'singleton'
 
 module Nrename
@@ -15,6 +16,8 @@ module Nrename
         :execute      => false,
         :pattern      => /(\d+)/,
         :recursive    => false,
+        :rename_dirs  => false,
+        :renumber     => false,
         :verbose      => true
       }
     end
@@ -26,6 +29,10 @@ module Nrename
       @options ||= OpenStruct.new default_options
     end
 
+    def reset
+      @options = nil
+    end
+
     def parser
       OptionParser.new do |opts|
         opts.banner = "Usage: #{Nrename.executable_name} [OPTINS] DIR..."
@@ -47,6 +54,16 @@ module Nrename
           options.numbers_only = n
         end
 
+        opts.on '-D', '--rename-dirs',
+        'Rename only directories instead of regular files' do |d|
+          options.rename_dirs = d
+        end
+
+        opts.on '--renumber',
+        'Renumber files from starting from 1 and on' do |renum|
+          options.renumber = renum
+        end
+
         opts.on '--regexp REGEXP', Regexp,
         'Use REGEXP to match filenames' do |regexp|
           options.pattern = regexp
@@ -69,8 +86,6 @@ module Nrename
     end
 
     def parse(args)
-      @options = nil
-
       # Display help if called through 'nrename' executable and without arguments:
       if args.empty? && Nrename.executable_name == 'nrename'
         args << '--help'
@@ -104,7 +119,7 @@ module Nrename
 
       if options.recursive
         dirs.dup.each do |dir|
-          Dir.glob(File.join dir, '**/') do |subdir|
+          Dir.glob(File.join dir.shellescape, '**/') do |subdir|
             dirs << subdir.chomp('/')
           end
         end

data/lib/nrename/version.rb

@@ -1,3 +1,3 @@
 module Nrename
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/nrename/directory_spec.rb

@@ -8,15 +8,71 @@ describe Nrename::Directory do
   end
 
   describe '#files' do
-    it 'returns all files inside directory' do
+    let(:files) { %w[foo bar baz] }
+    let(:dirs) { %w[quux corge grault garply] }
+
+    before :each do
+      inside test_dir do
+        touch files
+        mkdir dirs
+      end
+    end
+
+    it 'returns regular files when option "rename_dirs" is false' do
+      Nrename.options.stub :rename_dirs => false
+
+      dir = Nrename::Directory.new test_dir
+      dir_files = dir.files.map { |file| file.basename.to_s }
+
+      expect(dir_files).to match_array files
+    end
+
+    it 'returns directories when option "rename_dirs" is true' do
+      Nrename.options.stub :rename_dirs => true
+
+      dir = Nrename::Directory.new test_dir
+      dir_files = dir.files.map { |file| file.basename.to_s }
+
+      expect(dir_files).to match_array dirs
+    end
+  end
+
+  describe '#directories' do
+    it 'returns list of directories in given directory' do
+      dirs = %w[1 2 3 4 foo bar baz quux]
+
+      inside test_dir do
+        mkdir dirs
+      end
+
+      dir = Nrename::Directory.new test_dir
+      expect(dir).to have(dirs.length).directories
+    end
+
+    it 'ignores regular files' do
       files = %w[1.rb 2.rb 3.rb foo.rb bar baz.java]
+      dirs = %w[1 2 03 40 55]
 
       inside test_dir do
         touch files
+        mkdir dirs
       end
 
       dir = Nrename::Directory.new test_dir
-      expect(dir).to have(files.length).files
+      expect(dir).to have(dirs.length).directories
+    end
+  end
+
+  describe '#regular_files' do
+    it 'returns all regualr files in given directory' do
+      files = %w[1.rb 2.rb 3.rb foo.rb bar baz.java]
+
+      inside test_dir do
+        touch files
+      end
+
+      dir = Nrename::Directory.new test_dir
+      expect(dir).to have(files.length).regular_files
     end
 
     it 'ignores directories' do
@@ -29,7 +85,7 @@ describe Nrename::Directory do
       end
 
       dir = Nrename::Directory.new test_dir
-      expect(dir).to have(files.length).files
+      expect(dir).to have(files.length).regular_files
     end
   end
 
@@ -45,7 +101,7 @@ describe Nrename::Directory do
       expect(dir).to have(files.length).numbered_files
     end
 
-    it 'returns empty array when there is no num. files in dir' do
+    it 'returns empty collection when there is no numbered files in dir' do
       mkdir test_dir
       dir = Nrename::Directory.new test_dir
       expect(dir).to have(:no).numbered_files
@@ -63,19 +119,6 @@ describe Nrename::Directory do
       dir = Nrename::Directory.new test_dir
       expect(dir).to have(numbered_files.length).numbered_files
     end
-
-    it 'does not care about directories' do
-      files = %w[1.rb 2.rb 3.rb]
-      dirs = %w[1 2 03 40 55]
-
-      inside test_dir do
-        touch files
-        mkdir dirs
-      end
-
-      dir = Nrename::Directory.new test_dir
-      expect(dir).to have(files.length).numbered_files
-    end
   end
 
   describe '#field_length' do
@@ -132,6 +175,7 @@ describe Nrename::Directory do
       dir.normalize
 
       expected = %w[01 02 03 04 05 06 10 11]
+
       renamed_files = Dir.entries(test_dir).
         reject &(File.method :directory?)
 

data/spec/nrename/numbered_file_spec.rb

@@ -20,6 +20,13 @@ describe Nrename::NumberedFile do
       file = numbered_file '0001.txt'
       expect(file.number).to be == 1
     end
+
+    it 'handles different regular expressions' do
+      Nrename.options.stub :pattern => /^foo_0001_(\d+)\.txt$/
+
+      file = numbered_file 'foo_0001_0452.txt'
+      expect(file.number).to be == 452
+    end
   end
 
   describe '#normalized_path' do
@@ -31,11 +38,8 @@ describe Nrename::NumberedFile do
       it 'normalizes file name' do
         file = numbered_file 'abc_34.rb'
 
-        file.stub :number_length => 4
-        expect(file.normalized_path.to_s).to be == '0034.rb'
-
-        file.stub :number_length => 5
-        expect(file.normalized_path.to_s).to be == '00034.rb'
+        file.stub :number_length => 3
+        expect(file.normalized_path.to_s).to be == '034.rb'
       end
     end
 
@@ -47,9 +51,6 @@ describe Nrename::NumberedFile do
       it 'normalizes file name' do
         file = numbered_file 'abc_34.rb'
 
-        file.stub :number_length => 4
-        expect(file.normalized_path.to_s).to be == 'abc_0034.rb'
-
         file.stub :number_length => 5
         expect(file.normalized_path.to_s).to be == 'abc_00034.rb'
       end
@@ -62,9 +63,6 @@ describe Nrename::NumberedFile do
 
       file.stub :number_length => 4
       expect(file.adjusted_number).to be == '0123'
-
-      file.stub :number_length => 6
-      expect(file.adjusted_number).to be == '000123'
     end
   end
 end

data/spec/nrename/options_spec.rb

@@ -1,31 +1,115 @@
 require 'spec_helper'
+require 'forwardable'
 
 describe Nrename::Options do
+  extend Forwardable
+
+  def_delegator Nrename, :parse_options
+
+  after :each do
+    Nrename.options.reset                 # do not leak state
+  end
+
+  let(:defaults) { parse_options([]) }
+
   describe 'verbosity' do
-    it 'is on by default (when no arguments provided)' do
-      expect(Nrename.parse_options([]).verbose).to be_true
+    it 'is on by default' do
+      expect(defaults.verbose).to be_true
+    end
+
+    it 'is on when "-v" switch is provided' do
+      expect(parse_options(%w[-v]).verbose).to be_true
+    end
+
+    it 'is on when "--verbose" switch is provided' do
+      expect(parse_options(%w[--verbose]).verbose).to be_true
     end
 
-    it 'is off when or "--no-verbose" switch is provided' do
-      expect(Nrename.parse_options(%w[--no-verbose]).verbose).to be_false
+    it 'is off when "--no-verbose" switch is provided' do
+      expect(parse_options(%w[--no-verbose]).verbose).to be_false
     end
   end
 
   describe 'recursive processing' do
     it 'is off by default' do
-      expect(Nrename.parse_options([]).recursive).to be_false
+      expect(defaults.recursive).to be_false
     end
 
-    it 'is on when "-R" of "--recursive" is provided' do
-      %w[-R --recursive].each do |option|
-        expect(Nrename.parse_options([option]).recursive).to be_true
-      end
+    it 'is on when "-R" switch is provided' do
+      expect(parse_options(%w[-R]).recursive).to be_true
+    end
+
+    it 'is on when "--recursive" switch is provided' do
+      expect(parse_options(%w[--recursive]).recursive).to be_true
+    end
+  end
+
+  describe 'perform actual renaming' do
+    it 'is off by default' do
+      expect(defaults.execute).to be_false
+    end
+
+    it 'is on when "-X" switch is provided' do
+      expect(parse_options(%w[-X]).execute).to be_true
+    end
+
+    it 'is on when "--execute" switch is provided' do
+      expect(parse_options(%w[--execute]).execute).to be_true
+    end
+  end
+
+  describe 'regular expression' do
+    it 'has a default value' do
+      expect(defaults.pattern).to be == /(\d+)/
+    end
+
+    it 'can be provided with "--regexp" switch' do
+      regexp = parse_options(%w[--regexp _(\d+)_]).pattern
+      expect(regexp).to be == /_(\d+)_/
+    end
+  end
+
+  describe 'leaving numbers only' do
+    it 'is off by default' do
+      expect(defaults.numbers_only).to be_false
+    end
+
+    it 'is on when "-N" switch is provided' do
+      expect(parse_options(%w[-N]).numbers_only).to be_true
+    end
+
+    it 'is on when "--numbers-only" switch is provided' do
+      expect(parse_options(%w[--numbers-only]).numbers_only).to be_true
+    end
+  end
+
+  describe 'renaming of directories' do
+    it 'is off by default' do
+      expect(defaults.rename_dirs).to be_false
+    end
+
+    it 'is on when "-D" switch is provided' do
+      expect(parse_options(%w[-D]).rename_dirs).to be_true
+    end
+
+    it 'is on when "--rename-dirs" switch is provided' do
+      expect(parse_options(%w[--rename-dirs]).rename_dirs).to be_true
+    end
+  end
+
+  describe 'renumbering files from scratch' do
+    it 'is off by default' do
+      expect(defaults.renumber).to be_false
+    end
+
+    it 'is on when "--renumber" switch is provided' do
+      expect(parse_options(%w[--renumber]).renumber).to be_true
     end
   end
 
   describe 'directory arguments' do
-    let(:test_dir) { File.expand_path 'test_dir' }
-    let(:subdirs) { %w[aa bb cc] }
+    let(:test_dir) { File.expand_path 'test ][ directory' }
+    let(:subdirs) {  ['aa', 'bb', 'cc' 'foo bar [baz] (quux)'] }
 
     before :all do
       inside test_dir do
@@ -41,16 +125,16 @@ describe Nrename::Options do
       subdirs.each do |subdir|
         subdir_path =  File.expand_path subdir, test_dir
         arg = File.join test_dir, subdir
-        expect(Nrename.parse_options([arg]).dirs).to include subdir_path
+        expect(parse_options([arg]).dirs).to include subdir_path
       end
     end
 
     it 'empty if no arguments provided' do
-      expect(Nrename.parse_options([]).dirs).to be_empty
+      expect(defaults.dirs).to be_empty
     end
 
     it 'recursively captures all subdirs when -R option provided' do
-      dirs = Nrename.parse_options(['-R', test_dir]).dirs
+      dirs = parse_options(['-R', test_dir]).dirs
 
       expect(dirs).to include test_dir
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nrename
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-24 00:00:00.000000000 Z
+date: 2012-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -59,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 597873344998439750
+      hash: 3302606396241923876
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: