duck_puncher 2.11.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 810a0e182430aafb5d23731ac2d01a456675073b
-  data.tar.gz: faf6bff2544dd61bbf9a91bebcfc6bba7609ec13
+  metadata.gz: 5df7873691d0800251c6f01efa662ff8ffe5951f
+  data.tar.gz: 8143c677f0dab3351ed2f19c94b575efc6058682
 SHA512:
-  metadata.gz: b266c73a702ae2086b0bf603bd48cbd3b972e238b46319eaa25c1e2c8a1eb21027297156eb1e7f6abe00393f5b3aab0a5b7f34dd08c8b0a0cb70c4f01353632b
-  data.tar.gz: 1a5977e96defe3c647581d8440c1721efccd1da9b4435bf8e8839175a5c3fdd8649772d43f7fce6afa731b7394653671befa58547f084a8ef2c779d3df2cc8a5
+  metadata.gz: bb8741aacf58c8f481df8b7976fc263f128d2d27c56deab4b734f08dab0400ed9a8e48b592d0e692f2d25d0f223b07ca64d3a3002ea898d7956eb6d83747be01
+  data.tar.gz: 43e29a239f7ca340ccc0aa64abd36097d81e3ab6088866eb28bd9b6f6dfd395cf0b8b9e46ae38ca098f52b639a3e6ad9245514607bfb95f8fb9665fab98ab450

data/README.md

@@ -17,18 +17,17 @@ Numeric #to_currency  => `25.245.to_currency` => 25.25
 String  #pluralize    => `'hour'.pluralize(2)` => "hours"
         #underscore   => `'DuckPuncher::JSONStorage'.underscore` => 'duck_puncher/json_storage'
 Object  #clone!       => `Object.new.clone!` => a deep clone of the object (using Marshal.dump)
-        #punch        => `'duck'.punch` => a copy of 'duck' with the mixed String punches
+        #punch        => `'duck'.punch` => a copy of 'duck' with String punches mixed in
 Method  #to_instruct  => `Benchmark.method(:measure).to_instruct` returns the Ruby VM instruction sequence for the method
         #to_source    => `Benchmark.method(:measure).to_source` returns the method definition as a string
 ```
 
 ## Tactical punches
 
-Sometimes you don't want to punch all the ducks. That's why you can punch only certain methods onto a class:
+Punch only certain methods onto a duck:
 
 ```ruby
 >> DuckPuncher.punch! :Numeric, only: [:to_currency, :to_duration]
-WARN: Punching [:to_currency, :to_duration] onto Numeric
 => nil
 >> 100.to_currency '$'
 => "$100.00"
@@ -44,11 +43,8 @@ NoMethodError: undefined method `to_time_ago' for 100:Fixnum
 
 ## Usage
 
-Ducks need to be _loaded_ before they can be punched! Maybe put this in an initializer:
-
 ```ruby
-# config/initializers/duck_puncher.rb
-DuckPuncher.punch_all!                   # => punches all the ducks forever
+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
 ```
@@ -79,9 +75,40 @@ Because `DuckPuncher` extends the amazing [Usable](https://github.com/ridiculous
 ## 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:
+`.register` with the name of your module.
+
+### Punching your own duck
+```ruby
+class User < Struct.new(:name)
+end
+
+module Billable
+  def perform(amt)
+    puts "Attempting to bill #{name} for $#{amt}"
+    fail Errno::ENOENT
+  end
+end
+
+module Retryable
+  def perform_with_retry(*args, retries: 3)
+    perform *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)
+```
 
+### Punching core ducks
 ```ruby
+# Example punches
 module Donald
   def tap_tap
     p self
@@ -94,33 +121,30 @@ module Daisy
     "Hi, I'm Daisy"
   end
 end
-
-DuckPuncher.register :Donald, class: 'Array', if: -> { 'some condition' }
-DuckPuncher.register :Daisy, class: 'Array'
 ```
 
-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.
-
-Activate a custom punch:
+When punching a class, the `:class` option is required when registering:
 
 ```ruby
+DuckPuncher.register :Donald, class: 'Array'
 DuckPuncher.punch! :Donald
 [].tap_tap
-# or
-DuckPuncher.punch! :Object, only: :punch
-[].punch(:Donald).tap_tap
 ```
 
-Punches can also be stacked together:
+When punching instances, the `:class` option can be omitted, but the name of the punch is required:
 
 ```ruby
 DuckPuncher.punch! :Object, only: :punch
+DuckPuncher.register :Donald
+DuckPuncher.register :Daisy
 ducks = [].punch(:Donald).punch(:Daisy)
 ducks.tap_tap
 ducks.quack
 ```
 
+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
 
 __Object#require!__ will try to require a gem, or, if it's not found, then _download_ it! It will also keep track of any
@@ -136,7 +160,6 @@ LoadError: cannot load such file -- pry
  from (irb):1
  from bin/console:10:in `<main>'
 >> DuckPuncher.punch! :Object, only: :require!
-WARN: Punching require! onto Object
 => nil
 >> require! 'pry'
 Fetching: method_source-0.8.2.gem (100%)
@@ -196,5 +219,10 @@ Duck.track
 
 * Fork it
 * Run tests with `rake`
-* Start an IRB console that already has all your ducks in a row `bin/console`
+* Start an IRB console that already has all your ducks in a row: `bin/console`
+* Start an IRB console without punching ducks: `PUNCH=no bin/console`
 * Make changes and submit a PR to [https://github.com/ridiculous/duck_puncher](https://github.com/ridiculous/duck_puncher)
+
+## License
+
+MIT

data/bin/console

@@ -7,6 +7,8 @@ require 'irb'
 require 'byebug'
 require_relative '../test/fixtures/wut'
 
+DuckPuncher.log.level = Logger::DEBUG
+
 if ENV['PUNCH'] != 'no'
   DuckPuncher.punch_all!
 end

data/lib/duck_puncher.rb

@@ -56,7 +56,7 @@ module DuckPuncher
     end
 
     def punch_all!
-      log.warn 'Punching all ducks! Watch out!'
+      log.warn 'Punching all ducks!'
       Ducks.list.each &:punch
     end
 
@@ -65,13 +65,10 @@ module DuckPuncher
     end
   end
 
-  # @description Default logger
-  # @example Silence logging
-  #
-  #   `DuckPuncher.log.level = Logger::ERROR`
-  #
   self.log = Logger.new(STDOUT).tap do |config|
     config.level = Logger::INFO
     config.formatter = proc { |*args| "#{args.first}: #{args.last.to_s}\n" }
   end
+
+  log.level = Logger::ERROR
 end

data/lib/duck_puncher/duck.rb

@@ -18,7 +18,7 @@ module DuckPuncher
     # @option options [Array,Symbol] :only Specifies the methods to extend onto the current object
     def punch(opts = {})
       if options[:if] && !options[:if].call
-        DuckPuncher.log.warn %Q(Failed to punch #{name}!)
+        DuckPuncher.log.info %Q(Skipping the punch for #{name}!)
         return nil
       end
       target = opts.delete(:target) || klass

data/lib/duck_puncher/ducks.rb

@@ -15,7 +15,7 @@ module DuckPuncher
 
       def [](name)
         list.find { |duck| duck.name == name.to_sym } ||
-          DuckPuncher.log.info(%Q(Couldn't find "#{name}" in my list of Ducks! I know about: #{list.map(&:name).map(&:to_s)}))
+          DuckPuncher.log.warn(%Q(Couldn't find "#{name}" in my list of Ducks! I know about: #{list.map(&:name).map(&:to_s)}))
       end
 
       def load_path_for(duck)

data/lib/duck_puncher/gem_installer.rb

@@ -11,7 +11,7 @@ class DuckPuncher::GemInstaller
       begin
         require spec[:require_with]
       rescue LoadError => e
-        DuckPuncher.log.warn "Failed to load #{spec[:require_with]} from .duck_puncher/ #{e.inspect}"
+        DuckPuncher.log.error "Failed to load #{spec[:require_with]} from .duck_puncher/ #{e.inspect}"
       end
     end
   end

data/lib/duck_puncher/version.rb

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

metadata

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