zero_downtime 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90b2fb495197327ab698102779a0b606ae202f36
+  data.tar.gz: 32a7e5ee151c8f5f9c33349569a4f666f07e6a28
+SHA512:
+  metadata.gz: 878f523c0300154fa9c145a8c1de5181ea1524e51f4e2393be4f8a83a58645ece21eaae0a81a0327ce3e85566c9f4c892680feeeb145888c38f5234f694b274f
+  data.tar.gz: 25b2e870303b499762282565e34504660936848f645f56e335baf755c2d2983607e22433d7ea7518bd5d044e1a7cf21667db74d9fdea3e92ac5531e5435661b9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/gemfiles/*.gemfile.lock
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.2
+
+gemfile:
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
+
+script: bundle exec rspec spec

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'rails-4.0' do
+  gem 'activerecord', '~> 4.0.0'
+end
+
+appraise 'rails-4.1' do
+  gem 'activerecord', '~> 4.1.0'
+end
+
+appraise 'rails-4.2' do
+  gem 'activerecord', '~> 4.2.0'
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matthew Rudy Jacobs
+
+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,63 @@
+# ZeroDowntime
+
+[![Build Status](https://travis-ci.org/gogovan/zero_downtime.svg?branch=master)](https://travis-ci.org/gogovan/zero_downtime)
+
+This is a minimal library to help run zero-downtime with rails and activerecord
+
+## Deprecated Columns
+
+The most common use case is deprecating a column.
+
+If you just drop a column,
+it will break any existing process that has cached the columns.
+
+### Example
+
+We have a model `Person`
+
+It has a single column `:name`
+
+However we want to split this up into
+
+  * :first_name
+  * :last_name
+
+We add a migration
+
+```
+class AddFirstAndLastNamesToPeople < ActiveRecord::Migration
+  class SafePersone # safe model
+    self.table_name :people
+  end
+
+  def up
+    add_column :people, :first_name
+    add_column :people, :last_name
+
+    SafePerson.find_each do |person|
+      *first_names, last_name = person.name.split(" ")
+
+      person.first_name = first_names.join(" ")
+      person.last_name = last_name
+      person.save!
+    end
+  end
+end
+```
+
+That's fine,
+but what to do with the deprecated :name column?
+
+The answer, mark it as deprecated
+
+```
+class Person < ActiveRecord::Base
+  deprecate_column :name
+end
+```
+
+This will
+
+* Let us easily find it later
+* Stop anyone from using the column by accident
+* Ensure that once its deployed we can safely remove the column

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 'zero_downtime'
+
+# 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/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+
+gemspec :path => "../"

data/lib/zero_downtime/deprecatable.rb

@@ -0,0 +1,77 @@
+require 'active_support/concern'
+
+module ZeroDowntime
+  class DeprecatedColumn < RuntimeError
+  end
+
+  # Deprecatable adds the ability to deprecate columns
+  # to ActiveRecord
+  #
+  #   class MyModel < ActiveRecord::Base
+  #     deprecate_column :name
+  #   end
+  #
+  module Deprecatable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :deprecated_columns
+
+      class << self
+        alias_method_chain :columns, :deprecations
+      end
+    end
+
+    module ClassMethods
+      # deprecate a given column
+      # so it will be ignore by activerecord
+      # we can remove it once the deprecation is deployed
+      def deprecate_column(column_name)
+        deprecate_column_reader(column_name)
+        deprecate_column_writer(column_name)
+        override_attribute_methods
+
+        self.deprecated_columns ||= []
+        deprecated_columns << column_name.to_s
+      end
+
+      def columns_with_deprecations
+        all_columns = columns_without_deprecations
+        return all_columns unless deprecated_columns
+
+        all_columns.reject { |c| deprecated_columns.include?(c.name) }
+      end
+
+      private
+
+      def override_attribute_methods
+        return false if @attribute_methods_overriden
+
+        class_eval do
+          def attributes_with_deprecations
+            attributes_without_deprecations.except(*self.class.deprecated_columns)
+          end
+          alias_method_chain :attributes, :deprecations
+
+          def attribute_names_with_deprecations
+            attribute_names_without_deprecations - self.class.deprecated_columns
+          end
+          alias_method_chain :attribute_names, :deprecations
+        end
+        @attribute_methods_overriden = true
+      end
+
+      def deprecate_column_reader(column_name)
+        define_method(column_name) do
+          fail DeprecatedColumn, "attempted to read #{column_name}"
+        end
+      end
+
+      def deprecate_column_writer(column_name)
+        define_method("#{column_name}=") do |_|
+          fail DeprecatedColumn, "attempted to write #{column_name}"
+        end
+      end
+    end
+  end
+end

data/lib/zero_downtime/railtie.rb

@@ -0,0 +1,17 @@
+require 'zero_downtime/deprecatable'
+
+begin
+  require 'rails/railtie'
+
+  module ZeroDowntime
+    class Railtie < Rails::Railtie # :nodoc:
+      initializer 'zero_downtime.initialize' do
+        ActiveSupport.on_load(:active_record) do
+          ActiveRecord::Base.send :include, Deprecatable
+        end
+      end
+    end
+  end
+rescue LoadError
+  warn "can't load railtie"
+end

data/lib/zero_downtime/version.rb

@@ -0,0 +1,3 @@
+module ZeroDowntime # :nodoc:
+  VERSION = '0.2.1'
+end

data/lib/zero_downtime.rb

@@ -0,0 +1,8 @@
+require 'zero_downtime/version'
+require 'zero_downtime/deprecatable'
+require 'zero_downtime/railtie' if defined?(Rails)
+
+# ZeroDowntime is a simple library for enabling zero-downtime
+# with active record classes
+module ZeroDowntime
+end

data/zero_downtime.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zero_downtime/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'zero_downtime'
+  spec.version       = ZeroDowntime::VERSION
+  spec.authors       = ['Matthew Rudy Jacobs']
+  spec.email         = ['matthewrudyjacobs@gmail.com']
+
+  spec.summary       = <<-SUMMARY.strip
+    A simple library for running zero-downtime with Rails and ActiveRecord.
+  SUMMARY
+  spec.homepage      = 'https://github.com/gogovan/zero_downtime'
+  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_dependency 'activesupport', '>= 4.0.0', '< 5.0.0'
+  spec.add_dependency 'activerecord', '>= 4.0.0', '< 5.0.0'
+
+  spec.add_development_dependency 'rubocop', '~> 0.31.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'appraisal', '~> 2.0.0'
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: zero_downtime
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Matthew Rudy Jacobs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.31.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'
+- !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: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: 
+email:
+- matthewrudyjacobs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
+- lib/zero_downtime.rb
+- lib/zero_downtime/deprecatable.rb
+- lib/zero_downtime/railtie.rb
+- lib/zero_downtime/version.rb
+- zero_downtime.gemspec
+homepage: https://github.com/gogovan/zero_downtime
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A simple library for running zero-downtime with Rails and ActiveRecord.
+test_files: []