ruby_clone 1.0.0 → 1.0.1

data/README.md

@@ -6,18 +6,18 @@
 
 Install the gem:
 
-    gem install ruby_clone
+`gem install ruby_clone`
 
 Create a file that is named '.ruby_clone' in your home folder and set up a profile.
 **NOTE**: Don't forget to use the dot in the file.
 
 And then execute:
 
-    $ ruby_clone my_profile
+`$ ruby_clone my_profile`
 
 You can also specify another path of your **RubyClone** file:
 
-    $ ruby_clone -b /my/ruby_clone_file my_profile
+`$ ruby_clone -b /my/ruby_clone_file my_profile`
 
 ## Usage
 
@@ -31,19 +31,20 @@ To start using it, you'll need to create the following configuration in your **R
 **NOTE 2**: If your source folder/destination_folder has spaces as "My Source Folder", you need to set up it as
 "My\\ Source\\ Folder" with **two back slashes** for **each space**. Spaces and only one back slash will not work.
 
-
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder"
-    end
+```ruby
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder"
+end
+```
 
 If you set up this configuration in your $HOME/.ruby_clone, you can run with:
 
-    $ ruby_clone my_profile
+`$ ruby_clone my_profile`
 
 If is in another path, run with:
 
-    $ ruby_clone -b /my/backup_file my_profile
+`$ ruby_clone -b /my/backup_file my_profile`
 
 **NOTE**: This basic setup doesn't sync deleted files from the source folder. If you want to delete them, you need
 to setup the option 'delete: true'.
@@ -53,17 +54,21 @@ to setup the option 'delete: true'.
 **RubyClone** offers the option to use SSH in a easy way. You just need to use the option ':ssh' with the 'user@host'.
 Example for SSH that is on source folder.
 
-    profile :my_profile do
-      from "/my/source_folder/", ssh: "user@source_server"
-      to "/my/destination_folder"
-    end
+```ruby
+profile :my_profile do
+  from "/my/source_folder/", ssh: "user@source_server"
+  to "/my/destination_folder"
+end
+```
 
 Example for SSH that is on destination folder:
 
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder", ssh: "user@destination_server"
-    end
+```ruby
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder", ssh: "user@destination_server"
+end
+```
 
 After running one of theses profiles, you just need to type the password.
 
@@ -76,225 +81,252 @@ Here is all the configuration you can set up and improve your **RubyClone** file
 
 ### Excluding a Pattern - exclude_pattern "pattern"
 
-  If you need to exclude folders or files matching a pattern, use the 'exclude_pattern command.
-  This command can be used in two ways: On the top of **RubyClone** file and/or inside the 'from'.
-  Here a complete example:
+If you need to exclude folders or files matching a pattern, use the 'exclude_pattern command.
+This command can be used in two ways: On the top of **RubyClone** file and/or inside the 'from'.
+Here a complete example:
 
-    exclude_pattern "top_pattern"
+```ruby
+exclude_pattern "top_pattern"
 
-    profile :my_profile1 do
-      from "/my/source_folder/"
-      to "/my/destination_folder"
-    end
+profile :my_profile1 do
+  from "/my/source_folder/"
+  to "/my/destination_folder"
+end
 
-    profile :my_profile2 do
-      from "/my/source_folder/" do
-        exclude_pattern "from_pattern"
-      end
-      to "/my/destination_folder"
-    end
+profile :my_profile2 do
+  from "/my/source_folder/" do
+    exclude_pattern "from_pattern"
+  end
+  to "/my/destination_folder"
+end
+```
 
-  1. 'my_profile1' will exclude only the "top_pattern".
-  2. 'my_profile2' will exclude the "top_pattern" and "from_pattern"
+1. 'my_profile1' will exclude only the "top_pattern".
+2. 'my_profile2' will exclude the "top_pattern" and "from_pattern"
 
 ### Including a Pattern - include_pattern "pattern"
 
-  Same as the exclude_pattern. If you need to include folders or files matching a pattern, use the
-  include_pattern command. This command can be use in two ways: On the top of **RubyClone** file and/or
-  inside the 'from' block. Example:
-
-    include_pattern "top_pattern"
-
-    profile :my_profile1 do
-      from "/my/source_folder/"
-      to "/my/destination_folder"
-    end
-
-    profile :my_profile2 do
-      from "/my/source_folder/" do
-        include_pattern "from_pattern"
-      end
-      to "/my/destination_folder"
-    end
-
-  1. 'my_profile1' will include only the "top_pattern".
-  2. 'my_profile2' will include the "top_pattern" and "from_pattern"
-
-  Here an example using exclude_pattern and include_pattern together. In this example, :my_profile will exclude
-  all folders and will sync/include only the 'from_pattern'
-
-    profile :my_profile do
-      from "/my/source_folder/" do
-        exclude_pattern "*"
-        include_pattern "from_pattern"
-      end
-      to "/my/destination_folder"
-    end
+Same as the exclude_pattern. If you need to include folders or files matching a pattern, use the
+include_pattern command. This command can be use in two ways: On the top of **RubyClone** file and/or
+inside the 'from' block. Example:
+
+```ruby
+include_pattern "top_pattern"
+
+profile :my_profile1 do
+  from "/my/source_folder/"
+  to "/my/destination_folder"
+end
+
+profile :my_profile2 do
+  from "/my/source_folder/" do
+    include_pattern "from_pattern"
+  end
+  to "/my/destination_folder"
+end
+```
+
+1. 'my_profile1' will include only the "top_pattern".
+2. 'my_profile2' will include the "top_pattern" and "from_pattern"
+
+Here an example using exclude_pattern and include_pattern together. In this example, :my_profile will exclude
+all folders and will sync/include only the 'from_pattern'
+
+```ruby
+profile :my_profile do
+  from "/my/source_folder/" do
+    exclude_pattern "*"
+    include_pattern "from_pattern"
+  end
+  to "/my/destination_folder"
+end
+```
 
 ### Deleting files
 
-1. Deleting files that don't exist in source_folder but in destination folder - delete: true
+* Deleting files that don't exist in source_folder but in destination folder - delete: true
 
-  The basic configuration was created to be a secure configuration. So if you really want to delete files/folders
-  in your destination folder that doesn't exist anymore in your source folder, you'll need to set up 'delete: true' in
-  your **RubyClone** file. Below an example how to do it:
+The basic configuration was created to be a secure configuration. So if you really want to delete files/folders
+in your destination folder that doesn't exist anymore in your source folder, you'll need to set up 'delete: true' in
+your **RubyClone** file. Below an example how to do it:
 
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder", delete: true
-    end
+```ruby
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder", delete: true
+end
+```
 
-  Now all files that exists in "/my/destination_folder/" but "/my/source_folder" will be deleted. If for some
-  reason you want to keep some files and delete others, just set up the exclude_pattern inside 'from' block.
+Now all files that exists in "/my/destination_folder/" but "/my/source_folder" will be deleted. If for some
+reason you want to keep some files and delete others, just set up the exclude_pattern inside 'from' block.
 
-2. Deleting files that are excluded from source folder to destination folder - delete_excluded: true
+* Deleting files that are excluded from source folder to destination folder - delete_excluded: true
 
-  If you decided to exclude files from the syncronization but they still in your destination folder, you can use
-  the 'delete_excluded' to delete this files inside destination folder that are excluded from the source_folder.
-  Example:
+If you decided to exclude files from the syncronization but they still in your destination folder, you can use
+the 'delete_excluded' to delete this files inside destination folder that are excluded from the source_folder.
+Example:
 
-    profile :my_profile do
-      from "/my/source_folder/" do
-        exclude_pattern "my_pattern"
-      end
-      to "/my/destination_folder", delete_excluded: true
-    end
+```ruby
+profile :my_profile do
+  from "/my/source_folder/" do
+    exclude_pattern "my_pattern"
+  end
+  to "/my/destination_folder", delete_excluded: true
+end
+```
 
-  Now all files that are inside destination_folder that have the pattern 'my_pattern' will be deleted.
+Now all files that are inside destination_folder that have the pattern 'my_pattern' will be deleted.
 
-  **NOTE**: When you use 'delete_excluded :true' you don't need to set up 'delete: true' even the from
-  configuration doesn't have the 'exclude_pattern'
+**NOTE**: When you use 'delete_excluded :true' you don't need to set up 'delete: true' even the from
+configuration doesn't have the 'exclude_pattern'
 
 ### Backuping files - backup "folder"
 
-1. If you want to save all the files that get **updated** and **deleted**, you need to set up the 'backup'
-   configuration inside the 'to' block. Example:
+* If you want to save all the files that get **updated** and **deleted**, you need to set up the 'backup'
+configuration inside the 'to' block. Example:
 
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder", delete: true do
-        backup "/my/backup_folder"
-      end
-    end
+```ruby
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder", delete: true do
+    backup "/my/backup_folder"
+  end
+end
+```
 
-  Now all the folders/files that get **updated** or **deleted** in the "/my/destination_folder" will be moved to
-  "/my/backup_folder".  The files moved to "/my/destination_folder" will have a default suffix that is a **RubyClone**
-  control key plus the Date with the format: "yyyyMMdd".
 
-  All files that are saved in the "/my/backup_folder" will have a limit of 5 files. So if any file that passed this
-  limit, the old file will be deleted. You can change this limit using the option "limit".
+Now all the folders/files that get **updated** or **deleted** in the "/my/destination_folder" will be moved to
+"/my/backup_folder".  The files moved to "/my/destination_folder" will have a default suffix that is a **RubyClone**
+control key plus the Date with the format: "yyyyMMdd".
 
-  **NOTE**: The **RubyClone** control key is a special key to use as a control to remove old duplicated files.
+All files that are saved in the "/my/backup_folder" will have a limit of 5 files. So if any file that passed this
+limit, the old file will be deleted. You can change this limit using the option "limit".
 
-2. Changing the suffix of the files inside the backup folder - backup "folder", suffix: "my_suffix"
+**NOTE**: The **RubyClone** control key is a special key to use as a control to remove old duplicated files.
 
-  If you want to change the Date suffix for the files that you backup, you need to set the 'suffix' as a parameter to 'backup'.
-  Example:
+* Changing the suffix of the files inside the backup folder - backup "folder", suffix: "my_suffix"
 
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder", delete: true do
-        backup "/my/backup_folder", suffix: "my_suffix"
-      end
-    end
+If you want to change the Date suffix for the files that you backup, you need to set the 'suffix' as a parameter to 'backup'.
+Example:
+
+```ruby
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder", delete: true do
+    backup "/my/backup_folder", suffix: "my_suffix"
+  end
+end
+```
 
-  Another example using suffix with the Time class of Ruby to generate the date with timestamp "yyyyMMdd_hhmmss" :
+Another example using suffix with the Time class of Ruby to generate the date with timestamp "yyyyMMdd_hhmmss" :
 
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder", delete: true do
-        backup "/my/backup_folder", suffix: "_#{Time.now.strftime("%Y%m%d_%H%M%S")}"
-      end
-    end
+```ruby
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder", delete: true do
+    backup "/my/backup_folder", suffix: "_#{Time.now.strftime("%Y%m%d_%H%M%S")}"
+  end
+end
+```
 
-  **NOTE**: Changing the suffix will not change the **RubyClone** control key. Since this key control how to remove the
-  old duplicated files.
+**NOTE**: Changing the suffix will not change the **RubyClone** control key. Since this key control how to remove the
+old duplicated files.
 
-3. Disabling the default suffix - backup "folder", disable_suffix: true
+* Disabling the default suffix - backup "folder", disable_suffix: true
 
-  If for some reason you want to disable the file suffix in the backup folder you can set true for 'default_true'. Doing
+If for some reason you want to disable the file suffix in the backup folder you can set true for 'default_true'. Doing
 that all the files that are moved to "/my/backup_folder" will have the same name and it will get override by a new file.
 Example:
 
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder", delete: true do
-        backup "/my/backup_folder", disable_suffix: true
-      end
-    end
+```ruby
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder", delete: true do
+    backup "/my/backup_folder", disable_suffix: true
+  end
+end
+```
 
-  **NOTE**: This kind of setup will **backup only one file** and nothing more.
+**NOTE**: This kind of setup will **backup only one file** and nothing more.
 
-4. Changing how many files you want to backup - backup "folder", limit: 10
+* Changing how many files you want to backup - backup "folder", limit: 10
 
-  **RubyClone** have a default to save 5 files "/my/backup_folder" that have the same name. If you want to change the
-  limit you just need to set up the option limit with the number of files to save.
-  Example:
+**RubyClone** have a default to save 5 files "/my/backup_folder" that have the same name. If you want to change the
+limit you just need to set up the option limit with the number of files to save.
+Example:
 
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder", delete: true do
-        backup "/my/backup_folder", limit: 20
-      end
-    end
+```ruby
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder", delete: true do
+    backup "/my/backup_folder", limit: 20
+  end
+end
+```
 
-    Now "/my/backup_folder" will save 20 files with the same name.
+Now "/my/backup_folder" will save 20 files with the same name.
 
-5. Disabling the limit of files to save. Save unlimited files - backup "folder", limit: :unlimited
+* Disabling the limit of files to save. Save unlimited files - backup "folder", limit: :unlimited
 
-  If for some reason you want to backup all files that are **updated** or **deleted** you need to set up the 'limit'
-  option with ':unlimited'
-  Example:
+If for some reason you want to backup all files that are **updated** or **deleted** you need to set up the 'limit'
+option with ':unlimited'
+Example:
 
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder", delete: true do
-        backup "/my/backup_folder", limit: :unlimited
-      end
-    end
+```ruby
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder", delete: true do
+    backup "/my/backup_folder", limit: :unlimited
+  end
+end
+```
 
