git_commands 3.4.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4e5ee0c7fb792943323a8df9f026e46ed043c2e
-  data.tar.gz: a1d6e9c1709de3a742c9c20aa22cfbd6bdc86290
+  metadata.gz: 172e8dcb4ab65fc7f43efc68e42709b8730fb54b
+  data.tar.gz: 8a9fa030b351e83b13e3dd4ea7a5c0684670a05d
 SHA512:
-  metadata.gz: 725df66a77dd900e4f2c2aa5543c1e25ffc24d62cc332bc9e8fb7d7d29123f0eac821a57b8912d56c039eebcc1135f3ae1187531cddcfeb10c8f204e87854d53
-  data.tar.gz: 2b3162474ae63758828d6c1e9dc071c813a92565200e7a69d91c4808507718f11b62a05ab6598da26035e7c4fc95c3c6db38e6724f2d2c5ffda8b9a899836042
+  metadata.gz: 0adf55993c9add401986a9d019e712998813b087bcbbb27bcb339daaddab77a9c2ba3ddb8af7191c884462b6f7c05e55591323b7cd30dd96c5f4679cf1d7d070
+  data.tar.gz: 5222cf662d765a7fd08cbd31bb357abe849f2b5c42974c599a1b5e1462b4cb065720c58b5f6eb0a4d74298af3e770bf87efd97a7a7f35092be5b59084906fa3e

data/README.md

@@ -16,9 +16,8 @@
 ## Workflow
 This script facilitates adopting a subset of the branch-featuring workflow characterised by:
 * each feature will have its own branch
-* feature branches derive directly form master
-* integration of master to feature branch happens via rebasing to maintain a straight commits line
-* force pushing of feature branches to origin is not an issue
+* integration of feature branch with defaukt one happens via rebasing to maintain a straight commits line
+* is not an issue to `force-with-lease` push feature pranch to origin
 * release branches are created aggregating multiple branches
 
 ## Scope
@@ -48,10 +47,11 @@ Display the help of a specific command by:
 
 ```
 rebase --help
-Usage: rebase --repo=/Users/Elvis/greatest_hits --branches=feature/love_me_tender,fetaure/teddybear
+Usage: rebase --repo=/Users/Elvis/greatest_hits --origin=upstream --default=production --branches=feature/love_me_tender,fetaure/teddybear
     -r, --repo=REPO                  The path to the existing GIT repository
+    -o, --origin=ORIGIN              Specify the remote alias (origin)
+    -d, --default=DEFAULT            Specify the default branch (master)
     -b, --branches=BRANCHES          Specify branches as: 1. a comma-separated list of names 2. the path to a file containing names on each line 3. via pattern matching
-    -t, --target=TARGET              Specify the target branch, default to master
     -h, --help                       Prints this help
 ```
 
@@ -133,8 +133,8 @@ rebase --repo=/Users/Elvis/greatest_hits --branches=noent1,noent2
 No branches loaded!
 ```
 
-##### Master branch
-Master branch cannot be included into the branches list for obvious reasons:
+##### Default branch
+Default branch cannot be included into the branches list for obvious reasons:
 
 ```
 rebase --repo=/Users/Elvis/greatest_hits --branches=master,feature/love_me_tender
@@ -148,7 +148,7 @@ Successfully loaded 1 branch:
 Here are the available GIT commands:
 
 #### Rebase
-This command is useful in case you have several branches to rebase with _origin/master_ (or another specified target) frequently.
+This command is useful in case you have to rebase several branches with _origin/master_ (or another specified default) frequently.
 A confirmation is asked to before rebasing.  
 
 ```
@@ -156,17 +156,17 @@ rebase --repo=/Users/Elvis/greatest_hits --branches=feature/love_me_tender,featu
 ...
 ```
 
-##### Target branch
-The rebasing runs considering master branch as the target one.  
-In case you need to rebase against a different target branch you can specify it:
+##### Changing origin
+The rebasing runs considering `master` branch as the default one and `origin` as the remote alias.  
+In case you need to rebase against a different origin and default branch you can specify them by command line:
 ```
-rebase --repo=/Users/Elvis/greatest_hits --target=rc/release_to_graceland --branches=feature/love_me_tender
+rebase --repo=/Users/Elvis/greatest_hits --origin=upstream --default=production --branches=feature/love_me_tender
 
 Loading branches file...
 Successfully loaded 1 branch:
 01. feature/love_me_tender
 
-Proceed rebasing these branches with rc/release_to_graceland (Y/N)?
+Proceed rebasing these branches with upstream/production (Y/N)?
 ```
 
 #### Remove
@@ -180,10 +180,45 @@ remove --repo=/temp/top_20 --branches=*obsolete*
 
 #### Aggregate
 This command aggregates all of the specified branches into a single one in case you want to create a release branch.  
-The created aggregate branch follows this naming convention: *aggregate/yyyy_mm_dd*  
 A confirmation is asked before aggregating.  
 
 ```
 aggregate --repo=/Users/Elvis/greatest_hits --branches=*ready*
 ...
 ```
+
+##### Aggregate naming
+The created aggregate branch follows a default naming convention pattern: 
+`aggregate/<timestamp>` 
+
+Each of the term within the `<` and `>` chars are replaced by related (upcased) environment variables, but for the `timestamp`, that is computed at runtime in the `yyyymmdd` format.  
+Consider a valid pattern should at least contain one replaceable part within the `<` and `>` chars.
+
+You can overwrite the naming pattern by specifying the following environment variables:
+* `AGGREGATE_NAME` - the name to be used directly for the aggregator branch, without any pattern replacements
+* `AGGREGATE_PATTERN` - change the default pattern by specifying the related environment variables for each parts within the `<` and `>` chars
+
+###### Examples
+Passing directly the aggregate name:
+```shell
+AGGREGATE_NAME=my_aggregate aggregate --repo=/Users/Elvis/greatest_hits --branches=*ready*
+...
+Aggregate branches into my_aggregate (Y/N)?
+```
+
+Using the default pattern:
+```shell
+aggregate --repo=/Users/Elvis/greatest_hits --branches=*ready*
+...
+Aggregate branches into release/20170307 (Y/N)?
+```
+
+Using a custom pattern:
+```shell
+RELEASE_TYPE=bugfix \
+RISK=HIGH \
+PROGRESSIVE=3 \
+AGGREGATE_PATTERN="release/rc-<progressive>.<release_type>_<risk>_<timestamp>" aggregate --repo=/Users/Elvis/greatest_hits --branches=*ready*
+...
+Aggregate branches into release/rc-3.bugfix_HIGH_20170307 (Y/N)?
+```

data/lib/git_commands/aggregator.rb

@@ -0,0 +1,43 @@
+module GitCommands
+  class Aggregator
+    PATTERN = ENV.fetch("AGGREGATE_PATTERN") { "release/<timestamp>" }
+    NAME = ENV["AGGREGATE_NAME"]
+
+    class InvalidPatternError < ArgumentError; end
+
+    def initialize(name: NAME, pattern: PATTERN)
+      @name = name
+      @pattern = check_pattern(pattern)
+      define_methods
+    end
+
+    def timestamp
+      @timestamp ||= Time.new.strftime("%Y%m%d")
+    end
+
+    def call
+      return @name if @name
+      @pattern.gsub(/<[\w_]+>/) do |part|
+        msg = part.gsub(/<|>/, "")
+        send(msg)
+      end
+    end
+
+    private def check_pattern(pattern)
+      fail InvalidPatternError unless pattern.match(/<\w+>/) 
+      pattern
+    end
+
+    private def pattern_methods
+      @methods ||= @pattern.scan(/<(\w+)>/).flatten - ["timestamp"]
+    end
+
+    def define_methods
+      pattern_methods.each do |name|
+        define_singleton_method(name) do
+          ENV.fetch(name.upcase) { "" }
+        end
+      end
+    end
+  end
+end

data/lib/git_commands/branch.rb

@@ -3,11 +3,11 @@ require "pathname"
 module GitCommands
   using Colorize
   class Branch
-    MASTER = "master"
-    ORIGIN = "origin/"
+    DEFAULT = "master"
+    ORIGIN = "origin"
 
     def self.strip_origin(name)
-      name.strip.split(ORIGIN).last
+      name.strip.split("#{ORIGIN}/").last
     end
 
     def self.by_file(path)
@@ -19,9 +19,9 @@ module GitCommands
 
     def self.by_pattern(pattern)
       return [] unless pattern.index("*")
-      `git branch -r --list #{ORIGIN}#{pattern}`.split("\n").map do |name|
+      `git branch -r --list #{ORIGIN}/#{pattern}`.split("\n").map do |name|
         new(strip_origin(name))
-      end.reject(&:master?)
+      end.reject(&:default?)
     end
 
     def self.by_names(names_list)
@@ -54,7 +54,7 @@ module GitCommands
     end
 
     def valid?
-      return false if master?
+      return false if default?
       return false unless exists?
       true
     end
@@ -63,12 +63,12 @@ module GitCommands
       self.name == other.name
     end
 
-    def master?
-      @name == MASTER
+    def default?
+      @name == DEFAULT
     end
 
     def exists?(remote = true)
-      origin = ORIGIN if remote
+      origin = "#{ORIGIN}/" if remote
       `git rev-parse --verify #{origin}#{@name} 2> /dev/null`.match(/^[0-9a-z]+/)
     end
   end

data/lib/git_commands/cli.rb

@@ -20,15 +20,15 @@ module GitCommands
 
     def call
       parser.parse!(@args)
-      computer = @computer_klass.new(repo: @repo, branches: @branches, target: target)
+      computer = @computer_klass.new(repo: @repo, branches: @branches, origin: @origin, default: default)
       computer.send(@command_name)
     rescue Repository::PathError, Computer::GitError, AbortError, Repository::InvalidError => e
       error(e.message)  
       exit
     end
 
-    private def target
-      @target || Branch::MASTER
+    private def default
+      @default || Branch::DEFAULT
     end
 
     private def check_command_name(name)
@@ -38,18 +38,22 @@ module GitCommands
 
     private def parser
       OptionParser.new do |opts|
-        opts.banner = "Usage: #{@command_name} --repo=/Users/Elvis/greatest_hits --branches=feature/love_me_tender,fetaure/teddybear"
+        opts.banner = "Usage: #{@command_name} --repo=/Users/Elvis/greatest_hits --origin=upstream --default=production --branches=feature/love_me_tender,fetaure/teddybear"
 
         opts.on("-rREPO", "--repo=REPO", "The path to the existing GIT repository") do |repo|
           @repo = repo
         end
 
-        opts.on("-bBRANCHES", "--branches=BRANCHES", "Specify branches as: 1. a comma-separated list of names 2. the path to a file containing names on each line 3. via pattern matching") do |branches|
-          @branches = branches
+        opts.on("-oORIGIN", "--origin=ORIGIN", "Specify the remote alias (origin)") do |origin|
+          @origin = origin
+        end
+
+        opts.on("-dDEFAULT", "--default=DEFAULT", "Specify the default branch (master)") do |default|
+          @default = default
         end
 
-        opts.on("-tTARGET", "--target=TARGET", "Specify the target branch, default to master") do |target|
-          @target = target
+        opts.on("-bBRANCHES", "--branches=BRANCHES", "Specify branches as: 1. a comma-separated list of names 2. the path to a file containing names on each line 3. via pattern matching") do |branches|
+          @branches = branches
         end
 
         opts.on("-h", "--help", "Prints this help") do

data/lib/git_commands/computer.rb

@@ -1,6 +1,7 @@
 require "git_commands/prompt"
 require "git_commands/branch"
 require "git_commands/repository"
+require "git_commands/aggregator"
 
 module GitCommands
   class Computer
@@ -9,15 +10,14 @@ module GitCommands
     class GitError < StandardError; end
 
     attr_reader :out
-    attr_accessor :target
 
-    def initialize(repo:, branches:, target: Branch::MASTER, repo_klass: Repository, branch_klass: Branch, out: STDOUT)
+    def initialize(repo:, branches:, origin: Branch::ORIGIN, default: Branch::DEFAULT, repo_klass: Repository, branch_klass: Branch, out: STDOUT)
       @out = out
       @repo = repo_klass.new(repo)
-      @target = target
+      @origin = origin
+      @default = default
       Dir.chdir(@repo) do
         @branches = branch_klass.factory(branches)
-        @timestamp = Time.new.strftime("%Y-%m-%d")
         print_branches
       end
     end
@@ -35,14 +35,14 @@ module GitCommands
     end
 
     def rebase
-      confirm("Proceed rebasing these branches with #{@target}") do
+      confirm("Proceed rebasing these branches with: #{local_def}") do
         enter_repo do
           @branches.each do |branch|
             warning("Rebasing branch: #{branch}")
             `git checkout #{branch}`
-            `git pull origin #{branch}`
+            `git pull -r origin #{branch}`
             next unless rebase_with
-            `git push -f origin #{branch}`
+            `git push --force-with-lease origin #{branch}`
             success("Rebased successfully!")
           end
           remove_locals
@@ -50,23 +50,23 @@ module GitCommands
       end
     end
 
-    def aggregate
-      temp = "temp/#{@timestamp}"
-      target = "aggregate/#{@timestamp}"
-      confirm("Aggregate branches into #{target}") do
+    def aggregate(aggregator = Aggregator.new)
+      temp = "temp/#{aggregator.timestamp}"
+      aggregate_name = aggregator.call 
+      confirm("Aggregate branches into #{aggregate_name}") do
         enter_repo do
-          `git branch #{target}`
+          `git branch #{aggregate_name}`
           @branches.each do |branch|
             warning("Merging branch: #{branch}")
             `git checkout -b #{temp} origin/#{branch} --no-track`
-            clean_and_exit([temp, target]) unless rebase_with
-            clean_and_exit([temp]) unless rebase_with(target)
-            `git checkout #{target}`
+            clean_and_exit([temp, aggregate_name]) unless rebase_with
+            clean_and_exit([temp]) unless rebase_with(aggregate_name)
+            `git checkout #{aggregate_name}`
             `git merge #{temp}`
             `git branch -D #{temp}`
           end      
         end
-        success("#{target} branch created")
+        success("#{aggregate_name} branch created")
       end
     end
 
@@ -79,11 +79,13 @@ module GitCommands
     end
 
     private def align
-      `git checkout #{@target}`
-      `git pull`
+      `git fetch #{@origin} #{@default}`
+      `git fetch origin`
+      `git checkout #{@default}`
+      `git pull -r`
     end
 
-    private def rebase_with(branch = "#{Branch::ORIGIN}#{@target}")
+    private def rebase_with(branch = local_def)
       `git rebase #{branch}`
       return true unless @repo.locked?
       @repo.unlock
@@ -98,7 +100,7 @@ module GitCommands
     end
 
     private def remove_locals(branches = @branches)
-      `git checkout #{@target}`
+      `git checkout #{@default}`
       branches.each do |branch|
         `git branch -D #{branch}`
       end
@@ -108,5 +110,9 @@ module GitCommands
       remove_locals(branches)
       exit
     end
+
+    private def local_def
+      "#{@origin}/#{@default}"
+    end
   end
 end

data/lib/git_commands/prompt.rb

@@ -16,7 +16,7 @@ module GitCommands
     end
 
     def success(message)
-      out.puts message.to_s.green
+      out.puts "\n#{message}".green
       true
     end
 

data/lib/git_commands/version.rb

@@ -1,3 +1,3 @@
 module GitCommands
-  VERSION = "3.4.0"
+  VERSION = "3.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_commands
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.1
 platform: ruby
 authors:
 - costajob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ files:
 - bin/setup
 - git_commands.gemspec
 - lib/git_commands.rb
+- lib/git_commands/aggregator.rb
 - lib/git_commands/branch.rb
 - lib/git_commands/cli.rb
 - lib/git_commands/colorize.rb