duck_puncher 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d30be8964065fb57d3de53e4e23b2deaf8ceb277
-  data.tar.gz: f2bc471c1a31a1f438680f21440b86d489092cd1
+  metadata.gz: 2afbd4dd98468db97339d8094564c7830a8f6aa8
+  data.tar.gz: 2cabadf15f55e7b38b5028d0c702fb71ac809a4b
 SHA512:
-  metadata.gz: e117be77a8e6a2a80f0ba415315039fa727ba1495e52bfa9b83cd7b5d631b92ebce331eaac51f6b7fb2d5c76a00e2f88f19892f4f84039686fab277976a40588
-  data.tar.gz: 64a2e78858356beacb9f30ea6cd6955046c8f90fc596fd0d15c64cbe2e121423e85b9ffe384e08826655f45eddc74bae824a6c401877e65ebf62c44908adc851
+  metadata.gz: f3016a12e3e5ba11571b05ad62a58163a25db0fc4866d0c82c39cfeeaeada1c7ff44999bfabcb81021b3f4c810973e2b8b0a79e9c522426597b17e5f9f6d4d9e
+  data.tar.gz: c35a7d1dd77ac403f42884935f56963354e4aa5e75dcc36442b7a125ae000f3417a991da536aa8bcdb6b30ddb95f6619ced25004a6c44ce4efddfce85b6f0745

data/README.md

@@ -1,6 +1,9 @@
 # DuckPuncher
 
-These are the ducks I can punch:
+Ruby objects walk and talk like ducks, therefore they _are_ ducks. But ducks don't always behave, and some times they need
+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]/, '*') }` 
@@ -48,8 +51,25 @@ Try it out if your feeling frisky! However, I noticed it doesn't work well with
 Ducks need to be _loaded_ before they can be punched! Maybe do this in an initializer?
 
 ```ruby
-DuckPuncher.punch! :Hash, :Object #=> only punches the specified ducks
-DuckPuncher.punch_all!            #=> punches all the ducks
+DuckPuncher.punch_all!                  #=> punches all the ducks forever
+DuckPuncher.punch! :Hash, :Object       #=> only punches the Hash and Object ducks
+DuckPuncher.punch :String               #=> returns an anonymous punched duck that inherits from String
+DuckString = DuckPuncher.punch :String  #=> give the anonymous duck a name, so that you can use it!
+DuckString.new.respond_to? :underscore  #=> true
+```
+
+DuckPuncher defines a global `punch` method. This method creates and caches a delegation class pre-punched with only the
+ducks you want!
+
+Here's an example of how to use it:
+
+```ruby
+>> a = punch :Array, [punch(:String, 'foo'), punch(:String, 'bar')]
+=> ["foo", "bar"]
+>> a.m :upcase
+=> ["FOO", "BAR"]
+>> a.mm :pluralize, 2
+=> ["foos", "bars"]
 ```
 
 ## Contributing

data/Rakefile

@@ -2,8 +2,12 @@ require 'bundler/gem_tasks'
 require 'rake'
 require 'rake/testtask'
 
-task default: :test
+Rake::TestTask.new(:soft_punch_test) do |t|
+  t.pattern = 'test/soft_punch/*_test.rb'
+end
 
-Rake::TestTask.new do |t|
-  t.pattern = 'test/**/*_test.rb'
+Rake::TestTask.new(:hard_punch_test) do |t|
+  t.pattern = 'test/duck_puncher/*_test.rb'
 end
+
+task default: [:soft_punch_test, :hard_punch_test]

data/bin/console

@@ -6,6 +6,6 @@ require 'duck_puncher'
 require 'irb'
 require_relative '../test/fixtures/wut'
 
-DuckPuncher.punch_all!
+DuckPuncher.punch_all! if ENV['PUNCH'] != 'no'
 
 IRB.start

data/lib/duck_puncher.rb

@@ -1,5 +1,6 @@
 require 'pathname'
 require 'fileutils'
+require 'delegate'
 require 'logger'
 require 'duck_puncher/version'
 
@@ -9,35 +10,63 @@ module DuckPuncher
   autoload :Duck, 'duck_puncher/duck'
   autoload :Ducks, 'duck_puncher/ducks'
 
-  def self.punch!(*names)
-    names.each do |name|
-      if duck = Ducks[name]
+  class << self
+    attr_accessor :log
+
+    def delegate_class(name)
+      @delegations ||= {}
+      @delegations[name] ||= Ducks[name].dup.delegated
+    end
+
+    # @description Extends functionality to a copy of the specified class
+    def punch(*names)
+      singular = names.size == 1
+      punched_ducks = names.map do |name|
+        duck = Ducks[name]
+        duck_class = Class.new(duck.klass)
+        if duck.punch duck_class
+          duck_class
+        else
+          log.error %Q(Failed to punch #{name}!)
+        end
+      end
+      punched_ducks.compact!
+      punched_ducks = punched_ducks.first if singular
+      punched_ducks
+    end
+
+    def punch!(*names)
+      names.each do |name|
+        duck = Ducks[name]
         if duck.punched?
           log.info %Q(Already punched #{name})
         else
-          log.warn %Q(Punching the #{name} ducky)
+          log.warn %Q(Punching #{name} ducky)
           unless duck.punch
             log.error %Q(Failed to punch #{name}!)
           end
         end
-      else
-        log.info %Q(Couldn't find "#{name}" in my list of Ducks! I know about: #{Ducks.list.map(&:name).map(&:to_s)})
       end
+      nil
     end
-    nil
-  end
 
-  def self.punch_all!
-    log.warn 'Punching all ducks! Watch out!'
-    Ducks.list.each &:punch
-  end
-
-  class << self
-    attr_accessor :log
+    def punch_all!
+      log.warn 'Punching all ducks! Watch out!'
+      Ducks.list.each &:punch
+    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
 end
+
+def punch(name, val)
+  DuckPuncher.delegate_class(name).new val
+end

data/lib/duck_puncher/duck.rb

@@ -8,23 +8,34 @@ module DuckPuncher
       @punched = false
     end
 
+    # @note Assumes the String duck is loaded first
     def load_path
-      "duck_puncher/ducks/#{name.to_s.downcase}"
+      path_name = if name == :String
+        name.to_s.downcase
+      else
+        Object.send(:punch, :String, name.to_s).underscore
+      end
+      "duck_puncher/ducks/#{path_name}"
     end
 
-    def punch
+    def punch(target = nil)
       return false if options[:if] && !options[:if].call
       options[:before].call if options[:before]
-      const.send :include, DuckPuncher::Ducks.const_get(name)
+      (target || klass).send :include, DuckPuncher::Ducks.const_get(name)
+      options[:after].call if options[:after]
       @punched = true
     end
 
-    def const
-      @const ||= (options[:class] || name).to_s.split('::').inject(Kernel) { |k, part| k.const_get part }
+    def klass
+      @klass ||= (options[:class] || name).to_s.split('::').inject(Kernel) { |k, part| k.const_get part }
     end
 
     def punched?
       @punched
     end
+
+    def delegated
+      DelegateClass(klass).tap { |k| punch k }
+    end
   end
 end

data/lib/duck_puncher/ducks.rb

@@ -3,10 +3,10 @@ module DuckPuncher
     class << self
       def list
         @list ||= [
+          Duck.new(:String),
           Duck.new(:Array),
           Duck.new(:Numeric),
           Duck.new(:Hash),
-          Duck.new(:String),
           Duck.new(:Object),
           Duck.new(:Method, before: -> { DuckPuncher::GemInstaller.initialize! }),
           Duck.new(:ActiveRecord, class: 'ActiveRecord::Base', if: -> { defined? ::ActiveRecord })
@@ -14,7 +14,8 @@ module DuckPuncher
       end
 
       def [](name)
-        list.find { |duck| duck.name == name.to_sym }
+        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)}))
       end
     end
 

data/lib/duck_puncher/ducks/active_record.rb

@@ -1,48 +1,50 @@
 module DuckPuncher
-  module ActiveRecord
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    def associations?
-      associations.present?
-    end
-
-    def associations
-      reflections.select { |key, _| send(key).present? rescue nil }.keys
-    end
-
-    module ClassMethods
-      def except_for(*ids)
-        scoped.where("#{quoted_table_name}.id NOT IN (?)", ids)
-      end
-
-      def since(time)
-        scoped.where("#{quoted_table_name}.created_at > ?", time)
-      end
-
-      alias created_since since
-
-      def before(time)
-        scoped.where("#{quoted_table_name}.created_at < ?", time)
-      end
-
-      def updated_since(time)
-        scoped.where("#{quoted_table_name}.updated_at > ?", time)
-      end
-
-      def between(start_at, end_at)
-        scoped.where("#{quoted_table_name}.created_at BETWEEN ? AND ", start_at, end_at)
-      end
-
-      def latest
-        scoped.order("#{quoted_table_name}.id ASC").last
-      end
-
-      # shim for backwards compatibility with Rails 3
-      def scoped
-        where(nil)
-      end if Rails::VERSION::MAJOR != 3
-    end
-  end
+ module Ducks
+   module ActiveRecord
+     def self.included(base)
+       base.extend(ClassMethods)
+     end
+
+     def associations?
+       associations.present?
+     end
+
+     def associations
+       reflections.select { |key, _| send(key).present? rescue nil }.keys
+     end
+
+     module ClassMethods
+       def except_for(*ids)
+         scoped.where("#{quoted_table_name}.id NOT IN (?)", ids)
+       end
+
+       def since(time)
+         scoped.where("#{quoted_table_name}.created_at > ?", time)
+       end
+
+       alias created_since since
+
+       def before(time)
+         scoped.where("#{quoted_table_name}.created_at < ?", time)
+       end
+
+       def updated_since(time)
+         scoped.where("#{quoted_table_name}.updated_at > ?", time)
+       end
+
+       def between(start_at, end_at)
+         scoped.where("#{quoted_table_name}.created_at BETWEEN ? AND ", start_at, end_at)
+       end
+
+       def latest
+         scoped.order("#{quoted_table_name}.id ASC").last
+       end
+
+       # shim for backwards compatibility with Rails 3
+       def scoped
+         where(nil)
+       end if Rails::VERSION::MAJOR != 3
+     end
+   end
+ end
 end

data/lib/duck_puncher/ducks/array.rb

@@ -16,3 +16,4 @@ module DuckPuncher
     end
   end
 end
+

data/lib/duck_puncher/version.rb

@@ -1,3 +1,3 @@
 module DuckPuncher
-  VERSION = '2.4.0'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/test/duck_puncher/array_test.rb

@@ -1,4 +1,5 @@
 require_relative '../test_helper'
+DuckPuncher.punch! :Array
 
 class ArrayTest < MiniTest::Test
   attr_reader :subject

data/test/duck_puncher/hash_test.rb

@@ -1,4 +1,5 @@
 require_relative '../test_helper'
+DuckPuncher.punch! :Hash
 
 class HashTest < MiniTest::Test
   def test_seek

data/test/duck_puncher/method_test.rb

@@ -1,5 +1,6 @@
 require_relative '../test_helper'
 require_relative '../fixtures/wut'
+DuckPuncher.punch! :Method
 
 class MethodTest < MiniTest::Test
 

data/test/duck_puncher/numeric_test.rb

@@ -1,4 +1,5 @@
 require_relative '../test_helper'
+DuckPuncher.punch! :Numeric
 
 class NumericTest < MiniTest::Test
 

data/test/duck_puncher/object_test.rb

@@ -1,4 +1,5 @@
 require_relative '../test_helper'
+DuckPuncher.punch! :Object
 
 class ObjectTest < MiniTest::Test
   def test_clone!

data/test/duck_puncher/string_test.rb

@@ -1,5 +1,7 @@
 require_relative '../test_helper'
 
+DuckPuncher.punch! :String
+
 class StringTest < MiniTest::Test
   def test_pluralize
     assert_equal 'hour'.pluralize(1), 'hour'

data/test/soft_punch/duck_puncher_test.rb

@@ -0,0 +1,21 @@
+require_relative '../test_helper'
+
+class DuckPuncherTest < MiniTest::Test
+  DuckString = DuckPuncher.punch :String
+  DuckNumber, DuckArray = DuckPuncher.punch :Numeric, :Array
+
+  def test_punch
+    refute_respond_to '', :underscore
+    assert_respond_to DuckString.new, :underscore
+    refute_respond_to '', :underscore
+  end
+
+  def test_punch_multiple
+    refute_respond_to 25, :to_currency
+    refute_respond_to [], :m
+    assert_respond_to DuckNumber.new, :to_currency
+    assert_respond_to DuckArray.new, :m
+    refute_respond_to 25, :to_currency
+    refute_respond_to [], :m
+  end
+end

data/test/test_helper.rb

@@ -4,4 +4,3 @@ require 'minitest/reporters'
 require 'duck_puncher'
 
 Minitest::Reporters.use!
-DuckPuncher.punch_all!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duck_puncher
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-30 00:00:00.000000000 Z
+date: 2016-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - test/duck_puncher/object_test.rb
 - test/duck_puncher/string_test.rb
 - test/fixtures/wut.rb
+- test/soft_punch/duck_puncher_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ridiculous/duck_puncher
 licenses:
@@ -149,4 +150,5 @@ test_files:
 - test/duck_puncher/object_test.rb
 - test/duck_puncher/string_test.rb
 - test/fixtures/wut.rb
+- test/soft_punch/duck_puncher_test.rb
 - test/test_helper.rb