yieldable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3ec314bc5b85c0ce2c8a51066d428e69535eafe78a86b94e19bfc580b6140c5
-  data.tar.gz: 3b72b7259dd3e9323cef9b214d5c02dca1237082711ae08dff572cdd691bf010
+  metadata.gz: 79e8cb644aa929ab313099282285e9f3aa2db151144efc8b07ff4a774fccc80d
+  data.tar.gz: a175016151807bad144be44ad951ee561629f697d4b8ef009f796d52ef084b71
 SHA512:
-  metadata.gz: 9726fcc6cc5a07221aed121af8ab7e1e47ed5157cbe57ea8935e0d2f9db6dd9af7239c86bfc57f36dc6e3894ab51cdc6bd2c10dd448dd322d2fe8bfc809d67fe
-  data.tar.gz: 630e3203ca6dd8307b60564827c10a44f643ef563ed3d6731b6a74f4f2312f8c3ef0ceb027093d25d8cc5baa58f769db8c4c0db3e031b084eb48131387add759
+  metadata.gz: 9e90acbbd5aeb4e9bfcca226f1d3850f8e631df9ee1241775ded0d72d63b87210b6565923ef39c3c91fe2b1430476ecdc3f5c7af7a2396e7235d1ba235c9378f
+  data.tar.gz: c356ff0c2af1ffd8dac446667dcb12079abcc4cf36bebafdc83e834245316af9ebedb888f5f6ca4c8f33f460d619c6f0a5a566b0717a06f9b12f4270070e5fd0

data/README.md

@@ -4,7 +4,9 @@ Welcome to your new gem! In this directory, you'll find the files you need to be
 
 Yieldable is meta-mixin, which makes your module, class or it's instance to respond to method +to_proc+, for example, to easily build instances during iteration:
 
-  ["1", "2", "3"].map(&SomeObject)
+```ruby
+["1", "2", "3"].map(&SomeObject)
+```
 
 ## Installation
 
@@ -24,36 +26,45 @@ Or install it yourself as:
 
 ## Usage
 
-It is 2 different ways to use this module: +extend+ or +prepend+ it to your class.
+It is 2 different ways to use this module: `extend` or `prepend` it to your class.
 
-== <tt>extend Yieldable</tt>
+### `extend Yieldable`
 
-  class SomeObject
-    extend Yieldable # => singleton_class.to_proc = SomeObject.method(:call).to_proc
-  end
+```ruby
+class SomeObject
+  extend Yieldable 
+  # => singleton_class.to_proc = SomeObject.method(:call).to_proc
+end
+```
 
-This way defines an attribute reader +to_proc+ in a singleton class.
-It sets a proc only once for a class, so it will not generate a new +Proc+ object
-every time, like if you would use just a <tt>method(:call).to_proc</tt>.
-By default it uses the +call+ class method as a source method for a proc. You
-can change the source method name by using brackets:
+This way defines an attribute reader `#to_proc` in a singleton class.
+It sets a proc only once for a class, so it will not generate a new `Proc` object
+every time, like if you would use just a `method(:call).to_proc`.
+By default it uses the `call` class method as a source method for a proc. 
 
-  class SomeObject
-    extend Yieldable[:new] # => singleton_class.to_proc = SomeObject.method(:new).to_proc
-  end
+You can change the source method name by using brackets:
 
-It's better to ensure that a source method is defined _before_ extending a class with +Yieldable+.
-In the other way it will add the +singletone_method_added+ hook and wait. After a source method
+```ruby
+class SomeObject
+  extend Yieldable[:new] 
+  # => singleton_class.to_proc = SomeObject.method(:new).to_proc
+end
+```
+
+It's better to ensure that a source method is defined _before_ extending a class with `Yieldable`.
+In the other way it will add the `Yieldable::WaitMethodDefinition.singletone_method_added` hook and wait. After a source method
 will be added, the hook method will be removed.
 
-You can avoid to removing the hook with an optional <tt>once: false</tt> passed into the brackets:
+You can avoid to removing the hook with an optional `once: false` passed into the brackets:
 
-  extend Yieldable[:new, once: false]
+```ruby
+extend Yieldable[:new, once: false]
+```
 
-== <tt>prepend Yieldable</tt>
+### `prepend Yieldable`
 
-This way defines a +to_proc+ instance method once for a class, but a proc will be generated once for
-each object. You can also use a brackets like within an +extend+ way.
+This way defines a `#to_proc` instance method once for a class, but a proc will be generated once for
+each object. You can also use a brackets like within an `extend` way.
 
 
 ## Development

data/lib/yieldable/version.rb

@@ -1,3 +1,3 @@
 module Yieldable
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yieldable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Anton Semenov