appraisal 0.5.2 → 1.0.0.beta1

data/features/support/dependency_helpers.rb

@@ -0,0 +1,29 @@
+module DependencyHelpers
+  def build_gem(name, version)
+    create_dir(name)
+    cd(name)
+    create_dir("lib")
+    gem_path = "#{name}.gemspec"
+    version_path = "lib/#{name}.rb"
+    spec = <<-SPEC
+      Gem::Specification.new do |s|
+        s.name    = '#{name}'
+        s.version = '#{version}'
+        s.authors = 'Mr. Smith'
+        s.summary = 'summary'
+        s.files   = '#{version_path}'
+      end
+    SPEC
+    write_file(gem_path, spec)
+    write_file(version_path, "$#{name}_version = '#{version}'")
+    in_current_dir { `gem build #{gem_path} 2>&1` }
+    set_env("GEM_HOME", TMP_GEM_ROOT)
+    in_current_dir { `gem install #{name}-#{version}.gem 2>&1` }
+    FileUtils.rm_rf(File.join(current_dir, name))
+    dirs.pop
+  end
+end
+
+if respond_to?(:World)
+  World(DependencyHelpers)
+end

data/lib/appraisal/appraisal.rb

@@ -1,6 +1,8 @@
 require 'appraisal/gemfile'
 require 'appraisal/command'
+require 'appraisal/utils'
 require 'fileutils'
+require 'pathname'
 
 module Appraisal
   # Represents one appraisal and its dependencies
@@ -18,37 +20,75 @@ module Appraisal
 
     def write_gemfile
       ::File.open(gemfile_path, "w") do |file|
-        file.puts("# This file was generated by Appraisal")
-        file.puts
-        file.write(gemfile.to_s)
+        signature = "# This file was generated by Appraisal"
+        file.puts([signature, gemfile.to_s].reject {|s| s.empty? }.join("\n\n"))
       end
     end
 
-    def install
-      Command.new(bundle_command).run
+    def install(job_size = 1)
+      Command.new(check_command + ' || ' + install_command(job_size)).run
+    end
+
+    def update(gems = [])
+      Command.new(update_command(gems)).run
     end
 
     def gemfile_path
-      unless ::File.exist?(gemfile_root)
-        FileUtils.mkdir(gemfile_root)
+      unless gemfile_root.exist?
+        gemfile_root.mkdir
       end
 
-      ::File.join(gemfile_root, "#{clean_name}.gemfile")
+      gemfile_root.join("#{clean_name}.gemfile").to_s
     end
 
-    def bundle_command
-      gemfile = "--gemfile='#{gemfile_path}'"
-      "bundle check #{gemfile} || bundle install #{gemfile}"
+    def relativize
+      current_directory = Pathname.new(Dir.pwd)
+      relative_path = current_directory.relative_path_from(gemfile_root).cleanpath
+      lockfile_content = ::File.read(lockfile_path)
+
+      ::File.open(lockfile_path, 'w') do |file|
+        file.write lockfile_content.gsub(/#{current_directory}/, relative_path.to_s)
+      end
     end
 
     private
 
+    def check_command
+      gemfile_option = "--gemfile='#{gemfile_path}'"
+      ['bundle', 'check', gemfile_option].join(' ')
+    end
+
+    def install_command(job_size)
+      gemfile_option = "--gemfile='#{gemfile_path}'"
+      ['bundle', 'install', gemfile_option, bundle_parallel_option(job_size)].compact.join(' ')
+    end
+
+    def update_command(gems)
+      gemfile_config = "BUNDLE_GEMFILE='#{gemfile_path}'"
+      [gemfile_config, 'bundle', 'update', *gems].compact.join(' ')
+    end
+
     def gemfile_root
-      ::File.join(Dir.pwd, "gemfiles")
+      Pathname.new(::File.join(Dir.pwd, "gemfiles"))
+    end
+
+    def lockfile_path
+      "#{gemfile_path}.lock"
     end
 
     def clean_name
       name.gsub(/[^\w\.]/, '_')
     end
+
+    def bundle_parallel_option(job_size)
+      if job_size > 1
+        if Utils.support_parallel_installation?
+          "--jobs=#{job_size}"
+        else
+          warn 'Your current version of Bundler does not support parallel installation. Please ' +
+            'upgrade Bundler to version >= 1.4.0, or invoke `appraisal` without `--jobs` option.'
+        end
+      end
+    end
   end
 end

data/lib/appraisal/cli.rb

@@ -0,0 +1,87 @@
+require 'thor'
+require 'fileutils'
+
+module Appraisal
+  class CLI < Thor
+    default_task :install
+
+    # Override help command to print out usage
+    def self.help(shell, subcommand = false)
+      shell.say strip_heredoc(<<-help)
+        Appraisal: Find out what your Ruby gems are worth.
+
+        Usage:
+          appraisal [APPRAISAL_NAME] EXTERNAL_COMMAND
+
+          If APPRAISAL_NAME is given, only run that EXTERNAL_COMMAND against the given
+          appraisal, otherwise it runs the EXTERNAL_COMMAND against all appraisals.
+
+        Available Appraisal(s):
+      help
+
+      File.each do |appraisal|
+        shell.say "  - #{appraisal.name}"
+      end
+
+      shell.say
+
+      super
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'install', 'Resolve and install dependencies for each appraisal'
+    method_option 'jobs', aliases: 'j', type: :numeric, default: 1, banner: 'SIZE',
+      desc: 'Install gems in parallel using the given number of workers.'
+    def install
+      invoke :generate, [], {}
+
+      File.each do |appraisal|
+        appraisal.install(options[:jobs])
+        appraisal.relativize
+      end
+    end
+
+    desc 'generate', 'Generate a gemfile for each appraisal'
+    def generate
+      File.each do |appraisal|
+        appraisal.write_gemfile
+      end
+    end
+
+    desc 'clean', 'Remove all generated gemfiles and lockfiles from gemfiles folder'
+    def clean
+      FileUtils.rm_f Dir['gemfiles/*.{gemfile,gemfile.lock}']
+    end
+
+    desc 'update [LIST_OF_GEMS]', 'Remove all generated gemfiles and lockfiles, resolve, and install dependencies again'
+    def update(*gems)
+      invoke :generate, []
+
+      File.each do |appraisal|
+        appraisal.update(gems)
+      end
+    end
+
+    private
+
+    def method_missing(name, *args, &block)
+      matching_appraisal = File.new.appraisals.detect { |appraisal| appraisal.name == name.to_s }
+
+      if matching_appraisal
+        Command.new(args.join(' '), matching_appraisal.gemfile_path).run
+      else
+        File.each do |appraisal|
+          Command.new(ARGV.join(' '), appraisal.gemfile_path).run
+        end
+      end
+    end
+
+    def self.strip_heredoc(string)
+      indent = string.scan(/^[ \t]*(?=\S)/).min.size || 0
+      string.gsub(/^[ \t]{#{indent}}/, '')
+    end
+  end
+end

data/lib/appraisal/command.rb

@@ -4,14 +4,15 @@ module Appraisal
     BUNDLER_ENV_VARS = %w(RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE).freeze
 
     def self.from_args(gemfile)
-      command = ([$0] + ARGV.slice(1, ARGV.size)).join(' ')
+      ARGV.shift
+      command = ([$0] + ARGV).join(' ')
       new(command, gemfile)
     end
 
     def initialize(command, gemfile = nil)
       @original_env = {}
       @gemfile = gemfile
-      if command =~ /^bundle/
+      if command =~ /^(bundle|BUNDLE_GEMFILE)/
         @command = command
       else
         @command = "bundle exec #{command}"
@@ -37,6 +38,7 @@ module Appraisal
     def with_clean_env
       unset_bundler_env_vars
       ENV['BUNDLE_GEMFILE'] = @gemfile
+      ENV['APPRAISAL_INITIALIZED'] = '1'
       yield
     ensure
       restore_env

data/lib/appraisal/errors.rb

@@ -0,0 +1,8 @@
+module Appraisal
+  # Raises when Appraisal is unable to locate Appraisals file in the current directory.
+  class AppraisalsNotFound < StandardError
+    def message
+      "Unable to locate 'Appraisals' file in the current directory."
+    end
+  end
+end

data/lib/appraisal/file.rb

@@ -1,8 +1,9 @@
 require 'appraisal/appraisal'
+require 'appraisal/errors'
 require 'appraisal/gemfile'
 
 module Appraisal
-  # Loads and parses Appraisal files
+  # Loads and parses Appraisals file
   class File
     attr_reader :appraisals, :gemfile
 
@@ -14,7 +15,12 @@ module Appraisal
       @appraisals = []
       @gemfile = Gemfile.new
       @gemfile.load(ENV['BUNDLE_GEMFILE'] || 'Gemfile')
-      run(IO.read(path)) if ::File.exists?(path)
+
+      if ::File.exists? path
+        run IO.read(path)
+      else
+        raise AppraisalsNotFound
+      end
     end
 
     def each(&block)

data/lib/appraisal/gemfile.rb

@@ -8,8 +8,11 @@ module Appraisal
 
     def initialize
       @sources = []
+      @ruby_version = nil
       @dependencies = []
       @gemspec = nil
+      @groups = []
+      @git_sources = []
     end
 
     def load(path)
@@ -17,7 +20,7 @@ module Appraisal
     end
 
     def run(definitions)
-      instance_eval(definitions, __FILE__, __LINE__)
+      instance_eval(definitions, __FILE__, __LINE__) if definitions
     end
 
     def gem(name, *requirements)
@@ -25,25 +28,38 @@ module Appraisal
       @dependencies << Dependency.new(name, requirements)
     end
 
-    def group(*names)
-      # ignore the group
+    def group(*names, &block)
+      require 'appraisal/group'
+
+      group = Group.new(names)
+      group.run(&block)
+      @groups << group
     end
 
     def source(source)
       @sources << source
     end
 
+    def ruby(ruby_version)
+      @ruby_version = ruby_version
+    end
+
+    def git(source, options = {}, &block)
+      require 'appraisal/git_source'
+
+      git_source = GitSource.new(source, options)
+      git_source.run(&block)
+      @git_sources << git_source
+    end
+
     def to_s
-      [source_entry, dependencies_entry, gemspec_entry].join("\n\n")
+      [source_entry, ruby_version_entry, git_sources_entry, dependencies_entry, groups_entry,
+        gemspec_entry].reject{ |s| s.nil? || s.empty? }.join("\n\n").strip
     end
 
     def dup
       gemfile = Gemfile.new
-      @sources.each { |source| gemfile.source(source) }
-      dependencies.each do |dependency|
-        gemfile.gem(dependency.name, *dependency.requirements)
-      end
-      gemfile.gemspec(@gemspec.options) if @gemspec
+      gemfile.run(to_s)
       gemfile
     end
 
@@ -57,8 +73,22 @@ module Appraisal
       @sources.map { |source| "source #{source.inspect}" }.join("\n")
     end
 
+    def ruby_version_entry
+      if @ruby_version
+        "ruby #{@ruby_version.inspect}"
+      end
+    end
+
+    def git_sources_entry
+      @git_sources.map(&:to_s).join("\n\n")
+    end
+
     def dependencies_entry
-      dependencies.map { |dependency| dependency.to_s }.join("\n")
+      dependencies.map(&:to_s).join("\n")
+    end
+
+    def groups_entry
+      @groups.map(&:to_s).join("\n\n")
     end
 
     def gemspec_entry

data/lib/appraisal/gemspec.rb

@@ -9,14 +9,8 @@ module Appraisal
       @options[:path] ||= '.'
     end
 
-    def exists?
-      Dir[::File.join(@options[:path], "*.gemspec")].size > 0
-    end
-
     def to_s
-      if exists?
-        "gemspec #{exported_options.inspect.gsub(/^\{|\}$/, '')}"
-      end
+      "gemspec #{exported_options.inspect.gsub(/^\{|\}$/, '')}"
     end
 
     private

data/lib/appraisal/git_source.rb

@@ -0,0 +1,23 @@
+module Appraisal
+  class GitSource < Gemfile
+    def initialize(source, options = {})
+      super()
+      @source = source
+      @options = options
+    end
+
+    def run(&block)
+      instance_exec(&block)
+    end
+
+    def to_s
+      dependencies = super.strip.gsub(/^/, '  ')
+
+      if @options.empty?
+        "git #{@source.inspect} do\n#{dependencies}\nend"
+      else
+        "git #{@source.inspect}, #{@options.inspect} do\n#{dependencies}\nend"
+      end
+    end
+  end
+end

data/lib/appraisal/group.rb

@@ -0,0 +1,17 @@
+module Appraisal
+  class Group < Gemfile
+    def initialize(group_names)
+      super()
+      @group_names = group_names
+    end
+
+    def run(&block)
+      instance_exec(&block)
+    end
+
+    def to_s
+      "group #{@group_names.map(&:inspect).join(', ')} do\n" +
+        super.strip.gsub(/^/, '  ') + "\nend"
+    end
+  end
+end

data/lib/appraisal/task.rb

@@ -7,38 +7,40 @@ module Appraisal
   class Task < Rake::TaskLib
     def initialize
       namespace :appraisal do
-        desc "Generate a Gemfile for each appraisal"
+        desc "DEPRECATED: Generate a Gemfile for each appraisal"
         task :gemfiles do
-          File.each do |appraisal|
-            appraisal.write_gemfile
-          end
+          warn "`rake appraisal:gemfile` task is deprecated and will be removed soon. " +
+            "Please use `appraisal generate`."
+          exec 'bundle exec appraisal generate'
         end
 
-        desc "Resolve and install dependencies for each appraisal"
-        task :install => :gemfiles do
-          File.each do |appraisal|
-            appraisal.install
-          end
+        desc "DEPRECATED: Resolve and install dependencies for each appraisal"
+        task :install do
+          warn "`rake appraisal:install` task is deprecated and will be removed soon. " +
+            "Please use `appraisal install`."
+          exec 'bundle exec appraisal install'
         end
 
-        desc "Remove all generated gemfiles from gemfiles/ folder"
+        desc "DEPRECATED: Remove all generated gemfiles from gemfiles/ folder"
         task :cleanup do
-          require 'fileutils'
-          FileUtils.rm_f Dir['gemfiles/*.{gemfile,gemfile.lock}']
+          warn "`rake appraisal:cleanup` task is deprecated and will be removed soon. " +
+            "Please use `appraisal clean`."
+          exec 'bundle exec appraisal clean'
         end
 
         File.each do |appraisal|
-          desc "Run the given task for appraisal #{appraisal.name}"
+          desc "DEPRECATED: Run the given task for appraisal #{appraisal.name}"
           task appraisal.name do
-            Command.from_args(appraisal.gemfile_path).exec
+            ARGV.shift
+            warn "`rake appraisal:#{appraisal.name}` task is deprecated and will be removed soon. " +
+              "Please use `appraisal #{appraisal.name} rake #{ARGV.join(' ')}`."
+            exec "bundle exec appraisal #{appraisal.name} rake #{ARGV.join(' ')}"
           end
         end
 
         task :all do
-          File.each do |appraisal|
-            Command.from_args(appraisal.gemfile_path).run
-          end
-          exit
+          ARGV.shift
+          exec "bundle exec appraisal rake #{ARGV.join(' ')}"
         end
       end