git_commands 3.1.6 → 3.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2115eda28aa459f4ca512e8e734cd859702da356
-  data.tar.gz: 5950edb6f580c4c06f35cb763a3f75e746ed15d5
+  metadata.gz: b56d1810b535ad9bacd7d58b1dd1c68ef6f431f0
+  data.tar.gz: a1f27d3bf68f8f8c1293acc5f2ef24fc9faa83b1
 SHA512:
-  metadata.gz: c247805c7a0fb198f760c499f1f1bcfd12ea911adec58b8366e5b8b0058852ffd74bf0fc57afffd616ce6f13817f9aa7958e10a5638a7308f7f33036182a676a
-  data.tar.gz: d44b3d70b5b9ecbe9f3e22e4cfd9d327c26d5fff177228684793eae31fd097c4be37f0cab2e684fca30fbe4ea481726cfc4881ed1458d39bf8ac9454b44e8fbd
+  metadata.gz: c0ad1209c4c0e95e1814134fc64a25433fc7f62c8e584c49bbea69913df58b75826d548683db648bebc16712e006955bed6f8eda8b7987653bf85dcc7f6b2ee1
+  data.tar.gz: c0f56e29eb44e2f35113379f6f3a9cc7b58e2831d89183bcb3278020069a937a0e8ada519aaae40bce114ac1b33f31cadd7b4a46a2e670008bf4b97e2ba29432

data/README.md

@@ -2,11 +2,16 @@
 * [Workflow](#workflow)
 * [Scope](#scope)
 * [Installation](#installation)
+  * [git](#git)
 * [Usage](#usage)
-  * [Help](#help)
-  * [rebase](#rebase)
-  * [purge](#purge)
-  * [aggregate](#aggregate)
+  * [Arguments](#help)
+    * [Help](#help)
+    * [Repository](#repository)
+    * [Branches](#branches)
+  * [Commands](#commands)
+    * [rebase](#rebase)
+    * [purge](#purge)
+    * [aggregate](#aggregate)
 
 ## Workflow
 This script will facilitate adopting a subset of the branch-featuring workflow characterised by:
@@ -21,37 +26,61 @@ The scope of this gem is helping out in the following cases:
 * you need to quickly aggregate branches for a release
 
 ## Installation
-I assume you have GIT installed ;)  
 Just install the gem to use the binaries commands.
 ```
 gem install git_commands
 ```
 
+### git
+The library uses the Ruby command line execution to invoke the **git** command. I assume you have the GIT program on your path.
+
 ## Usage
 Here are the main commands:
 
-### Help
-Each command come with a help option that can be displayed:
+### Arguments
+All of the available commands come with the same set of arguments:
+
+#### Help
+Display the help of a specific command by:
 
 ```
 rebase --help
 Usage: rebase --repo=./Sites/oro --branches=feature/add_bin,fetaure/remove_rake_task
     -r, --repo=REPO                  The path to the existing GIT repository
-    -b, --branches=BRANCHES          The comma-separated list of branches or the path to a .branches files
+    -b, --branches=BRANCHES          The comma-separated list of branches or the path to a file listing branches names on each line
     -h, --help                       Prints this help
 ```
 
-### rebase
-This is probably the most useful command in case you have several branches to rebase with _origin/master_ frequently.
-A confirmation is asked to before rebasing.  
+#### Repository
+You have to specify the path (absolute or relative) to the GIT repository you want to work with. The path must be a folder initialized as a valid GIT repository (a check via *rev-parse* is performed), otherwise an error is raised:
+
+```
+rebase --repo=invalid
+'invalid' is not a valid GIT repository!
+```
+
+#### Branches
+Along with the repository you always have to specify the list of branches you want the command to interact with.  
+You have two main options here:
+
+##### List of branches
+Specify a comma separated list of branch names:
 
 ```
-rebase --repo=~/Sites/greatest_hits --branches=feature/love_me_tender,feature/teddybear,feature/return_to_sender
+rebase --branches=feature/love_me_tender,feature/teddybear,feature/return_to_sender
+
+Loading branches file...
+Successfully loaded 3 branches:
+01. feature/love_me_tender
+02. feature/teddybear
+03. feature/return_to_sender
 ```
 
-You can also specify as the *branches* argument a path to a file containing the branches names on each line, like this:
+##### Path to a names file
+Specify a path (absolute or relative) to a file containing the branches names on each line:
 
-```txt
+File *./Sites/greatest_hits*:
+```
 feature/love_me_tender
 feature/teddybear
 feature/return_to_sender
@@ -59,22 +88,52 @@ feature/in_the_ghetto
 ```
 
 ```
-rebase --repo=~/Sites/greatest_hits --branches=~/greatest_hits/.branches
+rebase --branches=./Sites/greatest_hits
+
+Loading branches file...
+Successfully loaded 4 branches:
+01. feature/love_me_tender
+02. feature/teddybear
+03. feature/return_to_sender
+04. feature/in_the_ghetto
+```
+
+##### Checking
+Each loaded branch is validated for existence (via *rev-parse*), in case it does not an error is raised:
+
+```
+rebase --repo=./Sites/greatest_hits --branches=noent
+
+Loading branches file...
+Branch 'noent' does not exist!
+```
+
+### Commands
+Here are the available GIT commands:
+
+#### rebase
+This is probably the most useful command in case you have several branches to rebase with _origin/master_ frequently.
+A confirmation is asked to before rebasing.  
+
+```
+rebase --repo=./Sites/greatest_hits --branches=feature/love_me_tender,feature/teddybear,feature/return_to_sender
+...
 ```
 
-### purge
+#### purge
 This command remove the specified branches locally and remotely.  
 A confirmation is asked before removal.  
 
 ```
-purge --repo=~/temp/top_20 --branches=release/in_the_ghetto
+purge --repo=/temp/top_20 --branches=release/in_the_ghetto
+...
 ```
 
-### aggregate
-It should be useful to aggregate your branches into a single one in case you want to create a release branch.  
+#### aggregate
+This command aggregates all of the specified branches into a single one in case you want to create a release branch.  
 It uses the following naming convention: *release/yyyy_mm_dd*  
 A confirmation is asked before aggregating.  
 
 ```
-aggregate --repo=~/Sites/greatest_hits --branches=~/greatest_hits/.branches
+aggregate --repo=./Sites/greatest_hits --branches=./Sites/greatest_hits
 ```

data/lib/git_commands/cli.rb

@@ -22,7 +22,7 @@ module GitCommands
       parser.parse!(@args)
       command = @command_klass.new(repo: @repo, branches: @branches)
       command.send(@command_name)
-    rescue StandardError => e
+    rescue Command::GitError, AbortError, ArgumentError => e
       error(e.message)  
     end
 

data/lib/git_commands/command.rb

@@ -8,7 +8,7 @@ module GitCommands
     include Prompt
 
     class GitError < StandardError; end
-    class NoBranchesError < StandardError; end
+    class NoBranchesError < ArgumentError; end
     class NoentRepositoryError < ArgumentError; end
 
     GITHUB_HOST = "github.com"
@@ -92,6 +92,7 @@ module GitCommands
     end
 
     private def fetch_repo(repo)
+      fail NoentRepositoryError, "Please specify a valid GIT repository!" unless repo
       fail NoentRepositoryError, "'#{repo}' is not a valid GIT repository!" unless valid_repo?(repo)
       Pathname::new(repo)
     end

data/lib/git_commands/version.rb

@@ -1,3 +1,3 @@
 module GitCommands
-  VERSION = "3.1.6"
+  VERSION = "3.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_commands
 version: !ruby/object:Gem::Version
-  version: 3.1.6
+  version: 3.1.7
 platform: ruby
 authors:
 - costajob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler