git_commands 3.1.8 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67b5256b61bb6187f47f4b24fe7220750b022b55
-  data.tar.gz: 9a40a26fbfb14155999237513714678a379943df
+  metadata.gz: 01a6f8395baa1fb4d58f303328df32879e9f2fde
+  data.tar.gz: b2868ae612d6128188cd940e8e25bf36ad301ce1
 SHA512:
-  metadata.gz: e3358e46e6c0a3f3d84709e4ed8cdb46503c47c23dc1f4bf6ac6dbad26650314b6d5c5c6cf8e8c1a0d77152ecc8e27f7e3e39b6950f5e8605c4f9d883e66fc22
-  data.tar.gz: b29fd122148138fc29b0a7ef6e3d53eb2c01630c363bc57afaf194b81ff0d89b7be4de91bdd2ce5d42a6dd3698fffb1e35d68d5f4a6edb48dc9cc85de35f4d86
+  metadata.gz: c4f5c35d40aa43b150264c28dd056e1252ac18ebeece5db18c315173a8d3ebcf34933dbad57d9e10db517616ce806981dc1c2ce076dbc06927a1ad723aaf7253
+  data.tar.gz: cac97ac9121721c40287714f5794a1b1fcc7bed5516ed839c15c27627d87bbbf584fb64b92eecf6d3f45f74d062180867e7a769c91e898019f16972bf75eb5fa

data/README.md

@@ -15,15 +15,17 @@
 
 ## Workflow
 This script will facilitate 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**
-* **release** branches are created **aggregating multiple branches** into a new one
+* each feature will have its own branch
+* feature branches derive directly form master
+* integration of master to feature branch happens via rebasing
+* force pushing of feature branches to origin is not an issue
+* release branches are created aggregating multiple branches
 
 ## Scope
 The scope of this gem is helping out in the following cases:
 * you have multiple feature branches waiting for release due to some reason (i.e. long QA time...), and need to keep them aligned with master
 * you need to quickly aggregate branches for a release
+* you want to cleanup local and remote branches upon release
 
 ## Installation
 Just install the gem to use the binaries commands.
@@ -46,9 +48,9 @@ Display the help of a specific command by:
 
 ```
 rebase --help
-Usage: rebase --repo=./Sites/oro --branches=feature/add_bin,fetaure/remove_rake_task
+Usage: rebase --repo=/Users/Elvis/greatest_hits --branches=feature/love_me_tender,fetaure/teddybear
     -r, --repo=REPO                  The path to the existing GIT repository
-    -b, --branches=BRANCHES          The comma-separated list of branches or the path to a file listing branches names on each line
+    -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
     -h, --help                       Prints this help
 ```
 
@@ -61,14 +63,13 @@ rebase --repo=invalid
 ```
 
 #### 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:
+As with the repository you always have to specify the list of branches you want to work with. There are different options:
 
 ##### List of branches
 Specify a comma separated list of branch names:
 
 ```
-rebase --branches=feature/love_me_tender,feature/teddybear,feature/return_to_sender
+rebase --repo=/Users/Elvis/greatest_hits --branches=feature/love_me_tender,feature/teddybear,feature/return_to_sender
 
 Loading branches file...
 Successfully loaded 3 branches:
@@ -80,7 +81,7 @@ Successfully loaded 3 branches:
 ##### Path to a names file
 Specify a path (absolute or relative) to a file containing the branches names on each line:
 
-File *./Sites/greatest_hits*:
+File */Users/Elvis/greatest_hits/.branches*:
 ```
 feature/love_me_tender
 feature/teddybear
@@ -89,7 +90,7 @@ feature/in_the_ghetto
 ```
 
 ```
-rebase --branches=./Sites/greatest_hits
+rebase --repo=/Users/Elvis/greatest_hits --branches=/Users/Elvis/greatest_hits/.branches
 
 Loading branches file...
 Successfully loaded 4 branches:
@@ -99,25 +100,47 @@ Successfully loaded 4 branches:
 04. feature/in_the_ghetto
 ```
 
