deprecation 0.0.5 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd629dd649dd88a3ef88453c700740bc88044205
+  data.tar.gz: 53cbaedda1b182264cb857ee7dac26eebc5cea8b
+SHA512:
+  metadata.gz: 8cd66fa50d5f4d2e480baad348faf3c95c7cff4b44dd718122d1daa2112871cb882ad288b10e8877376ff1d9f3b95bedfdf0ae09c0721d5c8a929d5f1f994ee2
+  data.tar.gz: 9011487732bdd87dcc96ac67e30b0c91f5a92968da2adc16abd7cf3d82601a8e0ccbdfd907ab08ad235d95c9e3e2eeebb4f926d30a218af1ea00a8333518f1b4

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/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Chris Beer
+
+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,55 @@
+Deprecation
+------------
+[![Build Status](https://travis-ci.org/cbeer/deprecation.png?branch=master)](https://travis-ci.org/cbeer/deprecation)
+
+Provide deprecation warnings for code
+
+## Add warnings
+```ruby
+class DeprecatedModule
+  extend Deprecation
+  self.deprecation_horizon = 'my_gem version 3.0.0'
+
+  def asdf
+
+  end
+  deprecation_deprecate :asdf
+
+  def custom_deprecation *args
+    Deprecation.warn(DeprecatedModule, "don't do that!") if args.length < 15
+  end
+
+end
+
+DeprecatedModule.new.asdf
+DEPRECATION WARNING: asdf is deprecated and will be removed from my_gem version 3.0.0. (called from irb_binding at (irb):18)
+=> nil
+
+```
+
+## Silence warnings
+
+```ruby
+
+  def silence_asdf_warning
+     Deprecation.silence(DeprecationModule) do
+       asdf
+     end
+  end
+```
+
+## Reporting
+```ruby
+Deprecation.default_deprecation_behavior = :stderr # the default
+
+Deprecation.default_deprecation_behavior = :log # put deprecation warnings into the Rails / ActiveSupport log
+
+DeprecationModule.debug = true # put the full callstack in the logged message
+
+Deprecation.default_deprecation_behavior = :notify # use ActiveSupport::Notifications to log the message
+
+Deprecation.default_deprecation_behavior = :raise # Raise an exception when using deprecated behavior
+
+Deprecation.default_deprecation_behavior = :silence # ignore all deprecations
+
+```

data/Rakefile

@@ -11,6 +11,12 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
 
 task :console do
   sh "irb -rubygems -I lib -r deprecation.rb"

data/deprecation.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   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.license = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -18,8 +19,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency "activesupport"
 
-  s.add_development_dependency("rake")
-  s.add_development_dependency("rspec")
-  s.add_development_dependency("bundler", ">= 1.0.14")
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", ">= 2.14"
+  s.add_development_dependency "bundler", ">= 1.0.14"
 end
 

data/lib/deprecation.rb

@@ -19,6 +19,8 @@ module Deprecation
     @silenced
   end
 
+  alias_method :silenced?, :silenced
+
   def silenced= bool
     @silenced = bool
   end
@@ -26,11 +28,25 @@ module Deprecation
   def debug
     @debug
   end
+  alias_method :debug?, :debug
 
   def debug= bool
     @debug = bool
   end
 
+  def self.logger
+    @logger ||= if defined?(Rails) && Rails.logger
+      Rails.logger
+    else
+      require 'active_support/logger'
+      ActiveSupport::Logger.new($stderr)
+    end
+  end
+
+  def self.logger= value
+    @logger = value
+  end
+
   included do
     class << self
     end

data/lib/deprecation/behaviors.rb

@@ -47,18 +47,12 @@ module Deprecation
   {
     :stderr => Proc.new { |message, callstack|
        $stderr.puts(message)
-       $stderr.puts callstack.join("\n  ") if klass.debug
+       $stderr.puts callstack.join("\n  ") if klass.respond_to? :debug and 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 = Deprecation.logger
        logger.warn message
-       logger.debug callstack.join("\n  ") if klass.debug
+       logger.debug callstack.join("\n  ") if klass.respond_to? :debug and klass.debug
      },
      :notify => Proc.new { |message, callstack|
         ActiveSupport::Notifications.instrument("deprecation.#{klass.to_s}",

data/lib/deprecation/reporting.rb

@@ -5,19 +5,36 @@ module Deprecation
     #
     #   Deprecation.warn("something broke!")
     #   # => "DEPRECATION WARNING: something broke! (called from your_code.rb:1)"
-    def warn(context, message = nil, callstack = caller)
-      return if context.silenced
+    def warn(context, message = nil, callstack = nil)
+      return if context.respond_to? :silenced? and context.silenced?
+
+      if callstack.nil?
+        callstack = caller
+        callstack.shift
+      end
+
       deprecation_message(callstack, message).tap do |m|
-        context.deprecation_behavior.each { |b| b.call(m, callstack) }
+        deprecation_behavior(context).each { |b| b.call(m, callstack) }
+      end
+    end
+
+    def deprecation_behavior context
+      if context.respond_to? :deprecation_behavior
+        context.deprecation_behavior 
+      else
+        [Deprecation.behaviors(self)[Deprecation.default_deprecation_behavior]]
       end
     end
 
     # Silence deprecation warnings within the block.
     def silence context
-      old_silenced, context.silenced = context.silenced, true
+      if context.respond_to? :silenced=
+        old_silenced, context.silenced = context.silenced, true
+      end
+
       yield
     ensure
-      context.silenced = old_silenced
+      context.silenced = old_silenced if context.respond_to? :silenced=
     end
 
     def collect(context)

data/lib/deprecation/version.rb

@@ -1,3 +1,3 @@
 module Deprecation
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/deprecation_spec.rb

@@ -74,4 +74,30 @@ describe Deprecation do
     end
 
   end
+
+  describe "warn" do
+    class A
+      def some_deprecated_method
+        Deprecation.warn(A, "some explicit deprecation warning")
+        true
+      end
+
+      def old_method
+        some_deprecated_method
+      end
+    end
+
+    let(:logger) { double() }
+
+    before(:each) do
+      Deprecation.stub logger: logger
+      Deprecation.stub default_deprecation_behavior: :log
+    end
+
+    it "should provide a useful deprecation trace" do
+      logger.should_receive(:warn).with(/called from old_method/)
+      expect(A.new.old_method).to be_true
+
+    end
+  end
 end

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: deprecation
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000 Z
+date: 2014-02-03 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'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 - !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
@@ -82,7 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - deprecation.gemspec
 - lib/deprecation.rb
@@ -95,31 +90,28 @@ files:
 - spec/deprecation_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/cbeer/deprecation
-licenses: []
+licenses:
+- MIT
+metadata: {}
 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: -2491741378934253569
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Stand-alone deprecation library borrowed from ActiveSupport::Deprecation
 test_files:
 - spec/deprecated_module_spec.rb