deprecation_rails 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+
+# OS generated files.
+.DS_Store*
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# VIM.
+.*.sw[a-z]
+*.un~
+Session.vim
+
+# Yard
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--debug

data/.travis.yml

@@ -0,0 +1,5 @@
+---
+language: ruby
+rvm:
+- 1.9.2
+- 1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,112 @@
+PATH
+  remote: .
+  specs:
+    deprecation_rails (0.0.0)
+      rails (>= 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.11)
+      actionpack (= 3.2.11)
+      mail (~> 2.4.4)
+    actionpack (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    columnize (0.3.6)
+    debugger (1.2.3)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.5)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.6)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.6)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    polyglot (0.3.3)
+    rack (1.4.3)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.11)
+      actionmailer (= 3.2.11)
+      actionpack (= 3.2.11)
+      activerecord (= 3.2.11)
+      activeresource (= 3.2.11)
+      activesupport (= 3.2.11)
+      bundler (~> 1.0)
+      railties (= 3.2.11)
+    railties (3.2.11)
+      actionpack (= 3.2.11)
+      activesupport (= 3.2.11)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger (~> 1.2.2)
+  deprecation_rails!
+  rake
+  rspec (~> 2.12.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jey Balachandran
+
+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,47 @@
+# deprecation_rails [![Build Status](https://travis-ci.org/jeyb/deprecation_rails.png)](https://travis-ci.org/jeyb/deprecation_rails)
+Deprecation policies for your Rails application.
+
+## Usage
+Deprecations can occur on classes or methods.
+
+### Deprecating classes
+```ruby
+class Array
+  include Deprecation::Notifier # Rails controllers and models will have this included by default.
+  deprecate at: Date.parse("2013-01-12"), message: "Use BetterArray instead."
+end
+```
+
+This will output:
+```
+DEPRECATION WARNING: Array is deprecated as of 2013-01-12 00:00:00 -0800. Use BetterArray instead. (called from block (2 levels) in <top (required)> at /../array.rb:11)
+```
+
+### Deprecating methods
+```ruby
+class Array
+  include Deprecation::Notifier # Rails controllers and models will have this included by default.
+
+  def id
+    object_id
+  end
+  deprecate :id, at: Date.parse("2013-01-12"), message: "Use object_id instead."
+end
+```
+
+This will output:
+```
+DEPRECATION WARNING: Array#id is deprecated as of 2013-01-12 00:00:00 -0800. Use object_id instead. (called from block (2 levels) in <top (required)> at /../array.rb:4)
+```
+
+## Contributing to deprecation_rails
+* 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) 2013 Jey Balachandran. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require "rubygems"
+require "bundler/setup"
+require "rake"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => exception
+  $stderr.puts exception.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit exception.status_code
+end
+
+require "rspec/core"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task default: :spec

data/deprecation_rails.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "deprecation_rails"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Jey Balachandran"]
+  gem.email         = ["jey.balachandran@gmail.com"]
+  gem.summary       = %q{Deprecation policies for your Rails application.}
+  gem.description   = %q{Deprecation policies for your Rails application.}
+  gem.homepage      = "http://github.com/jeyb/deprecation_rails"
+  gem.license       = "MIT"
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 1.9.2"
+
+  gem.add_dependency "rails", ">= 3.0"
+
+  gem.add_development_dependency "debugger", "~> 1.2.2"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.12.0"
+end

data/lib/deprecation.rb

@@ -0,0 +1,6 @@
+require "deprecation/version"
+require "deprecation/notifier"
+require "deprecation/engine" if defined?(Rails)
+
+module Deprecation
+end

data/lib/deprecation/engine.rb

@@ -0,0 +1,15 @@
+module Deprecation
+  class Engine < ::Rails::Engine
+    initializer "deprecation.initialize" do |app|
+      require "deprecation"
+
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send :include, Deprecation::Notifier
+      end
+
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :include, Deprecation::Notifier
+      end
+    end
+  end
+end

data/lib/deprecation/notifier.rb

@@ -0,0 +1,47 @@
+module Deprecation
+  module Notifier
+    extend ActiveSupport::Concern
+
+    class << self
+      def __deprecation_logger__(class_name, method_name, options = {})
+        options = options.symbolize_keys
+
+        if options[:at].nil? || options[:at].to_time <= Time.now
+          message = class_name
+          message << "#" << method_name if method_name
+          message << " is deprecated"
+          message << (options[:at].present?? " as of #{options[:at]}." : ".")
+          message << " " << options[:message] if options[:message]
+
+          ActiveSupport::Deprecation.warn(message, caller[1..-1])
+        end
+      end
+    end
+
+    module ClassMethods
+      def deprecate(*args)
+        return if defined?(Rails) && Rails.env.production?
+
+        if args.size == 0 || args.first.is_a?(Hash)
+          deprecate_class(*args)
+        else
+          deprecate_method(*args)
+        end
+      end
+
+      private
+
+      def deprecate_class(options = {})
+        Deprecation::Notifier.__deprecation_logger__(self.class.name, nil, options)
+      end
+
+      def deprecate_method(method_name, options = {})
+        method = instance_method(method_name)
+        define_method(method_name) do |*args, &block|
+          Deprecation::Notifier.__deprecation_logger__(self.class.name, method_name.to_s, options)
+          method.bind(self).(*args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/deprecation/version.rb

@@ -0,0 +1,3 @@
+module Deprecation
+  VERSION = "0.0.1"
+end

data/spec/lib/deprecation_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+class DeprecatedMethodsTest
+  include Deprecation::Notifier
+  DAY = 24 * 60 * 60
+
+  def deprecated_method
+  end
+  deprecate :deprecated_method
+
+  def deprecated_method_with_custom_message
+  end
+  deprecate :deprecated_method_with_custom_message, message: "That Shit Cray"
+
+  def deprecated_method_as_of_yesterday
+  end
+  deprecate :deprecated_method_as_of_yesterday, at: Time.now - DAY
+
+  def deprecated_method_starting_tomorrow
+  end
+  deprecate :deprecated_method_starting_tomorrow, at: Time.now + DAY
+
+  def undeprecated_method
+  end
+end
+
+describe Deprecation do
+  subject { DeprecatedMethodsTest.new }
+
+  it "calls the deprecation logger when the method is deprecated" do
+    ActiveSupport::Deprecation.should_receive(:warn)
+    subject.deprecated_method
+  end
+
+  it "calls the deprecation logger when the method is deprecated with a custom message" do
+    ActiveSupport::Deprecation.should_receive(:warn)
+    subject.deprecated_method_with_custom_message
+  end
+
+  it "calls the deprecation logger for methods deprecated as of yesterday" do
+    ActiveSupport::Deprecation.should_receive(:warn)
+    subject.deprecated_method_as_of_yesterday
+  end
+
+  it "doesn't call the deprecation logger when the method isn't deprecated" do
+    ActiveSupport::Deprecation.should_not_receive(:warn)
+    subject.undeprecated_method
+  end
+
+  it "doesn't call the deprecation logger for methods deprecated starting tomorrow" do
+    ActiveSupport::Deprecation.should_not_receive(:warn)
+    subject.deprecated_method_starting_tomorrow
+  end
+
+  it "calls the deprecation logger when the class is defined" do
+    ActiveSupport::Deprecation.should_receive(:warn).once
+
+    class DeprecatedClassTest
+      include Deprecation::Notifier
+      deprecate
+
+      def undeprecated_method
+      end
+    end
+
+    subject = DeprecatedClassTest.new
+    subject.undeprecated_method
+  end
+
+  it "doesn't call the deprecation logger when the class is defined for class deprecated starting tomorrow" do
+    ActiveSupport::Deprecation.should_not_receive(:warn)
+
+    class DeprecatedClassTest
+      include Deprecation::Notifier
+      deprecate at: Time.now + DeprecatedMethodsTest::DAY
+
+      def undeprecated_method
+      end
+    end
+
+    subject = DeprecatedClassTest.new
+    subject.undeprecated_method
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "rails/all"
+require "deprecation"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: deprecation_rails
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Jey Balachandran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Deprecation policies for your Rails application.
+email:
+- jey.balachandran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- deprecation_rails.gemspec
+- lib/deprecation.rb
+- lib/deprecation/engine.rb
+- lib/deprecation/notifier.rb
+- lib/deprecation/version.rb
+- spec/lib/deprecation_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jeyb/deprecation_rails
+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: 1.9.2
+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: Deprecation policies for your Rails application.
+test_files:
+- spec/lib/deprecation_spec.rb
+- spec/spec_helper.rb
+has_rdoc: