attr_deprecated 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmFkOWE1MDcyZGExNWZjNjkyODYxMjZiNTJmZGFkNDdhNzZjYjU5NA==
+  data.tar.gz: !binary |-
+    OTlmZTEyMzgwNGExY2ZkZTBkNmUxY2EzZWQ1NmU3NWM4MWM4OTg0Mg==
+SHA512:
+  metadata.gz: !binary |-
+    MjM1MDY3ZmUxZTkxOTRjZDhkMWIwMTNjNWUwMDk1ZGMxNWE4YTkzYWFjNjc4
+    NzY5ZWY1YzdiMDVkMGI5NGI1YzYzOTk5M2M1Yjg0Y2NiMDNiMGZlNGVjOWUx
+    OGE0NmNkM2Y0NDhiMTgzOWYwYTBkMTVkNzM1YmRjNWU5Yzg0M2M=
+  data.tar.gz: !binary |-
+    MjQwOTc5YzNhZDAwZjdhOWE3OWFmOTBmNWNiOTcyZDBhMzI0OGYxZDc0NTg5
+    NDQ0ODRmYjE5ZDBmMDUwZjc0ZWUxMWUzNTU5Zjg4NzZmMDg5ZGE0MGIyZWM1
+    ZGI4YTlkOGUyZDhlN2JmZTQzMWMxZmFhY2YxNGViODM4ODEwYWM=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rails', github: 'rails/rails', branch: '3-2-stable'
+
+# Specify your gem's dependencies in attr_deprecated.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Anthony Erlinger
+
+MIT License
+
+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,73 @@
+# AttrDeprecated
+
+A simple and non-intrusive way to mark deprecated columns/attributes in your models so they may be more safely removed.
+Any usage of a deprecated attribute will be logged with a warning message and a trace of where the deprecated attribute
+was called. Exceptions and Airbrake messages can be raised as well.
+
+## Why?
+
+Because we all have crap we don't want in our schema but are too afraid to remove.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'attr_deprecated'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attr_deprecated
+
+## Usage
+
+**In your model**
+
+    class User < ActiveRecord::Base
+      attr_deprecated :some_deprecated_column, :some_other_deprecated_column
+
+      ...
+    end
+
+**Example**:
+
+    > User.attr_deprecated
+     => <DeprecatedAttributeSet: {"some_deprecated_column", "some_other_deprecated_column"}>
+    >
+    > User.attr_deprecated? :some_deprecated_column
+     => true
+    >
+    > User.first.some_deprecated_column
+    WARNING: Called deprecated attribute on User: some_deprecated_column
+    .../.rvm/rubies/ruby-2.1.0/lib/ruby/2.1.0/irb.rb:396:in `start'
+    .../.rvm/gems/ruby-2.1.0/gems/railties-3.2.17/lib/rails/commands/console.rb:47:in `start'
+    .../.rvm/gems/ruby-2.1.0/gems/railties-3.2.17/lib/rails/commands/console.rb:8:in `start'
+    .../.rvm/gems/ruby-2.1.0/gems/railties-3.2.17/lib/rails/commands.rb:41:in `<top (required)>'
+    ...
+
+
+## TODO:
+
+Add configuration:
+
+Suppose you have a project with a `production`, `staging`, `development`, and `test` environment defined. You can define the behavior of attr_deprecated for each environment through the config params:
+
+    AttrDeprecated.configure do |config|
+      config.do_logging = [:production, :staging, :development, :test]
+      config.do_exceptions = [:production]
+
+      # Only if you're using Airbrake:
+      config.do_airbrake = [:production, :staging]
+    end
+
+
+## Contributing
+
+1. Fork it ( http://github.com/Aerlinger/attr_deprecated/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/attr_deprecated.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attr_deprecated/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attr_deprecated"
+  spec.version       = AttrDeprecated::VERSION
+  spec.authors       = ["Anthony Erlinger"]
+  spec.email         = ["anthony@handybook.com"]
+  spec.summary       = %q{Mark unused model attributes as deprecated.}
+  spec.description   = %q{A simple and non-intrusive way to mark deprecated columns/attributes in your models. Any usage of these attributes will logged with a warning message and a trace of where the deprecated attribute was called. An exception can be optionally raised as well.}
+  spec.homepage      = "https://github.com/Aerlinger/attr_deprecated"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', ['>= 3.0', '< 5.0']
+
+  spec.add_development_dependency 'activerecord', ['>= 3.0', '< 5.0']
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "2.14.1"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/active_model/deprecated_attribute_set.rb

@@ -0,0 +1,9 @@
+require 'set'
+
+module AttrDeprecated
+  class DeprecatedAttributeSet < Set
+    def ==(other_set)
+      Set.new(self) == Set.new(other_set)
+    end
+  end
+end

data/lib/attr_deprecated.rb

@@ -0,0 +1,92 @@
+require 'active_support'
+
+require "attr_deprecated/version"
+require "attr_deprecated/configuration"
+
+require "notifiers/deprecation_logger"
+require "active_model/deprecated_attribute_set"
+
+require 'active_record'
+require 'active_model'
+
+module AttrDeprecated
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :_deprecated_attributes, instance_writer: false
+  end
+
+  module ClassMethods
+    ##
+    # == attr_deprecated
+    #
+    # class macro definition to non-destructively mark an attribute as deprecated.
+    #
+    # The original method (i.e. the one marked as deprecated) is renamed and wrapped in an alias that dispatches the notification.
+    # (See the `around_alias` pattern. [Paolo Perotta. Metaprogramming Ruby, p. 121])
+    #
+    def attr_deprecated(*attributes)
+      attributes                  = DeprecatedAttributeSet.new(attributes.compact)
+      self._deprecated_attributes ||= DeprecatedAttributeSet.new
+
+      # Rails uses lazy initialization to wrap methods, so make sure we pre-initialize any deprecated attributes
+      if defined?(ActiveRecord) && ancestors.include?(ActiveRecord::Base)
+        new(Hash[attributes.zip(attributes.map {})], without_protection: true)
+      end
+
+      # Taking the difference of the two sets ensures we don't deprecate the same attribute more than once
+      (attributes - _deprecated_attributes).each do |attribute|
+        _set_attribute_as_deprecated attribute
+      end
+
+      self._deprecated_attributes += attributes
+    end
+
+    def deprecated_attribute?(attribute)
+      _deprecated_attributes.include?(attribute)
+    end
+
+    def deprecated_attributes
+      _deprecated_attributes || DeprecatedAttributeSet.new
+    end
+
+    def clear_deprecated_attributes!
+      self._deprecated_attributes = _deprecated_attributes.clear
+    end
+
+    def _set_attribute_as_deprecated(attribute)
+      original_method = instance_method(attribute.to_sym)
+
+      klass = self
+      define_method attribute.to_sym do |*args|
+        klass._notify_deprecated_attribute_call(attribute)
+
+        original_method.bind(self).call(*args)
+      end
+    end
+
+    def _notify_deprecated_attribute_call(attribute)
+      @_deprecation_logger ||= AttrDeprecated::DeprecatedAttributeLogger.new(self)
+
+      @_deprecation_logger.log_deprecated_attribute_usage(self, attribute)
+    end
+  end
+end
+
+module AttrDeprecated
+  class << self
+    include AttrDeprecated::Configuration
+
+    def configure(&block)
+      AttrDeprecated::Configuration.configure(&block)
+    end
+  end
+end
+
+if defined? Rails || ENV['test']
+  class ActiveRecord::Base
+    include AttrDeprecated
+  end
+
+  require 'attr_deprecated/railtie.rb' if defined?(Rails)
+end

data/lib/attr_deprecated/configuration.rb

@@ -0,0 +1,23 @@
+require 'active_support/concern'
+
+module AttrDeprecated
+  module Configuration
+    extend ActiveSupport::Concern
+
+    included do
+      add_config :log_environments
+      add_config :exception_environments
+      add_config :airbrake_environments
+    end
+
+    module ClassMethods
+      def configure
+        yield self
+      end
+
+      def add_config(value)
+        @name = value if value
+      end
+    end
+  end
+end

data/lib/attr_deprecated/railtie.rb

@@ -0,0 +1,17 @@
+require 'rails/railtie'
+
+module AttrDeprecated
+  class Railtie < ::Rails::Railtie
+    initializer "attr_deprecated.active_record", :before => "active_record.set_configs" do |app|
+      ActiveSupport.on_load :active_record do
+        require 'attr_deprecated'
+
+        if app.config.respond_to?(:active_record)
+          class ActiveRecord::Base
+            include AttrDeprecated
+          end
+        end
+      end
+    end
+  end
+end

data/lib/attr_deprecated/version.rb

@@ -0,0 +1,3 @@
+module AttrDeprecated
+  VERSION = "0.0.2"
+end

data/lib/notifiers/airbrake_notifier.rb

@@ -0,0 +1,17 @@
+module AttrDeprecated
+  class AirbrakeNotifier
+    def initialize(target)
+      @target = target
+    end
+
+    def notify_airbrake(attribute)
+      if defined?(Airbrake)
+        Airbrake.notify Exception.new
+                          "WARNING: Called deprecated attribute for #{klass.name}: #{attrs.join(', ')}\n" +
+                          backtrace.map { |trace| "\t#{trace}" }.join("\n")
+
+      end
+    rescue
+    end
+  end
+end

data/lib/notifiers/deprecation_logger.rb

@@ -0,0 +1,36 @@
+module AttrDeprecated
+  class DeprecatedAttributeLogger
+    def initialize(target)
+      @target = target
+      super()
+    end
+
+    def logger
+      @target.logger
+    end
+
+    def logger?
+      @target.respond_to?(:logger) && @target.logger
+    end
+
+    def backtrace
+      if defined? Rails
+        Rails.backtrace_cleaner.clean(caller)
+      else
+        caller
+      end
+    end
+
+    def log_deprecated_attribute_usage(klass, *attrs)
+      warning_message = "WARNING: Called deprecated attribute on #{klass.name}: #{attrs.join(', ')}\n" +
+        backtrace.map { |trace| "\t#{trace}" }.join("\n")
+      if logger?
+        logger.warn do
+          warning_message
+        end
+      else
+        puts warning_message
+      end
+    end
+  end
+end

data/spec/attr_deprecated_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+class Foo
+  include AttrDeprecated
+
+  attr_accessor :fresh_attribute,
+                :an_unused_attribute
+  attr_deprecated :an_unused_attribute
+end
+
+describe "Sample spec" do
+  specify "AttrDeprecated is defined" do
+    defined?(AttrDeprecated).should be_true
+  end
+
+  specify "A class that extends AttrDeprecated::Model will have attr_deprecated defined" do
+    Foo.methods.should include(:attr_deprecated)
+  end
+
+  it "has attr deprecated" do
+    Foo.deprecated_attributes.should eq [:an_unused_attribute]
+  end
+
+  describe "A class includes AttrDeprecated" do
+    before do
+      @f = Foo.new
+      @f.an_unused_attribute = "asdf"
+      @f.fresh_attribute = "fresh"
+    end
+
+    describe "declaring an unused attribute as deprecated" do
+      specify ".attr_deprecated? includes :an_unused_attribute" do
+        Foo.deprecated_attribute?(:an_unused_attribute).should be_true
+      end
+
+      specify "A getter attribute is defined as deprecated" do
+        @f.should_receive(:an_unused_attribute).exactly(1).times.and_call_original
+        Foo.should_receive(:_notify_deprecated_attribute_call)
+
+        @f.should_not_receive(:an_unused_attribute=)
+
+        @f.an_unused_attribute.should eq("asdf")
+      end
+
+      specify "A setter attribute is defined as deprecated" do
+        Foo.should_receive(:_notify_deprecated_attribute_call).exactly(2).times.and_call_original
+
+        @f.an_unused_attribute = "omg"
+        @f.an_unused_attribute
+        @f.an_unused_attribute.should eq("omg")
+      end
+
+      specify "calling attr_deprecated more than once shouldn't cause infinite regress" do
+        Foo.class_eval { attr_deprecated :an_unused_attribute }
+
+        @f.an_unused_attribute.should eq("asdf")
+      end
+    end
+
+    describe "Adding a new deprecated attribute (more than once)" do
+      before do
+        Foo.class_eval { attr_deprecated :fresh_attribute, :fresh_attribute}
+      end
+
+      it "only calls fresh_attribute once" do
+        @f.should_receive(:fresh_attribute).exactly(1).times.and_call_original
+
+        @f.fresh_attribute.should eq("fresh")
+      end
+    end
+
+    describe "clearing deprecated attributes" do
+      before do
+        Foo.clear_deprecated_attributes!
+      end
+
+      it "Doesn't have any deprecated attributes" do
+        Foo.deprecated_attributes.should eq([])
+      end
+    end
+  end
+
+  describe "A class doesn't have any deprecated attributes initially" do
+    before do
+      @dummy_class = Class.new do
+        include AttrDeprecated
+      end
+    end
+
+    it "empty deprecated attributes" do
+      @dummy_class.deprecated_attributes.should eq([])
+    end
+
+    it "calling attr_deprecated alone doesn't raise an error" do
+      @dummy_class.class_eval do
+        attr_deprecated
+      end
+
+      @dummy_class.deprecated_attributes.should eq([])
+    end
+  end
+end

data/spec/attr_deprected_active_record_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+class User < ActiveRecord::Base
+  attr_deprecated :a_deprecated_attribute
+end
+
+describe "Integration with ActiveRecord" do
+  before do
+    ActiveRecord::Base.send(:descendants).each do |klass|
+      begin
+        klass.delete_all
+      rescue
+      end
+    end
+  end
+
+  let!(:user) { User.new(name: "rspec", a_deprecated_attribute: "wtf") }
+
+  it "has :a_deprecated_attribute method" do
+    User.instance_methods.should include(:a_deprecated_attribute)
+  end
+
+  it "ensures we've initialized ActiveRecord correctly for our test suite" do
+    user.save!
+
+    expect(user.persisted?).to be_true
+    expect(user.a_deprecated_attribute).to eq("wtf")
+  end
+
+  it "has one deprecated attribute" do
+    expect(User.deprecated_attributes).to eq([:a_deprecated_attribute])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+Bundler.setup
+
+ENV['test'] = 'test'
+
+require 'attr_deprecated'
+require 'support/active_record'
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end

data/spec/support/active_record.rb

@@ -0,0 +1,17 @@
+require 'attr_deprecated'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+ActiveRecord::Schema.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.string :email
+    t.string :a_deprecated_attribute
+    t.timestamps
+  end
+end
+
+class User < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: attr_deprecated
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Anthony Erlinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !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'
+description: A simple and non-intrusive way to mark deprecated columns/attributes
+  in your models. Any usage of these attributes will logged with a warning message
+  and a trace of where the deprecated attribute was called. An exception can be optionally
+  raised as well.
+email:
+- anthony@handybook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attr_deprecated.gemspec
+- lib/active_model/deprecated_attribute_set.rb
+- lib/attr_deprecated.rb
+- lib/attr_deprecated/configuration.rb
+- lib/attr_deprecated/railtie.rb
+- lib/attr_deprecated/version.rb
+- lib/notifiers/airbrake_notifier.rb
+- lib/notifiers/deprecation_logger.rb
+- spec/attr_deprecated_spec.rb
+- spec/attr_deprected_active_record_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: https://github.com/Aerlinger/attr_deprecated
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Mark unused model attributes as deprecated.
+test_files:
+- spec/attr_deprecated_spec.rb
+- spec/attr_deprected_active_record_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb