pied_piper 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d579aeffae1f032f9ee5e820ddbbaa907cdf9126aa053dbbd97d7d31e38cc24b
-  data.tar.gz: ca5279f4ddbf50304fa72029a5f3d871beb79f2e90b16f67da14d6bc19a723e4
+  metadata.gz: 28891debbf93a2a534057564d68b0fa12eb56a320634e495d084efe62df74651
+  data.tar.gz: 5f77d34e71bf2e0ec423d967dd7eb92edf2012f28cad208cb802e3848040d009
 SHA512:
-  metadata.gz: 0c210a151538ab94ef386fd7fa463007545b4a2329b67e59c717c5b2055b9abb854ea661034b6190db1f5965b2d63d238bd783377ba7cc641425df704986de5b
-  data.tar.gz: 9a98bd3b029ff085f5d96cc7c1ffa1a915b3e64ec1a3b9d51069597d1c18dd2180a0e7f31049e2faa58129b6ca2602d9b8bb76d854d34ad925eccbf7f6c93f23
+  metadata.gz: 9b686c4a5412660cae523bd19d9ca76aae68764680801d1ec8bf742928236a07c14a3f7df8e49a454f3ced3b6178e60fa0386125b3565ae5d24c9d2e6a61303a
+  data.tar.gz: a4a1c639b8c1abcb819ca4990b6161189190c84e3e29bc9c26cbcf951c0c5b86c497a9df35dcce0cf96859fff085c2cc657eff8b4f3f0abdf3d0d9ed208566fc

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in pied_piper.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pied_piper (0.1.4)
+    pied_piper (0.1.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -113,40 +113,62 @@ Thus the `PiedPiper` class was born.
 
 ### Ruby and its Kernel module
 
-If you want to add pipe functionality everywhere, we already talked about how to implement it above by requiring `pied_piper/kernel".
+If you want to add pipe functionality everywhere, we already talked about how to implement it above by requiring `pied_piper/kernel`.
 
-This will provide pipe functionality on every object which has `Object` in one of its superclasses ( thus practically every object in Ruby besides `BasicObject` ) with the least amount of monkey-patching/side-effects, since we only add one Kernel method named `piper` and don't alter existing behaviour.
+This will provide pipe functionality on every object which has `Object` in one of its superclasses ( thus practically every object in Ruby besides `BasicObject` which is the highest class in Ruby's inheritance hierarchy ) with the least amount of monkey-patching/side-effects, since we only add one `Kernel` method named `piper` and don't alter existing behaviour.
 
 In case you didn't know:
 
 `Object` includes `Kernel` as a module.
 
+Included modules can be seen in Ruby like this:
+
+```ruby
+Object.included_modules
+# => [Kernel]
+```
+
+If you want to see the whole inheritance chain of a class (with superclasses and included/prepended modules) you can do this:
+
+```ruby
+Object.ancestors
+# => [Object, Kernel, BasicObject]
+```
+
+Since Object `includes Kernel`, `Kernel` follows after `Object`.
+
+If `Object` would `prepend Kernel`, `Kernel` would be before `Object`.
+
 Methods who are intended to be globally available, like `puts` and `gets`, and who aren't intended to be available with an explicit receiver like `"foo".puts` are defined as private instance methods on `Kernel`.
 
-Private instance methods can only be called with an implicit receiver (implicit self) in Ruby.
+All private instance methods can only be called with an implicit receiver (implicit self) in Ruby.
 
-That's why things like this work, because were always "inside" an object:
+That's why things like this work with an implicit receiver/self, because were always "inside" an object:
 
 ```ruby
 puts self
 # main
 # nil
 
-# implicit receiver for puts
+# implicit receiver/self for puts
 puts "foo"
 ```
 
-but this doesn't:
+... but this doesn't, since we called `puts`  on an explicit receiver:
 
 ```ruby
-# explicit receiver for puts
+# explicit receiver/self for puts
 self.puts "foo"
 # => NoMethodError: private method `puts' called for main:Object
 ```
 
-So if you want to provide functionality that's available everywhere like `puts` the usual approach is to define a private instance method on Kernel.
+So if you want to provide functionality that's available everywhere like `puts`, but cannot be called on an object, the usual approach is to define a private instance method on Kernel.
+
+That's what has been done with the `piper` and `p_end` methods and can be seen in the source [here](https://github.com/christophweegen/pied-piper/blob/master/lib/pied_piper/kernel.rb) :-)
+
+Just a bit of background information, in case you're curious how this gem was implemented.
 
-That's what has been done with the `piper` and `p_end` method :-)
+But back to usage...
 
 ### Array Pipes
 
@@ -161,6 +183,26 @@ p | concat  | p.end
 # => "Pied Piper of Hamelin"
 ```
 
+If the first array element is a Symbol and the last is an object of class `Proc`, we can also use methods which accept blocks:
+
+```ruby
+p = piper("Pied Piper")
+
+map_double = [:map, ->(str) { str * 2 }]
+p | :split | map_double | :join | p_end
+# => "PiedPiedPiperPiper"
+```
+
+It's also possible to use methods with arguments and blocks, arguments have to between the method name (first element of the array) and the last element of the array which is a block:
+
+```ruby
+p = piper("Pied Piper")
+
+map_double_array = [:each_with_object, [], ->(str, array) { |str| array << [str * 2]}]
+p | :split | map_double_array | p_end
+# => [["PiedPied"], ["PiperPiper"]]
+```
+
 ### Proc Object Pipes
 
 An Object of `Proc` class which takes exactly one parameter:

data/lib/pied_piper.rb

@@ -26,12 +26,18 @@ class PiedPiper
     when Symbol
       @object.send(function)
     when Array
-      meth, *args = function
-      case meth
+      method, *args, blk = function
+      case method
+
       when Symbol
-        @object.send(meth, *args)
+        case blk
+        when Proc
+          @object.send(method, *args, &blk)
+        else
+          @object.send(method, *args, blk)
+        end
       when Method
-        meth.call(@object, *args)
+        method.call(@object, *args)
       end
     when Proc
       function.call(@object, *args)

data/lib/pied_piper/version.rb

@@ -1,3 +1,3 @@
 class PiedPiper
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.5'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pied_piper
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Christoph Weegen