modularity-rails 0.6.3 → 0.7.0

data/.evergreen

@@ -3,4 +3,4 @@ require 'capybara-webkit'
 Evergreen.configure do |config|
   config.driver = :webkit
   config.public_dir = ''
-end
+end

data/README.md

@@ -40,7 +40,7 @@ Modularity provides practices to create code bases of incredible complexity that
 nicely manageable and perform very well. 
 
 
-# Modules
+## Modules
 
 Modules are native CoffeeScript classes that are specialized for doing what most JavaScript running in browsers does: 
 managing a UI consisting of DOM elements, reacting to events that happen within that section, 
@@ -77,24 +77,39 @@ class MyModule extends Module
     # ...
 ```
 
+## Hooks
 
-## Reusable example modules and mixins.
+Hooks are a more direct and easier way to interact with mixins. They are methods with predefined names that mixing modules can implement to hook into events of their mixins
+without the need to wire up event handlers, and with the ability to interact with the workflow of the mixins.
+
+
+# Reusable example modules and mixins.
 
 Modularity comes bundled with a bunch of example modules and mixins that can be used in production code.
 The example modules are located in `vendor/assets/javascripts/modules/` and _vendor/assets/javascripts/mixins_
 and must be explicitly required in your Rails files using the `require` commands of the asset pipeline.
 
 
-### Modules
+## Modules
 
 * __button.coffee__: A simple button. Fires the `clicked` event when anything inside the container is clicked. Uses the `clickable` mixin.  
 * __counter_button.coffee__: Similar to button, but includes the click count as data payload in the fired event.
 
 
-### Mixins
+## Mixins
+
+###clickable
+Including this mixins adds a 'clickable' aspect to your module, i.e. turns it into a button. Clicking anywhere inside the container makes it fire the 'clicked' event.
+
+###closable
+Including this mixin makes a module closable. The mixin searches for an embedded DOM element with the class 'CloseButton'. When it is clicked, the following things happen:
 
-* __clickable.coffee__: Including this mixins adds a 'clickable' aspect to your module, i.e. turns it into a button. Clicking anywhere inside the container makes it fire the 'clicked' event.
-* __closable.coffee__: Including this mixin makes a module closable. This means that when the user clicks on an embedded DOM element with the class 'CloseButton', a 'closing' event will be fired, and the whole module will be removed from the DOM.
+* The _closable_closing_ hook of the closable class is called.
+  This hook could be used to display confirmation dialogs (and abort the close process) or to fire custom events that depend on the DOM still being present. 
+  If this method returns a falsy value, the closing process is aborted.
+* The closable module fires a local 'closing' event (with the DOM still present).
+* The whole module including its container is removed from the DOM.
+* The _closable_closed_ hook of the closable class is called.
 
 
 # Development

data/lib/modularity-rails/version.rb

@@ -1,3 +1,3 @@
 module ModularityRails
-  VERSION = "0.6.3"
+  VERSION = "0.7.0"
 end

data/spec/javascripts/mixins/closable_spec.coffee

@@ -6,7 +6,8 @@ describe 'test environment setup', ->
     load_modularity()
     loadCS "/vendor/assets/javascripts/mixins/closable.coffee"
 
-    class window.ClosableModuleStandard extends Module
+    # A standard closable module.
+    class window.ClosableModule1 extends Module
       @mixin closable
 
 
@@ -16,31 +17,82 @@ describe 'Closable', ->
   describe 'constructor', ->
     it 'shows an alert if there is no close button', ->
       spy = spyOn window, 'alert'
-      new ClosableModuleStandard('#test #closable3')
+      new ClosableModule1('#test #closable3')
       expect(spy).toHaveBeenCalled()
       expect(spy.argsForCall[0][0]).toMatch(/close button not found/i)
 
     it 'shows no alert if there is a close button', ->
       spy = spyOn window, 'alert'
-      new ClosableModuleStandard('#test #closable1')
+      new ClosableModule1('#test #closable1')
       expect(spy).not.toHaveBeenCalled()
 
     it 'finds the close button div automatically', ->
-      new ClosableModuleStandard('#test #closable1')
+      new ClosableModule1('#test #closable1')
       $('#test #closable1 .CloseButton').click()
       expect($('#test #closable1').length).toEqual(0)
 
 
   describe 'when clicking the close button', ->
+
+    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
+
+        constructor: ->
+          super
+          @closing_hook_got_called = no
+
+        closable_closing: =>
+          @closing_hook_got_called = yes
+
+      module = new ClosableModule('#test #closable1')
+      $('#test #closable1 .CloseButton').click()
+      expect(module.closing_hook_got_called).toBeTruthy()
+
+
+    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
+
+        constructor: ->
+          super
+          @closed_hook_got_called = no
+
+        closable_closed: =>
+          @closed_hook_got_called = yes
+
+      module = new ClosableModule('#test #closable1')
+      $('#test #closable1 .CloseButton').click()
+      expect(module.closed_hook_got_called).toBeTruthy()
+
+
+    it "aborts the close operation if the closable_closing method returns false", ->
+
+      class ClosableModuleWithHookThatReturnsFalse extends Module
+        @mixin closable
+        closable_closing: -> false
+
+      module = new ClosableModuleWithHookThatReturnsFalse('#test #closable1')
+      module.bind_event('closed', (spy = jasmine.createSpy()))
+
+      $('#test #closable1 .CloseButton').click()
+
+      expect(spy).not.toHaveBeenCalled()
+
+
     it 'removes the container', ->
-      new ClosableModuleStandard('#test #closable1')
+      new ClosableModule1('#test #closable1')
       $('#test #closable1 .CloseButton').click()
 
       expect($('#test #closable1').length).toEqual(0)
-      
-    
+
+
     it "fires the 'closed' event", ->
-      closable_module = new ClosableModuleStandard('#test #closable1')
+      closable_module = new ClosableModule1('#test #closable1')
       closable_module.bind_event('closed', (spy = jasmine.createSpy()))
 
       $('#test #closable1 .CloseButton').click()

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

@@ -4,7 +4,7 @@ window.closable =
     close_button = @container.find('.CloseButton')
     unless close_button?.length > 0
       window.alert 'Error: Close button not found'
-    close_button.click @close_button_clicked
+    close_button.click => @close_button_clicked()
 
 
   # The events that can be fired by closable objects.
@@ -14,5 +14,8 @@ window.closable =
 
   # Called when the button got clicked by the user or programmatically.
   close_button_clicked: ->
+    if @closable_closing
+      return unless @closable_closing()
     @fire_event 'closed'
     @container.remove()
+    @closable_closed() if @closable_closed

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

@@ -18,6 +18,7 @@ class window.Module
       return alert "Error in Module constructor: The given container ('#{container.selector}') has more than one element." unless container? and container.length == 1
 
 
+    # Attach mixins.
     if @mixins?
       for mixin_data in @mixins
         

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modularity-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-30 00:00:00.000000000 Z
+date: 2012-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70358087399780 !ruby/object:Gem::Requirement
+  requirement: &70343797333300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70358087399780
+  version_requirements: *70343797333300
 - !ruby/object:Gem::Dependency
   name: capybara-webkit
-  requirement: &70358087399360 !ruby/object:Gem::Requirement
+  requirement: &70343797332340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70358087399360
+  version_requirements: *70343797332340
 - !ruby/object:Gem::Dependency
   name: evergreen
-  requirement: &70358087398900 !ruby/object:Gem::Requirement
+  requirement: &70343797331680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70358087398900
+  version_requirements: *70343797331680
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70358087398440 !ruby/object:Gem::Requirement
+  requirement: &70343797331020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70358087398440
+  version_requirements: *70343797331020
 - !ruby/object:Gem::Dependency
   name: guard-livereload
-  requirement: &70358087398020 !ruby/object:Gem::Requirement
+  requirement: &70343797330580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70358087398020
+  version_requirements: *70343797330580
 description: Description of ModularityRails.
 email:
 - kevin.goslar@gmail.com
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Summary of ModularityRails.