modularity-rails 0.14.0 → 0.15.0

data/demo/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', '3.2.3'
+gem 'rails', '3.2.9'
 
 gem 'capybara-webkit'
 gem 'jquery-rails'

data/demo/spec/javascripts/data/ajax_loader_spec.coffee

@@ -4,133 +4,129 @@
 
 describe 'ajax_loader', ->
   
-  ajax_loader = spy = spy_get = null
+  ajax_loader = spy = spy_get = spy_fire = null
   beforeEach ->
     spy = sinon.spy()
     spy_get = sinon.spy jQuery, 'get'
+    spy_fire = sinon.spy modularity, 'fire_global_event'
 
   afterEach ->
     spy_get.restore()
+    spy_fire.restore()
 
   describe 'constructor', ->
+
     it "stores the 'cache' settings", ->
       loader = new modularity.AjaxLoader {caching: yes}
-      loader.caching.should.be.true
+      expect(loader.caching).to.be.true
+
+    it 'defaults to no caching', ->
+      loader = new modularity.AjaxLoader {}
+      expect(loader.caching).to.be.false
 
 
   describe 'get', ->
     url = "/users/4"
 
-    describe 'with caching enabled', ->
+    beforeEach ->
+      ajax_loader = new modularity.AjaxLoader {caching: yes}
 
-      beforeEach ->
-        ajax_loader = new modularity.AjaxLoader {caching: yes}
+    describe 'first time request', ->
 
-      describe 'first time request', ->
+      beforeEach ->
+        ajax_loader.get url, spy
 
-        beforeEach ->
-          ajax_loader.get url, spy
+      it 'makes an ajax request', ->
+        expect(jQuery.get).to.have.been.calledOnce
 
-        it 'makes an ajax request', ->
-          jQuery.get.should.have.been.called
+      it 'saves the callback for later', ->
+        expect(ajax_loader.cb_cache.get(url)).to.have.length 1
+        expect(ajax_loader.cb_cache.get(url)[0]).to.equal spy
 
+      it 'returns without calling the callback', ->
+        expect(spy).to.not.have.been.called
 
-        it 'saves the callback for later', ->
-          ajax_loader.cache.get(url).should.have.length 1
-          ajax_loader.cache.get(url)[0].should.equal spy
 
-        it 'returns without calling the callback', ->
-          spy.should.not.have.been.called
+    describe 'the request is already in progress', ->
 
-      describe 'the request is already in progress', ->
+      existing_cb = sinon.spy()
+      new_cb = sinon.spy()
+      beforeEach ->
+        ajax_loader.cb_cache.add url, [existing_cb]
+        ajax_loader.get url, new_cb
 
-        beforeEach ->
-          ajax_loader.cache.cache[url] = [spy]
+      it 'adds the callback to the callback cache', ->
+        expect(ajax_loader.cb_cache.get(url)).to.have.length 2
+        expect(ajax_loader.cb_cache.get(url)[0]).to.equal existing_cb
+        expect(ajax_loader.cb_cache.get(url)[1]).to.equal new_cb
 
+      it 'returns without calling the callback', ->
+        expect(new_cb).to.not.have.been.called
 
-        it 'adds the callback to the callback array', ->
-          ajax_loader.cache.get(url).should.have.length 1
-          ajax_loader.cache.get(url)[0].should.equal spy
+      it 'does not make another ajax request', ->
+        expect(jQuery.get).to.not.have.been.called
 
+      it "does not fire the 'loading' event", ->
+        expect(modularity.fire_global_event).to.not.have.been.called
 
-        it 'returns without calling the callback', ->
-          spy.should.not.have.been.called
 
+    describe 'ajax request returns successfully', ->
 
-        it 'does not make another ajax request', ->
-          jQuery.get.should.not.have.been.called
+      old_jquery_get = null
+      beforeEach ->
+        jquery_callback = null
+        old_jquery_get = jQuery.get
+        jQuery.get = (url, callback) -> callback 'result'
 
-      describe 'ajax request successful', ->
+      afterEach ->
+        jQuery.get = old_jquery_get
 
+      describe 'with caching enabled', ->
         beforeEach ->
-          jquery_callback = null
-          jQuery.get = (url, callback) -> jquery_callback = callback
+          ajax_loader.caching = true
           ajax_loader.get url, spy
-          jquery_callback('result')
 
         it 'calls the given callbacks with the server data', ->
           expect(spy.calledWith('result')).to.be.true
 
-        it 'replaces the cache callbacks with returned data', ->
-          ajax_loader.cache.get(url).should.equal 'result'
-
-      describe 'the data has already been loaded', ->
-
-        it 'calls the callback with the cached data', ->
-          ajax_loader.cache.add url, "my data"
-
-          ajax_loader.get(url, spy)
+        it 'removes the callbacks from the callback cache', ->
+          expect(ajax_loader.cb_cache.get(url)).to.be.undefined
 
-          spy.should.have.been.called
-          expect(spy.calledWith('my data')).to.be.true
+        it 'stores the data in the data cache', ->
+          expect(ajax_loader.data_cache.get(url)).to.equal 'result'
 
+        it "fires the 'loading' event", ->
+          expect(modularity.fire_global_event.calledWith('AJAX_LOADED')).to.be.true
 
-    describe 'with caching disabled', ->
-
-      beforeEach ->
-        ajax_loader = new modularity.AjaxLoader {caching: no}
-
-      describe 'first time request', ->
 
+      describe 'with caching disabled', ->
         beforeEach ->
+          ajax_loader.caching = false
           ajax_loader.get url, spy
 
-        it 'makes an ajax request', ->
-          jQuery.get.should.have.been.called
-
-        it 'saves the callback for later', ->
-          ajax_loader.cache.get(url).should.have.length 1
-          ajax_loader.cache.get(url)[0].should.equal spy
-
-        it 'returns without calling the callback', ->
-          spy.should.not.have.been.called
+        it 'calls the given callbacks with the server data', ->
+          expect(spy.calledWith('result')).to.be.true
 
-      describe 'the request is already in progress', ->
+        it 'removes the callbacks from the callback cache', ->
+          expect(ajax_loader.cb_cache.get(url)).to.be.undefined
 
-        beforeEach ->
-          ajax_loader.cache.cache[url] = [spy]
+        it 'does not store the data in the data cache', ->
+          expect(ajax_loader.data_cache.get(url)).to.be.undefined
 
-        it 'adds the callback to the callback array', ->
-          ajax_loader.cache.get(url).should.have.length 1
-          ajax_loader.cache.get(url)[0].should.equal spy
+        it "fires the 'loading' event", ->
+          expect(modularity.fire_global_event.calledWith('AJAX_LOADED')).to.be.true
 
-        it 'returns without calling the callback', ->
-          spy.should.not.have.been.called
 
-        it 'does not make another ajax request', ->
-          jQuery.get.should.not.have.been.called
+    describe 'the data has already been loaded', ->
 
-      describe 'ajax request successful', ->
+      it 'calls the callback with the cached data', ->
+        ajax_loader.data_cache.add url, "my data"
 
-        beforeEach ->
-          jquery_callback = null
-          jQuery.get = (url, callback) -> jquery_callback = callback
-          ajax_loader.get url, spy
-          jquery_callback('result')
+        ajax_loader.get(url, spy)
 
-        it 'calls the given callbacks with the server data', ->
-          expect(spy.calledWith "result").to.be.true
+        expect(spy).to.have.been.called
+        expect(spy.calledWith('my data')).to.be.true
 
-        it 'replaces the cache callbacks with returned data', ->
-          expect(ajax_loader.cache.get(url)).to.be.undefined
+      it "does not fire the 'loading' event", ->
+        expect(modularity.fire_global_event).to.not.have.been.called
 

data/demo/spec/javascripts/data/persistence_manager_spec.coffee

@@ -4,7 +4,7 @@
 
 
 describe 'PersistenceManager', ->
-  
+
   # Global variables for testing.
   persistence_manager = null
   entry_1 = {id: 1, value: 'one'}
@@ -46,7 +46,7 @@ describe 'PersistenceManager', ->
 
     beforeEach ->
       sinon.stub(jQuery, 'ajax').yieldsTo('success', entry_2)
-      
+
     afterEach ->
       jQuery.ajax.restore()
 
@@ -109,33 +109,6 @@ describe 'PersistenceManager', ->
       persistence_manager.entry_url(entry_1).should.equal '/users/1.json'
 
 
-  describe 'load_all', ->
-
-    loading_done_callback = null
-    beforeEach ->
-      sinon.stub(jQuery, 'ajax').yieldsTo('success', [entry_1, entry_2])
-      loading_done_callback = sinon.spy()
-      persistence_manager.load_all loading_done_callback, {'q': 'foo'},
-
-    afterEach ->
-      jQuery.ajax.restore()
-      
-    it 'makes a request to the INDEX action of the server', ->
-      jQuery.ajax.should.have.been.calledOnce
-      jQuery.ajax.args[0][0].url.should.equal '/users.json'
-
-    it 'provides the given data as parameters to the request', ->
-      jQuery.ajax.args[0][0].data.should.eql {'q': 'foo'}
-
-    it 'fills the server cache with the response data', ->
-      persistence_manager.server_data.length().should.eql 2
-      persistence_manager.server_data.get(1).should.eql entry_1
-      persistence_manager.server_data.get(2).should.eql entry_2
-
-    it 'calls the given callback method when the data is available', ->
-      loading_done_callback.should.have.been.calledOnce
-
-
   describe 'load', ->
 
     describe 'entry exists in client data cache', ->
@@ -171,7 +144,7 @@ describe 'PersistenceManager', ->
 
 
     describe "entry doesn't exist on the client at all", ->
-      
+
       beforeEach ->
         sinon.stub(jQuery, 'ajax').yieldsTo('success', entry_1)
 
@@ -203,6 +176,49 @@ describe 'PersistenceManager', ->
           done()
 
 
+  describe 'load_all', ->
+
+    loading_done_callback = null
+    beforeEach ->
+      sinon.stub(jQuery, 'ajax').yieldsTo('success', [entry_1, entry_2])
+      loading_done_callback = sinon.spy()
+      persistence_manager.load_all loading_done_callback, {'q': 'foo'},
+
+    afterEach ->
+      jQuery.ajax.restore()
+
+    it 'makes a request to the INDEX action of the server', ->
+      jQuery.ajax.should.have.been.calledOnce
+      jQuery.ajax.args[0][0].url.should.equal '/users.json'
+
+    it 'provides the given data as parameters to the request', ->
+      jQuery.ajax.args[0][0].data.should.eql {'q': 'foo'}
+
+    it 'fills the server cache with the response data', ->
+      persistence_manager.server_data.length().should.eql 2
+      persistence_manager.server_data.get(1).should.eql entry_1
+      persistence_manager.server_data.get(2).should.eql entry_2
+
+    it 'calls the given callback method when the data is available', ->
+      loading_done_callback.should.have.been.calledOnce
+
+
+  describe 'load_many', ->
+
+    describe 'all snippets in cache', ->
+      it 'returns an array of all requested snippets', ->
+        persistence_manager.add_all [{id: 1}, {id: 2}, {id: 3}]
+        persistence_manager.load_many [1,2], (snippets) ->
+          expect(snippets).to.have.length 2
+          expect(snippets[0].id).to.equal 1
+          expect(snippets[1].id).to.equal 2
+
+
+    describe 'some snippets are not cached', ->
+
+      it 'loads the missing snippets from the server'
+
+
   describe 'save', ->
 
     describe 'for unsaved objects', ->
@@ -224,7 +240,7 @@ describe 'PersistenceManager', ->
       sinon.stub(jQuery, 'ajax').yieldsTo('success', entry_2)
       server_entry = {id: 1, title: 'server title', desc: 'server desc'}
       persistence_manager.server_data.add server_entry
-      
+
     afterEach ->
       jQuery.ajax.restore()
 

data/lib/modularity-rails/version.rb

@@ -1,3 +1,3 @@
 module ModularityRails
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
 end

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

@@ -11,30 +11,67 @@
 class window.modularity.AjaxLoader
 
   constructor: (params = {}) ->
-    @cache = new modularity.Cache()
+
+    # Caches the callbacks.
+    @cb_cache = new modularity.Cache()
 
     # Whether to perform caching of data.
     # Default: no.
-    @caching = params.caching
+    @caching = !!params.caching
+
+    # Caches the data loaded.
+    @data_cache = new modularity.Cache()
+
+    # The number of currently running loading operations.
+    @loader_count = 0
+
 
+  # The different events that this class can fire.
+  @events =
+    AJAX_LOADING: 'AJAX_LOADING'
+    AJAX_LOADED: 'AJAX_LOADED'
 
+
+  # Loads the data from the given URL asynchronously.
   get: (url, callback) ->
-    cached_value = @cache.get url
-
-    # New request --> start GET call, store callback.
-    unless cached_value?
-      @cache.add url, [callback]
-      return jQuery.get url, (data) =>
-        cb(data) for cb in @cache.get(url)
-        if @caching
-          @cache.add url, data
-        else
-          @cache.remove url
-
-    # Request while the GET call is still pending --> 
+
+    # Return immediately if we have cached data.
+    if @caching
+      cached_data = @data_cache.get url
+      return callback(cached_data) if cached_data?
+
+    # Here, we have no cached data. Check
+
+    # If a GET call to this URL is already in progress -->
     # add the given callback to the list of waiting callbacks.
-    if cached_value.constructor is Array
-      return cached_value.push callback
+    request_in_progress = @cb_cache.get url
+    return request_in_progress.push(callback) if request_in_progress?
+
+    # Here, no request is currently in progress --> start a new one.
+
+    # Add callback to callback list.
+    @cb_cache.add url, [callback]
+
+    # Fire 'loading' event if this is the start of a loading operation.
+    @loader_count++
+    if @loader_count == 1
+      window.modularity.fire_global_event window.modularity.AjaxLoader.events.AJAX_LOADING
+
+    # Perform the request.
+    jQuery.get url, (data) =>
+
+      # Add result to cache.
+      if @caching
+        @data_cache.add url, data
+
+      # Call callbacks.
+      cb(data) for cb in @cb_cache.get url
+
+      # Remove request from callback list.
+      @cb_cache.remove url
+
+      # Fire 'loaded' event.
+      @loader_count--
+      if @loader_count == 0
+        window.modularity.fire_global_event window.modularity.AjaxLoader.events.AJAX_LOADED
 
-    # There is a cached response for this request --> answer the request immediately.
-    callback(cached_value)

data/vendor/assets/javascripts/modularity/data/persistence_manager.coffee

@@ -6,18 +6,18 @@
 class modularity.PersistenceManager
 
   constructor: (params) ->
-    
+
     # Copy of the data as it is on the server.
     @server_data = new modularity.IndexedCache 'id'
-    
+
     # Copy of the data as it is on the client.
     @client_data = new modularity.IndexedCache 'id'
-    
+
     # The base url on the server. Expected to be a fully RESTful API.
     @base_url = params.url
 
     @key = params.key or 'id'
-  
+
     # For handling parallel requests to the server.
     @loader = new modularity.AjaxLoader { cache: no }
 
@@ -34,25 +34,23 @@ class modularity.PersistenceManager
 
   # Creates the given object on the server.
   create: (obj, callback) ->
-    jQuery.ajax {
+    jQuery.ajax
       url: @collection_url()
       type: 'POST'
       data: obj
       success: (server_obj) =>
         @server_data.add server_obj
         callback server_obj
-    }
 
 
   delete: (obj, callback) ->
     @client_data.remove obj
     @server_data.remove obj
-    jQuery.ajax {
+    jQuery.ajax
       url: @entry_url(obj)
       type: 'DELETE'
       success: ->
         callback() if callback?
-    }
 
 
   # Returns the url to access a single entry.
@@ -60,19 +58,29 @@ class modularity.PersistenceManager
     "#{@base_url}/#{entry[@key]}.json"
 
 
-  # Returns the entry with the given key.
-  load: (key, callback) ->
-    
+  # Returns the cached data object, or undefined.
+  get_cached: (key) ->
+
     # Try to use client_data cache.
     client_obj = @client_data.get key
-    return callback(client_obj) if client_obj
-    
+    return client_obj if client_obj
+
     # No data in client cache --> try to use server cache.
     server_obj = @server_data.get key
     if server_obj
       client_obj = modularity.clone_hash server_obj
       @client_data.add client_obj
-      return callback client_obj
+      return client_obj
+
+    # Object not found in client or server cache.
+    return undefined
+
+
+  # Returns the entry with the given key.
+  load: (key, callback) ->
+
+    # Try to load from cache.
+    return callback(snippet) if snippet = @get_cached key
 
     # No data on client at all --> load data from server.
     @loader.get "#{@base_url}/#{key}", (server_entry) =>
@@ -85,16 +93,32 @@ class modularity.PersistenceManager
   # Loads all objects from the server.
   # Provides the given params as parameters to the GET request.
   load_all: (callback, params) ->
-    jQuery.ajax {
+    jQuery.ajax
       url: @collection_url()
       cache: no
       data: params
       success: (data) =>
         @server_data.add_all data
         callback()
-    }
 
- 
+
+  # Loads all snippets with the given ids.
+  load_many: (ids, callback) ->
+    missing_ids = []
+    snippets = []
+    $.each ids, (pos, id) =>
+      snippet = @get_cached id
+      if snippet
+        snippets.push snippet
+      else
+        missing_ids.push id
+
+    if missing_ids.length == 0
+      return callback(snippets)
+
+    alert "uncached snippets found: #{missing_ids}"
+
+
   # Saves the given object.
   # Does the right thing (create or update) dependent on
   # whether the object already has a key parameter.
@@ -109,24 +133,23 @@ class modularity.PersistenceManager
   # The given object must exist on the server already,
   # and have a proper value in the key attribute.
   update: (obj, callback) ->
-    
+
     # Create a new hash, containing only the changed attributes between obj and it's replica in @server_data.
     diff_obj = modularity.object_diff @server_data.get(obj[@key]), obj
     return if modularity.object_length(diff_obj) == 0
-    
+
     # Add key attribute.
     diff_obj[@key] = obj[@key]
-    
+
     # Update server_data version.
     @server_data.add obj
 
     # Send to server
-    jQuery.ajax {
+    jQuery.ajax
       url: @entry_url(obj)
       type: 'PUT'
       data: diff_obj
       success: (server_obj) =>
         @server_data.add server_obj
         callback server_obj if callback
-    }
 

metadata

@@ -1,96 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: modularity-rails
 version: !ruby/object:Gem::Version
-  version: 0.14.0
   prerelease: 
+  version: 0.15.0
 platform: ruby
 authors:
 - Kevin Goslar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2012-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
+    none: false
+  name: rails
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: capybara-webkit
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: capybara-webkit
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: evergreen
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: evergreen
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: rb-fsevent
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-livereload
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: guard-livereload
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 description: Description of ModularityRails.
 email:
 - kevin.goslar@gmail.com
@@ -192,20 +192,20 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Summary of ModularityRails.