wt_activerecord_index_spy 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11d05e2c0947b38147e7410caf7659d87ecf28e07f684f075eb77034d0b01025
+  data.tar.gz: 17d2229914f89671fbd811a4e5dc5851354190d7e1eb90ec7444f1449731c4eb
+SHA512:
+  metadata.gz: 8bf3bb1095e3b9ba88d69fdbd0dd00da66135308b4a2f2931abda47f225609aa8eef07f029b70a936087181d92b36832441c429d37b6b67ae076671236de847e
+  data.tar.gz: 7216232729e5f15769f2da26abb2d9e8922cb1411f67843cd2f64e2e08a3fe2b50045ea0481fac74b338dc941d5fad23e8763d6c8eeae11240a0359f17d957cc

data/.env.template

@@ -0,0 +1,3 @@
+DATABASE_URL_MYSQL2='mysql2://USER:PASSWORD@localhost:3306'
+# docker run --name some-postgres -e POSTGRES_PASSWORD=1234 -p 5432:5432 --rm  postgres
+DATABASE_URL_POSTGRESQL='postgresql://postgres:1234@localhost:5432'

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Ubuntu 20.4]
+ - Database/version: [e.g. MySql 5.7]
+ - Ruby version: [e.g. Ruby 2.5]
+ - Activerecord version: [e.g. Ruby 5.2]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,29 @@
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+## Checklist:
+
+- [ ] My code follows the style guidelines set by rubocop
+- [ ] I have performed a self-review of my own code
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] I have checked my code and corrected any misspellings

data/.github/workflows/main.yml

@@ -0,0 +1,51 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.ruby }}, ActiveRecord ${{ matrix.activerecord }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.7
+          - 2.6
+          - 2.5
+        activerecord:
+          - '~> 6'
+          - '~> 5'
+          - '~> 4'
+        exclude:
+          - ruby: 2.7
+            activerecord: '~> 4'
+    env:
+      DATABASE_URL_MYSQL2: 'mysql2://root:root@127.0.0.1:3306'
+      DATABASE_URL_POSTGRESQL: 'postgresql://root:root@127.0.0.1:5432'
+      ACTIVE_RECORD_VERSION: ${{ matrix.activerecord }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: install gems
+      run: |
+        gem install bundler
+        bundle install
+    - name: Create databases
+      run: |
+        sudo systemctl start mysql.service
+        sudo systemctl start postgresql.service
+        echo "create user root password 'root';" >> /tmp/create_user.sql
+        echo "ALTER ROLE root WITH CREATEDB;" >> /tmp/create_user.sql
+        sudo su postgres -c 'psql --file=/tmp/create_user.sql'
+        sudo su postgres -c 'createdb root'
+        bundle exec rake db:drop db:create db:migrate
+        ADAPTER=postgresql bundle exec rake db:drop db:create db:migrate
+    - name: Tests for mysql2
+      run: |
+        bundle exec rspec
+    - name: Tests for postgresql
+      run: |
+        ADAPTER=postgresql bundle exec rspec

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.env
+Gemfile.lock
+
+.ruby-version
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'Rakefile'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'Rakefile'
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 0.3.0
+* add support for PostgreSQL (unfortunately all results are uncertain)
+* add support for Ruby >= 2.5 and Activerecord >= 4
+* sort lines in the HTML report by certainity_level, identifier, query
+* improve the query analyser to not analyse a query again if a similar query was analysed before with a prepared statement (Postgres use prepared statements by default)
+* improve the logic to detect if a query was fired from a test file or not
+* remove the auto require for the module TestHelpers
+
+## 0.2.0
+* Improve RSpec matcher to cache EXPLAIN results

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at fabio.perrella@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONTRIBUTORS.md

@@ -0,0 +1,3 @@
+- @fabioperrella
+- @julik
+- @lorenzograndi4

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in wt_activerecord_index_spy.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"
+
+active_record_version = ENV.fetch("ACTIVE_RECORD_VERSION", "~> 4")
+
+gem "activerecord", active_record_version
+gem "activesupport", active_record_version
+
+if active_record_version == "~> 4"
+  gem "pg", "~> 0.15"
+else
+  gem "pg"
+end

data/LICENSE.md

@@ -0,0 +1,33 @@
+Copyright 2021 WeTransfer
+
+Hippocratic License Version Number: 2.1.
+
+Purpose. The purpose of this License is for the Licensor named above to permit the Licensee (as defined below) broad permission, if consistent with Human Rights Laws and Human Rights Principles (as each is defined below), to use and work with the Software (as defined below) within the full scope of Licensor’s copyright and patent rights, if any, in the Software, while ensuring attribution and protecting the Licensor from liability.
+
+Permission and Conditions. The Licensor grants permission by this license (“License”), free of charge, to the extent of Licensor’s rights under applicable copyright and patent law, to any person or entity (the “Licensee”) obtaining a copy of this software and associated documentation files (the “Software”), to do everything with the Software that would otherwise infringe (i) the Licensor’s copyright in the Software or (ii) any patent claims to the Software that the Licensor can license or becomes able to license, subject to all of the following terms and conditions:
+
+- Acceptance. This License is automatically offered to every person and entity subject to its terms and conditions. Licensee accepts this License and agrees to its terms and conditions by taking any action with the Software that, absent this License, would infringe any intellectual property right held by Licensor.
+
+- Notice. Licensee must ensure that everyone who gets a copy of any part of this Software from Licensee, with or without changes, also receives the License and the above copyright notice (and if included by the Licensor, patent, trademark and attribution notice). Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software. For clarity, although Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee with additional or different terms, the portion of the Software not modified must be distributed pursuant to this License. If anyone notifies Licensee in writing that Licensee has not complied with this Notice section, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice. If Licensee does not do so, Licensee’s License (and all rights licensed hereunder) shall end immediately.
+
+- Compliance with Human Rights Principles and Human Rights Laws.
+
+  1. Human Rights Principles.
+
+     (a) Licensee is advised to consult the articles of the United Nations Universal Declaration of Human Rights and the United Nations Global Compact that define recognized principles of international human rights (the “Human Rights Principles”). Licensee shall use the Software in a manner consistent with Human Rights Principles.
+
+     (b) Unless the Licensor and Licensee agree otherwise, any dispute, controversy, or claim arising out of or relating to (i) Section 1(a) regarding Human Rights Principles, including the breach of Section 1(a), termination of this License for breach of the Human Rights Principles, or invalidity of Section 1(a) or (ii) a determination of whether any Law is consistent or in conflict with Human Rights Principles pursuant to Section 2, below, shall be settled by arbitration in accordance with the Hague Rules on Business and Human Rights Arbitration (the “Rules”); provided, however, that Licensee may elect not to participate in such arbitration, in which event this License (and all rights licensed hereunder) shall end immediately. The number of arbitrators shall be one unless the Rules require otherwise.
+
+     Unless both the Licensor and Licensee agree to the contrary: (1) All documents and information concerning the arbitration shall be public and may be disclosed by any party; (2) The repository referred to under Article 43 of the Rules shall make available to the public in a timely manner all documents concerning the arbitration which are communicated to it, including all submissions of the parties, all evidence admitted into the record of the proceedings, all transcripts or other recordings of hearings and all orders, decisions and awards of the arbitral tribunal, subject only to the arbitral tribunal's powers to take such measures as may be necessary to safeguard the integrity of the arbitral process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3) Article 26(6) of the Rules shall not apply.
+
+  2. Human Rights Laws. The Software shall not be used by any person or entity for any systems, activities, or other uses that violate any Human Rights Laws. “Human Rights Laws” means any applicable laws, regulations, or rules (collectively, “Laws”) that protect human, civil, labor, privacy, political, environmental, security, economic, due process, or similar rights; provided, however, that such Laws are consistent and not in conflict with Human Rights Principles (a dispute over the consistency or a conflict between Laws and Human Rights Principles shall be determined by arbitration as stated above). Where the Human Rights Laws of more than one jurisdiction are applicable or in conflict with respect to the use of the Software, the Human Rights Laws that are most protective of the individuals or groups harmed shall apply.
+
+  3. Indemnity. Licensee shall hold harmless and indemnify Licensor (and any other contributor) against all losses, damages, liabilities, deficiencies, claims, actions, judgments, settlements, interest, awards, penalties, fines, costs, or expenses of whatever kind, including Licensor’s reasonable attorneys’ fees, arising out of or relating to Licensee’s use of the Software in violation of Human Rights Laws or Human Rights Principles.
+
+- Failure to Comply. Any failure of Licensee to act according to the terms and conditions of this License is both a breach of the License and an infringement of the intellectual property rights of the Licensor (subject to exceptions under Laws, e.g., fair use). In the event of a breach or infringement, the terms and conditions of this License may be enforced by Licensor under the Laws of any jurisdiction to which Licensee is subject. Licensee also agrees that the Licensor may enforce the terms and conditions of this License against Licensee through specific performance (or similar remedy under Laws) to the extent permitted by Laws. For clarity, except in the event of a breach of this License, infringement, or as otherwise stated in this License, Licensor may not terminate this License with Licensee.
+
+- Enforceability and Interpretation. If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, then such invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction; provided, however, subject to a court modification pursuant to the immediately following sentence, if any term or provision of this License pertaining to Human Rights Laws or Human Rights Principles is deemed invalid, illegal, or unenforceable against Licensee by a court of competent jurisdiction, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee. Upon a determination that any term or provision is invalid, illegal, or unenforceable, to the extent permitted by Laws, the court may modify this License to affect the original purpose that the Software be used in compliance with Human Rights Principles and Human Rights Laws as closely as possible. The language in this License shall be interpreted as to its fair meaning and not strictly for or against any party.
+
+- Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES “AS IS,” WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an Ethical Source license (https://ethicalsource.dev) and is offered for use by licensors and licensees at their own risk, on an “AS IS” basis, and with no warranties express or implied, to the maximum extent permitted by Laws.

data/README.md

@@ -0,0 +1,188 @@
+# wt_activerecord_index_spy
+
+[![Gem](https://img.shields.io/gem/v/wt_activerecord_index_spy)](https://rubygems.org/gems/wt_activerecord_index_spy)
+![GitHub Actions Workflow](https://github.com/WeTransfer/wt_activerecord_index_spy/actions/workflows/main.yml/badge.svg)
+[![Hippocratic License](https://img.shields.io/badge/license-Hippocratic-green)](https://github.com/WeTransfer/wt_activerecord_index_spy/blob/main/LICENSE.md)
+
+A Ruby library to watch and analyze queries that run using `ActiveRecord` to check
+if they use a proper index.
+
+It subscribes to `sql.active_record` notification using `ActiveSupport::Notifications`.
+
+It was designed to be used in tests, but it's also possible to use it in
+staging or production, carefully.
+
+## Why would I use this?
+
+Imagine you have an application running in production and after a deploy, it starts to slow down.
+
+After a perhaps exhaustive debugging session, you may find that a new query or perhaps a change
+in the database schema was responsible for starting to have queries that do not use database indexes.
+
+Then, you create the appropriate index and the problem is solved!
+
+By using this gem, you can get those queries that are not using suitable database indexes in
+your test suite. So you won't have surprises like the example above, after a deploy.
+
+You can also enable the gem in your development/staging environment, generate a report
+and analyze if there is any missing index.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wt_activerecord_index_spy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wt_activerecord_index_spy
+
+## Usage
+
+There are 3 different modes to use it:
+
+### 1 - Using a test matcher
+
+Include the helper in your RSpec configuration:
+
+```ruby
+require 'wt_activerecord_index_spy/test_helpers'
+
+RSpec.configure do |config|
+  config.include(WtActiverecordIndexSpy::TestHelpers)
+end
+```
+
+Use the helper `have_used_db_indexes` where you want to check if all queries used database indexes:
+
+```ruby
+it 'uses an index for all the queries' do
+  expect { SomeClass.some_method }.to have_used_db_indexes
+end
+```
+
+Given that some results are uncertain, it's also possible to set the matcher to fail only with certain results:
+
+```ruby
+it 'uses an index for all the queries' do
+  expect { SomeClass.some_method }.to have_used_db_indexes(only_certains: true)
+end
+```
+
+### 2 - Watching all queries from a start point
+
+Add this line to enable it:
+
+```ruby
+WtActiverecordIndexSpy.watch_queries
+```
+
+After that, `wt_activerecord_index_spy` will run an `EXPLAIN` query for every query
+fired with `ActiveRecord` that has a `WHERE` condition.
+
+Finally, you can generate a report with the results:
+
+```ruby
+WtActiverecordIndexSpy.export_html_results
+```
+
+This method creates an HTML file with a report and prints its location to STDOUT.
+
+The content of this file is similar to this:
+
+| Level | Identifier | Query | Origin |
+| ----  | ---------- | ----- | ------ |
+| certain | User Load | SELECT `users`.* FROM `users` WHERE `users`.`name` = 'lala' LIMIT 1  | spec/wt_activerecord_index_spy_spec.rb:162 |
+| uncertain | User Load | SELECT `users`.* FROM `users` WHERE `users`.`city_id` IN (SELECT `cities`.`id` FROM `cities` WHERE `cities`.`name` = 'Santo Andre') | spec/wt_activerecord_index_spy_spec.rb:173 |
+
+Where:
+- **Level**: `certain` when it is certain that an index is missing, or `uncertain` when it's not possible to be sure
+- **Identifier**: is the query identifier reported `ActiveRecord` notification
+- **Origin**: is the line the query was fired
+
+This mode, by default, **ignores** queries that were originated in test code. For that, it considers files which path includes `test/` or `spec/`.
+
+It's possible to disable it as follows:
+
+```ruby
+WtActiverecordIndexSpy.watch_queries(ignore_queries_originated_in_test_code: false)
+```
+
+If the same query runs in many places, only one origin will be added to the report.
+
+It's also possible to get the results using the following methods:
+
+```ruby
+# Returns a list of certain results
+WtActiverecordIndexSpy.certain_results
+
+# Returns a list of certain and uncertain results mixed
+WtActiverecordIndexSpy.results
+```
+
+### 3 - Watching all queries given a block
+
+It's also possible to enable it in a specific context, using a block:
+
+```ruby
+WtActiverecordIndexSpy.watch_queries do
+  # some code...
+end
+```
+
+After that, you can generate the HTML report with:
+
+```ruby
+WtActiverecordIndexSpy.export_html_results
+```
+
+## Supported versions
+
+Currently, it supports:
+
+**Ruby**: 2.7, 2.6, 2.5
+
+**Mysql**: 5.7
+
+**PostgreSQL**: 13.2
+
+Note: Currently, the PostgreSQL query analyser is not so intelligent and can't be
+certain if an index is missing or not. So all results are `uncertain`. More
+details in https://github.com/WeTransfer/wt_activerecord_index_spy/issues/12
+
+**ActiveRecord**: 6, 5, 4
+
+**RSpec**: 3.x
+
+## Development
+
+After checking out the repo, run `cp .env.template .env` and set database credentials to run the tests.
+
+Run `bin/setup` to install dependencies.
+
+Then, run `bundle exec rake db:create db:migrate` to create the Mysql databases and `ADAPTER=postgresql bundle exec rake db:create db:migrate` to create the PostgresSQL database.
+
+Then, run `bundle exec rspec` to run the tests for Mysql and `ADAPTER=postgresql bundle exec rspec`.
+
+You can also run `bundle exec bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wetransfer/wt_activerecord_index_spy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](./CODE_OF_CONDUCT.md).
+Please add your name to the [CONTRIBUTORS.md](./CONTRIBUTORS.md)
+
+## License
+
+The gem is available as open source under the terms of the [Hippocratic License](https://firstdonoharm.dev/version/2/1/license.html).
+
+## Code of Conduct
+
+Everyone interacting in the WT Activerecord Index Spy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](./CODE_OF_CONDUCT.md).