folders_renamer 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16f39f91fc475ebea67ebf29ae7f09854c6aeb30
-  data.tar.gz: f8fee7f1217c9087c3bdc557ef658addd610e313
+  metadata.gz: 4435cbed167eafecf60d8397e12350a675a045f5
+  data.tar.gz: 49b62f2ffccd8ce6f4eab4664e2471ac952eb5d8
 SHA512:
-  metadata.gz: 0265a40fedbfce56cf2f7b01c256eb2ade4ea613565e07dea3a4f4a94f630e39aa35ec67a04c8209986e26fc627827b466078b07aaf68209374c30fee8ad85c1
-  data.tar.gz: 7aea3f338fefc303d2fb242c42658a0b4aa001eb9bd6f71ce42aad4299f91fbe36f681f19a2f30f42cbd65b428df5094c8e67f6b613646838f2e9319d5266aec
+  metadata.gz: 6f0567f370e6dc320ca482ef2121a965b7e2869c48f1bb29da9d3e9d1bbbe889dc714e54211bead4771d26d8149e81c4468a001925be5d0bbd6909fef139a2d4
+  data.tar.gz: 75fa20a55585c53dde5ea70561b3d5a6eca4874dc7aa3f8a827d9c22aa0f5eeb090510e9edd6080cd0476b5010a8b89947fa1e93f53ec25f987550d598d716ed

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelogs
 
+### 0.1.2
+* Update `filename_cleaner` to 0.3
+* Add `--commit` options to allow the dry-run
+
 ### 0.1.1
 * Fix the link in README.md
 

data/README.md

@@ -14,14 +14,16 @@ Rename/cleanup folder names using the simple rules. For optimal result you may l
 also like to try my [filename_cleaner][] gem which clean/rename the bad file names.
 
 Features
-========
+--------
 
 - Rename directory recursively from any starting location
 - Replace unwanted characters with value of your choice using `--sep-string` option (default to . (dot))
 - Following the [Semantic Versioning][] for release schedule
 - Quickly rename bad folder names to good folder names with one command.
 
-e.g. turn these directories (if your OS allow you to have these names)
+TL;DR
+-----
+Turn these directories (if your OS allow you to have these names)
 
 ```
 some_folder/
@@ -41,6 +43,18 @@ some_folder/
 ├── aa_aa
     └── bb_bb
         └── cc_cc
+
+```
+using command like:
+
+```sh
+cd ~/path/to/some_folder/
+
+# Perform the dry-run to see what will be changed (no changes)
+folders_renamer rename --sep-string _
+
+# Commit your changes
+folders_renamer rename --sep-string _ --commit
 ```
 
 ### Installation
@@ -58,14 +72,16 @@ Usage:
   folders_renamer rename -b, --base-dir=BASE_DIR -s, --sep-string=SEP_STRING
 
 Options:
-  -b, --base-dir=BASE_DIR      # Starting directory
-                               # Default: . (current directory)
-  -s, --sep-string=SEP_STRING  # Separtor string to use
-                               # Default: .
-  -v, [--version=VERSION]      # Display version number
+  -b, --base-dir=BASE_DIR        # Starting directory
+                                 # Default: . (current directory)
+  -s, --sep-string=SEP_STRING    # Separtor string to use
+                                 # Default: .
+  -c, [--commit], [--no-commit]  # Commit your changes (defalt --no-commit)
+  -v, [--version=VERSION]        # Display version number
 
 Cleanup and rename folders
 ```
+
 ### Contributing
 
 1. Fork it

data/folders_renamer.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = Dir.glob("{test}/**/*")
   spec.require_paths = ["lib"]
   spec.add_runtime_dependency "thor", "~> 0.19"
-  spec.add_runtime_dependency "filename_cleaner", "~> 0.2"
+  spec.add_runtime_dependency "filename_cleaner", "~> 0.3"
   spec.add_development_dependency "awesome_print", "~> 1.2"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "gem-ctags", "~> 1.0"

data/lib/folders_renamer/cli.rb

@@ -12,6 +12,11 @@ module FoldersRenamer
                   desc: "Separtor string to use",
                   default: ".",
                   required: true
+    method_option :commit,
+                  type: :boolean,
+                  aliases: '-c',
+                  desc: 'Commit your changes',
+                  default: false
     method_option "version",
                   aliases: "-v",
                   desc: "Display version number"
@@ -22,7 +27,7 @@ module FoldersRenamer
         exit
       end
       puts "Your options #{opts}"
-      process(opts)
+      FoldersRenamer.rename(opts)
     end
 
     desc "usage", "Display help screen"
@@ -32,23 +37,16 @@ Usage:
   folders_renamer rename -b, --base-dir=BASE_DIR -s, --sep-string=SEP_STRING
 
 Options:
-  -b, --base-dir=BASE_DIR      # Starting directory
-                               # Default: . (current directory)
-  -s, --sep-string=SEP_STRING  # Separtor string to use
-                               # Default: .
-  -v, [--version=VERSION]      # Display version number
+  -b, --base-dir=BASE_DIR        # Starting directory
+                                 # Default: . (current directory)
+  -s, --sep-string=SEP_STRING    # Separtor string to use
+                                 # Default: .
+  -c, [--commit], [--no-commit]  # Commit your changes
+  -v, [--version=VERSION]        # Display version number
 
 Cleanup and rename folders
       EOS
     end
-
     default_task :usage
-
-  private
-
-    def process(opts = {})
-      puts "FYI: your options #{opts}"
-      FoldersRenamer.rename(opts[:base_dir], opts[:sep_string])
-    end
   end
 end

data/lib/folders_renamer/folders_renamer.rb

@@ -4,8 +4,10 @@ require "filename_cleaner"
 module FoldersRenamer
   CustomError = Class.new(StandardError)
   class << self
-    def rename(base_dir = Dir.pwd, sep_string = ".")
-      base_dir = File.expand_path(base_dir)
+    def rename(options)
+      base_dir   = File.expand_path(options[:base_dir])
+      sep_string = options[:sep_string]
+      commit     = options[:commit]
 
       unless File.directory?(base_dir) && File.readable?(base_dir)
         fail "#{base_dir} is not a valid directory or not readable!"
@@ -17,10 +19,15 @@ module FoldersRenamer
           unless new_path == path
             puts "FYI: rename from: #{path}"
             puts "FYI: rename to  : #{new_path}"
-            path.rename(new_path)
+            path.rename(new_path) if commit
           end
         end
       end
+      unless commit
+        puts "---------------------------------------------------------------------"
+        puts "This is the dry run only, use --commit to make your changes permanent"
+        puts "---------------------------------------------------------------------"
+      end
     end
 
   private

data/lib/folders_renamer/version.rb

@@ -1,3 +1,3 @@
 module FoldersRenamer
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/lib/folders_renamer/test_folders_renamer.rb

@@ -11,7 +11,7 @@ describe FoldersRenamer do
   context "#rename" do
     it "works with default separator string" do
       FileUtils.cd @base_dir
-      FoldersRenamer.rename(@base_dir, ".")
+      FoldersRenamer.rename(base_dir: @base_dir, sep_string: ".", commit: true)
       filesystem do
         dir "base" do
           dir "aa.01" do
@@ -22,7 +22,7 @@ describe FoldersRenamer do
     end
     it "works with non-default separator string" do
       FileUtils.cd @base_dir
-      FoldersRenamer.rename(@base_dir, "_")
+      FoldersRenamer.rename(base_dir: @base_dir, sep_string: "_", commit: true)
       filesystem do
         dir "base" do
           dir "aa_01" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folders_renamer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement