bundler-github 0.1.0 → 0.2.0

data/README.md

@@ -19,28 +19,53 @@ Usage
 In your `Gemfile` you can now replace:
 
 ``` ruby
-gem 'devise', git: 'https://github.com/plataformatec/devise.git'
+gem 'recaptcha', git: 'https://github.com/ambethia/recaptcha.git'
 ```
 
 with:
 
 ``` ruby
-gem 'devise', github: 'plataformatec/devise'
+gem 'recaptcha', github: 'ambethia/recaptcha'
 ```
 
 **But wait!** That sugar only gets sweeter! If the repository's name is the same as the gem's name (and it usally is), you can leave out the repo name and just include the repository owner.
 
 ``` ruby
-gem 'devise', github: 'plataformatec'
+gem 'recaptcha', github: 'ambethia'
 ```
 
 *How you like them apples!?*
 
+One inconvenience I haven't figured a work around for is that you'll need to explicitly `bundler/github` before you require `bundler/setup`. In a Rails app
+you might change your `boot.rb` (*oh, the humanity!*) from:
+
+``` ruby
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+```
+
+to look like:
+
+``` ruby
+if File.exists?(ENV['BUNDLE_GEMFILE'])
+  require 'bundler/github'
+  require 'bundler/setup'
+end
+```
+
+However, you don't *need* to require `bundler-github` from your `Gemfile`, it's already loaded by the time your application's `Gemfile` is read anyways.
+
+### Private Repositories ###
+
+By default HTTP transport is used, but you can switch to an authenticated url scheme (ssh) by prepending a `:` to the account name, like:
+
+``` ruby
+gem 'has_secrets', github: ':ambethia'
+```
+
 ### Other notes on usage ###
 
-* `bundler-github` just expands and swaps the `:github` option out for `:git`, other options, like `:branch`, `:ref`, etc. should be left untouched.
+* `bundler-github` just expands and swaps the `:github` option out for `:git`, other options, like `:branch`, `:ref`, etc. will be left untouched.
 * I may favor the Ruby 1.9 syntaxes in my examples, but the gem does not. It was developed for and tested against 1.8.7 and 1.9.x.
-* You should not include `bundler-github` in your `Gemfile`. Bundler is already loaded by the time your application's `Gemfile` is read.
 
 Caveat emptor!
 --------------
@@ -51,7 +76,7 @@ I have no idea if this is going to work for you, in your environment. It's beta-
 
 The only way I could find to hook in and add the `:github` option was to make my own `bundle` command which replaces the executable generated by Rubygems in your `$PATH`. The new command includes our patch then loads Bunder's original `bundle` command. For a hack, I think it's pretty elegant.
 
-If you can suggest a better way to hook another gem without needing to modify the original gem or require it somewhere explicitly, I'd love to hear it. The unique way bundler is used makes it challenging to extend without any kind of plugin API.
+The unique way bundler is used makes it challenging to extend without any kind of plugin API. If you can suggest a better way to hook it without needing to modify the original gem, I'd love to hear it. 
 
 Copyright
 ---------

data/lib/bundler/github.rb

@@ -5,11 +5,13 @@ module Bundler
 
   module Github
 
-    URI = lambda { |user, repo| "git://github.com/#{user}/#{repo}.git" }
+    HTTP = lambda { |user, repo| "https://github.com/#{user}/#{repo}.git" }
+    SSH  = lambda { |user, repo| "git@github.com:#{user}/#{repo}.git" }
 
     def self.expand_options(name, version, opts)
       user, repo  = opts.delete('github').split('/')
-      opts['git'] = URI.call(user, repo || name)
+      transport   = user =~ /^:/ ? (user.slice!(0); SSH) : HTTP
+      opts['git'] = transport.call(user, repo || name)
     end
   end
 

data/lib/bundler/github/dsl_patch.rb

@@ -1,10 +1,9 @@
 module Bundler::Github
   module DslPatch
 
-    # The list of valid options is buried in unfortunately buried in this
-    # original method, so to add an option without reimplementing (and
-    # duplicating) code, we rescue the exception, and swap our :github option
-    # for :git, with the expanded URI
+    # The list of valid options is buried in this original method, so to add
+    # an option without reimplementing (and duplicating) code, we rescue the
+    # exception, and swap our :github option for :git, with the expanded URI
     def _normalize_options_with_github(*args)
       begin
         _normalize_options_without_github(*args)

data/test/bundler_github_test.rb

@@ -7,7 +7,7 @@ class BundlerGithubTest < MiniTest::Unit::TestCase
   # Let's get meta.
   def setup
     @gem = @repo = 'bundler-github'
-    @uri = lambda { "git://github.com/ambethia/#{@repo}.git" }
+    @uri = lambda { "https://github.com/ambethia/#{@repo}.git" }
   end
 
   def test_expands_uri
@@ -28,6 +28,11 @@ class BundlerGithubTest < MiniTest::Unit::TestCase
     assert_equal @uri.call, expand('ambethia')
   end
 
+  def test_expands_authenticated_uri_with_shh
+    @uri = 'git@github.com:ambethia/bundler-github.git'
+    assert_equal @uri, expand(':ambethia')
+  end
+
   def expand(repository)
     { 'github' => repository }.tap { |opts|
       Bundler::Github.expand_options(@gem, nil, opts)

metadata

@@ -2,7 +2,7 @@
 name: bundler-github
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jason L Perry
@@ -63,7 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 616532358228670493
+      hash: -3869597957558738981
       segments: 
       - 0
       version: "0"
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 616532358228670493
+      hash: -3869597957558738981
       segments: 
       - 0
       version: "0"