gemika 0.1.4 → 0.2.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/.travis.yml

@@ -0,0 +1,50 @@
+language: ruby
+
+rvm:
+  - 1.8.7
+  - 2.1.8
+  - 2.2.4
+  - 2.3.1
+
+gemfile:
+  - gemfiles/Gemfile.2.3.mysql2
+  - gemfiles/Gemfile.3.2.mysql2
+  - gemfiles/Gemfile.4.2.mysql2
+  - gemfiles/Gemfile.4.2.pg
+  - gemfiles/Gemfile.5.0.mysql2
+  - gemfiles/Gemfile.5.0.pg
+
+before_script:
+  - psql -c 'create database gemika_test;' -U postgres
+  - mysql -e 'create database IF NOT EXISTS gemika_test;'
+
+script: bundle exec rake gemika:spec
+
+sudo: false
+
+cache: bundler
+
+notifications:
+  email:
+    - fail@makandra.de
+
+matrix:
+  exclude:
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile.4.2.mysql2
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile.4.2.pg
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile.5.0.mysql2
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile.5.0.pg
+    - rvm: 2.1.8
+      gemfile: gemfiles/Gemfile.2.3.mysql2
+    - rvm: 2.1.8
+      gemfile: gemfiles/Gemfile.5.0.mysql2
+    - rvm: 2.1.8
+      gemfile: gemfiles/Gemfile.5.0.pg
+    - rvm: 2.2.4
+      gemfile: gemfiles/Gemfile.2.3.mysql2
+    - rvm: 2.3.1
+      gemfile: gemfiles/Gemfile.2.3.mysql2

data/README.md

@@ -1,10 +1,14 @@
-# Gemika
+# Gemika [![Build Status](https://travis-ci.org/makandra/gemika.svg?branch=master)](https://travis-ci.org/makandra/gemika)
 
 ## Test a Ruby gem against multiple versions of everything
 
 Gemika helps you test your gem against multiple versions of Ruby, gem dependencies and database types.
 
-Here's what Gemika can give your test's development setup (all steps are opt-in):
+![Matrix task output](https://raw.githubusercontent.com/makandra/gemika/master/doc/minidusen_test.png)
+
+## Features
+
+Here's what Gemika can give your test's development setup (all features are opt-in):
 
 - Test one codebase against multiple sets of gem dependency sets (e.g. Rails 4.2, Rails 5.0).
 - Test one codebase against multiple Ruby versions (e.g. Ruby 2.1.8, Ruby 2.3.1).
@@ -19,10 +23,19 @@ Here's what Gemika can give your test's development setup (all steps are opt-in)
 - Configure RSpec to wrap each example in a transaction that is rolled back when the example ends. This way each example starts with a blank database.
 
 
-## Requirements
+## Compatibility
+
+Gemika currently supports the following dependency versions:
 
-- Gemika currently assumes you're testing with [RSpec](http://rspec.info/).
-- If you use any database-related features, you need `activaterecord` as a development dependency
+- Ruby: 1.8.7, 2.1, 2.2, 2.3
+- RSpec: Versions 1, 3
+- ActiveRecord: Versions 2.3, 3.2, 4.2, 5.0
+- Databases: PostgreSQL (with `pg` gem), MySQL or MariaDB (with `mysql2` gem)
+
+Gemika also makes some assumption about your Gem:
+
+- You're testing with [RSpec](http://rspec.info/).
+- If you use any database-related features, you need `activerecord` as a development dependency
 
 
 ## Example directory structure
@@ -44,13 +57,14 @@ Gemfile.lock -> gemfiles/Gemfile.set2.lock  # Symlink to default Gemfile.lock fo
 my_gem.gemspec                              # Specification for your gem
 Rakefile                                    # Should require 'gemika/tasks'
 README.md                                   # README for your gem
-lib/my_gem.rb                               # Library files for your gem
+lib/my_gem.rb                               # Main file to require for your gem
 lib/my_gem/my_class.rb                      # Class delivered by your gem
 lib/my_gem/version.rb                       # Version definition for your gem
 spec/spec_helper.rb                         # Requires 'gemika' and all files in support folder
-spec/support/database.rb                    # Calls `Gemika.rewrite_schema! { ... }`
-spec/support/database.yml                   # Local
-spec/support/database.travis.yml            # Calls `Gemika.rewrite_schema! { ... }`
+spec/support/database.rb                    # Database schema for test database
+spec/support/database.yml                   # Database credentials for local development (not checked in)
+spec/support/database.sample.yml            # Sample database credentials for new developers
+spec/support/database.travis.yml            # Database credentials for Travis CI
 spec/my_gem/my_class_spec.rb                # Tests for your gem
 ```
 
@@ -64,10 +78,10 @@ For a live example of this setup, check the [makandra/minidusen](https://github.
 
 Gemika expects a standard gem directory that looks roughly like this:
 
-```
-my_gem.gemspec                              # Specification for your gem
-Rakefile                                    # Should require 'gemika/tasks'
-lib/my_gem.rb                               # Library files for your gem
+```shell
+my_gem.gemspec  # Specification for your gem
+Rakefile        # Rake tasks for your gem
+lib/my_gem.rb   # Main file to require for your gem
 ```
 
 If you don't have a directory yet, you can [ask Bundler to create it for you](http://bundler.io/rubygems.html):
@@ -244,6 +258,8 @@ ln -s gemfiles/Gemfile.4.2.mysql2 Gemfile
 ln -s gemfiles/Gemfile.4.2.mysql2.lock Gemfile.lock
 ```
 
+Note that since you now have a Gemfile in your project root, you will need to call `bundle exec rake` instead of `rake` from this point on.
+
 Commit both `.ruby-version` and symlinks to your repo.
 
 We recommend to setup Travis CI (see below) to check the entire test matrix after each push, even if a developer only tested with the defaults.
@@ -492,6 +508,28 @@ We recommend to test large changes against multiple versions of Ruby and multipl
 Note that we have configured Travis CI to automatically run tests in all supported Ruby versions and dependency sets after each push. We will only merge pull requests after a green Travis build.
 ```
 
+
+Development
+-----------
+
+Here are some hints when you try to make changes to Gemika:
+
+There are tests in `spec`. We only accept PRs with tests. To run tests:
+
+- Install Ruby 2.2.4
+- Create a local test database `gemika_test` in both MySQL and PostgreSQL
+- Copy `spec/support/database.sample.yml` to `spec/support/database.yml` and enter your local credentials for the test databases
+- Install development dependencies using `bundle install`
+- Run tests using `bundle exec rspec`
+
+We recommend to test large changes against multiple versions of Ruby and multiple dependency sets. Supported combinations are configured in `.travis.yml`. We provide some rake tasks to help with this:
+
+- Install development dependencies using `bundle matrix:install`
+- Run tests using `bundle matrix:spec`
+
+Note that we have configured Travis CI to automatically run tests in all supported Ruby versions and dependency sets after each push. We will only merge pull requests after a green Travis build.
+
+
 Credits
 -------
 

data/Rakefile

@@ -1,2 +1,9 @@
 require 'rake'
 require 'bundler/gem_tasks'
+begin
+  require 'gemika/tasks'
+rescue LoadError
+  puts 'Run `gem install gemika` for additional tasks'
+end
+
+task :default => 'matrix:spec'

data/gemfiles/Gemfile.2.3.mysql2

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '=2.3.18'
+gem 'rspec', '~> 1.3.0'
+gem 'mysql2', '= 0.2.20'
+
+gem 'rake', '=10.0.4'
+
+gem 'i18n', '=0.6.11' # 0.7 no longer builds for Ruby 1.8.7
+
+gem 'gemika', :path => '..'

data/gemfiles/Gemfile.2.3.mysql2.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: ..
+  specs:
+    gemika (0.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activerecord (2.3.18)
+      activesupport (= 2.3.18)
+    activesupport (2.3.18)
+    i18n (0.6.11)
+    mysql2 (0.2.20)
+    rake (10.0.4)
+    rspec (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 2.3.18)
+  gemika!
+  i18n (= 0.6.11)
+  mysql2 (= 0.2.20)
+  rake (= 10.0.4)
+  rspec (~> 1.3.0)
+
+BUNDLED WITH
+   1.12.5

data/gemfiles/Gemfile.3.2.mysql2

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '=3.2.22'
+gem 'rspec', '~> 3.4'
+gem 'mysql2', '= 0.3.17'
+
+gem 'rake', '=10.0.4'
+
+gem 'i18n', '=0.6.11' # 0.7 no longer builds for Ruby 1.8.7
+
+gem 'gemika', :path => '..'

data/gemfiles/Gemfile.3.2.mysql2.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: ..
+  specs:
+    gemika (0.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.22)
+      activesupport (= 3.2.22)
+      builder (~> 3.0.0)
+    activerecord (3.2.22)
+      activemodel (= 3.2.22)
+      activesupport (= 3.2.22)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.22)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    diff-lcs (1.2.5)
+    i18n (0.6.11)
+    multi_json (1.12.1)
+    mysql2 (0.3.17)
+    rake (10.0.4)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    tzinfo (0.3.51)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.2.22)
+  gemika!
+  i18n (= 0.6.11)
+  mysql2 (= 0.3.17)
+  rake (= 10.0.4)
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.12.5

data/gemfiles/Gemfile.4.2.mysql2

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~>4.2.1'
+gem 'rspec', '~>3.4'
+gem 'mysql2', '~> 0.3.17'
+
+gem 'rake'
+
+gem 'gemika', :path => '..'

data/gemfiles/Gemfile.4.2.mysql2.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: ..
+  specs:
+    gemika (0.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.9.0)
+    mysql2 (0.3.21)
+    rake (11.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.2.1)
+  gemika!
+  mysql2 (~> 0.3.17)
+  rake
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.12.5

data/gemfiles/Gemfile.4.2.pg

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~>4.2.1'
+gem 'rspec', '~>3.4'
+gem 'pg'
+
+gem 'rake'
+
+gem 'gemika', :path => '..'

data/gemfiles/Gemfile.4.2.pg.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: ..
+  specs:
+    gemika (0.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.9.0)
+    pg (0.19.0)
+    rake (11.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.2.1)
+  gemika!
+  pg
+  rake
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.12.5

data/gemfiles/Gemfile.5.0.mysql2

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~>5.0.0'
+gem 'rspec', '~>3.5'
+gem 'mysql2', '~>0.4.4'
+
+gem 'rake'
+
+gem 'gemika', :path => '..'

data/gemfiles/Gemfile.5.0.mysql2.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: ..
+  specs:
+    gemika (0.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.2)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    minitest (5.9.0)
+    mysql2 (0.4.4)
+    rake (11.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.0.0)
+  gemika!
+  mysql2 (~> 0.4.4)
+  rake
+  rspec (~> 3.5)
+
+BUNDLED WITH
+   1.12.5

data/gemfiles/Gemfile.5.0.pg

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~>5.0.0'
+gem 'rspec', '~>3.5'
+gem 'pg', '~>0.18.4'
+
+gem 'rake'
+
+gem 'gemika', :path => '..'

data/gemfiles/Gemfile.5.0.pg.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: ..
+  specs:
+    gemika (0.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.2)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    minitest (5.9.0)
+    pg (0.18.4)
+    rake (11.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.0.0)
+  gemika!
+  pg (~> 0.18.4)
+  rake
+  rspec (~> 3.5)
+
+BUNDLED WITH
+   1.12.5

data/lib/gemika/database.rb

@@ -1,11 +1,15 @@
 require 'yaml'
+require 'gemika/env'
 
 module Gemika
   class Database
 
+    class Error < StandardError; end
+    class UnknownAdapter < Error; end
+
     def initialize(options = {})
       yaml_config_folder = options.fetch(:config_folder, 'spec/support')
-      yaml_config_filename = travis? ? 'database.travis.yml' : 'database.yml'
+      yaml_config_filename = Env.travis? ? 'database.travis.yml' : 'database.yml'
       yaml_config_path = File.join(yaml_config_folder, yaml_config_filename)
       if File.exists?(yaml_config_path)
         @yaml_config = YAML.load_file(yaml_config_path)
@@ -46,24 +50,24 @@ module Gemika
     def adapter_config
       default_config = {}
       default_config['database'] = guess_database_name
-      if pg?
+      if Env.pg?
         default_config['adapter'] = 'postgresql'
-        default_config['username'] = 'postgres' if travis?
+        default_config['username'] = 'postgres' if Env.travis?
         default_config['password'] = ''
         user_config = @yaml_config['postgresql'] || @yaml_config['postgres'] || @yaml_config['pg'] || {}
-      elsif mysql2?
+      elsif Env.mysql2?
         default_config['adapter'] = 'mysql2'
-        default_config['username'] = 'travis' if travis?
+        default_config['username'] = 'travis' if Env.travis?
         default_config['encoding'] = 'utf8'
         user_config = (@yaml_config['mysql'] || @yaml_config['mysql2']) || {}
       else
-        raise "Unknown database type"
+        raise UnknownAdapter, "Unknown database type. Either 'pg' or 'mysql2' gem should be in your current bundle."
       end
       default_config.merge(user_config)
     end
 
     def guess_database_name
-      project_name = File.basename(File.expand_path(__dir__))
+      project_name = File.basename(Dir.pwd)
       "#{project_name}_test"
     end
 
@@ -71,21 +75,5 @@ module Gemika
       ActiveRecord::Base.connection
     end
 
-    def pg?
-      gem_loaded?('pg')
-    end
-
-    def mysql2?
-      gem_loaded?('mysql2')
-    end
-
-    def gem_loaded?(name)
-      Gem.loaded_specs.has_key?(name)
-    end
-
-    def travis?
-      !!ENV['TRAVIS']
-    end
-
   end
 end