git_commands 2.1.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00a6f3b64ac568ed9a8a00e28c157015f70a5892
-  data.tar.gz: deeb00dac84552dd33e4f8bfde79aaae31d8ee90
+  metadata.gz: fdcb9347219a2d30498979c09bf72df199d467d6
+  data.tar.gz: e28679b3e3a1d502f3c2f332a8613931975baf40
 SHA512:
-  metadata.gz: dd423813e1be43a52b56011ef9c49540b759342e04fca35981967b618166c8613a1ac4eff440b69bebaabcaa0bee6ce1edd15850220e704d239b206a47cef16a
-  data.tar.gz: 44a626d66746877bb03092572b74541858607a81f698d46e69887747660f6f181a48f4b36e43c16a62fcac1dc0dec6a3a55f9dafb66e2774f5d9b8590a3d00f5
+  metadata.gz: fc67e861437e2e785b670c860875dd08defda841f517c1055bba73f7da5c418197171fe373c67b7edb60abd18f95797de25be237ba995431ee2e4372cd6f381c
+  data.tar.gz: 6fc5ae0086a7e7acd78976e465fb597148e6a255653faf9d5fe0c4a516cec496b55bc4aa9c11b377ae8625f97b43b1c9875caa870dd1c185dad70cea2ae2fc31

data/.travis.yml

@@ -1,9 +1,5 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
   - 2.1.8
   - 2.2.1
   - 2.3.0

data/README.md

@@ -3,7 +3,7 @@
 * [Scope](#scope)
 * [Installation](#installation)
 * [Usage](#usage)
-  * [setup](#setup)
+  * [Help](#help)
   * [rebase](#rebase)
   * [purge](#purge)
   * [aggregate](#aggregate)
@@ -13,8 +13,6 @@ This script will facilitate adopting a subset of the branch-featuring workflow c
 * each **feature** will have **its own branch**
 * **feature** branches **derive** directly **form master**
 * **integration** of master to feature branch happens **via rebasing**
-* rebasing interactively is used on feature branch to **squash commits** to get a **single one per feature** branch
-* **pushing with force** on local branches is not an issue
 * **release** branches are created **aggregating multiple branches** into a new one
 
 ## Scope
@@ -24,56 +22,52 @@ The scope of this is helping out in the following cases:
 
 ## Installation
 I assume you have GIT installed ;)  
-You will probably use this gem standalone, since i see no use in including it into another project.  
-Just clone the Github repository, move to the gem directory and start using rake tasks.
+Just install the gem to use the binaries commands.
+```
+gem isntall git_commands
+```
 
 ## Usage
-Here are the main Rake tasks:
+Here are the main commands:
 
-### setup
-The core of the library is automating multiple branches fetching, this action happens in two concurrent ways:  
-* from the command line, by splitting a comma separated list
-* by reading a file where names are listed on each line
-In case **no branches** are fetched the **script halts**.
+### Help
+Each command has an help option that can be displayed:
 
-Is also assumed you're pointing to a project directory somewhere, so the script could move in and execute the GIT commands for you.
-
-To call this task with arguments call it like that:
-```ruby
-rake git_commands:setup repo=git_repository base_dir=repo_path branches_file=file_listing_branches branches=list,of,branches,separated,by,comma
 ```
-Here are the arguments list:
-* **repo**: the repository name you want to automate git commant to
-* **base_dir**: the base path to your GIT repo, excluding its name (specified eralier). It defaults to HOME/Sites
-* **branches_file**: the path to the file, if any, listing the branches names. It defaults to the **.branches** file inside of your repo path (you need to add it to the .gitignore then)
-* **branches**: a list of branches separated by comma (optional), if specified it has precedence over the branches_file
+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
+    -h, --help                       Prints this help
+```
 
 ### rebase
-This is probably the most useful command in case you have several branch to rebase with _origin/master_ frequently.
-Consider after the rebase the branch is pushed to origin with force, so be aware in case more than one programmer access the same branch from different computers.  
+This is probably the most useful command in case you have several branches to rebase with _origin/master_ frequently.
 A confirmation is asked to continue.  
 
-As the other tasks, it depends on the setup one, so it accepts the same arguments:
-```ruby
-# loads branches from the repo .branches file, repo si located at HOME/Sites/my_repo
-rake git_commands:rebase repo=my_repo
+```
+rebase --repo=~/Sites/greatest_hits --branches=feature/love_me_tender,feature/teddybear,feature/return_to_sender
+```
+
+You can also specify as the *branches* the path to a file containing multiple branches on each line:
+
+```
+rebase --repo=~/Sites/greatest_hits --branches=~/greatest_hits/.branches
 ```
 
 ### purge
 This command remove the specified branches locally and remotely.  
 A confirmation is asked before each removal.  
-It uses the same arguments as setup:
-```ruby
-# purge old branches specified at the command line, repo is located at HOME/Sites/my_repo
-rake git_commands:purge repo=my_repo branches=old_branch,older_branch,oldest_branch
+
+```
+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.  
-It uses the following naming convention: rb_yyyy_mm_dd  
+It uses the following naming convention: *release/yyyy_mm_dd*  
 A confirmation is asked to continue.  
-It uses the same arguments as setup:
-```ruby
-# aggregate branches listed in the /tmp/to_release file, repo si located at HOME/Sites/my_repo
-rake git_commands:aggregate repo=my_repo branches_file=/tmp/to_release
+
+```
+aggregate --repo=~/Sites/greatest_hits --branches=~/greatest_hits/.branches
 ```

data/Rakefile

@@ -1,6 +1,5 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
-import 'lib/tasks/git_commands.rake'
 
 Rake::TestTask.new(:spec) do |t|
   t.libs << 'lib'

data/bin/aggregate

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "git_commands"
+
+cli = GitCommands::CLI.new(command_name: "aggregate")
+cli.call

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "git_utils"
+require "git_commands"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/bin/purge

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "git_commands"
+
+cli = GitCommands::CLI.new(command_name: "purge")
+cli.call

data/bin/rebase

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "git_commands"
+
+cli = GitCommands::CLI.new(command_name: "rebase")
+cli.call

data/git_commands.gemspec

@@ -11,11 +11,11 @@ Gem::Specification.new do |s|
   s.summary = "Utility library to rebase and aggregate your project branches"
   s.homepage = "https://github.com/costajob/git_commands.git"
   s.license = "MIT"
-  s.required_ruby_version = ">= 1.9.2"
+  s.required_ruby_version = ">= 2.1.8"
 
   s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|s|features)/}) }
-  s.bindir = "exe"
-  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.bindir = "bin"
+  s.executables = %w[rebase aggregate purge]
   s.require_paths = ["lib"]
 
   s.add_development_dependency "bundler", "~> 1.11"

data/lib/git_commands/cli.rb

@@ -0,0 +1,53 @@
+require "optparse"
+require "git_commands/command"
+
+module GitCommands
+  class CLI
+    VALID_COMMANDS = %w[rebase aggregate purge]
+
+    class UnknownCommandError < ArgumentError; end
+
+    def initialize(command_name:, args: ARGV, out: STDOUT, command_klass: Command)
+      @command_name = check_command_name(command_name)
+      @command_klass = command_klass
+      @args = args
+      @out = out 
+      @repo = nil
+      @branches = nil
+    end
+
+    def call
+      parser.parse!(@args)
+      command = @command_klass.new(repo: @repo, branches: @branches)
+      command.send(@command_name)
+    end
+
+    private def create_command
+      return @command if @command
+    end
+
+    private def check_command_name(name)
+      return name if VALID_COMMANDS.include?(name)
+      fail UnknownCommandError, "#{name} is not a supported command"
+    end
+
+    private def parser
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{@command_name} --repo=./Sites/oro --branches=feature/add_bin,fetaure/remove_rake_task"
+
+        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 .branches files") do |branches|
+          @branches = branches
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          @out.puts opts
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/git_commands/colorize.rb

@@ -10,13 +10,12 @@ module GitCommands
       :grey => 37
     }
 
-  end
-end
-
-String.instance_eval do
-  GitCommands::Colorize::CODES.each do |message, code|
-    define_method(message) do
-      "\e[#{code}m#{self}\e[0m"
+    refine String do
+      GitCommands::Colorize::CODES.each do |message, code|
+        define_method(message) do
+          "\e[#{code}m#{self}\e[0m"
+        end
+      end
     end
   end
 end

data/lib/git_commands/command.rb

@@ -1,7 +1,7 @@
-require 'pathname'
-require 'fileutils'
-require 'net/http'
-require 'git_commands/prompt'
+require "pathname"
+require "fileutils"
+require "net/http"
+require "git_commands/prompt"
 
 module GitCommands
   class Command
@@ -9,36 +9,37 @@ module GitCommands
 
     class GitError < StandardError; end
     class NoBranchesError < StandardError; end
+    class NoentRepositoryError < ArgumentError; end
 
-    GITHUB_HOST = 'github.com'
-    BASE_DIR = File.join(ENV['HOME'], 'Sites')
+    GITHUB_HOST = "github.com"
     UNFINISHED_REBASE_FILES = %w(rebase-merge rebase-apply)
 
     def self.check_connection
-      !!Net::HTTP.new(GITHUB_HOST).head('/')
+      !!Net::HTTP.new(GITHUB_HOST).head("/")
     rescue Errno::ENETUNREACH => e
-      raise e, 'There is no connection!'
+      raise e, "There is no connection!"
     end
 
-    def initialize(options = {})
+    attr_reader :out
+
+    def initialize(repo:, branches:, out: STDOUT)
       self.class.check_connection
-      @repo = options[:repo] || error('Please specify a valid repository name!', ArgumentError)
-      @base_dir = options[:base_dir]  || BASE_DIR
-      @branches_file = options[:branches_file] || repo_path.join('.branches')
-      @branches = options[:branches].to_s.split(',')
-      fetch_branches
+      @out = out
+      @repo = fetch_repo(repo)
+      @branches = fetch_branches(branches)
+      @timestamp = Time.new.strftime("%Y-%m-%d")
       check_branches
     end
 
     def purge
       enter_repo do
         @branches.each do |branch|
-          error('Trying ro remove master!', GitError) if branch == 'master'
+          error("Trying ro remove master!", GitError) if branch == "master"
           warning("Removing branch: #{branch}")
-          confirm('Remove local branch') do
+          confirm("Remove local branch") do
             `git branch -D #{branch}`
           end
-          confirm('Remove remote branch') do
+          confirm("Remove remote branch") do
             `git push origin :#{branch}`
           end
         end
@@ -46,90 +47,86 @@ module GitCommands
     end
 
     def rebase
-      confirm('Proceed rebasing these branches') do
+      confirm("Proceed rebasing these branches") 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} -f`
+            `git push origin #{branch}`
             `git checkout master`
             `git branch -D #{branch}`
-            success 'Rebased successfully!'
+            success "Rebased successfully!"
           end
         end
       end
     end
 
     def aggregate
-      temp = "temp_#{aggregate_name}"
-      confirm("Aggregate branches into #{aggregate_name}") do
+      temp = "temp/#{@timestamp}"
+      aggregate = "release/#{@timestamp}"
+      confirm("Aggregate branches into #{aggregate}") do
         enter_repo do
-          `git branch #{aggregate_name}`
+          `git branch #{aggregate}`
           @branches.each do |branch|
             warning("Merging branch: #{branch}")
             `git checkout -b #{temp} origin/#{branch} --no-track`
             rebase_with_master
-            `git rebase #{aggregate_name}`
-            `git checkout #{aggregate_name}`
+            `git rebase #{aggregate}`
+            `git checkout #{aggregate}`
             `git merge #{temp}`
             `git branch -d #{temp}`
           end      
         end
-        success 'Aggregate branch created'
+        success "#{aggregate} branch created"
       end
     end
 
-    private 
-
-    def repo_path
-      @repo_path ||= Pathname::new(File.join(@base_dir, @repo))
+    private def fetch_repo(repo)
+      return Pathname::new(repo) if File.exist?(repo)
+      fail NoentRepositoryError, "#{repo} is not a valid GIT repository!" 
     end
 
-    def fetch_branches
-      return unless @branches.empty? && File.exist?(@branches_file)
-      warning('Loading branches file')
-      @branches = File.foreach(@branches_file).map(&:strip)
+    private def check_branches
+      error("No branches have been loaded!", NoBranchesError) if @branches.empty?
+      print_branches
     end
 
-    def check_branches
-      error('No branches have been loaded!', NoBranchesError) if @branches.empty?
-      print_branches
+    private def fetch_branches(branches)
+      warning("Loading branches file")
+      return File.foreach(branches).map(&:strip) if File.exist?(branches)
+      branches.to_s.split(",").map(&:strip) 
     end
 
-    def print_branches
+    private def print_branches
       size = @branches.to_a.size
-      plural = size > 1 ? 'es' : ''
+      plural = size > 1 ? "es" : ""
       success "Successfully loaded #{size} branch#{plural}:"
-      puts @branches.each_with_index.map { |branch, i| "#{(i+1).to_s.rjust(2, '0')}. #{branch}" } + ['']
+      @out.puts @branches.each_with_index.map { |branch, i| "#{(i+1).to_s.rjust(2, "0")}. #{branch}" } + [""]
     end
 
-    def pull_master
+    private def pull_master
       `git checkout master`
       `git pull`
     end
 
-    def rebase_with_master
+    private def rebase_with_master
       `git rebase origin/master`
-      error('Halting unfinished rebase!', GitError) { `git rebase --abort` } if unfinished_rebase?
+      error("Halting unfinished rebase!", GitError) { `git rebase --abort` } if unfinished_rebase?
     end
 
-    def enter_repo
-      Dir.chdir repo_path do
+    private def enter_repo
+      Dir.chdir(@repo) do
         pull_master
         yield
       end
     end
 
-    def unfinished_rebase?
+    private def unfinished_rebase?
       UNFINISHED_REBASE_FILES.any? do |name| 
-        File.exists?(repo_path.join('.git', name))
+        File.exists?(@repo.join(".git", name))
       end
     end
-
-    def aggregate_name
-      @aggregate_name ||= Time.new.strftime("rb_%Y-%m-%d")
-    end
   end
 end

data/lib/git_commands/prompt.rb

@@ -1,24 +1,29 @@
-require 'git_commands/colorize'
+require "git_commands/colorize"
 
 module GitCommands
+  using Colorize
   module Prompt
     VALID_ANSWERS = %w[Y y N n]
 
     class AbortError < StandardError; end
 
-    def warning(message, char = '*')
+    def out
+      @out ||= STDOUT
+    end
+
+    def warning(message, char = "*")
       spacer = (char * (message.size + 4)).grey
-      puts "\n", spacer, "#{char} #{message.to_s.yellow} #{char}", spacer, "\n"
+      out.puts "\n", spacer, "#{char} #{message.to_s.yellow} #{char}", spacer, "\n"
     end
 
     def error(message, error = StandardError)
-      puts message.to_s.red
+      out.puts message.to_s.red
       yield if block_given?
       fail error, message
     end
 
     def success(message)
-      puts message.to_s.green
+      out.puts message.to_s.green
     end
 
     def confirm(message)
@@ -29,14 +34,14 @@ module GitCommands
       when /y/i
         yield
       else
-        error('Aborted operation!', AbortError)
+        error("Aborted operation!", AbortError)
       end
     end
 
     private 
     
     def ask(message)
-      print message.cyan
+      out.print message.cyan
       input
     end
 

data/lib/git_commands/version.rb

@@ -1,3 +1,3 @@
 module GitCommands
-  VERSION = "2.1.0"
+  VERSION = "3.0.1"
 end

data/lib/git_commands.rb

@@ -1 +1,6 @@
-require 'git_commands/command'
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "git_commands/version"
+require "git_commands/command"
+require "git_commands/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.1
 platform: ruby
 authors:
 - costajob
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-09-22 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,7 +69,10 @@ dependencies:
 description: 
 email:
 - costajob@gmail.com
-executables: []
+executables:
+- rebase
+- aggregate
+- purge
 extensions: []
 extra_rdoc_files: []
 files:
@@ -80,15 +83,18 @@ files:
 - README.md
 - Rakefile
 - Vagrantfile
+- bin/aggregate
 - bin/console
+- bin/purge
+- bin/rebase
 - bin/setup
 - git_commands.gemspec
 - lib/git_commands.rb
+- lib/git_commands/cli.rb
 - lib/git_commands/colorize.rb
 - lib/git_commands/command.rb
 - lib/git_commands/prompt.rb
 - lib/git_commands/version.rb
-- lib/tasks/git_commands.rake
 homepage: https://github.com/costajob/git_commands.git
 licenses:
 - MIT
@@ -101,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.1.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/tasks/git_commands.rake

@@ -1,29 +0,0 @@
-require 'git_commands/command'
-
-namespace :git_commands do
-  desc <<END
-Setup the command instance:
-  > rake git_utils:setup repo=git_repository base_dir=repo_path branches_file=file_listing_branches branches=list,of,branches,separated,by,comma
-END
-  task :setup do
-    @command = GitCommands::Command::new(:repo => ENV['repo'], 
-                                      :base_dir => ENV['base_dir'], 
-                                      :branches_file => ENV['branches_file'], 
-                                      :branches => ENV['branches'])
-  end
-  
-  desc 'Purge specified branches locally and from origin'
-  task :purge => :setup do
-    @command.purge
-  end
-  
-  desc 'Rebase specified branches with master'
-  task :rebase => :setup do
-    @command.rebase
-  end
-  
-  desc 'Aggregate specified branches into a single one'
-  task :aggregate => :setup do
-    @command.aggregate
-  end
-end