gem-src 0.2.0 → 0.2.1

data/README.md

@@ -2,10 +2,59 @@
 
 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!
 
+
 ## Installation
 
     $ gem install gem-src
 
+
+## Usage (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).
+
+For example, when you execute
+
+    % gem i kaminari
+and if the gem is installed into `~/.gem/ruby/1.8/kaminari-0.14.1` directory, you'll see Kaminari's full Git repo at `~/.gem/ruby/1.8/kaminari-0.14.1/src` directory.
+
+So, the whole directory structure will be like this.
+
+    ~/.gem/ruby/1.8
+    ├── gems
+    │   ├── arel-3.0.2
+    │   │   ├── src
+    │   ├── gem-src-0.2.0
+    │   │   ├── src
+    │   ├── kaminari-0.14.0
+    │   │   ├── src
+    │   ├── 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.
+
+### GEMSRC_CLONE_ROOT env var
+
+Instead of cloning the repo under installed gem directory for each `gem install`, you can specify one single directory via `GEMSRC_CLONE_ROOT` environment variable to keep all the cloned 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.
+
+For example,
+
+    % GEMSRC_CLONE_ROOT=~/src gem i active_decorator
+will clone the Git repo into `~/src/active_decorator` directory if not exists.
+
+Now, the whole directory structure will be like this.
+
+    ~
+    ├── src
+    │   ├── active_decorator
+    │   ├── capybara
+    │   ├── i18n_generators
+    ...
+
+
 ## Contributing
 
 1. Fork it

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.2.0'
+  gem.version       = '0.2.1'
   gem.authors       = ["Akira Matsuda"]
   gem.email         = ["ronnie@dio.jp"]
   gem.description   = 'Gem.post_install { `git clone gem_source src` }'

data/lib/rubygems_plugin.rb

@@ -1,7 +1,12 @@
 require 'rubygems'
 
 Gem.post_install do |installer|
-  clone_dir = ENV['GEMSRC_CLONE_ROOT'] ? File.join(ENV['GEMSRC_CLONE_ROOT'], installer.spec.name) : File.join(installer.gem_dir, 'src')
+  clone_dir = if ENV['GEMSRC_CLONE_ROOT']
+    File.join ENV['GEMSRC_CLONE_ROOT'], installer.spec.name
+  else
+    gem_dir = installer.respond_to?(:gem_dir) ? installer.gem_dir : File.join(installer.gem_home, 'gems', installer.spec.full_name)
+    File.join gem_dir, 'src'
+  end
 
   if (repo = installer.spec.homepage) && !repo.empty? && !File.exists?(clone_dir)
     if repo =~ /\Ahttps?:\/\/([^.]+)\.github.com\/(.+)/

metadata

@@ -1,23 +1,33 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: gem-src
-version: !ruby/object:Gem::Version
-  version: 0.2.0
+version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
 platform: ruby
-authors:
+authors: 
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-15 00:00:00.000000000 Z
+
+date: 2012-10-16 00:00:00 Z
 dependencies: []
+
 description: Gem.post_install { `git clone gem_source src` }
-email:
+email: 
 - ronnie@dio.jp
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -27,26 +37,36 @@ files:
 - lib/rubygems_plugin.rb
 homepage: https://github.com/amatsuda/gem-src
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Gem.post_install { `git clone gem_source src` }
 test_files: []
+