duck_puncher 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cb44e09391f847e93e57bcf8440f2c2d15ed047
-  data.tar.gz: 3ce4e5424e681138720017420ac9acf62fb813d2
+  metadata.gz: f03c81056b93d66e3c9799672cc6e20c34d1ac72
+  data.tar.gz: 30186f7d1cc1b8ce19d94810b17e24cf7fe0b2ab
 SHA512:
-  metadata.gz: 21f328e2955ba0a5d22edb8182ebba32707413aff62e0f788bc87fe5bf889317d601d44cc809cdfb1edb3e8029777080124e26f57b65e0a6b499e0b51c775960
-  data.tar.gz: 1de4fb69952aec16f29c3bfa6034cf4400b5aea73d64bbfee6f7b735c0149e4fb5cd278cacd2d45dfbd4bd7a27faf29117a2ef55393520f2cbbe95b8820b27e7
+  metadata.gz: a27458ff3a2d1e52d381c44d91b6281b0c485870471298413a8144a070574e06a2119d75f9f61feb803167d0cf6e23c05d7a31f967dc9482eb2c46bfc62429b7
+  data.tar.gz: 5cb8230d00f0cf0b058b1db9f9043990beacf2c4dcafb1073aae9d74356b7fc8dd0d6a0ec7eb42a1ceb8b525c9ba21b85d9a1c4458f972e675f98799a2fdba70

data/README.md

@@ -8,28 +8,36 @@ DuckPuncher provides an interface for administering __duck punches__ (a.k.a "mon
 Default extensions:
 
 ```ruby
-Array   #m                  => `[].m(:to_s)` => `[].map(&:to_s)`
+Enumerable
+        #m                  => `[].m(:to_s)` => `[].map(&:to_s)`
         #m!                 => `[].m!(:upcase)` => `[].map!(&:upcase)`
         #mm                 => `[].mm(:sub, /[aeiou]/, '*')` => `[].map { |x| x.sub(/[aeiou]/, '*') }` 
         #mm!                => `[].mm!(:sub, /[aeiou]/, '*')` => `[].map! { |x| x.sub(/[aeiou]/, '*') }` 
         #except             => `[].except('foo', 'bar')` => `[] - ['foo', 'bar']`
-Hash    #dig                => `{a: 1, b: {c: 2}}.dig(:b, :c)` => 2 (Part of standard lib in Ruby >= 2.3)
+        #map_keys           => `[{id: 1, name: 'foo'}, {id: 2}].map_keys(:id)` => `[1, 2]`
+Hash
+        #dig                => `{a: 1, b: {c: 2}}.dig(:b, :c)` => 2 (Part of standard lib in Ruby >= 2.3)
         #compact            => `{a: 1, b: nil}.compact` => {a: 1}
-Numeric #to_currency        => `25.245.to_currency` => 25.25 
+Numeric
+        #to_currency        => `25.245.to_currency` => 25.25 
         #to_duration        => `10_000.to_duration` => '2 h 46 min'
         #to_time_ago        => `10_000.to_time_ago` => '2 hours ago'
         #to_rad             => `10.15.to_rad` => 0.17715091907742445
-String  #pluralize          => `'hour'.pluralize(2)` => "hours"
+String
+        #pluralize          => `'hour'.pluralize(2)` => "hours"
         #underscore         => `'DuckPuncher::JSONStorage'.underscore` => 'duck_puncher/json_storage'
         #to_boolean         => `'1'.to_boolean` => true
         #constantize        => `'MiniTest::Test'.constantize` => MiniTest::Test
-Module  #local_methods      => `Kernel.local_methods` returns the methods defined directly in the class + nested constants w/ methods
-Object  #clone!             => `Object.new.clone!` => a deep clone of the object (using Marshal.dump)
+Module
+        #local_methods      => `Kernel.local_methods` returns the methods defined directly in the class + nested constants w/ methods
+Object
+        #clone!             => `Object.new.clone!` => a deep clone of the object (using Marshal.dump)
         #punch              => `'duck'.punch` => a copy of 'duck' with String punches mixed in
         #punch!             => `'duck'.punch!` => destructive version applies extensions directly to the base object
         #echo               => `'duck'.echo.upcase` => spits out the caller and value of the object and returns the object
         #track              => `Object.new.track` => Traces methods calls to the object (requires [object_tracker](https://github.com/ridiculous/object_tracker), which it'll try to download)
-Method  #to_instruct        => `Benchmark.method(:measure).to_instruct` returns the Ruby VM instruction sequence for the method
+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
 ```
 
@@ -38,19 +46,19 @@ Method  #to_instruct        => `Benchmark.method(:measure).to_instruct` returns
 Punch all registered ducks:
 
 ```ruby
-DuckPuncher.punch_all!
+DuckPuncher.()
 ```
 
 Punch individual ducks by name:
 
 ```ruby
-DuckPuncher.punch! Hash, Object
+DuckPuncher.(Hash, Object)
 ```
 
 One method to rule them all:
 
 ```ruby
-DuckPuncher.punch! Object, only: :punch 
+DuckPuncher.(Object, only: :punch)
 ```
 
 ### Tactical punches

data/bin/console

@@ -7,10 +7,10 @@ require 'irb'
 require 'byebug'
 require_relative '../test/fixtures/wut'
 
-DuckPuncher.log.level = Logger::DEBUG
+DuckPuncher.logger.level = Logger::DEBUG
 
 if ENV['PUNCH'] != 'no'
-  DuckPuncher.punch_all!
+  DuckPuncher.()
 end
 
 IRB.start

data/lib/duck_puncher/ancestral_hash.rb

@@ -0,0 +1,8 @@
+module DuckPuncher
+  # @note When updating this file please update comment regarding this module in duck_puncher.rb
+  module AncestralHash
+    def ancestral_hash
+      ::Hash.new { |me, klass| me[me.keys.detect { |key| key > klass }] if klass }
+    end
+  end
+end

data/lib/duck_puncher/decoration.rb

@@ -1,4 +1,5 @@
 module DuckPuncher
+  # @note When updating this file please update comment regarding this module in duck_puncher.rb
   module Decoration
     def decorators
       @decorators ||= ancestral_hash
@@ -18,7 +19,7 @@ module DuckPuncher
 
     def cached_decorators
       @cached_decorators ||= Hash.new do |me, target|
-        me[target] = DuckPuncher.decorators.select { |klass, _| klass >= target }.sort { |a, b| b[0] <=> a[0] }
+        me[target] = DuckPuncher.decorators.select { |klass, _| klass >= target }
       end
     end
 

data/lib/duck_puncher/defaults.rb

@@ -0,0 +1,20 @@
+DuckPuncher.logger = Logger.new(STDOUT).tap do |config|
+  config.formatter = proc { |*args| "[#{args[1]}] #{args[0]}: #{args[-1]}\n" }
+  config.level = Logger::ERROR
+end
+
+ducks = [
+  [String, DuckPuncher::Ducks::String],
+  [Enumerable, DuckPuncher::Ducks::Enumerable],
+  [Array, DuckPuncher::Ducks::Enumerable],
+  [Hash, DuckPuncher::Ducks::Enumerable],
+  [Numeric, DuckPuncher::Ducks::Numeric],
+  [Hash, DuckPuncher::Ducks::Hash],
+  [Object, DuckPuncher::Ducks::Object],
+  [Module, DuckPuncher::Ducks::Module],
+  [Method, DuckPuncher::Ducks::Method, { before: ->(_target) { DuckPuncher::GemInstaller.initialize! } }],
+]
+ducks << ['ActiveRecord::Base', DuckPuncher::Ducks::ActiveRecord] if defined? ::ActiveRecord
+ducks.each do |duck|
+  DuckPuncher.register *duck
+end

data/lib/duck_puncher/duck.rb

@@ -2,7 +2,6 @@ module DuckPuncher
   class Duck
     attr_accessor :target, :mod, :options
 
-    # @todo test punching a module
     # @param target [String,Class] Class or module to punch
     # @param mod [String,Module] The module that defines the extensions (@name is used by default)
     # @param [Hash] options to modify the duck #punch method behavior
@@ -20,14 +19,14 @@ module DuckPuncher
     # @option options [Symbol,String] :method Specifies if the methods should be included or prepended (:include)
     # @return [Class] The class that was just punched
     def punch(opts = {})
-      target = opts.delete(:target) || self.target
-      Array(target).each do |klass|
-        options[:before].call(klass) if options[:before]
-        klass.extend Usable
-        klass.usable mod, only: opts[:only], method: opts[:method]
-        options[:after].call(klass) if options[:after]
+      targets = Array(opts.delete(:target) || self.target)
+      targets.each do |target|
+        options[:before].call(target) if options[:before]
+        target.extend Usable
+        target.usable mod, only: opts[:only], method: opts[:method]
+        options[:after].call(target) if options[:after]
       end
-      target
+      targets
     end
 
     #

data/lib/duck_puncher/ducks/{array.rb → enumerable.rb}

@@ -1,6 +1,6 @@
 module DuckPuncher
   module Ducks
-    module Array
+    module Enumerable
       def m(method_name)
         map(&method_name)
       end
@@ -20,6 +20,10 @@ module DuckPuncher
       def except(*args)
         self - args
       end
+
+      def map_keys(key)
+        map { |x| x[key] }
+      end
     end
   end
 end

data/lib/duck_puncher/ducks/object.rb

@@ -34,7 +34,7 @@ module DuckPuncher
         begin
           require 'object_tracker' || raise(LoadError)
         rescue LoadError
-          DuckPuncher.punch! Object, only: :require! unless respond_to? :require!
+          DuckPuncher.(Object, only: :require!) unless respond_to? :require!
           require! 'object_tracker'
         end
         extend ::ObjectTracker

data/lib/duck_puncher/ducks.rb

@@ -1,7 +1,7 @@
 module DuckPuncher
   module Ducks
     autoload :String, 'duck_puncher/ducks/string'
-    autoload :Array, 'duck_puncher/ducks/array'
+    autoload :Enumerable, 'duck_puncher/ducks/enumerable'
     autoload :Numeric, 'duck_puncher/ducks/numeric'
     autoload :Hash, 'duck_puncher/ducks/hash'
     autoload :Object, 'duck_puncher/ducks/object'

data/lib/duck_puncher/gem_installer.rb

@@ -11,7 +11,7 @@ class DuckPuncher::GemInstaller
       begin
         require spec[:require_with]
       rescue LoadError => e
-        DuckPuncher.log.error "Failed to load #{spec[:require_with]} from .duck_puncher/ #{e.inspect}"
+        DuckPuncher.logger.error "Failed to load #{spec[:require_with]} from .duck_puncher/ #{e.inspect}"
       end
     end
   end
@@ -29,6 +29,6 @@ class DuckPuncher::GemInstaller
     end
     installer.installed_gems.any?
   rescue => e
-    DuckPuncher.log.error "Failed to install #{args.first}. #{e.inspect}"
+    DuckPuncher.logger.error "Failed to install #{args.first}. #{e.inspect}"
   end
 end

data/lib/duck_puncher/registration.rb

@@ -1,4 +1,5 @@
 module DuckPuncher
+  # @note When updating this file please update comment regarding this module in duck_puncher.rb
   module Registration
     def register(target, *mods)
       options = mods.last.is_a?(Hash) ? mods.pop : {}

data/lib/duck_puncher/utilities.rb

@@ -0,0 +1,23 @@
+module DuckPuncher
+  # @note When updating this file please update comment regarding this module in duck_puncher.rb
+  module Utilities
+    def lookup_constant(const)
+      return const if ::Module === const
+      if const.to_s.respond_to?(:constantize)
+        const.to_s.constantize
+      else
+        const.to_s.split('::').inject(::Object) { |k, part| k.const_get(part) }
+      end
+    rescue ::NameError => e
+      logger.error "#{e.class}: #{e.message}"
+      nil
+    end
+
+    def redefine_constant(name, const)
+      if const_defined? name
+        remove_const name
+      end
+      const_set name, const
+    end
+  end
+end

data/lib/duck_puncher/version.rb

@@ -1,3 +1,3 @@
 module DuckPuncher
-  VERSION = '4.1.0'.freeze
+  VERSION = '4.2.0'.freeze
 end

data/lib/duck_puncher.rb

@@ -1,4 +1,3 @@
-# Standard lib
 require 'pathname'
 require 'fileutils'
 require 'logger'
@@ -12,81 +11,51 @@ require 'usable'
 require 'duck_puncher/version'
 require 'duck_puncher/registration'
 require 'duck_puncher/decoration'
+require 'duck_puncher/utilities'
+require 'duck_puncher/ancestral_hash'
+require 'duck_puncher/duck'
+require 'duck_puncher/ducks'
 
 module DuckPuncher
-  autoload :JSONStorage, 'duck_puncher/json_storage'
   autoload :GemInstaller, 'duck_puncher/gem_installer'
-  autoload :Duck, 'duck_puncher/duck'
-  autoload :Ducks, 'duck_puncher/ducks'
+  autoload :JSONStorage, 'duck_puncher/json_storage'
 
   class << self
-    include Registration, Decoration
-
-    attr_accessor :log
-    alias_method :logger, :log
-
-    def punch!(*classes)
-      options = classes.last.is_a?(Hash) ? classes.pop : {}
+    # @description Include additional functionality
+    #   Registration[:register, :deregister]
+    #   Decoration[:decorators, :build_decorator_class, :decorate, :cached_decorators, :undecorate]
+    #   Utilities[:lookup_constant, :redefine_constant]
+    #   AncestralHash[:ancestral_hash]
+    include Registration, Decoration, Utilities, AncestralHash
+
+    attr_accessor :logger
+
+    # Backwards compatibility
+    alias_method :log, :logger
+    alias_method :log=, :logger=
+
+    def call(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      classes = args.any? ? args : Ducks.list.keys
       classes.each do |klass|
         klass = lookup_constant(klass)
         Ducks[klass].sort.each do |duck|
-          punches = options[:only] || Ducks::Module.instance_method(:local_methods).bind(duck.mod).call
-          log.info %Q(#{duck.target}#{" <-- #{punches}" if Array(punches).any?})
+          punches = Array(options[:only] || Ducks::Module.instance_method(:local_methods).bind(duck.mod).call)
           options[:target] = klass
+          logger.info %Q(#{klass}#{" <-- #{duck.mod.name}#{punches}" if punches.any?})
           unless duck.punch(options)
-            log.error %Q(Failed to punch #{name})
+            logger.error %Q(Failed to punch #{name})
           end
         end
       end
       nil
     end
 
-    def punch_all!
-      punch! *Ducks.list.keys
-    end
-
-    def lookup_constant(const)
-      return const if Module === const
-      if const.to_s.respond_to?(:constantize)
-        const.to_s.constantize
-      else
-        const.to_s.split('::').inject(Object) { |k, part| k.const_get(part) }
-      end
-    rescue NameError => e
-      log.error "#{e.class}: #{e.message}"
-      nil
-    end
-
-    def redefine_constant(name, const)
-      if const_defined? name
-        remove_const name
-      end
-      const_set name, const
-    end
-
-    def ancestral_hash
-      Hash.new { |me, klass| me[klass.superclass] if klass.respond_to?(:superclass) }
-    end
-  end
-
-  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
-
-  ducks = [
-    [String, Ducks::String],
-    [Array, Ducks::Array],
-    [Numeric, Ducks::Numeric],
-    [Hash, Ducks::Hash],
-    [Object, Ducks::Object],
-    [Module, Ducks::Module],
-    [Method, Ducks::Method, { before: ->(*) { DuckPuncher::GemInstaller.initialize! } }],
-  ]
-  ducks << ['ActiveRecord::Base', Ducks::ActiveRecord] if defined? ::ActiveRecord
-  ducks.each do |duck|
-    register *duck
+    # Backwards compatibility
+    alias punch_all! call
+    alias punch! call
   end
 end
+
+# Everyone likes defaults
+require 'duck_puncher/defaults'

data/test/lib/duck_puncher/{array_test.rb → enumerable_test.rb}

@@ -2,7 +2,7 @@ require_relative '../../test_helper'
 
 DuckPuncher.punch! Object
 
-class ArrayTest < MiniTest::Test
+class EnumerableTest < MiniTest::Test
   attr_reader :subject
 
   def setup
@@ -36,4 +36,10 @@ class ArrayTest < MiniTest::Test
     assert_equal subject.except('a', 'b', 'c'), %w[d e f g h i j k l m]
     assert_equal subject.except, subject
   end
+
+  def test_map_keys
+    @subject = [{ id: 1, name: 'a' }, { id: 2, name: 'b' }, { name: 'c' }]
+    assert_respond_to @subject.punch, :map_keys
+    assert_equal %w[a b c], @subject.punch.map_keys(:name)
+  end
 end

data/test/lib/duck_puncher_test.rb

@@ -6,7 +6,6 @@ class DuckPuncherTest < MiniTest::Test
   def setup
     @subject = Animal.new
     @kaia = Kaia.new
-    DuckPuncher.deregister Animal, Kaia, Dog
   end
 
   def teardown
@@ -22,12 +21,22 @@ class DuckPuncherTest < MiniTest::Test
     assert_respond_to @kaia.punch, :talk
   end
 
-
   def test_punch_all!
-    DuckPuncher.punch_all!
+    DuckPuncher.()
+    expected_methods = DuckPuncher::Ducks.list.values.m(:to_a).flatten.m(:mod).m(:local_methods).flatten
+    assert expected_methods.size > 1
+    good_ducks = DuckPuncher::Ducks.list.select { |_, ducks|
+      ducks.all? { |duck| (duck.mod.local_methods - duck.target.instance_methods(:false)).size.zero? }
+    }
+    assert good_ducks.size > 5
+  end
+
+  def test_call
+    DuckPuncher.()
     expected_methods = DuckPuncher::Ducks.list.values.m(:to_a).flatten.m(:mod).m(:local_methods).flatten
     assert expected_methods.size > 1
     good_ducks = DuckPuncher::Ducks.list.select { |_, ducks|
+      # Assert that all methods were copied over
       ducks.all? { |duck| (duck.mod.local_methods - duck.target.instance_methods(:false)).size.zero? }
     }
     assert good_ducks.size > 5

data/test/test_helper.rb

@@ -5,7 +5,7 @@ require 'duck_puncher'
 
 Minitest::Reporters.use!
 
-DuckPuncher.log.level = Logger::INFO
+DuckPuncher.logger.level = Logger::INFO
 
 module CustomPunch
   def talk

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duck_puncher
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: usable
@@ -105,11 +105,13 @@ files:
 - bin/console
 - duck_puncher.gemspec
 - lib/duck_puncher.rb
+- lib/duck_puncher/ancestral_hash.rb
 - lib/duck_puncher/decoration.rb
+- lib/duck_puncher/defaults.rb
 - lib/duck_puncher/duck.rb
 - lib/duck_puncher/ducks.rb
 - lib/duck_puncher/ducks/active_record.rb
-- lib/duck_puncher/ducks/array.rb
+- lib/duck_puncher/ducks/enumerable.rb
 - lib/duck_puncher/ducks/hash.rb
 - lib/duck_puncher/ducks/method.rb
 - lib/duck_puncher/ducks/module.rb
@@ -119,9 +121,10 @@ files:
 - lib/duck_puncher/gem_installer.rb
 - lib/duck_puncher/json_storage.rb
 - lib/duck_puncher/registration.rb
+- lib/duck_puncher/utilities.rb
 - lib/duck_puncher/version.rb
 - test/fixtures/wut.rb
-- test/lib/duck_puncher/array_test.rb
+- test/lib/duck_puncher/enumerable_test.rb
 - test/lib/duck_puncher/hash_test.rb
 - test/lib/duck_puncher/method_test.rb
 - test/lib/duck_puncher/module_test.rb
@@ -156,7 +159,7 @@ specification_version: 4
 summary: Administer precision extensions (a.k.a "punches") to your favorite Ruby classes
 test_files:
 - test/fixtures/wut.rb
-- test/lib/duck_puncher/array_test.rb
+- test/lib/duck_puncher/enumerable_test.rb
 - test/lib/duck_puncher/hash_test.rb
 - test/lib/duck_puncher/method_test.rb
 - test/lib/duck_puncher/module_test.rb