gemika 0.2.0 → 0.3.0

data/lib/gemika/database.rb

@@ -1,7 +1,12 @@
 require 'yaml'
+require 'active_record'
 require 'gemika/env'
+require 'gemika/errors'
 
 module Gemika
+  ##
+  # Helpers for creating a test database.
+  #
   class Database
 
     class Error < StandardError; end
@@ -20,6 +25,9 @@ module Gemika
       @connected = false
     end
 
+    ##
+    # Connects ActiveRecord to the database configured in `spec/support/database.yml`.
+    #
     def connect
       unless @connected
         ActiveRecord::Base.establish_connection(adapter_config)
@@ -27,6 +35,9 @@ module Gemika
       end
     end
 
+    ##
+    # Drops all tables from the current database.
+    #
     def drop_tables!
       connect
       connection.tables.each do |table|
@@ -34,28 +45,52 @@ module Gemika
       end
     end
 
+    ##
+    # Runs the [ActiveRecord database migration](http://api.rubyonrails.org/classes/ActiveRecord/Migration.html) described in `block`.
+    #
+    # @example
+    #   Gemika::Database.new.migrate do
+    #     create_table :users do |t|
+    #       t.string :name
+    #       t.string :email
+    #       t.string :city
+    #     end
+    #  end
     def migrate(&block)
       connect
       ActiveRecord::Migration.class_eval(&block)
     end
 
+    ##
+    # Drops all tables,  then
+    # runs the [ActiveRecord database migration](http://api.rubyonrails.org/classes/ActiveRecord/Migration.html) described in `block`.
+    #
+    # @example
+    #   Gemika::Database.new.rewrite_schema! do
+    #     create_table :users do |t|
+    #       t.string :name
+    #       t.string :email
+    #       t.string :city
+    #     end
+    #  end
     def rewrite_schema!(&block)
       connect
       drop_tables!
       migrate(&block)
     end
 
-    private
-
+    ##
+    # Returns a hash of ActiveRecord adapter options for the currently activated database gem.
+    #
     def adapter_config
       default_config = {}
       default_config['database'] = guess_database_name
-      if Env.pg?
+      if Env.gem?('pg')
         default_config['adapter'] = 'postgresql'
         default_config['username'] = 'postgres' if Env.travis?
         default_config['password'] = ''
         user_config = @yaml_config['postgresql'] || @yaml_config['postgres'] || @yaml_config['pg'] || {}
-      elsif Env.mysql2?
+      elsif Env.gem?('mysql2')
         default_config['adapter'] = 'mysql2'
         default_config['username'] = 'travis' if Env.travis?
         default_config['encoding'] = 'utf8'
@@ -66,6 +101,8 @@ module Gemika
       default_config.merge(user_config)
     end
 
+    private
+
     def guess_database_name
       project_name = File.basename(Dir.pwd)
       "#{project_name}_test"

data/lib/gemika/env.rb

@@ -1,84 +1,126 @@
+require 'rubygems'
+require 'gemika/errors'
+
 module Gemika
+  ##
+  # Version switches to write code that works with different versions of
+  # Ruby and gem dependencies.
+  #
   module Env
 
-    class Error < StandardError; end
-    class Unknown < Error; end
+    VERSION_PATTERN = /(?:\d+\.)*\d+/
 
+    ##
+    # Returns the path to the gemfile for the current Ruby process.
+    #
     def gemfile
-      ENV['BUNDLE_GEMFILE']
-    end
-
-    def gemfile=(path)
-      ENV['BUNDLE_GEMFILE'] = path
+      if @gemfile_changed
+        @process_gemfile
+      else
+        ENV['BUNDLE_GEMFILE']
+      end
     end
 
+    ##
+    # Changes the gemfile to the given `path`, runs the given `block`, then resets
+    # the gemfile to its original path.
+    #
+    # @example
+    #   Gemika::Env.with_gemfile('gemfiles/Gemfile.rails3') do
+    #     system('rspec spec') or raise 'RSpec failed'
+    #   end
+    #
     def with_gemfile(path, *args, &block)
-      old_gemfile = gemfile
-      self.gemfile = path
-      block.call(*args)
+      # Make sure that if block calls  #gemfile we still return the gemfile for this
+      # process, regardless of what's in ENV temporarily
+      @gemfile_changed = true
+      @process_gemfile = ENV['BUNDLE_GEMFILE']
+      Bundler.with_clean_env do
+        ENV['BUNDLE_GEMFILE'] = path
+        block.call(*args)
+      end
     ensure
-      self.gemfile = old_gemfile
-    end
-
-    def ruby_1_8?
-      RUBY_VERSION.start_with?('1.8.')
-    end
-
-    def pg?
-      gem?('pg')
-    end
-
-    def mysql2?
-      gem?('mysql2')
-    end
-
-    def active_record_2?
-      gem?('activerecord', '< 3')
+      @gemfile_changed = false
+      ENV['BUNDLE_GEMFILE'] = @process_gemfile
+    end
+
+    ##
+    # Check if the given gem was activated by the current gemfile.
+    # It might or might not have been `require`d yet.
+    #
+    # @example
+    #   Gemika::Env.gem?('activerecord')
+    #   Gemika::Env.gem?('activerecord', '= 5.0.0')
+    #   Gemika::Env.gem?('activerecord', '~> 4.2.0')
+    #
+    def gem?(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      name, requirement_string = args
+      if options[:gemfile] && !process_gemfile?(options[:gemfile])
+        gem_in_gemfile?(options[:gemfile], name, requirement_string)
+      else
+        gem_activated?(name, requirement_string)
+      end
     end
 
-    def active_record_3_plus?
-      gem?('activerecord', '>= 3')
+    ##
+    # Returns the current version of Ruby.
+    #
+    def ruby
+      RUBY_VERSION
     end
 
-    def rspec_1?
-      gem?('rspec', '< 2')
+    ##
+    # Check if the current version of Ruby satisfies the given requirements.
+    #
+    # @example
+    #   Gemika::Env.ruby?('>= 2.1.0')
+    #
+    def ruby?(requirement)
+      requirement_satisfied?(requirement, ruby)
     end
 
-    def rspec_2_plus?
-      gem?('rspec', '>= 2')
+    ##
+    # Returns whether this process is running within a TravisCI build.
+    #
+    def travis?
+      !!ENV['TRAVIS']
     end
 
-    def rspec_binary
-      if rspec_1?
-        'spec'
-      elsif rspec_2_plus?
-        'rspec'
+    ##
+    # Creates an hash that enumerates entries in order of insertion.
+    #
+    # @!visibility private
+    #
+    def new_ordered_hash
+      # We use it when ActiveSupport is activated
+      if ruby?('>= 1.9')
+        {}
+      elsif gem?('activesupport')
+        require 'active_support/ordered_hash'
+        ActiveSupport::OrderedHash.new
       else
-        raise Unknown, 'Unknown rspec version'
+        # We give up
+        {}
       end
     end
 
-    def rspec_1_in_gemfile?(gemfile)
-      lockfile = "#{gemfile}.lock"
-      contents = File.read(lockfile)
-      contents =~ /\brspec \(1\./
+    private
+
+    def bundler?
+      !gemfile.nil? && gemfile != ''
     end
 
-    def rspec_binary_for_gemfile(gemfile)
-      if rspec_1_in_gemfile?(gemfile)
-        'spec'
-      else
-        'rspec'
-      end
+    def process_gemfile?(given_gemfile)
+      bundler? && File.expand_path(gemfile) == File.expand_path(given_gemfile)
     end
 
-    def gem?(name, requirement_string = nil)
+    def gem_activated?(name, requirement)
       gem = Gem.loaded_specs[name]
       if gem
-        if requirement_string
-          requirement = Gem::Requirement.new(requirement_string)
+        if requirement
           version = gem.version
-          gem_requirement_satisfied_by_version?(requirement, version)
+          requirement_satisfied?(requirement, version)
         else
           true
         end
@@ -87,29 +129,39 @@ module Gemika
       end
     end
 
-    def travis?
-      !!ENV['TRAVIS']
-    end
-
-    def new_ordered_hash
-      if defined?(ActiveSupport::OrderedHash)
-        ActiveSupport::OrderedHash.new
+    def gem_in_gemfile?(gemfile, name, requirement = nil)
+      lockfile = lockfile_contents(gemfile)
+      if lockfile =~ /\b#{Regexp.escape(name)}\s*\((#{VERSION_PATTERN})\)/
+        version = $1
+        if requirement
+          requirement_satisfied?(requirement, version)
+        else
+          true
+        end
       else
-        {}
+        false
       end
     end
 
-    private
-
-    def gem_requirement_satisfied_by_version?(requirement, version)
-      if Env.ruby_1_8?
+    def requirement_satisfied?(requirement, version)
+      requirement = Gem::Requirement.new(requirement) if requirement.is_a?(String)
+      version = Gem::Version.new(version) if version.is_a?(String)
+      if requirement.respond_to?(:satisfied_by?) # Ruby 1.9.3+
+        requirement.satisfied_by?(version)
+      else
         ops = Gem::Requirement::OPS
         requirement.requirements.all? { |op, rv| (ops[op] || ops["="]).call version, rv }
-      else
-        requirement.satisfied_by?(version)
       end
     end
 
+    def lockfile_contents(gemfile)
+      lockfile = "#{gemfile}.lock"
+      File.exists?(lockfile) or raise MissingLockfile, "Lockfile not found: #{lockfile}"
+      File.read(lockfile)
+    end
+
+    # Make all methods available as static module methods
     extend self
+
   end
 end

data/lib/gemika/errors.rb

@@ -0,0 +1,9 @@
+module Gemika
+  class Error < StandardError; end
+  class MissingGemfile < Error; end
+  class MissingLockfile < Error; end
+  class UnusableGemfile < Error; end
+  class UnsupportedRuby < Error; end
+  class MatrixFailed < Error; end
+  class RSpecFailed < Error; end
+end

data/lib/gemika/matrix.rb

@@ -1,14 +1,15 @@
 require 'yaml'
+require 'gemika/errors'
 require 'gemika/env'
 
 module Gemika
   class Matrix
 
-    class Error < StandardError; end
-    class Invalid < Error; end
-    class Failed < Error; end
-    class Incompatible < Error; end
-
+    ##
+    # Load `.travis.yml` files.
+    #
+    # @!visibility private
+    #
     class TravisConfig
       class << self
 
@@ -37,6 +38,9 @@ module Gemika
       end
     end
 
+    ##
+    # A row in the test matrix
+    #
     class Row
 
       def initialize(attrs)
@@ -44,16 +48,32 @@ module Gemika
         @gemfile = attrs.fetch(:gemfile)
       end
 
-      attr_reader :ruby, :gemfile
+      ##
+      # The Ruby version for the row.
+      #
+      attr_reader :ruby
+
+      ##
+      # The path to the gemfile for the row.
+      #
+      attr_reader :gemfile
 
-      def compatible_with_ruby?(current_ruby)
+      ##
+      # Returns whether this row can be run with the given Ruby version.
+      #
+      def compatible_with_ruby?(current_ruby = Env.ruby)
         ruby == current_ruby
       end
 
+      ##
+      # Raises an error if this row is invalid.
+      #
+      # @!visibility private
+      #
       def validate!
-        File.exists?(gemfile) or raise Invalid, "Gemfile not found: #{gemfile}"
+        File.exists?(gemfile) or raise MissingGemfile, "Gemfile not found: #{gemfile}"
         contents = File.read(gemfile)
-        contents.include?('gemika') or raise Invalid, "Gemfile is missing gemika dependency: #{gemfile}"
+        contents.include?('gemika') or raise UnusableGemfile, "Gemfile is missing gemika dependency: #{gemfile}"
       end
 
     end
@@ -77,6 +97,13 @@ module Gemika
       @current_ruby = options.fetch(:current_ruby, RUBY_VERSION)
     end
 
+    ##
+    # Runs the given `block` for each matrix row that is compatible with the current Ruby.
+    #
+    # The row's gemfile will be set as an environment variable, so Bundler will use that gemfile if you shell out in `block`.
+    #
+    # At the end it will print a summary of which rows have passed, failed or were skipped (due to incompatible Ruby version).
+    #
     def each(&block)
       @all_passed = true
       rows.each do |row|
@@ -98,6 +125,12 @@ module Gemika
       print_summary
     end
 
+    ##
+    # Builds a {Matrix} from the given `.travis.yml` file.
+    #
+    # @param [Hash] options
+    # @option options [String] Path to the `.travis.yml` file.
+    #
     def self.from_travis_yml(options = {})
       rows = TravisConfig.load_rows(options)
       new(options.merge(:rows => rows))
@@ -143,7 +176,7 @@ module Gemika
         message = "No gemfiles were compatible with Ruby #{RUBY_VERSION}"
         puts tint(message, COLOR_FAILURE)
         puts
-        raise Incompatible, message
+        raise UnsupportedRuby, message
       elsif @all_passed
         puts tint("All gemfiles succeeded for Ruby #{RUBY_VERSION}", COLOR_SUCCESS)
         puts
@@ -151,7 +184,7 @@ module Gemika
         message = 'Some gemfiles failed'
         puts tint(message, COLOR_FAILURE)
         puts
-        raise Failed, message
+        raise MatrixFailed, message
       end
     end
 

data/lib/gemika/rspec.rb

@@ -1,52 +1,95 @@
+require 'gemika/errors'
+require 'gemika/env'
+
 module Gemika
-  class RSpec
-    class << self
-
-      def configure_transactional_examples
-        if Env.rspec_1?
-
-          Spec::Runner.configure do |config|
-
-            config.before :each do
-              # from ActiveRecord::Fixtures#setup_fixtures
-              connection = ActiveRecord::Base.connection
-              connection.increment_open_transactions
-              connection.transaction_joinable = false
-              connection.begin_db_transaction
-            end
-
-            config.after :each do
-              # from ActiveRecord::Fixtures#teardown_fixtures
-              connection = ActiveRecord::Base.connection
-              if connection.open_transactions != 0
-                connection.rollback_db_transaction
-                connection.decrement_open_transactions
-              end
-            end
-
-          end
-
-        else
-
-          ::RSpec.configure do |config|
-            config.around do |example|
-              if example.metadata.fetch(:transaction, example.metadata.fetch(:rollback, true))
-                ActiveRecord::Base.transaction do
-                  begin
-                    example.run
-                  ensure
-                    raise ActiveRecord::Rollback
-                  end
-                end
-              else
-                example.run
-              end
-            end
-          end
+  module RSpec
+
+    ##
+    # Runs the RSpec binary.
+    #
+    def run_specs(options = nil)
+      options ||= {}
+      files = options.fetch(:files, 'spec')
+      rspec_options = options.fetch(:options, '--color')
+      # We need to override the gemfile explicitely, since we have a default Gemfile in the project root
+      gemfile = options.fetch(:gemfile, Gemika::Env.gemfile)
+      fatal = options.fetch(:fatal, true)
+      runner = binary(:gemfile => gemfile)
+      command = "bundle exec #{runner} #{rspec_options} #{files}"
+      result = shell_out(command)
+      if result
+        true
+      elsif fatal
+        raise RSpecFailed, "RSpec failed: #{command}"
+      else
+        false
+      end
+    end
+
+    ##
+    # Returns the binary name for the current RSpec version.
+    #
+    def binary(options = {})
+      if Env.gem?('rspec', '< 2', options)
+        'spec'
+      else
+        'rspec'
+      end
+    end
+
+    ##
+    # Configures RSpec.
+    #
+    # Works with both RSpec 1 and RSpec 2.
+    #
+    def configure(&block)
+      configurator.configure(&block)
+    end
+
+    ##
+    # Configures RSpec to clean out the database before each example.
+    #
+    # Requires the `database_cleaner` gem to be added to your development dependencies.
+    #
+    def configure_clean_database_before_example
+      require 'database_cleaner' # optional dependency
+      configure do |config|
+        config.before(:each) do
+          # Truncation works across most database adapters; I had issues with :deletion and pg
+          DatabaseCleaner.clean_with(:truncation)
+        end
+      end
+    end
 
+    ##
+    # Configures RSpec so it allows the `should` syntax that works across all RSpec versions.
+    #
+    def configure_should_syntax
+      if Env.gem?('rspec', '>= 2.11')
+        configure do |config|
+          config.expect_with(:rspec) { |c| c.syntax = [:should, :expect] }
+          config.mock_with(:rspec) { |c| c.syntax = [:should, :expect] }
         end
+      else
+        # We have an old RSpec that only understands should syntax
       end
+    end
+
+    private
 
+    def shell_out(command)
+      system(command)
     end
+
+    def configurator
+      if Env.gem?('rspec', '<2')
+        Spec::Runner
+      else
+        ::RSpec
+      end
+    end
+
+    extend self
+
   end
 end

data/lib/gemika/tasks/matrix.rb

@@ -1,46 +1,40 @@
+require 'gemika/env'
 require 'gemika/matrix'
+require 'gemika/rspec'
 
-module Gemika
-  module Tasks
-    RSPEC_ARGS = '--color spec'
-  end
-end
-
+##
+# Rake tasks to run commands for each compatible row in the test matrix.
+#
 namespace :matrix do
 
   desc "Run specs for all Ruby #{RUBY_VERSION} gemfiles"
-  task :spec do
+  task :spec, :files do |t, options|
     Gemika::Matrix.from_travis_yml.each do |row|
-      rspec_binary = Gemika::Env.rspec_binary_for_gemfile(row.gemfile)
-      args = Gemika::Tasks::RSPEC_ARGS
-      system("bundle exec #{rspec_binary} #{args}")
+      options = options.to_hash.merge(:gemfile => row.gemfile, :fatal => false)
+      Gemika::RSpec.run_specs(options)
     end
   end
 
   desc "Install all Ruby #{RUBY_VERSION} gemfiles"
   task :install do
     Gemika::Matrix.from_travis_yml.each do |row|
+      puts "Calling `bundle install` with #{ENV['BUNDLE_GEMFILE']}"
       system('bundle install')
     end
   end
 
-  desc "Update all Ruby #{RUBY_VERSION} gemfiles"
-  task :update, :gems do |t, args|
+  desc "List dependencies for all Ruby #{RUBY_VERSION} gemfiles"
+  task :list do
     Gemika::Matrix.from_travis_yml.each do |row|
-      system("bundle update #{args[:gems]}")
+      system('bundle list')
     end
   end
 
-end
-
-namespace :gemika do
-
-  # Private task to pick the correct RSpec binary
-  # (spec in RSpec 1, rspec in RSpec 2+)
-  task :spec do
-    rspec_binary = Gemika::Env.rspec_binary
-    args = Gemika::Tasks::RSPEC_ARGS
-    system("bundle exec #{rspec_binary} #{args}")
+  desc "Update all Ruby #{RUBY_VERSION} gemfiles"
+  task :update, :gems do |t, options|
+    Gemika::Matrix.from_travis_yml.each do |row|
+      system("bundle update #{options[:gems]}")
+    end
   end
 
 end

data/lib/gemika/tasks/rspec.rb

@@ -0,0 +1,9 @@
+require 'gemika/rspec'
+
+# Private task to pick the correct RSpec binary for the currently activated
+# RSpec version (`spec` in RSpec 1, `rspec` in RSpec 2+)
+desc 'Run specs with the current RSpec version'
+task :current_rspec, :files do |t, options|
+  options = options.to_hash
+  Gemika::RSpec.run_specs(options)
+end

data/lib/gemika/tasks.rb

@@ -1,2 +1,2 @@
 require 'gemika/tasks/matrix'
-require 'gemika/tasks/database'
+require 'gemika/tasks/rspec'

data/lib/gemika/version.rb

@@ -1,3 +1,3 @@
 module Gemika
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end