column_hider 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d4fc13bfe9f49a63d59c3b6df79228de6fa5950
-  data.tar.gz: 725c675d14826b9472abfa07a1ec47475e1f956a
+  metadata.gz: badf7c2c991d783e0e4b34b2008ad9e4dc05cc09
+  data.tar.gz: ba10ae1db681ea76972df423cda94c0da7372c3d
 SHA512:
-  metadata.gz: 7cbe3d3a3b1ea959faa82b892548001be553975c5e4f470e87a422c50c9191a89f958797f7ccf915f7fc37537f7cee9169cf2748d2b504374cc02e9c8fc423d1
-  data.tar.gz: 8d22ed88c39f9dd44fc2b4267530fb78b76f3ba41d007bbf9986e06854a773232c390831b5a97695e2ae16e5cebc8eee055cf5aaa509ccaaf7eaf0fd1df67578
+  metadata.gz: f49d270c3bf75e4f9feb9923729ea2f3834558dae2808db87b3d042b62437d20d3816e632914fdaf76cc88297efe09213d4f5a1d67594c1c0dd178a432627acb
+  data.tar.gz: 8d1cd306bf2e5886f85dc86fd5c581afd3be6f61edd9170a4d1614f2ab0e23254d73b4b1e1a832aeb114917d9222f6e85fc0791936f26274649a585de0531d80

data/{README.rdoc → README.md}

@@ -1,71 +1,84 @@
-= ColumnHider
+# ColumnHider
 
-== Procedure for deleting or renaming database columns in Rails applications
+## Procedure for deleting or renaming database columns in Rails applications
 
-=== Avoiding downtime, or reliability issues during deploys
+### Avoiding downtime, or reliability issues during deploys
 
-Ian Hall
-May 2015
+Ian Hall, May 2015
+
+___
 
----
 The process of deleting or renaming columns in a production database has some hidden dangers, more or less severe depending on how long it takes to run different parts of your deployment process.
 
 This procedure aims to completely avoid these issues. If you can’t afford an deployment outage and want your application to be as close to 100% available as possible, you might like to consider this procedure.
 
----
-== Renaming columns
-
-The simple solution to this is: don’t do it! Instead:
-
-* create a new column with the desired name
-* migrate all data from the old column to the new column
-* change all references to the old column name in your code to use the new column name
-* (optional) use the column-deletion procedure below to remove the old column
-
-The second step, migrating data from old to new columns, may need to be repeated before the fourth step if there is any gap in time which allows data to be updated between steps two and three.
+___
 
-== Column-deletion procedure
-=== Problem Definition
+## Column-deletion procedure
+### Problem Definition
 
-When a Rails model is first used in a running Rails application, all the columns in the underlying database table are enumerated. The list of columns is kept in a class instance variable of an <code>ActiveRecord::Attribute::ClassMethods</code> method named +columns+.  Once created, this variable persists for the lifetime of the running application.
+When a Rails model is first used in a running Rails application, all the columns in the underlying database table are enumerated. The list of columns is kept in a class instance variable of an <code>ActiveRecord::Attribute::ClassMethods</code> method named `columns`.  Once created, this variable persists for the lifetime of the running application.
 
 Caching the column names this way is a good performance enhancement for the application, but it can lead to problems during or after database changes.
 
-Without the procedure described below, one would run a migration to physically remove the column-to-be-deleted (+CTBD+), then deploy a new version of the application, with all references to the +CTBD+ removed. After successful deployment, restart the application.
+Without the procedure described below, one would run a migration to physically remove the column-to-be-deleted (`CTBD`), then deploy a new version of the application, with all references to the `CTBD` removed. After successful deployment, restart the application.
 
 <b>The danger period is the interval between the migration completing and the application restarting.</b>
 
 Even though this interval may be relatively short - perhaps only a minute or two - if it’s possible that the running application will access the table that you’ve changed with the migration, then you’ll run into a problem.
 
-=== Solution
+### Solution
+
+The solution to this problem lies in overriding the `ActiveRecord` columns method described above.
 
-The solution to this problem lies in overriding the +ActiveRecord+ columns method described above.
+* Step One
 
-[Step One] Add the gem to your Gemfile.
+  Add the `column_hider` gem to your Gemfile and run `bundle install`.
 
-In the model for your application which contains the +CTBD+, add these two lines:
+  In the model for your application which contains the `CTBD`, add these two lines:
 
-  extend ColumnHider
-  column_hider_columns :column_one
+  ```ruby  
+    extend ColumnHider::ActiveRecordAttributes   
+    column_hider_columns :column_one
+  ```   
 
-where +:column_one+ is the +CTBD+.
+  where `:column_one` is the `CTBD`.
 
-This logically deletes the column from the application - whenever the application accesses the model, the column will be removed from the list of columns that the application knows about.
+  This logically deletes the column from the application - whenever the application accesses the model, the column will be removed from the list of columns that the application knows about.
 
-Then go through your application in the normal way and remove all other references to the +CTBD+.
+  Then go through your application in the normal way and remove all other references to the `CTBD`.
 
-[Step Two] Deploy the code changes made in Step One.
+* Step Two
+ 
+  Deploy the code changes made in Step One.
 
-At this point, your application will know nothing about the +CTBD+, and you can now go on to physically remove the +CTBD+.
+  At this point, your application will know nothing about the `CTBD`.
 
-[Step Three] Create and deploy a Rails migration to physically remove the +CTBD+.
+* Step Three
+ 
+  Create and deploy a Rails migration to physically remove the `CTBD`.
 
-[Step Four] Remove the two lines from your model that were added in Step One. Deploy this whenever …
+* Step Four
 
-[Step Five] … and relax!
+  Remove the two lines from your model that were added in Step One. Deploy this whenever …
+
+* Step Five
+ 
+  … and relax!
+
+## Renaming columns
+
+The simple solution to this is: don’t do it! Instead:
+
+* create a new column with the desired name
+* migrate all data from the old column to the new column
+* change all references to the old column name in your code to use the new column name
+* (optional) use the column-deletion procedure above to remove the old column
+
+The second step, migrating data from old to new columns, may need to be repeated before the fourth step if there is any gap in time which allows data to be updated between steps two and three.
 
-== Conclusion
+## Conclusion
 
-This might seem like a long-winded way to go about it, but it guarantees that you will avoid any problems in your running application when deleting or renaming columns.
+This might seem like a long-winded way to go about it, but it will help you avoid any problems in your running application when deleting or renaming columns.
 
 Your mileage may vary, depending on the usage pattern of your application. If you can afford to take downtime and close down user access during a deployment window, you can safely run a destructive migration followed by an application deploy.

data/lib/column_hider/version.rb

@@ -1,3 +1,3 @@
 module ColumnHider
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/column_hider.rb

@@ -8,7 +8,7 @@ module ColumnHider
   # `  extend ColumnHider`
   # `  column_hider_columns :column_one, :column_two, ...`
   #
-
+  module ActiveRecordAttributes
     def column_hider_columns(*cols)
       @column_hider_columns = []
       cols.each do |col|
@@ -20,4 +20,6 @@ module ColumnHider
       @column_hider_columns ||= [] # just in case the model includes the line "  extend ColumnHider", but doesn't call column_hider_columns
       super.reject { |col| @column_hider_columns.include?(col.name) }
     end
+  end
+
 end

data/test/column_hider_test.rb

@@ -15,7 +15,7 @@ describe ColumnHider do
         t.string :capital
         t.string :comment
       end
-      extend ColumnHider
+      extend ColumnHider::ActiveRecordAttributes
       column_hider_columns :capital
     end
   end

data/test/dummy/log/test.log

@@ -85,3 +85,12 @@
    (0.2ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
    (0.1ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
    (0.2ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
+   (0.2ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
+   (0.2ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
+   (0.1ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
+   (0.3ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
+   (0.1ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
+   (0.2ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
+   (0.3ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
+   (0.2ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 
+   (0.1ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "capital" varchar, "comment" varchar) 

metadata

@@ -1,44 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: column_hider
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Flashfunders
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Superclasses the 'columns' method of ActiveRecord's Attribute class and
+        version: '1.3'
+description: Superclasses the "columns method" of ActiveRecords Attribute class and
   dynamically removes your chosen column(s).
 email:
 - engineering@flashfunders.com
@@ -47,7 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/column_hider.rb
 - lib/column_hider/version.rb