modularity-rails 0.12.3 → 0.14.0

data/README.md

@@ -1,13 +1,11 @@
-# Modularity::Rails [![Build Status](https://secure.travis-ci.org/kevgo/modularity-rails.png)](http://travis-ci.org/#!/kevgo/modularity-rails)
+# Modularity::Rails [![Build Status](https://secure.travis-ci.org/kevgo/modularity-rails.png)](http://travis-ci.org/#!/kevgo/modularity-rails) <a href="https://codeclimate.com/github/kevgo/modularity-rails" target="_blank"><img src="https://codeclimate.com/badge.png" /></a>
 
-A lightweight, modular, object and component oriented frontend framework for Rails applications.
+Makes the [Modularity CoffeeScript](http://github.com/kevgo/modularity-coffeescript) library and related modules available to
+Rails 3.1 applications.
 
-Makes the [Modularity CoffeeScript](http://github.com/kevgo/modularity-coffeescript) library available to 
-Rails 3.1 applications. 
-
-Modularity is a pattern and framework for lightweight object-oriented JavaScript 
-that allows to compose functionally rich web pages in a clean and testable way 
-out of well structured and reusable components.
+Modularity is a framework for lightweight component-oriented CoffeeScript.
+It allows to compose functionally rich web pages in a clean, intuitive, and testable way
+out of well structured and reusable components. It scales very well with complexity.
 
 
 ## Authors
@@ -17,7 +15,7 @@ out of well structured and reusable components.
 
 # Installation
 
-Add this line to your application's Gemfile:
+Load modularity in your application's Gemfile:
                          
 ```ruby
 gem 'modularity-rails'

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

@@ -17,18 +17,6 @@ describe 'ajax_loader', ->
       loader = new modularity.AjaxLoader {caching: yes}
       loader.caching.should.be.true
 
-  describe 'ajax', ->
-
-    describe 'GET request', ->
-
-      it 'buffers the request'
-
-      it 'fires the events'
-
-      it ''
-
-    describe 'other requests'
-
 
   describe 'get', ->
     url = "/users/4"
@@ -54,8 +42,6 @@ describe 'ajax_loader', ->
         it 'returns without calling the callback', ->
           spy.should.not.have.been.called
 
-        it 'fires the LOADING event'
-
       describe 'the request is already in progress', ->
 
         beforeEach ->
@@ -74,8 +60,6 @@ describe 'ajax_loader', ->
         it 'does not make another ajax request', ->
           jQuery.get.should.not.have.been.called
 
-        it "doesn't fire the LOADING event again"
-
       describe 'ajax request successful', ->
 
         beforeEach ->
@@ -85,13 +69,11 @@ describe 'ajax_loader', ->
           jquery_callback('result')
 
         it 'calls the given callbacks with the server data', ->
-          spy.should.have.been.calledWith 'result'
+          expect(spy.calledWith('result')).to.be.true
 
         it 'replaces the cache callbacks with returned data', ->
           ajax_loader.cache.get(url).should.equal 'result'
 
-        it 'fires the LOADED event'
-
       describe 'the data has already been loaded', ->
 
         it 'calls the callback with the cached data', ->
@@ -100,9 +82,7 @@ describe 'ajax_loader', ->
           ajax_loader.get(url, spy)
 
           spy.should.have.been.called
-          spy.should.have.been.calledWith "my data"
-
-        it "doesn't fire any events"
+          expect(spy.calledWith('my data')).to.be.true
 
 
     describe 'with caching disabled', ->
@@ -149,7 +129,7 @@ describe 'ajax_loader', ->
           jquery_callback('result')
 
         it 'calls the given callbacks with the server data', ->
-          spy.should.have.been.calledWith 'result'
+          expect(spy.calledWith "result").to.be.true
 
         it 'replaces the cache callbacks with returned data', ->
           expect(ajax_loader.cache.get(url)).to.be.undefined

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

@@ -41,7 +41,6 @@ describe 'PersistenceManager', ->
       persistence_manager.add_all data
       spy.should.have.been.calledOnce
 
-
   describe 'create', ->
     new_obj = {value: 'foo'}
 
@@ -137,52 +136,6 @@ describe 'PersistenceManager', ->
       loading_done_callback.should.have.been.calledOnce
 
 
-  describe 'load_local', ->
-
-    describe 'entry exists in client data cache', ->
-      it 'returns the entry from the @client_data cache if it exists there', ->
-        persistence_manager.client_data.add entry_1
-        result = persistence_manager.load_local 1
-        result.should.equal entry_1
-
-    describe 'entry exists in server data cache', ->
-
-      beforeEach ->
-        persistence_manager.server_data.add entry_1
-
-      it 'adds the entry to the client data cache', ->
-        persistence_manager.load_local 1
-        persistence_manager.client_data.length().should.equal 1
-        persistence_manager.client_data.get(1).should.eql entry_1
-
-      it 'returns the entry from the client data cache', ->
-        result = persistence_manager.load_local 1
-        client_cache_entry = persistence_manager.client_data.get 1
-        result.should.equal client_cache_entry
-
-      it 'returns a different hash than the server data, so that the user can make changes to it', ->
-        result = persistence_manager.load_local 1
-        server_cache_entry = persistence_manager.server_data.get 1
-        result.should.not.equal server_cache_entry
-
-    describe "entry doesn't exist in any cache", ->
-
-      it 'returns undefined', ->
-        expect(persistence_manager.load_local(1)).to.be.undefined
-
-
-  describe 'load_many', ->
-
-    describe 'all entries exists in the cache', ->
-      it 'returns the entries immediately', (done) ->
-        persistence_manager.add_all [entry_1, entry_2]
-        persistence_manager.load_many [1,2], (entries) ->
-          entries.length.should.equal 2
-          entries[0].should.eql entry_1
-          entries[1].should.eql entry_2
-          done()
-
-
   describe 'load', ->
 
     describe 'entry exists in client data cache', ->

data/demo/spec/javascripts/modularity_spec.coffee

@@ -48,23 +48,23 @@ describe 'modularity', ->
 
     it 'shows an alert with the given message if the given condition is false', ->
       modularity.assert false, 'Message'
-      window.alert.should.have.been.calledWith "Message"
+      expect(window.alert.calledWith "Message").to.be.true
 
     it 'fails when the condition is null', ->
       modularity.assert null, 'Message'
-      window.alert.should.have.been.calledWith "Message"
+      expect(window.alert.calledWith "Message").to.be.true
 
     it 'fails when the condition is undefined', ->
       modularity.assert undefined, 'Message'
-      window.alert.should.have.been.calledWith "Message"
+      expect(window.alert.calledWith "Message").to.be.true
 
     it 'fails when the condition is an empty array', ->
       modularity.assert [], 'Message'
-      window.alert.should.have.been.calledWith "Message"
+      expect(window.alert.calledWith "Message").to.be.true
 
     it 'fails when the condition is an empty string', ->
       modularity.assert '', 'Message'
-      window.alert.should.have.been.calledWith "Message"
+      expect(window.alert.calledWith "Message").to.be.true
 
     it 'passes when the condition is a string', ->
       modularity.assert '123', 'Message'
@@ -77,6 +77,15 @@ describe 'modularity', ->
       modularity.assert('123').should.be.true
 
 
+  describe '@$ notation', ->
+
+    it 'returns a new jQuery object relative to container', ->
+      module = new TestModule $ '#module_container'
+      insideObject = module.$ '.inside_module,.outside_module'
+      insideObject.length.should.equal 1
+      insideObject.hasClass('inside_module').should.be.true
+
+
   describe 'jQuery Integration', ->
 
     it 'works', ->
@@ -299,7 +308,7 @@ describe 'modularity', ->
       sinon.spy myMixin, 'method1'
       instance = new Test('testing')
       instance.method1("arg1", "arg2")
-      myMixin.method1.should.have.been.calledWith("arg1", "arg2")
+      expect(myMixin.method1.calledWith("arg1", "arg2")).to.be.true
       myMixin.method1.restore()
 
 

data/demo/spec/javascripts/spec_helper.coffee

@@ -3,7 +3,6 @@
 #= require sinon-chai
 #= require_tree ./templates
 
-window.chai.use window.sinonChai
 
 # Renders the template with the given path in the #konacha div.
 window.template = (path) ->

data/demo/spec/javascripts/templates/modularity.jst.ejs

@@ -1,3 +1,6 @@
-<div id="module_container"></div>
+<div id="module_container">
+  <div class="inside_module"></div>
+</div>
+<div class="outside_module"></div>
+<div class="double"></div>
 <div class="double"></div>
-<div class="double"></div>

data/lib/modularity-rails/version.rb

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

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

@@ -2,7 +2,8 @@
 #
 # Use UglifyJS (http://github.com/mishoo/UglifyJS) for compression.
 #
-# Please see https://github.com/kevgo/modularity for more information.
+# Please see https://github.com/kevgo/modularity for more information on Modularity,
+# and https://github.com/kevgo/modularity-rails for Rails integration.
 
 
 window.modularity = {
@@ -10,9 +11,10 @@ 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
+    if !condition or condition?.length == 0
+      alert message
+      return false
+    true
 
 
   # GLOBAL EVENTS.
@@ -20,7 +22,7 @@ window.modularity = {
   # 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 unless modularity.assert typeof event_type == 'string', "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
 
@@ -33,8 +35,8 @@ window.modularity = {
   # Returns the DOM object that is used to fire global events on.
   global_event_container: -> modularity.global_event_container_cache or= $(window)
 }
-modularity.bindGlobalEvent = modularity.bind_global_event
-modularity.fireGlobalEvent = modularity.fire_global_event
+window.modularity.bindGlobalEvent = window.modularity.bind_global_event
+window.modularity.fireGlobalEvent = window.modularity.fire_global_event
 
 
 class window.modularity.Module
@@ -54,7 +56,7 @@ class window.modularity.Module
     # Attach mixins.
     if @mixins?
       for mixin_data in @mixins
-        
+
         # Attach all properties from mixin to the prototype.
         for methodName, method of mixin_data.mixin
           do (methodName, method) => unless @[methodName]
@@ -64,11 +66,16 @@ class window.modularity.Module
         mixin_data.mixin?.constructor?.apply(@, arguments)
 
 
+  # Runs the given query within the container element.
+  $: (query) ->
+    @container.find query
+
+
   # MODULE EVENTS.
 
   # Calls the given function when this widget fires the given local event.
   bind_event: (event_type, callback) =>
-    return unless modularity.assert event_type, "Module.bind_event: parameter 'event_type' is empty"
+    return unless modularity.assert typeof event_type == 'string', "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
   bindEvent: Module::bind_event
@@ -80,6 +87,12 @@ class window.modularity.Module
     @container.trigger event_type, data ?= {}
   fireEvent: Module::fire_event
 
+
+  # Hides this module.
+  hide: ->
+    @container.hide()
+
+
   # mixin = constructor of Draggable
   # self = Card
   @mixin: (mixin, p...) ->
@@ -88,6 +101,11 @@ class window.modularity.Module
     @prototype.mixins.push({mixin: mixin, params: p})
 
 
+  # Shows this module.
+  show: ->
+    @container.show()
+
+
 # jQuery integration for creating Modules.
 #
 # Call like this: myModule = $('...').module(MyModuleClass)
@@ -103,7 +121,7 @@ jQuery.fn.module = (klass, args...) ->
 
   # Check parameters.
   if typeof klass != 'function'
-    return alert "ERROR!\n\nYou must provide the Module class when calling $.module().\n\nExample: $('...').module(MyModuleClass)\n\nYou provided: #{klass} (#{typeof klass})" 
+    return alert "ERROR!\n\nYou must provide the Module class when calling $.module().\n\nExample: $('...').module(MyModuleClass)\n\nYou provided: #{klass} (#{typeof klass})"
 
   # Instantiate the class and return the instance.
   new klass(this, args...)

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

@@ -18,18 +18,6 @@ class window.modularity.AjaxLoader
     @caching = params.caching
 
 
-  # The different events that this widget can fire.
-  @events =
-    AJAX_LOADING: 'AJAX_LOADING'       # Called when an AJAX request starts.
-    AJAX_LOADED: 'AJAX_LOADED'         # Called when an AJAX request finishes.
-
-
-  # Makes the given AJAX call.
-  # Buffers the call if it's a GET request.
-  # Fires the AJAX events.
-  ajax: (options) ->
-
-
   get: (url, callback) ->
     cached_value = @cache.get url
 

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

@@ -63,8 +63,16 @@ class modularity.PersistenceManager
   # Returns the entry with the given key.
   load: (key, callback) ->
     
-    entry = @load_local key
-    return callback(entry) if entry
+    # Try to use client_data cache.
+    client_obj = @client_data.get key
+    return callback(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
 
     # No data on client at all --> load data from server.
     @loader.get "#{@base_url}/#{key}", (server_entry) =>
@@ -86,38 +94,7 @@ class modularity.PersistenceManager
         callback()
     }
 
-
-  # Loads the entry synchronously from the cache.
-  # Doesn't fall back to the server.
-  load_local: (key) ->
-
-    # Try to use client_data cache.
-    client_obj = @client_data.get key
-    return client_obj if client_obj
-
-    # No data in client cache --> try to use server cache.
-    server_obj = @server_data.get key
-    return null unless server_obj
-    client_obj = modularity.clone_hash server_obj
-    @client_data.add client_obj
-    client_obj
  
-
-  # Returns all entries with the given keys.
-  load_many: (keys, callback) ->
-    result = []
-    missing_keys = []
-    for key in keys
-      do (key) =>
-        entry = @load_local key
-        if entry
-          result.push entry
-        else
-          missing_keys.push key
-    alert "modularity.PersistenceManager.load_many(): Missing functionality to load from the server." if missing_keys.length > 0
-    callback result
-
-
   # Saves the given object.
   # Does the right thing (create or update) dependent on
   # whether the object already has a key parameter.

data/vendor/assets/javascripts/modularity/tools/object_tools.coffee

@@ -1,8 +1,3 @@
-# Returns an object that contains only the attributes 
-# that are different between obj_1 and obj_2.
-# Only looks for changed attributes, not missing attributes.
-
-
 # Returns a replica of the given hash.
 # Don't use this method for real objects with superclasses, prototypes, and stuff.
 modularity.clone_hash = (obj) ->
@@ -11,6 +6,9 @@ modularity.clone_hash = (obj) ->
   result
 
 
+# Returns an object that contains only the attributes
+# that are different between obj_1 and obj_2.
+# Only looks for changed attributes, not missing attributes.
 modularity.object_diff = (obj_1, obj_2) ->
   result = {}
   for own key, value_2 of obj_2
@@ -20,7 +18,8 @@ modularity.object_diff = (obj_1, obj_2) ->
   result
 
 
+# Returns the number of attributes of the given object.
+# NOTE(KG): This doesn't work in IE8.
 modularity.object_length = (obj) ->
-  # NOTE(KG): This doesn't work in IE8.
   Object.keys(obj).length
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modularity-rails
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.14.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-02 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70181204940740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70181204940740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: capybara-webkit
-  requirement: &70181204936980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70181204936980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: evergreen
-  requirement: &70181204934000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70181204934000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70181204930600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70181204930600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-livereload
-  requirement: &70181204926320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70181204926320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Description of ModularityRails.
 email:
 - kevin.goslar@gmail.com
@@ -155,7 +180,6 @@ files:
 - vendor/assets/javascripts/modularity/data/persistence_manager.coffee
 - vendor/assets/javascripts/modularity/mixins/clickable.coffee
 - vendor/assets/javascripts/modularity/mixins/closable.coffee
-- vendor/assets/javascripts/modularity/modules/ajax_indicator.coffee
 - vendor/assets/javascripts/modularity/modules/autogrow_textarea.coffee
 - vendor/assets/javascripts/modularity/modules/button.coffee
 - vendor/assets/javascripts/modularity/modules/counter_button.coffee
@@ -181,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Summary of ModularityRails.

data/vendor/assets/javascripts/modularity/modules/ajax_indicator.coffee

@@ -1,24 +0,0 @@
-# Indicates that an AJAX request is running.
-class sn.AjaxIndicator extends modularity.Module
-
-  constructor: ->
-
-    # The number of currently running ajax requests.
-    @ajax_counter = 0
-
-    @searchManager.bind_event sn.SearchManager.events.AJAX_LOADING, @ajax_loading
-    @searchManager.bind_event sn.SearchManager.events.AJAX_LOADED, @ajax_loaded
-
-
-  # Called when an ajax request starts.
-  ajax_loading: =>
-    @container.addClass 'loading' if @ajax_counter == 0
-    @ajax_counter += 1
-
-
-  # Called when the ajax request is done.
-  ajax_loaded: =>
-    @ajax_counter -= 1
-    @ajax_counter = 0 if @ajax_counter <= 0
-    @container.removeClass 'loading'
-