file_renamer 0.1.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6fe61d9eb0216d0be9aea5e4a1fc248faddac51a955334fddb57a45ebd24c8c
-  data.tar.gz: e4d291324489972119092196e1821e0c05e1fdf9302edbef8ce5e495728e705c
+  metadata.gz: abfc8171a09153f98a5e713ef7a70a91882c9db60434101921714cf4dc1c467b
+  data.tar.gz: 4c04c4eec580a8460db6d9f2197c8c25cab8443cebd75e890229baef4a17c4e1
 SHA512:
-  metadata.gz: 8bf4eefa65ded92112fc40b1c3a3fda55e525bcf11464958ecc66080086121b9525151a0311986bcc8294236cd9a74a5009712a11058bfdb538ec611452bcc92
-  data.tar.gz: ed435b66f5eed781d750ee9c62f6f818a9e923288ba740758b806b22f6f5acb345a1a28624effe7e72a042a74a3c5c74e6c86a5d961400d478d5f8799a5cfab3
+  metadata.gz: c67b670abd019667dcdb11530240f76b3429005018049b6295d7f683529e248827edf4820495b7d11e5d1f42af44a4308fd96388188f4e737aba47d9f2d748cd
+  data.tar.gz: bff076f6cdaf1c2896e2a6e6ae8f6f95330679511973a916ac33de1cbd85de8ef7b3e4dcf708019b9c53aea5011654b63e35fbaf76b960da768bfd5af71f0401

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in file_renamer.gemspec
+gem "rspec", "~> 3.10"
+gem "rake", "~> 13.0"
+gem "bundler", "~> 2.1"
+gem "thor", "~> 1.0"
+gem 'simplecov', require: false, group: :test

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    rake (13.0.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  simplecov
+  thor (~> 1.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,5 +1,8 @@
-  ![](https://ruby-gem-downloads-badge.herokuapp.com/file_renamer?&style=plastic)
-  ![](http://badges.github.io/stability-badges/dist/experimental.svg)
+  ![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/file_renamer?&style=plastic)
+  [![Build Status](https://img.shields.io/travis/tee0zed/file_renamer)](https://travis-ci.org/github/tee0zed/file_renamer)
+  [![Code Coverage](https://img.shields.io/badge/SimpleCov-%2099.46%25-brightgreen)](https://img.shields.io/badge/SimpleCov-%2099.46%25-green)
+  [![Stability]( https://img.shields.io/badge/stability%20-stable-brightgreen)]( https://img.shields.io/badge/stability%20-stable-brightgreen)
+ 
   
 # FileRenamer
 
@@ -27,7 +30,7 @@ Or install it yourself as:
 
 ### From terminal
 
-    filerenamer [options]
+    file_renamer [options]
     -d --dir (optional)
     -p --prefix (optional)
     -e --extension (optional)
@@ -62,12 +65,19 @@ Or install it yourself as:
 
 ### In your project 
 
-    FileRenamer::Renamer.rename!(params) 
+    FileRenamer::PathProcessor.run!(params) 
+    
 where 
- - params[:dir] - for execution directory (required)
- - params[:prefix] - for filename's prefixes 
- - params[:ext] - for filename's extensions
- - params[:name] - for filename's new names (required)
+  - params[:dir] - for execution directory (required)
+  - params[:prefix] - for filename's prefixes 
+  - params[:ext] - for filename's extensions
+  - params[:name] - for filename's new names (required)
+ 
+ or 
+  - corrected_params[:dir] - for execution directory (required)
+  - corrected_params[:prefix] - for filename's prefixes 
+  - corrected_params[:ext] - for filename's extensions
+  - corrected_params[:name] - for filename's new names (required)
 
 ## Development
 
@@ -94,4 +104,4 @@ in project folder to run all specs
 
 MIT License. 
 
-2020 Tee Zed
+2020 Tee Zed

data/Rakefile

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
 desc 'Spec all'
 task :spec_all do
-  system("rspec spec/*")
-end
+  system('rspec spec/*')
+end

data/bin/file_renamer

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require_relative '../lib/path_processor'
+require_relative '../lib/name_alterer'
+require_relative '../lib/params_corrector'
+
+begin
+  params = {}
+  OptionParser.new do |opts|
+    opts.on('-n STRING', '--name', 'new filename (don\'t use spaces!)', String)
+    opts.on('-p STRING', '--prefix', 'prefix of the filename', String)
+    opts.on('-e STRING', '--ext', 'extension of the filename', String)
+    opts.on('-d STRING', '--dir', 'working directory (current by default)', String)
+  end.parse!(into: params)
+rescue OptionParser::MissingArgument
+  puts 'Argument error.'
+end
+
+begin
+  session = FileRenamer::PathProcessor.new({ params: params })
+rescue StandardError => e
+  abort "#{e.message}"
+end
+
+session.rename_files!
+
+puts "#{session.counter} paths renamed!"

data/lib/name_alterer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module FileRenamer
+  class NameAlterer
+    attr_reader :filename,
+                :number,
+                :name
+
+    def initialize
+      @filename
+      @number
+      @name
+    end
+
+    def renamed_filename(args)
+      init_params(args)
+      name_with_extension
+    end
+
+    private
+
+    def init_params(args)
+      @filename = args[:filename]
+      @number   = args[:number]
+      @name     = args[:new_name]
+    end
+
+    def name_with_extension
+      filename.gsub(/^\w+./, "#{numbered_name}.")
+    end
+
+    def numbered_name
+      number.zero? ? name.to_s : "#{name}_#{number}"
+    end
+  end
+end

data/lib/params_corrector.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module FileRenamer
+  class ParamsCorrector
+    SLASH = Gem.win_platform? ? '\\' : '/'
+    FILENAME_REGEXP = /^[a-zA-Z_0-9-]+$/.freeze
+    EXTENSION_REGEXP = /^[a-zA-Z0-9_.]{1,6}$/.freeze
+
+    attr_accessor :params
+
+    def initialize
+      @params
+    end
+
+    def corrected_params(params)
+      init_params(params)
+      params_correction!
+      self.params
+    end
+
+    def init_params(params)
+      self.params = params
+    end
+
+    private
+
+    def params_correction!
+      params[:dir]    = correct_dir(params[:dir])
+      params[:name]   = correct_name(params[:name])
+      params[:prefix] = correct_prefix(params[:prefix])
+      params[:ext]    = correct_ext(params[:ext])
+    end
+
+    def correct_dir(dir)
+      if dir.nil?
+        Dir.pwd + SLASH
+      elsif File.directory?(dir)
+        dir += SLASH if dir[-1] != SLASH
+        dir
+      else
+        raise StandardError.new "Directory must exist!"
+      end
+    end
+
+    def correct_name(name)
+      if name.to_s.match?(FILENAME_REGEXP)
+        name.strip.chomp
+      else
+        raise StandardError.new "Incorrect name!"
+      end
+    end
+
+    def correct_prefix(prefix)
+      prefix.to_s.strip
+    end
+
+    def correct_ext(ext)
+      if ext.to_s.match?(EXTENSION_REGEXP)
+        ext[0] == '.' ? ext : ext.prepend('.')
+      end
+    end
+  end
+end

data/lib/path_processor.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative 'name_alterer'
+require_relative 'params_corrector'
+
+module FileRenamer
+  class PathProcessor
+    attr_accessor :counter
+
+    attr_reader   :name_alterer,
+                  :extension,
+                  :name,
+                  :prefix,
+                  :directory,
+                  :paths,
+                  :params
+
+    def self.run!(args = {})
+      self.new(args).rename_files!
+    end
+
+    def initialize(args)
+      @params       = args[:corrected_params] || ParamsCorrector.new.corrected_params(args[:params])
+      @name_alterer = args.fetch(:name_alterer, NameAlterer.new)
+
+      init_corrected_params
+
+      @paths   = paths
+      @counter = 0
+    end
+
+    def rename_files!
+      paths.each do |path|
+        process_path(path) if should_be_renamed?(path)
+      end
+    end
+
+    private
+
+    def init_corrected_params
+      @extension = params[:ext]
+      @name      = params[:name]
+      @directory = params[:dir]
+      @prefix    = params[:prefix]
+    end
+
+    def process_path(path)
+      old_filename = slice_filename(path)
+      renamed_filename = name_alterer.renamed_filename({ filename: old_filename,
+                                                             number: counter,
+                                                             new_name: name })
+
+      renamed_path = renamed_path(path, old_filename, renamed_filename)
+
+      rename_file!(path, renamed_path)
+      self.counter += 1
+    end
+
+    def rename_file!(path, renamed_path)
+      File.rename(path, renamed_path)
+    end
+
+    def renamed_path(path, filename, new_filename)
+      path.gsub(filename, new_filename)
+    end
+
+    def should_be_renamed?(path)
+      matches_pattern?(path) && is_file?(path)
+    end
+
+    def paths
+      Dir["#{directory}*"].sort
+    end
+
+    def matches_pattern?(path)
+      slice_filename(path).match?(Regexp.new("^#{prefix}.*#{extension}$"))
+    end
+
+    def is_file?(path)
+      !File.directory?(path)
+    end
+
+    def slice_filename(path)
+      path.slice(%r{([^/|\\]+$)})
+    end
+  end
+end

data/spec/name_alterer_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'NameAlterer#renamed_filename' do
+  context 'when single file with one extension rename' do
+    let(:params_1) { { filename: 'IMG_123.jpg', number: 0, new_name: 'new_name' } }
+    let(:path_alterer_1) { FileRenamer::NameAlterer.new }
+
+    it 'renames only name' do
+      expect(path_alterer_1.renamed_filename(params_1)).to eq 'new_name.jpg'
+    end
+  end
+
+  context 'when second file with one extension rename' do
+    let(:params_2) { { filename: 'IMG_123.jpg', number: 1, new_name: 'new_name' } }
+    let(:path_alterer_2) { FileRenamer::NameAlterer.new }
+
+    it 'adds number to name' do
+      expect(path_alterer_2.renamed_filename(params_2)).to eq 'new_name_1.jpg'
+    end
+  end
+
+  context 'when single file with two extensions rename' do
+    let(:params_3) { { filename: 'IMG_123.html.erb', number: 0, new_name: 'new_name' } }
+    let(:path_alterer_3) { FileRenamer::NameAlterer.new }
+
+    it 'renames only name' do
+      expect(path_alterer_3.renamed_filename(params_3)).to eq 'new_name.html.erb'
+    end
+  end
+
+  context 'when second file with two extensions rename' do
+    let(:params_4) { { filename: 'IMG_123.html.erb', number: 2, new_name: 'new_name' } }
+    let(:path_alterer_4) { FileRenamer::NameAlterer.new }
+
+    it 'adds number to name' do
+      expect(path_alterer_4.renamed_filename(params_4)).to eq 'new_name_2.html.erb'
+    end
+  end
+end

data/spec/params_corrector_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: false
+
+require 'spec_helper'
+
+describe 'ParamsCorrector#corrected_params' do
+  before :each do
+    @corrector = FileRenamer::ParamsCorrector.new
+  end
+
+  context 'when extension parameter correction' do
+    let(:params) { { ext: 'jpg', dir: './spec/fixtures/dir/', prefix: nil, name: 'new_name' } }
+    it 'return ext string with dot if ext not nil' do
+      corrected_params = @corrector.corrected_params(params)
+      expect(corrected_params[:ext]).to eq '.jpg'
+    end
+
+    let(:params1) { { ext: '.jpg', dir: './spec/fixtures/dir/', prefix: nil, name: 'new_name' } }
+    it 'return ext string with dot if ext not nil' do
+      corrected_params = @corrector.corrected_params(params1)
+      expect(corrected_params[:ext]).to eq '.jpg'
+    end
+
+    let(:params2) { { ext: 'jpganyany', dir: './spec/fixtures/dir/', prefix: nil, name: 'new_name' } }
+    it 'return nil if ext not matches regexp' do
+      corrected_params = @corrector.corrected_params(params2)
+      expect(corrected_params[:ext]).to eq nil
+    end
+
+    let(:params3) { { ext: nil, dir: './spec/fixtures/dir/', prefix: nil, name: 'new_name' } }
+    it 'return nil if ext nil' do
+      corrected_params = @corrector.corrected_params(params3)
+      expect(corrected_params[:ext]).to eq nil
+    end
+  end
+
+  context 'when dir parameter correction' do
+    let(:params) { { dir: './spec/fixtures/dir/', ext: nil, name: 'new_name' } }
+    it 'return path string if dir exists' do
+      corrected_params = @corrector.corrected_params(params)
+      expect(corrected_params[:dir]).to eq './spec/fixtures/dir/'
+    end
+
+    let(:params1) { { dir: './spec/fixtures/dir2/', ext: nil, name: 'new_name' } }
+    it 'raise error if dir does not exists' do
+      expect{ @corrector.corrected_params(params1) }.to raise_error(StandardError, "Directory must exist!")
+    end
+
+    let(:params2) { { dir: './spec/fixtures/dir', ext: nil, name: 'new_name' } }
+    it 'adds slash to the end of path' do
+      corrected_params = @corrector.corrected_params(params2)
+      expect(corrected_params[:dir]).to eq './spec/fixtures/dir/'
+    end
+  end
+
+  context 'when prefix parameter correction' do
+    let(:params) { { prefix: " DCIM\n", ext: nil, dir: './spec/fixtures/dir/', name: 'new_name' } }
+    it 'strips prefix string if prefix exists' do
+      corrected_params = @corrector.corrected_params(params)
+      expect(corrected_params[:prefix]).to eq 'DCIM'
+    end
+
+    let(:params1) { { dir: './spec/fixtures/dir/', prefix: nil, ext: nil, name: 'new_name' } }
+    it 'return empty string if prefix does not exists' do
+      corrected_params = @corrector.corrected_params(params1)
+      expect(corrected_params[:prefix]).to eq ''
+    end
+  end
+
+  context 'when name parameter correction' do
+    let(:params1) { { dir: './spec/fixtures/dir/', name: nil, ext: nil } }
+    it 'raise error if name does not exists' do
+      expect{ @corrector.corrected_params(params1) }.to raise_error(StandardError, "Incorrect name!")
+    end
+
+    let(:params2) { { dir: './spec/fixtures/dir/', name: 'name any any ///&&&', ext: nil } }
+    it 'raise error if name does not matches regexp' do
+      expect{ @corrector.corrected_params(params2) }.to raise_error(StandardError, "Incorrect name!")
+    end
+  end
+end

data/spec/path_processor_spec.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: false
+
+require_relative 'spec_helper'
+
+describe 'PathProcessor#rename_files' do
+  before(:each) do
+    i = 1
+    3.times do
+      File.write("./spec/fixtures/dir/file#{i}.txt", '')
+      i += 1
+    end
+
+    i = 1
+    3.times do
+      File.write("./spec/fixtures/dir/pict#{i}.jpg", '')
+      i += 1
+    end
+  end
+
+  after(:each) do
+    Dir['./spec/fixtures/dir/*'].each do |f|
+      File.delete(f)
+    end
+  end
+
+  context 'when prefix and extension passed' do
+    let(:args) { { params: { dir: './spec/fixtures/dir/', prefix: 'file', ext: 'txt', name: 'new_name' } } }
+
+    it 'renames only file*.txt' do
+      FileRenamer::PathProcessor.run!(args)
+      expect(Dir['./spec/fixtures/dir/*']).to match_array %w[
+        ./spec/fixtures/dir/new_name.txt
+        ./spec/fixtures/dir/new_name_1.txt
+        ./spec/fixtures/dir/new_name_2.txt
+        ./spec/fixtures/dir/pict1.jpg
+        ./spec/fixtures/dir/pict2.jpg
+        ./spec/fixtures/dir/pict3.jpg
+      ]
+    end
+  end
+
+  context 'when only ext passed' do
+    let(:args) { { params: { dir: './spec/fixtures/dir/', prefix: nil, ext: 'jpg', name: 'new_name' } } }
+
+    it 'renames only *.jpeg' do
+      FileRenamer::PathProcessor.run!(args)
+      expect(Dir['./spec/fixtures/dir/*']).to match_array %w[
+        ./spec/fixtures/dir/file1.txt
+        ./spec/fixtures/dir/file2.txt
+        ./spec/fixtures/dir/file3.txt
+        ./spec/fixtures/dir/new_name.jpg
+        ./spec/fixtures/dir/new_name_1.jpg
+        ./spec/fixtures/dir/new_name_2.jpg
+      ]
+    end
+  end
+
+  context 'when only prefix passed' do
+    let(:args) { { params: { dir: './spec/fixtures/dir/', prefix: 'pict', ext: nil, name: 'new_name' } } }
+
+    it 'renames only pict*' do
+      FileRenamer::PathProcessor.run!(args)
+      expect(Dir['./spec/fixtures/dir/*']).to match_array %w[
+        ./spec/fixtures/dir/file1.txt
+        ./spec/fixtures/dir/file2.txt
+        ./spec/fixtures/dir/file3.txt
+        ./spec/fixtures/dir/new_name.jpg
+        ./spec/fixtures/dir/new_name_1.jpg
+        ./spec/fixtures/dir/new_name_2.jpg
+      ]
+    end
+  end
+
+  context 'when prefix and ext doesnt match any of files' do
+    let(:args) { { params: { dir: './spec/fixtures/dir/', prefix: 'pict', ext: 'txt', name: 'new_name' } } }
+
+    it 'renames nothing' do
+      FileRenamer::PathProcessor.run!(args)
+      expect(Dir['./spec/fixtures/dir/*']).to match_array %w[
+        ./spec/fixtures/dir/file1.txt
+        ./spec/fixtures/dir/file2.txt
+        ./spec/fixtures/dir/file3.txt
+        ./spec/fixtures/dir/pict1.jpg
+        ./spec/fixtures/dir/pict2.jpg
+        ./spec/fixtures/dir/pict3.jpg
+      ]
+    end
+  end
+
+  context 'when prefix and ext doesnt match any of files' do
+    let(:args) { { params: { dir: './spec/fixtures/dir/', prefix: 'file', ext: 'jpg', name: 'new_name' } } }
+
+    it 'renames nothing' do
+      FileRenamer::PathProcessor.run!(args)
+      expect(Dir['./spec/fixtures/dir/*']).to match_array %w[
+        ./spec/fixtures/dir/file1.txt
+        ./spec/fixtures/dir/file2.txt
+        ./spec/fixtures/dir/file3.txt
+        ./spec/fixtures/dir/pict1.jpg
+        ./spec/fixtures/dir/pict2.jpg
+        ./spec/fixtures/dir/pict3.jpg
+      ]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'file_renamer'
-require 'path'
+# frozen_string_literal: true
+require 'simplecov'
+SimpleCov.start
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'params_corrector'
+require 'name_alterer'
+require 'path_processor'

metadata

@@ -1,80 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: file_renamer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.4
 platform: ruby
 authors:
-- Taras Zhuk
+- Tee Zed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: File Renamer allows to rename bunch of files of similar extension or
-  filename prefix all at once.
-email:
-- tee@zed@gmail.com
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email: tee0zed@gmail.com
 executables:
-- filerenamer
+- file_renamer
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/filerenamer
+- bin/file_renamer
 - bin/setup
-- lib/file_renamer.rb
-- lib/file_renamer/version.rb
-- lib/path.rb
-- spec/integral_spec.rb
-- spec/path_spec.rb
-- spec/renamer_spec.rb
+- lib/name_alterer.rb
+- lib/params_corrector.rb
+- lib/path_processor.rb
+- spec/name_alterer_spec.rb
+- spec/params_corrector_spec.rb
+- spec/path_processor_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/tee0zed/file_renamer
+homepage: http://github.com/tee0zed/file_renamer/
 licenses:
 - MIT
 metadata: {}
@@ -85,22 +98,17 @@ require_paths:
 - bin
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Multiple files renamer script.
-test_files:
-- spec/integral_spec.rb
-- spec/path_spec.rb
-- spec/renamer_spec.rb
-- spec/spec_helper.rb
+summary: Bulk file renaming tool
+test_files: []

data/.rspec

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

data/bin/filerenamer

@@ -1,23 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'optparse'
-require_relative '../lib/file_renamer'
-require_relative '../lib/path'
-
-begin 
-
-params = {}
-OptionParser.new do |opts|
-  opts.on('-n', '--name STRING', String)
-  opts.on('-p', '--prefix STRING', String)
-  opts.on('-e', '--ext STRING', String)
-  opts.on('-d', '--dir STRING', String)
-end.parse!(into: params)
-
-  rescue OptionParser::MissingArgument 
-    puts "Argument error."
-end 
-
-FileRenamer::Renamer.rename!(params)
-
-puts "#{FileRenamer::Path.get_count} paths renamed!"

data/lib/file_renamer.rb

@@ -1,80 +0,0 @@
-require_relative 'file_renamer/version.rb'
-require_relative 'path'
-
-module FileRenamer
-  class Renamer
-    SLASH = Gem.win_platform? ? '\\' : '/'
-    FILENAME_REGEXP = /^[a-zA-Z_0-9 -]+$/ 
-    EXTENSION_REGEXP = /^[a-zA-Z0-9]{1,4}$/
-
-    attr_reader :params, :paths 
-
-    def self.rename!(params)
-      session =  FileRenamer::Renamer.new(params)
-      session.get_paths
-      session.rename_files
-    end  
-
-    def initialize(params)
-      @params = params 
-      @paths = []
-    end 
-
-    def get_paths
-      params_correction!
-
-      Dir["#{params[:dir]}*"].sort.each do |path|
-        @paths << FileRenamer::Path.new(path, params) 
-      end 
-    end 
-
-    def rename_files
-      @paths.each { |p| p.rename_file! if p.correct_path? }
-    end 
-
-    private 
-
-    def params_correction!
-      correct_dir
-
-      abort "New name must exist!" unless params[:name]
-      correct_name
-      
-      correct_prefix
-      correct_ext
-      
-      abort "Incorrect name!" unless @params[:name]
-      abort "Directory must exist!" unless @params[:dir]
-    end 
-
-    def correct_dir
-      if @params[:dir].nil? 
-        @params[:dir] = Dir.pwd
-        @params[:dir] << SLASH
-      else 
-        @params[:dir] << SLASH unless @params[:dir][-1] == SLASH 
-        @params[:dir] = nil unless File.directory?(@params[:dir])
-      end 
-    end
-
-    def correct_name
-      if @params[:name] && @params[:name].match?(FILENAME_REGEXP)
-        @params[:name] = @params[:name].strip.gsub(' ', '_') 
-      else 
-        @params[:name] = nil 
-      end 
-    end 
-
-    def correct_prefix
-      @params[:prefix] = @params[:prefix].strip if @params[:prefix]
-    end 
-
-    def correct_ext
-      if @params[:ext] && @params[:ext].match?(EXTENSION_REGEXP)
-        @params[:ext] = '.' + @params[:ext] unless @params[:ext][0] == '.'
-      else 
-        @params[:ext] = nil 
-      end 
-    end 
-  end 
-end

data/lib/file_renamer/version.rb

@@ -1,3 +0,0 @@
-module FileRenamer
-  VERSION = "0.1.3"
-end

data/lib/path.rb

@@ -1,55 +0,0 @@
-
-module FileRenamer
-  class Path
-    FILENAME_REGEX = /([^\/|\\]+$)/
-
-    @@counter = 0 
-    
-    attr_reader :path, :prefix, :ext, :new_name
-
-    def self.get_count 
-      @@counter 
-    end 
-
-    def self.reset_counter
-      @@counter = 0
-    end 
-
-    def initialize(path, params)
-      @path = path
-      @new_name = params[:name] 
-      @prefix = params[:prefix]
-      @ext = params[:ext]
-    end 
-
-    def correct_path?
-      @path.slice(FILENAME_REGEX)
-      .match?(Regexp.new("^#{prefix}.*#{ext}$")) && 
-      !File.directory?(@path)
-    end 
-
-    def rename_file!
-      File.rename(@path, renamed_path(@@counter))
-      @@counter += 1 
-    end 
-
-    private 
-
-    def renamed_path(num)
-      filename = @path.slice(FILENAME_REGEX)
-
-      name = 
-      if num == 0 
-        "#{@new_name}"
-      else 
-        "#{@new_name}_#{num}"
-      end 
-      
-      name << '.' if filename.match?('\.')
-
-      new_name = filename.gsub(/^\w+./, "#{name}")
-
-      @path.gsub(filename, new_name)
-    end 
-  end 
-end

data/spec/integral_spec.rb

@@ -1,85 +0,0 @@
-require 'spec_helper'
-
-describe "FileRenamer" do 
-  context "integral test" do 
-    before(:each) { 
-        i = 1 
-        3.times do 
-          File.write("./spec/fixtures/dir/file#{i}.txt", "")
-          i += 1
-        end 
-
-        i = 1 
-        3.times do 
-          File.write("./spec/fixtures/dir/pict#{i}.jpg", "")
-          i += 1
-        end 
-      }
-
-    after(:each) {
-        Dir["./spec/fixtures/dir/*"].each do |f|
-          File.delete(f) if File.exists?(f)
-        end 
-      }
-
-  let(:params1) {{ dir: "./spec/fixtures/dir/", prefix: "file", ext: "txt", name: "new_name" }}
-    it 'renames files correctly' do
-      FileRenamer::Path.reset_counter
-      FileRenamer::Renamer.rename!(params1)
-      expect(Dir["./spec/fixtures/dir/*"]).to match_array ["./spec/fixtures/dir/new_name.txt", 
-                                                           "./spec/fixtures/dir/new_name_1.txt", 
-                                                           "./spec/fixtures/dir/new_name_2.txt",
-                                                           "./spec/fixtures/dir/pict1.jpg", 
-                                                           "./spec/fixtures/dir/pict2.jpg", 
-                                                           "./spec/fixtures/dir/pict3.jpg"]
-    end
-
-    let(:params2) {{ dir: "./spec/fixtures/dir/", prefix: "pict", ext: "txt", name: "new_name" }}
-    it 'doesnt renames if prefix and ext doesnt match any of files' do
-      FileRenamer::Path.reset_counter
-      FileRenamer::Renamer.rename!(params2)
-      expect(Dir["./spec/fixtures/dir/*"]).to match_array ["./spec/fixtures/dir/file1.txt", 
-                                                           "./spec/fixtures/dir/file2.txt", 
-                                                           "./spec/fixtures/dir/file3.txt",
-                                                           "./spec/fixtures/dir/pict1.jpg", 
-                                                           "./spec/fixtures/dir/pict2.jpg", 
-                                                           "./spec/fixtures/dir/pict3.jpg"]
-    end
-
-    let(:params3) {{ dir: "./spec/fixtures/dir/", prefix: nil, ext: "jpg", name: "new_name" }}
-    it 'renames files correctly if only ext passed' do
-      FileRenamer::Path.reset_counter
-      FileRenamer::Renamer.rename!(params3)
-      expect(Dir["./spec/fixtures/dir/*"]).to match_array ["./spec/fixtures/dir/file1.txt", 
-                                                           "./spec/fixtures/dir/file2.txt", 
-                                                           "./spec/fixtures/dir/file3.txt",
-                                                           "./spec/fixtures/dir/new_name.jpg", 
-                                                           "./spec/fixtures/dir/new_name_1.jpg", 
-                                                           "./spec/fixtures/dir/new_name_2.jpg"]
-    end
-
-    let(:params4) {{ dir: "./spec/fixtures/dir/", prefix: "file", ext: "jpg", name: "new_name" }}
-    it 'doesnt renames if prefix and ext doesnt match any of files' do
-      FileRenamer::Path.reset_counter
-      FileRenamer::Renamer.rename!(params4)
-      expect(Dir["./spec/fixtures/dir/*"]).to match_array ["./spec/fixtures/dir/file1.txt", 
-                                                           "./spec/fixtures/dir/file2.txt", 
-                                                           "./spec/fixtures/dir/file3.txt",
-                                                           "./spec/fixtures/dir/pict1.jpg", 
-                                                           "./spec/fixtures/dir/pict2.jpg", 
-                                                           "./spec/fixtures/dir/pict3.jpg"]
-    end
-
-    let(:params5) {{ dir: "./spec/fixtures/dir/", prefix: 'pict', ext: nil, name: "new_name" }}
-    it 'renames files correctly if only prefix passed' do
-      FileRenamer::Path.reset_counter
-      FileRenamer::Renamer.rename!(params5)
-      expect(Dir["./spec/fixtures/dir/*"]).to match_array ["./spec/fixtures/dir/file1.txt", 
-                                                           "./spec/fixtures/dir/file2.txt", 
-                                                           "./spec/fixtures/dir/file3.txt",
-                                                           "./spec/fixtures/dir/new_name.jpg", 
-                                                           "./spec/fixtures/dir/new_name_1.jpg", 
-                                                           "./spec/fixtures/dir/new_name_2.jpg"]
-    end
-  end 
-end 

data/spec/path_spec.rb

@@ -1,79 +0,0 @@
-require 'spec_helper'
-require 'byebug'
-describe "FileRenamer" do 
-  context "Path#correct_path?" do 
-    let(:params1) {{ name: 'new_name', prefix: nil, ext: nil }}
-    let(:no_opt_params1) { FileRenamer::Path.new('/Documents/DCIM_123.jpg', params1)} 
-    let(:no_opt_params2) { FileRenamer::Path.new('/Documents/ANOTHER_1123133.jpg', params1)} 
-    it "return true for all paths without options" do
-      expect(no_opt_params1.correct_path?).to eq true 
-      expect(no_opt_params2.correct_path?).to eq true 
-    end 
-
-    let(:params2) {{ name: 'new_name', prefix: 'DCIM', ext: '.jpg' }}
-    let(:with_options_params_correct1) { FileRenamer::Path.new('/Documents/DCIM_1asdasdggqeda23.jpg', params2) }
-    let(:with_options_params_correct2) { FileRenamer::Path.new('/Documents/DCIM_1f12fsa23.jpg', params2) }
-    it "return true if options matches path" do 
-      expect(with_options_params_correct1.correct_path?).to eq true 
-      expect(with_options_params_correct2.correct_path?).to eq true 
-    end 
-
-    let(:params3) {{ name: 'new_name', prefix: 'DCIM', ext: nil }}
-    let(:with_prefix_correct1) { FileRenamer::Path.new('/Documents/DCIM_1asdads123223.jpg', params3) }
-    let(:with_prefix_correct2) { FileRenamer::Path.new('/Documents/DCIM_1addsa23.png', params3) }
-    it "return true if prefix matches path" do 
-      expect(with_prefix_correct1.correct_path?).to eq true 
-      expect(with_prefix_correct2.correct_path?).to eq true 
-    end 
-
-    let(:params4) {{ name: 'new_name', prefix: nil, ext: '.jpg' }}
-    let(:with_ext_correct1) { FileRenamer::Path.new('/Documents/ANOTHER_124143.jpg', params4) }
-    let(:with_ext_correct2) { FileRenamer::Path.new('/Documents/IMG_12122133.jpg', params4) }
-    it "return true if extension matches path" do 
-      expect(with_ext_correct1.correct_path?).to eq true 
-      expect(with_ext_correct2.correct_path?).to eq true 
-    end 
-
-    let(:params5) {{ name: 'new_name', prefix: 'DCIM', ext: '.jpg' }}
-    let(:with_prefix_incorrect1) { FileRenamer::Path.new('/Documents/IDCIMMG_114223.jpg', params5) }
-    let(:with_prefix_incorrect2) { FileRenamer::Path.new('/Documents/IMGDCIMDCIM_12131123.jpg', params5) }
-    it "return false if prefix not matches path" do 
-      expect(with_prefix_incorrect1.correct_path?).to eq false 
-      expect(with_prefix_incorrect2.correct_path?).to eq false 
-    end 
-
-    let(:params6) {{ name: 'new_name', prefix: 'IMG', ext: '.jpg' }}
-    let(:with_ext_incorrect1) { FileRenamer::Path.new('/Documents/IMG_123.png', params6) }
-    let(:with_ext_incorrect2) { FileRenamer::Path.new('/Documents/IMG_123.txt', params6) }
-    it "return false if extension not matches path" do 
-      expect(with_ext_incorrect1.correct_path?).to eq false 
-      expect(with_ext_incorrect2.correct_path?).to eq false 
-    end 
-  end 
-
-  context 'Path#renamed_path' do
-    let(:params7) {{ name: 'new_name', prefix: nil, ext: '.jpg' }} 
-    let(:with_ext_params) { FileRenamer::Path.new('/Documents/IMG_123.jpg', params7) }
-    it 'renames file correctly if extension param passed' do 
-      expect(with_ext_params.send(:renamed_path, 0)).to eq "/Documents/new_name.jpg"
-    end 
-
-    let(:params8) {{ name: 'new_name', prefix: nil, ext: nil }}
-    let(:without_ext_params) { FileRenamer::Path.new('/Documents/IMG_123.jpg', params8) }
-    it 'renames file correctly if extension param not passed' do 
-      expect(without_ext_params.send(:renamed_path, 0)).to eq "/Documents/new_name.jpg"
-    end 
-
-    let(:params9) {{ name: 'new_name', prefix: nil, ext: nil }}
-    let(:filename_w_two_dots_with_ext_params) { FileRenamer::Path.new('/Documents/IMG_123.html.erb', params9) }
-    it 'renames file with two extensions correctly if extension param passed' do 
-      expect(filename_w_two_dots_with_ext_params.send(:renamed_path, 0)).to eq "/Documents/new_name.html.erb"
-    end 
-
-    let(:params10) {{ name: 'new_name', prefix: 'DCIM', ext: '.jpg' }}
-    let(:filename_w_two_dots_without_ext_params) { FileRenamer::Path.new('/Documents/IMG_123.html.erb', params10) }
-    it 'renames file with two extensions correctly if extension param not passed' do 
-      expect(filename_w_two_dots_without_ext_params.send(:renamed_path, 0)).to eq "/Documents/new_name.html.erb"
-    end 
-  end 
-end 

data/spec/renamer_spec.rb

@@ -1,126 +0,0 @@
-require 'spec_helper'
-
-describe 'FileRenamer' do 
-  context 'Renamer#get_paths' do 
-    before(:each) { 
-      i = 1 
-      3.times do 
-        File.write("./spec/fixtures/dir/file#{i}.txt", "")
-        i += 1
-      end 
-
-      i = 1 
-      3.times do 
-        File.write("./spec/fixtures/dir/pict#{i}.jpg", "")
-        i += 1
-      end 
-    }
-
-    after(:each) {
-      Dir["./spec/fixtures/dir/*"].each do |f|
-        File.delete(f) if File.exists? f
-      end 
-    }
-
-    let(:params1) {{ dir: "./spec/fixtures/dir/", ext: nil, prefix: nil, name: 'new_name' }}
-    let(:obj1) { FileRenamer::Renamer.new(params1) }
-    it 'returns all Path objects' do 
-      obj1.get_paths
-
-      expect(obj1.paths.count).to eq 6
-      expect(obj1.paths.all?{|o| o.is_a? FileRenamer::Path }).to eq true 
-      expect(obj1.paths.map(&:path)).to match_array ["./spec/fixtures/dir/pict3.jpg", 
-                                                     "./spec/fixtures/dir/pict2.jpg", 
-                                                     "./spec/fixtures/dir/pict1.jpg", 
-                                                     "./spec/fixtures/dir/file1.txt",
-                                                     "./spec/fixtures/dir/file2.txt", 
-                                                     "./spec/fixtures/dir/file3.txt" ]
-
-    end 
-  end 
-
-  context 'Renamer#correct_ext' do
-    let(:params) {{ ext: 'jpg' }}
-    let(:obj) { FileRenamer::Renamer.new(params) } 
-    it 'return ext string with dot if ext not nil' do 
-      obj.send(:correct_ext)
-      expect(obj.params[:ext]).to eq '.jpg'
-    end 
-
-    let(:params1) {{ ext: 'jpganyany' }}
-    let(:obj1) { FileRenamer::Renamer.new(params1) } 
-    it 'return nil if ext not matches regexp' do 
-      obj1.send(:correct_ext)
-      expect(obj1.params[:ext]).to eq nil
-    end 
-
-    let(:params2) {{ ext: nil }}
-    let(:obj2) { FileRenamer::Renamer.new(params2) } 
-    it 'return nil if ext nil' do 
-      obj2.send(:correct_ext)
-      expect(obj2.params[:ext]).to eq nil
-    end 
-  end 
-
-  context 'Renamer#correct_dir' do
-    let(:params) {{ dir: './spec/fixtures/dir/' }}
-    let(:obj) { FileRenamer::Renamer.new(params) } 
-    it 'return dir string if dir exists' do 
-      obj.send(:correct_dir)
-      expect(obj.params[:dir]).to eq './spec/fixtures/dir/'
-    end 
-
-    let(:params1) {{ dir: './spec/fixtures/dir2/' }}
-    let(:obj1) { FileRenamer::Renamer.new(params1) } 
-    it 'return nil if dir does not exists' do 
-      obj1.send(:correct_dir)
-      expect(obj1.params[:dir]).to eq nil
-    end 
-
-    let(:params2) {{ dir: './spec/fixtures/dir' }}
-    let(:obj2) { FileRenamer::Renamer.new(params2) } 
-    it 'add slash to the end of path' do 
-      obj2.send(:correct_dir)
-      expect(obj2.params[:dir]).to eq './spec/fixtures/dir/'
-    end 
-  end 
-
-  context 'Renamer#correct_prefix' do
-    let(:params) {{ prefix: " DCIM\n" }}
-    let(:obj) { FileRenamer::Renamer.new(params) } 
-    it 'strips prefix string if prefix exists' do 
-      obj.send(:correct_prefix)
-      expect(obj.params[:prefix]).to eq 'DCIM'
-    end 
-
-    let(:params1) {{ prefix: nil }}
-    let(:obj1) { FileRenamer::Renamer.new(params1) } 
-    it 'return nil if prefix does not exists' do 
-      obj1.send(:correct_prefix)
-      expect(obj1.params[:prefix]).to eq nil
-    end 
-  end 
-
-  context 'Renamer#correct_name' do
-    let(:params) {{ name: "new name  " }}
-    let(:obj) { FileRenamer::Renamer.new(params) } 
-    it 'deletes spaces from filename and strips' do 
-      obj.send(:correct_name)
-      expect(obj.params[:name]).to eq 'new_name'
-    end 
-
-    let(:params1) {{ name: nil }}
-    let(:obj1) { FileRenamer::Renamer.new(params1) } 
-    it 'return nil if name does not exists' do 
-      obj1.send(:correct_name)
-      expect(obj1.params[:name]).to eq nil
-    end 
-
-    let(:params2) {{ name: 'name any any ////&&$^' }}
-    let(:obj2) { FileRenamer::Renamer.new(params1) } 
-    it 'return nil if name does not matches regexp' do 
-      obj1.send(:correct_name)
-      expect(obj1.params[:name]).to eq nil
-    end 
-  end 
-end