git-it 0.0.7 → 0.0.8

data/README.rdoc

@@ -18,9 +18,17 @@ Might not need sudo depending on your setup. To install as /usr/bin/git-it thoug
 
 == Use
 
-Open current branch in the web. Use it as an easy way to issue pull request in github.
+Open branch
 
-    git it opened_in_the_web #=> open https://github.com/more-ron/git-it/tree/master
+    git it opened #=> https://github.com/more-ron/git-it/tree/gh-pages
+
+Compare branches
+
+    git it compared #=> https://github.com/more-ron/git-it/compare/master...gh-pages
+
+Issue a pull request
+
+    git it pulled #=> https://github.com/more-ron/git-it/pull/new/more-ron:master...gh-pages
 
 
 
@@ -40,9 +48,18 @@ You will need to know where git-it got installed. To do that execute the followi
 
 [Parameters]
 
-  get it opened in the web:
+  get it opened:
+    --path=$REPO --sha=$SHA opened
+
+  get it compared:
+    --path=$REPO --sha=$SHA compared
+  get it compared to release:
+    --path=$REPO --sha=$SHA compared --to=release
 
-    --path=$REPO --sha=$SHA opened_in_the_web
+  get it pulled:
+    --path=$REPO --sha=$SHA pulled
+  get it pulled to release:
+    --path=$REPO --sha=$SHA pulled --to=release
 
 
 

data/bin/git-it

@@ -34,20 +34,35 @@ default_value false
 # = Commands =
 # ============
 
-desc 'Opens current branch in web browser.'
+desc 'Opens current branch.'
+command :opened do |c|
+  c.action do |global_options, options, args|
+    GitIt::Commander.new( global_options ).open( args, options )
+  end
+end
 
-command :opened_in_the_web do |c|
+desc 'Compares current branch to...'
+command :compared do |c|
 
-  c.desc 'Site: auto | github'
-  c.default_value 'auto'
-  c.flag :site
+  c.desc 'Name of the branch to compare to'
+  c.default_value 'master'
+  c.flag :to
 
-  c.action do |global_options,options,args|
-    GitIt::Commander.new(global_options).open_in_the_web(args, options)
+  c.action do |global_options, options, args|
+    GitIt::Commander.new( global_options ).compare( args, options )
   end
 end
 
-class Object # :nodoc:
+desc 'Issue pull request for current branch to...'
+command :pulled do |c|
+
+  c.desc 'Name of the branch to be pulled into'
+  c.default_value 'master'
+  c.flag :to
+
+  c.action do |global_options, options, args|
+    GitIt::Commander.new( global_options ).pull( args, options )
+  end
 end
 
 # ====================
@@ -75,4 +90,7 @@ on_error do |exception|
   true
 end
 
+class Object # :nodoc:
+end
+
 exit run(ARGV)

data/lib/git-it/commander.rb

@@ -1,149 +1,207 @@
-# Grand central station for git it commands
-class GitIt::Commander
-
-  # current git repository
-  attr_reader :repository
-
-  # current git object
-  attr_reader :git_object
-
-  # [global options]
-  #   --help::          Show this message
-  #   -p, --path=path:: repository path (default: {{present_working_directory}})
-  #   -s, --sha=sha::   SHA1 (default: {{current_head}})
-  #   --version::       Show gem's version
-  def initialize(options)
-    @global_options = options
-    @repository     = Rugged::Repository.new( get_path(options[:path]) )
-    @git_object     = get_object( options[:sha] )
-    @test_mode      = options[:test]
-  end
+module GitIt
+  # Grand central station for git it commands
+  class Commander
+
+    # current git repository
+    attr_reader :repository
+
+    # current git object
+    attr_reader :git_object
+
+    # [global options]
+    #
+    #   --help::          Show this message
+    #   -p, --path=path:: repository path (default: {{present_working_directory}})
+    #   -s, --sha=sha::   SHA1 (default: {{current_head}})
+    #
+    # [sample usage]
+    #
+    #   Open present working directory's repository branch:
+    #     git it opened
+    #
+    #   Open specified repository in the path:
+    #     git it --path=the/path/to/the/repo opened
+    #
+    #   Open specified sha1:
+    #     git it --sha=50m35ha1 opened
+    #
+    #   Open specified repository in the path and sha1:
+    #     git it --path=the/path/to/the/repo --sha=50m35ha1 opened
+    #
+    def initialize(options)
+      @global_options = options
+      @repository     = Rugged::Repository.new( get_path(options[:path]) )
+      @git_object     = get_object( options[:sha] )
+      @test_mode      = options[:test]
+
+      @link_generator = LinkGenerator.new( @repository.config["remote.origin.url"] )
+    end
 
 
 
-  # ===========
-  # = Actions =
-  # ===========
-
-  # [get it opened in the web]
-  #
-  #   Opens closest branch in the web.
-  #
-  # [commands]
-  #
-  #   Open present working directory's repository and head in the web:
-  #     git it opened_in_the_web
-  #
-  #   Open specified repository in the path:
-  #     git it --path=the/path/to/the/repo opened_in_the_web
-  #
-  #   Open specified sha1:
-  #     git it --sha=50m35ha1 opened_in_the_web
-  #
-  #   Open specified repository in the path and sha1:
-  #     git it --path=the/path/to/the/repo --sha=50m35ha1 opened_in_the_web
-  #
-  # [notes]
-  #
-  #   * Currently only supports GitHub.com
-  #
-  def open_in_the_web(args, options)
-    closest_branch = closest_remote_branch || closest_local_branch
-
-    if closest_branch
-      remote_origin_url = repository.config["remote.origin.url"]
-      #=> git@github.com:more-ron/git-it.git
-
-      github_link = remote_origin_url.gsub("git@github.com:", "https://github.com/")
-      #=> https://github.com/more-ron/git-it.git
-
-      branch_name = closest_branch.name.gsub("origin/", "")
-      #=> origin/gh-pages => gh-pages
+    # ===========
+    # = Actions =
+    # ===========
 
-      branch_name = closest_remote_branch.target.gsub("refs/remotes/origin/", "") if branch_name == "HEAD"
-      #=> refs/remotes/origin/master => master
+    # [get it opened]
+    #
+    #   Opens the current branch
+    #
+    # [sample usage]
+    #
+    #   Open the current branch:
+    #     git it opened
+    #
+    def open(args, options)
+      _closest_branch = closest_branch
 
-      github_link = github_link.gsub(".git", "/tree/#{ branch_name }")
-      #=> https://github.com/more-ron/git-it/tree/master
+      if _closest_branch
+        branch_name = clean_branch_name_for( _closest_branch )
+        link        = @link_generator.branch_link( branch_name )
 
-      launch github_link
-    else
-      fail "Could not find closest remote branch for sha: #{@git_object.oid.inspect}"
+        launch link
+      else
+        fail "Could not find closest remote branch for sha: #{@git_object.oid.inspect}"
+      end
     end
-  end
 
+    # [get it compared]
+    #
+    #   Compares the current branch to another branch (default: master)
+    #
+    # [sample usage]
+    #
+    #   Compare the current branch to master branch
+    #     git it compared
+    #
+    #   Compare the current branch to release branch
+    #     git it compared --to=release
+    #
+    def compare(args, options)
+      _closest_branch = closest_branch
+
+      if _closest_branch
+        branch_name = clean_branch_name_for( _closest_branch )
+        link        = @link_generator.compare_branches_link( branch_name, options[:to] || "master" )
+
+        launch link
+      else
+        fail "Could not find closest remote branch for sha: #{@git_object.oid.inspect}"
+      end
+    end
+
+    # [get it pulled]
+    #
+    #   Issues a pull request of the current branch into another branch (default: master)
+    #
+    # [sample usage]
+    #
+    #   Issue a pull request of the current branch into master branch
+    #     git it pulled
+    #
+    #   Issue a pull request of the current branch into release branch
+    #     git it pulled --to=release
+    #
+    def pull(args, options)
+      _closest_branch = closest_branch
+
+      if _closest_branch
+        branch_name = clean_branch_name_for( _closest_branch )
+        link        = @link_generator.pull_request_link( branch_name, options[:to] || "master" )
+
+        launch link
+      else
+        fail "Could not find closest remote branch for sha: #{@git_object.oid.inspect}"
+      end
+    end
 
 
-  # ============
-  # = Privates =
-  # ============
 
-  private
+    # ============
+    # = Privates =
+    # ============
 
-  def get_path(path)
-    path == "{{present_working_directory}}" ? Dir.pwd : path
-  end
+    private
 
-  def get_object(sha)
-    if sha == "{{current_head}}"
-      repository.lookup( repository.head.target )
-    else
-      repository.lookup( sha )
+    def get_path(path)
+      path == "{{present_working_directory}}" ? Dir.pwd : path
     end
-  end
 
-  def discover_repository(path)
-    Rugged::Repository.discover( path )
-  end
+    def get_object(sha)
+      if sha == "{{current_head}}"
+        repository.lookup( repository.head.target )
+      else
+        repository.lookup( sha )
+      end
+    end
 
-  def remote_branches
-    @remote_branches ||= Rugged::Branch.each_name(repository, :remote).sort.collect do |branch_name|
-      Rugged::Branch.lookup(@repository, branch_name, :remote)
+    def discover_repository(path)
+      Rugged::Repository.discover( path )
     end
-  end
 
-  def local_branches
-    @local_branches ||= Rugged::Branch.each_name(repository, :local).sort.collect do |branch_name|
-      Rugged::Branch.lookup(@repository, branch_name)
+    def remote_branches
+      @remote_branches ||= Rugged::Branch.each_name(repository, :remote).sort.collect do |branch_name|
+        Rugged::Branch.lookup(@repository, branch_name, :remote)
+      end
     end
-  end
 
-  def closest_remote_branch
-    remote_branches.min_by do |branch|
-      distance_in_objects(:from => branch.tip.oid, :to => @git_object.oid)
+    def local_branches
+      @local_branches ||= Rugged::Branch.each_name(repository, :local).sort.collect do |branch_name|
+        Rugged::Branch.lookup(@repository, branch_name)
+      end
     end
-  end
 
-  def closest_local_branch
-    local_branches.min_by do |branch|
-      distance_in_objects(:from => branch.tip.oid, :to => @git_object.oid)
+    def closest_remote_branch
+      remote_branches.min_by do |branch|
+        distance_in_objects(:from => branch.tip.oid, :to => @git_object.oid)
+      end
+    end
+
+    def closest_local_branch
+      local_branches.min_by do |branch|
+        distance_in_objects(:from => branch.tip.oid, :to => @git_object.oid)
+      end
     end
-  end
 
-  def distance_in_objects(options = {})
-    normal_direction_value   = _distance_in_objects(options)
-    opposite_direction_value = _distance_in_objects(:from => options[:to], :to => options[:from])
+    def closest_branch
+      closest_remote_branch || closest_local_branch
+    end
 
-    [normal_direction_value, opposite_direction_value].max
-  end
+    def clean_branch_name_for( branch )
+      branch_name = branch.name.gsub("origin/", "")
+      #=> origin/gh-pages => gh-pages
 
-  def _distance_in_objects(options = {})
-    walker = Rugged::Walker.new(repository)
-    walker.push(options[:to])
-    walker.hide(options[:from])
-    walker.count
-  end
+      branch_name = branch.target.gsub("refs/remotes/origin/", "") if branch_name == "HEAD"
+      #=> refs/remotes/origin/master => master
 
-  def test_mode?
-    @test_mode
-  end
+      branch_name
+    end
+
+    def distance_in_objects(options = {})
+      normal_direction_value   = _distance_in_objects(options)
+      opposite_direction_value = _distance_in_objects(:from => options[:to], :to => options[:from])
 
-  def launch(what)
-    if test_mode?
-      puts "Launchy.open( #{what.inspect} )"
-    else
-      Launchy.open( what )
+      [normal_direction_value, opposite_direction_value].max
+    end
+
+    def _distance_in_objects(options = {})
+      walker = Rugged::Walker.new(repository)
+      walker.push(options[:to])
+      walker.hide(options[:from])
+      walker.count
+    end
+
+    def test_mode?
+      @test_mode
+    end
+
+    def launch(what)
+      if test_mode?
+        puts "Launchy.open( #{what.inspect} )"
+      else
+        Launchy.open( what )
+      end
     end
-  end
 
+  end
 end

data/lib/git-it/link_generator.rb

@@ -0,0 +1,35 @@
+module GitIt
+  # Link generator compatible with GitHub like site UI
+  class LinkGenerator
+
+    # git@github.com:more-ron/git-it.git
+    attr_reader :repository_url
+
+    # all you need is the repository url
+    def initialize(repository_url)
+      @repository_url = repository_url
+
+      @repo = /^git@(?<site>.*):(?<user>.*)\/(?<proj>.*).git$/.match(@repository_url)
+
+      @site = @repo[:site]
+      @user = @repo[:user]
+      @proj = @repo[:proj]
+    end
+
+    # https://github.com/more-ron/git-it/tree/gh-pages
+    def branch_link(branch_name)
+      "https://#{@site}/#{@user}/#{@proj}/tree/#{branch_name}"
+    end
+
+    # https://github.com/more-ron/git-it/compare/master...gh-pages
+    def compare_branches_link(to, from = "master")
+      "https://#{@site}/#{@user}/#{@proj}/compare/#{from}...#{to}"
+    end
+
+    # https://github.com/more-ron/git-it/pull/new/more-ron:master...gh-pages
+    def pull_request_link(source, destination = "master")
+      "https://#{@site}/#{@user}/#{@proj}/pull/new/#{@user}:#{destination}...#{source}"
+    end
+
+  end
+end

data/lib/git-it/version.rb

@@ -2,5 +2,5 @@
 module GitIt
 
   # Current git-it version
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/lib/git-it.rb

@@ -1,6 +1,7 @@
-require 'git-it/version.rb'
-require 'git-it/global_helper.rb'
-require 'git-it/commander.rb'
+require 'git-it/version'
+require 'git-it/global_helper'
+require 'git-it/commander'
+require 'git-it/link_generator'
 
 # Add requires for other files you add to your project here, so
 # you just need to require this one file in your bin file

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-it
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -116,11 +116,12 @@ extra_rdoc_files:
 - README.rdoc
 - git-it.rdoc
 files:
-- bin/git-it
 - lib/git-it/commander.rb
 - lib/git-it/global_helper.rb
+- lib/git-it/link_generator.rb
 - lib/git-it/version.rb
 - lib/git-it.rb
+- bin/git-it
 - README.rdoc
 - git-it.rdoc
 homepage: http://more-ron.github.com/git-it/