acread 0.5.0

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org/'
+
+# gem dependencies
+gem 'rails', '>= 3.0'
+
+# dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", ">= 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.8.4"
+  gem 'sqlite3'
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 yann ARMAND
+
+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,81 @@
+# acread
+[![Build Status](https://secure.travis-ci.org/yarmand/acread.png?branch=master)](http://travis-ci.org/yarmand/acread)
+
+acread is a gem that helps you deprecating ActiveRecord attributes.
+
+When you deprecate an attribute, acread can helps you in 3 ways :
+
+1. helps you finding where you are using this attribute by creating glue to raise a `DeprecatedAttributeError`.
+1. ignore this atribute when serializing the object through to_json, to_xml ...
+1. helps your zero downtime migration by ignoring the attribute for objects already in memory when saving to database.
+
+# Usage
+
+## Installation
+add to your Gemfile :
+
+    gem 'acread'
+
+## deprecate an attribute
+
+    class Person < ActiveRecord::Base
+      ...
+      deprecate_attribute :long_name
+      ...
+    end
+
+## find attribute usage
+you can catch the `DeprecatedAttributeError` exception and for example put a backtrace in a specific logger.
+
+    class ApplicationController
+    	rescue_from DeprecatedAttributeError, :with => :log_deprecate
+    	
+    	private
+    	
+    	def deprecated_logger
+    		@@deprecated_logger ||= Logger.new("#{Rails.root}/log/deprecated_calls.log")
+  		end
+    	
+    	def log_deprecated e
+    		deprecated_logger.error(e.stacktrace.join("\n"))
+    	end
+    end
+    
+## zero downtime migration
+When you are done with cleaning your code from any usage of deprecated attributes, you can prepare a migration including some drop_columns.
+
+example :
+
+    class RemoveLongNames < ActiveRecord::Migration
+      def self.up
+        remove_column :Person, :long_name
+
+      end
+
+      def self.down
+        raise ActiveRecord::IrreversibleMigration
+      end
+    end
+    
+Then you can safely follow the steps :
+
+
+1. Deploy your code with deprecation declaration in it
+1. Run the migration
+2. Remove deprecation declarations from your code
+3. Deploy your final clean version of code
+
+# Contributing to acread
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+# Copyright
+
+Copyright (c) 2012 yann ARMAND under MIT See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "acread"
+  gem.homepage = "http://github.com/yarmand/acread"
+  gem.license = "MIT"
+  gem.summary = %Q{An ActiveRecord Extension to deprecate attributes}
+  gem.description = %Q{When you deprecate an attribute, acread can helps you in 3 ways :
+
+1. helps you finding where you are using this attribute by creating glue to raise a `DeprecatedAttributeError`.
+2. ignore this atribute when serializing the object through to_json, to_xml ...
+3. helps your zero downtime migration by ignoring the attribute for objects already in memory when saving to database.}
+  gem.email = "yann@harakys.com"
+  gem.authors = ["yann ARMAND"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acread #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/acread.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "acread"
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["yann ARMAND"]
+  s.date = "2012-10-23"
+  s.description = "When you deprecate an attribute, acread can helps you in 3 ways :\n\n1. helps you finding where you are using this attribute by creating glue to raise a `DeprecatedAttributeError`.\n2. ignore this atribute when serializing the object through to_json, to_xml ...\n3. helps your zero downtime migration by ignoring the attribute for objects already in memory when saving to database."
+  s.email = "yann@harakys.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "acread.gemspec",
+    "lib/acread.rb",
+    "lib/acread/active_record_ext.rb",
+    "lib/acread/deprecatable.rb",
+    "test/helper.rb",
+    "test/test_acread.rb"
+  ]
+  s.homepage = "http://github.com/yarmand/acread"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "An ActiveRecord Extension to deprecate attributes"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 3.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+  end
+end
+

data/lib/acread.rb

@@ -0,0 +1,2 @@
+require 'acread/active_record_ext'
+

data/lib/acread/active_record_ext.rb

@@ -0,0 +1,20 @@
+require 'active_record'
+require 'acread/deprecatable'
+
+class ActiveRecord::Base
+  extend Deprecatable
+  
+  def columns
+    self.class.columns.reject { |c| (self.class.deprecated_attributes || []).include? c.name.to_s} 
+  end
+
+  # ensure the deprecated attributes will be skip when serialize the record
+  def serializable_hash(options = {})
+    options = {} if options.nil?
+    options = { 
+      :only => self.attributes.keys.map(&:to_sym) - (self.class.deprecated_attributes || []).map(&:to_sym)
+    }.update(options)
+    ActiveRecord::Serialization.instance_method( :serializable_hash ).bind( self ).call(options)
+  end
+
+end

data/lib/acread/deprecatable.rb

@@ -0,0 +1,25 @@
+module Deprecatable
+
+  def deprecate_attribute attr
+    @deprecated_attributes ||=[]
+    @deprecated_attributes << attr.to_s
+    overide_accessors attr
+  end
+
+  def deprecated_attributes
+    @deprecated_attributes
+  end
+
+  def overide_accessors attr
+    msg = "You can't access atribute #{attr}, it has been deprecated"
+    [ '', '=', '?', '_changed?'].each do |term|
+      define_method("#{attr}#{term}") do |e=nil|
+      raise DeprecatedAttributeError, msg 
+      end
+    end
+  end
+
+end
+
+class DeprecatedAttributeError < RuntimeError
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'acread'
+
+class Test::Unit::TestCase
+end

data/test/test_acread.rb

@@ -0,0 +1,69 @@
+require 'helper'
+
+class Person < ActiveRecord::Base
+  deprecate_attribute :long_name
+  establish_connection :adapter => 'sqlite3', :database => 'foobar.db'
+  connection.create_table table_name, :force => true do |t|
+    t.string :name
+    t.string :long_name
+  end
+end
+
+class PersonFull < ActiveRecord::Base
+  establish_connection :adapter => 'sqlite3', :database => 'foobar.db'
+  connection.create_table table_name, :force => true do |t|
+    t.string :name
+    t.string :long_name
+  end
+end
+
+
+class TestAcread < Test::Unit::TestCase
+  def setup
+    @bob = Person.create!(:name => 'bob')
+    @james = PersonFull.create(:long_name => 'James the magnific')
+  end
+
+  def test_cretor_with_deprecated_field_raise_exception
+    assert_raise(DeprecatedAttributeError) { Person.create(:long_name => 'should not see this')    }
+  end
+
+  def test_read_deprecated_raise_exception
+    assert_raise(DeprecatedAttributeError) { @bob.long_name }
+  end
+
+  def test_write_deprecated_raise_exception
+    assert_raise(DeprecatedAttributeError) { @bob.long_name = 'Bon' }
+  end
+
+
+  def test_hash_exclude_deprecated_attributes
+    h = @bob.serializable_hash
+    assert !(h.keys.include? 'long_name')
+  end
+
+  def test_columns_exclude_deprecated_attributes
+    h = @bob.send(:columns).map(&:name)
+    assert !(h.include? 'long_name')
+  end
+
+  def test_non_deprecated_class_can_read_all_attributes
+    assert @james.long_name.is_a? String
+  end
+ 
+  def test_non_deprecated_class_can_write_all_attributes
+    s = 'james the short'
+    @james.long_name = s
+    assert @james.long_name == s
+  end
+  
+  def test_non_deprecated_class_columns_output_all_attributes
+    h = @james.send(:columns).map(&:name)
+    assert h.include? 'long_name'
+  end
+  
+  def test_non_deprecated_class_hash_output_all_attributes
+    h = @james.serializable_hash
+    assert h.keys.include? 'long_name'
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: acread
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- yann ARMAND
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'When you deprecate an attribute, acread can helps you in 3 ways :
+
+
+  1. helps you finding where you are using this attribute by creating glue to raise
+  a `DeprecatedAttributeError`.
+
+  2. ignore this atribute when serializing the object through to_json, to_xml ...
+
+  3. helps your zero downtime migration by ignoring the attribute for objects already
+  in memory when saving to database.'
+email: yann@harakys.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- acread.gemspec
+- lib/acread.rb
+- lib/acread/active_record_ext.rb
+- lib/acread/deprecatable.rb
+- test/helper.rb
+- test/test_acread.rb
+homepage: http://github.com/yarmand/acread
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2680666247373849907
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An ActiveRecord Extension to deprecate attributes
+test_files: []