duck_puncher 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f48603e05216d29053e2f95e16b169b802bc78e2
-  data.tar.gz: 044ce7bcd8d7418a24bdc8455c514b642da23913
+  metadata.gz: 6a8db75a39d70dd7e9d2889e265ee699fb57cc69
+  data.tar.gz: afd816328b5e7e2a525ff440713b9288310e2dad
 SHA512:
-  metadata.gz: b79b94c75adda2e450d3799b47ab21564817e732ddbd19f2c05dcec268ed55421f0448bafad72177316afc3cf51e01a4364a1d2ac960b379c8dcafe62ff1bb18
-  data.tar.gz: c60bc8371e38deeb3b322c3cffeb608ac2df063c9496eabad82f7cc8f3c976c6a0a81770ee79e3e7d0c9fc2b87767307bf9ae516aacab23968dd3bd35dc17d1b
+  metadata.gz: 3f69f32294c4ccfe42c934ba0641da5da0e72caa0c205317ee6b090685695593dea1f21003bdad75dd499964d3058a00c87f109b0782ba30e91c9478a9637b65
+  data.tar.gz: 6109c6c42f64701e35942f935af09aeaa1081747e6b7a758d5cc32a9655f690b540fcbe0cbdb61068e053bc094054a117705328d5f9d37b63db55a8d193dd311

data/README.md

@@ -5,21 +5,41 @@ tough love. You know, lil love punches! :punch: :heart:
 
 These are the ducks I love the most:
 
-    Array#m             => `[].m(:to_s)` => `[].map(&:to_s)` 
-    Array#mm            => `[].mm(:sub, /[aeiou]/, '*')` => `[].map { |x| x.sub(/[aeiou]/, '*') }` 
-    Array#get           => `[].methods.get('ty?')` => [:empty?] 
-    Hash#dig            => `{a: 1, b: {c: 2}}.dig(:b, :c)` => 2 (Part of standard lib in Ruby >= 2.3)
-    Numeric#to_currency => `25.245.to_currency` => 25.25 
-    Numeric#to_duration => `10_000.to_duration` => '2 h 46 min'
-    Numeric#to_time_ago => `10_000.to_time_ago` => '2 hours ago'
-    Numeric#to_rad      => `10.15.to_rad` => 0.17715091907742445
-    String#pluralize    => `'hour'.pluralize(2)` => "hours"
-    String#underscore   => `'DuckPuncher::JSONStorage'.underscore` => 'duck_puncher/json_storage'
-    Object#clone!       => `Object.new.clone!` => a deep clone of the object (using Marshal.dump)
-    Method#to_instruct  => `Benchmark.method(:measure).to_instruct` returns the Ruby VM instruction sequence for the method
-    Method#to_source    => `Benchmark.method(:measure).to_source` returns the method definition as a string
-    
-I also provide an experimental punch that tries to download the required gem if it doesn't exist on your computer. The
+```ruby
+Array#m             => `[].m(:to_s)` => `[].map(&:to_s)` 
+Array#mm            => `[].mm(:sub, /[aeiou]/, '*')` => `[].map { |x| x.sub(/[aeiou]/, '*') }` 
+Array#get           => `[].methods.get('ty?')` => [:empty?] 
+Hash#dig            => `{a: 1, b: {c: 2}}.dig(:b, :c)` => 2 (Part of standard lib in Ruby >= 2.3)
+Numeric#to_currency => `25.245.to_currency` => 25.25 
+Numeric#to_duration => `10_000.to_duration` => '2 h 46 min'
+Numeric#to_time_ago => `10_000.to_time_ago` => '2 hours ago'
+Numeric#to_rad      => `10.15.to_rad` => 0.17715091907742445
+String#pluralize    => `'hour'.pluralize(2)` => "hours"
+String#underscore   => `'DuckPuncher::JSONStorage'.underscore` => 'duck_puncher/json_storage'
+Object#clone!       => `Object.new.clone!` => a deep clone of the object (using Marshal.dump)
+Object#punch        => `'duck'.punch` => a copy of 'duck' with the mixed String punches
+Object#track        => `'duck'.punch.track` => downloads the [ObjectTracker](https://github.com/ridiculous/object_tracker) gem if it's not available and starts tracking this object
+Method#to_instruct  => `Benchmark.method(:measure).to_instruct` returns the Ruby VM instruction sequence for the method
+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:
+
+```ruby
+>> DuckPuncher.punch! :Numeric, only: [:to_currency, :to_duration]
+INFO: Already punched Numeric
+=> nil
+>> 100.to_currency '$'
+=> "$100.00"
+>> 100.to_duration
+=> "1 min"
+>> 100.to_time_ago
+NoMethodError: undefined method `to_time_ago' for 100:Fixnum
+```
+
+There is also an experimental punch that tries to download the required gem if it doesn't exist on your computer. The
 method is called `require!` and works like this:
 
 Downloads and activates a gem for the current and subsequent consoles. For example:
@@ -52,8 +72,9 @@ Ducks need to be _loaded_ before they can be punched! Maybe put this in an initi
 
 ```ruby
 # config/initializers/duck_puncher.rb
-DuckPuncher.punch_all!                  #=> punches all the ducks forever
-DuckPuncher.punch! :Hash, :Object       #=> only punches the Hash and Object ducks
+DuckPuncher.punch_all!                   #=> punches all the ducks forever
+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
 ```
 
 Create a new class of your favorite duck pre-punched:
@@ -64,14 +85,16 @@ DuckString = DuckPuncher.punch :String  #=> give the anonymous duck a name, so t
 DuckString.new.respond_to? :underscore  #=> true
 ```
 
-That works, but it's pretty verbose and not real pactical to be managing potentially a bunch of custom classes. That's
-+why DuckPuncher defines an `Object#punch` method that sets this stuff up for you!
+If you punch `Object` then you can use `punch` on any object to get a new decorated copy of the class with the desired
+functionality mixed in:
 
 ```ruby
-DuckPuncher.punch! :Object
-"yes".punch.to_boolean
+# Assuming you've already done `DuckPuncher.punch! :Object, only: :punch`
+%w[yes no 1].punch.m(:punch).punch.m(:to_boolean) #=> [true, false, true]
 ```
 
+Because `DuckPuncher` extends the amazing [Usable](https://github.com/ridiculous/usable) gem, you can configure only the punches you want! 
+
 ## Contributing
 
 * Fork it

data/bin/console

@@ -4,6 +4,7 @@ require 'bundler/setup'
 require 'pp'
 require 'duck_puncher'
 require 'irb'
+require 'byebug'
 require_relative '../test/fixtures/wut'
 
 DuckPuncher.punch_all! if ENV['PUNCH'] != 'no'

data/duck_puncher.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "usable", "~> 1", "< 2"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", '~> 10.1'
   spec.add_development_dependency "minitest", '~> 5.0'

data/lib/duck_puncher/duck.rb

@@ -12,14 +12,15 @@ module DuckPuncher
       "duck_puncher/ducks/#{name.to_s.gsub(/\B([A-Z])/, '_\1').downcase}"
     end
 
-    def punch(target = nil)
+    def punch(opts = {})
       if options[:if] && !options[:if].call
         DuckPuncher.log.warn %Q(Failed to punch #{name}!)
         return nil
       end
       options[:before].call if options[:before]
-      (target || klass).send :include, DuckPuncher::Ducks.const_get(name)
-      options[:after].call if options[:after]
+      target = opts.fetch(:target, klass)
+      target.extend Usable
+      target.usable DuckPuncher::Ducks.const_get(name), opts
       @punched = true
     end
 
@@ -32,11 +33,11 @@ module DuckPuncher
     end
 
     def delegated
-      DelegateClass(klass).tap &method(:punch)
+      DelegateClass(klass).tap { |k| punch target: k }
     end
 
     def classify
-      Class.new(klass).tap &method(:punch)
+      Class.new(klass).tap { |k| punch target: k }
     end
   end
 end

data/lib/duck_puncher/ducks/object.rb

@@ -14,6 +14,12 @@ module DuckPuncher
       def punch
         DuckPuncher.delegate_class(self.class.name.to_sym).new(self)
       end
+
+      def track
+        require! 'object_tracker'
+        extend ::ObjectTracker
+        track_all!
+      end
     end
   end
 end

data/lib/duck_puncher/gem_installer.rb

@@ -1,3 +1,5 @@
+require 'rubygems/dependency_installer'
+
 class DuckPuncher::GemInstaller
   def self.initialize!
     spec_data = DuckPuncher::JSONStorage.read('load_paths.json').values

data/lib/duck_puncher/version.rb

@@ -1,3 +1,3 @@
 module DuckPuncher
-  VERSION = '2.7.0'.freeze
+  VERSION = '2.8.0'.freeze
 end

data/lib/duck_puncher.rb

@@ -2,6 +2,7 @@ require 'pathname'
 require 'fileutils'
 require 'delegate'
 require 'logger'
+require 'usable'
 require 'duck_puncher/version'
 
 module DuckPuncher
@@ -27,13 +28,14 @@ module DuckPuncher
     end
 
     def punch!(*names)
+      options = names.last.is_a?(Hash) ? names.pop : {}
       names.each do |name|
         duck = Ducks[name]
         if duck.punched?
           log.info %Q(Already punched #{name})
         else
           log.warn %Q(Punching #{name} ducky)
-          unless duck.punch
+          unless duck.punch(options)
             log.error %Q(Failed to punch #{name}!)
           end
         end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: duck_puncher
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: usable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Duck punches Ruby