gem-src 0.6.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 49616d662bfc4d63838e221b220a0159b0d28c59
-  data.tar.gz: 39f4410194d7b0bc0e3e42e6ae41351a63afc6a8
+SHA256:
+  metadata.gz: 70651b92bbaa9d17a2f084c7e2ff97adf2b40a2ebe4ec00deae616afec1fe995
+  data.tar.gz: 5ac36fd408e1b1f96945986c6f4bef28d737b2ef8e0d8b9e66a913c16a76dede
 SHA512:
-  metadata.gz: a0a8e311d525ebf2ef63b19595f05a03b5f668a2ea5734b870c509aaf83f7f57b691582139445ee5fbc4ce15fcf521e6ab1a36d043c3d267410307dfe0469c50
-  data.tar.gz: 6866e89026ee3890f115d2b6e9831aba2fc306051e32c2b49dd034ad9a3dbd93a690a17d6658142fec4ac565d9aca2c646257361ea3faf9615fc86cdefce0eab
+  metadata.gz: 1ac67aa2d4b6f7ac57ffebb80e1ebed510477117dc9e3ce3573d51d9b9b146ab2152dbdf6ad3928220e7ac6d6353808687d1548f6e310a0730def45826ba24e1
+  data.tar.gz: 9e2818b0389ab44f3cf537ecfcf85c00adb77d9d59edad7010ca7471aabf411403aeedb97fc4426651e372bcb788b741239f7fb9122603953544397c500ee531

data/README.md

@@ -1,24 +1,39 @@
 # gem-src
 
 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!
+Plus, gem-src runs `git init` on each installed gem, and links it to the cloned source repository and the origin repository so that you can easily transfer commits to and from the gem and the repositories.
 
+***TL;DR***
 
-## Installation
+    % git clone https://github.com/amatsuda/gem-src.git "$(rbenv root)/plugins/gem-src"
+    % mkdir ~/src
+    % echo "gemsrc_clone_root: ~/src" >> ~/.gemrc
 
-### As a Rubygem
+Then you're all set!
 
-gem-src is a gem plugin that can be installed via gem install command:
 
-    % gem install gem-src
+## Installation
 
-### As an rbenv plugin (recommended)
+### :star2: 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
+    % git clone https://github.com/amatsuda/gem-src.git "$(rbenv root)/plugins/gem-src"
 
 then you get gem-src enabled for all `gem` and `bundle` commands invoked through rbenv.
 
+### :star2: As a Bundler plugin (experimental, but also recommended)
+
+gem-src is a bundler plugin that can be installed via bundler plugin install command:
+
+    % bundler plugin install gem-src
+
+### As a Rubygem
+
+gem-src is a gem plugin that can be installed via gem install command:
+
+    % gem install gem-src
+
 ## Configuration
 
 ### By default
@@ -46,7 +61,7 @@ So, the whole directory structure will be like this.
 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 (strongly recommended)
+### :star2: 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.
 
@@ -98,6 +113,12 @@ When you firstly installed this gem, you might want to type in this command righ
     % gem pristine --all
 This will reinstall all the already installed gems, and so will `git clone` all the repos.
 
+## Skip cloning
+
+If you want to skip cloning repositories, you can skip cloning by providing an environment variable `GEMSRC_SKIP`:
+
+    % GEMSRC_SKIP=true bundle install
+
 
 ## Contributing
 

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.6.1'
+  gem.version       = '0.10.0'
   gem.authors       = ["Akira Matsuda"]
   gem.email         = ["ronnie@dio.jp"]
   gem.description   = 'Gem.post_install { `git clone gem_source src` }'
@@ -19,8 +19,9 @@ Gem::Specification.new do |gem|
   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.
+[gem-src] Installing gem-src as a gem is not recommended. Please consider installing as an rbenv plugin instead.
 
+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
 

data/lib/gem/src/irregular_repositories.rb

@@ -0,0 +1,81 @@
+module Gem
+  class Src
+    IRREGULAR_REPOSITORIES = {
+      'activesupport' => nil,
+      'actionview' => nil,
+      'actionpack' => nil,
+      'activemodel' => nil,
+      'activerecord' => nil,
+      'activerecord-jdbcmysql-adapter' => 'https://github.com/jruby/activerecord-jdbc-adapter',
+      'activerecord-jdbcpostgresql-adapter' => 'https://github.com/jruby/activerecord-jdbc-adapter',
+      'activerecord-jdbcsqlite3-adapter' => 'https://github.com/jruby/activerecord-jdbc-adapter',
+      'activejob' => nil,
+      'actionmailbox' => nil,
+      'actionmailer' => nil,
+      'actioncable' => nil,
+      'actiontext' => nil,
+      'activestorage' => nil,
+      'railties' => nil,
+      'activeresource' => 'https://github.com/rails/activeresource.git',
+      'autoparse' => 'https://github.com/google/autoparse.git',
+      'aws-sdk-rails' => 'https://github.com/aws/aws-sdk-rails.git',
+      'breadcrumbs_on_rails' => 'https://github.com/weppos/breadcrumbs_on_rails',
+      'bson' => 'https://github.com/mongodb/bson-ruby.git',
+      'coffee-script-source' => 'https://github.com/rails/ruby-coffee-script',
+      'compass-core' => 'https://github.com/Compass/compass.git',
+      'compass-import-once' => 'https://github.com/Compass/compass.git',
+      'concurrent-ruby' => 'https://github.com/ruby-concurrency/concurrent-ruby/',
+      'concurrent-ruby-edge' => 'https://github.com/ruby-concurrency/concurrent-ruby/',
+      'concurrent-ruby-ext' => 'https://github.com/ruby-concurrency/concurrent-ruby/',
+      'cool.io' => 'https://github.com/tarcieri/cool.io.git',
+      'cucumber-core' => 'https://github.com/cucumber/cucumber-ruby-core.git',
+      'cucumber-wire' => 'https://github.com/cucumber/cucumber-ruby-wire.git',
+      'diff-lcs' => 'https://github.com/halostatue/diff-lcs.git',
+      'elasticsearch' => 'https://github.com/elastic/elasticsearch-ruby.git',
+      'elasticsearch-api' => 'https://github.com/elastic/elasticsearch-ruby.git',
+      'elasticsearch-extensions' => 'https://github.com/elastic/elasticsearch-ruby.git',
+      'elasticsearch-transport' => 'https://github.com/elastic/elasticsearch-ruby.git',
+      'erubis' => 'https://github.com/kwatch/erubis.git',
+      'flay' => 'https://github.com/seattlerb/flay',
+      'geocoder' => 'https://github.com/alexreisner/geocoder',
+      'hirb' => 'https://github.com/cldwalker/hirb',
+      'houston' => 'https://github.com/nomad/houston',
+      'html2haml' => 'https://github.com/haml/html2haml',
+      'io-console' => 'https://github.com/ruby/io-console',
+      'kaminari-actionview' => nil,
+      'kaminari-activerecord' => nil,
+      'kaminari-core' => nil,
+      'kwalify' => nil,
+      'log4r' => 'https://github.com/colbygk/log4r',
+      'meta_request' => 'https://github.com/dejan/rails_panel',
+      'method_source' => 'https://github.com/banister/method_source',
+      'origin' => 'https://github.com/mongoid/origin',
+      'padrino' => 'https://github.com/padrino/padrino-framework',
+      'padrino-admin' => nil,
+      'padrino-cache' => nil,
+      'padrino-core' => nil,
+      'padrino-gen' => nil,
+      'padrino-helpers' => nil,
+      'padrino-mailer' => nil,
+      'padrino-performance' => nil,
+      'padrino-support' => nil,
+      'paranoia' => 'https://github.com/rubysherpas/paranoia',
+      'pdf-core' => 'https://github.com/prawnpdf/pdf-core',
+      'pg' => nil,
+      'rack-mini-profiler' => 'https://github.com/MiniProfiler/rack-mini-profiler',
+      'raindrops' => 'https://github.com/tmm1/raindrops',
+      'redis-actionpack' => 'https://github.com/redis-store/redis-actionpack',
+      'redis-activesupport' => 'https://github.com/redis-store/redis-activesupport',
+      'redis-rack' => 'https://github.com/redis-store/redis-rack',
+      'redis-rails' => 'https://github.com/redis-store/redis-rails',
+      'rom-mapper' => 'https://github.com/rom-rb/rom-mapper',
+      'rom-repository' => 'https://github.com/rom-rb/rom-repository',
+      'rom-sql' => 'https://github.com/rom-rb/rom-sql',
+      'rouge' => 'https://github.com/jneen/rouge',
+      'rubygems-update' => nil,
+      'spreadsheet' => 'https://github.com/zdavatz/spreadsheet',
+      'thin' => 'https://github.com/macournoyer/thin',
+      'uniform_notifier' => 'https://github.com/flyerhzm/uniform_notifier'
+    }.freeze unless defined? IRREGULAR_REPOSITORIES
+  end
+end

