gemika 0.1.4 → 0.2.0

data/lib/gemika/env.rb

@@ -0,0 +1,115 @@
+module Gemika
+  module Env
+
+    class Error < StandardError; end
+    class Unknown < Error; end
+
+    def gemfile
+      ENV['BUNDLE_GEMFILE']
+    end
+
+    def gemfile=(path)
+      ENV['BUNDLE_GEMFILE'] = path
+    end
+
+    def with_gemfile(path, *args, &block)
+      old_gemfile = gemfile
+      self.gemfile = path
+      block.call(*args)
+    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')
+    end
+
+    def active_record_3_plus?
+      gem?('activerecord', '>= 3')
+    end
+
+    def rspec_1?
+      gem?('rspec', '< 2')
+    end
+
+    def rspec_2_plus?
+      gem?('rspec', '>= 2')
+    end
+
+    def rspec_binary
+      if rspec_1?
+        'spec'
+      elsif rspec_2_plus?
+        'rspec'
+      else
+        raise Unknown, 'Unknown rspec version'
+      end
+    end
+
+    def rspec_1_in_gemfile?(gemfile)
+      lockfile = "#{gemfile}.lock"
+      contents = File.read(lockfile)
+      contents =~ /\brspec \(1\./
+    end
+
+    def rspec_binary_for_gemfile(gemfile)
+      if rspec_1_in_gemfile?(gemfile)
+        'spec'
+      else
+        'rspec'
+      end
+    end
+
+    def gem?(name, requirement_string = nil)
+      gem = Gem.loaded_specs[name]
+      if gem
+        if requirement_string
+          requirement = Gem::Requirement.new(requirement_string)
+          version = gem.version
+          gem_requirement_satisfied_by_version?(requirement, version)
+        else
+          true
+        end
+      else
+        false
+      end
+    end
+
+    def travis?
+      !!ENV['TRAVIS']
+    end
+
+    def new_ordered_hash
+      if defined?(ActiveSupport::OrderedHash)
+        ActiveSupport::OrderedHash.new
+      else
+        {}
+      end
+    end
+
+    private
+
+    def gem_requirement_satisfied_by_version?(requirement, version)
+      if Env.ruby_1_8?
+        ops = Gem::Requirement::OPS
+        requirement.requirements.all? { |op, rv| (ops[op] || ops["="]).call version, rv }
+      else
+        requirement.satisfied_by?(version)
+      end
+    end
+
+    extend self
+  end
+end

data/lib/gemika/matrix.rb

@@ -1,8 +1,63 @@
 require 'yaml'
+require 'gemika/env'
 
 module Gemika
   class Matrix
 
+    class Error < StandardError; end
+    class Invalid < Error; end
+    class Failed < Error; end
+    class Incompatible < Error; end
+
+    class TravisConfig
+      class << self
+
+        def load_rows(options)
+          path = options.fetch(:path, '.travis.yml')
+          travis_yml = YAML.load_file(path)
+          rubies = travis_yml.fetch('rvm')
+          gemfiles = travis_yml.fetch('gemfile')
+          matrix_options = travis_yml.fetch('matrix', {})
+          excludes = matrix_options.fetch('exclude', [])
+          rows = []
+          rubies.each do |ruby|
+            gemfiles.each do |gemfile|
+              row = { 'rvm' => ruby, 'gemfile' => gemfile }
+              rows << row unless excludes.include?(row)
+            end
+          end
+          rows = rows.map { |row| convert_row(row) }
+          rows
+        end
+
+        def convert_row(travis_row)
+          Row.new(:ruby => travis_row['rvm'], :gemfile => travis_row['gemfile'])
+        end
+
+      end
+    end
+
+    class Row
+
+      def initialize(attrs)
+        @ruby = attrs.fetch(:ruby)
+        @gemfile = attrs.fetch(:gemfile)
+      end
+
+      attr_reader :ruby, :gemfile
+
+      def compatible_with_ruby?(current_ruby)
+        ruby == current_ruby
+      end
+
+      def validate!
+        File.exists?(gemfile) or raise Invalid, "Gemfile not found: #{gemfile}"
+        contents = File.read(gemfile)
+        contents.include?('gemika') or raise Invalid, "Gemfile is missing gemika dependency: #{gemfile}"
+      end
+
+    end
+
     COLOR_HEAD = "\e[44;97m"
     COLOR_WARNING = "\e[33m"
     COLOR_SUCCESS = "\e[32m"
@@ -11,68 +66,59 @@ module Gemika
 
     def initialize(options)
       @rows = options.fetch(:rows)
-      @rows.each { |row| validate_row(row) }
-      @results = {}
+      @silent = options.fetch(:silent, false)
+      @io = options.fetch(:io, STDOUT)
+      @color = options.fetch(:color, true)
+      validate = options.fetch(:validate, true)
+      @rows.each(&:validate!) if validate
+      @results = Env.new_ordered_hash
+      @compatible_count = 0
       @all_passed = nil
+      @current_ruby = options.fetch(:current_ruby, RUBY_VERSION)
     end
 
     def each(&block)
       @all_passed = true
-      rows.each do |entry|
-        gemfile = entry['gemfile']
-        if compatible?(entry)
+      rows.each do |row|
+        gemfile = row.gemfile
+        if row.compatible_with_ruby?(current_ruby)
+          @compatible_count += 1
           print_title gemfile
-          ENV['BUNDLE_GEMFILE'] = gemfile
-          gemfile_passed = block.call
+          gemfile_passed = Env.with_gemfile(gemfile, row, &block)
           @all_passed &= gemfile_passed
           if gemfile_passed
-            @results[entry] = tint('Success', COLOR_SUCCESS)
+            @results[row] = tint('Success', COLOR_SUCCESS)
           else
-            @results[entry] = tint('Failed', COLOR_FAILURE)
+            @results[row] = tint('Failed', COLOR_FAILURE)
           end
         else
-          @results[entry] = tint("Skipped", COLOR_WARNING)
+          @results[row] = tint("Skipped", COLOR_WARNING)
         end
       end
       print_summary
     end
 
-    def self.from_travis_yml
-      travis_yml = YAML.load_file('.travis.yml')
-      rubies = travis_yml.fetch('rvm')
-      gemfiles = travis_yml.fetch('gemfile')
-      matrix_options = travis_yml.fetch('matrix', {})
-      excludes = matrix_options.fetch('exclude', [])
-      includes = matrix_options.fetch('include', [])
-      rows = []
-      rubies.each do |ruby|
-        gemfiles.each do |gemfile|
-          row = { 'rvm' => ruby, 'gemfile' => gemfile }
-          rows << row unless excludes.include?(row)
-        end
-      end
-      rows += includes
-      new(:rows => rows)
+    def self.from_travis_yml(options = {})
+      rows = TravisConfig.load_rows(options)
+      new(options.merge(:rows => rows))
     end
 
-    def validate_row(row)
-      gemfile = row['gemfile']
-      File.exists?(gemfile) or raise ArgumentError, "Gemfile not found: #{gemfile}"
-      contents = File.read(gemfile)
-      contents.include?('gemika') or raise ArgumentError, "Gemfile is missing gemika dependency: #{gemfile}"
-      row
-    end
+    attr_reader :rows, :current_ruby
 
     private
 
-    attr_reader :rows
-
-    def compatible?(entry)
-      entry['rvm'] == RUBY_VERSION
+    def puts(*args)
+      unless @silent
+        @io.puts(*args)
+      end
     end
 
     def tint(message, color)
-      color + message + COLOR_RESET
+      if @color
+        color + message + COLOR_RESET
+      else
+        message
+      end
     end
 
     def print_title(title)
@@ -84,22 +130,28 @@ module Gemika
     def print_summary
       print_title 'Summary'
 
-      gemfile_size = @results.keys.map { |entry| entry['gemfile'].size }.max
-      ruby_size = @results.keys.map { |entry| entry['rvm'].size }.max
+      gemfile_size = @results.keys.map { |row| row.gemfile.size }.max
+      ruby_size = @results.keys.map { |row| row.ruby.size }.max
 
       @results.each do |entry, result|
-        puts "- #{entry['gemfile'].ljust(gemfile_size)}  Ruby #{entry['rvm'].ljust(ruby_size)}  #{result}"
+        puts "- #{entry.gemfile.ljust(gemfile_size)}  Ruby #{entry.ruby.ljust(ruby_size)}  #{result}"
       end
 
       puts
 
-      if @all_passed
-        puts tint("All gemfiles succeeded for Ruby #{RUBY_VERSION}.", COLOR_SUCCESS)
+      if @compatible_count == 0
+        message = "No gemfiles were compatible with Ruby #{RUBY_VERSION}"
+        puts tint(message, COLOR_FAILURE)
+        puts
+        raise Incompatible, message
+      elsif @all_passed
+        puts tint("All gemfiles succeeded for Ruby #{RUBY_VERSION}", COLOR_SUCCESS)
         puts
       else
-        puts tint('Some gemfiles failed.', COLOR_FAILURE)
+        message = 'Some gemfiles failed'
+        puts tint(message, COLOR_FAILURE)
         puts
-        fail
+        raise Failed, message
       end
     end
 

data/lib/gemika/rspec.rb

@@ -3,20 +3,47 @@ module Gemika
     class << self
 
       def configure_transactional_examples
-        ::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
+        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
-            else
-              example.run
             end
           end
+
         end
       end
 

data/lib/gemika/tasks/matrix.rb

@@ -1,26 +1,46 @@
 require 'gemika/matrix'
 
+module Gemika
+  module Tasks
+    RSPEC_ARGS = '--color spec'
+  end
+end
+
 namespace :matrix do
 
   desc "Run specs for all Ruby #{RUBY_VERSION} gemfiles"
   task :spec do
-    Gemika::Matrix.from_travis_yml.each do
-      system("bundle exec rspec spec")
+    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}")
     end
   end
 
   desc "Install all Ruby #{RUBY_VERSION} gemfiles"
   task :install do
-    Gemika::Matrix.from_travis_yml.each do
+    Gemika::Matrix.from_travis_yml.each do |row|
       system('bundle install')
     end
   end
 
   desc "Update all Ruby #{RUBY_VERSION} gemfiles"
   task :update, :gems do |t, args|
-    Gemika::Matrix.from_travis_yml.each do
+    Gemika::Matrix.from_travis_yml.each do |row|
       system("bundle update #{args[:gems]}")
     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}")
+  end
+
+end

data/lib/gemika/version.rb

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

data/lib/gemika.rb

@@ -1,6 +1,7 @@
 require 'gemika/version'
+require 'gemika/env'
 require 'gemika/database' if defined?(ActiveRecord)
 require 'gemika/matrix'
-require 'gemika/rspec' if defined?(RSpec)
+require 'gemika/rspec' if defined?(RSpec) || defined?(Spec)
 
 # don't load tasks by default

data/spec/fixtures/travis_yml/Gemfile_without_gemika

@@ -0,0 +1 @@
+gem 'some-gem'

data/spec/fixtures/travis_yml/excludes.yml

@@ -0,0 +1,12 @@
+rvm:
+  - 2.1.8
+  - 2.3.1
+
+gemfile:
+  - gemfiles/Gemfile1
+  - gemfiles/Gemfile2
+
+matrix:
+  exclude:
+    - rvm: 2.1.8
+      gemfile: gemfiles/Gemfile1

data/spec/fixtures/travis_yml/gemfile_without_gemika.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 2.1.8
+
+gemfile:
+  - spec/fixtures/travis_yml/Gemfile_without_gemika

data/spec/fixtures/travis_yml/missing_gemfile.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 2.1.8
+
+gemfile:
+  - gemfiles/nonexisting_gemfile

data/spec/fixtures/travis_yml/two_by_two.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 2.1.8
+  - 2.3.1
+
+gemfile:
+  - gemfiles/Gemfile1
+  - gemfiles/Gemfile2

data/spec/gemika/database_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper' # can't move this to .rspec in RSpec 1
+
+describe Gemika::Database do
+
+  it 'connects ActiveRecord to the database in database.yml, then migrates the schema' do
+    user = User.create!(:email => 'foo@bar.com')
+    database_user = User.first
+    user.email.should == database_user.email
+  end
+
+  it 'wraps each example in a transaction that is rolled back when the transaction ends' do
+    User.count.should == 0
+  end
+
+end

data/spec/gemika/matrix_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper' # can't move this to .rspec in RSpec 1
+
+describe Gemika::Matrix do
+
+  before :each do
+    @original_bundle_gemfile = ENV['BUNDLE_GEMFILE']
+  end
+
+  after :each do
+    # Make sure failing tests are not messing out our environment
+    ENV['BUNDLE_GEMFILE'] = @original_bundle_gemfile
+  end
+
+  describe '#each' do
+
+    it "calls the block with each matrix row, setting ENV['BUNDLE_GEMFILE'] to the respective gemfile" do
+      current_ruby = '2.1.8'
+      row1 = Gemika::Matrix::Row.new(:ruby => current_ruby, :gemfile => 'gemfiles/Gemfile1')
+      row2 = Gemika::Matrix::Row.new(:ruby => current_ruby, :gemfile => 'gemfiles/Gemfile2')
+      matrix = Gemika::Matrix.new(:rows =>[row1, row2], :validate => false, :current_ruby => current_ruby, :silent => true)
+      spy = double('block')
+      spy.should_receive(:observe_gemfile).with('gemfiles/Gemfile1')
+      spy.should_receive(:observe_gemfile).with('gemfiles/Gemfile2')
+      matrix.each do
+        spy.observe_gemfile(ENV['BUNDLE_GEMFILE'])
+        true
+      end
+    end
+
+    it 'only calls the block with rows compatible with the current Ruby' do
+      current_ruby = '2.1.8'
+      other_ruby = '2.3.1'
+      row1 = Gemika::Matrix::Row.new(:ruby => current_ruby, :gemfile => 'gemfiles/Gemfile1')
+      row2 = Gemika::Matrix::Row.new(:ruby => other_ruby, :gemfile => 'gemfiles/Gemfile2')
+      matrix = Gemika::Matrix.new(:rows =>[row1, row2], :validate => false, :current_ruby => current_ruby, :silent => true)
+      spy = double('block')
+      spy.should_receive(:observe_gemfile).with('gemfiles/Gemfile1')
+      spy.should_not_receive(:observe_gemfile).with('gemfiles/Gemfile2')
+      matrix.each do
+        spy.observe_gemfile(ENV['BUNDLE_GEMFILE'])
+        true
+      end
+    end
+
+    it "resets ENV['BUNDLE GEMFILE'] to its initial value afterwards" do
+      original_env = ENV['BUNDLE_GEMFILE']
+      original_env.should be_present
+      current_ruby = '2.1.8'
+      row = Gemika::Matrix::Row.new(:ruby => current_ruby, :gemfile => 'gemfiles/Gemfile1')
+      matrix = Gemika::Matrix.new(:rows =>[row], :validate => false, :current_ruby => current_ruby, :silent => true)
+      matrix.each { true }
+      ENV['BUNDLE_GEMFILE'].should == original_env
+    end
+
+    it 'prints an overview of which gemfiles have passed, which have failed, which were skipped' do
+      row1 = Gemika::Matrix::Row.new(:ruby => '2.1.8', :gemfile => 'gemfiles/GemfileAlpha')
+      row2 = Gemika::Matrix::Row.new(:ruby => '2.1.8', :gemfile => 'gemfiles/GemfileBeta')
+      row3 = Gemika::Matrix::Row.new(:ruby => '2.3.1', :gemfile => 'gemfiles/GemfileAlpha')
+      require 'stringio'
+      actual_output = ''
+      io = StringIO.new(actual_output)
+      matrix = Gemika::Matrix.new(:rows =>[row1, row2, row3], :validate => false, :current_ruby => '2.1.8', :io => io, :color => false)
+      commands = [
+        lambda { io.puts 'Successful output'; true },
+        lambda { io.puts 'Failed output'; false },
+        lambda { io.puts 'Skipped output'; false  }
+      ]
+      expect { matrix.each { commands.shift.call } }.to raise_error(Gemika::Matrix::Failed)
+      expected_output = <<EOF
+gemfiles/GemfileAlpha
+
+Successful output
+
+gemfiles/GemfileBeta
+
+Failed output
+
+Summary
+
+- gemfiles/GemfileAlpha  Ruby 2.1.8  Success
+- gemfiles/GemfileBeta   Ruby 2.1.8  Failed
+- gemfiles/GemfileAlpha  Ruby 2.3.1  Skipped
+
+Some gemfiles failed
+EOF
+      actual_output.strip.should == expected_output.strip
+    end
+
+    it 'should raise an error if a row failed (returns false)' do
+      current_ruby = '2.1.8'
+      row = Gemika::Matrix::Row.new(:ruby => current_ruby, :gemfile => 'gemfiles/Gemfile')
+      matrix = Gemika::Matrix.new(:rows =>[row], :validate => false, :current_ruby => current_ruby, :silent => true)
+      expect { matrix.each { false } }.to raise_error(Gemika::Matrix::Failed, /Some gemfiles failed/i)
+    end
+
+    it 'should raise an error if no row if compatible with the current Ruby' do
+      current_ruby = '2.1.8'
+      other_ruby = '2.3.1'
+      row = Gemika::Matrix::Row.new(:ruby => other_ruby, :gemfile => 'gemfiles/Gemfile')
+      matrix = Gemika::Matrix.new(:rows =>[row], :validate => false, :current_ruby => current_ruby, :silent => true)
+      expect { matrix.each { false } }.to raise_error(Gemika::Matrix::Incompatible, /No gemfiles were compatible/i)
+    end
+
+  end
+
+  describe '.from_travis_yml' do
+
+    it 'builds a matrix by combining Ruby versions and gemfiles from a Travis CI configuration file' do
+      path = 'spec/fixtures/travis_yml/two_by_two.yml'
+      matrix = Gemika::Matrix.from_travis_yml(:path => path, :validate => false)
+      matrix.rows.size.should == 4
+      matrix.rows[0].ruby.should == '2.1.8'
+      matrix.rows[0].gemfile.should == 'gemfiles/Gemfile1'
+      matrix.rows[1].ruby.should == '2.1.8'
+      matrix.rows[1].gemfile.should == 'gemfiles/Gemfile2'
+      matrix.rows[2].ruby.should == '2.3.1'
+      matrix.rows[2].gemfile.should == 'gemfiles/Gemfile1'
+      matrix.rows[3].ruby.should == '2.3.1'
+      matrix.rows[3].gemfile.should == 'gemfiles/Gemfile2'
+    end
+
+    it 'allows to exclude rows from the matrix' do
+      path = 'spec/fixtures/travis_yml/excludes.yml'
+      matrix = Gemika::Matrix.from_travis_yml(:path => path, :validate => false)
+      matrix.rows.size.should == 3
+      matrix.rows[0].ruby.should == '2.1.8'
+      matrix.rows[0].gemfile.should == 'gemfiles/Gemfile2'
+      matrix.rows[1].ruby.should == '2.3.1'
+      matrix.rows[1].gemfile.should == 'gemfiles/Gemfile1'
+      matrix.rows[2].ruby.should == '2.3.1'
+      matrix.rows[2].gemfile.should == 'gemfiles/Gemfile2'
+    end
+
+    it 'raises an error if a Gemfile does not exist' do
+      path = 'spec/fixtures/travis_yml/missing_gemfile.yml'
+      expect { Gemika::Matrix.from_travis_yml(:path => path) }.to raise_error(Gemika::Matrix::Invalid, /gemfile not found/i)
+    end
+
+    it 'raises an error if a Gemfile does not depend on "gemika"' do
+      path = 'spec/fixtures/travis_yml/gemfile_without_gemika.yml'
+      expect { Gemika::Matrix.from_travis_yml(:path => path) }.to raise_error(Gemika::Matrix::Invalid, /missing gemika dependency/i)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$: << File.join(File.dirname(__FILE__), "/../../lib" )
+
+require 'active_record'
+require 'gemika'
+
+ActiveRecord::Base.default_timezone = :local
+
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/shared_examples/*.rb"].sort.each {|f| require f}
+
+Gemika::RSpec.configure_transactional_examples
+
+if Gemika::Env.rspec_2_plus?
+  RSpec.configure do |config|
+    config.expect_with(:rspec) { |c| c.syntax = [:should, :expect] }
+    config.mock_with(:rspec) { |c| c.syntax = [:should, :expect] }
+  end
+end

data/spec/support/database.rb

@@ -0,0 +1,8 @@
+Gemika::Database.new.rewrite_schema! do
+
+  create_table :users do |t|
+    t.string :name
+    t.string :email
+  end
+
+end

data/spec/support/database.sample.yml

@@ -0,0 +1,10 @@
+mysql:
+  database: gemika_test
+  host: localhost
+  username: root
+  password: secret
+
+postgresql:
+  database: gemika_test
+  user:
+  password: