gem-src 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7bdbdaa6e01ab1155713781bc4b8790b21873ee
-  data.tar.gz: b2b2f64ebb5815991146b3658cdc68acc9ea4c86
+  metadata.gz: 829ded2173fdb56252ef40be2bbea300a0eb14da
+  data.tar.gz: 42f85aed1c4311f9a8d3f9d70e17e5f32bbab116
 SHA512:
-  metadata.gz: 320ce85e5a4fcf917c093587027c9b25e3c57354bfe882f58db194d8c0e2de2188883a36e0354651e067926f3147adf362d565d66321e9ea9e4f369540ba82e3
-  data.tar.gz: 3754ba1cbc6e7065cbf716e72f177741a92748020d1219bf32a24e30c48eb75daaefa992eb8a3b3d21327876ff53ef7081e5ec02c3619751a372f9c6065ffbdd
+  metadata.gz: a2e655aa543cc0d462c3f007a9a47b7a4ea492f1788a95416beeaaa3efba99ace4e9681c053ac7d527170ed8fead517704b90d6d955466cdb73acedcba11d7c4
+  data.tar.gz: a9f999c47b8e8148b7bcf491a0f442e10364f491eefdc74e17f8dd60bd1f54e278d1b97773f1a71aa35388fd9b498cb28a9c5aed3e5d65a4bbd21b4bd3f2b1a3

data/README.md

@@ -1,18 +1,29 @@
 # gem-src
 
-A gem plugin that automatically `git clone`s the gem's source right after every `gem install` so you can `git log`, `git grep` and of course write your patch there!
+gem-src is a gem plugin && rbenv plugin that automatically `git clone`s the gem's source right after every `gem install` so you can `git log`, `git grep` and of course write your patch there!
 
 
 ## Installation
 
+### As a Rubygem
+
+gem-src is a gem plugin that can be installed via gem install command:
+
     $ gem install gem-src
 
+### As an rbenv plugin (recommended)
+
+Alternatively, if you're using rbenv, you can install gem-src as an rbenv plugin:
+
+    $ git clone https://github.com/amatsuda/gem-src.git ~/.rbenv/plugins/gem-src
+
+then you get gem-src enabled for all `gem` and `bundle` commands invoked through rbenv.
 
 ## Configuration
 
 ### By default
 
-With this gem installed, every `gem install` you perform will be followed by automatic `git clone` into the installed gem's "src" directory (if the gemspec's "homepage" property points to a Git repo).
+With this gem plugin installed, every `gem install` you perform will be followed by automatic `git clone` of the online repo into the installed gem's "src" directory (if the gemspec's "homepage" property points to a Git repo).
 
 For example, when you execute
 
@@ -32,14 +43,15 @@ So, the whole directory structure will be like this.
     │   ├── kaminari-0.14.1
     │   │   ├── src
     ...
-Note that if you're using RVM, each of `~/.rvm/gems/*/gems/*` will have it's Git repo inside "src" directory.
+Note that you might be cloning the same repository again and again as the gem is updated, or the gem install directory changes.
+For example, if you're using RVM, each of `~/.rvm/gems/*/gems/*` will have it's Git repo inside "src" directory.
 
-### specifying gemsrc_clone_root
+### specifying gemsrc_clone_root (strongly recommended)
 
 Instead of cloning the repo under installed gem directory for each `gem install`, you can specify one single directory to keep all the cloned source repositories.
 
 This way, `git clone` will no more be executed per every `gem update`.
-This option would be more efficient particularly if you're frequently switching RVM gemsets, or using bundler with `--path` per each projects.
+This option would be more efficient particularly if you're frequently switching Ruby versions or gemsets, or using bundler with `--path` per each projects.
 There are two ways to specify this variable:
 
     1) `GEMSRC_CLONE_ROOT` environment variable
@@ -61,7 +73,7 @@ Now, the whole directory structure will look like this.
     ...
 
 
-## Usage
+## Pristine
 
 When you firstly installed this gem, you might want to type in this command right after the installation.
 
@@ -69,13 +81,6 @@ When you firstly installed this gem, you might want to type in this command righ
 This will reinstall all the already installed gems, and so will `git clone` all the repos.
 
 
-## Todo
-
-* Bundler
-
-* specs
-
-
 ## Contributing
 
 1. Fork it

data/etc/rbenv.d/exec/~gem-src.bash

@@ -0,0 +1,34 @@
+# This code is borrowed from https://github.com/sstephenson/rbenv-gem-rehash.
+#
+# Copyright (c) 2013 Sam Stephenson <<sstephenson@gmail.com>>
+#
+# Copyright (c) 2013 Joshua Peek <<josh@joshpeek.com>>
+#
+# 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.
+
+# Remember the current directory, then change to the plugin's root.
+cwd="$PWD"
+cd "${BASH_SOURCE%/*}/../../../lib"
+
+# Make sure `rubygems_plugin.rb` is discovered by RubyGems by adding
+# its directory to Ruby's load path.
+export RUBYLIB="$PWD:$RUBYLIB"
+
+cd "$cwd"

data/gem-src.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "gem-src"
-  gem.version       = '0.4.2'
+  gem.version       = '0.5.0'
   gem.authors       = ["Akira Matsuda"]
   gem.email         = ["ronnie@dio.jp"]
   gem.description   = 'Gem.post_install { `git clone gem_source src` }'
@@ -17,4 +17,13 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency 'rspec', ['>= 0']
+
+  gem.post_install_message = <<-END
+[gem-src] If you have not yet configured "gemsrc_clone_root", we strongly recommend you to add the configuration to your .gemrc.
+
+e.g.)
+% echo "gemsrc_clone_root: ~/src" >> ~/.gemrc
+
+See README for more details.
+END
 end

data/lib/rubygems_plugin.rb

@@ -9,7 +9,7 @@ module Gem
     attr_reader :installer
 
     def initialize(installer)
-      @installer = installer
+      @installer, @tested_repositories = installer, []
     end
 
     def clone_dir
@@ -56,22 +56,32 @@ module Gem
       api[/^homepage_uri: (.*)$/, 1]
     end
 
+    def github_organization_uri(name)
+      "https://github.com/#{name}/#{name}"
+    end
+
     def git_clone(repository)
-      system 'git', 'clone', repository, clone_dir if repository && !repository.empty? && git?(repository)
+      return if repository.nil? || repository.empty?
+      return if @tested_repositories.include? repository
+      @tested_repositories << repository
+      system 'git', 'clone', repository, clone_dir if git?(repository)
     end
 
-    def git_clone_homepage_or_source_code_uri_or_homepage_uri
+    def git_clone_homepage_or_source_code_uri_or_homepage_uri_or_github_organization_uri
       return false if File.exist? clone_dir
       git_clone(installer.spec.homepage) ||
         git_clone(github_url(installer.spec.homepage)) ||
         git_clone(source_code_uri) ||
         git_clone(homepage_uri) ||
-        git_clone(github_url(homepage_uri))
+        git_clone(github_url(homepage_uri)) ||
+        git_clone(github_organization_uri(installer.spec.name))
     end
   end
 end
 
 
 Gem.post_install do |installer|
-  Gem::Src.new(installer).git_clone_homepage_or_source_code_uri_or_homepage_uri
+  next true if installer.class.name == 'Bundler::Source::Path::Installer'
+  Gem::Src.new(installer).git_clone_homepage_or_source_code_uri_or_homepage_uri_or_github_organization_uri
+  true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem-src
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-15 00:00:00.000000000 Z
+date: 2014-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -36,12 +36,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- etc/rbenv.d/exec/~gem-src.bash
 - gem-src.gemspec
 - lib/rubygems_plugin.rb
 homepage: https://github.com/amatsuda/gem-src
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message: |
+  [gem-src] If you have not yet configured "gemsrc_clone_root", we strongly recommend you to add the configuration to your .gemrc.
+
+  e.g.)
+  % echo "gemsrc_clone_root: ~/src" >> ~/.gemrc
+
+  See README for more details.
 rdoc_options: []
 require_paths:
 - lib
@@ -57,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gem.post_install { `git clone gem_source src` }