executable-hooks 1.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+.idea
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,38 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head
+  - ruby-head
+  - rbx-18mode
+  - rbx-19mode
+before_install:
+  - '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
+  - 'curl -L https://get.smf.sh | sh'
+  - 'export PATH=~/.sm/bin:$PATH'
+  - 'sm ext install gem mpapis/sm_gem'
+install: gem install tf -v '>=0.4.1'
+before_script:
+  - unset BUNDLE_GEMFILE
+script: tf --text test/tf/*
+notifications:
+  irc:
+    channels:
+      - "irc.freenode.org#rubygems-bundler"
+  email:
+    recipients:
+      - mpapis@gmail.com
+    on_failure: change
+matrix:
+  allow_failures:
+    - rvm: jruby-18mode
+    - rvm: jruby-19mode
+    - rvm: jruby-head
+    - rvm: rbx-18mode
+    - rvm: rbx-19mode
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 1.0.0
+date: 2013-07-10
+
+ - extracted hooking to rubygems executables from https://github.com/mpapis/rubygems-bundler

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+#ruby=1.8.7
+
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2013 Michal Papis
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,27 @@
+# Rubygems executable hooks
+
+Add next rubygems plugin support for executables.
+
+## Usage
+
+Install the gem:
+
+    gem install executable-hooks
+
+In gem `lib` dir create `rubygems_executable_plugin.rb`:
+
+    Gem.execute do |original_file|
+      warn("Executing: #{original_file}")
+    end
+
+Generate and install the new gem with executable hook.
+
+Now try it:
+
+    gem install haml
+    haml --version
+
+Returns:
+
+    Executing: /home/mpapis/.rvm/gems/ruby-1.8.7-p374-new1/bin/haml
+    Haml 4.0.3

data/bin/executable-hooks-uninstaller

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'executable-hooks/uninstaller'
+
+ExecutableHooks.uninstall

data/bin/ruby_executable_hooks

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+original_file=ARGV[0]
+ARGV.shift
+$PROGRAM_NAME=original_file
+
+require 'rubygems'
+begin
+  require 'executable-hooks/hooks'
+  Gem::ExecutableHooks.run(original_file)
+rescue LoadError
+  warn "unable to load executable-hooks/hooks" if ENV.key?('ExecutableHooks_DEBUG')
+end
+
+eval File.read(original_file), binding, original_file

data/executable-hooks.gemspec

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+Kernel.load(File.expand_path("../lib/executable-hooks/version.rb", __FILE__))
+
+Gem::Specification.new do |s|
+  s.name        = "executable-hooks"
+  s.version     = ExecutableHooks::VERSION
+  s.authors     = ["Michal Papis"]
+  s.email       = ["mpapis@gmail.com"]
+  s.homepage    = "https://github.com/mpapis/executable-hooks"
+  s.summary     = %q{
+    Hook into rubygems executables allowing extra actions to be taken before executable is run.
+  }
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.extensions  = %w( ext/wrapper_installer/extconf.rb )
+  s.executables = %w( executable-hooks-uninstaller )
+
+  s.add_development_dependency "tf"
+  #s.add_development_dependency "smf-gem"
+end

data/ext/wrapper_installer/extconf.rb

@@ -0,0 +1,22 @@
+# Fake building extension
+File.open('Makefile', 'w') { |f| f.write("all:\n\ninstall:\n\n") }
+File.open('make', 'w') do |f|
+  f.write('#!/bin/sh')
+  f.chmod(f.stat.mode | 0111)
+end
+File.open('wrapper_installer.so', 'w') {}
+File.open('wrapper_installer.dll', 'w') {}
+File.open('nmake.bat', 'w') { |f| }
+
+
+# add the gem to load path
+$: << File.expand_path("../../../lib", __FILE__)
+# load the uninstaller
+require 'executable-hooks/uninstaller'
+# call the action
+RegenerateBinstubsCommand.new.execute
+# unload the path, what was required stays ... but there is that much we can do
+$:.pop
+
+# just in case - it worked
+true

data/lib/executable-hooks/hooks.rb

@@ -0,0 +1,46 @@
+module Gem
+  @executables_hooks    ||= []
+
+  class << self
+    unless method_defined?(:execute)
+      def execute(&hook)
+        @executables_hooks << hook
+      end
+
+      attr_reader :executables_hooks
+    end
+
+    unless method_defined?(:load_executable_plugins)
+      def load_executable_plugins
+        load_plugin_files(find_files('rubygems_executable_plugin', false))
+      rescue ArgumentError, NoMethodError
+        # old rubygems
+        plugins = find_files('rubygems_executable_plugin')
+
+        plugins.each do |plugin|
+
+          # Skip older versions of the GemCutter plugin: Its commands are in
+          # RubyGems proper now.
+
+          next if plugin =~ /gemcutter-0\.[0-3]/
+
+          begin
+            load plugin
+          rescue ::Exception => e
+            details = "#{plugin.inspect}: #{e.message} (#{e.class})"
+            warn "Error loading RubyGems plugin #{details}"
+          end
+        end
+      end
+    end
+  end
+
+  class ExecutableHooks
+    def self.run(original_file)
+      Gem.load_executable_plugins
+      Gem.executables_hooks.each do |hook|
+        hook.call(original_file)
+      end
+    end
+  end
+end

data/lib/executable-hooks/installer.rb

@@ -0,0 +1,95 @@
+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?
+    bindir = inst.bin_dir ? inst.bin_dir : Gem.bindir(inst.gem_home)
+    inst.spec.executables.each do |filename|
+      filename.untaint
+      original = File.join bindir, filename
+      if File.exists?( original )
+        bin_script_path = File.join bindir, inst.formatted_program_filename(filename)
+        FileUtils.rm_f bin_script_path
+        File.open bin_script_path, 'wb', 0755 do |file|
+          file.print bundler_app_script_text(inst, filename)
+        end
+        inst.say bin_script_path if Gem.configuration.really_verbose
+      else
+        inst.say "Can not find #{inst.spec.name} in GEM_PATH"
+        break
+      end
+    end
+  end
+
+
+  def self.shebang(inst, bin_file_name)
+    # options were defined first in 1.5, we want to support back to 1.3.7
+    ruby_name = Gem::ConfigMap[:ruby_install_name] if inst.instance_variable_get(:@env_shebang)
+    bindir = inst.bin_dir ? inst.bin_dir : Gem.bindir(inst.gem_home)
+    path = File.join bindir, inst.formatted_program_filename(bin_file_name)
+    first_line = File.open(path, "rb") {|file| file.gets}
+
+    if /\A#!/ =~ first_line then
+      # Preserve extra words on shebang line, like "-w". Thanks RPA.
+      shebang = first_line.sub(/\A\#!.*?ruby\S*((\s+\S+)+)/, "#!#{Gem.ruby}")
+      opts = $1
+      shebang.strip! # Avoid nasty ^M issues.
+    end
+
+    if which = Gem.configuration[:custom_shebang]
+      which = which.gsub(/\$(\w+)/) do
+        case $1
+        when "env"
+          @env_path ||= Gem::Installer::ENV_PATHS.find {|env_path| File.executable? env_path }
+        when "ruby"
+          "#{Gem.ruby}#{opts}"
+        when "exec"
+          bin_file_name
+        when "name"
+          inst.spec.name
+        end
+      end
+
+      return "#!#{which}"
+    end
+
+    if not ruby_name then
+      "#!#{Gem.ruby}#{opts}"
+    elsif opts then
+      "#!/bin/sh\n'exec' #{ruby_name.dump} '-x' \"$0\" \"$@\"\n#{shebang}"
+    else
+      @env_path ||= Gem::Installer::ENV_PATHS.find {|env_path| File.executable? env_path }
+      "#!#{@env_path} #{ruby_name}"
+    end
+  end
+
+  # Return the text for an application file.
+  def self.bundler_app_script_text(inst, bin_file_name)
+    <<-TEXT
+#{shebang(inst, bin_file_name)}
+#
+# This file was generated by RubyGems.
+#
+# The application '#{inst.spec.name}' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = "#{Gem::Requirement.default}"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem '#{inst.spec.name}', version
+load Gem.bin_path('#{inst.spec.name}', '#{bin_file_name}', version)
+TEXT
+  end
+
+end
+
+Gem.post_install do |inst|
+  ExecutableHooksInstaller.bundler_generate_bin(inst)
+end

data/lib/executable-hooks/regenerate_binstubs_command.rb

@@ -0,0 +1,69 @@
+require 'rubygems/command_manager'
+require 'rubygems/installer'
+require 'rubygems/version'
+require 'executable-hooks/wrapper'
+
+class RegenerateBinstubsCommand < Gem::Command
+  def initialize
+    super 'regenerate_binstubs', 'Re run generation of executable wrappers for gems.'
+  end
+
+  def arguments # :nodoc:
+    "STRING        start of gem name to regenerate binstubs"
+  end
+
+  def usage # :nodoc:
+    "#{program_name} [STRING]"
+  end
+
+  def defaults_str # :nodoc:
+    ""
+  end
+
+  def description # :nodoc:
+    'Re run generation of executable wrappers for all gems. '+
+    'Wrappers will be compatible with both rubygems and bundler. '+
+    'The switcher is BUNDLE_GEMFILE environment variable, '+
+    'when set it switches to bundler mode, when not set, '+
+    'then the command will work as it was with pure rubygems.'
+  end
+
+  def execute
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('2.0.0') then
+      # https://github.com/rubygems/rubygems/issues/326
+      puts "try also: gem pristine --binstubs"
+    end
+    ExecutableHooks::Wrapper.install
+    execute_no_wrapper
+  end
+
+  def execute_no_wrapper
+    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?
+        org_gem_path = Gem.path.find{|path|
+          File.exists? File.join path, 'gems', 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
+          ExecutableHooksInstaller.bundler_generate_bin(inst)
+        else
+          puts "##{spec.name} #{spec.version} not found in GEM_PATH"
+        end
+      end
+    end
+  end
+
+  private
+  def installed_gems
+    if Gem::VERSION > '1.8' then
+      Gem::Specification.to_a
+    else
+      Gem.source_index.map{|name,spec| spec}
+    end
+  end
+end

data/lib/executable-hooks/specification.rb

@@ -0,0 +1,17 @@
+module ExecutableHooks
+  module Specification
+    def self.find
+      @executable_hooks_spec ||=
+        if Gem::Specification.respond_to?(:find_by_name)
+          Gem::Specification.find_by_name("executable-hooks")
+        else
+          Gem.source_index.find_name("executable-hooks").last
+        end
+    rescue Gem::LoadError
+      nil
+    end
+    def self.version
+      find ? find.version.to_s : nil
+    end
+  end
+end

data/lib/executable-hooks/uninstaller.rb

@@ -0,0 +1,10 @@
+require 'executable-hooks/wrapper'
+require 'executable-hooks/regenerate_binstubs_command'
+
+module ExecutableHooks
+  def self.uninstall
+    Gem.configuration[:custom_shebang] = "$env #{Gem.default_exec_format % "ruby"}"
+    RegenerateBinstubsCommand.new.execute_no_wrapper
+    Wrapper.uninstall
+  end
+end

data/lib/executable-hooks/version.rb

@@ -0,0 +1,3 @@
+module ExecutableHooks
+  VERSION = "1.1.0"
+end

data/lib/executable-hooks/wrapper.rb

@@ -0,0 +1,53 @@
+# install / uninstall wrapper
+require 'fileutils'
+require 'rubygems'
+require 'executable-hooks/specification'
+
+module ExecutableHooks
+  module 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
+
+      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!
+")
+      end
+    end
+    def self.install
+      ensure_custom_shebang
+
+      executable_hooks_spec = ExecutableHooks::Specification.find
+
+      if executable_hooks_spec
+        wrapper_path = File.expand_path( "bin/#{wrapper_name}", executable_hooks_spec.full_gem_path )
+
+        if File.exist?(wrapper_path) && !File.exist?(destination)
+          FileUtils.mkdir_p(bindir)
+          FileUtils.cp(wrapper_path, destination)
+          File.chmod(0775, destination)
+        end
+      end
+    end
+    def self.uninstall
+      FileUtils.rm_f(destination) if File.exist?(destination)
+    end
+  end
+end

data/lib/rubygems_executable_plugin.rb

@@ -0,0 +1,3 @@
+Gem.execute do |original_file|
+  warn("Executing: #{original_file}") if ENV.key?('ExecutableHooks_DEBUG')
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,26 @@
+# Simulate require_relative - it's required as the plugin can be called in wrong version or from bundler.
+require File.expand_path('../executable-hooks/specification.rb', __FILE__)
+
+called_path, called_version = __FILE__.match(/^(.*\/executable-hooks-([^\/]+)\/lib).*$/)[1..2]
+
+# continue only if loaded and called versions all the same, and not shared gems disabled in bundler
+if
+  ( $:.include?(called_path) || ExecutableHooks::Specification.version == called_version ) and
+  ( !defined?(Bundler) || ( defined?(Bundler) && Bundler::SharedHelpers.in_bundle? && !Bundler.settings[:disable_shared_gems]) )
+
+  require 'rubygems/version'
+  require 'executable-hooks/wrapper'
+
+  # Set the custom_shebang if user did not set one
+  Gem.pre_install do |inst|
+    ExecutableHooks::Wrapper.install
+  end
+
+  if Gem::Version.new(Gem::VERSION) < Gem::Version.new('2.0') then
+    # Add custom_shebang support to rubygems
+    require 'executable-hooks/installer'
+  end
+
+  require 'executable-hooks/regenerate_binstubs_command'
+  Gem::CommandManager.instance.register_command :regenerate_binstubs
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: executable-hooks
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Michal Papis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-07-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tf
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: 
+email: 
+- mpapis@gmail.com
+executables: 
+- executable-hooks-uninstaller
+extensions: 
+- ext/wrapper_installer/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- bin/executable-hooks-uninstaller
+- bin/ruby_executable_hooks
+- executable-hooks.gemspec
+- ext/wrapper_installer/extconf.rb
+- lib/executable-hooks/hooks.rb
+- lib/executable-hooks/installer.rb
+- lib/executable-hooks/regenerate_binstubs_command.rb
+- lib/executable-hooks/specification.rb
+- lib/executable-hooks/uninstaller.rb
+- lib/executable-hooks/version.rb
+- lib/executable-hooks/wrapper.rb
+- lib/rubygems_executable_plugin.rb
+- lib/rubygems_plugin.rb
+has_rdoc: true
+homepage: https://github.com/mpapis/executable-hooks
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Hook into rubygems executables allowing extra actions to be taken before executable is run.
+test_files: []
+