deprecation 0.0.1 → 0.0.2

data/lib/deprecation.rb

@@ -2,33 +2,42 @@ require 'deprecation/behaviors'
 require 'deprecation/reporting'
 require 'deprecation/method_wrappers'
 require 'active_support/concern'
+require 'deprecation/core_ext/module/deprecation'
 
 module Deprecation
   extend ActiveSupport::Concern
 
-  included do
-    class << self
-      attr_accessor :deprecation_horizon
+  def deprecation_horizon= horizon
+    @deprecation_horizon = horizon
+  end
 
-      # Whether to print a backtrace along with the warning.
-      attr_accessor :debug
+  def deprecation_horizon
+    @deprecation_horizon
+  end
 
-      attr_accessor :silenced
+  def silenced
+    @silenced
+  end
+
+  def silenced= bool
+    @silenced = bool
+  end
+
+  def debug
+    @debug
+  end
+
+  def debug= bool
+    @debug = bool
+  end
+
+  included do
+    class << self
     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

@@ -2,7 +2,6 @@ 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
@@ -32,7 +31,6 @@ module Deprecation
     def deprecation_behavior=(deprecation_behavior)
       @deprecation_behavior = Array(deprecation_behavior).map { |b| Deprecation.behaviors(self)[b] || b }
     end
-  end
 
   def self.deprecations
     @deprecations ||= []

data/lib/deprecation/core_ext/module/deprecation.rb

@@ -0,0 +1,5 @@
+class Module
+  def deprecation_deprecate *method_names
+    Deprecation.deprecate_methods(self, *method_names)
+  end
+end

data/lib/deprecation/method_wrappers.rb

@@ -2,9 +2,8 @@ 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)
+  def self.deprecate_methods(target_module, *method_names)
     options = method_names.extract_options!
     method_names += options.keys
 
@@ -12,8 +11,8 @@ module Deprecation
       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(
+            Deprecation.warn(#{target_module.to_s},
+              Deprecation.deprecated_method_warning(#{target_module.to_s},
                 :#{method_name},
                 #{options[method_name].inspect}),
               caller
@@ -24,5 +23,4 @@ module Deprecation
       end
     end
   end
-  end
 end

data/lib/deprecation/reporting.rb

@@ -1,13 +1,13 @@
 module Deprecation
-  module ClassMethods
+  class << self
     # 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
+    def warn(context, message = nil, callstack = caller)
+      return if context.silenced
       deprecation_message(callstack, message).tap do |m|
-        deprecation_behavior.each { |b| b.call(m, callstack) }
+        context.deprecation_behavior.each { |b| b.call(m, callstack) }
       end
     end
 
@@ -19,19 +19,19 @@ module Deprecation
       @silenced = old_silenced
     end
 
-    def collect
-      old_behavior = self.class.deprecation_behavior
+    def collect(context)
+      old_behavior = context.deprecation_behavior
       deprecations = []
-      self.deprecation_behavior = Proc.new do |message, callstack|
+      context.deprecation_behavior = Proc.new do |message, callstack|
         deprecations << message
       end
       result = yield
       [result, deprecations]
     ensure
-      self.class.deprecation_behavior = old_behavior
+      context.deprecation_behavior = old_behavior
     end
 
-    def deprecated_method_warning(method_name, options = nil)
+    def deprecated_method_warning(context, method_name, options = nil)
 
       options ||= {}
 
@@ -40,7 +40,7 @@ module Deprecation
         options = {}
       end
 
-      warning = "#{method_name} is deprecated and will be removed from #{options[:deprecation_horizon] || deprecation_horizon}"
+      warning = "#{method_name} is deprecated and will be removed from #{options[:deprecation_horizon] || context.deprecation_horizon}"
       case message
         when Symbol then "#{warning} (use #{message} instead)"
         when String then "#{warning} (#{message})"

data/lib/deprecation/version.rb

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

data/spec/deprecated_module_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe "deprecated module methods" do
+  module DeprecatedModule
+    extend Deprecation
+
+    self.deprecation_behavior = :raise
+
+    self.deprecation_horizon = 'release 0.1'
+    def a
+
+    end
+
+    deprecation_deprecate :a
+  end
+
+  module DeprecatedModuleLater
+    extend Deprecation
+
+    self.deprecation_behavior = :raise
+
+    self.deprecation_horizon = 'release 0.2'
+    def b
+
+    end
+
+    deprecation_deprecate :b
+  end
+  class DeprecationModuleTest
+    include DeprecatedModule
+    include DeprecatedModuleLater
+  end
+  subject { DeprecationModuleTest.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 be deprecated in release 0.2" do
+      expect { subject.b }.to raise_error /b is deprecated and will be removed from release 0.2/
+    end
+  end
+end

data/spec/deprecation_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Deprecation do
   class DeprecationTest
-    include Deprecation
+    extend Deprecation
     self.deprecation_behavior = :raise
 
     self.deprecation_horizon = 'release 0.1'
@@ -12,7 +12,7 @@ describe Deprecation do
       1 
     end
 
-    deprecate :a
+    deprecation_deprecate :a
 
     def b
       
@@ -26,12 +26,12 @@ describe Deprecation do
 
     end
     
-    deprecate :c, :d
+    deprecation_deprecate :c, :d
 
     def e
 
     end
-    deprecate :e => { :deprecation_horizon => 'asdf 1.4' }
+    deprecation_deprecate :e => { :deprecation_horizon => 'asdf 1.4' }
   end
   subject { DeprecationTest.new}
 

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deprecation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -87,9 +87,11 @@ files:
 - deprecation.gemspec
 - lib/deprecation.rb
 - lib/deprecation/behaviors.rb
+- lib/deprecation/core_ext/module/deprecation.rb
 - lib/deprecation/method_wrappers.rb
 - lib/deprecation/reporting.rb
 - lib/deprecation/version.rb
+- spec/deprecated_module_spec.rb
 - spec/deprecation_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/cbeer/deprecation
@@ -106,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2510818728159110120
+      hash: -342229614951663189
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,5 +122,6 @@ signing_key:
 specification_version: 3
 summary: Stand-alone deprecation library borrowed from ActiveSupport::Deprecation
 test_files:
+- spec/deprecated_module_spec.rb
 - spec/deprecation_spec.rb
 - spec/spec_helper.rb