birdspotting 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5eee91abd57f9e2b8fd2b1ea4074048637ef84a6be504ab85106c5b6685cc851
+  data.tar.gz: 8ea9402c56cceac3fc6a62b58872b2dddbd90eb04f7c33e9bf6eee3bb4c30cc8
+SHA512:
+  metadata.gz: aa88d709c649cd4447c4bd01ebb2a4c21a8f2f445c7bc961fb432a6a1e8aab1292bd1e5602c96c11fb088373d9edbaf727c9d53639be54c16cbe01222bbf6657
+  data.tar.gz: 450ecba8b6d2f64677b03e552c82ebe8aee70e130f82374cafe8e2277807449b38fa382fcb2f0b397ae0003b5fd9917ea11fe850b0e4e87eceac899181a66b09

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+aliasses:
+  - &step_restore_vendor_cache
+    restore_cache:
+      keys:
+        - birdspotting-vendor-{{ .Branch }}-{{ .Revision }}
+        - birdspotting-vendor-{{ .Branch }}
+        - birdspotting-vendor-
+  - &step_save_vendor_cache
+    save_cache:
+      key: birdspotting-vendor-{{ .Branch }}-{{ .Revision }}
+      paths: [ vendor/bundle ]
+
+
+version: 2
+
+jobs:
+  test:
+    docker:
+      - image: circleci/ruby:2.4-jessie-node
+    steps:
+      - checkout
+      - *step_restore_vendor_cache
+      - run:
+          name: Install Ruby dependencies
+          command: bundle install --path vendor/bundle --jobs=2
+      - *step_save_vendor_cache
+      - run:
+          name: Run RSpec suite
+          command: |
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
+          environment:
+            RAILS_ENV: test
+      - store_test_results:
+          path: /tmp/test-results
+
+workflows:
+  version: 2
+
+  test:
+    jobs:
+      - test

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.swp
+*.gem
+*.swo
+
+.ruby-gemset
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,82 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "examples/*.rb"
+
+#
+# Opinionated cops
+#
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+#
+# Disabled cops
+#
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/BlockComments:
+  Exclude:
+    - "spec/spec_helper.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Style/Proc:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at david.bourguignon@drivy.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in birdspotting.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: .
+  specs:
+    birdspotting (0.1.0)
+      activerecord (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.59.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.29.1)
+      rubocop (>= 0.58.0)
+    ruby-progressbar (1.10.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  birdspotting!
+  bundler (~> 1.16)
+  guard-rspec
+  guard-rubocop
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  rubocop
+  rubocop-rspec
+  simplecov
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,47 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec", failed_mode: :focus do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 David Bourguignon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+
+# Birdspotting
+
+Some add-ons on `ActiveRecord::Migration` to make migration safer in the context of zero downtime deployment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'birdspotting'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install birdspotting
+
+## Usage
+
+### Configuration
+
+You can configure the gem (for instance by creating a `config/initializers/birdspotting.rb`) with the following options (here with the default values):
+
+```ruby
+Birdspotting.configure do |config|
+    config.start_check_at            = nil
+    config.check_bypass_env_var      = "BYPASS_SCHEMA_STATEMENTS_CHECK"
+
+    config.add_column_position_check = true
+
+    config.encoding_check            = true
+    config.encoding_check_message    = "\n/!\\ You are dealing with a %<type>s field" \
+    "(%<column_name>s): did you think about emojis and used the appropriate encoding? /!\\ \n\n"
+
+    config.rename_column_check       = true
+    config.rename_column_message     = "Don't use rename_column! https://stackoverflow.com/a/18542147"
+
+    config.remove_column_check        = true
+end
+```
+
+#### Common configuration
+
+`start_check_at` allows to start the checks after some migration version only. Set it to a migration 
+timestamp like 20151209000000 for instance. When nil, all migrations will be checked.
+
+`check_bypass_env_var` specify the ENV var allowing to bypass the checks.
+
+### add_column request position
+
+We like to keep or columns organised for the case where we don't use the ORM but some other client.
+
+This will raise a `Birdspotting::ColumnPositionMissingError` error if neither `:first` or `:after`
+is in the add_columns option.
+
+You can skip this validation by setting `add_column_position_check` to `false`. 
+
+### add_column encoding warning
+
+This will add a warning when adding a string (or text) column to warn us to think about encoding 
+issues. Like do we want to support emojis, or unusual characters?
+
+You can skip this validation by setting `encoding_check` to `false`. 
+You can customise the warning message by using the `encoding_check_message` setting.
+
+### rename_column
+
+By default, we don't want to use the rename column possibility as it will break any live application.
+And we want to be able to release and run migration without downtime.
+Though when a rename_column is used, it will raise a `Birdspotting::RenameColumnForbiddenError`.
+
+You can skip this validation by setting `rename_column_check` to `false`. 
+You can customise the warning message by using the `rename_column_message` setting.
+
+### remove_column
+
+By default, we don't want to be able to remove a columns which is still in use by a the application.
+
+Thus we check if the column is still present in the columns list.
+
+- If we are not able to find the model, we issue a `Birdspotting::ModelNotFoundError`.
+- If the column is still present in the model, we issue a `Birdspotting::RemoveColumnForbiddenError`.
+
+We advise to set the column in the `ignored_columns` of the model.
+
+You can skip this validation by setting `remove_column_check` to `false`. 
+
+### reorder columns [mySql only]
+
+As said above, we like to keep or columns organised for the case where 
+we don't use the ORM but some other client.
+
+This helper allow to reorder all the columns of a table.
+
+Usage:
+
+````ruby
+class ReorderPostsColumns < ActiveRecord::Migration[5.2]
+  include Birdspotting::ReorderColumns
+
+  def change
+    reorder_columns_for :posts, %i{
+      id
+      author
+      body
+      subject
+      posted_at
+      created_at
+      updated_at
+    }
+  end
+end
+````
+
+**CAVEAT:**
+
+* All columns must be passed in parameters (or it will raise a `Birdspotting::MismatchedColumnsError`).
+* For now, it only works on mysql (or it will raise a `Birdspotting::UnsupportedAdapterError`).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `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 tags, 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/drivy/birdspotting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Birdspotting project’s codebases and issue trackers is expected to follow the [code of conduct](https://github.com/drivy/birdspotting/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "birdspotting"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/birdspotting.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "birdspotting/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "birdspotting"
+  spec.version       = Birdspotting::VERSION
+  spec.authors       = ["Drivy", "Howard Wilson", "David Bourguignon"]
+  spec.email         = ["oss@drivy.com"]
+
+  spec.summary       = "Rails migration helpers."
+  spec.homepage      = "https://github.com/drivy/birdspotting"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_runtime_dependency "activerecord", ">= 5.0"
+end

data/lib/birdspotting.rb

@@ -0,0 +1,21 @@
+require "active_record"
+
+require "birdspotting/version"
+require "birdspotting/errors"
+require "birdspotting/configuration"
+require "birdspotting/schema_statements"
+require "birdspotting/reorder_columns"
+
+module Birdspotting
+  def self.configuration
+    @configuration || configure
+  end
+
+  def self.configure(&block)
+    @configuration = Configuration.default.tap do |config|
+      block&.call(config)
+    end
+  end
+end
+
+ActiveRecord::Migration.prepend Birdspotting::SchemaStatements

data/lib/birdspotting/configuration.rb

@@ -0,0 +1,35 @@
+class Birdspotting::Configuration
+  attr_accessor :start_check_at,
+                :check_bypass_env_var,
+                :add_column_position_check,
+                :encoding_check,
+                :encoding_check_message,
+                :rename_column_check,
+                :rename_column_message,
+                :remove_column_check
+
+  def self.default
+    new.tap do |config|
+      config.start_check_at = nil
+      config.check_bypass_env_var = "BYPASS_SCHEMA_STATEMENTS_CHECK"
+      config.add_column_position_check = true
+      config.encoding_check = true
+      config.encoding_check_message = "\n/!\\ You are dealing with a %<type>s field" \
+        "(%<column_name>s): did you think about emojis and used the appropriate encoding? /!\\ \n\n"
+      config.rename_column_check = true
+      config.rename_column_message = "Don't use rename_column! https://stackoverflow.com/a/18542147"
+      config.remove_column_check = true
+    end
+  end
+
+  %w[
+    add_column_position_check
+    encoding_check
+    rename_column_check
+    remove_column_check
+  ].each do |name|
+    define_method "#{name}?" do
+      public_send(name)
+    end
+  end
+end

data/lib/birdspotting/errors.rb

@@ -0,0 +1,24 @@
+module Birdspotting
+
+  class Error < StandardError
+  end
+
+  class ColumnPositionMissingError < Error
+  end
+
+  class RemoveColumnForbiddenError < Error
+  end
+
+  class ModelNotFoundError < Error
+  end
+
+  class RenameColumnForbiddenError < Error
+  end
+
+  class UnsupportedAdapterError < Error
+  end
+
+  class MismatchedColumnsError < Error
+  end
+
+end

data/lib/birdspotting/reorder_columns.rb

@@ -0,0 +1,50 @@
+module Birdspotting::ReorderColumns
+
+  def reorder_columns_for(table_name, ordered_columns)
+    check_if_supported
+    check_all_columns_present(ordered_columns, table_name)
+
+    column_types = column_types(table_name)
+
+    count = 0
+    ordered_columns.zip(ordered_columns.rotate)[0...-1].each do |column, column_after|
+      sql_type = column_types[column_after.to_s]
+      sql = <<~SQL
+        ALTER TABLE #{table_name} MODIFY COLUMN #{column_after} #{sql_type} AFTER #{column}, ALGORITHM=INPLACE, LOCK=NONE
+      SQL
+
+      message = "Moving #{column_after} after #{column} (#{count += 1} of #{ordered_columns.count})"
+      say_with_time message do
+        ActiveRecord::Base.connection.execute sql
+      end
+    end
+  end
+
+  private
+
+  def check_all_columns_present(ordered_columns, table_name)
+    columns = ActiveRecord::Base.connection.columns(table_name)
+    return if Set.new(ordered_columns.map(&:to_s)) == Set.new(columns.map(&:name))
+
+    raise Birdspotting::MismatchedColumnsError,
+          "All columns must be present on the #{table_name} table"
+  end
+
+  def column_types(table_name)
+    table_definition = ActiveRecord::Base
+                       .connection
+                       .execute("SHOW CREATE TABLE `#{table_name}`")
+                       .to_h[table_name.to_s]
+    column_definitions = table_definition.lines.map(&:strip).select { |l| l.starts_with?("`") }
+
+    Hash[column_definitions.map { |d| d.match(/`(.*)`\s*(.+?)(,|)\z/)[1, 2] }]
+  end
+
+  def check_if_supported
+    return if ActiveRecord::Base.connection_config[:adapter] == "mysql2"
+
+    raise Birdspotting::UnsupportedAdapterError,
+          "reorder_columns_for only supported with mysql2 adapter"
+  end
+
+end

data/lib/birdspotting/schema_statements.rb

@@ -0,0 +1,96 @@
+module Birdspotting::SchemaStatements
+
+  def add_column(table_name, column_name, type, options = {})
+    add_column_position_check(options)
+    encoding_check(column_name, type, options)
+
+    super
+  end
+
+  def rename_column(*args, **kwargs)
+    rename_column_check(kwargs)
+
+    super(*args)
+  end
+
+  def remove_column(table_name, column_name, type = nil, options = {})
+    remove_column_check(column_name, table_name, options)
+
+    super(table_name, column_name, type, options)
+  end
+
+  private
+
+  def rename_column_check(options)
+    return if bypass_check?(options)
+    return unless Birdspotting.configuration.rename_column_check?
+
+    raise Birdspotting::RenameColumnForbiddenError, Birdspotting.configuration.rename_column_message
+  end
+
+  def add_column_position_check(options)
+    return if bypass_check?(options)
+    return unless Birdspotting.configuration.add_column_position_check?
+    return unless options[:after].nil? && options[:first].nil?
+
+    raise Birdspotting::ColumnPositionMissingError,
+          "The :after or :first option is required when adding columns"
+  end
+
+  def encoding_check(column_name, type, options)
+    return if bypass_check?(options)
+    return unless Birdspotting.configuration.encoding_check?
+    return unless %i[text string].include?(type)
+
+    STDERR.puts sprintf(
+      Birdspotting.configuration.encoding_check_message,
+      type:        type,
+      column_name: column_name
+    )
+  end
+
+  def remove_column_check(column_name, table_name, options)
+    return if bypass_check?(options)
+    return unless Birdspotting.configuration.remove_column_check?
+
+    model = model_for(table_name)
+
+    unless model
+      raise Birdspotting::ModelNotFoundError,
+            "No model for `#{table_name}` table could be found. " \
+            "Is the associated model preloaded?" \
+            "Call the model at the beginning of the migration to ensure it is loaded." \
+            "Or use the :bypass_schema_statements_check option " \
+            "if you're sure of what you are doing."
+    end
+
+    if model.columns.map(&:name).include?(column_name.to_s) # rubocop:disable Style/GuardClause
+      raise Birdspotting::RemoveColumnForbiddenError,
+            "`#{column_name}` column should be added to ignored_columns in `#{model.name}` model" \
+            " before being removed. Use #{Birdspotting.configuration.check_bypass_env_var}" \
+            " env variable if you're sure of what you are doing."
+    end
+  end
+
+  def model_for(table_name)
+    model = ActiveRecord::Base.descendants.find { |t| t.table_name == table_name.to_s }
+    model || begin
+               table_name.to_s.classify.constantize
+             rescue StandardError
+               nil
+             end
+  end
+
+  def bypass_check?(options = {})
+    checkable_version? ||
+      options.delete(:bypass_schema_statements_check) ||
+      ENV.key?(Birdspotting.configuration.check_bypass_env_var)
+  end
+
+  def checkable_version?
+    version &&
+      Birdspotting.configuration.start_check_at &&
+      version <= Birdspotting.configuration.start_check_at
+  end
+
+end

data/lib/birdspotting/version.rb

@@ -0,0 +1,3 @@
+module Birdspotting
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: birdspotting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Drivy
+- Howard Wilson
+- David Bourguignon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- oss@drivy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- birdspotting.gemspec
+- lib/birdspotting.rb
+- lib/birdspotting/configuration.rb
+- lib/birdspotting/errors.rb
+- lib/birdspotting/reorder_columns.rb
+- lib/birdspotting/schema_statements.rb
+- lib/birdspotting/version.rb
+homepage: https://github.com/drivy/birdspotting
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Rails migration helpers.
+test_files: []