gem-src 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4f3c83dc3c5a18f5ae5811a98878cf4f8425f9ec
-  data.tar.gz: 9dc52976d13b55dbcc66b243698b195c89307372
+SHA256:
+  metadata.gz: 70651b92bbaa9d17a2f084c7e2ff97adf2b40a2ebe4ec00deae616afec1fe995
+  data.tar.gz: 5ac36fd408e1b1f96945986c6f4bef28d737b2ef8e0d8b9e66a913c16a76dede
 SHA512:
-  metadata.gz: 784ee29ac83834644d22b0e2ac06cb8d482ecab3e74caab90b312dc7f503dd1aebf67001506e973e3121657d3df96a212745d320039df5d52aa0ed4cf270a3d0
-  data.tar.gz: 210a3f0b03f80eef330601954bc57eb73d87ab9033cb78b19ae83ece781405d60c3ba4e7ebb8ee8769fedb0009ce580e77773188a0f5a138819fb4f27df50f2d
+  metadata.gz: 1ac67aa2d4b6f7ac57ffebb80e1ebed510477117dc9e3ce3573d51d9b9b146ab2152dbdf6ad3928220e7ac6d6353808687d1548f6e310a0730def45826ba24e1
+  data.tar.gz: 9e2818b0389ab44f3cf537ecfcf85c00adb77d9d59edad7010ca7471aabf411403aeedb97fc4426651e372bcb788b741239f7fb9122603953544397c500ee531

data/README.md

@@ -5,7 +5,7 @@ Plus, gem-src runs `git init` on each installed gem, and links it to the cloned
 
 ***TL;DR***
 
-    % 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"
     % mkdir ~/src
     % echo "gemsrc_clone_root: ~/src" >> ~/.gemrc
 
@@ -14,20 +14,26 @@ Then you're all set!
 
 ## Installation
 
-### As a Rubygem
-
-gem-src is a gem plugin that can be installed via gem install command:
-
-    % gem install gem-src
-
 ### :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

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

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

@@ -5,35 +5,46 @@ require 'net/https'
 
 module Gem
   class Src
-    IRREGULAR_REPOSITORIES = {'activesupport' => nil, 'actionview' => nil, 'actionpack' => nil, 'activemodel' => nil, 'activerecord' => nil, 'activejob' => nil, 'actionmailer' => nil, 'actioncable' => 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', 'bson' => 'https://github.com/mongodb/bson-ruby.git', 'compass-core' => 'https://github.com/Compass/compass.git', 'compass-import-once' => 'https://github.com/Compass/compass.git', '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-api' => 'https://github.com/elastic/elasticsearch-ruby.git', 'elasticsearch-transport' => 'https://github.com/elastic/elasticsearch-ruby.git', 'erubis' => 'https://github.com/kwatch/erubis.git', 'geocoder' => 'https://github.com/alexreisner/geocoder', 'hirb' => 'https://github.com/cldwalker/hirb', 'html2haml' => 'https://github.com/haml/html2haml', 'io-console' => nil, 'kaminari-actionview' => nil, 'kaminari-activerecord' => nil, 'kaminari-core' => nil, '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', 'rouge' => 'https://github.com/jneen/rouge', 'spreadsheet' => 'https://github.com/zdavatz/spreadsheet', 'thin' => 'https://github.com/macournoyer/thin', 'uniform_notifier' => 'https://github.com/flyerhzm/uniform_notifier'}.freeze
+    class << self
+      def post_install_hook(installer)
+        return true if installer.class.name == 'Bundler::Source::Path::Installer'
+        return true if !!ENV['GEMSRC_SKIP']
 
-    attr_reader :installer
+        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 skip_clone?
       return false if File.exist? clone_dir
 
       now = Time.now
 
-      if IRREGULAR_REPOSITORIES.key? installer.spec.name
-        return git_clone IRREGULAR_REPOSITORIES[installer.spec.name]
+      if IRREGULAR_REPOSITORIES.key? @spec.name
+        return git_clone IRREGULAR_REPOSITORIES[@spec.name]
       end
 
-      result = git_clone(installer.spec.homepage) ||
-        git_clone(github_url(installer.spec.homepage)) ||
+      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(installer.spec.name))
+        git_clone(github_organization_uri(@spec.name))
 
       if verbose?
-        puts "gem-src: #{installer.spec.name} - !!! Failed to find a repo." if result.nil?
-        puts "gem-src: #{installer.spec.name} - #{Time.now - now}s"
+        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
@@ -41,7 +52,7 @@ module Gem
     # 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: #{installer.spec.name} - repositorizing..." if verbose?
+        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
@@ -49,10 +60,10 @@ module Gem
     # 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: #{installer.spec.name} - adding remotes..." if verbose?
+        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 remote set-url origin #{origin}` if origin
+        `cd #{gem_dir} && git config remote.origin.url #{origin}` if origin
       end
     end
 
@@ -60,17 +71,22 @@ module Gem
 
     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
-      installer.respond_to?(:gem_dir) ? installer.gem_dir : File.expand_path(File.join(installer.gem_home, 'gems', installer.spec.full_name))
+      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)
@@ -99,9 +115,13 @@ 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("https://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
@@ -120,11 +140,12 @@ 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: #{installer.spec.name} - Cloning from #{repository}..." if verbose?
+      puts "gem-src: #{@spec.name} - Cloning from #{repository}..." if verbose?
 
       if use_ghq?
         system 'ghq', 'get', repository
@@ -142,25 +163,15 @@ module Gem
       uri =~ /\A(?:https?|git):\/\// ? uri : nil
     end
 
-    def skip_clone?
-      !!ENV['GEMSRC_SKIP']
-    end
-
     def verbose?
       !!ENV['GEMSRC_VERBOSE'] || Gem.configuration[:gemsrc_verbose]
     end
-  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 = 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
+Gem.post_install do |installer|
+  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.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Akira Matsuda
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,7 +38,11 @@ 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: {}
@@ -64,9 +68,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-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