bundler-github 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright 2011 Jason L Perry
+
+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.

data/README.md

@@ -0,0 +1,59 @@
+bundler-github
+==============
+
+Use shorthand instead of full Github repository URIs in your `Gemfile`. 
+
+Oh, yes... **syntactic sugars!**
+
+Installation
+------------
+
+``` bash
+gem install bundler-github
+```
+**Note:** Currently, this gem must always be installed *after* Bundler. If you update or re-install Bundler, you'll need to re-install this gem. See the caveat below for details.
+
+Usage
+-----
+
+In your `Gemfile` you can now replace:
+
+``` ruby
+gem 'devise', git: 'https://github.com/plataformatec/devise.git'
+```
+
+with:
+
+``` ruby
+gem 'devise', github: 'plataformatec/devise'
+```
+
+**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'
+```
+
+*How you like them apples!?*
+
+### 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.
+* 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!
+--------------
+
+> *You coveteth my ice cream bar...*
+
+I have no idea if this is going to work for you, in your environment. It's beta-quality software, and as such should not be considered production ready. 
+
+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.
+
+Copyright
+---------
+
+Copyright © 2011 Jason L Perry. See MIT-LICENSE for the rights reserved.

data/bin/bundle

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'bundler/github'
+load Gem.bin_path('bundler', 'bundle')

data/lib/bundler/github.rb

@@ -0,0 +1,17 @@
+require 'bundler'
+require 'bundler/github/dsl_patch'
+
+module Bundler
+
+  module Github
+
+    URI = 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)
+    end
+  end
+
+  Bundler::Dsl.send(:include, Bundler::Github::DslPatch)
+end

data/lib/bundler/github/dsl_patch.rb

@@ -0,0 +1,26 @@
+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
+    def _normalize_options_with_github(*args)
+      begin
+        _normalize_options_without_github(*args)
+      rescue Bundler::InvalidOption => exception
+        if exception.message =~ /:github/
+          Bundler::Github.expand_options(*args)
+          retry
+        else
+          raise exception
+        end
+      end
+    end
+
+    def self.included(mod)
+      mod.send :alias_method, :_normalize_options_without_github, :_normalize_options
+      mod.send :alias_method, :_normalize_options, :_normalize_options_with_github
+    end
+  end
+end

data/test/bundler_github_test.rb

@@ -0,0 +1,36 @@
+require 'minitest/unit'
+require 'minitest/autorun'
+require 'bundler/github'
+
+class BundlerGithubTest < MiniTest::Unit::TestCase
+
+  # Let's get meta.
+  def setup
+    @gem = @repo = 'bundler-github'
+    @uri = lambda { "git://github.com/ambethia/#{@repo}.git" }
+  end
+
+  def test_expands_uri
+    assert_equal @uri.call, expand('ambethia/bundler-github')
+  end
+
+  def test_expands_uri_with_distinct_gem_name
+    @gem = 'bundler_github'
+    assert_equal @uri.call, expand('ambethia/bundler-github')
+  end
+
+  def test_expands_uri_with_distinct_repo_name
+    @repo = 'bundler_github'
+    assert_equal @uri.call, expand('ambethia/bundler_github')
+  end
+
+  def test_expands_uri_with_implicit_gem_name
+    assert_equal @uri.call, expand('ambethia')
+  end
+
+  def expand(repository)
+    { 'github' => repository }.tap { |opts|
+      Bundler::Github.expand_options(@gem, nil, opts)
+    }['git']
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: bundler-github
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason L Perry
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-02 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: "    A hack for using shorthand like `:github => 'ambethia/recaptcha'` instead\n    of a full git repository URI in your Gemfiles\n"
+email: 
+- jasper@ambethia.com
+executables: 
+- bundle
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/bundle
+- lib/bundler/github.rb
+- lib/bundler/github/dsl_patch.rb
+- MIT-LICENSE
+- README.md
+- test/bundler_github_test.rb
+homepage: https://github.com/ambethia/bundler-github
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 616532358228670493
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 616532358228670493
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: bundler-github
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Gemfile shorthand for Github repos
+test_files: 
+- test/bundler_github_test.rb