appbundler 0.5.0 → 0.6.0

data/README.md

@@ -1,70 +1,70 @@
-# Appbundler
-
-Appbundler reads a Gemfile.lock and generates code with
-`gem "some-dep", "= VERSION"` statements to lock the app's dependencies
-to the versions selected by bundler. This code is used in binstubs for
-the application so that running (e.g.) `chef-client` on the command line
-activates the locked dependencies for `chef` before running the command.
-
-This provides the following benefits:
-* The application loads faster because rubygems is not resolving
-  dependency constraints at runtime.
-* The application runs with the same dependencies that it would if
-  bundler was used, so we can test applications (that will be installed
-  in an omnibus package) using the default bundler workflow.
-* There's no need to `bundle exec` or patch the bundler runtime into the
-  app.
-* The app can load gems not included in the Gemfile/gemspec. Our use
-  case for this is to load plugins (e.g., for knife and test kitchen).
-* A user can use rvm and still use the application (see below).
-* The application is protected from installation of incompatible
-  dependencies.
-
-# Usage
-
-Install via rubygems: `gem install appbundler` or clone this project and
-bundle install:
-
-```
-git clone https://github.com/opscode/appbundler.git
-cd appbundler
-bundle install
-```
-
-Clone whatever project you want to appbundle somewhere else, and bundle
-install it:
-
-```
-mkdir ~/oc
-cd ~/oc
-git clone https://github.com/opscode/chef.git
-cd chef
-bundle install
-```
-
-Create a bin directory where your bundled binstubs will live:
-
-```
-mkdir ~/appbundle-bin
-# Add to your PATH if you like
-```
-
-Now you can app bundle your project (chef in our example):
-
-```
-bin/appbundler ~/oc/chef ~/appbundler-bin
-```
-
-Now you can run all of the app's executables with locked down deps:
-
-```
-~/appbunlder-bin/chef-client -v
-```
-
-
-# RVM
-
-The generated binstubs explicitly disable rvm, so the above won't work
-if you're using rvm. This is intentional, because our use case is for
-omnibus applications where rvm's environment variables can break the
-embedded application by making ruby look for gems in rvm's gem repo.
+# Appbundler
+
+Appbundler reads a Gemfile.lock and generates code with
+`gem "some-dep", "= VERSION"` statements to lock the app's dependencies
+to the versions selected by bundler. This code is used in binstubs for
+the application so that running (e.g.) `chef-client` on the command line
+activates the locked dependencies for `chef` before running the command.
+
+This provides the following benefits:
+* The application loads faster because rubygems is not resolving
+  dependency constraints at runtime.
+* The application runs with the same dependencies that it would if
+  bundler was used, so we can test applications (that will be installed
+  in an omnibus package) using the default bundler workflow.
+* There's no need to `bundle exec` or patch the bundler runtime into the
+  app.
+* The app can load gems not included in the Gemfile/gemspec. Our use
+  case for this is to load plugins (e.g., for knife and test kitchen).
+* A user can use rvm and still use the application (see below).
+* The application is protected from installation of incompatible
+  dependencies.
+
+# Usage
+
+Install via rubygems: `gem install appbundler` or clone this project and
+bundle install:
+
+```
+git clone https://github.com/opscode/appbundler.git
+cd appbundler
+bundle install
+```
+
+Clone whatever project you want to appbundle somewhere else, and bundle
+install it:
+
+```
+mkdir ~/oc
+cd ~/oc
+git clone https://github.com/opscode/chef.git
+cd chef
+bundle install
+```
+
+Create a bin directory where your bundled binstubs will live:
+
+```
+mkdir ~/appbundle-bin
+# Add to your PATH if you like
+```
+
+Now you can app bundle your project (chef in our example):
+
+```
+bin/appbundler ~/oc/chef ~/appbundler-bin
+```
+
+Now you can run all of the app's executables with locked down deps:
+
+```
+~/appbunlder-bin/chef-client -v
+```
+
+
+# RVM
+
+The generated binstubs explicitly disable rvm, so the above won't work
+if you're using rvm. This is intentional, because our use case is for
+omnibus applications where rvm's environment variables can break the
+embedded application by making ruby look for gems in rvm's gem repo.

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require "bundler/gem_tasks"

data/appbundler.gemspec

@@ -1,27 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'appbundler/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "appbundler"
-  spec.version       = Appbundler::VERSION
-  spec.authors       = ["danielsdeleo"]
-  spec.email         = ["dan@opscode.com"]
-  spec.description   = %q{Extracts a dependency solution from bundler's Gemfile.lock to speed gem activation}
-  spec.summary       = spec.description
-  spec.homepage      = ""
-  spec.license       = "Apache2"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "mixlib-shellout", "~> 1.0"
-
-  spec.add_dependency "mixlib-cli", "~> 1.4"
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'appbundler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "appbundler"
+  spec.version       = Appbundler::VERSION
+  spec.authors       = ["danielsdeleo"]
+  spec.email         = ["dan@opscode.com"]
+  spec.description   = %q{Extracts a dependency solution from bundler's Gemfile.lock to speed gem activation}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "Apache2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "mixlib-shellout", "~> 1.0"
+
+  spec.add_dependency "mixlib-cli", "~> 1.4"
+end

data/bin/appbundler

@@ -1,13 +1,13 @@
-#!/usr/bin/env ruby
-
-Kernel.trap(:INT) { exit 1 }
-
-begin
-  require 'appbundler/cli'
-rescue LoadError
-  $:.unshift File.expand_path("../../lib", __FILE__)
-  require 'appbundler/cli'
-end
-
-Appbundler::CLI.run(ARGV)
-
+#!/usr/bin/env ruby
+
+Kernel.trap(:INT) { exit 1 }
+
+begin
+  require 'appbundler/cli'
+rescue LoadError
+  $:.unshift File.expand_path("../../lib", __FILE__)
+  require 'appbundler/cli'
+end
+
+Appbundler::CLI.run(ARGV)
+

data/lib/appbundler.rb

@@ -1,4 +1,4 @@
-
-module Appbundler
-end
-
+
+module Appbundler
+end
+

data/lib/appbundler/app.rb

@@ -1,188 +1,192 @@
-require 'bundler'
-require 'pp'
-
-module Appbundler
-  class App
-
-    BINSTUB_FILE_VERSION=1
-
-    attr_reader :app_root
-    attr_reader :target_bin_dir
-
-    def self.demo
-      demo = new("/Users/ddeleo/oc/chef")
-
-      knife = demo.executables.grep(/knife/).first
-      puts demo.binstub(knife)
-    end
-
-    def initialize(app_root, target_bin_dir)
-      @app_root = app_root
-      @target_bin_dir = target_bin_dir
-    end
-
-    def write_executable_stubs
-      executables_to_create = executables.map do |real_executable_path|
-        basename = File.basename(real_executable_path)
-        stub_path = File.join(target_bin_dir, basename)
-        [real_executable_path, stub_path]
-      end
-
-      executables_to_create.each do |real_executable_path, stub_path|
-        File.open(stub_path, "wb", 0755) do |f|
-          f.write(binstub(real_executable_path))
-        end
-        if RUBY_PLATFORM =~ /mswin|mingw|windows/
-          batch_wrapper_path = "#{stub_path}.bat"
-          File.open(batch_wrapper_path, "wb", 0755) do |f|
-            f.write(batchfile_stub)
-          end
-        end
-      end
-
-      executables_to_create
-    end
-
-    def name
-      File.basename(app_root)
-    end
-
-    def gemfile_lock
-      File.join(app_root, "Gemfile.lock")
-    end
-
-    def ruby
-      Gem.ruby
-    end
-
-    def batchfile_stub
-      ruby_relpath_windows = ruby_relative_path.gsub('/', '\\')
-      <<-E
-@ECHO OFF
-"%~dp0\\#{ruby_relpath_windows}" "%~dpn0" %*
-E
-    end
-
-    # Relative path from #target_bin_dir to #ruby. This is used to
-    # generate batch files for windows in a way that the package can be
-    # installed in a custom location. On Unix we don't support custom
-    # install locations so this isn't needed.
-    def ruby_relative_path
-      ruby_pathname = Pathname.new(ruby)
-      bindir_pathname = Pathname.new(target_bin_dir)
-      ruby_pathname.relative_path_from(bindir_pathname).to_s
-    end
-
-    def shebang
-      "#!#{ruby}\n"
-    end
-
-    # A specially formatted comment that documents the format version of the
-    # binstub files we generate.
-    #
-    # This comment should be unusual enough that we can reliably (enough)
-    # detect whether a binstub was created by Appbundler and parse it to learn
-    # what version of the format it uses. If we ever need to support reading or
-    # mutating existing binstubs, we'll know what file version we're starting
-    # with.
-    def file_format_comment
-      "#--APP_BUNDLER_BINSTUB_FORMAT_VERSION=#{BINSTUB_FILE_VERSION}--\n"
-    end
-
-    # Ruby code (as a string) that clears GEM_HOME and GEM_PATH environment
-    # variables. In an omnibus context, this is important so users can use
-    # things like rvm without accidentally pointing the app at rvm's
-    # ruby and gems.
-    #
-    # Environment sanitization can be skipped by setting the
-    # APPBUNDLER_ALLOW_RVM environment variable to "true". This feature
-    # exists to make tests run correctly on travis.ci (which uses rvm).
-    def env_sanitizer
-      %Q{ENV["GEM_HOME"] = ENV["GEM_PATH"] = nil unless ENV["APPBUNDLER_ALLOW_RVM"] == "true"}
-    end
-
-    def runtime_activate
-      @runtime_activate ||= begin
-        statements = runtime_dep_specs.map {|s| %Q|gem "#{s.name}", "= #{s.version}"|}
-        activate_code = ""
-        activate_code << env_sanitizer << "\n"
-        activate_code << statements.join("\n") << "\n"
-        activate_code
-      end
-    end
-
-    def binstub(bin_file)
-      shebang + file_format_comment + runtime_activate + load_statement_for(bin_file)
-    end
-
-    def load_statement_for(bin_file)
-      name, version = app_spec.name, app_spec.version
-      bin_basename = File.basename(bin_file)
-      <<-E
-gem "#{name}", "= #{version}"
-
-spec = Gem::Specification.find_by_name("#{name}", "= #{version}")
-bin_file = spec.bin_file("#{bin_basename}")
-
-Kernel.load(bin_file)
-E
-    end
-
-    def relative_bin_file(bin_file)
-      bin_file_pathname = Pathname.new(bin_file)
-      bindir_pathname = Pathname.new(target_bin_dir)
-      bin_file_pathname.relative_path_from(bindir_pathname).to_s
-    end
-
-    def executables
-      bin_dir_glob = File.join(app_root, "bin", "*")
-      Dir[bin_dir_glob]
-    end
-
-    def relative_app_lib_dir
-      lib_dir_pathname = Pathname.new(app_lib_dir)
-      bindir_pathname = Pathname.new(target_bin_dir)
-      lib_dir_pathname.relative_path_from(bindir_pathname).to_s
-    end
-
-    def app_lib_dir
-      File.join(app_root, "lib")
-    end
-
-    def runtime_dep_specs
-      add_dependencies_from(app_spec)
-    end
-
-    def app_dependency_names
-      @app_dependency_names ||= app_spec.dependencies.map(&:name)
-    end
-
-    def app_spec
-      spec_for(name)
-    end
-
-    def gemfile_lock_specs
-      parsed_gemfile_lock.specs
-    end
-
-    def parsed_gemfile_lock
-      @parsed_gemfile_lock ||= Bundler::LockfileParser.new(IO.read(gemfile_lock))
-    end
-
-    private
-
-    def add_dependencies_from(spec, collected_deps=[])
-      spec.dependencies.each do |dep|
-        next if collected_deps.any? {|s| s.name == dep.name }
-        next_spec = spec_for(dep.name)
-        collected_deps << next_spec
-        add_dependencies_from(next_spec, collected_deps)
-      end
-      collected_deps
-    end
-
-    def spec_for(dep_name)
-      gemfile_lock_specs.find {|s| s.name == dep_name } or raise "No spec #{dep_name}"
-    end
-  end
-end
+require 'bundler'
+require 'fileutils'
+require 'pp'
+
+module Appbundler
+  class App
+
+    BINSTUB_FILE_VERSION=1
+
+    attr_reader :app_root
+    attr_reader :target_bin_dir
+
+    def self.demo
+      demo = new("/Users/ddeleo/oc/chef")
+
+      knife = demo.executables.grep(/knife/).first
+      puts demo.binstub(knife)
+    end
+
+    def initialize(app_root, target_bin_dir)
+      @app_root = app_root
+      @target_bin_dir = target_bin_dir
+    end
+
+    # Copy over any .bundler and Gemfile.lock files to the target gem
+    # directory.  This will let us run tests from under that directory.
+    def copy_bundler_env
+      gem_path = app_gemspec.gem_dir
+      FileUtils.install(gemfile_lock, gem_path, :mode => 0644)
+      if File.exist?(dot_bundle_dir) && File.directory?(dot_bundle_dir)
+        FileUtils.cp_r(dot_bundle_dir, gem_path)
+        FileUtils.chmod_R("ugo+rX", File.join(gem_path, ".bundle"))
+      end
+    end
+
+    def write_executable_stubs
+      executables_to_create = executables.map do |real_executable_path|
+        basename = File.basename(real_executable_path)
+        stub_path = File.join(target_bin_dir, basename)
+        [real_executable_path, stub_path]
+      end
+
+      executables_to_create.each do |real_executable_path, stub_path|
+        File.open(stub_path, "wb", 0755) do |f|
+          f.write(binstub(real_executable_path))
+        end
+        if RUBY_PLATFORM =~ /mswin|mingw|windows/
+          batch_wrapper_path = "#{stub_path}.bat"
+          File.open(batch_wrapper_path, "wb", 0755) do |f|
+            f.write(batchfile_stub)
+          end
+        end
+      end
+
+      executables_to_create
+    end
+
+    def name
+      File.basename(app_root)
+    end
+
+    def dot_bundle_dir
+      File.join(app_root, ".bundle")
+    end
+
+    def gemfile_lock
+      File.join(app_root, "Gemfile.lock")
+    end
+
+    def ruby
+      Gem.ruby
+    end
+
+    def batchfile_stub
+      ruby_relpath_windows = ruby_relative_path.gsub('/', '\\')
+      <<-E
+@ECHO OFF
+"%~dp0\\#{ruby_relpath_windows}" "%~dpn0" %*
+E
+    end
+
+    # Relative path from #target_bin_dir to #ruby. This is used to
+    # generate batch files for windows in a way that the package can be
+    # installed in a custom location. On Unix we don't support custom
+    # install locations so this isn't needed.
+    def ruby_relative_path
+      ruby_pathname = Pathname.new(ruby)
+      bindir_pathname = Pathname.new(target_bin_dir)
+      ruby_pathname.relative_path_from(bindir_pathname).to_s
+    end
+
+    def shebang
+      "#!#{ruby}\n"
+    end
+
+    # A specially formatted comment that documents the format version of the
+    # binstub files we generate.
+    #
+    # This comment should be unusual enough that we can reliably (enough)
+    # detect whether a binstub was created by Appbundler and parse it to learn
+    # what version of the format it uses. If we ever need to support reading or
+    # mutating existing binstubs, we'll know what file version we're starting
+    # with.
+    def file_format_comment
+      "#--APP_BUNDLER_BINSTUB_FORMAT_VERSION=#{BINSTUB_FILE_VERSION}--\n"
+    end
+
+    # Ruby code (as a string) that clears GEM_HOME and GEM_PATH environment
+    # variables. In an omnibus context, this is important so users can use
+    # things like rvm without accidentally pointing the app at rvm's
+    # ruby and gems.
+    #
+    # Environment sanitization can be skipped by setting the
+    # APPBUNDLER_ALLOW_RVM environment variable to "true". This feature
+    # exists to make tests run correctly on travis.ci (which uses rvm).
+    def env_sanitizer
+      %Q{ENV["GEM_HOME"] = ENV["GEM_PATH"] = nil unless ENV["APPBUNDLER_ALLOW_RVM"] == "true"}
+    end
+
+    def runtime_activate
+      @runtime_activate ||= begin
+        statements = runtime_dep_specs.map {|s| %Q|gem "#{s.name}", "= #{s.version}"|}
+        activate_code = ""
+        activate_code << env_sanitizer << "\n"
+        activate_code << statements.join("\n") << "\n"
+        activate_code
+      end
+    end
+
+    def binstub(bin_file)
+      shebang + file_format_comment + runtime_activate + load_statement_for(bin_file)
+    end
+
+    def load_statement_for(bin_file)
+      name, version = app_spec.name, app_spec.version
+      bin_basename = File.basename(bin_file)
+      <<-E
+gem "#{name}", "= #{version}"
+
+spec = Gem::Specification.find_by_name("#{name}", "= #{version}")
+bin_file = spec.bin_file("#{bin_basename}")
+
+Kernel.load(bin_file)
+E
+    end
+
+    def executables
+      spec = app_gemspec
+      spec.executables.map {|e| spec.bin_file(e)}
+    end
+
+    def runtime_dep_specs
+      add_dependencies_from(app_spec)
+    end
+
+    def app_dependency_names
+      @app_dependency_names ||= app_spec.dependencies.map(&:name)
+    end
+
+    def app_gemspec
+      Gem::Specification.find_by_name(app_spec.name, app_spec.version)
+    end
+
+    def app_spec
+      spec_for(name)
+    end
+
+    def gemfile_lock_specs
+      parsed_gemfile_lock.specs
+    end
+
+    def parsed_gemfile_lock
+      @parsed_gemfile_lock ||= Bundler::LockfileParser.new(IO.read(gemfile_lock))
+    end
+
+    private
+
+    def add_dependencies_from(spec, collected_deps=[])
+      spec.dependencies.each do |dep|
+        next if collected_deps.any? {|s| s.name == dep.name }
+        next_spec = spec_for(dep.name)
+        collected_deps << next_spec
+        add_dependencies_from(next_spec, collected_deps)
+      end
+      collected_deps
+    end
+
+    def spec_for(dep_name)
+      gemfile_lock_specs.find {|s| s.name == dep_name } or raise "No spec #{dep_name}"
+    end
+  end
+end