dont 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 403a3db127556cfce32a357144d5f4de3b5c3e54
-  data.tar.gz: d39e2718237b61d04fe89b2c519b42424420b878
+  metadata.gz: 24d5eabf7ad968cb3d575076d120bf5ccc4808ae
+  data.tar.gz: f7dc01339e3629f8cad5ed1cfc3297afd4c0f0b9
 SHA512:
-  metadata.gz: 3edaf5249591d2af3646f1b926aef81b1c5b84967e84ff873e00a2eba46f3c44556f7c18a618e5ba30fceb36486e2afb6a360870ae73699e535386cc86304b7f
-  data.tar.gz: 260ad407d1c267df6352336c5da2e9a07b834fef1a93255245427c1c24d958573fa08f9055a3878aa70c7f1404757b03bc8610f55d94b5a8b7e8c7d847c488b1
+  metadata.gz: 5c2a8cf3e08e5aed86eff61fb3af1d1b612c9a56c9ca46c8655abe7ceb16904734b2f8c0e9a97cf77e6a090a752a6b303f2af693a359e6a42a8f15a6ecfd67b6
+  data.tar.gz: ff10f1eb7399ee41889c758e8d47c3ee87b410fafabd9a894e16c090fef129c7eadd37c04a4e83620c38174084fc064e2155093b879991a72dee28c644a7b9ed

data/.travis.yml

@@ -1,5 +1,12 @@
 sudo: false
 language: ruby
 rvm:
+  - 2.2.5
   - 2.3.3
+  - ruby-head
+  - jruby-9.1.5.0
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-9.1.5.0
 before_install: gem install bundler -v 1.13.6

data/README.md

@@ -1,5 +1,7 @@
 # Dont
 
