nitro 0.26.0 → 0.27.0

data/lib/nitro/helper/javascript.rb

@@ -1,9 +1,58 @@
 require 'nano/inflect'
 
-require 'nitro/compiler/morphing'
-
 module Nitro
 
+# Javascript utilities.
+
+module JavascriptUtils
+private
+  # Escape carrier returns and single and double quotes for JavaScript segments.
+  
+  def escape_javascript(js)
+    (js || '').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
+  end
+
+  # Converts a Ruby hash to a Javascript hash.
+  
+  def hash_to_js(options)
+    '{' + options.map {|k, v| "#{k}:#{v}"}.join(', ') + '}'
+  end
+  
+  # Converts the name of a javascript file to the actual 
+  # filename. Override if you don't like the defaults.
+  
+  def name_to_jsfile(name)  
+    "js/#{name}.js"
+  end  
+end
+
+# Generates cliend side javascript.
+
+module ScriptGenerator
+  include JavascriptUtils
+  
+  attr_accessor :buffer
+
+  # Present an alert dialog box.
+  
+  def alert(text)
+    js "alert('#{text}');"
+  end
+
+private
+
+  def record(code)
+    @buffer << code
+    return true
+  end
+  alias_method :js, :record
+
+end
+
+require 'nitro/helper/javascript/prototype'
+require 'nitro/helper/javascript/scriptaculous'
+require 'nitro/helper/javascript/morphing'
+
 # A collection of useful Javascript helpers. This modules
 # integrates helpers for the following javascript libraries:
 #
@@ -12,16 +61,22 @@ module Nitro
 # * effects.js
 # * dragdrop.js
 # * controls.js
+#
+#--
+# gmosx: this code is kinda old, will be deprecated soon.
+#++
 
 module JavascriptHelper
-
-  # Insert an anchor to execute a given function when the link is followed.
-  # Call with the name of the link, and the function to be called:
+  include JavascriptUtils
+  
+  # Insert an anchor to execute a given function when the link 
+  # is followed. Call with the name of the link, and the 
+  # function to be called:
   #  link_to_function "Do it." :go
 
   def link_to_function(name, function)
     %{<a href="#" onclick="#{function}; return false;">#{name}</a>}
-  end
+  end  
 
   # -- older stuff --
 
@@ -37,13 +92,13 @@ module JavascriptHelper
 
   # :section: behaviour.js
   #
-  # Behaviour.js is a third-party library for keeping HTML clean of javascript.
-  # The +behaviour+ method provides an interface to that library.
-  # To learn more about the concept, visit the distributor:
-  # http://bennolan.com/behaviour/
+  # Behaviour.js is a third-party library for keeping HTML clean 
+  # of javascript. The +behaviour+ method provides an interface 
+  # to that library. To learn more about the concept, visit the 
+  # distributor: http://bennolan.com/behaviour/
   
-  # Register javascript code with an HTML element of a given id with the
-  # +behaviour+ method.
+  # Register javascript code with an HTML element of a given id 
+  # with the +behaviour+ method.
   #
   # Example: 
   #
@@ -266,32 +321,16 @@ module JavascriptHelper
   # HEAD. Add other script files as arguments if desired.
   
   def include_script(*files)
-    return if @_script_files.nil? and files.empty?
+    return nil if files.empty?
     
     code = ''
 
     for file in files
-      code << %|<script src="#{file}" type="text/javascript">//</script>\n|
+      code << %|<script src="#{name_to_jsfile(file)}" type="text/javascript">//</script>\n|
     end if files
 
-    for file in @_script_files
-      code << %|<script src="#{file}" type="text/javascript">//</script>\n|
-    end if @_script_files
-    
     return code
   end
-  
-  # Escape carrier returns and single and double quotes for JavaScript segments.
-  
-  def escape_javascript(js)
-    (js || '').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
-  end
-
-  # Converts a Ruby hash to a Javascript hash.
-  
-  def hash_to_js(options)
-    '{' + options.map {|k, v| "#{k}:#{v}"}.join(', ') + '}'
-  end
 
   # Emits the aggregated css.
   
@@ -358,35 +397,6 @@ module JavascriptHelper
 
 end
 
-# :section: Javascript related morphers.
-
-# Transform a normal achor into an asynchronous request:
-#  <a href="..." async="true">...</a>
-# becomes
-#  <a href="#" onclick="new Ajax.Request...; return false;">...</a>
-
-class AsyncMorpher < Morpher
-  def before_start(buffer)
-    href = @attributes['href'] 
-    @attributes['href'] = '#'
-    @attributes['onclick'] = "new Ajax.Request('#{href}'); return false;"
-    @attributes.delete(@key)
-  end
-end
-
-class LocalMorpher < Morpher
-  def before_start(buffer)
-    @attributes['href'] = '#'
-    @attributes['onclick'] = "ngs#{@value.camelcase(true)}();"
-    @attributes.delete(@key)
-  end
-end
-
-# Install the morphers.
-
-Morphing.add_morpher :async, AsyncMorpher
-Morphing.add_morpher :local, LocalMorpher
-
 end
 
 # * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper/javascript/morphing.rb

@@ -0,0 +1,163 @@
+require 'mega/dictionary'
+
+require 'nitro/compiler/morphing'
+
+# Javascript related morphers.
+
+module Nitro
+
+#--
+# A useful superclass for morphers. Provides easy access to 
+# js/css shared buffers.
+#++
+
+class SharedMorpher < Morpher # :nodoc: all
+  include JavascriptUtils
+  
+  # Record javascript to be injected in the template.
+  
+  def record_js(code)
+    (@compiler.shared[:js_buffer] ||= '') << code
+  end
+  alias_method :js, :record_js
+  
+  # Record css to be injected in the template.
+  
+  def record_css(css)
+    (@compiler.shared[:css_buffer] ||= '') << css
+  end
+  alias_method :css, :record_css
+  
+  # Require javascript files.
+  
+  def require_script_file(*names)
+    files = (@compiler.shared[:js_required_files] ||= Dictionary.new)
+    for name in names
+      files[name] = true    
+    end
+  end
+  alias_method :add_script_file, :require_script_file
+end
+
+# Transform a normal achor into an asynchronous request:
+#  <a href="..." async="true">...</a>
+# becomes
+#  <a href="#" onclick="new Ajax.Request...; return false;">...</a>
+
+class AsyncMorpher < SharedMorpher
+  def before_start(buffer)
+    require_script_file :prototype
+    
+    href = @attributes['href'] 
+    @attributes['href'] = '#'
+    @attributes['onclick'] = "new Ajax.Request('#{href}'); return false;"
+    @attributes.delete(@key)
+  end
+end
+
+# Transform script attributes.
+#
+# <form script="action">...
+# becomes
+# <form onsubmit="action(); return false">...
+#
+# <a script="action">..</a>
+# becomes
+# <a href="#" onclick="action(); return false">...</a>
+
+class ScriptMorpher < SharedMorpher
+  def before_start(buffer)
+    require_script_file :prototype
+    
+    case @name
+      when 'form'
+        @attributes['onsubmit'] = "#@value(); return false"
+      else
+        @attributes['href'] = '#'
+        @attributes['onclick'] = "#@value(); return false"
+    end
+    @attributes.delete(@key)
+  end
+end
+
+# Transform client attributes. '__nc_' marks Nitro generated
+# javascript functions.
+#
+# <form client="action">...
+# becomes
+# <form onsubmit="__nc_action(); return false">...
+#
+# <a client="action">..</a>
+# becomes
+# <a href="#" onclick="__nc_action(); return false">...</a>
+
+class ClientMorpher < SharedMorpher
+  def before_start(buffer)
+    require_script_file :prototype, :effects
+    
+    case @name
+      when 'form'
+        @attributes['onsubmit'] = "__nc_#@value(); return false"
+      else
+        @attributes['href'] = '#'
+        @attributes['onclick'] = "__nc_#@value(); return false"
+    end
+    @attributes.delete(@key)
+  end
+end
+
+# Makes a DOM element draggable.
+
+class DraggableMorpher < SharedMorpher
+  def before_start(buffer)
+    require_script_file :prototype, :effects, :dragdrop
+    
+    id = @attributes['id'] || @attributes['name']    
+    options = @attributes['drag_options'] || ''
+    js "new Draggable('#{id}', #{hash_to_js(options)});"
+  
+    @attributes.delete(@key)
+  end
+end
+
+# Adds auto-complete functionality to a standard input field.
+#
+# === Example
+# 
+# <input type="text" id="myfield" name="myfield" auto_complete="true" />
+#
+# You need to provide the autocomplete values by means of a
+# custom action: {field_id}_auto_complete. The method should
+# return a <ul> list. In this example:
+#
+# def myfield_auto_complete
+#   %{<ul><li>....</ul>}
+
+class AutoCompleteMorpher < SharedMorpher
+  def before_start(buffer)
+    require_script_file :prototype, :effects, :controls
+    
+    id = @id = @attributes['id'] || @attributes['name']    
+    update = @attributes['auto_complete_update'] || "#{id}_auto_complete"
+    url = @attributes['auto_complete_url'] || "#{id}_auto_complete"    
+    js "new Ajax.Autocompleter('#{id}', '#{update}', '#{url}');"
+
+    @attributes.delete(@key)
+  end
+  
+  def after_end(buffer)
+    buffer << %|<div id="#{@id}_auto_complete" class="auto_complete"> </div>|
+  end
+end
+
+# Install the morphers.
+
+Morphing.add_morpher :async, AsyncMorpher
+Morphing.add_morpher :script, ScriptMorpher
+Morphing.add_morpher :client, ClientMorpher
+Morphing.add_morpher :auto_complete, AutoCompleteMorpher
+Morphing.add_morpher :draggable, DraggableMorpher
+
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper/javascript/prototype.rb

@@ -0,0 +1,96 @@
+module Nitro
+
+# Add Prototype methods to the ScriptGenerator.
+# Prototype.js is a third-party library that provides a number 
+# of functions for AJAX-style interaction with the browser. 
+# Prototype's homepage is http://prototype.conio.net/
+
+module ScriptGenerator
+
+  # html = A string or a symbol to an action for rendering.
+  #--
+  # TODO: resolve html.
+  #++
+  
+  def insert_html(id, html, options = {})
+    position = options.fetch(:where, :before)
+    js "new Insertion.#{position.to_s.camelize}('#{id}', '#{html}');"
+  end
+
+  def replace_html(id, html, options = {})
+    js "Element.update('#{id}', '#{html}');"
+  end
+  
+  # Hide a DOM element.
+  
+  def hide(id)
+    js "$('#{id}').style.display = 'none';"
+  end
+
+  # Show a DOM element.
+  
+  def show(id)
+    js "$('#{id}').style.display = 'block';"
+  end
+
+  # Toggle a DOM element.
+  
+  def toggle(id)
+    js "Element.toggle('#{id}');"
+  end
+
+  # Perform an ajax, async update.
+
+  def ajax_update(id, options = {})
+    code = %~
+      new Ajax.Updater(
+        { success: '#{id}' },
+        '#{options[:action] || options[:url]}', 
+        {
+          method: '#{options.fetch(:method, :post)}',
+          parameters: #{options[:params] || options[:parameters]}, 
+    ~
+
+    if before = options[:before]
+      if before.is_a? Proc
+        old_buffer = @buffer
+        @buffer = ''
+        before.call
+        before = @buffer
+        @buffer = old_buffer + @buffer
+      end
+      code << %~
+        onLoading: function(request) {
+          #{before}
+        },
+      ~
+    end
+
+    if success = options[:success]
+      if success.is_a? Proc      
+        old_buffer = @buffer
+        @buffer = ''
+        success.call
+        success = @buffer
+        @buffer = old_buffer
+      end
+      code << %~
+        onComplete: function(request) {
+          #{success}
+        }        
+      ~
+    end
+
+    code << %~
+        }
+      );
+    ~
+    
+    js(code)
+  end
+
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper/javascript/scriptaculous.rb

@@ -0,0 +1,18 @@
+module Nitro
+
+# Add Scriptaculous methods to the ScriptGenerator.
+
+module ScriptGenerator
+
+  def visual_effect(name, id = false, options = {})
+    element = id ? "'#{id}'" : "element"
+    options[:queue] = "'#{options[:queue]}'" if options[:queue]
+    js "new Effect.#{name.to_s.camelize}(#{element}, #{hash_to_js(options)});"
+  end
+  alias_method :effect, :visual_effect
+
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>