deprecation 0.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+#gemspec
+#
+gem 'activesupport'
+gem 'rspec'

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+
+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
+
+
+task :console do
+  sh "irb -rubygems -I lib -r deprecation.rb"
+end

data/deprecation.gemspec

@@ -0,0 +1,25 @@
+# Provide a simple gemspec so you can easily use your enginex
+# project in your rails apps through git.
+require File.join(File.dirname(__FILE__), "lib/deprecation/version")
+Gem::Specification.new do |s|
+  s.name = "deprecation"
+  s.version = Deprecation::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Chris Beer"]
+  s.email = ["chris@cbeer.info"]
+  s.summary = %q{Stand-alone deprecation library borrowed from ActiveSupport::Deprecation}
+  s.description = %q{Stand-alone deprecation library borrowed from ActiveSupport::Deprecation}
+  s.homepage = "http://github.com/cbeer/deprecation"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activesupport"
+
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("bundler", ">= 1.0.14")
+end
+

data/lib/deprecation.rb

@@ -0,0 +1,34 @@
+require 'deprecation/behaviors'
+require 'deprecation/reporting'
+require 'deprecation/method_wrappers'
+require 'active_support/concern'
+
+module Deprecation
+  extend ActiveSupport::Concern
+
+  included do
+    class << self
+      attr_accessor :deprecation_horizon
+
+      # Whether to print a backtrace along with the warning.
+      attr_accessor :debug
+
+      attr_accessor :silenced
+    end
+
+    # By default, warnings are not silenced and debugging is off.
+    self.silenced = false
+    self.debug = false
+  end
+
+  module ClassMethods
+    def deprecate *method_names
+      # Declare that a method has been deprecated.
+      #   deprecate :foo
+      #   deprecate :bar => 'message'
+      #   deprecate :foo, :bar, :baz => 'warning!', :qux => 'gone!'
+      deprecate_methods(self, *method_names)
+    end
+  end
+end
+

data/lib/deprecation/behaviors.rb

@@ -0,0 +1,68 @@
+require "active_support/notifications"
+require "active_support/concern"
+
+module Deprecation
+  module ClassMethods
+
+    # Returns the current behavior or if one isn't set, defaults to +:stderr+
+    def deprecation_behavior
+      @deprecation_behavior ||= [Deprecation.behaviors(self)[:stderr]]
+    end
+
+    # Sets the behavior to the specified value. Can be a single value, array, or
+    # an object that responds to +call+.
+    #
+    # Available behaviors:
+    #
+    # [+stderr+]  Log all deprecation warnings to +$stderr+.
+    # [+log+]     Log all deprecation warnings to +Rails.logger+.
+    # [+notify]   Use +ActiveSupport::Notifications+ to notify +deprecation.rails+.
+    # [+silence+] Do nothing.
+    #
+    # Setting behaviors only affects deprecations that happen after boot time.
+    # Deprecation warnings raised by gems are not affected by this setting because
+    # they happen before Rails boots up.
+    #
+    #   Deprecation.deprecation_behavior = :stderr
+    #   Deprecation.deprecation_behavior = [:stderr, :log]
+    #   Deprecation.deprecation_behavior = MyCustomHandler
+    #   Deprecation.deprecation_behavior = proc { |message, callstack| 
+    #     # custom stuff
+    #   }
+    def deprecation_behavior=(deprecation_behavior)
+      @deprecation_behavior = Array(deprecation_behavior).map { |b| Deprecation.behaviors(self)[b] || b }
+    end
+  end
+
+  def self.deprecations
+    @deprecations ||= []
+  end
+
+    def self.behaviors klass
+  # Default warning behaviors per Rails.env.
+  {
+    :stderr => Proc.new { |message, callstack|
+       $stderr.puts(message)
+       $stderr.puts callstack.join("\n  ") if klass.debug
+     },
+    :log => Proc.new { |message, callstack|
+       logger =
+         if defined?(Rails) && Rails.logger
+           Rails.logger
+         else
+           require 'active_support/logger'
+           ActiveSupport::Logger.new($stderr)
+         end
+       logger.warn message
+       logger.debug callstack.join("\n  ") if klass.debug
+     },
+     :notify => Proc.new { |message, callstack|
+        ActiveSupport::Notifications.instrument("deprecation.#{klass.to_s}",
+        :message => message, :callstack => callstack)
+     },
+     :raise => Proc.new { |message, callstack| raise message },
+     :silence => Proc.new { |message, callstack| },
+     :test => Proc.new { |message, callstack| self.deprecations << message }
+  }
+    end
+end

data/lib/deprecation/method_wrappers.rb

@@ -0,0 +1,28 @@
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/array/extract_options'
+
+module Deprecation
+  module ClassMethods
+  # Declare that a method has been deprecated.
+  def deprecate_methods(target_module, *method_names)
+    options = method_names.extract_options!
+    method_names += options.keys
+
+    method_names.each do |method_name|
+      target_module.alias_method_chain(method_name, :deprecation) do |target, punctuation|
+        target_module.module_eval(<<-end_eval, __FILE__, __LINE__ + 1)
+          def #{target}_with_deprecation#{punctuation}(*args, &block)
+            self.class.warn(
+              self.class.deprecated_method_warning(
+                :#{method_name},
+                #{options[method_name].inspect}),
+              caller
+            )
+            send(:#{target}_without_deprecation#{punctuation}, *args, &block)
+          end
+        end_eval
+      end
+    end
+  end
+  end
+end

data/lib/deprecation/reporting.rb

@@ -0,0 +1,81 @@
+module Deprecation
+  module ClassMethods
+    # Outputs a deprecation warning to the output configured by <tt>ActiveSupport::Deprecation.behavior</tt>
+    #
+    #   Deprecation.warn("something broke!")
+    #   # => "DEPRECATION WARNING: something broke! (called from your_code.rb:1)"
+    def warn(message = nil, callstack = caller)
+      return if silenced
+      deprecation_message(callstack, message).tap do |m|
+        deprecation_behavior.each { |b| b.call(m, callstack) }
+      end
+    end
+
+    # Silence deprecation warnings within the block.
+    def silence
+      old_silenced, @silenced = @silenced, true
+      yield
+    ensure
+      @silenced = old_silenced
+    end
+
+    def collect
+      old_behavior = self.class.deprecation_behavior
+      deprecations = []
+      self.deprecation_behavior = Proc.new do |message, callstack|
+        deprecations << message
+      end
+      result = yield
+      [result, deprecations]
+    ensure
+      self.class.deprecation_behavior = old_behavior
+    end
+
+    def deprecated_method_warning(method_name, options = nil)
+
+      options ||= {}
+
+      if options.is_a? String  or options.is_a? Symbol
+        message = options
+        options = {}
+      end
+
+      warning = "#{method_name} is deprecated and will be removed from #{options[:deprecation_horizon] || deprecation_horizon}"
+      case message
+        when Symbol then "#{warning} (use #{message} instead)"
+        when String then "#{warning} (#{message})"
+        else warning
+      end
+    end
+
+    private
+      def deprecation_message(callstack, message = nil)
+        message ||= "You are using deprecated behavior which will be removed from the next major or minor release."
+        message += '.' unless message =~ /\.$/
+        "DEPRECATION WARNING: #{message} #{deprecation_caller_message(callstack)}"
+      end
+
+      def deprecation_caller_message(callstack)
+        file, line, method = extract_callstack(callstack)
+        if file
+          if line && method
+            "(called from #{method} at #{file}:#{line})"
+          else
+            "(called from #{file}:#{line})"
+          end
+        end
+      end
+
+      def extract_callstack(callstack)
+        deprecation_gem_root = File.expand_path("../..", __FILE__) + "/"
+        offending_line = callstack.find { |line| !line.start_with?(deprecation_gem_root) } || callstack.first
+        if offending_line
+          if md = offending_line.match(/^(.+?):(\d+)(?::in `(.*?)')?/)
+            md.captures
+          else
+            offending_line
+          end
+        end
+      end
+  end
+end

data/lib/deprecation/version.rb

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

data/spec/deprecation_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Deprecation do
+  class DeprecationTest
+    include Deprecation
+    self.deprecation_behavior = :raise
+
+    self.deprecation_horizon = 'release 0.1'
+
+
+    def a
+      1 
+    end
+
+    deprecate :a
+
+    def b
+      
+    end
+
+    def c
+
+    end
+
+    def d
+
+    end
+    
+    deprecate :c, :d
+
+    def e
+
+    end
+    deprecate :e => { :deprecation_horizon => 'asdf 1.4' }
+  end
+  subject { DeprecationTest.new}
+
+  describe "a" do
+    it "should be deprecated" do
+      expect { subject.a }.to raise_error /a is deprecated/
+    end
+  end
+
+  describe "b" do
+    it "should not be deprecated" do
+      expect { subject.b }.not_to raise_error /b is deprecated/
+    end
+  end
+
+  describe "c,d" do
+    it "should be deprecated" do
+      expect { subject.c }.to raise_error /c is deprecated/
+      expect { subject.d }.to raise_error /d is deprecated/
+    end
+  end
+
+  describe "e" do
+    it "should be deprecated in asdf 1.4" do
+      expect { subject.e }.to raise_error /e is deprecated and will be removed from asdf 1.4/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'deprecation'
+
+require 'rspec/expectations'
+
+RSpec::Matchers.define :be_deprecated do |expected|
+  match do |actual|
+    actual.call
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: deprecation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.14
+description: Stand-alone deprecation library borrowed from ActiveSupport::Deprecation
+email:
+- chris@cbeer.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- deprecation.gemspec
+- lib/deprecation.rb
+- lib/deprecation/behaviors.rb
+- lib/deprecation/method_wrappers.rb
+- lib/deprecation/reporting.rb
+- lib/deprecation/version.rb
+- spec/deprecation_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cbeer/deprecation
+licenses: []
+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: 2510818728159110120
+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: Stand-alone deprecation library borrowed from ActiveSupport::Deprecation
+test_files:
+- spec/deprecation_spec.rb
+- spec/spec_helper.rb