forwardable-extended 2.4.3 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 358e5f1ae11b0c4aef42ef9fe0cb9a715072567d
-  data.tar.gz: c04370f5d7cd533bfe8d2615818d0ca4ed08182e
+  metadata.gz: a0bf26e6d3a0d6c8702033209c8cc78dd66e91b8
+  data.tar.gz: cff44e0ccbc27734e5b7537f1bfb7ab00699d6af
 SHA512:
-  metadata.gz: 74df3a5ede82a5094b3d0d21636b69ac1579c5f75bbddbf24b02bc0dbd26056794962302bfe7983ae0cb2333e3c25f3e18c451f3fdff5da078f7ef272f72adec
-  data.tar.gz: cc66189537e5f8ca95ce0cc44a568cef86b4c828206585bc795ebf4c2662f9839679d1ae2ecd95c438672cb1a5f738944dd24065f2b025ae7c089004b2e396c4
+  metadata.gz: 956f7150e5cf3d1c008debc814333c1b15b6447dce17857a7a6593bea964e76f0d1d74f68e8828ed9dce6bd5cb309d0dc9069539aaea12635ea1374b1aef137f
+  data.tar.gz: 1067a33f3dbaa30926b9f52a01a6031160a2864a98b4b74a7d80745680f20a47936d612f4c3337903524865fb576d5973d84af91d14c0e4ba84fe6079d688353

data/lib/forwardable/extended.rb

@@ -1,8 +1,6 @@
-# ----------------------------------------------------------------------------
 # Frozen-string-literal: true
 # Copyright: 2015-2016 Jordon Bedwell - MIT License
 # Encoding: utf-8
-# ----------------------------------------------------------------------------
 
 require "forwardable/extended/version"
 require "forwardable"
@@ -10,10 +8,9 @@ require "forwardable"
 module Forwardable
   module Extended
 
-    # ------------------------------------------------------------------------
     # Make our methods private on the class, there is no reason for public.
-    # ------------------------------------------------------------------------
-
+    # This makes it so that things are cleaner to view when inside of REPL's/Debuggers.
+    # That way you don't see our methods without asking to see them.
     def self.extended(klass)
       instance_methods.each do |method|
         klass.private_class_method(
@@ -22,10 +19,10 @@ module Forwardable
       end
     end
 
-    # ------------------------------------------------------------------------
-    # A simpler delegator that wraps around `def_delegator` and makes it easy.
-    # ------------------------------------------------------------------------
-
+    # Delegate using a Rails-like interface.
+    # to - the class (object) you are delegating to.
+    # alias_of - the method of the class (by default it's the method.)
+    # method - the method you are forwarding.
     def rb_delegate(method, to: nil, alias_of: method, **kwd)
       raise ArgumentError, "to must be provided" unless to
       def_delegator(
@@ -33,14 +30,12 @@ module Forwardable
       )
     end
 
-    # ------------------------------------------------------------------------
-    # Delegates a method to a `hash[key]`.
-    # @param [Symbol] key used if method is an alias; disignates the hash key.
-    # @param [Hash] hash the hash object you wish to delegate to.
-    # ------------------------------------------------------------------------
-
+    # Delegate a method to a hash and key.
+    # key - the key to use if the method is not the key.
+    # method - the name of the method you wish to create.
+    # hash - the hash you are delegating to.
     def def_hash_delegator(hash, method, key: method, **kwd)
-      prefix, suffix, wrap = __prepare(**kwd)
+      prefix, suffix, wrap = prepare_delegate(**kwd)
 
       if suffix
         method = method.to_s.gsub(
@@ -66,15 +61,12 @@ module Forwardable
       STR
     end
 
-    # ------------------------------------------------------------------------
-    # Delegates a method to an instance variable.
-    # @note if you are not using an alias or booleans use `attr_reader`.
-    # @param [String, Symbol] ivar the instance variable.
-    # @param [String, Symbol] alias_ the alias.
-    # ------------------------------------------------------------------------
-
+    # Delegate a method to an instance variable.
+    # ivar - the instance variable you are aliasing.
+    # alias_ - alias it to another method name.
+    # Note: If you are not doing booleans then don't bother with this.
     def def_ivar_delegator(ivar, alias_ = ivar, **kwd)
-      prefix, suffix, wrap = __prepare(**kwd)
+      prefix, suffix, wrap = prepare_delegate(**kwd)
 
       if suffix
         alias_ = alias_.to_s.gsub(
@@ -100,17 +92,14 @@ module Forwardable
       STR
     end
 
-    # ------------------------------------------------------------------------
-    # A more beefed up version of Ruby's `def_delegator` that
-    # offers a tiny bit more than the default version in `Forwardable`
-    # @param [Object<>] accessor the object to ship your method to.
-    # @param [String, Symbol] method the method being messaged.
-    # @param [Array<>] args the arguments to place in front.
-    # ------------------------------------------------------------------------
-
+    # method - the method you wish to delegate.
+    # alias_ - the name of the method on the current object.
+    # args - arguments to pass to the method.  Note: these are inspected.
+    # Like def_delegator but allows you to send args and do other stuff.
+    # accessor - the object you wish to delegate to.
     def def_modern_delegator(accessor, method, alias_ = method, args: [], **kwd)
       args = [args].flatten.compact.map(&:to_s).unshift("").join(", ")
-      prefix, suffix, wrap = __prepare(**kwd)
+      prefix, suffix, wrap = prepare_delegate(**kwd)
 
       if suffix
         alias_ = alias_.to_s.gsub(
@@ -136,12 +125,7 @@ module Forwardable
       STR
     end
 
-    # ------------------------------------------------------------------------
-    # Wraps around traditional def_delegator to offer forwarding to modern,
-    # ivar and hash delegators.  With a bit of data checking between.
-    # @see `Object::Forwardable#def_delegator`
-    # ------------------------------------------------------------------------
-
+    # Wraps around traditional delegation and modern delegation.
     def def_delegator(accessor, method, alias_ = method, **kwd)
       kwd, alias_ = alias_, method if alias_.is_a?(Hash) && !kwd.any?
 
@@ -155,18 +139,14 @@ module Forwardable
         )
 
       else
-        raise ArgumentError, "Alias not supported with type" if alias_ != method
-        send("def_#{kwd[:type]}_delegator", accessor, method, **kwd.tap { |obj|
+        raise ArgumentError, "Alias not supported." if alias_ != method
+        send("def_#{kwd[:type]}_delegator", accessor, method, **kwd.tap do |obj|
           obj.delete(:type)
-        })
+        end)
       end
     end
 
-    # ------------------------------------------------------------------------
-    # Wraps around traditional `def_delegators` to detect hash arguments.
-    # @see `Object::Forwardable#def_delegators`
-    # ------------------------------------------------------------------------
-
+    # Create multiple delegates at once.
     def def_delegators(accessor, *methods)
       kwd = methods.shift if methods.first.is_a?(Hash)
       kwd = methods.pop   if methods. last.is_a?(Hash)
@@ -177,14 +157,10 @@ module Forwardable
       end
     end
 
-    # ------------------------------------------------------------------------
-    # Prepares the suffix, prefix and wrap method if available.
-    # @param [true, false, :reverse] bool whether or not this is a boolean.
-    # @param [true, Symbol, String] wrap wrap result into the wrap.
-    # ------------------------------------------------------------------------
-
-    private
-    def __prepare(wrap: nil, bool: false)
+    # Prepares a delegate and it's few arguments.
+    # wrap - whether to wrap (or the class to wrap it with.)
+    # bool - whether or not this delegate is a boolean.
+    private def prepare_delegate(wrap: nil, bool: false)
       prefix = (bool == :reverse ? "!!!" : "!!") if bool
       wrap   = "self.class.new" if wrap.is_a?(TrueClass)
       suffix = "?" if bool

data/lib/forwardable/extended/version.rb

@@ -4,6 +4,6 @@
 
 module Forwardable
   module Extended
-    VERSION = "2.4.3"
+    VERSION = "2.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forwardable-extended
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 2.5.0
 platform: ruby
 authors:
 - Jordon Bedwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-03-17 00:00:00.000000000 Z
 dependencies: []
 description: Forwardable with hash, and instance variable extensions.
 email:
@@ -42,7 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Forwardable with hash, and instance variable extensions.