duck_puncher 2.12.0 → 2.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5df7873691d0800251c6f01efa662ff8ffe5951f
-  data.tar.gz: 8143c677f0dab3351ed2f19c94b575efc6058682
+  metadata.gz: 9e0baa8b465ab3c4158735e6bc53c37f0bbf6883
+  data.tar.gz: 34c8cf5c21031da525db6133dbec50e3d4840f26
 SHA512:
-  metadata.gz: bb8741aacf58c8f481df8b7976fc263f128d2d27c56deab4b734f08dab0400ed9a8e48b592d0e692f2d25d0f223b07ca64d3a3002ea898d7956eb6d83747be01
-  data.tar.gz: 43e29a239f7ca340ccc0aa64abd36097d81e3ab6088866eb28bd9b6f6dfd395cf0b8b9e46ae38ca098f52b639a3e6ad9245514607bfb95f8fb9665fab98ab450
+  metadata.gz: 202f6cc91ff336089c3761334add4ab4503bd358fef5aa9310fb555545a3b980701ef8db4504b3af75207baa1871956365e1c4dd6cfc1a09c3ad85ee0a8dc136
+  data.tar.gz: 8f431ff2ca0ecd65c040842d803edb06012baf39c90d0a806f32c42bed21b57a4677b249659abd5401a0a7d166e74a0e110ac4789a58cf48f7302e16610f0b51

data/README.md

@@ -1,9 +1,12 @@
 # DuckPuncher [![Gem Version](https://badge.fury.io/rb/duck_puncher.svg)](http://badge.fury.io/rb/duck_puncher)  [![Build Status](https://travis-ci.org/ridiculous/duck_puncher.svg)](https://travis-ci.org/ridiculous/duck_puncher) [![Code Climate](https://codeclimate.com/github/ridiculous/duck_puncher/badges/gpa.svg)](https://codeclimate.com/github/ridiculous/duck_puncher)
 
-Since Ruby objects walk and talk like ducks, they must therefore _be_ ducks. But ducks don't always behave, and some times they need
-tough love! :punch: :heart:
+DuckPuncher provides an interface for administering __duck punches__ (a.k.a "monkey patches"). Punches can be administered in several ways: 
 
-These are the ducks I love the most:
+* as an extension
+* as a subclass
+* as a decorator
+
+Default extensions:
 
 ```ruby
 Array   #m            => `[].m(:to_s)` => `[].map(&:to_s)` 
@@ -22,35 +25,35 @@ Method  #to_instruct  => `Benchmark.method(:measure).to_instruct` returns the Ru
         #to_source    => `Benchmark.method(:measure).to_source` returns the method definition as a string
 ```
 
-## Tactical punches
+## Usage
 
-Punch only certain methods onto a duck:
+Punch all registered ducks:
 
 ```ruby
->> DuckPuncher.punch! :Numeric, only: [:to_currency, :to_duration]
-=> nil
->> 100.to_currency '$'
-=> "$100.00"
->> 100.to_duration
-=> "1 min"
->> 100.to_time_ago
-NoMethodError: undefined method `to_time_ago' for 100:Fixnum
+DuckPuncher.punch_all!
 ```
 
-## Install
+Punch individual ducks by name:
 
-    gem 'duck_puncher'
+```ruby
+DuckPuncher.punch! :Hash, :Object
+```
 
-## Usage
+One method to rule them all:
 
 ```ruby
-DuckPuncher.punch_all!                   # => punches all registered ducks
-DuckPuncher.punch! :Hash, :Object        # => only punches the Hash and Object ducks
-DuckPuncher.punch! :Object, only: :punch # => only opens a can of whoop ass! Define one method to rule them all
+DuckPuncher.punch! :Object, only: :punch 
 ```
 
-The `.punch` method creates and caches a new punched class that inherits from the original. This avoids altering built-in
-classes. For example:
+### Tactical punches
+
+Punch only certain methods onto a duck:
+
+```ruby
+DuckPuncher.punch! :Numeric, only: [:to_currency, :to_duration]
+```
+
+The `.punch` method creates and caches a new punched class that __inherits__ from the original:
 
 ```ruby
 >> DuckPuncher.punch :String
@@ -61,7 +64,7 @@ classes. For example:
 => false
 ```
 
-If you punch `Object` then you can use `punch` on any object to get a new decorated copy of the class with the desired
+If you punch `Object` then you can use `punch` on any object to get a new __decorated__ copy of the object with the desired
 functionality mixed in:
 
 ```ruby
@@ -72,78 +75,57 @@ functionality mixed in:
 
 Because `DuckPuncher` extends the amazing [Usable](https://github.com/ridiculous/usable) gem, you can configure only the punches you want! 
 
-## Registering custom punches
+### Registering custom punches
 
-DuckPuncher allows you to utilize the `punch` interface to decorate any kind of object with your own punches. Simply call 
-`.register` with the name of your module.
+DuckPuncher allows you to utilize the `punch` interface to __decorate__ any kind of object with your own punches. Simply 
+call `.register` with the name of your module (or an array of names) and any of
+[these options](https://github.com/ridiculous/duck_puncher/blob/master/lib/duck_puncher/duck.rb#L11).
 
-### Punching your own duck
-```ruby
-class User < Struct.new(:name)
-end
 
+```ruby
+# Define some extensions
 module Billable
-  def perform(amt)
+  def call(amt)
     puts "Attempting to bill #{name} for $#{amt}"
     fail Errno::ENOENT
   end
 end
 
 module Retryable
-  def perform_with_retry(*args, retries: 3)
-    perform *args
+  def call_with_retry(*args, retries: 3)
+    call *args
   rescue Errno::ENOENT
     puts 'retrying'
     retry if (retries -= 1) > 0
   end
 end
 
-DuckPuncher.register :Billable
-DuckPuncher.register :Retryable
-DuckPuncher.punch! :Object, only: :punch
-
-user = User.new('Ryan').punch(:Billable).punch(:Retryable)
-user.perform_with_retry(19.99)
-```
+# Register the extensions
+DuckPuncher.register [:Billable, :Retryable]
 
-### Punching core ducks
-```ruby
-# Example punches
-module Donald
-  def tap_tap
-    p self
-    self
-  end
+# Our duck
+class User < Struct.new(:name)
 end
 
-module Daisy
-  def quack
-    "Hi, I'm Daisy"
-  end
-end
+# Add the #punch method to User instances
+DuckPuncher.punch! :Object, only: :punch, target: User
+
+# Usage
+user = User.new('Ryan').punch(:Billable).punch(:Retryable)
+user.call_with_retry(19.99)
 ```
 
-When punching a class, the `:class` option is required when registering:
+When punching at a class level, the `:class` option is required:
 
 ```ruby
-DuckPuncher.register :Donald, class: 'Array'
-DuckPuncher.punch! :Donald
-[].tap_tap
+DuckPuncher.register :Billable, class: 'User'
+DuckPuncher.punch! :Billable
 ```
 
-When punching instances, the `:class` option can be omitted, but the name of the punch is required:
+## Install
 
-```ruby
-DuckPuncher.punch! :Object, only: :punch
-DuckPuncher.register :Donald
-DuckPuncher.register :Daisy
-ducks = [].punch(:Donald).punch(:Daisy)
-ducks.tap_tap
-ducks.quack
-```
+    gem 'duck_puncher'
 
-The `register` method takes the same options as [Duck#initialize](https://github.com/ridiculous/duck_puncher/blob/master/lib/duck_puncher/duck.rb#L11)
-and will be used to configure punches.
 
 ## Experimental
 

data/lib/duck_puncher.rb

@@ -47,7 +47,7 @@ module DuckPuncher
       options = names.last.is_a?(Hash) ? names.pop : {}
       names.each do |name|
         duck = Ducks[name]
-        log.warn %Q(Punching#{" #{options[:only]} onto" if Array(options[:only]).any?} #{name})
+        log.warn %Q(Punching#{" #{options[:only]} onto" if Array(options[:only]).any?} #{options.fetch(:target, name)})
         unless duck.punch(options)
           log.error %Q(Failed to punch #{name}!)
         end
@@ -61,7 +61,9 @@ module DuckPuncher
     end
 
     def register(*args)
-      Ducks.list << Duck.new(*args)
+      Array(args.shift).each do |name|
+        Ducks.list << Duck.new(name, *args)
+      end
     end
   end
 

data/lib/duck_puncher/version.rb

@@ -1,3 +1,3 @@
 module DuckPuncher
-  VERSION = '2.12.0'.freeze
+  VERSION = '2.12.1'.freeze
 end

data/test/lib/duck_puncher_test.rb

@@ -1,17 +1,6 @@
 require_relative '../test_helper'
 
-module CustomPunch
-  def tap_tap
-    p self
-    self
-  end
-end
-
 class DuckPuncherTest < MiniTest::Test
-  def teardown
-    Object.send :remove_const, :CustomPunch
-  end
-
   def test_register
     refute_respond_to [], :tap_tap
     DuckPuncher.register :CustomPunch, class: 'Array'
@@ -20,4 +9,15 @@ class DuckPuncherTest < MiniTest::Test
     DuckPuncher.punch! :Object, only: :punch
     assert_respond_to [].punch(:CustomPunch), :tap_tap
   end
+
+  def test_register_with_array
+    refute_respond_to [], :quack
+    refute_respond_to [], :wobble
+    DuckPuncher.register [:CustomPunch2, :CustomPunch3], class: 'Array'
+    DuckPuncher.punch! :CustomPunch2
+    assert_respond_to [], :quack
+    refute_respond_to [], :wobble
+    DuckPuncher.punch! :CustomPunch3
+    assert_respond_to [], :wobble
+  end
 end

data/test/test_helper.rb

@@ -4,3 +4,20 @@ require 'minitest/reporters'
 require 'duck_puncher'
 
 Minitest::Reporters.use!
+
+module CustomPunch
+  def tap_tap
+    p self
+    self
+  end
+end
+
+module CustomPunch2
+  def quack
+  end
+end
+
+module CustomPunch3
+  def wobble
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duck_puncher
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.12.1
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-27 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: usable