deprecated_columns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84cf7ea6278f1e8dc25fd4057b20643a03b487ec
+  data.tar.gz: 529cd11e87e2eeffd4c8336745132f4aa540507e
+SHA512:
+  metadata.gz: 4938ee1ad63d749e44d9cdb13b15f6b4e9aa12113630f108864828369366065d826cafade716d77b425ffcc66c9777a4fdcb0ed785dfc50f5d49758fa90676f0
+  data.tar.gz: 6a33d174c844840bc2e0909c02e81b02b926c78c68cff26a0329fda86936f09aa6560da7c5ab44758a95d8e640dacca65c05437fb8472219d32a4b8fca6b3def

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in deprecated_columns.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Government Digital Service
+
+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,45 @@
+# DeprecatedColumns
+
+Permits a grace period for substractive column changes, via Active Record
+migrations.
+
+This was inspired by (read: entirely lifted) from Whitehall with a few
+modifications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```gem 'deprecated_columns'```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deprecated_columns
+
+## Usage
+
+```ruby
+class User < ActiveRecord::Base
+  deprecated_columns :name
+end
+```
+
+For subtractive migrations to columns in your schema you'll see a warning,
+unless you've specifically marked the column(s) using the `deprecated_columns`
+macro.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/alphagov/deprecated_columns. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "gem_publisher"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :publish_gem do |t|
+  gem = GemPublisher.publish_if_updated("deprecated_columns.gemspec", :rubygems)
+  puts "Published #{gem}" if gem
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deprecated_columns"
+
+# 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

data/bin/setup

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

data/deprecated_columns.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "deprecated_columns/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "deprecated_columns"
+  spec.version       = DeprecatedColumns::VERSION
+  spec.authors       = ["Ben Lovell"]
+  spec.email         = ["benjamin.lovell@gmail.com"]
+
+  spec.summary       = %q{Active Record compliant column/attribute deprecator}
+  spec.description   = %q{Mark column(s) for deprecation to permit subtractive schema changes in production.}
+  spec.homepage      = "https://www.gov.uk/"
+  spec.license       = "MIT"
+
+  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.required_ruby_version = ">= 2.0.0"
+
+  spec.add_dependency "rails", ">= 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "gem_publisher", "~> 1.1.1"
+end

data/jenkins.sh

@@ -0,0 +1,13 @@
+#!/bin/bash -xe
+
+# Gemfile.lock is not in source control because this is a gem
+rm -f Gemfile.lock
+
+git clean -fdx
+
+bundle install --path "${HOME}/bundles/${JOB_NAME}"
+bundle exec rake
+
+if [[ -n "$PUBLISH_GEM" ]]; then
+  bundle exec rake publish_gem
+fi

data/jenkins_branches.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+set -e
+
+VENV_PATH="${HOME}/venv/${JOB_NAME}"
+
+[ -x ${VENV_PATH}/bin/pip ] || virtualenv ${VENV_PATH}
+. ${VENV_PATH}/bin/activate
+
+pip install -q ghtools
+
+REPO="alphagov/deprecated_columns"
+gh-status "$REPO" "$GIT_COMMIT" pending -d "\"Build #${BUILD_NUMBER} is running on Jenkins\"" -u "$BUILD_URL" >/dev/null
+
+if ./jenkins.sh; then
+  gh-status "$REPO" "$GIT_COMMIT" success -d "\"Build #${BUILD_NUMBER} succeeded on Jenkins\"" -u "$BUILD_URL" >/dev/null
+  exit 0
+else
+  gh-status "$REPO" "$GIT_COMMIT" failure -d "\"Build #${BUILD_NUMBER} failed on Jenkins\"" -u "$BUILD_URL" >/dev/null
+  exit 1
+fi

data/lib/deprecated_columns.rb

@@ -0,0 +1,32 @@
+require "deprecated_columns/version"
+require "deprecated_columns/warn_on_column_removal"
+
+module DeprecatedColumns
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def deprecated_columns(*names)
+      unless self.respond_to?(:deprecated_column_list)
+        class_attribute :deprecated_column_list
+        self.deprecated_column_list = []
+      end
+
+      self.deprecated_column_list += names.map(&:to_s)
+
+      class_eval do
+        def attribute_names
+          super.reject { |name| deprecated_column_list.include?(name) }
+        end
+
+        def columns
+          super.reject { |column| deprecated_column_list.include?(column.name) }
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, DeprecatedColumns
+ActiveRecord::Migration.send :prepend, WarnOnColumnRemoval

data/lib/deprecated_columns/version.rb

@@ -0,0 +1,3 @@
+module DeprecatedColumns
+  VERSION = "0.1.0"
+end

data/lib/deprecated_columns/warn_on_column_removal.rb

@@ -0,0 +1,24 @@
+module WarnOnColumnRemoval
+  def remove_column(table_name, column_name, type = nil, options = {})
+    puts column_deprecation_status(table_name, column_name)
+
+    super
+  end
+
+  def column_deprecation_status(table_name, column_name)
+    begin
+      klass = table_name.to_s.singularize.camelize.constantize
+    rescue NameError
+      return "WARNING: Couldn't find model for table #{table_name}. I can't tell " +
+        "if column #{column_name} has been deprecated."
+    end
+
+    if klass.try(:deprecated_column_list).to_a.include?(column_name.to_s)
+      "OK: #{table_name}.#{column_name} has been deprecated."
+    else
+      "WARNING: #{table_name}.#{column_name} has not been deprecated. Please " +
+        "use the `deprecated_columns` macro to avoid crashing the application " +
+        "at deploy time."
+    end
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: deprecated_columns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Lovell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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: rspec-rails
+  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: sqlite3
+  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-byebug
+  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: gem_publisher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+description: Mark column(s) for deprecation to permit subtractive schema changes in
+  production.
+email:
+- benjamin.lovell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deprecated_columns.gemspec
+- jenkins.sh
+- jenkins_branches.sh
+- lib/deprecated_columns.rb
+- lib/deprecated_columns/version.rb
+- lib/deprecated_columns/warn_on_column_removal.rb
+homepage: https://www.gov.uk/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: Active Record compliant column/attribute deprecator
+test_files: []