modularity-rails 0.7.1 → 0.8.0

data/README.md

@@ -8,6 +8,11 @@ that allows to compose functionally rich web pages in a clean and testable way
 out of well structured and reusable components.
 
 
+## Authors
+* [Kevin Goslar](https://github.com/kevgo) (kevin.goslar@gmail.com)
+* [Alex David](https://github.com/alexdavid)
+
+
 # Installation
 
 Add this line to your application's Gemfile:
@@ -112,6 +117,20 @@ Including this mixin makes a module closable. The mixin searches for an embedded
 * The _closable_closed_ hook of the closable class is called.
 
 
+## Tools
+
+### Loader
+A generic cached loader for parallel and repeated GET requests.
+Prevents duplicate requests, caches the responses.
+
+The first request triggers the ajax request. Subsequent requests while the resquest is running are accumulated without causing new requests.
+Once the response arrives, all currently requesting clients are answered. Subsequent requests are answered immediately using the cached data.  
+
+```coffeescript
+Module.loader.get '/test.json', (data) ->
+  # Use data here.
+```
+
 # Development
 
 ## Contributing

data/lib/modularity-rails/version.rb

@@ -1,3 +1,3 @@
 module ModularityRails
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

data/spec/javascripts/tools/ajax_loader_spec.coffee

@@ -0,0 +1,85 @@
+#= require spec_helper
+
+describe 'test environment setup', ->
+
+  it 'loading libraries', ->
+    load_modularity()
+    loadCS "/vendor/assets/javascripts/tools/ajax_loader.coffee"
+
+
+describe 'ajax_loader', ->
+  
+  describe 'get', ->
+    spy = null
+    beforeEach ->
+      spyOn(jQuery, 'get')
+      spy = jasmine.createSpy()
+      Module.loader.cache = {}
+
+    url = "user/4"
+
+    describe 'the data has already been loaded', ->
+      it 'calls the callback with the cached data', ->
+        spy = jasmine.createSpy()
+        url = "/users/4"
+
+        Module.loader.cache[url] = "my data"
+        Module.loader.get(url, spy)
+
+        expect(spy).toHaveBeenCalled()
+        expect(spy.argsForCall[0][0]).toEqual("my data")
+
+
+    describe 'the request is already in progress', ->
+
+      beforeEach ->
+        Module.loader.cache[url] = []
+        Module.loader.get(url, spy)
+
+
+      it 'adds the callback to the callback array', ->
+        expect(Module.loader.cache[url].length).toEqual(1)
+        expect(Module.loader.cache[url][0]).toEqual(spy)
+
+
+      it 'returns without calling the callback', ->
+        expect(spy).not.toHaveBeenCalled()
+
+
+      it 'does not make another ajax request', ->
+        expect(jQuery.get).not.toHaveBeenCalled()
+
+
+
+    describe 'first time request', ->
+      
+      beforeEach ->
+        Module.loader.get(url, spy)
+
+      it 'makes an ajax request', ->
+        expect(jQuery.get).toHaveBeenCalled()
+
+
+      it 'saves the callback for later', ->
+        expect(Module.loader.cache[url].length).toEqual(1)
+        expect(Module.loader.cache[url][0]).toEqual(spy)
+
+      it 'returns without calling the callback', ->
+        expect(spy).not.toHaveBeenCalled()
+
+
+    
+    describe 'ajax request successful', ->
+
+      beforeEach ->
+        jquery_callback = null
+        jQuery.get = (url, callback) -> jquery_callback = callback
+        Module.loader.get url, spy
+        jquery_callback('result')
+
+      it 'calls the given callbacks', ->
+        expect(spy).toHaveBeenCalled()
+        expect(spy.argsForCall[0][0]).toEqual('result')
+
+      it 'replaces the cache callbacks with returned data', ->
+        expect(Module.loader.cache[url]).toEqual('result')

data/vendor/assets/javascripts/tools/ajax_loader.coffee

@@ -0,0 +1,28 @@
+# A generic ajax loader for parallel GET requests.
+# Prevents duplicate requests, caches the responses
+# to answer subsequent requests immediately
+# without additional server requests.
+#
+# Warning: Caches the responses, so once a request is cached,
+#          any new content on the same URL will not be visible!
+Module.loader =
+
+  cache: {}
+
+  get: (url, callback) ->
+    cache = Module.loader.cache[url]
+
+    # New request --> start GET call, store callback.
+    unless cache?
+      Module.loader.cache[url] = [callback]
+      return jQuery.get url, (data) ->
+        cb(data) for cb in Module.loader.cache[url]
+        Module.loader.cache[url] = data
+
+    # Request while the GET call is still pending --> 
+    # add the given callback to the list of waiting callbacks.
+    if cache.constructor is Array
+      return cache.push callback
+
+    # There is a cached response for this request --> answer the request immediately.
+    callback(cache)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modularity-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-02 00:00:00.000000000 Z
+date: 2012-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70310922324920 !ruby/object:Gem::Requirement
+  requirement: &70363417911480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70310922324920
+  version_requirements: *70363417911480
 - !ruby/object:Gem::Dependency
   name: capybara-webkit
-  requirement: &70310922324500 !ruby/object:Gem::Requirement
+  requirement: &70363417911000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310922324500
+  version_requirements: *70363417911000
 - !ruby/object:Gem::Dependency
   name: evergreen
-  requirement: &70310922324020 !ruby/object:Gem::Requirement
+  requirement: &70363417910480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310922324020
+  version_requirements: *70363417910480
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70310922323560 !ruby/object:Gem::Requirement
+  requirement: &70363417909960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310922323560
+  version_requirements: *70363417909960
 - !ruby/object:Gem::Dependency
   name: guard-livereload
-  requirement: &70310922323080 !ruby/object:Gem::Requirement
+  requirement: &70363417909540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310922323080
+  version_requirements: *70363417909540
 description: Description of ModularityRails.
 email:
 - kevin.goslar@gmail.com
@@ -96,11 +96,13 @@ files:
 - spec/javascripts/templates/button.html
 - spec/javascripts/templates/closable.html
 - spec/javascripts/templates/test.html
+- spec/javascripts/tools/ajax_loader_spec.coffee
 - vendor/assets/javascripts/mixins/clickable.coffee
 - vendor/assets/javascripts/mixins/closable.coffee
 - vendor/assets/javascripts/modularity.js.coffee
 - vendor/assets/javascripts/modules/button.coffee
 - vendor/assets/javascripts/modules/counter_button.coffee
+- vendor/assets/javascripts/tools/ajax_loader.coffee
 homepage: http://github.com/kevgo/modularity-rails
 licenses: []
 post_install_message: