roda-container 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15d116dc716eb7e2220f95bab7a4179e53737569
-  data.tar.gz: 02779f0dd1d9e5c7c6ab4bec115abd2f65d1d586
+  metadata.gz: 332f3de4a0b33b8ee1b9d15d0b4d2458321ad231
+  data.tar.gz: 49cfa204feae3922fd56f179fff187b1a5ec3f07
 SHA512:
-  metadata.gz: 7134e5541427b5da8d8b49f217baccdc3d5063fe6a350ccbf19c09b68167821f97bdc5489d887c4ae032a0749f7c3b46b3d9bea9965dc85f62980cb7ebf6600d
-  data.tar.gz: fcafa937f4f20c140ea30397a28478631381aad60f9a732e49af9e0d6260cbcc26d6568b82bdc344cb0edd9395027fd247dd7a0e1e8537601b83fa7123cb00d0
+  metadata.gz: f1d0773bec2dc4fe6e5ac3e36a81a4832afb24b78d1098d9be60f83986df68df89d45fe756689a44a62b8b4f9c3d3db718974002b598283f04be6d6c55836105
+  data.tar.gz: 3427710252525289662f4977db2024cc9d8ab83137167254e73d07f501c91918f7e6f3b4f6f61751a945b0f613b133cb82e8929e65c698cc8e81cac1172109bd

data/README.md

@@ -1,11 +1,11 @@
-# roda-container
+# roda-container <a href="https://gitter.im/AMHOL/roda-container" target="_blank">![Join the chat at https://gitter.im/AMHOL/roda-container](https://badges.gitter.im/Join%20Chat.svg)</a>
 
 A plugin for Roda which turns your application into a (IoC) container
 
 ## Installation
 
 ```ruby
-gem 'roda-container', '0.0.3'
+gem 'roda-container', '0.1.0'
 ```
 
 ## Usage
@@ -47,13 +47,13 @@ MyApplication.route do |r|
   # Roda responds to the instance method #call, with the call: false
   # option, calling MyApplication.instance.resolve(:app) will not attempt to call
   # it, without the option, the application would error
-  MyApplication.instance.register(:app, self, call: false)
+  register(:app, self, call: false) # Roda#register, regiser with the request container
 end
 ```
 
 ## Thread safety
 
-Please note the use of `MyApplication.instance.register` and `MyApplication.instance.resolve` above, without the calls to `Roda.instance` there is a high possiblilty of a thread safety issue when registering anything at runtime. For example:
+Please note the use of and `MyApplication.instance.resolve` above, without the call to `Roda.instance` the item will not be present in the container, as it was registered with the request container (using Roda#register), without this, there is high possiblilty of a thread safety issue when registering anything at runtime. For example:
 
 ```ruby
 class MyApplication < Roda
@@ -62,7 +62,7 @@ end
 
 MyApplication.route do |r|
   # DO NOT DO THIS, SEE ABOVE ^^^
-  MyApplication.register(:app, self, call: false)
+  MyApplication.register(:app, self, call: false) # Roda.register, register with the global container
 
   r.on 'users' do
     # ...
@@ -78,9 +78,17 @@ MyApplication.route do |r|
 end
 ```
 
-Immagine a user hitting `POST /users`, then another user hitting `GET /users/{id}` in quick succession; the first user registers their instance of app with the container, then hits the 5 second sleep, then the second user comes along, registers their instance of app with the container, the request executes and they go on their merry way.
+Immagine a user hitting `POST /users`, then another user hitting `GET /users/{id}` in quick succession; the first user registers their instance of app with the global container, then hits the 5 second sleep, then the second user comes along, registers their instance of app with the global container, the request executes and they go on their merry way.
 
-A few seconds later the 5 second sleep is complete, and the first user resolves `:app` from the container, only to find the instance that was registered by the user hitting `GET /users/{id}`, they have just spent 5 minutes meticulously filling out your webform to create their user account, only for their payload to lost in a race condition, needless to say, you don't want this to happen.
+A few seconds later the 5 second sleep is complete, and the first user resolves `:app` from the global container, only to find the application instance that was registered by the user hitting `GET /users/{id}`, they have just spent 5 minutes meticulously filling out your webform to create their user account, only for their payload to be lost in a race condition, needless to say - you don't want this to happen.
+
+This is preventable by registering anything specific to a request with the request container, this is done using the `Roda#register` method, i.e.
+
+```ruby
+MyApplication.route do |r|
+  register(:app, self, call: false) # Roda#register, regiser with the request container
+end
+``
 
 ## Contributing
 

data/lib/roda/plugins/container.rb

@@ -106,6 +106,10 @@ class Roda
           Thread.current[:__container__] = self.class.send(:container).dup
           super
         end
+        
+        def register(*args, &block)
+          self.class.instance.register(*args, &block)
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda-container
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler