Add bindir support, fixes #24

Author: mpapis

.travis.yml

@@ -1,28 +1,19 @@
 language: ruby
 rvm:
-  - jruby-18mode
-  - jruby-19mode
+  - jruby
   - jruby-head
-  - ruby-head
-  - rbx-18mode
-  - rbx-19mode
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
+  - rbx-3
 before_install:
+  - 'rvm @global do gem uninstall -a -x rubygems-bundler executable-hooks || true'
+  - 'rm -f $(rvm @global do gem env home)/bin/jruby_executable_hooks'
   - 'rm -rf $rvm_path/gems/*/{bin,gems}/rubygems-bundler-* $rvm_path/gems/*/{bin,gems}/executable-hooks-* $rvm_path/gems/*/bin/ruby_*_{wrapper,hooks}'
   - hash -r
+  - 'if [[ -n "${WITH_RUBYGEMS:-}" ]] ; then gem update --system "${WITH_RUBYGEMS}" ; fi'
   - gem build executable-hooks.gemspec
   - gem install executable-hooks-$(awk -F'"' '/VERSION/{print $2}' < lib/executable-hooks/version.rb).gem --development
 before_script:
   - unset BUNDLE_GEMFILE
-script: tf --text test-tf/*
+script: NOEXEC=0 tf --text test-tf${TEST_SUFFIX:-}/*
 notifications:
   irc:
     channels:
@@ -32,10 +23,21 @@ notifications:
       - [email protected]
     on_failure: change
 matrix:
-  allow_failures:
-    - rvm: jruby-18mode
-    - rvm: jruby-19mode
-    - rvm: jruby-head
-    - rvm: rbx-18mode
-    - rvm: rbx-19mode
+  fast_finish: true
+  include:
+    - rvm: 1.8.7
+      env: WITH_RUBYGEMS=1.6.2
+    - rvm: 2.5
+      env: TEST_SUFFIX=-bundle
+    - rvm: 1.8.7
+    - rvm: 1.9.2
+    - rvm: 1.9.3
+    - rvm: 2.0.0
+    - rvm: 2.1
+    - rvm: 2.2
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
     - rvm: ruby-head
+  allow_failures:
+    - rvm: rbx-3

bin/ruby_executable_hooks

@@ -10,6 +10,6 @@ begin
   Gem::ExecutableHooks.run($0)
 rescue LoadError
   warn "unable to load executable-hooks/hooks" if ENV.key?('ExecutableHooks_DEBUG')
-end
+end unless $0.end_with?('/executable-hooks-uninstaller')
 
 eval File.read($0), binding, $0

executable-hooks.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   }
   s.post_install_message = <<-MESSAGE
 # In case of problems run the following command to update binstubs:
-gem regenerate_binstubs
+    gem regenerate_binstubs
   MESSAGE
 
 

ext/wrapper_installer/extconf.rb

@@ -15,7 +15,8 @@
 require 'executable-hooks/wrapper'
 require 'executable-hooks/regenerate_binstubs_command'
 # call the actions
-ExecutableHooks::Wrapper.install_from(File.expand_path("../../..", __FILE__))
+options = RegenerateBinstubsCommand.default_install_options
+ExecutableHooks::Wrapper.new(options).install_from(File.expand_path("../../..", __FILE__))
 RegenerateBinstubsCommand.new.execute_no_wrapper
 # unload the path, what was required stays ... but there is that much we can do
 $:.pop

lib/executable-hooks/installer.rb

@@ -2,9 +2,11 @@ module ExecutableHooksInstaller
   # Iterate through executables and generate wrapper for each one,
   # extract of rubygems code
   def self.bundler_generate_bin(inst)
-    return if inst.spec.executables.nil? or inst.spec.executables.empty?
+    return if inst.spec.executables.nil?
+    executables = inst.spec.executables.reject{ |name| name == 'executable-hooks-uninstaller' }
+    return if executables.empty?
     bindir = inst.bin_dir ? inst.bin_dir : Gem.bindir(inst.gem_home)
-    inst.spec.executables.each do |filename|
+    executables.each do |filename|
       filename.untaint
       original = File.join bindir, filename
       if File.exists?( original )

lib/executable-hooks/regenerate_binstubs_command.rb

@@ -4,8 +4,37 @@
 require 'executable-hooks/wrapper'
 
 class RegenerateBinstubsCommand < Gem::Command
+  def self.default_install_options
+    require 'rubygems/commands/install_command'
+    Gem::Command.extra_args = Gem.configuration[:gem]
+    config_args = Gem.configuration[:install]
+    config_args =
+      case config_args
+      when String
+        config_args.split ' '
+      else
+        Array(config_args)
+      end
+    Gem::Command.add_specific_extra_args 'install', config_args
+    ic = Gem::Commands::InstallCommand.new
+    ic.handle_options ["install"]
+    ic.options
+  end
+
   def initialize
     super 'regenerate_binstubs', 'Re run generation of executable wrappers for gems.'
+
+    add_option(:"Install/Update", '-i', '--install-dir DIR',
+      'Gem repository directory to get installed',
+      'gems') do |value, options|
+      options[:install_dir] = File.expand_path(value)
+    end
+
+    add_option(:"Install/Update", '-n', '--bindir DIR',
+      'Directory where binary files are',
+      'located') do |value, options|
+      options[:bin_dir] = File.expand_path(value)
+    end
   end
 
   def arguments # :nodoc:
@@ -33,17 +62,18 @@ def execute
       # https://github.com/rubygems/rubygems/issues/326
       puts "try also: gem pristine --binstubs"
     end
-    ExecutableHooks::Wrapper.install
+    ExecutableHooks::Wrapper.new(options).install
     execute_no_wrapper
   end
 
-  def execute_no_wrapper
+  def execute_no_wrapper(wrapper_name = ExecutableHooks::Wrapper.expanded_wrapper_name)
     require 'executable-hooks/installer'
     name = get_one_optional_argument || ''
     specs = installed_gems.select{|spec| spec.name =~ /^#{name}/i }
     specs.each do |spec|
-      unless spec.executables.empty?
-        try_to_fix_binstubs(spec) or
+      executables = spec.executables.reject{ |name| name == 'executable-hooks-uninstaller' }
+      unless executables.empty?
+        try_to_fix_binstubs(spec, executables, wrapper_name) or
         try_to_install_binstubs(spec) or
         $stderr.puts "##{spec.name} #{spec.version} not found in GEM_PATH"
       end
@@ -52,9 +82,9 @@ def execute_no_wrapper
 
   private
 
-  def try_to_fix_binstubs(spec)
+  def try_to_fix_binstubs(spec, executables, wrapper_name)
     executable_paths =
-    spec.executables.map do |executable|
+    executables.map do |executable|
       path = expanded_bin_paths.detect{|bin_path| File.exist?(File.join(bin_path, executable)) }
       File.join(path, executable) if path
     end
@@ -67,7 +97,7 @@ def try_to_fix_binstubs(spec)
     puts "#{spec.name} #{spec.version}"
     executable_mode = 0111
     executable_shebangs.map do |path, lines|
-      lines[0] = "#!#{ExecutableHooksInstaller.env_path} #{ExecutableHooks::Wrapper.expanded_wrapper_name}"
+      lines[0] = "#!#{ExecutableHooksInstaller.env_path} #{wrapper_name}"
       File.open(path, "w") do |file|
         file.puts(lines)
       end
@@ -80,24 +110,27 @@ def expanded_bin_paths
     @expanded_bin_paths ||= begin
       paths = expanded_gem_paths.map{|path| File.join(path, "bin") }
       paths << RbConfig::CONFIG["bindir"]
+      # TODO: bindir from options?
       paths
     end
   end
 
   def try_to_install_binstubs(spec)
-    org_gem_path = expanded_gem_paths.find{|path|
-      File.exists? File.join path, 'gems', spec.full_name
-    } || Gem.dir
+    org_gem_path = options[:install_dir] || existing_gem_path(spec.full_name) || Gem.dir
     cache_gem = File.join(org_gem_path, 'cache', spec.file_name)
     if File.exist? cache_gem
       puts "#{spec.name} #{spec.version}"
-      inst = Gem::Installer.new Dir[cache_gem].first, :wrappers => true, :force => true, :install_dir => org_gem_path
+      inst = Gem::Installer.new Dir[cache_gem].first, :wrappers => true, :force => true, :install_dir => org_gem_path, :bin_dir => options[:bin_dir]
       ExecutableHooksInstaller.bundler_generate_bin(inst)
     else
       false
     end
   end
 
+  def existing_gem_path(full_name)
+    expanded_gem_paths.find{|path| File.exists? File.join path, 'gems', full_name}
+  end
+
   def expanded_gem_paths
     @expanded_gem_paths ||=
     Gem.path.map do |path|

lib/executable-hooks/specification.rb

@@ -3,7 +3,7 @@ module Specification
     def self.find
       @executable_hooks_spec ||=
         if Gem::Specification.respond_to?(:find_by_name)
-          Gem::Specification.find_by_name("executable-hooks")
+          Gem::Specification.find_by_name("executable-hooks", ">=0", ">=0.alpha")
         else
           Gem.source_index.find_name("executable-hooks").last
         end

lib/executable-hooks/uninstaller.rb

@@ -1,10 +1,14 @@
 require 'executable-hooks/wrapper'
 require 'executable-hooks/regenerate_binstubs_command'
+require 'rubygems/uninstaller'
 
 module ExecutableHooks
   def self.uninstall
     Gem.configuration[:custom_shebang] = "$env #{Gem.default_exec_format % "ruby"}"
-    RegenerateBinstubsCommand.new.execute_no_wrapper
-    Wrapper.uninstall
+    options = RegenerateBinstubsCommand.default_install_options
+    RegenerateBinstubsCommand.new.execute_no_wrapper("ruby")
+    ExecutableHooks::Wrapper.new(options).uninstall
+    options.merge!(:executables => true, :all => true, :ignore => true)
+    Gem::Uninstaller.new("executable-hooks", options).uninstall
   end
 end

lib/executable-hooks/wrapper.rb

@@ -4,35 +4,23 @@
 require 'executable-hooks/specification'
 
 module ExecutableHooks
-  module Wrapper
+  class Wrapper
     def self.wrapper_name
       'ruby_executable_hooks'
     end
+
     def self.expanded_wrapper_name
       Gem.default_exec_format % self.wrapper_name
     end
-    def self.bindir
-      Gem.respond_to?(:bindir,true) ? Gem.send(:bindir) : File.join(Gem.dir, 'bin')
-    end
-    def self.destination
-      File.expand_path( expanded_wrapper_name, bindir )
-    end
-    def self.ensure_custom_shebang
-      expected_shebang = "$env #{expanded_wrapper_name}"
 
-      Gem.configuration[:custom_shebang] ||= expected_shebang
+    attr_reader :options
 
-      if Gem.configuration[:custom_shebang] != expected_shebang
-        warn("
-Warning:
-    Found    custom_shebang: '#{Gem.configuration[:custom_shebang]}',
-    Expected custom_shebang: '#{expected_shebang}',
-this can potentially break 'executable-hooks' and gem executables overall!
-Check your '~/.gemrc' and '/etc/gemrc' for 'custom_shebang' and remove it.
-")
-      end
+    def initialize(options)
+      @options = options
     end
-    def self.install
+
+    def install
+      @bindir = options[:bin_dir] if options[:bin_dir]
       ensure_custom_shebang
 
       executable_hooks_spec = ExecutableHooks::Specification.find
@@ -42,8 +30,10 @@ def self.install
       end
     end
 
-    def self.install_from(full_gem_path)
-      wrapper_path = File.expand_path( "bin/#{wrapper_name}", full_gem_path )
+    def install_from(full_gem_path)
+      wrapper_path = File.expand_path( "bin/#{self.class.wrapper_name}", full_gem_path )
+      bindir       = calculate_bindir(options)
+      destination  = calculate_destination(bindir)
 
       if File.exist?(wrapper_path) && !File.exist?(destination)
         FileUtils.mkdir_p(bindir) unless File.exist?(bindir)
@@ -53,8 +43,37 @@ def self.install_from(full_gem_path)
         File.chmod(0775, destination)
       end
     end
-    def self.uninstall
+
+    def uninstall
+      destination = calculate_destination(calculate_bindir(options))
       FileUtils.rm_f(destination) if File.exist?(destination)
     end
+
+    def calculate_bindir(options)
+      return options[:bin_dir] if options[:bin_dir]
+      Gem.respond_to?(:bindir,true) ? Gem.send(:bindir) : File.join(Gem.dir, 'bin')
+    end
+
+    def calculate_destination(bindir)
+      File.expand_path(self.class.expanded_wrapper_name, bindir)
+    end
+
+
+    def ensure_custom_shebang
+      expected_shebang = "$env #{self.class.expanded_wrapper_name}"
+
+      Gem.configuration[:custom_shebang] ||= expected_shebang
+
+      if Gem.configuration[:custom_shebang] != expected_shebang
+        warn("
+Warning:
+    Found    custom_shebang: '#{Gem.configuration[:custom_shebang]}',
+    Expected custom_shebang: '#{expected_shebang}',
+this can potentially break 'executable-hooks' and gem executables overall!
+Check your '~/.gemrc' and '/etc/gemrc' for 'custom_shebang' and remove it.
+")
+      end
+    end
+
   end
 end

lib/rubygems_plugin.rb

@@ -12,8 +12,8 @@
   require 'executable-hooks/wrapper'
 
   # Set the custom_shebang if user did not set one
-  Gem.pre_install do |inst|
-    ExecutableHooks::Wrapper.install
+  Gem.pre_install do |gem_installer|
+    ExecutableHooks::Wrapper.new(gem_installer.options).install
   end
 
   if Gem::Version.new(Gem::VERSION) < Gem::Version.new('2.0') then

test-tf-bundle/bundle_comment_test.sh

@@ -0,0 +1,20 @@
+gem install executable-hooks-$(awk -F'"' '/VERSION/{print $2}' < lib/executable-hooks/version.rb).gem --development
+# match=/installed/
+gem install rubygems-bundler bundler
+# match=/installed/
+gem install haml -v "4.0.7"  # match=/installed/
+# match=/installed/
+
+true TMPDIR:${TMPDIR:=/tmp}:
+d=$TMPDIR/test-bundled
+mkdir $d
+pushd $d
+
+NOEXEC=1 haml -v             # match=/4.0.7/
+
+echo -e 'source "https://rubygems.org"\ngem "haml", "4.0.6"' > Gemfile
+bundle install               # match=/haml 4.0.6/
+NOEXEC=1 haml -v             # match=/4.0.6/
+
+popd
+rm -rf $d

test-tf/rubygems_comment_test.sh

@@ -1,14 +1,15 @@
 gem install executable-hooks-$(awk -F'"' '/VERSION/{print $2}' < lib/executable-hooks/version.rb).gem --development
 # match=/installed/
+wrapper_name=$(ruby -I ./lib/ -r executable-hooks/wrapper -e "puts ExecutableHooks::Wrapper.expanded_wrapper_name")
 
-gem install haml            # match=/installed/
-head -n 1 $(which haml)     # match=/ruby_executable_hooks/
-which ruby_executable_hooks # status=0
+gem install haml -v "<5"     # match=/installed/
+head -n 1 $(which haml )     # match=/ruby_executable_hooks/
+which ${wrapper_name}        # status=0
 
 gem list                     # match=/haml/
 executable-hooks-uninstaller # match=/haml/
 
 head -n 1 $(which haml)      # match!=/ruby_executable_hooks/
-which ruby_executable_hooks  # status=1
+which ${wrapper_name}        # status=1
 
 gem uninstall -x haml        # match=/Successfully uninstalled/