+[![Build Status](https://travis-ci.org/datacamp/dont.svg?branch=master)](https://travis-ci.org/datacamp/dont) [![Gem Version](https://badge.fury.io/rb/dont.svg)](https://badge.fury.io/rb/dont) 
+
 Easily deprecate methods.
 
 ## Installation
@@ -21,12 +23,10 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-# Register custom handlers
-#
-Dont.register_handler(:logger, ->(object, method) {
-  class_name = object.class.name
-  logger.warn("Don't use `#{class_name}##{method}`. It's deprecated.")
-})
+# Register a deprecation handler.
+# Anything that responds to `.call(deprecation)` will work.
+LOGGER = Logger.new
+Dont.register_handler(:logger, ->(deprecation) { LOGGER.warn(deprecation.message) })
 class Shouter
   include Dont.new(:logger)
 
@@ -37,25 +37,26 @@ class Shouter
   def scream(msg)
     shout(msg)
   end
-  dont_use :scream
+  dont_use :scream, use: :shout
 end
 
-# This will log "Don't use `Shouter#scream`. It's deprecated.", and then
-# execute the method.
+# Logs "DEPRECATED: Don't use Shouter#scream. It's deprecated in favor of
+# shout.", before executing the method.
 Shouter.new.scream("hello")
-# => HELLO
 
-# There's also a builtin "exception" handler, which is handy for in development
+
+# The :exception deprecation handler is provided by default.
+# It raises an exception whenever the method is called, which is handy in
+# test or development mode.
 class Person
   include Dont.new(:exception)
 
   attr_accessor :firstname
   attr_accessor :first_name
 
-  dont_use :firstname
+  dont_use :firstname, use: :first_name
 end
-
-Person.new.firstname # => Dont::DeprecationError
+Person.new.firstname # => fails with Dont::DeprecationError
 ```
 
 ## Development

data/dont.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "dry-container", ">= 0.6"
+  spec.add_dependency "dry-initializer", ">= 0.10.0"
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/dont.rb

@@ -1,27 +1,16 @@
 require "dont/version"
 require "dry-container"
+require "dry-initializer"
 
 # Defines a `dont_use` method which can be used to deprecate methods.  Whenever
 # the deprecated method is used the specified handler will get triggered.
 #
 # @example
 #
-#     class Person
-#       include Dont.new(:exception)
-#
-#       attr_accessor :firstname
-#       attr_accessor :first_name
-#
-#       dont_use :firstname
-#     end
-#
-#     Person.new.firstname # => Dont::DeprecationError
-#
-#     # Register custom handlers
-#     Dont.register_handler(:logger, ->(object, method) {
-#       class_name = object.class.name
-#       logger.warn("Don't use `#{class_name}##{method}`. It's deprecated.")
-#     })
+#     # Register a deprecation handler.
+#     # Anything that responds to `.call(deprecation)` will work.
+#     LOGGER = Logger.new
+#     Dont.register_handler(:logger, ->(deprecation) { LOGGER.warn(deprecation.message) })
 #     class Shouter
 #       include Dont.new(:logger)
 #
@@ -32,36 +21,35 @@ require "dry-container"
 #       def scream(msg)
 #         shout(msg)
 #       end
-#       dont_use :scream
+#       dont_use :scream, use: :shout
 #     end
 #
-#     # This will log "Don't use `Shouter#scream`. It's deprecated.", and then
-#     # execute the method.
+#     # Logs "DEPRECATED: Don't use Shouter#scream. It's deprecated in favor of
+#     # shout.", before executing the method.
 #     Shouter.new.scream("hello")
-#     # => HELLO
 #
 #
+#     # The :exception deprecation handler is provided by default.
+#     # It raises an exception whenever the method is called, which is handy in
+#     # test or development mode.
+#     class Person
+#       include Dont.new(:exception)
+#
+#       attr_accessor :firstname
+#       attr_accessor :first_name
+#
+#       dont_use :firstname, use: :first_name
+#     end
+#     Person.new.firstname # => fails with Dont::DeprecationError
+#
 class Dont < Module
   Error = Class.new(StandardError)
   DeprecationError = Class.new(Error)
   MissingHandlerError = Class.new(Error)
-  WrongArityError = Class.new(Error)
-
-  HANDLERS = {
-    exception: -> (object, method) {
-      class_name = object.class.name
-      fail DeprecationError, "Don't use `#{class_name}##{method}`. It's deprecated."
-    },
-    airbrake: -> (object, method) {
-      class_name = object.class.name
-      err = DeprecationError.new("Don't use `#{class_name}##{method}`. It's deprecated.")
-      Airbrake.notify(err)
-    },
-  }
 
   def initialize(key)
     handler = Dont.fetch_handler(key)
-    @implementation = ->(method) {
+    @implementation = ->(old_method, use: nil) {
       # The moment `dont_use` is called in ActiveRecord is before AR defines
       # the attributes in the model. So you get an error when calling
       # instance_method with the regular implementation.
@@ -70,19 +58,25 @@ class Dont < Module
       # adapts the code.
       is_ar_attribute = defined?(ActiveRecord::Base) &&
         ancestors.include?(ActiveRecord::Base) &&
-        !method_defined?(method)
+        !method_defined?(old_method)
 
-      old_method = instance_method(method) unless is_ar_attribute
-      define_method(method) do |*args|
-        handler.call(self, method)
+      original = instance_method(old_method) unless is_ar_attribute
+      define_method(old_method) do |*args|
+        deprecation = Deprecation.new(
+          subject: self,
+          new_method: use,
+          old_method: old_method,
+        )
+        handler.call(deprecation)
         if is_ar_attribute
-          if method =~ /=$/
-            self[method.to_s.gsub(/=$/, '')] = args.first
+          if old_method =~ /=\z/
+            attr = old_method.to_s.sub(/=\z/, '')
+            public_send(:[]=, attr, *args)
           else
-            self[method.to_s.gsub(/\?$/, '')]
+            self[old_method.to_s.sub(/\?\z/, '')]
           end
         else
-          old_method.bind(self).call(*args)
+          original.bind(self).call(*args)
         end
       end
     }
@@ -95,23 +89,46 @@ class Dont < Module
   end
 
   class << self
-    def handlers
-      @handlers ||= Dry::Container.new
-    end
-
     def register_handler(key, callable)
       handlers.register(key, callable)
     end
 
     def fetch_handler(key)
-      self.handlers.resolve(key)
+      handlers.resolve(key)
     rescue Dry::Container::Error => e
       fail MissingHandlerError, e.message
     end
+
+    protected
+
+    def handlers
+      @handlers ||= Dry::Container.new
+    end
+  end
+
+  # Contains info about the deprecated method being called
+  class Deprecation
+    extend Dry::Initializer::Mixin
+
+    option :subject
+    option :new_method
+    option :old_method, optional: true
+
+    # A message saying that the old_method is deprecated. It also mentions the
+    # new_method if provided.
+    #
+    # @return [String]
+    def message
+      klass = subject.class.name
+      if new_method && !new_method.empty?
+        "DEPRECATED: Don't use #{klass}##{old_method}. It's deprecated in favor of #{new_method}."
+      else
+        "DEPRECATED: Don't use #{klass}##{old_method}. It's deprecated."
+      end
+    end
   end
 
-  register_handler(:exception, -> (object, method) {
-    class_name = object.class.name
-    fail Dont::DeprecationError, "Don't use `#{class_name}##{method}`. It's deprecated."
+  register_handler(:exception, -> (deprecation) {
+    fail Dont::DeprecationError, deprecation.message
   })
 end

data/lib/dont/version.rb

@@ -1,3 +1,3 @@
 class Dont < Module
-  VERSION = "0.1.2".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dont
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Maarten Claes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2016-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement