nrename 0.0.1

data/bin/nrename

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path '../../lib/nrename', __FILE__
+
+Nrename.run ARGV.dup

data/features/options_processing.feature

@@ -0,0 +1,35 @@
+Feature: Options processing
+  In order to use the program conveniently
+  As a user
+  I want options to be parsed correctly
+
+  Scenario: Displaying help when run with "-h"
+    When I run `nrename -h`
+    Then the exit status should be 0
+    And the stdout should contain "Usage: nrename "
+
+  Scenario: Displaying help when run without any options
+    When I run `nrename`
+    Then the exit status should be 0
+    And the stdout should contain "Usage: nrename "
+
+  Scenario: Displaying version
+    When I run `nrename --version`
+    Then the exit status should be 0
+    And the stdout should match /^(\d+)\.\g'1'\.\g'1'$/
+
+  Scenario: Passing valid directory name
+    Given a directory named "foo_bar"
+    When I run `nrename foo_bar`
+    Then the exit status should be 0
+
+  Scenario: Passing invalid directory name
+    When I run `nrename no_dir`
+    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
+    Given an empty file named "foo"
+    When I run `nrename foo`
+    Then the exit status should be 1
+    And the stderr should contain "foo is not a valid directory."

data/features/renaming_files.feature

@@ -0,0 +1,86 @@
+Feature: Renaming files
+  In order to get my files nicely sortable
+  As a user
+  I want program to rename files correctly
+
+  Scenario: Renaming files in specified directory
+    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 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  |
+
+  Scenario: Renaming files in current directory
+    Given a directory named "dir"
+    And the following empty files inside directory "dir":
+    | 1.txt    |
+    | 10.txt   |
+    When I cd to "dir"
+    And I run `nrename -X`
+    Then the exit status should be 0
+    And the following files should exist:
+    | 01.txt   |
+    | 10.txt   |
+
+  Scenario: Dry-run
+    Given a directory named "dir"
+    And the following empty files inside directory "dir":
+    | 1.txt    |
+    | 10.txt   |
+    | 0023.txt |
+    When I cd to "dir"
+    When I run `nrename`
+    Then the exit status should be 0
+    And the following files should exist:
+    | 1.txt    |
+    | 10.txt   |
+    | 0023.txt |
+    And the following files should not exist:
+    | 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  |
+    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   |
+    And the following files should exist inside directory "bar":
+    | 0033.txt |
+    | 1234.txt |
+
+  Scenario: Renaming files recursively
+    Given a directory named "foo"
+    And a directory named "bar"
+    And the following empty files inside directory "foo":
+    | 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   |
+    And the following files should exist inside directory "bar":
+    | 0033.txt |
+    | 1234.txt |

data/features/support/env.rb

@@ -0,0 +1,19 @@
+require 'aruba/cucumber'
+
+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

data/lib/nrename/directory.rb

@@ -0,0 +1,60 @@
+require 'pathname'
+require 'fileutils'
+
+module Nrename
+  class Directory
+    def initialize(dir)
+      @dir = Pathname.new dir
+
+      unless @dir.absolute?
+        fail ArgumentError, 'directory path should be absolute.'
+      end
+
+      opts = Nrename.options
+
+      @verbose = opts.verbose
+      @execute = opts.execute
+      @pattern = opts.pattern
+    end
+
+    def numbered_files
+      @numbered_files ||= @dir.children
+        .reject(&:directory?)
+        .select { |file| file.basename.to_s =~ @pattern }
+    end
+
+    def num_field_length
+      @num_field_length ||= max_number.to_s.size
+    end
+
+    def max_number
+      numbered_files.map(&method(:number_for)).max
+    end
+
+    def normalize
+      numbered_files.each do |old|
+        new = normalized_name_for(old)
+        next if old == new
+        FileUtils.mv old, new, {
+          :noop    => !@execute,
+          :verbose => @verbose
+        }
+      end
+    end
+
+    def normalized_name_for(path)
+      dirname, filename = path.split
+      new_filename = filename.to_s
+      new_filename[@pattern, 1] = adjusted_number_string_for(path)
+      dirname + new_filename
+    end
+
+    def number_for(path)
+      path.basename.to_s[@pattern, 1].to_i
+    end
+
+    def adjusted_number_string_for(path)
+      number_for(path).to_s.rjust num_field_length, '0'
+    end
+  end
+end

data/lib/nrename/options.rb

@@ -0,0 +1,82 @@
+require 'optparse'
+require 'ostruct'
+
+module Nrename
+  module Options
+    def self.parse(args)
+      default_options = {
+        :dirs      => [],
+        :execute   => false,
+        :pattern   => /(\d+)/,
+        :recursive => false,
+        :verbose   => true
+      }
+
+      options = OpenStruct.new default_options
+
+      executable_name = File.basename $PROGRAM_NAME
+
+      # display help if called through 'nrename' executable
+      # and without arguments
+      if args.empty? && executable_name == 'nrename'
+        args << '--help'
+      end
+
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{executable_name} [OPTINS] [DIR]..."
+
+        opts.separator ''
+        opts.separator 'Options:'
+
+        opts.on '-X', '--execute', "Do actual work" do |x|
+          options.execute = x
+        end
+
+        opts.on '-R', '--recursive',
+             'Process given directories recursively' do |rec|
+          options.recursive = rec
+        end
+
+        opts.on '-v', '--[no-]verbose', 'Run verbosely' do |v|
+          options.verbose = v
+        end
+
+        opts.on '-h', '--help', 'Display this message' do
+          puts opts
+          exit
+        end
+
+        opts.on '--version', 'Display version' do
+          puts VERSION
+          exit
+        end
+      end.parse!(args)
+
+      args.each do |arg|
+        dir = File.expand_path arg
+        if File.directory? dir
+          options.dirs << dir
+        else
+          warn "#{dir} is not a valid directory."
+          exit 1
+        end
+      end
+
+      if options.dirs.empty?
+        options.dirs << File.expand_path('.')
+      end
+
+      if options.recursive
+        options.dirs.dup.each do |dir|
+          Dir.glob "#{dir}/**/" do |subdir|
+            options.dirs << subdir.chomp('/')
+          end
+        end
+      end
+
+      options.dirs.uniq!
+
+      options
+    end
+  end
+end

data/lib/nrename/version.rb

@@ -0,0 +1,3 @@
+module Nrename
+  VERSION = "0.0.1"
+end

data/lib/nrename.rb

@@ -0,0 +1,20 @@
+$:.push File.expand_path(File.dirname __FILE__)
+
+require 'nrename/version'
+require 'nrename/directory'
+require 'nrename/options'
+
+module Nrename
+  def self.options
+    # return default options if not alredy set by .run():
+    @options ||= Options.parse []
+  end
+
+  def self.run(args=[])
+    @options = Options.parse args
+
+    options.dirs
+      .map { |dir| Directory.new dir }
+      .each &:normalize
+  end
+end

data/spec/nrename/directory_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe Nrename::Directory do
+  let(:test_dir) { '/tmp/test_dir' }
+
+  after :each do
+    rm_rf test_dir
+  end
+
+  describe '#numbered_files' do
+    it 'correctly determines number of numbered files' do
+      inside test_dir do
+        touch %w[1.rb 2.rb 3.rb]
+      end
+
+      dir = Nrename::Directory.new test_dir
+      dir.should have(3).numbered_files
+    end
+
+    it 'returns empty array when there is no num. files in dir' do
+      mkdir test_dir
+      dir = Nrename::Directory.new test_dir
+      dir.should have(:no).numbered_files
+    end
+
+    it 'does not care about non-numbered files' do
+      inside test_dir do
+        touch %w[1.rb 2.rb 3.rb foo.rb bar baz.java]
+      end
+
+      dir = Nrename::Directory.new test_dir
+      dir.should have(3).numbered_files
+    end
+
+    it 'does not care about directories' do
+      inside test_dir do
+        touch %w[1.rb 2.rb 3.rb]
+        mkdir %w[1 2 03 40 55]
+      end
+
+      dir = Nrename::Directory.new test_dir
+      dir.should have(3).numbered_files
+    end
+  end
+
+  describe '#field_length' do
+    it 'returns minimal number of digits to fit num of any file' do
+      inside test_dir do
+        touch %w[1 2 3 444 3234 5 6 7]
+      end
+
+      dir = Nrename::Directory.new test_dir
+      dir.num_field_length.should be == 4
+    end
+
+    it 'ignores starting zeros in number' do
+      inside test_dir do
+        touch %w[001 002 004 035]
+      end
+
+      dir = Nrename::Directory.new test_dir
+      dir.num_field_length.should be == 2
+    end
+  end
+
+  describe '#max_number' do
+    it 'returns maximum number for all file names' do
+      inside test_dir do
+        touch %w[1 2 3]
+      end
+
+      dir = Nrename::Directory.new test_dir
+      dir.max_number.should be == 3
+    end
+
+    it 'is not fooled by fancy file names' do
+      inside test_dir do
+        touch %w[001 foo003bar.java o98.c 30_999.rb]
+      end
+
+      dir = Nrename::Directory.new test_dir
+      dir.max_number.should be == 98
+    end
+  end
+
+  describe '#normalize' do
+    before do
+      Nrename.options.stub execute: true
+    end
+
+    it 'renames files so than they can be sorted properly' do
+      inside test_dir do
+        touch %w[1 2 3 10 11 004 005 006]
+      end
+
+      # turn off verbose output:
+      Nrename.options.stub verbose: false
+
+      dir = Nrename::Directory.new test_dir
+      dir.normalize
+
+      expected = %w[01 02 03 04 05 06 10 11]
+      renamed_files = Dir.entries(test_dir)
+      expected.each { |file| renamed_files.should include file }
+    end
+  end
+
+  describe '#normalized_name_for' do
+    it 'returns normalized name for file' do
+      dir = Nrename::Directory.new test_dir
+      file = Pathname.new(test_dir) + '1.txt'
+      dir.stub num_field_length: 4
+      new_name = dir.normalized_name_for(file).basename.to_s
+      new_name.should be == '0001.txt'
+    end
+  end
+
+  describe '#number_for' do
+    it 'returns number for file' do
+      inside test_dir do
+        touch 'av023cd.txt'
+      end
+
+      dir = Nrename::Directory.new test_dir
+      file = dir.numbered_files.first
+      dir.number_for(file).should be == 23
+    end
+  end
+
+  describe '#adjusted_number_string_for' do
+    it 'returns number string adjusted to field length' do
+      inside test_dir do
+        touch 'qwe0032rty.gif'
+      end
+
+      dir = Nrename::Directory.new test_dir
+      dir.stub num_field_length: 6
+      file = dir.numbered_files.first
+      dir.adjusted_number_string_for(file).should be == '000032'
+    end
+  end
+end

data/spec/nrename/options_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Nrename::Options do
+  def parse_options(args)
+    Nrename::Options.parse args
+  end
+
+  describe 'verbosity' do
+    it 'is on by default (when no arguments provided)' do
+      parse_options([]).verbose.should be_true
+    end
+
+    it 'is off when or "--no-verbose" switch is provided' do
+      parse_options(%w[--no-verbose]).verbose.should be_false
+    end
+  end
+
+  describe 'recursive processing' do
+    it 'is off by default' do
+      parse_options([]).recursive.should be_false
+    end
+
+    it 'is on when "-R" of "--recursive" is provided' do
+      %w[-R --recursive].each do |option|
+        parse_options([option]).recursive.should be_true
+      end
+    end
+  end
+
+  describe 'directory arguments' do
+    let(:test_dir) { File.expand_path 'test_dir' }
+    let(:subdirs) { %w[aa bb cc] }
+
+    before :all do
+      inside test_dir do
+        mkdir subdirs
+      end
+    end
+
+    after :all do
+      rm_rf test_dir
+    end
+
+    it 'captures rest of arguments as directories to process' do
+      subdirs.each do |subdir|
+        subdir_path =  File.expand_path subdir, test_dir
+        arg = File.join test_dir, subdir
+        parse_options([arg]).dirs.should include subdir_path
+      end
+    end
+
+    it 'captures current dir if no arguments provided' do
+      parse_options([]).dirs.should be == [File.expand_path('.')]
+    end
+
+    it 'recursively captures all subdirs when -R option provided' do
+      dirs = parse_options(['-R', test_dir]).dirs
+
+      dirs.should include test_dir
+
+      subdirs.each do |subdir|
+        dirs.should include File.join(test_dir, subdir)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rspec'
+require 'fileutils'
+
+require File.expand_path '../../lib/nrename', __FILE__
+
+module Support
+  def inside(dir, &block)
+    mkdir dir unless File.exists? dir
+    cd dir, &block
+  end
+end
+
+RSpec.configure do |config|
+  config.include FileUtils
+  config.include Support
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: nrename
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Victor Deryagin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &81769620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *81769620
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &81769410 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *81769410
+description: ''
+email:
+- vderyagin@gmail.com
+executables:
+- nrename
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/nrename
+- lib/nrename/options.rb
+- lib/nrename/version.rb
+- lib/nrename/directory.rb
+- lib/nrename.rb
+- spec/spec_helper.rb
+- spec/nrename/options_spec.rb
+- spec/nrename/directory_spec.rb
+- features/renaming_files.feature
+- features/support/env.rb
+- features/options_processing.feature
+homepage: ''
+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: nrename
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/spec_helper.rb
+- spec/nrename/options_spec.rb
+- spec/nrename/directory_spec.rb
+- features/renaming_files.feature
+- features/support/env.rb
+- features/options_processing.feature
+has_rdoc: