metaprogrammer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a381d9508c34f1f4f2bc6a369bd5e4fb1cdd46a4fa41396d639dacd988e7ebd
-  data.tar.gz: f0786bd8310cfea0f8489cc996bc6de537fcf36ec35dd3b38a80a48dafcc577d
+  metadata.gz: 0d299382d0bbbd8d3262540fb1858d56137e4eb7021762621a50a874a501de2d
+  data.tar.gz: 7102fa8d9a6e9ba6944fc6072109818bc83353aff4bfd7cc9b877812079886c3
 SHA512:
-  metadata.gz: a2d5d43631cd5a3d4bd341ca06ed8aef4d8f7c5042a54656cb1b156a1c20821cc6db3906f4b6527675809e9f9fdcb8916ea423537579a7c5736cf64780dcb850
-  data.tar.gz: fc6101bc1fb32dda0136cedd3d2ccb86002d22935401cf8cf5a02c4e8ea480c80f4604428f04fc988433653a428c60bf91b2d2f6e9901ffaed35c1b43c0dc487
+  metadata.gz: f596ed55a57c676a7122fb603bba2094903445035e10eb7addd0ed081875b6c12e7424cae75baab3e7bd1506eeacaee9f8c1aaa4948cdaad8c82e15f5170d9fd
+  data.tar.gz: 4e981efd236ce35674193f2d30c96c9ff25c4d5b1327d4ee00951c45906309cb27a75a74841f6fe447798c701bee5b6029a4cfb07e4954ce1b3cbb62bd19fd8d

data/README.md

@@ -0,0 +1,77 @@
+## Metaprogrammer
+
+---
+
+### Install
+
+Install from rubygems, the gem is named 'metaprogrammer'.
+
+### Usage
+
+`Metaprogrammer` is a module. There are two main methods it exposes:
+
+- `patch_class_methods`
+- `patch_instance_methods`.
+
+There is also a `patch_all_methods` method that has the same signature
+as the other two, and calls them both.
+
+An example usage looks like this:
+
+```
+class MyClass
+  extend Metaprogrammer
+  def foo
+    1
+  end
+  def self.foo
+    1
+  end
+end
+
+MyClass.patch_all_methods do |orig_method, **args, &blk|
+  orig_method.call(**args, &blk) + 1
+end
+
+MyClass.foo # => 2
+MyClass.new.foo # => 2
+```
+
+You can manipulate the arguments or the return value.
+
+A couple example usages are included with the gem:
+
+```
+# Rescue all errors
+MyClass.rescue_all_methods(RuntimeError) do |error|
+  puts "#{error.class} was raised!"
+end
+
+# Memoize all methods
+MyClass.memoize # memoizes all methods.
+```
+
+The implementations of these methods are pretty simple
+(assuming these are called in class scope of the method which extends Metaprogrammer)
+
+```
+# rescue all methods
+patch_all_methods do |orig_method, *args, &caller_blk|
+  begin
+    orig_method.call *args, &caller_blk
+  rescue *exceptions => e
+    blk.call(e)
+  end
+end
+
+# memoize methods
+patch_all_methods do |orig_method, *args, &caller_blk|
+  memos = @_memoized_methods ||= {}
+  method_memos = @_memoized_methods[orig_method] ||= {}
+  method_memos[args] ||= orig_method.call *args, &caller_blk
+end
+```
+
+`patch_all_methods`, `patch_class_methods`, and `patch_instance_methods` can all
+be configured with `only:` and `except:` options. These should be given
+as arrays of symbols corresponding to method names.

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Metaprogrammer
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metaprogrammer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - max pleaner
@@ -17,6 +17,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/metaprogrammer
 - lib/metaprogrammer.rb
 - lib/metaprogrammer/usages.rb