bundler 1.0.0.rc.5 → 1.0.0.rc.6

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 1.0.0.rc.6
+
+Features:
+
+  - Much better documentation for most of the commands and Gemfile
+    format
+
+Bugfixe:
+
+  - Don't attempt to create directories if they already exist
+  - Fix the capistrano task so that it actually runs
+  - Update the Gemfile template to reference rubygems.org instead
+    of :gemcutter
+  - bundle exec should exit with a non zero exit code when the gem
+    binary does not exist or the file is not executable.
+  - Expand paths in Gemfile relative to the Gemfile and not the current
+    working directory.
+
 ## 1.0.0.rc.5
 
 Features:

data/ISSUES.md

@@ -0,0 +1,30 @@
+# Bundler Issues
+
+## Troubleshooting
+
+Before reporting a bug, try these troubleshooting steps:
+
+    rm -rf ~/.bundle/ ~/.gem/ .bundle/ Gemfile.lock
+    bundle install
+
+## Reporting bugs
+
+If you are still having problems, please report bugs to the [Bundler issue tracker](http://github.com/carlhuda/bundler/issues/).
+
+Instructions that allow the Bundler team to reproduce your issue are vitally important. When you report a bug, please create a gist of the following information and include a link in your ticket:
+
+  - What version of bundler you are using
+  - What version of Ruby you are using
+  - Whether you are using RVM, and if so what version
+  - Your Gemfile
+  - Your Gemfile.lock
+  - If you are on 0.9, whether you have locked or not
+  - If you are on 1.0, the result of `bundle config`
+  - The command you ran to generate exception(s)
+  - The exception backtrace(s)
+
+If you are using Rails 2.3, please also include:
+
+  - Your boot.rb file
+  - Your preinitializer.rb file
+  - Your environment.rb file

data/README.md

@@ -1,5 +1,3 @@
-### Note: the master branch is currently unstable while 1.0 is in beta.<br>The current stable version of bundler is in the branch named `v0.9`.
-
 ## Bundler : A gem to bundle gems
 
 Bundler is a tool that manages gem dependencies for your ruby application. It
@@ -12,38 +10,6 @@ you run any ruby code in context of the bundle's gem environment.
 
 See [gembundler.com](http://gembundler.com) for up-to-date installation and usage instructions
 
-## Gem dependency resolution
-
-One of the most important things that the bundler does is do a
-dependency resolution on the full list of gems that you specify, all
-at once. This differs from the one-at-a-time dependency resolution that
-Rubygems does, which can result in the following problem:
-
-    # On my system:
-    #   activesupport 3.0.pre
-    #   activesupport 2.3.4
-    #   activemerchant 1.4.2
-    #   rails 2.3.4
-    #
-    # activemerchant 1.4.2 depends on activesupport >= 2.3.2
-
-    gem "activemerchant", "1.4.2"
-    # results in activating activemerchant, as well as
-    # activesupport 3.0.pre, since it is >= 2.3.2
-
-    gem "rails", "2.3.4"
-    # results in:
-    #   can't activate activesupport (= 2.3.4, runtime)
-    #   for ["rails-2.3.4"], already activated
-    #   activesupport-3.0.pre for ["activemerchant-1.4.2"]
-
-This is because activemerchant has a broader dependency, which results
-in the activation of a version of activesupport that does not satisfy
-a more narrow dependency.
-
-Bundler solves this problem by evaluating all dependencies at once,
-so it can detect that all gems *together* require activesupport "2.3.4".
-
 ## Upgrading from Bundler 0.8 to 0.9 and above
 
 Upgrading to Bundler 0.9 from Bundler 0.8 requires upgrading several
@@ -114,39 +80,12 @@ Bundler 0.9 changes the following Bundler 0.8 Gemfile APIs:
 
 ### Development
 
-For information about future plans and changes that will happen between now and bundler 1.0, see the [ROADMAP](http://github.com/carlhuda/bundler/blob/master/ROADMAP.md). To see what has changed in each version of bundler, starting with 0.9.5, see the [CHANGELOG](http://github.com/carlhuda/bundler/blob/master/CHANGELOG.md).
-
-### Deploying to memory-constrained servers
-
-When deploying to a server that is memory-constrained, like Dreamhost, you should run `bundle package` on your local development machine, and then check in the resulting `Gemfile.lock` file and `vendor/cache` directory. The lockfile and cached gems will mean bundler can just install the gems immediately, without contacting any gem servers or using a lot of memory to resolve the dependency tree. On the server, you only need to run `bundle install` after you update your deployed code.
+For information about future plans and changes that will happen in the future, see the [ROADMAP](http://github.com/carlhuda/bundler/blob/master/ROADMAP.md). To see what has changed in each version of bundler, starting with 0.9.5, see the [CHANGELOG](http://github.com/carlhuda/bundler/blob/master/CHANGELOG.md).
 
 ### Other questions
 
 Any remaining questions may be asked via IRC in [#bundler](irc://irc.freenode.net/bundler) on Freenode, or via email on the [Bundler mailing list](http://groups.google.com/group/ruby-bundler).
 
-## Reporting bugs
-
-Before reporting a bug, try these troubleshooting steps:
-
-    rm -rf ~/.bundle/ ~/.gem/ .bundle/ Gemfile.lock
-    bundle install
-
-If you are still having problems, please report bugs to the github issue tracker for the project, located at [http://github.com/carlhuda/bundler/issues/](http://github.com/carlhuda/bundler/issues/).
-
-The best possible scenario is a ticket with a fix for the bug and a test for the fix. If that's not possible, instructions to reproduce the issue are vitally important. If you're not sure exactly how to reproduce the issue that you are seeing, create a gist of the following information and include it in your ticket:
-
-  - What version of bundler you are using
-  - What version of Ruby you are using
-  - Whether you are using RVM, and if so what version
-  - Your Gemfile
-  - Your Gemfile.lock
-  - If you are on 0.9, whether you have locked or not
-  - If you are on 1.0, the result of `bundle config`
-  - The command you ran to generate exception(s)
-  - The exception backtrace(s)
-
-If you are using Rails 2.3, please also include:
+### Issues
 
-  - Your boot.rb file
-  - Your preinitializer.rb file
-  - Your environment.rb file
+See [ISSUES](http://github.com/carlhuda/bundler/blob/master/ISSUES.md).

data/lib/bundler.rb

@@ -1,3 +1,4 @@
+require 'rbconfig'
 require 'fileutils'
 require 'pathname'
 require 'yaml'
@@ -38,13 +39,17 @@ module Bundler
   class GemfileError     < BundlerError; status_code(4)  ; end
   class PathError        < BundlerError; status_code(13) ; end
   class GitError         < BundlerError; status_code(11) ; end
-  class GemspecError     < BundlerError; status_code(14) ; end
   class DeprecatedError  < BundlerError; status_code(12) ; end
   class GemspecError     < BundlerError; status_code(14) ; end
   class DslError         < BundlerError; status_code(15) ; end
   class ProductionError  < BundlerError; status_code(16) ; end
   class InvalidOption    < DslError                      ; end
 
+
+  WINDOWS = RbConfig::CONFIG["host_os"] =~ %r!(msdos|mswin|djgpp|mingw)!
+  NULL    = WINDOWS ? "NUL" : "/dev/null"
+
+
   class VersionConflict  < BundlerError
     attr_reader :conflicts
 
@@ -186,9 +191,6 @@ module Bundler
       SharedHelpers.default_lockfile
     end
 
-    WINDOWS = Config::CONFIG["host_os"] =~ %r!(msdos|mswin|djgpp|mingw)!
-    NULL    = WINDOWS ? "NUL" : "/dev/null"
-
     def requires_sudo?
       path = bundle_path
       path = path.parent until path.exist?
@@ -199,7 +201,7 @@ module Bundler
 
     def mkdir_p(path)
       if requires_sudo?
-        sudo "mkdir -p '#{path}'"
+        sudo "mkdir -p '#{path}'" unless File.exist?(path)
       else
         FileUtils.mkdir_p(path)
       end
@@ -209,6 +211,32 @@ module Bundler
       `sudo -p 'Enter your password to install the bundled RubyGems to your system: ' #{str}`
     end
 
+    def load_gemspec(file)
+      path = Pathname.new(file)
+      # Eval the gemspec from its parent directory
+      Dir.chdir(path.dirname) do
+        begin
+          Gem::Specification.from_yaml(path.basename)
+          # Raises ArgumentError if the file is not valid YAML
+        rescue ArgumentError, SyntaxError, Gem::EndOfYAMLException, Gem::Exception
+          begin
+            eval(File.read(path.basename), TOPLEVEL_BINDING, path.expand_path.to_s)
+          rescue LoadError => e
+            original_line = e.backtrace.find { |line| line.include?(path.to_s) }
+            msg  = "There was a LoadError while evaluating #{path.basename}:\n  #{e.message}"
+            msg << " from\n  #{original_line}" if original_line
+            msg << "\n"
+
+            if RUBY_VERSION >= "1.9.0"
+              msg << "\nDoes it try to require a relative path? That doesn't work in Ruby 1.9."
+            end
+
+            raise GemspecError, msg
+          end
+        end
+      end
+    end
+
   private
 
     def configure_gem_home_and_path

data/lib/bundler/capistrano.rb

@@ -1,15 +1,36 @@
 # Capistrano task for Bundler.
 #
-# Just add "require 'bundler/capistrano'" in your Capistrano deploy.rb, and Bundler
-# will be activated after each new deployment. To configure the directory that
-# Bundler will install to, set :bundle_dir before deploy:update_code runs.
+# Just add "require 'bundler/capistrano'" in your Capistrano deploy.rb, and
+# Bundler will be activated after each new deployment.
 
 Capistrano::Configuration.instance(:must_exist).load do
   after "deploy:update_code", "bundle:install"
 
   namespace :bundle do
-    task :install do
-      run "bundle install --gemfile #{release_path}/Gemfile --path #{fetch(:bundle_dir, '#{shared_path}/bundle')} --deployment --without development test"
+    desc <<-DESC
+      Install the current Bundler environment. By default, gems will be \
+      installed to the shared/bundle path. Gems in the development and \
+      test group will not be installed. The install command is executed \
+      with the --deployment and --quiet flags. You can override any of \
+      these defaults by setting the variables shown below.
+
+        set :bundle_gemfile,      "Gemfile"
+        set :bundle_dir,          fetch(:shared_path)+"/bundle"
+        set :bundle_flags,       "--deployment --quiet"
+        set :bundle_without,      [:development, :test]
+    DESC
+    task :install, :except => { :no_release => true } do
+      bundle_dir     = fetch(:bundle_dir,         " #{fetch(:shared_path)}/bundle")
+      bundle_without = [*fetch(:bundle_without,   [:development, :test])].compact
+      bundle_flags   = fetch(:bundle_flags, "--deployment --quiet")
+      bundle_gemfile = fetch(:bundle_gemfile,     "Gemfile")
+
+      args = ["--gemfile #{fetch(:latest_release)}/#{bundle_gemfile}"]
+      args << "--path #{bundle_dir}" unless bundle_dir.to_s.empty?
+      args << bundle_flags.to_s
+      args << "--without #{bundle_without.join(" ")}" unless bundle_without.empty?
+
+      run "bundle install #{args.join(' ')}"
     end
   end
 end

data/lib/bundler/cli.rb

@@ -23,6 +23,38 @@ module Bundler
     default_task :install
     class_option "no-color", :type => :boolean, :banner => "Disable colorization in output"
 
+    def help(cli = nil)
+      case cli
+      when "gemfile" then command = "gemfile.5"
+      when nil       then command = "bundle"
+      else command = "bundle-#{cli}"
+      end
+
+      manpages = %w(
+          bundle
+          bundle-config
+          bundle-exec
+          bundle-install
+          bundle-package
+          bundle-update
+          gemfile.5)
+
+      if manpages.include?(command)
+        root = File.expand_path("../man", __FILE__)
+
+        if have_groff?
+          groff   = "groff -Wall -mtty-char -mandoc -Tascii"
+          pager   = ENV['MANPAGER'] || ENV['PAGER'] || 'more'
+
+          Kernel.exec "#{groff} #{root}/#{command} | #{pager}"
+        else
+          puts File.read("#{root}/#{command}.txt")
+        end
+      else
+        super
+      end
+    end
+
     desc "init", "Generates a Gemfile into the current working directory"
     long_desc <<-D
       Init generates a default Gemfile in the current working directory. When adding a
@@ -296,9 +328,11 @@ module Bundler
         Kernel.exec(*ARGV)
       rescue Errno::EACCES
         Bundler.ui.error "bundler: not executable: #{ARGV.first}"
+        exit 126
       rescue Errno::ENOENT
         Bundler.ui.error "bundler: command not found: #{ARGV.first}"
         Bundler.ui.warn  "Install missing gem binaries with `bundle install`"
+        exit 127
       end
     end
 
@@ -428,8 +462,9 @@ module Bundler
 
       constant_name = name.split('_').map{|p| p.capitalize}.join
       constant_name = constant_name.split('-').map{|q| q.capitalize}.join('::') if constant_name =~ /-/
+      constant_array = constant_name.split('::')
       FileUtils.mkdir_p(File.join(target, 'lib', name))
-      opts = {:name => name, :constant_name => constant_name}
+      opts = {:name => name, :constant_name => constant_name, :constant_array => constant_array}
       template(File.join('newgem', 'Gemfile.tt'),                     File.join(target, 'Gemfile'),                 opts)
       template(File.join('newgem', 'Rakefile.tt'),                    File.join(target, 'Rakefile'),                opts)
       template(File.join('newgem', 'gitignore.tt'),                   File.join(target, '.gitignore'),              opts)
@@ -446,6 +481,11 @@ module Bundler
 
   private
 
+    def have_groff?
+      `which groff 2>#{NULL}`
+      $? == 0
+    end
+
     def locate_gem(name)
       spec = Bundler.load.specs.find{|s| s.name == name }
       raise GemNotFound, "Could not find gem '#{name}' in the current bundle." unless spec

data/lib/bundler/dsl.rb

@@ -24,6 +24,7 @@ module Bundler
       path              = opts && opts[:path] || '.'
       name              = opts && opts[:name] || '*'
       development_group = opts && opts[:development_group] || :development
+      path              = File.expand_path(path, Bundler.default_gemfile.dirname)
       gemspecs = Dir[File.join(path, "#{name}.gemspec")]
 
       case gemspecs.size

data/lib/bundler/gem_helper.rb

@@ -7,26 +7,28 @@ module Bundler
       GemHelper.new(dir, opts && opts[:name]).install
     end
 
-    attr_reader :spec_path, :base, :name
+    attr_reader :spec_path, :base, :gemspec
 
     def initialize(base, name = nil)
       @base = base
-      @name = name || determine_name or raise("Cannot automatically determine the name of your gem. Use :name => 'gemname' in #install_tasks to manually set it.")
-      @spec_path = File.join(@base, "#{@name}.gemspec")
+      gemspecs = name ? [File.join(base, "#{name}.gemspec")] : Dir[File.join(base, "*.gemspec")]
+      raise "Unable to determine name from existing gemspec. Use :name => 'gemname' in #install_tasks to manually set it." unless gemspecs.size == 1
+      @spec_path = gemspecs.first
+      @gemspec = Bundler.load_gemspec(@spec_path)
     end
 
     def install
-      desc "Build #{name}-#{current_version}.gem into the pkg directory"
+      desc "Build #{name}-#{version}.gem into the pkg directory"
       task 'build' do
         build_gem
       end
 
-      desc "Build and install #{name}-#{current_version}.gem into system gems"
+      desc "Build and install #{name}-#{version}.gem into system gems"
       task 'install' do
         install_gem
       end
 
-      desc "Create tag #{current_version_tag} and build and push #{name}-#{current_version}.gem to Rubygems"
+      desc "Create tag #{version_tag} and build and push #{name}-#{version}.gem to Rubygems"
       task 'push' do
         push_gem
       end
@@ -66,20 +68,13 @@ module Bundler
       Dir[File.join(base, "#{name}-*.gem")].sort_by{|f| File.mtime(f)}.last
     end
 
-    def determine_name
-      gemspecs = Dir[File.join(base, "*.gemspec")]
-      raise "Unable to determine name from existing gemspec." unless gemspecs.size == 1
-
-      Gem::Specification.load(File.join(base, File.basename(gemspecs.first)[/^.*\.gemspec$/])).name
-    end
-
     def git_push
       sh "git push --all"
       sh "git push --tags"
     end
 
     def guard_already_tagged
-      if sh('git tag').split(/\n/).include?(current_version_tag)
+      if sh('git tag').split(/\n/).include?(version_tag)
         raise("This tag has already been committed to the repo.")
       end
     end
@@ -93,26 +88,23 @@ module Bundler
     end
 
     def tag_version
-      sh "git tag #{current_version_tag}"
+      sh "git tag -am 'Version #{version}' #{version_tag}"
       yield if block_given?
     rescue
-      sh "git tag -d #{current_version_tag}"
+      sh "git tag -d #{version_tag}"
       raise
     end
 
-    def current_version
-      unless File.exist?(version_file_path)
-        raise("Version file could not be found at #{version_file_path}")
-      end
-      File.read(version_file_path)[/V(ERSION|ersion)\s*=\s*(["'])(.*?)\2/, 3]
+    def version
+      gemspec.version
     end
 
-    def version_file_path
-      File.join(base, 'lib', name, 'version.rb')
+    def version_tag
+      "v#{version}"
     end
 
-    def current_version_tag
-      "v#{current_version}"
+    def name
+      gemspec.name
     end
 
     def sh(cmd, &block)
@@ -132,4 +124,4 @@ module Bundler
       [output, $?]
     end
   end
-end
+end

data/lib/bundler/man/bundle

@@ -0,0 +1,96 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "BUNDLE" "1" "August 2010" "" ""
+.
+.SH "NAME"
+\fBbundle\fR \- Ruby Dependency Management
+.
+.SH "SYNOPSIS"
+\fBbundle\fR [\-\-no\-color] COMMAND [ARGS]
+.
+.SH "DESCRIPTION"
+Bundler manages an \fBapplication\'s dependencies\fR through its entire life across many machines systematically and repeatably\.
+.
+.P
+See the bundler website \fIhttp://gembundler\.com\fR for information on getting started, and Gemfile(5) for more information on the \fBGemfile\fR format\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-\-no\-color\fR
+Prints all output without color
+.
+.SH "BUNDLE COMMANDS"
+We divide \fBbundle\fR subcommands into primary commands and utilities\.
+.
+.SH "PRIMARY COMMANDS"
+.
+.TP
+bundle install(1) \fIbundle\-install\.1\.html\fR
+Install the gems specified by the \fBGemfile\fR or \fBGemfile\.lock\fR
+.
+.TP
+bundle update(1) \fIbundle\-update\.1\.html\fR
+Update dependencies to their latest versions
+.
+.TP
+bundle package(1) \fIbundle\-package\.1\.html\fR
+Package the \.gem files required by your application into the \fBvendor/cache\fR directory
+.
+.TP
+bundle exec(1) \fIbundle\-exec\.1\.html\fR
+Execute a script in the context of the current bundle
+.
+.TP
+bundle config(1) \fIbundle\-config\.1\.html\fR
+Specify and read configuration options for bundler
+.
+.SH "UTILITIES"
+.
+.TP
+\fBbundle check(1)\fR
+Determine whether the requirements for your application are installed and available to bundler
+.
+.TP
+\fBbundle list(1)\fR
+Show all of the gems in the current bundle
+.
+.TP
+\fBbundle show(1)\fR
+Show the source location of a particular gem in the bundle
+.
+.TP
+\fBbundle console(1)\fR
+Start an IRB session in the context of the current bundle
+.
+.TP
+\fBbundle open(1)\fR
+Open an installed gem in the editor
+.
+.TP
+\fBbundle viz(1)\fR
+Generate a visual representation of your dependencies
+.
+.TP
+\fBbundle init(1)\fR
+Generate a simple \fBGemfile\fR, placed in the current directory
+.
+.TP
+\fBbundle gem(1)\fR
+Create a simple gem, suitable for development with bundler
+.
+.SH "OBSOLETE"
+These commands are obsolete and should no longer be used
+.
+.IP "\(bu" 4
+\fBbundle lock(1)\fR
+.
+.IP "\(bu" 4
+\fBbundle unlock(1)\fR
+.
+.IP "\(bu" 4
+\fBbundle cache(1)\fR
+.
+.IP "" 0
+