modularity-rails 0.17.0 → 0.19.0

data/README.md

@@ -55,6 +55,51 @@ Each module has a container. The container is the outermost DOM element of a sec
 Everything the module does must happen inside this container.
 The module is responsible for managing the inner DOM-structure of the container.
 
+## Events
+
+Modules are supposed to form a loosely coupled architecture, in which they communicate with each other through events.
+Similar to jQuery events, a module can trigger an event using its `trigger` method, like so:
+```coffeescript
+@trigger 'user_selected', user
+```
+
+The first argument is the event name, the second one an optional data payload. The event is a normal jQuery event,
+triggered from the container of the module.
+
+Other modules can subscribe to events from particular modules using a similar mechanism:
+```coffeescript
+@user_list.on 'user_selected', (e, user) -> ...
+```
+
+The first argument is the jQuery event object, the second one the data payload.
+
+### Event Autobinding
+
+If you want to avoid writing lots of boilerplate code to wire up events, use Modularities `autobind` method together with the convention to name your event handler methods "on_#{module_name}_#{event_name}".
+For example, to listen to the "entry_created" event of a module called "userlist", name your method "on_userlist_entry_created". To illustrate this more, the following two pieces of code are equivalent:
+
+Manual event listener setup:
+```coffeescript
+@userlist = new UserList()
+@userlist.on 'entry_selected', @user_selected
+@userlist.on 'entry_created', @user_created
+@userlist.on 'entry_deleted', @user_deleted
+
+user_selected: (e, user) -> ...
+user_created: (e, user) -> ...
+user_deleted: (e, user) -> ...
+```
+
+Automatic event listener setup:
+```coffeescript
+@userlist = new UserList()
+@autobind()
+
+on_userlist_entry_selected: (e, user) -> ...
+on_userlist_entry_created: (e, user) -> ...
+on_userlist_entry_deleted: (e, user) -> ...
+```
+
 
 ## Mixins
 

data/app/assets/javascripts/modularity/data/indexed_cache.coffee

@@ -16,12 +16,12 @@ class modularity.IndexedCache
     @add(entry) for entry in entries
 
 
-  remove: (entry) ->
-    @cache.remove entry[@key]
+  remove: (entry_id) ->
+    @cache.remove entry_id
 
 
-  remove_many: (entries) ->
-    @cache.remove_many (entry[@key] for entry in entries)
+  remove_many: (entry_ids) ->
+    @cache.remove_many entry_ids
 
 
   get: (key) ->

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

@@ -55,13 +55,13 @@ class modularity.PersistenceManager
 
 
   # Deletes the given objects from the server.
-  delete_many: (objects, callback) ->
-    @client_data.remove_many objects
-    @server_data.remove_many objects
+  delete_many: (object_ids, callback) ->
+    @client_data.remove_many object_ids
+    @server_data.remove_many object_ids
     jQuery.ajax
       url: @base_url
       type: 'DELETE'
-      data: (obj.id for obj in objects)
+      data: {ids: object_ids}
       success: ->
         callback() if callback?
 

data/app/assets/javascripts/modularity/mixins/clickable.coffee

@@ -12,5 +12,5 @@ modularity.clickable =
 
 
   # Event handler for clicks on this clickable element.
-  container_clicked: -> @fire 'clicked'
+  container_clicked: -> @trigger 'clicked'
 

data/app/assets/javascripts/modularity/mixins/closable.coffee

@@ -11,6 +11,6 @@ modularity.closable =
   close_button_clicked: ->
     if @closable_closing
       return unless @closable_closing()
-    @fire 'closed'
+    @trigger 'closed'
     @container.remove()
     @closable_closed() if @closable_closed

data/app/assets/javascripts/modularity/modularity.coffee

@@ -1,4 +1,6 @@
 #= require jquery
+#= require_self
+#= require ./tools/string_tools
 
 # The Modularity framework written specificially for CoffeeScript.
 #
@@ -75,21 +77,40 @@ class @modularity.Module
 
   # MODULE EVENTS.
 
+  # Automatically binds events to member elements.
+  autobind: ->
+    my_fields = []
+    my_callbacks = []
+    for element of @
+      switch typeof @[element]
+        when 'object'
+          my_fields.push element
+        when 'function'
+          my_callbacks.push(element) if modularity.string_starts_with element, 'on_'
+    for field in my_fields
+      for callback in my_callbacks
+        if modularity.string_starts_with callback, "on_#{field}_"
+          event_name = callback.substring 4 + field.length
+          @[field].on event_name, @[callback]
+    false
+
+
   # Calls the given function when this widget fires the given local event.
-  bind_event: (event_type, callback) =>
+  on: (event_type, callback) =>
     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
-  on: Module::bind_event
+  bind_event: Module::bind_event
+
 
   # Fires the given local event with the given data payload.
-  fire_event: (event_type, data) =>
+  trigger: (event_type, data) =>
     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 ?= {}
   fireEvent: Module::fire_event
-  fire: Module::fire_event
+  fire_event: Module::fire_event
 
 
   # Hides this module.

data/app/assets/javascripts/modularity/tools/string_tools.coffee

@@ -0,0 +1,3 @@
+modularity.string_starts_with = (string, start) ->
+  string.substring(0, start.length) == start
+

data/lib/modularity-rails/version.rb

@@ -1,3 +1,3 @@
 module ModularityRails
-  VERSION = '0.17.0'
+  VERSION = '0.19.0'
 end

metadata

@@ -1,144 +1,144 @@
 --- !ruby/object:Gem::Specification
 name: modularity-rails
 version: !ruby/object:Gem::Version
+  version: 0.19.0
   prerelease: 
-  version: 0.17.0
 platform: ruby
 authors:
 - Kevin Goslar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-06 00:00:00.000000000 Z
+date: 2013-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.12
-    none: false
-  type: :runtime
   name: rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.12
-    none: false
-- !ruby/object:Gem::Dependency
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-  type: :runtime
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  type: :runtime
+- !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  type: :development
+- !ruby/object:Gem::Dependency
   name: guard-livereload
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  type: :development
+- !ruby/object:Gem::Dependency
   name: konacha
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  type: :development
+- !ruby/object:Gem::Dependency
   name: poltergeist
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  type: :development
+- !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  type: :development
+- !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Makes the modularity-coffee framework available to Ruby on Rails applications.
 email:
 - kevin.goslar@gmail.com
@@ -157,6 +157,7 @@ files:
 - app/assets/javascripts/modularity/modules/button.coffee
 - app/assets/javascripts/modularity/tools/array_tools.coffee
 - app/assets/javascripts/modularity/tools/object_tools.coffee
+- app/assets/javascripts/modularity/tools/string_tools.coffee
 - config/initializers/konacha.rb
 - lib/modularity-rails/engine.rb
 - lib/modularity-rails/version.rb
@@ -171,20 +172,20 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A lightweight, object- and component-oriented CoffeeScript framework for