data/lib/rubygems_plugin.rb

@@ -1,27 +1,96 @@
+# frozen-string-literal: true
+
 require 'rubygems'
 require 'net/https'
 
 module Gem
   class Src
-    attr_reader :installer
+    class << self
+      def post_install_hook(installer)
+        return true if installer.class.name == 'Bundler::Source::Path::Installer'
+        return true if !!ENV['GEMSRC_SKIP']
+
+        gem_src = Gem::Src.new installer
+        gem_src.git_clone_homepage_or_source_code_uri_or_homepage_uri_or_github_organization_uri
+
+        gem_src.repositorize_installed_gem
+
+        gem_src.remote_add_src_and_origin
+        true
+      end
+    end
 
     def initialize(installer)
-      @installer, @tested_repositories = installer, []
+      @installer, @spec, @tested_repositories = installer, installer.spec, []
+    end
+
+    # Guess the git repo from the gemspec and perform git clone
+    def git_clone_homepage_or_source_code_uri_or_homepage_uri_or_github_organization_uri
+      return false if File.exist? clone_dir
+
+      now = Time.now
+
+      if IRREGULAR_REPOSITORIES.key? @spec.name
+        return git_clone IRREGULAR_REPOSITORIES[@spec.name]
+      end
+
+      result = git_clone(source_code_uri_from_metadata) ||
+        git_clone(@spec.homepage) ||
+        git_clone(github_url(@spec.homepage)) ||
+        git_clone(source_code_uri) ||
+        git_clone(homepage_uri) ||
+        git_clone(github_url(homepage_uri)) ||
+        git_clone(github_organization_uri(@spec.name))
+
+      if verbose?
+        puts "gem-src: #{@spec.name} - !!! Failed to find a repo." if result.nil?
+        puts "gem-src: #{@spec.name} - #{Time.now - now}s"
+      end
+      result
+    end
+
+    # git init the installed gem so that we can directly edit the files there
+    def repositorize_installed_gem
+      if File.directory? gem_dir
+        puts "gem-src: #{@spec.name} - repositorizing..." if verbose?
+        `cd #{gem_dir} && ! git rev-parse --is-inside-work-tree 2> /dev/null && git init && git checkout -qb gem-src_init && git add -A && git commit -m 'Initial commit by gem-src'`
+      end
+    end
+
+    # git remote add from the installed gem to the cloned repo so that we can easily transfer patches
+    def remote_add_src_and_origin
+      if File.directory?(clone_dir) && File.directory?(gem_dir)
+        puts "gem-src: #{@spec.name} - adding remotes..." if verbose?
+        `cd #{gem_dir} && git remote add src #{clone_dir}`
+        origin = `cd #{clone_dir} && git remote get-url origin`.chomp
+        `cd #{gem_dir} && git config remote.origin.url #{origin}` if origin
+      end
     end
 
+    private
+
     def clone_dir
       @clone_dir ||= if ENV['GEMSRC_CLONE_ROOT']
-        File.expand_path installer.spec.name, ENV['GEMSRC_CLONE_ROOT']
+        File.expand_path @spec.name, ENV['GEMSRC_CLONE_ROOT']
       elsif Gem.configuration[:gemsrc_clone_root]
-        File.expand_path installer.spec.name, Gem.configuration[:gemsrc_clone_root]
+        File.expand_path @spec.name, Gem.configuration[:gemsrc_clone_root]
       else
-        gem_dir = installer.respond_to?(:gem_dir) ? installer.gem_dir : File.expand_path(File.join(installer.gem_home, 'gems', installer.spec.full_name))
         File.join gem_dir, 'src'
       end
     end
 
+    def gem_dir
+      if @installer.respond_to?(:gem_dir)
+        @installer.gem_dir
+      elsif @installer.respond_to?(:gem_home)  # old rubygems
+        File.expand_path(File.join(@installer.gem_home, 'gems', @spec.full_name))
+      else  # bundler
+        File.expand_path(File.join(Gem.dir, 'gems', @spec.full_name))
+      end
+    end
+
     def github_url(url)
-      if url =~ /\Ahttps?:\/\/([^.]+)\.github.com\/(.+)/
+      if url =~ /\Ahttps?:\/\/([^.]+)\.github\.(?:com|io)\/(.+)/
         if $1 == 'www'
           "https://github.com/#{$2}"
         elsif $1 == 'wiki'
@@ -46,19 +115,23 @@ module Gem
       Net::HTTP.new('github.com', 443).tap {|h| h.use_ssl = true }.request_head(url).code != '404'
     end
 
+    def source_code_uri_from_metadata
+      @spec.metadata['source_code_uri']
+    end
+
     def api
       require 'open-uri'
-      @api ||= open("http://rubygems.org/api/v1/gems/#{installer.spec.name}.yaml", &:read)
+      @api ||= OpenURI.open_uri("https://rubygems.org/api/v1/gems/#{@spec.name}.yaml", &:read)
     rescue OpenURI::HTTPError
       ""
     end
 
     def source_code_uri
-      api[/^source_code_uri: (.*)$/, 1]
+      api_uri_for('source_code')
     end
 
     def homepage_uri
-      api[/^homepage_uri: (.*)$/, 1]
+      api_uri_for('homepage')
     end
 
     def github_organization_uri(name)
@@ -67,10 +140,13 @@ module Gem
 
     def git_clone(repository)
       return if repository.nil? || repository.empty?
+      return if repository.include? 'rubyforge.org'
       return if @tested_repositories.include? repository
       @tested_repositories << repository
       return if github?(repository) && !github_page_exists?(repository)
 
+      puts "gem-src: #{@spec.name} - Cloning from #{repository}..." if verbose?
+
       if use_ghq?
         system 'ghq', 'get', repository
       else
@@ -82,21 +158,20 @@ module Gem
       ENV['GEMSRC_USE_GHQ'] || Gem.configuration[:gemsrc_use_ghq]
     end
 
-    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_organization_uri(installer.spec.name))
+    def api_uri_for(key)
+      uri = api[Regexp.new("^#{key}_uri: (.*)$"), 1]
+      uri =~ /\A(?:https?|git):\/\// ? uri : nil
     end
-  end
+
+    def verbose?
+      !!ENV['GEMSRC_VERBOSE'] || Gem.configuration[:gemsrc_verbose]
+    end
+  end unless defined?(Src) # for rubygems test suite.
 end
 
+require 'gem/src/irregular_repositories'
+
 
 Gem.post_install do |installer|
-  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
+  Gem::Src.post_install_hook installer
 end

data/plugins.rb

@@ -0,0 +1,7 @@
+# frozen-string-literal: true
+
+Bundler::Plugin::API.hook Bundler::Plugin::Events::GEM_AFTER_INSTALL do |spec_install|
+  require_relative 'lib/rubygems_plugin'
+
+  Gem::Src.post_install_hook spec_install
+end

data/spec/gem-src_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Gem::Src do
+  def quick_gem(name, version='2')
+    require 'rubygems/specification'
+
+    spec = Gem::Specification.new do |s|
+      s.platform    = Gem::Platform::RUBY
+      s.name        = name
+      s.version     = version
+      s.author      = 'A User'
+      s.email       = 'example@example.com'
+      s.homepage    = 'http://example.com'
+      s.summary     = "this is a summary"
+      s.description = "This is a test description"
+
+      yield(s) if block_given?
+    end
+
+    Gem::Specification.map # HACK: force specs to (re-)load before we write
+
+    written_path = write_file spec.spec_file do |io|
+      io.write spec.to_ruby_for_cache
+    end
+
+    spec.loaded_from = spec.loaded_from = written_path
+
+    Gem::Specification.add_spec spec.for_cache
+
+    spec
+  end
+
+  describe '#clone_dir' do
+    subject do
+      gem = quick_gem 'my_awesome_gem'
+      installer = Gem::Installer.new gem
+      installer.stub(:gem_dir, '~/g/my_awesome_gem')
+      Gem::Src.new installer
+    end
+    context "with ENV['GEMSRC_CLONE_ROOT']" do
+      around do |example|
+        e, g = ENV['GEMSRC_CLONE_ROOT'], Gem.configuration[:gemsrc_clone_root]
+        ENV['GEMSRC_CLONE_ROOT'], Gem.configuration[:gemsrc_clone_root] = '~/foo', nil
+        example.run
+        ENV['GEMSRC_CLONE_ROOT'], Gem.configuration[:gemsrc_clone_root] = e, g
+      end
+      its(:clone_dir) { should == '~/foo/my_awesome_gem' }
+    end
+
+    context "with Gem.configuration[:gemsrc_clone_root]" do
+      around do |example|
+        e, g = ENV['GEMSRC_CLONE_ROOT'], Gem.configuration[:gemsrc_clone_root]
+        ENV['GEMSRC_CLONE_ROOT'], Gem.configuration[:gemsrc_clone_root] = nil, '~/bar'
+        example.run
+        ENV['GEMSRC_CLONE_ROOT'], Gem.configuration[:gemsrc_clone_root] = e, g
+      end
+      its(:clone_dir) { should == '~/bar/my_awesome_gem' }
+    end
+
+    context "without clone_root configuration" do
+      around do |example|
+        e, g = ENV['GEMSRC_CLONE_ROOT'], Gem.configuration[:gemsrc_clone_root]
+        ENV['GEMSRC_CLONE_ROOT'], Gem.configuration[:gemsrc_clone_root] = nil, nil
+        example.run
+        ENV['GEMSRC_CLONE_ROOT'], Gem.configuration[:gemsrc_clone_root] = e, g
+      end
+      its(:clone_dir) { should == '~/aho/my_awesome_gem/src' }
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'bundler/setup'
+Bundler.require
+require File.join(File.dirname(__FILE__), '../lib/rubygems_plugin')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem-src
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Akira Matsuda
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,13 +38,18 @@ files:
 - Rakefile
 - etc/rbenv.d/exec/~gem-src.bash
 - gem-src.gemspec
+- lib/gem/src/irregular_repositories.rb
 - lib/rubygems_plugin.rb
+- plugins.rb
+- spec/gem-src_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/amatsuda/gem-src
 licenses: []
 metadata: {}
 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.
+  [gem-src] Installing gem-src as a gem is not recommended. Please consider installing as an rbenv plugin instead.
 
+  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
 
@@ -63,9 +68,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.0.rc.1
+signing_key:
 specification_version: 4
 summary: Gem.post_install { `git clone gem_source src` }
-test_files: []
+test_files:
+- spec/gem-src_spec.rb
+- spec/spec_helper.rb