git-helpers 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82e6414a87935574c740f9d98767652b1c025da8
-  data.tar.gz: 5f015b8462fbba630f4d3707d867f0f2a351d829
+  metadata.gz: 4981c208c8a78f9d127ae0eadb4d094aa5d22527
+  data.tar.gz: d68a8861b6012bb68104ed6f51b68ff32c0ac876
 SHA512:
-  metadata.gz: 92f619ab95515a29e3d0e4b75b824784ebb85dcff7dc6c5e0d9e159383ccb0d51249dc8865b7372152c4c09566106762c2cd45e01357ad14c6abefdd76081200
-  data.tar.gz: 1bfcc829bb713f1da03ad088dc367a681fcf1ec0b192cedbb426b0576a534cf343a7fc9673859a67ba3d46285d9070bae2b1b49c68c4d9648376d726628906bc
+  metadata.gz: 003a486979b01520f36627e2441d4f0c5e2a75ddd016776265bdc3c2e85ac4f886817130f5fe83b9edbd477dc0fc22abb8fc07b17d595c5854c50d76452edcbd
+  data.tar.gz: 3f9100bb1444f1cfbdb0477edc42b3a7833ec88cf5401cc42f8ecba58a7ff57cc53d25efa449bb35e4ebc87d8f6c5898baf150cbdf81df8dc0663679700ec620

data/README.md

@@ -22,6 +22,14 @@ Running `git update` will pull down the latest changes for your current branch
 from the upstream remote (or origin if you don't have an upstream), and pushes
 the changes to your origin (or not at all if it was pulled from origin).
 
+### Browse
+Running `git browse` will open the current repo in your web browser to the repository
+page at the current working branch. You can specify the remote if you wish to
+browse a different one in the format `git browse [remote]`. If you wish to view a
+specific branch/tag/commit then you can specify the tree after `remote` in the
+format `git browse [remote] [tree]`.
+*Note: To use a commit as a tree you must use the full commit hash* 
+
 ## Development
 
 After checking out the repo, run `bundle` to install dependencies. Then, run `bundle exec rake spec` to run the tests.

data/exe/git-browse

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require 'git/helpers'
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.banner = "Git-Helpers git browse\n"\
+                "Opens the default browser to the optionally specified remote (default 'origin'), at the optional branch/tree/commit\n"\
+                'Usage: git browse [remote] [branch/tree/commit]'
+  opts.on_tail '-h', '--help', 'Shows this help message' do
+    puts opts
+    exit 0
+  end
+  opts.on_tail '-v', '--version', 'Shows the version of git-helpers' do
+    puts "Git-Helpers version #{Git::Helpers::VERSION}"
+    exit 0
+  end
+end.parse!
+
+remote = ARGV.shift unless ARGV.empty?
+tree = ARGV.shift unless ARGV.empty?
+
+if remote.nil?
+  Git::Helpers.browse
+elsif tree.nil?
+  Git::Helpers.browse Dir.pwd, remote
+else
+  Git::Helpers.browse Dir.pwd, remote, tree
+end

data/lib/git/helpers/browse.rb

@@ -0,0 +1,24 @@
+require 'git/helpers/utils'
+module Git
+  # Provides a set of helper functions to make Git life easier
+  module Helpers
+    require 'git'
+    require 'launchy'
+
+    # Opens the default web browser to the specified repositorys page based on
+    #   the the specified remote, and tree
+    # @param repo_dir [String] Directory of the git repo to browse, defaults to current working dir
+    # @param remote_name [String] Name of the remote to browse, defaults to origin
+    # @param tree [String] Tree to browse, can be a branch name, tag, or commit hash
+    def self.browse(repo_dir = Dir.pwd, remote_name = 'origin', tree = nil)
+      repo = Git.open(repo_dir)
+      raise "#{remote_name} is not a known remote" unless Utils.remote? repo, remote_name
+      remote = Utils.remotes_hash(repo)[remote_name]
+      tree ||= repo.current_branch
+      url = remote.url.chomp('.git')
+      url = Utils.transform_url(url)
+      url << "/tree/#{tree}"
+      Launchy.open url
+    end
+  end
+end

data/lib/git/helpers/utils.rb

@@ -10,6 +10,29 @@ module Git
       def self.remote?(repo, remote)
         repo.remotes.map(&:name).include?(remote)
       end
+
+      # Get a hash of remotes keyed to their name
+      # @param repo [Git::Base] Repository to get the remotes for
+      # @return [Hash{String => Git::Remote}] A hash of remotes
+      def self.remotes_hash(repo)
+        Hash[repo.remotes.map { |r| [r.name, r] }]
+      end
+
+      # Takes a url from a git remote and transforms it into an normal url with
+      #   the desired scheme
+      # @param url [String] Url to transform
+      # @param scheme [String] What scheme the transformed Url will use, https (default), or http
+      # @return [String] A transformed Url
+      def self.transform_url(url, scheme = 'https')
+        # if git ssh url
+        if /^git@/ === url
+          url.gsub(/^git@(.*):/, scheme + '://\1/')
+        elsif %r{^git://} === url
+          url.gsub(/^git/, scheme)
+        else
+          url
+        end
+      end
     end
   end
 end

data/lib/git/helpers/version.rb

@@ -1,5 +1,5 @@
 module Git
   module Helpers
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/git/helpers.rb

@@ -1,2 +1,3 @@
 require 'git/helpers/version'
 require 'git/helpers/update'
+require 'git/helpers/browse'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-helpers
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Kierran McPherson
@@ -156,6 +156,7 @@ description: |2
 email:
 - kierranm@gmail.com
 executables:
+- git-browse
 - git-update
 extensions: []
 extra_rdoc_files: []
@@ -168,9 +169,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/git-browse
 - exe/git-update
 - git-helpers.gemspec
 - lib/git/helpers.rb
+- lib/git/helpers/browse.rb
 - lib/git/helpers/update.rb
 - lib/git/helpers/utils.rb
 - lib/git/helpers/version.rb