modularity-rails 0.8.1 → 0.9.0

data/.travis.yml

@@ -3,6 +3,8 @@ before_script:
   - "sh -e /etc/init.d/xvfb start"
 language: ruby
 rvm:
+  - 1.8.7
+  - 1.9.2
   - 1.9.3
 script: bundle exec evergreen run
 

data/lib/modularity-rails/version.rb

@@ -1,3 +1,3 @@
 module ModularityRails
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/spec/javascripts/mixins/closable_spec.coffee

@@ -7,8 +7,8 @@ describe 'test environment setup', ->
     loadCS "/vendor/assets/javascripts/mixins/closable.coffee"
 
     # A standard closable module.
-    class window.ClosableModule1 extends Module
-      @mixin closable
+    class window.ClosableModule1 extends modularity.Module
+      @mixin modularity.closable
 
 
 describe 'Closable', ->
@@ -37,8 +37,8 @@ describe 'Closable', ->
     it "calls the closable_closing hook on the object if it exists", ->
 
       # A closable module with the 'closing' hook.
-      class ClosableModule extends Module
-        @mixin closable
+      class ClosableModule extends modularity.Module
+        @mixin modularity.closable
 
         constructor: ->
           super
@@ -55,8 +55,8 @@ describe 'Closable', ->
     it "calls the closable_closed hook on the object if it exists", ->
 
       # A closable module with the 'closed' hook.
-      class ClosableModule extends Module
-        @mixin closable
+      class ClosableModule extends modularity.Module
+        @mixin modularity.closable
 
         constructor: ->
           super
@@ -72,8 +72,8 @@ describe 'Closable', ->
 
     it "aborts the close operation if the closable_closing method returns false", ->
 
-      class ClosableModuleWithHookThatReturnsFalse extends Module
-        @mixin closable
+      class ClosableModuleWithHookThatReturnsFalse extends modularity.Module
+        @mixin modularity.closable
         closable_closing: -> false
 
       module = new ClosableModuleWithHookThatReturnsFalse('#test #closable1')

data/spec/javascripts/modularity_spec.coffee

@@ -7,7 +7,7 @@ describe 'setting up test environment', ->
 
   it 'defining test classes', ->
 
-    class window.TestModule extends Module
+    class window.TestModule extends modularity.Module
       constructor: (container) ->
         super
 
@@ -22,7 +22,7 @@ describe 'modularity', ->
       spyOn window, 'alert'
 
     it "is defined on the 'window' object", ->
-      expect(window.Module).not.toBeUndefined()
+      expect(modularity.Module).not.toBeUndefined()
 
     it 'shows an error if no container is given', ->
       new TestModule()
@@ -55,34 +55,34 @@ describe 'modularity', ->
       spyOn window, 'alert'
 
     it 'shows an alert with the given message if the given condition is false', ->
-      Module.assert false, 'Message'
+      modularity.assert false, 'Message'
       expect(alert).toHaveBeenCalledWith("Message")
 
     it 'fails when the condition is null', ->
-      Module.assert null, 'Message'
+      modularity.assert null, 'Message'
       expect(alert).toHaveBeenCalledWith("Message")
 
     it 'fails when the condition is undefined', ->
-      Module.assert undefined, 'Message'
+      modularity.assert undefined, 'Message'
       expect(alert).toHaveBeenCalledWith("Message")
 
     it 'fails when the condition is an empty array', ->
-      Module.assert [], 'Message'
+      modularity.assert [], 'Message'
       expect(alert).toHaveBeenCalledWith("Message")
 
     it 'fails when the condition is an empty string', ->
-      Module.assert '', 'Message'
+      modularity.assert '', 'Message'
       expect(alert).toHaveBeenCalledWith("Message")
 
     it 'passes when the condition is a string', ->
-      Module.assert '123', 'Message'
+      modularity.assert '123', 'Message'
       expect(alert).not.toHaveBeenCalled()
 
     it "returns false if the condition doesn't pass", ->
-      expect(Module.assert(false)).toBeFalsy()
+      expect(modularity.assert(false)).toBeFalsy()
 
     it "returns true if the condition passes", ->
-      expect(Module.assert('123')).toBeTruthy()
+      expect(modularity.assert('123')).toBeTruthy()
 
 
   describe 'jQuery Integration', ->
@@ -95,7 +95,7 @@ describe 'modularity', ->
       expect(alert).not.toHaveBeenCalled()
 
     it 'returns the created instance', ->
-      result = $('#test #module_container').module(Module)
+      result = $('#test #module_container').module(modularity.Module)
       expect(result).toBeDefined()
       expect(typeof result).toEqual('object')
 
@@ -104,7 +104,7 @@ describe 'modularity', ->
       expect(alert).toHaveBeenCalled()
 
     it 'returns an error if the jQuery object is empty.', ->
-      $('#test #zonk').module(Module)
+      $('#test #zonk').module(modularity.Module)
       expect(alert).toHaveBeenCalled()
 
 
@@ -195,7 +195,7 @@ describe 'modularity', ->
 
       beforeEach ->
         mockGlobalContainer = $('#test #module_container')
-        spyOn(Module, 'global_event_container').andReturn(mockGlobalContainer)
+        spyOn(modularity, 'global_event_container').andReturn(mockGlobalContainer)
 
       describe 'bind_global_event', ->
 
@@ -204,31 +204,31 @@ describe 'modularity', ->
 
         it 'binds the given event type and callback method to the global event container', ->
           callback = ->
-          Module.bind_global_event '123', callback
+          modularity.bind_global_event '123', callback
           expect(mockGlobalContainer.bind).toHaveBeenCalledWith('123', callback)
 
         it "throws an error if no parameters are given", ->
-          Module.bind_global_event()
+          modularity.bind_global_event()
           expect(window.alert).toHaveBeenCalled()
           expect(mockGlobalContainer.bind).not.toHaveBeenCalled()
 
         it "throws an error if the given event type doesn't exist", ->
-          Module.bind_global_event undefined, ->
+          modularity.bind_global_event undefined, ->
           expect(window.alert).toHaveBeenCalled()
           expect(mockGlobalContainer.bind).not.toHaveBeenCalled()
 
         it 'throws an error if the given event type is not a string', ->
-          Module.bind_global_event {}, ->
+          modularity.bind_global_event {}, ->
           expect(window.alert).toHaveBeenCalled()
           expect(mockGlobalContainer.bind).not.toHaveBeenCalled()
 
         it "throws an error if the given callback doesn't exist", ->
-          Module.bind_global_event '123'
+          modularity.bind_global_event '123'
           expect(window.alert).toHaveBeenCalled()
           expect(mockGlobalContainer.bind).not.toHaveBeenCalled()
 
         it 'throws an error if the given callback is not a function', ->
-          Module.bind_global_event '123', {}
+          modularity.bind_global_event '123', {}
           expect(window.alert).toHaveBeenCalled()
           expect(mockGlobalContainer.bind).not.toHaveBeenCalled()
 
@@ -239,30 +239,31 @@ describe 'modularity', ->
           spyOn mockGlobalContainer, 'trigger'
 
         it 'triggers a custom jQuery event with the given event type on the global event container object', ->
-          Module.fire_global_event 'event type', 'event data'
+          modularity.fire_global_event 'event type', 'event data'
           expect(mockGlobalContainer.trigger).toHaveBeenCalledWith('event type', 'event data')
 
         describe 'when no payload is given', ->
           it 'provides an empty object as payload', ->
-            Module.fire_global_event 'event type'
+            modularity.fire_global_event 'event type'
             expect(mockGlobalContainer.trigger).toHaveBeenCalled()
             expect(mockGlobalContainer.trigger.argsForCall[0][1]).toEqual({})
 
           it "doesn't change the original payload variable", ->
             data = undefined
-            Module.fire_global_event 'event type', data
+            modularity.fire_global_event 'event type', data
             expect(data).toBeUndefined
 
         it 'provides 0 as payload if 0 is given', ->
-          Module.fire_global_event 'event type', 0
+          modularity.fire_global_event 'event type', 0
           expect(mockGlobalContainer.trigger).toHaveBeenCalled()
           expect(mockGlobalContainer.trigger.argsForCall[0][1]).toEqual(0)
 
         it 'throws an error if the given event type is not a string', ->
-          Module.fire_global_event {}
+          modularity.fire_global_event {}
           expect(mockGlobalContainer.trigger).not.toHaveBeenCalled()
           expect(window.alert).toHaveBeenCalled()
 
+
   describe 'mixins', ->
 
     myMixin = instance = recordedSelf = Test = null
@@ -272,7 +273,7 @@ describe 'modularity', ->
       method2: ->
 
     beforeEach ->
-      class Test extends Module
+      class Test extends modularity.Module
         @mixin myMixin
 
 

data/spec/javascripts/modules/button_spec.coffee

@@ -14,7 +14,7 @@ describe 'Button', ->
   describe 'manual clicks', ->
 
     it 'fires when clicking on the container directly', ->
-      button = new window.Button($('#test #button1'))
+      button = new modularity.Button($('#test #button1'))
       button.bind_event('clicked', (spy = jasmine.createSpy()))
 
       button.container.click()
@@ -24,7 +24,7 @@ describe 'Button', ->
 
 
     it 'fires when clicking embedded elements of the button', ->
-      button = new window.Button($('#test #button2'))
+      button = new modularity.Button($('#test #button2'))
       button.bind_event('clicked', (spy = jasmine.createSpy()))
 
       button.container.find('.embedded').click()
@@ -36,7 +36,7 @@ describe 'Button', ->
   describe 'programmatic clicks', ->
 
     it 'programmatically clicks the button', ->
-      button = new window.Button($('#test #button2'))
+      button = new modularity.Button($('#test #button2'))
       spy = jasmine.createSpy()
       button.bind_event('clicked', spy)
 

data/spec/javascripts/modules/counter_button_spec.coffee

@@ -17,7 +17,7 @@ describe 'CounterButton', ->
     describe 'manual clicks', ->
 
       it 'fires when clicking on the container directly', ->
-        button = new window.CounterButton('#test #button1')
+        button = new modularity.CounterButton('#test #button1')
         button.bind_event('clicked', (spy = jasmine.createSpy()))
 
         button.container.click()
@@ -27,7 +27,7 @@ describe 'CounterButton', ->
 
 
       it 'fires when clicking embedded elements of the button', ->
-        button = new window.CounterButton('#test #button2')
+        button = new modularity.CounterButton('#test #button2')
         button.bind_event('clicked', (spy = jasmine.createSpy()))
 
         button.container.find('.embedded').click()
@@ -38,7 +38,7 @@ describe 'CounterButton', ->
     describe 'programmatic clicks', ->
 
       it 'programmatically clicks the button', ->
-        button = new window.CounterButton('#test #button2')
+        button = new modularity.CounterButton('#test #button2')
         spy = jasmine.createSpy()
         button.bind_event('clicked', spy)
 
@@ -49,7 +49,7 @@ describe 'CounterButton', ->
   describe 'CounterButton specific functionality', ->
 
     it 'provides the click counter as the event payload', ->
-      button = new window.CounterButton('#test #button1')
+      button = new modularity.CounterButton('#test #button1')
       button.bind_event('clicked', (spy = jasmine.createSpy()))
 
       button.container.click()

data/spec/javascripts/tools/ajax_loader_spec.coffee

@@ -1,30 +1,31 @@
-#= require spec_helper
-
 describe 'test environment setup', ->
 
   it 'loading libraries', ->
     load_modularity()
+    loadCS "/vendor/assets/javascripts/tools/cache.coffee"
     loadCS "/vendor/assets/javascripts/tools/ajax_loader.coffee"
 
 
 describe 'ajax_loader', ->
   
+  ajax_loader = null
+  beforeEach ->
+    ajax_loader = new modularity.AjaxLoader()
+
   describe 'get', ->
+
+    url = "/users/4"
     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"
+        ajax_loader.cache.add url, "my data"
 
-        Module.loader.cache[url] = "my data"
-        Module.loader.get(url, spy)
+        ajax_loader.get(url, spy)
 
         expect(spy).toHaveBeenCalled()
         expect(spy.argsForCall[0][0]).toEqual("my data")
@@ -33,13 +34,12 @@ describe 'ajax_loader', ->
     describe 'the request is already in progress', ->
 
       beforeEach ->
-        Module.loader.cache[url] = []
-        Module.loader.get(url, spy)
+        ajax_loader.cache.cache[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)
+        expect(ajax_loader.cache.get(url).length).toEqual(1)
+        expect(ajax_loader.cache.get(url)[0]).toEqual(spy)
 
 
       it 'returns without calling the callback', ->
@@ -54,15 +54,15 @@ describe 'ajax_loader', ->
     describe 'first time request', ->
       
       beforeEach ->
-        Module.loader.get(url, spy)
+        ajax_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)
+        expect(ajax_loader.cache.get(url).length).toEqual(1)
+        expect(ajax_loader.cache.get(url)[0]).toEqual(spy)
 
       it 'returns without calling the callback', ->
         expect(spy).not.toHaveBeenCalled()
@@ -74,7 +74,7 @@ describe 'ajax_loader', ->
       beforeEach ->
         jquery_callback = null
         jQuery.get = (url, callback) -> jquery_callback = callback
-        Module.loader.get url, spy
+        ajax_loader.get url, spy
         jquery_callback('result')
 
       it 'calls the given callbacks', ->
@@ -82,4 +82,4 @@ describe 'ajax_loader', ->
         expect(spy.argsForCall[0][0]).toEqual('result')
 
       it 'replaces the cache callbacks with returned data', ->
-        expect(Module.loader.cache[url]).toEqual('result')
+        expect(ajax_loader.cache.get(url)).toEqual('result')

data/spec/javascripts/tools/cache_spec.coffee

@@ -11,7 +11,7 @@ describe 'Cache', ->
   
   cache = null
   beforeEach ->
-    cache = new window.Cache()
+    cache = new modularity.Cache()
 
 
   describe 'constructor', ->

data/vendor/assets/javascripts/mixins/clickable.coffee

@@ -1,6 +1,6 @@
 # This mixin adds a 'clickable' aspect to modules.
 # This means clicking anywhere on the module fires the 'clicked' event.
-window.clickable =
+window.modularity.clickable =
 
   constructor: ->
     @container.click @container_clicked
@@ -17,5 +17,5 @@ window.clickable =
 
 
   # Event handler for clicks on this clickable element. 
-  container_clicked: -> @fire_event clickable.events.clicked
+  container_clicked: -> @fire_event modularity.clickable.events.clicked
 

data/vendor/assets/javascripts/mixins/closable.coffee

@@ -1,4 +1,4 @@
-window.closable =
+window.modularity.closable =
 
   constructor: (container) ->
     close_button = @container.find('.CloseButton')

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

@@ -5,7 +5,35 @@
 # Please see https://github.com/kevgo/modularity for more information.
 
 
-window.modularity or= {}
+window.modularity = {
+
+  # Checks whether the given condition is true.
+  # Shows an alert with the given message if not.
+  assert: (condition, message) ->
+    condition_ok = condition?.length > 0
+    alert(message) unless condition_ok
+    condition_ok
+
+
+  # GLOBAL EVENTS.
+
+  # Subscribes to the given global event,
+  # i.e. calls the given function when the given global event type happens.
+  bind_global_event: (event_type, callback) ->
+    return unless modularity.assert event_type, "modularity.bind_global_event: parameter 'event_type' is empty"
+    return alert "modularity.bind_global_event: parameter 'callback' must be a function, #{callback} (#{typeof callback}) given." unless typeof callback == 'function'
+    modularity.global_event_container().bind event_type, callback
+
+  # Fires the given global event with the given data payload.
+  fire_global_event: (event_type, data) ->
+    modularity.assert event_type, 'Module.fire_global_event: You must provide the event type to fire.'
+    return alert("Module.fire_global_event: Event type must be a string, #{event_type} (#{typeof event_type}) given.") unless typeof event_type == 'string'
+    modularity.global_event_container().trigger event_type, data ?= []
+
+  # Returns the DOM object that is used to fire global events on.
+  global_event_container: -> modularity.global_event_container_cache or= $(window)
+}
+
 
 class window.modularity.Module
 
@@ -34,24 +62,17 @@ class window.modularity.Module
         mixin_data.mixin.constructor.apply @, arguments
 
 
-  # Checks whether the given condition is true.
-  # Shows an alert with the given message if not.
-  @assert: (condition, message) ->
-    condition_ok = condition?.length > 0
-    alert(message) unless condition_ok
-    condition_ok
-
   # MODULE EVENTS.
 
   # Calls the given function when this widget fires the given local event.
   bind_event: (event_type, callback) =>
-    return unless Module.assert event_type, "Module.bind_event: parameter 'event_type' is empty"
+    return unless modularity.assert event_type, "Module.bind_event: parameter 'event_type' is empty"
     return alert "Module.bind_event: parameter 'callback' must be a function, #{callback} (#{typeof callback}) given." unless typeof callback == 'function'
     @container.bind event_type, callback
 
   # Fires the given local event with the given data payload.
   fire_event: (event_type, data) =>
-    Module.assert event_type, 'Module.fire_event: You must provide the event type to fire.'
+    modularity.assert event_type, 'Module.fire_event: You must provide the event type to fire.'
     return alert("Module.fire_event: Event type must be a string, #{event_type} (#{typeof event_type}) given.") unless typeof event_type == 'string'
     @container.trigger event_type, data ?= {}
 
@@ -63,25 +84,6 @@ class window.modularity.Module
     @prototype.mixins.push({mixin: mixin, params: p})
 
 
-  # GLOBAL EVENTS.
-
-  # Subscribes to the given global event, 
-  # i.e. calls the given function when the given global event type happens.
-  @bind_global_event: (event_type, callback) =>
-    return unless @assert event_type, "Module.bind_global_event: parameter 'event_type' is empty"
-    return alert "Module.bind_global_event: parameter 'callback' must be a function, #{callback} (#{typeof callback}) given." unless typeof callback == 'function'
-    @global_event_container().bind event_type, callback
-
-  # Fires the given global event with the given data payload.
-  @fire_global_event: (event_type, data) =>
-    @assert event_type, 'Module.fire_global_event: You must provide the event type to fire.'
-    return alert("Module.fire_global_event: Event type must be a string, #{event_type} (#{typeof event_type}) given.") unless typeof event_type == 'string'
-    @global_event_container().trigger event_type, data ?= []
-
-  # Returns the DOM object that is used to fire global events on.
-  @global_event_container: => @global_event_container_cache or= $(window)
-
-
 # jQuery integration for creating Modules.
 #
 # Call like this: myModule = $('...').module(MyModuleClass)

data/vendor/assets/javascripts/modules/button.coffee

@@ -3,6 +3,6 @@
 # A button module.
 # Responds to clicks on the container element.
 # The container element is expected to already be populated.
-class window.modularity.Button extends Module
-  @mixin clickable
+class window.modularity.Button extends window.modularity.Module
+  @mixin window.modularity.clickable
 

data/vendor/assets/javascripts/modules/counter_button.coffee

@@ -1,7 +1,7 @@
 # A button that counts how often it is clicked.
 # This is implemented as a subclass of Button, 
 # to take advantage of the already existing functionality there.
-class window.modularity.CounterButton extends Button
+class window.modularity.CounterButton extends modularity.Button
 
   constructor: ->
     super

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

@@ -1,3 +1,6 @@
+#= require tools/cache
+
+
 # A generic ajax loader for parallel GET requests.
 # Prevents duplicate requests, caches the responses
 # to answer subsequent requests immediately
@@ -5,24 +8,26 @@
 #
 # Warning: Caches the responses, so once a request is cached,
 #          any new content on the same URL will not be visible!
-Module.loader =
+class modularity.AjaxLoader
+
+  constructor: ->
+    @cache = new modularity.Cache()
 
-  cache: {}
 
   get: (url, callback) ->
-    cache = Module.loader.cache[url]
+    cached_value = @cache.get 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
+    unless cached_value?
+      @cache.add url, [callback]
+      return jQuery.get url, (data) =>
+        cb(data) for cb in @cache.get(url)
+        @cache.add 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
+    if cached_value.constructor is Array
+      return cached_value.push callback
 
     # There is a cached response for this request --> answer the request immediately.
-    callback(cache)
+    callback(cached_value)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modularity-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-10 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70325015499260 !ruby/object:Gem::Requirement
+  requirement: &70160283637480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70325015499260
+  version_requirements: *70160283637480
 - !ruby/object:Gem::Dependency
   name: capybara-webkit
-  requirement: &70325015480180 !ruby/object:Gem::Requirement
+  requirement: &70160283637020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70325015480180
+  version_requirements: *70160283637020
 - !ruby/object:Gem::Dependency
   name: evergreen
-  requirement: &70325015479500 !ruby/object:Gem::Requirement
+  requirement: &70160283636560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70325015479500
+  version_requirements: *70160283636560
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70325015478760 !ruby/object:Gem::Requirement
+  requirement: &70160283635920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70325015478760
+  version_requirements: *70160283635920
 - !ruby/object:Gem::Dependency
   name: guard-livereload
-  requirement: &70325015478160 !ruby/object:Gem::Requirement
+  requirement: &70160283635300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70325015478160
+  version_requirements: *70160283635300
 description: Description of ModularityRails.
 email:
 - kevin.goslar@gmail.com
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Summary of ModularityRails.