good_migrations 0.0.1

data/example/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/example/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/example/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/example/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'rails/performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionDispatch::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/example/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/good_migrations.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'good_migrations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "good_migrations"
+  spec.version       = GoodMigrations::VERSION
+  spec.authors       = ["Justin Searls", "Kevin Baribeau"]
+  spec.email         = ["searls@gmail.com", "kevin.baribeau@gmail.com"]
+
+  spec.summary       = %q{Prevents Rails from auto-loading app code in database migrations}
+  spec.description   = %q{Referencing code in app/ from a database migration risks breaking the migration when your app code changes; this gem prevents that mistake}
+  spec.homepage      = "https://github.com/testdouble/good-migrations"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+end

data/lib/good_migrations.rb

@@ -0,0 +1,3 @@
+require "good_migrations/version"
+require "good_migrations/load_error"
+require "good_migrations/railtie" if defined?(Rails)

data/lib/good_migrations/load_error.rb

@@ -0,0 +1,4 @@
+module GoodMigrations
+  class LoadError < ::LoadError
+  end
+end

data/lib/good_migrations/railtie.rb

@@ -0,0 +1,11 @@
+require "active_record/railtie"
+
+module GoodMigrations
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), '../../tasks/*.rake')].each do |file|
+        load file
+      end
+    end
+  end
+end

data/lib/good_migrations/version.rb

@@ -0,0 +1,3 @@
+module GoodMigrations
+  VERSION = "0.0.1"
+end

data/tasks/good_migrations.rake

@@ -0,0 +1,63 @@
+require 'active_support/dependencies'
+require 'good_migrations'
+
+namespace :good_migrations do
+  task :disable_autoload do
+    next if ENV['GOOD_MIGRATIONS'] == "skip"
+    ActiveSupport::Dependencies.class_eval do
+      extend Module.new {
+        def load_file(path, const_paths = loadable_constants_for_path(path))
+          if path.starts_with? File.join(Rails.application.root, 'app')
+            raise GoodMigrations::LoadError, <<-ERROR
+Rails attempted to auto-load:
+
+#{path}
+
+Which is in your project's `app/` directory. The good_migrations
+gem was designed to prevent this, because migrations are intended
+to be immutable and safe-to-run for the life of your project, but
+code in `app/` is liable to change at any time.
+
+The most common reason for this error is that you may be referencing an
+ActiveRecord model inside the migration in order to use the ActiveRecord API
+to implement a data migration by querying and updating objects.
+
+For instance, if you want to access a model "User" in your migration, it's safer
+to redefine the class inside the migration instead, like this:
+
+class MakeUsersOlder < ActiveRecord::Migration
+  class User < ActiveRecord::Base
+    # Define whatever you need on the User beyond what AR adds automatically
+  end
+
+  def up
+    User.find_each do |user|
+      user.update!(:age => user.age + 1)
+    end
+  end
+
+  def down
+    #...
+  end
+end
+
+For more information, visit:
+
+https://github.com/testdouble/good-migrations
+
+ERROR
+          else
+            super
+          end
+        end
+      }
+    end
+  end
+end
+
+Rake.application.in_namespace('db:migrate') do |namespace|
+  ([Rake::Task['db:migrate']] + namespace.tasks).each do |task|
+    task.prerequisites << "good_migrations:disable_autoload"
+  end
+end
+

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: good_migrations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Searls
+- Kevin Baribeau
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: pry
+  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'
+description: Referencing code in app/ from a database migration risks breaking the
+  migration when your app code changes; this gem prevents that mistake
+email:
+- searls@gmail.com
+- kevin.baribeau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/.gitignore
+- example/Gemfile
+- example/README
+- example/Rakefile
+- example/app/controllers/application_controller.rb
+- example/app/helpers/application_helper.rb
+- example/app/models/pant.rb
+- example/app/views/layouts/application.html.erb
+- example/config.ru
+- example/config/application.rb
+- example/config/boot.rb
+- example/config/database.yml
+- example/config/environment.rb
+- example/config/environments/development.rb
+- example/config/environments/production.rb
+- example/config/environments/test.rb
+- example/config/initializers/backtrace_silencers.rb
+- example/config/initializers/inflections.rb
+- example/config/initializers/mime_types.rb
+- example/config/initializers/secret_token.rb
+- example/config/initializers/session_store.rb
+- example/config/locales/en.yml
+- example/config/routes.rb
+- example/db/migrate/20160202162849_create_pants.rb
+- example/db/migrate/20160202163803_change_pants.rb
+- example/db/migrate/20160202182520_change_pants_dangerously.rb
+- example/db/seeds.rb
+- example/doc/README_FOR_APP
+- example/lib/tasks/.gitkeep
+- example/public/404.html
+- example/public/422.html
+- example/public/500.html
+- example/public/favicon.ico
+- example/public/images/rails.png
+- example/public/index.html
+- example/public/javascripts/application.js
+- example/public/javascripts/controls.js
+- example/public/javascripts/dragdrop.js
+- example/public/javascripts/effects.js
+- example/public/javascripts/prototype.js
+- example/public/javascripts/rails.js
+- example/public/robots.txt
+- example/public/stylesheets/.gitkeep
+- example/script/rails
+- example/test/performance/browsing_test.rb
+- example/test/test_helper.rb
+- example/vendor/plugins/.gitkeep
+- good_migrations.gemspec
+- lib/good_migrations.rb
+- lib/good_migrations/load_error.rb
+- lib/good_migrations/railtie.rb
+- lib/good_migrations/version.rb
+- tasks/good_migrations.rake
+homepage: https://github.com/testdouble/good-migrations
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Prevents Rails from auto-loading app code in database migrations
+test_files: []