gemika 0.3.2 → 0.5.0

data/{gemfiles/Gemfile.5.0.pg → Gemfile.5.2.pg}

@@ -4,13 +4,14 @@ source 'https://rubygems.org'
 ruby '>= 2.2'
 
 # Runtime dependencies
-gem 'activerecord', '~>5.0.0'
+gem 'activerecord', '~>5.2.0'
 gem 'rspec', '~>3.5'
 gem 'pg', '~>0.18.4'
 
 # Development dependencies
 gem 'rake'
 gem 'database_cleaner'
+gem 'pry'
 
 # Gem under test
-gem 'gemika', :path => '..'
+gem 'gemika', :path => '.'

data/{gemfiles/Gemfile.5.0.pg.lock → Gemfile.5.2.pg.lock}

@@ -1,28 +1,35 @@
 PATH
-  remote: ..
+  remote: .
   specs:
+    gemika (0.5.0)
 
 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)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (7.1.2)
-    concurrent-ruby (1.0.2)
-    database_cleaner (1.5.3)
+    arel (9.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    database_cleaner (1.7.0)
     diff-lcs (1.2.5)
-    i18n (0.7.0)
-    minitest (5.9.0)
+    i18n (1.5.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
     pg (0.18.4)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (11.3.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -37,18 +44,19 @@ GEM
       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.3.6)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 5.0.0)
+  activerecord (~> 5.2.0)
   database_cleaner
   gemika!
   pg (~> 0.18.4)
+  pry
   rake
   rspec (~> 3.5)
 
@@ -56,4 +64,4 @@ RUBY VERSION
    ruby 2.2.4p230
 
 BUNDLED WITH
-   1.12.5
+   1.17.3

data/Gemfile.5.2.sqlite3

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Ruby
+ruby '>= 2.2'
+
+# Runtime dependencies
+gem 'activerecord', '~>5.2.0'
+gem 'rspec', '~>3.5'
+gem 'sqlite3'
+
+# Development dependencies
+gem 'rake'
+gem 'database_cleaner'
+gem 'pry'
+
+# Gem under test
+gem 'gemika', :path => '.'

data/Gemfile.5.2.sqlite3.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    gemika (0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    i18n (1.5.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.2.0)
+  database_cleaner
+  gemika!
+  pry
+  rake
+  rspec (~> 3.5)
+  sqlite3
+
+RUBY VERSION
+   ruby 2.2.4p230
+
+BUNDLED WITH
+   1.17.3

data/Gemfile.6.0.pg

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Ruby
+ruby '>= 2.2'
+
+# Runtime dependencies
+gem 'activerecord', '~>6.0.0'
+gem 'rspec', '~>3.5'
+gem 'pg', '~>0.18.4'
+
+# Development dependencies
+gem 'rake'
+gem 'database_cleaner'
+gem 'pry'
+
+# Gem under test
+gem 'gemika', :path => '.'

data/Gemfile.6.0.pg.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    gemika (0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pg (0.18.4)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.0.0)
+  database_cleaner
+  gemika!
+  pg (~> 0.18.4)
+  pry
+  rake
+  rspec (~> 3.5)
+
+RUBY VERSION
+   ruby 2.2.4p230
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -1,4 +1,4 @@
-# Gemika [![Build Status](https://travis-ci.org/makandra/gemika.svg?branch=master)](https://travis-ci.org/makandra/gemika)
+# Gemika  [![Tests](https://github.com/makandra/gemika/workflows/Tests/badge.svg)](https://github.com/makandra/gemika/actions)
 
 ## Test a Ruby gem against multiple versions of everything
 
@@ -12,12 +12,13 @@ Here's what Gemika can give your test's development setup (all features are opt-
 
 - Test one codebase against multiple sets of runtime gem dependency sets (e.g. Rails 2.3, Rails 5.0).
 - Test one codebase against multiple Ruby versions (e.g. Ruby 1.8.7, Ruby 2.3.10).
-- Test one codebase against multiple database types (currently MySQL or PostgreSQL).
+- Test one codebase against multiple database types (currently MySQL, PostgreSQL, or sqlite3).
 - Compute a matrix of all possible dependency permutations (Ruby, runtime gems, database type). Manually exclude incompatible dependency permutations (e.g. Rails 5.0 does not work with Ruby 2.1).
 - Let developers enter their local credentials for MySQL and PostgreSQL in a `database.yml` file.
 - Define default Ruby version, gem dependencies and database for developers who don't care about every possible permutation for everyday work.
-- Help configure a [Travis CI](https://travis-ci.org/) build that tests every dependency permutation after each `git push`.
-- Share your Ruby / gem dependeny / database permutation between local development and Travis CI.
+- Help configure a [Travis CI](https://travis-ci.org/) or Github Actions build that tests every dependency permutation after each `git push`.
+- Share your Ruby / gem dependeny / database permutation between local development and Travis CI / Github Actions.
+- Migrate your Travis CI config to a Github Actions config.
 - Define an [ActiveRecord database migration](http://api.rubyonrails.org/classes/ActiveRecord/Migration.html) that sets up your test database.
 - Automatically drop and re-create your test database before each run of your test suite.
 - Work around breaking changes in RSpec, Ruby and other gems
@@ -30,7 +31,7 @@ Gemika currently supports the following dependency versions:
 - Ruby: 1.8.7, 2.1, 2.2, 2.3
 - RSpec: Versions 1, 2, 3
 - ActiveRecord: Versions 2.3, 3.2, 4.2, 5.0
-- Databases: PostgreSQL (with `pg` gem), MySQL or MariaDB (with `mysql2` gem)
+- Databases: PostgreSQL (with `pg` gem), MySQL or MariaDB (with `mysql2` gem), or sqlite3 (with `sqlite3` gem)
 
 Gemika also makes some assumption about your Gem:
 
@@ -43,14 +44,14 @@ Gemika also makes some assumption about your Gem:
 Below you can see the directory of a gem with a completed Gemika testing setup. The next section describes how to get there:
 
 ```shell
-gemfiles/Gemfile.set1                       # First dependency set. Should include development dependencies and gemika.
-gemfiles/Gemfile.set1.lock                  # Generated by `rake matrix:install`
-gemfiles/Gemfile.set2                       # Second dependency set. Should include development dependencies and gemika.
-gemfiles/Gemfile.set2.lock                  # Generated by `rake matrix:install`
-gemfiles/Gemfile.set3                       # Third dependency set. Should include development dependencies and gemika.
-gemfiles/Gemfile.set3.lock                  # Generated by `rake matrix:install`
-Gemfile -> gemfiles/Gemfile.set2            # Symlink to default Gemfile for development
-Gemfile.lock -> gemfiles/Gemfile.set2.lock  # Symlink to default Gemfile.lock for development
+Gemfile.set1                                # First dependency set. Should include development dependencies and gemika.
+Gemfile.set1.lock                           # Generated by `rake matrix:install`
+Gemfile.set2                                # Second dependency set. Should include development dependencies and gemika.
+Gemfile.set2.lock                           # Generated by `rake matrix:install`
+Gemfile.set3                                # Third dependency set. Should include development dependencies and gemika.
+Gemfile.set3.lock                           # Generated by `rake matrix:install`
+Gemfile -> Gemfile.set2                     # Symlink to default Gemfile for development
+Gemfile.lock -> Gemfile.set2.lock           # Symlink to default Gemfile.lock for development
 .ruby-version                               # Default Ruby version for development
 .gitignore                                  # Should ignore spec/support/database.yml
 .travis.yml                                 # Configures all tested Ruby / gemfile combinations, for both local development and Travis CI
@@ -65,6 +66,7 @@ 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/support/database.github.yml            # Alternatively: Database credentials for Github Actions
 spec/my_gem/my_class_spec.rb                # Tests for your gem
 ```
 
@@ -79,9 +81,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:
 
 ```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
+my_gem.gemspec      # Specification for your gem
+Rakefile            # Rake tasks for your gem
+lib/my_gem.rb       # Main file to require for your gem
+spec/my_gem_spec.rb # Tests 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):
@@ -135,86 +138,66 @@ task :default => 'matrix:spec'
 ### Define multiple dependency sets
 
 We are now creating one `Gemfile` for each set of gems and database type you'd like to test again.
+Your gemfiles should be placed directly in your project's root directory.
 
-First, create a directory for the gemfiles:
-
-```shell
-mkdir gemfiles
-```
-
-For each dependency set, create a `Gemfile` in the `gemfiles` directory that contains:
+For each dependency set, create a `Gemfile` in the project root directory that contains:
 
 1. The runtime dependencies you'd like to test against (e.g. Rails 5)
-2. The development dependencies for that set (e.g. `rspec`) in a version that is compatible with these runtime gependencies.
+2. The development dependencies for that set (e.g. `rspec`) in a version that is compatible with these runtime dependencies.
 3. The `gemika` gem
-4. Your own gem from path `..`
- 
-For instance, if one dependency set is Rails 3.2 with a MySQL database, we would create `gemfiles/Gemfile.4.2.mysql2` with these contents:
+4. Your own gem from path `.`
+
+For instance, if one dependency set is Rails 3.2 with a MySQL database, we would create `./Gemfile.4.2.mysql2` with these contents:
 
 ```ruby
+source 'https://rubygems.org'
+
 # Runtime dependencies
 gem 'rails', '~>3.2.22'
-gem 'mysql2', '= 0.3.17'
-gem 'rspec', '~> 3.4'
+gem 'mysql2', '= 0.4.10'
 
 # Development dependencies
+gem 'rspec', '~> 3.4'
 gem 'rake'
 gem 'byebug'
 gem 'gemika'
 
 # Gem under test
-gem 'my_gem', :path => '..'
+gem 'my_gem', :path => '.'
 ```
 
-If a second dependency is Rails 5.0 with a PostgreSQL database, we would create `gemfiles/Gemfile.5.0.pg` with these contents:
+If a second dependency is Rails 5.0 with a PostgreSQL database, we would create `./Gemfile.5.0.pg` with these contents:
 
 ```ruby
+source 'https://rubygems.org'
+
 # Runtime dependencies
 gem 'rails', '~>5.0.0'
 gem 'pg', '~>0.18.4'
-gem 'rspec', '~>3.5'
 
 # Development dependencies
+gem 'rspec', '~>3.5'
 gem 'rake'
 gem 'byebug'
 gem 'gemika'
 
 # Gem under test
-gem 'my_gem', :path => '..'
-```
-
-In this example, your `gemfiles` directory should now look like this:
-
-```
-gemfiles/Gemfile.4.2.mysql2
-gemfiles/Gemfile.5.0.pg
-```
-
-Create lockfiles for each bundle by running:
-
-```shell
-rake matrix:install
+gem 'my_gem', :path => '.'
 ```
 
-In this example, your `gemfiles` directory should now contain a lockfile for each gemfile:
+In this example, your project directory should now also contain:
 
 ```
-gemfiles/Gemfile.4.2.mysql2
-gemfiles/Gemfile.4.2.mysql2.lock
-gemfiles/Gemfile.5.0.pg
-gemfiles/Gemfile.5.0.pg.lock
+Gemfile.4.2.mysql2
+Gemfile.5.0.pg
 ```
 
-Gemfiles and lockfiles should be committed to your repo.
-
-Make sure to re-run `rake matrix:install` after each change to your gemfiles, and commit the generated changes.
-
 
 ### Define combinations of gemfiles and Ruby versions
 
 We will now define a test matrix that contains all permutations of gemfiles and tested Ruby versions.
 
-We store the matrix in a `.travis.yml` file, **even if the project is not using Travis CI**. This allows us to configure the matrix once and us it for both local developent and Travis CI builds.
+We store the matrix in a `.travis.yml` file, **even if the project is not using Travis CI**. This allows us to configure the matrix once and us it for both local development and Travis CI builds.
 
 Create a `.travis.yml` that lists all gemfiles and Ruby versions you'd like to test against:
 
@@ -225,16 +208,19 @@ rvm:
   - 2.3.1
 
 gemfile:
-  - 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
+  - Gemfile.3.2.mysql2
+  - Gemfile.4.2.mysql2
+  - Gemfile.4.2.pg
+  - Gemfile.5.0.mysql2
+  - Gemfile.5.0.pg
 ```
 
 Don't mind the `rvm` key if you're using a different version manager locally (like rbenv). Things will still work.
 
 
+Alternatively, create a Github Actions file like [this](/.github/workflows/test.yml).
+
+
 #### Excluding incompatible matrix rows
 
 There might be incompatible combinations of gemfiles and Rubies, e.g. Rails 5.0 does not work with Ruby 2.1 or lower. In this case, add an `matrix`/`exclude` key to your `.travis.yml`:
@@ -242,12 +228,59 @@ There might be incompatible combinations of gemfiles and Rubies, e.g. Rails 5.0
 ```yaml
 matrix:
   exclude:
-    - gemfile: gemfiles/Gemfile.5.0.mysql2
+    - gemfile: Gemfile.5.0.mysql2
       rvm: 2.1.8
-    - gemfile: gemfiles/Gemfile.5.0.pg
+    - gemfile: Gemfile.5.0.pg
       rvm: 2.1.8
 ```
 
+For `.github/workflows/test.yml`, it looks similar:
+
+```yaml
+jobs:
+  my_job:
+    strategy:
+      matrix:
+        exclude:
+          - gemfile: Gemfile.5.0.mysql2
+            ruby: 2.1.8
+          - gemfile: Gemfile.5.0.pg
+            ruby: 2.1.8
+```
+
+
+Alternatively, you can instead explicitly list all Ruby / Gemfile combinations with
+
+```
+matrix:
+  include:
+  - gemfile: Gemfile.5.0.mysql2
+    rvm: 2.3.8
+  - gemfile: Gemfile.5.2.mysql2
+    rvm: 2.3.8
+```
+
+### Generate lockfiles
+
+Generate lockfiles for each bundle by running:
+
+```shell
+rake matrix:install
+```
+
+In this example, your project directory should now contain a lockfile for each gemfile:
+
+```
+Gemfile.4.2.mysql2
+Gemfile.4.2.mysql2.lock
+Gemfile.5.0.pg
+Gemfile.5.0.pg.lock
+```
+
+Gemfiles and lockfiles should be committed to your repo.
+
+Make sure to re-run `rake matrix:install` after each change to your gemfiles, and commit the generated changes.
+
 
 ### Default Ruby and default gemfile
 
@@ -262,8 +295,8 @@ Create a `.ruby-version` file with the default Ruby version:
 Choose a default dependency set and symlink both gemfile and lockfile to your project root:
 
 ```
-ln -s gemfiles/Gemfile.4.2.mysql2 Gemfile
-ln -s gemfiles/Gemfile.4.2.mysql2.lock Gemfile.lock
+ln -s Gemfile.4.2.mysql2 Gemfile
+ln -s Gemfile.4.2.mysql2.lock Gemfile.lock
 ```
 
 Commit both `.ruby-version` and symlinks to your repo.
@@ -288,6 +321,9 @@ postgresql:
   database: minidusen_test
   user:
   password:
+
+sqlite:
+  database: ":memory:"
 ```
 
 We don't want to commit our local credentials, so add a line to your `.gitignore`:
@@ -327,6 +363,25 @@ Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each {|f| require f}
 Now you have a great place for code snippets that need to run before specs (factories, VCR configuration, etc.).
 
 
+To have your database work with Github Actions, add a database file `spec/support/database.github.yml`.
+
+```
+mysql:
+  database: test
+  username: root
+  password: password
+  host: 127.0.0.1
+  port: 3306
+
+postgresql:
+  database: test
+  host: localhost
+  username: postgres
+  password: postgres
+  port: 5432
+```
+
+
 #### Test database schema
 
 If your gem is talking to the database, you probably need to create some example tables.
@@ -383,6 +438,25 @@ Gemika::RSpec.configure_clean_database_before_example
 Note that you also need `require 'gemika'` in your `spec_helper.rb`.
 
 
+#### Migrate from Travis CI to Github Actions
+
+To help in your migrations, you can ask Gemika to generate a Github Actions config from an existing `.travis-ci.yml`.
+
+To do this, call
+
+```
+bundle exec rake gemika:generate_github_actions_workflow
+```
+
+Copy the resulting file to `.github/workflows/test.yml`.
+
+Make sure you have a `spec/support/database.github.yml` if you use databases. See above how this is supposed to look like.
+
+You may have to fix a few things manually though. For example, Github Actions will only allow certain Ruby versions (but show you a list of supported versions when it fails).
+
+Also, when you run on a Ubuntu 20.04 container, you might have issues with the mysql2 gem. See [this guide](https://makandracards.com/makandra/486428-installing-old-versions-of-mysql2-on-ubuntu-20-04+) for a potential solution.
+
+
 ### Try it out
 
 Check if you can install development dependencies for each row in the test matrix:
@@ -424,8 +498,8 @@ rake matrix:spec
 Note that if your current Ruby version is *very* far away from your [default Ruby](#default-ruby-and-default-gemfile) in `.ruby-version`, you might need to run `rake` with a gemfile that has compatible dependencies:
 
 ```shell
-BUNDLE_GEMFILE=gemfiles/Gemfile.2.3 bundle exec rake matrix:install
-BUNDLE_GEMFILE=gemfiles/Gemfile.2.3 bundle exec rake matrix:spec
+BUNDLE_GEMFILE=Gemfile.2.3 bundle exec rake matrix:install
+BUNDLE_GEMFILE=Gemfile.2.3 bundle exec rake matrix:spec
 ```
 
 We recommend to setup Travis CI to check the entire test matrix after each push, including all Rubies. This way developers can stay on the [default Ruby and gemfile](#default-ruby-and-default-gemfile) most of the time while Travis CI checks make sure that nothing broken gets merged.
@@ -471,10 +545,9 @@ notifications:
     - notifications@test.com
 
 install:
-  # Old Travis CI bundler explodes when lockfile version doesn't match recently bumped version
-  - gem install bundler --version='=1.12.5'
-  # This is the default Travis CI install step
-  - bundle install --jobs=3 --retry=3 --deployment --path=${BUNDLE_PATH:-vendor/bundle}
+  # Replace default Travis CI bundler script with a version that doesn't
+  # explode when lockfile doesn't match recently bumped version
+  - bundle install --no-deployment --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}
 
 script: bundle exec rake current_rspec
 ```