git-it 0.0.6 → 0.0.7

data/README.rdoc

@@ -1,22 +1,71 @@
 = git-it! get it?
 
+{<img src="https://travis-ci.org/more-ron/git-it.png" />}[https://travis-ci.org/more-ron/git-it]
+
+== Describe
+
 Commands to help you git it.
 
-Author::    Ronald Maravilla  (mailto:more.ron.too@gmail.com)
-License::   Undecided
+
 
 == Install
 
-    gem install git-it
+Might not need sudo depending on your setup. To install as /usr/bin/git-it though you'll need sudo.
+
+    sudo gem install git-it #=> install git-it gem
+
+
 
 == Use
 
 Open current branch in the web. Use it as an easy way to issue pull request in github.
 
-    git it opened_in_the_web
+    git it opened_in_the_web #=> open https://github.com/more-ron/git-it/tree/master
+
+
+
+== Integrate with {SourceTree}[http://www.sourcetreeapp.com/]
+
+Read instruction on how to add custom action {here}[http://blog.sourcetreeapp.com/2012/02/08/custom-actions-more-power-to-you/].
+
+You will need to know where git-it got installed. To do that execute the following:
+
+  which git-it #=> /usr/bin/git-it
+
+[Script to run]
+
+  Based on the result from above set the script to:
+
+    /usr/bin/git-it
 
-== Documentation
+[Parameters]
+
+  get it opened in the web:
+
+    --path=$REPO --sha=$SHA opened_in_the_web
+
+
+
+== Document
 
 API Documentation is available {here}[http://more-ron.github.com/git-it/index.html].  Recommend starting with GitIt::Commander.
 
+
+
+Author::    {Ronald Maravilla}[http://about.me/ronald.maravilla]
+Copyright:: Copyright © 2013 by Ronald Maravilla
+License::
+
+  {MIT}[http://opensource.org/licenses/MIT]
+
+  Copyright (c) 2013 Ronald Maravilla
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+
 :include:git-it.rdoc

data/bin/git-it

@@ -2,23 +2,21 @@
 
 require 'gli'
 require 'git-it'
+require 'rugged'
+require 'launchy'
 
-include GLI::App
 extend GitIt::GlobalHelper
+include GLI::App
 
 program_desc 'Git it! Get it?'
 
 version GitIt::VERSION
 
-
 # ==================
 # = Global Options =
 # ==================
 
-# desc 'debug mode'
-# switch [:d,:debug]
-
-desc 'repository path'
+desc 'Repository path'
 default_value '{{present_working_directory}}'
 arg_name 'path'
 flag [:p,:path]
@@ -28,6 +26,9 @@ default_value '{{current_head}}'
 arg_name 'sha'
 flag [:s,:sha]
 
+desc 'Test mode'
+switch [:t,:test]
+default_value false
 
 # ============
 # = Commands =
@@ -46,7 +47,8 @@ command :opened_in_the_web do |c|
   end
 end
 
-
+class Object # :nodoc:
+end
 
 # ====================
 # = Before and After =

data/lib/git-it/commander.rb

@@ -1,48 +1,79 @@
-require 'rugged'
-# require 'debugger'
-
 # 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
+  # [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
 
 
+
   # ===========
   # = Actions =
   # ===========
 
-  # Command:: git it opened_in_the_web
+  # [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)
-    remote_origin_url = repository.config["remote.origin.url"]
-    # => git@github.com:more-ron/git-it.git
+    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
 
-    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
 
-    branch_name = closest_remote_branch.name.gsub("origin/", "")
-    # origin/gh-pages => gh-pages
-    branch_name = closest_remote_branch.target.gsub("refs/remotes/origin/", "") if branch_name == "HEAD"
-    # refs/remotes/origin/master => master
+      branch_name = closest_remote_branch.target.gsub("refs/remotes/origin/", "") if branch_name == "HEAD"
+      #=> refs/remotes/origin/master => master
 
-    github_link = github_link.gsub(".git", "/tree/#{ branch_name }")
-    # => https://github.com/more-ron/git-it/tree/master
+      github_link = github_link.gsub(".git", "/tree/#{ branch_name }")
+      #=> https://github.com/more-ron/git-it/tree/master
 
-    `open #{ github_link }` # should use launchy in the future
+      launch github_link
+    else
+      fail "Could not find closest remote branch for sha: #{@git_object.oid.inspect}"
+    end
   end
 
 
+
   # ============
   # = Privates =
   # ============
@@ -79,22 +110,40 @@ class GitIt::Commander
 
   def closest_remote_branch
     remote_branches.min_by do |branch|
-      distance_in_object(:from => branch.tip.oid, :to => @git_object.oid)
+      distance_in_objects(:from => branch.tip.oid, :to => @git_object.oid)
     end
   end
 
-  def distance_in_object(options = {})
-    normal_direction_value   = _distance_in_object(options)
-    opposite_direction_value = _distance_in_object(:from => options[:to], :to => options[:from])
+  def closest_local_branch
+    local_branches.min_by do |branch|
+      distance_in_objects(:from => branch.tip.oid, :to => @git_object.oid)
+    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])
 
     [normal_direction_value, opposite_direction_value].max
   end
 
-  def _distance_in_object(options = {})
+  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

data/lib/git-it/global_helper.rb

@@ -1,6 +1,8 @@
+# Global helper to make it easier to git
 module GitIt::GlobalHelper
 
-  # Prints "I don't git-it. That command made no sense."
+  # [I don't get it]
+  #   Raises "I don't git-it. That command made no sense."
   def i_dont_git_it
     raise "I don't git-it. That command made no sense."
   end

data/lib/git-it/version.rb

@@ -1,3 +1,6 @@
+# Command line interface to git it
 module GitIt
-  VERSION = '0.0.6'
+
+  # Current git-it version
+  VERSION = '0.0.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-it
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -60,45 +60,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: gli
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 2.5.4
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.5.4
 - !ruby/object:Gem::Dependency
-  name: gli
+  name: rugged
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.4
+        version: 0.17.0.b7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.4
+        version: 0.17.0.b7
 - !ruby/object:Gem::Dependency
-  name: rugged
+  name: launchy
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.17.0.b7
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.17.0.b7
+        version: 2.2.0
 description: 
 email: more.ron.too@gmail.com
 executables: