delegate_it 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e57152f604c87fa5c3232b78d9a35cfdd5b9ea82
-  data.tar.gz: a5329c960ac1e9efbe11d9f5bdb49fe09076e84e
+  metadata.gz: 6f50eddfb21b4ce5194f165f8a54aa0c0289de12
+  data.tar.gz: 160a17d66a8b07abcd2b6d815c20f158d6f9c395
 SHA512:
-  metadata.gz: c8e6667235220cc6ef4d55f16ecb623b91603ac15a6c2efb99636ecd74255ca94a97960cdc248924a63d8b591196d910ed96ffa38dda1546eaf68d7cf1b036f4
-  data.tar.gz: f3e461c652478fcadba16bc4ca59fa23d739e6ea554f1eb844057bab21f0904283ec1ceb307e31208ff4355c015c458f8161189b865d34fcac9725fa3189e94b
+  metadata.gz: 290e75c1e27cf94be088089cadf1c8364dd042edf8c57e30cfd1c7bcf095cbc4c9ba647f011fd4a8c452110a485db9355584f89a052bd5421985ef864723c7e2
+  data.tar.gz: 84782ae5584bbd95de9fed4d37c5b6bef3de28f958264a8e5855be9d97d14f1210c4efd661c742e5faa4f4aad9fac8ba48c96e682e5ab4b05994cfefa0e9524c

data/README.md

@@ -1,3 +1,41 @@
-# Delegate_it
+# Delegate it
 
-Delegate_it gem provides an easy way to use ActiveSupport like `delegate` method in your non Rails projects.
+delegate_it gem provides an easy way to use ActiveSupport like `delegate` method in your non Rails projects.
+
+## Installation
+
+In your Gemfile:
+
+````ruby
+gem 'delegate_it'
+````
+
+## Usage
+
+```` ruby
+class Offer
+  include DelegateIt
+
+  delegate :name, :description, to: :product
+  delegate :brand, to: :manufacturer, allow_nil: true
+
+  private
+
+  def product
+    Struct.new(:name, :description)
+    .new('Great product', 'Awesome!')
+  end
+end
+
+offer = Offer.new
+offer.name # => 'Great product'
+offer.description # => 'Awesome!'
+offer.brand # => nil
+
+````
+
+### Supported options
+
+  `allow_nil: true` - if the delegate does not exist method call will return nil.
+
+PRs are welcome.

data/lib/delegate_it/main.rb

@@ -32,4 +32,4 @@ module DelegateIt
       super
     end
   end
-end
+end

data/lib/delegate_it/version.rb

@@ -1,3 +1,3 @@
 module DelegateIt
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

data/spec/delegate_it/main_spec.rb

@@ -91,4 +91,3 @@ describe 'DelegateIt' do
     end
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delegate_it
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - pawurb