-  Now all files will be saved, until you change the 'limit' to a specific number to erased all the old files that passed
-  the new limit.
+Now all files will be saved, until you change the 'limit' to a specific number to erased all the old files that passed
+the new limit.
 
 ### Disabling the output commands of RSync - config options
 
-1.  **RubyClone** offers the possibility to not show the rsync command generated (show_command) and rsync output
-  (show_output). To use it, you need to set up in the top of your **RubyClone** file the 'config' and the commands you
-  want to disable. Example:
+*  **RubyClone** offers the possibility to not show the rsync command generated (show_command) and rsync output
+(show_output). To use it, you need to set up in the top of your **RubyClone** file the 'config' and the commands you
+want to disable. Example:
 
-    config show_command: false, show_output: false
+```ruby
+config show_command: false, show_output: false
 
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder"
-    end
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder"
+end
+```
 
-  The above config will not show anymore the rsync command and rsync outputs. But errors will keep showing if
-  happen.
+The above config will not show anymore the rsync command and rsync outputs. But errors will keep showing if
+happen.
 
-2. Overriding the default configuration of Rsync command - config options: 'override_options'
+* Overriding the default configuration of Rsync command - config options: 'override_options'
 
-  If you need to override the default configurations for RSync you can set up the "config options: 'my_options'".
-  Example:
+If you need to override the default configurations for RSync you can set up the "config options: 'my_options'".
+Example:
 
-    config options: '-Cav --stats'
+```ruby
+config options: '-Cav --stats'
 
-    profile :my_profile do
-      from "/my/source_folder/"
-      to "/my/destination_folder"
-    end
+profile :my_profile do
+  from "/my/source_folder/"
+  to "/my/destination_folder"
+end
+```
 
 ## Running
 
 **RubyClone** as default will try to read the **RubyClone** file in your home folder: $HOME/.ruby_clone. If you
 need to specify another path of your **RubyClone** file don't forget to add the option -b
 
-    $ ruby_clone -b /my/ruby_clone_file profile
+`$ ruby_clone -b /my/ruby_clone_file profile`
 
 RSync offers the options to dry-run the command and just run the sincronization as a simulation. You can do this
 too with **RubyClone**. Just pass the option '-d' to ruby_clone
 
-    $ ruby_clone -d profile
+`$ ruby_clone -d profile`
 
 ## More interesting **RubyClone** file
 
@@ -306,19 +338,16 @@ it will copy the 'source_folder' inside the 'destination_folder. (This behaviour
 **NOTE 2**: If your source folder/destination_folder has spaces as "/My Source Folder", you need to set up it as
 "My\\ Source\\ Folder" with **two back slashes** for **each space**. Spaces and only one back slash will not work.
 
-    profile :my_profile do
-      from "/my/source_folder/" do
-        exclude_pattern "pattern"
-      end
-      to "/my/destination_folder", delete_excluded: true do
-        backup "/my/backup"
-      end
-    end
-
-## **WARNINGS**
-
-  Even this script were has been tested many times, you run this script entirely at your own risk.
-  **RubyClone** accepts no responsibility for any damage this script may cause.
+```ruby
+profile :my_profile do
+  from "/my/source_folder/" do
+    exclude_pattern "pattern"
+  end
+  to "/my/destination_folder", delete_excluded: true do
+    backup "/my/backup"
+  end
+end
+```
 
 ## Contributing to **RubyClone**
 
@@ -326,4 +355,4 @@ it will copy the 'source_folder' inside the 'destination_folder. (This behaviour
 
 ## Copyright
 
-Copyright (c) 2012 Frederico Benevides. See MIT-LICENSE for further details.
+Copyright (c) 2012 Frederico Benevides. See MIT-LICENSE for further details.

data/lib/ruby_clone/version.rb

@@ -1,3 +1,3 @@
 module RubyClone
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_clone
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70295966492060 !ruby/object:Gem::Requirement
+  requirement: &70236612351040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70295966492060
+  version_requirements: *70236612351040
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70295966491280 !ruby/object:Gem::Requirement
+  requirement: &70236612350320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *70295966491280
+  version_requirements: *70236612350320
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70295966490740 !ruby/object:Gem::Requirement
+  requirement: &70236612349580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70295966490740
+  version_requirements: *70236612349580
 description: Ruby clone is a command line tool to work with Rsync using DSL!
 email:
 - fredbene@gmail.com