+##### Pattern matching
+In case you want to work with a set of branches with a common pattern, you have to specify a greedy operator with the wild card you want to match.  
+Just consider you have not to specify *origin/* as the name of the branch, since is managed by the script for you: 
+
+```
+rebase --repo=/Users/Elvis/greatest_hits --branches=*der
+
+Loading branches file...
+Successfully loaded 2 branches:
+01. feature/love_me_tender
+02. feature/return_to_sender
+```
+
 ##### Checking
-Each loaded branch is validated for existence (via *rev-parse*), in case it does not an error is raised:
+Each loaded branch is validated for existence (but for branches loaded via pattern matching). In case the validation fails, the branch is filtered from the resulting list.
 
 ```
-rebase --repo=./Sites/greatest_hits --branches=noent
+rebase --repo=/Users/Elvis/greatest_hits --branches=noent,feature/love_me_tender
 
 Loading branches file...
-Branch 'noent' does not exist!
+Successfully loaded 1 branch:
+01. feature/love_me_tender
+```
+
+In case no branches have been loaded, an error is raised:
+
+```
+cd /Users/Elvis
+rebase --repo=./greatest_hits --branches=noent1, noent2
+No branches loaded!
 ```
 
 ##### Master branch
-Master branch cannot be included into the branches list for obvious reasons (from useless to dangerous ones).
-An error is raised in case master branch is specified:
+Master branch cannot be included into the branches list for obvious reasons (from useless to dangerous ones):
 
 ```
-rebase --repo=./Sites/greatest_hits --branches=master
+rebase --repo=/Users/Elvis/greatest_hits --branches=master,feature/love_me_tender
 
 Loading branches file...
-Commands cannot interact directly with 'master' branch!
+Successfully loaded 1 branch:
+01. feature/love_me_tender
 ```
 
 ### Commands
@@ -128,7 +151,7 @@ This is probably the most useful command in case you have several branches to re
 A confirmation is asked to before rebasing.  
 
 ```
-rebase --repo=./Sites/greatest_hits --branches=feature/love_me_tender,feature/teddybear,feature/return_to_sender
+rebase --repo=/Users/Elvis/greatest_hits --branches=feature/love_me_tender,feature/teddybear,feature/return_to_sender
 ...
 ```
 
@@ -137,7 +160,7 @@ 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=*obsolete*
 ...
 ```
 
@@ -147,5 +170,5 @@ It uses the following naming convention: *release/yyyy_mm_dd*
 A confirmation is asked before aggregating.  
 
 ```
-aggregate --repo=./Sites/greatest_hits --branches=./Sites/greatest_hits
+aggregate --repo=/Users/Elvis/greatest_hits --branches=*ready*
 ```

data/lib/git_commands/branch.rb

@@ -0,0 +1,66 @@
+module GitCommands
+  class Branch
+    MASTER = "master"
+    ORIGIN = "origin/"
+
+    def self.strip_origin(name)
+      name.strip.split(ORIGIN).last
+    end
+
+    def self.by_names(names_list)
+      String(names_list).split(",").map do |name|
+        new(name.strip)
+      end.select(&:valid?)
+    end
+
+    def self.by_file(names_file)
+      return [] unless File.file?(names_file)
+      File.foreach(names_file).map do |name|
+        new(name.strip)
+      end.select(&:valid?)
+    end
+
+    def self.by_pattern(pattern)
+      return [] unless pattern.index("*")
+      `git branch -r --list #{ORIGIN}#{pattern}`.split("\n").map do |name|
+        new(strip_origin(name))
+      end
+    end
+
+    def self.factory(src)
+      return [] unless src
+      branches = by_file(src)
+      branches = by_pattern(src) if branches.empty?
+      branches = by_names(src) if branches.empty?
+      branches
+    end
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def to_s
+      @name
+    end
+
+    def valid?
+      return false if master?
+      return false unless exists?
+      true
+    end
+
+    def ==(other)
+      self.name == other.name
+    end
+
+    private def master?
+      @name == MASTER
+    end
+
+    private def exists?
+      `git rev-parse --verify origin/#{@name} 2> /dev/null`.match(/^[0-9a-z]+/)
+    end
+  end
+end

data/lib/git_commands/cli.rb

@@ -22,8 +22,9 @@ module GitCommands
       parser.parse!(@args)
       command = @command_klass.new(repo: @repo, branches: @branches)
       command.send(@command_name)
-    rescue Command::GitError, AbortError, ArgumentError => e
+    rescue Command::GitError, AbortError, Repository::InvalidError => e
       error(e.message)  
+      exit
     end
 
     private def create_command
@@ -37,13 +38,13 @@ module GitCommands
 
     private def parser
       OptionParser.new do |opts|
-        opts.banner = "Usage: #{@command_name} --repo=./Sites/oro --branches=feature/add_bin,fetaure/remove_rake_task"
+        opts.banner = "Usage: #{@command_name} --repo=/Users/Elvis/greatest_hits --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", "The comma-separated list of branches or the path to a file listing branches names on each line") do |branches|
+        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
 

data/lib/git_commands/command.rb

@@ -2,41 +2,25 @@ require "pathname"
 require "fileutils"
 require "net/http"
 require "git_commands/prompt"
+require "git_commands/branch"
+require "git_commands/repository"
 
 module GitCommands
   class Command
     include Prompt
 
     class GitError < StandardError; end
-    class NoBranchesError < ArgumentError; end
-    class NoentRepositoryError < ArgumentError; end
-
-    GITHUB_HOST = "github.com"
-    UNFINISHED_REBASE_FILES = %w(rebase-merge rebase-apply)
-
-    def self.check_connection
-      !!Net::HTTP.new(GITHUB_HOST).head("/")
-    rescue Errno::ENETUNREACH => e
-      raise e, "There is no connection!"
-    end
-
-    def self.git_repo?(repo)
-      `git rev-parse --is-inside-work-tree 2> /dev/null`.strip == "true"
-    end
-
-    def self.valid_branch?(branch)
-      `git rev-parse --verify origin/#{branch} 2> /dev/null`.match(/^[0-9a-z]+/)
-    end
 
     attr_reader :out
 
-    def initialize(repo:, branches:, out: STDOUT)
-      self.class.check_connection
+    def initialize(repo:, branches:, repo_klass: Repository, branch_klass: Branch, out: STDOUT)
       @out = out
-      @repo = fetch_repo(repo)
-      @branches = fetch_branches(String(branches))
-      @timestamp = Time.new.strftime("%Y-%m-%d")
-      print_branches
+      @repo = repo_klass.new(repo)
+      Dir.chdir(@repo) do
+        @branches = branch_klass.factory(branches)
+        @timestamp = Time.new.strftime("%Y-%m-%d")
+        print_branches
+      end
     end
 
     def purge
@@ -54,15 +38,15 @@ module GitCommands
     end
 
     def rebase
-      confirm("Proceed rebasing these branches") do
+      confirm("Proceed rebasing these branches with master") do
         enter_repo do
           @branches.each do |branch|
             warning("Rebasing branch: #{branch}")
             `git checkout #{branch}`
             `git pull origin #{branch}`
-            rebase_with_master
-            `git push origin #{branch}`
-            `git checkout master`
+            next unless rebase_with_master
+            `git push -f origin #{branch}`
+            `git checkout #{Branch::MASTER}`
             `git branch -D #{branch}`
             success "Rebased successfully!"
           end
@@ -79,53 +63,20 @@ module GitCommands
           @branches.each do |branch|
             warning("Merging branch: #{branch}")
             `git checkout -b #{temp} origin/#{branch} --no-track`
-            rebase_with_master
+            next unless rebase_with_master
             `git rebase #{aggregate}`
             `git checkout #{aggregate}`
             `git merge #{temp}`
             `git branch -d #{temp}`
-            `git checkout master`
           end      
+          `git checkout #{Branch::MASTER}`
         end
         success "#{aggregate} branch created"
       end
     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
-
-    private def valid_repo?(repo)
-      return false unless File.directory?(repo)
-      Dir.chdir(repo) do
-        self.class.git_repo?(repo)
-      end
-    end
-
-    private def fetch_branches(src)
-      warning("Loading branches file")
-      branches = File.foreach(src).map(&:strip) if valid_file?(src)
-      branches ||= src.split(",").map(&:strip) 
-      branches.tap do |list|
-        fail(NoBranchesError, "No branches have been loaded!") if list.empty?
-        list.each { |branch| check_branch(branch) }
-      end
-    end
-
-    private def check_branch(branch)
-      Dir.chdir(@repo) do
-        fail(GitError, "Commands cannot interact directly with 'master' branch!") if branch == "master"
-        fail(GitError, "Branch '#{branch}' does not exist!") unless self.class.valid_branch?(branch)
-      end
-    end
-
-    private def valid_file?(branches)
-      File.exist?(branches) && !File.directory?(branches)
-    end
-
     private def print_branches
+      fail GitError, "No branches loaded!" if @branches.empty?
       size = @branches.to_a.size
       plural = size > 1 ? "es" : ""
       success "Successfully loaded #{size} branch#{plural}:"
@@ -133,16 +84,15 @@ module GitCommands
     end
 
     private def pull_master
-      `git checkout master`
+      `git checkout #{Branch::MASTER}`
       `git pull`
     end
 
     private def rebase_with_master
-      `git rebase origin/master`
-      if unfinished_rebase?
-        `git rebase --abort`
-        fail(GitError, "Halting unfinished rebase!")
-      end
+      `git rebase origin/#{Branch::MASTER}`
+      return true unless @repo.locked?
+      `git rebase --abort`
+      error("Got conflicts, skipping rebase!")
     end
 
     private def enter_repo
@@ -151,11 +101,5 @@ module GitCommands
         yield
       end
     end
-
-    private def unfinished_rebase?
-      UNFINISHED_REBASE_FILES.any? do |name| 
-        File.exists?(@repo.join(".git", name))
-      end
-    end
   end
 end

data/lib/git_commands/prompt.rb

@@ -34,7 +34,6 @@ module GitCommands
 
     def error(message)
       out.puts message.to_s.red
-      exit
     end
 
     private def ask(message)

data/lib/git_commands/repository.rb

@@ -0,0 +1,39 @@
+require "pathname"
+
+module GitCommands
+  class Repository
+    LOCKING_FILES = %w(rebase-merge rebase-apply)
+
+    class InvalidError < StandardError; end
+
+    def initialize(path)
+      @path = Pathname::new(path.to_s)
+      fail InvalidError, "'#{path}' is not a valid GIT repository!" unless valid?
+    end
+
+    def to_path
+      @path.to_s
+    end
+
+    def locked?
+      LOCKING_FILES.any? do |name| 
+        File.exists?(@path.join(".git", name))
+      end
+    end
+
+    private def valid?
+      return false unless exists?
+      work_tree?
+    end
+
+    private def exists?
+      File.directory?(@path)
+    end
+
+    private def work_tree?
+      Dir.chdir(@path) do
+        `git rev-parse --is-inside-work-tree 2> /dev/null`.strip == "true"
+      end
+    end
+  end
+end

data/lib/git_commands/version.rb

@@ -1,3 +1,3 @@
 module GitCommands
-  VERSION = "3.1.8"
+  VERSION = "3.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_commands
 version: !ruby/object:Gem::Version
-  version: 3.1.8
+  version: 3.2.0
 platform: ruby
 authors:
 - costajob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,10 +75,12 @@ files:
 - bin/setup
 - git_commands.gemspec
 - lib/git_commands.rb
+- lib/git_commands/branch.rb
 - lib/git_commands/cli.rb
 - lib/git_commands/colorize.rb
 - lib/git_commands/command.rb
 - lib/git_commands/prompt.rb
+- lib/git_commands/repository.rb
 - lib/git_commands/version.rb
 homepage: https://github.com/costajob/git_commands.git
 licenses: