nitro 0.20.0 → 0.21.0

data/lib/nitro/mixin/buffer.rb

@@ -0,0 +1,66 @@
+require 'glue/attribute'
+
+module Nitro
+
+# The output buffering mixin. Provides php-style output
+# buffering functionality.
+#
+# === Examples
+#
+# <?r buf = capture do ?>
+# ...
+# <?r end ?>
+#
+#--
+# TODO: use better names but keep the ob_xxx php style methods
+# as aliases.
+#++
+
+module BufferMixin
+
+private
+
+  # Output buffers stack, used for php-style nested output 
+  # buffering.
+
+  attr :out_buffers
+  
+  # Start (push) a new output buffer.
+
+  def open_buffer
+    @out_buffers ||= []
+    @out_buffers.push(@out)
+    @out = ''
+  end
+  alias_method :ob_start, :open_buffer
+  
+  # End (pop) the current output buffer.
+  
+  def close_buffer
+    buf = @out
+    @out = @out_buffers.pop
+    return buf
+  end
+  alias_method :ob_end, :close_buffer
+  
+  # End (pop) the current output buffer and write to the parent.
+  
+  def close_and_write_buffer
+    nested_buffer = @out
+    @out = @out_buffers.pop
+    @out << nested_buffer
+  end
+  alias_method :ob_write_end, :close_and_write_buffer
+  
+  def capture
+    open_buffer
+    yield
+    return close_buffer
+  end
+  
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>
+

data/lib/nitro/mixin/debug.rb

@@ -6,22 +6,22 @@ module DebugMixin
 
 private
 
-	# Returns a <pre>-tag set with the +object+ dumped by YAML. 
-	# Very readable way to inspect an object.
-	#--
-	# TODO: make safe html.
-	#++
-	
-	def debug(object)
-	  begin
-	    Marshal::dump(object)
-	    "<pre class='debug_dump'>#{object.to_yaml.gsub("  ", "&nbsp; ")}</pre>"
-	  rescue Object
-	    # Object couldn't be dumped, perhaps because of singleton 
-	    # methods, this is the fallback.
-	    "<code class='debug_dump'>#{object.inspect}</code>"
-	  end
-	end
+  # Returns a <pre>-tag set with the +object+ dumped by YAML. 
+  # Very readable way to inspect an object.
+  #--
+  # TODO: make safe html.
+  #++
+  
+  def debug(object)
+    begin
+      Marshal::dump(object)
+      "<pre class='debug_dump'>#{object.to_yaml.gsub("  ", "&nbsp; ")}</pre>"
+    rescue Object
+      # Object couldn't be dumped, perhaps because of singleton 
+      # methods, this is the fallback.
+      "<code class='debug_dump'>#{object.inspect}</code>"
+    end
+  end
 
 end
 

data/lib/nitro/mixin/form.rb

@@ -0,0 +1,88 @@
+require 'glue/hash'
+
+module Nitro
+
+# A collection of useful helpers for creating and manipulating
+# Forms.
+
+module FormMixin
+  
+  # Render a standard form for the given Entity (ie an
+  # object with attribute metadata).
+  # If show_all is false then apply field filtering.
+  #
+  # Example:
+  #
+  #  <p>
+  #    <form name="test">
+  #      #{form_for entry}
+  #    </form>
+  #  </p>
+  #--
+  # TODO: get info, for example localization mode from session,
+  # if this module is mixed in a Render.
+  #++
+  
+  def form_for(obj, lc = nil, show_all = false)
+    str = '<dl>'
+    
+    for p in obj.class.properties
+      unless show_all
+        next if :oid == p.symbol
+      end
+      
+      if p.klass.ancestors.include?(Integer) or
+          p.klass.ancestors.include?(Float) 
+        str << %{
+  <dt><label for="#{p.symbol}">#{p.symbol}</label></dt>
+  <dd>
+    <input type="text" id="#{p.symbol}" name="#{p.symbol}" value="#{obj.send(p.symbol)}" />
+  </dd>
+        }
+      elsif p.klass.ancestors.include?(String)
+        str << %{
+  <dt><label for="#{p.symbol}">#{p.symbol}</label></dt>
+  <dd>
+        }
+        val = obj.send(p.symbol)
+        if :textarea == p.meta[:ui]
+          str << %{
+    <textarea id="#{p.symbol}" name="#{p.symbol}">#{val}</textarea>
+          }
+        else
+          str << %{
+    <input type="text" id="#{p.symbol}" name="#{p.symbol}" value="#{val}" />
+          }        
+        end
+        str << %{
+  </dd>
+        }
+      elsif p.klass.ancestors.include?(TrueClass)
+        str << %{
+  <dt><label for="#{p.symbol}">#{p.symbol}</label></dt>
+  <dd>
+    <input type="checkbox" id="#{p.symbol}" name="#{p.symbol}" />
+  </dd>
+        }
+      elsif p.klass.ancestors.include?(Time)
+        str << %{
+  <dt><label for="#{p.symbol}">#{p.symbol}</label></dt>
+  <dd>
+    <input type="text" id="#{p.symbol}" name="#{p.symbol}" value="#{obj.send(p.symbol)}" />
+  </dd>
+        }
+      end
+    end
+
+    str << %{
+</dl>}
+    
+    self << str
+  end
+  alias_method :build_form, :form_for
+  
+end
+
+end 
+
+# * George Moschovitis

data/lib/nitro/mixin/helper.rb

@@ -7,8 +7,8 @@ module Nitro
 # be shared accross all Controllers.
 
 module Helper
-	include DebugMixin
-	# This is an open module, extend in your application.
+  include DebugMixin
+  # This is an open module, extend in your application.
 end
 
 end

data/lib/nitro/mixin/javascript.rb

@@ -13,123 +13,123 @@ module JavascriptMixin
 
 private
 
-	unless const_defined? :DEFAULT_JAVASCRIPT_FILES
-		DEFAULT_JAVASCRIPT_FILES = [
-			'js/behaviour.js', 
-			'js/prototype.js', 
-			'js/effects.js', 
-			'js/dragdrop.js', 
-			'js/controls.js'
-		]
-	end
+  unless const_defined? :DEFAULT_JAVASCRIPT_FILES
+    DEFAULT_JAVASCRIPT_FILES = [
+      'js/behaviour.js', 
+      'js/prototype.js', 
+      'js/effects.js', 
+      'js/dragdrop.js', 
+      'js/controls.js'
+    ]
+  end
 
-	# :section: behaviour.js
-	
-	def behaviour(id, js)
-		@_behaviours ||= []
-		@_behaviours << [id, js]
-	end
-	
-	# :section: prototype.js
+  # :section: behaviour.js
+  
+  def behaviour(id, js)
+    @_behaviours ||= []
+    @_behaviours << [id, js]
+  end
+  
+  # :section: prototype.js
 
-	def live_request(id, options = {})
-		if href = options.delete(:href)
-			behaviour "##{id}", %{
-				el.onclick = function() {
-					new Ajax.Request('#{href}', #{hash_to_js(options)});
-					return false;
-				}
-			}
-		else
-			behaviour "##{id}", %{
-				el.onclick = function() {
-					new Ajax.Request(el.href, #{hash_to_js(options)});
-					return false;
-				}
-			}
-		end
-	end
-	alias_method :live, :live_request
-	alias_method :async, :live_request
-	
-	# :section: script.aculo.us dragdrop.js
-	
-	# Make the element dragable.
-	
-	def draggable(id, options = {})
-		@_javascript ||= ''
-		@_javascript << "\nnew Draggable('#{id}', #{hash_to_js(options)});"
-	end
-	
-	# :section: script.aculo.us controls.js
-	
-	# Add autocomplete functionality to a text field.
-	
-	def auto_complete(id, options = {})
-		update = options[:update] || "#{id}_auto_complete"
-		url = options[:url] || "#{id}_auto_complete"
-		@_javascript ||= ''
-		@_javascript << "\nnew Ajax.Autocompleter('#{id}', '#{update}', '#{url}');"
-		
-		# Turn off the browser's autocomplete functionality to avoid
-		# interference.
-		
-		behaviour "##{id}", %{
-			el.autocomplete = 'off';
-		}
-	end
-	
-	# :section: general javascript helpers.
-	
-	# Include external javascript file.
-	
-	def include_script(files = DEFAULT_JAVASCRIPT_FILES)
-		code = ''
-		
-		for file in [files].flatten
-			code << %|<script src="#{file}" type="text/javascript">//</script>|
-		end
-		
-		return code
-	end
-	
-	# Escape carrier returns and single and double quotes for JavaScript segments.
+  def live_request(id, options = {})
+    if href = options.delete(:href)
+      behaviour "##{id}", %{
+        el.onclick = function() {
+          new Ajax.Request('#{href}', #{hash_to_js(options)});
+          return false;
+        }
+      }
+    else
+      behaviour "##{id}", %{
+        el.onclick = function() {
+          new Ajax.Request(el.href, #{hash_to_js(options)});
+          return false;
+        }
+      }
+    end
+  end
+  alias_method :live, :live_request
+  alias_method :async, :live_request
+  
+  # :section: script.aculo.us dragdrop.js
+  
+  # Make the element dragable.
+  
+  def draggable(id, options = {})
+    @_javascript ||= ''
+    @_javascript << "\nnew Draggable('#{id}', #{hash_to_js(options)});"
+  end
+  
+  # :section: script.aculo.us controls.js
+  
+  # Add autocomplete functionality to a text field.
+  
+  def auto_complete(id, options = {})
+    update = options[:update] || "#{id}_auto_complete"
+    url = options[:url] || "#{id}_auto_complete"
+    @_javascript ||= ''
+    @_javascript << "\nnew Ajax.Autocompleter('#{id}', '#{update}', '#{url}');"
+    
+    # Turn off the browser's autocomplete functionality to avoid
+    # interference.
+    
+    behaviour "##{id}", %{
+      el.autocomplete = 'off';
+    }
+  end
+  
+  # :section: general javascript helpers.
+  
+  # Include external javascript file.
+  
+  def include_script(files = DEFAULT_JAVASCRIPT_FILES)
+    code = ''
+    
+    for file in [files].flatten
+      code << %|<script src="#{file}" type="text/javascript">//</script>|
+    end
+    
+    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}" }
+    (js || '').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
   end
 
-	# Converts a Ruby hash to a Javascript hash.
-	
-	def hash_to_js(options)
+  # Converts a Ruby hash to a Javascript hash.
+  
+  def hash_to_js(options)
     '{' + options.map {|k, v| "#{k}:#{v}"}.join(', ') + '}'
   end
 
-	# Emits the aggregated helper javascript.
-	#--
-	# FIXME: refactor this!
-	#++
-	
-	def helper_script
-		code = %|<script type="text/javascript">\n|
-		unless @_behaviours.empty?
-			code << %|var _behaviours = {\n|
-			compo = []
-			for id, js in @_behaviours
-				compo << %|'#{id}': function(el) { #{js} \n }|
-			end
-			code << compo.join(',')
-			code << %|
-			}
-			Behaviour.register(_behaviours);		
-			|
-		end
-		code << %|
-				#@_javascript
-			</script>
-		|
-	end
-	
+  # Emits the aggregated helper javascript.
+  #--
+  # FIXME: refactor this!
+  #++
+  
+  def helper_script
+    code = %|<script type="text/javascript">\n|
+    unless @_behaviours.empty?
+      code << %|var _behaviours = {\n|
+      compo = []
+      for id, js in @_behaviours
+        compo << %|'#{id}': function(el) { #{js} \n }|
+      end
+      code << compo.join(',')
+      code << %|
+      }
+      Behaviour.register(_behaviours);    
+      |
+    end
+    code << %|
+        #@_javascript
+      </script>
+    |
+  end
+  
 end
 
 end

data/lib/nitro/mixin/markup.rb

@@ -0,0 +1,144 @@
+require 'singleton'
+require 'redcloth'
+
+require 'glue/property'
+require 'glue/sanitize'
+
+module Nitro
+
+#--
+# Override the default PropertyUtils implementation to
+# add markup support.
+#++
+=begin
+module PropertyUtils
+  # Override to add markup code.  
+  #
+  def self.prop_setter(prop)
+    s = prop.symbol
+    if markup = prop.meta[:markup]
+      # if true, set to default Markup
+      markup = Nitro::Markup if true == markup
+
+      code = %{
+        def #{s}=(val)
+      }
+      
+      if Property.type_checking
+        code << %{
+          unless String == val.class
+            raise "Invalid type, expected '#{prop.klass}', is '\#\{val.class\}'."
+          end
+        }
+      end
+
+      code << %{
+          @#{s} = #{markup}.expand(val)
+        end
+
+        def compact_#{s}
+          #{markup}.compact(@#{s})
+        end
+      }
+
+      return code
+    else
+      return %{
+        def #{s}=(val)
+          @#{s} = val
+        end
+      }
+    end
+  end
+end
+=end
+
+# Generalised Markup transformations.
+#
+# The expand methods evaluate (expand) the markup
+# code to produce the final content. The compact
+# methods reverse this process to create the original
+# markup code. Not all markup transformations are
+# reversible.
+#
+# When this library is included, the default PropertyUtils 
+# implementation is overriden to add markup support.
+#
+# === Examples
+#
+# Define your custom markup methods like this:
+#
+# module Markup
+#   def markup_simple
+#      ...
+#    end
+#    def markup_special
+#      ...
+#    end
+#
+#   # maps the {{..}} macro
+#    alias_method :sanitize, :markup_simple
+#    # maps the {|..|} macro
+#    alias_method :markup, :markup_special
+#  end
+#
+# here comes the #{obj.body} # => prints the expanded version.
+#
+#  obj.body = markup(@params['body'])  
+
+module Markup
+private
+
+  # The default markup method. You should override this method 
+  # in your application to call your custom markup 
+  # methods.
+
+  def expand(str)
+    if str
+      xstr = str.dup
+      xstr.gsub!(/</, '&lt;')    
+      xstr.gsub!(/>/, '&gt;')
+      return String.sanitize(xstr)
+    end
+    return nil
+  end
+  alias_method :sanitize, :expand
+
+  # ...
+  
+  def expand_redcloth(str)
+    if str
+      return RedCloth.new(expand(str)).to_html
+    end
+    return nil
+  end
+  alias_method :markup, :expand_redcloth
+      
+  # Compact (reverse) the content to the origial markup
+  # code. Not all markup transformations are reversible.
+  # You should override this method in your application 
+  # to call your custom markup methods.
+  #
+  # NOT IMPLEMENTED.
+  
+  def compact(str, meth = nil)
+  end
+
+  # Remove markup code from the input string.
+  #
+  # NOT IMPLEMENTED.
+  
+  def clear(str)
+  end  
+end
+
+# An abstract Markup class.
+
+class Markuper
+  include Singleton
+  include Markup
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>