nitro 0.25.0 → 0.26.0

data/lib/nitro/helper/form/controls.rb

@@ -0,0 +1,274 @@
+require 'nitro/helper/xhtml'
+
+module Nitro
+
+# :section: Property controls.
+
+# A Form control.
+
+class Control
+  include Nitro::XhtmlHelper
+  
+  # Fetch the instance vars in a nice way use either rel 
+  # or prop. 
+  # 
+  # values/value contain the contents of the prop or rel, 
+  # (values reads better for relations)
+  
+  attr_reader :prop
+  alias_method :rel, :prop
+  
+  attr_reader :obj
+  
+  attr_reader :value
+  alias_method :values, :value
+  
+  # setup instance vars to use in methods
+
+  def initialize(obj, key, value=nil)
+    @obj = obj
+    @prop = key
+    @value = value || obj.send(key.name.to_sym)
+  end
+  
+  # Main bulk of the control. Overide to customise
+  
+  def render
+    "No view for this control"
+  end
+  
+  # Label item. Override to customise
+  
+  def label
+    %{<label for="#{prop.name}">#{prop[:title] || prop.name.to_s.humanize}</label>}
+  end
+  
+  # Custom callback to process the request information
+  # posted back from the form
+  #
+  # When Property.populate_object (or fill) is called
+  # with the :preprocess => true option then this
+  # method will get called before the value is pushed
+  # onto the object that is getting 'filled'
+  #
+  # Overide this on controls that require special mods
+  # to the incoming values
+  
+  def on_populate(val)
+    puts "PREPROCESSING !"
+    return val
+  end
+  
+private
+
+  def emit_style
+    if prop.respond_to?(:control_style)
+      style = prop.control_style
+    elsif self.class.respond_to?(:style)
+      style = self.class.style
+    else
+      style = nil
+    end
+    style ? %{ style="#{style}"} : ''
+  end
+  
+end
+
+# Fixnum
+
+class FixnumControl < Control
+  setting :style, :default => 'width: 100px', :doc => 'The default style'
+
+  def render
+    style = prop.control_style ||self.class.style 
+    %{<input type="text" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="#{value}"#{emit_style} /> + -}
+  end
+end
+
+# Float
+
+class FloatControl < Control
+  setting :style, :default => 'width: 100px', :doc => 'The default style'
+
+  def render
+    style = prop.control_style ||self.class.style 
+    %{<input type="text" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="#{value}"#{emit_style} /> + -}
+  end
+end
+
+# Text
+
+class TextControl < Control
+  setting :style, :default => 'width: 250px', :doc => 'The default style'
+
+  def render
+    %{<input type="text" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="#{value}"#{emit_style} />}
+  end
+end
+
+# Textarea
+
+class TextareaControl < Control
+  setting :style, :default => 'width: 500px; height: 100px', :doc => 'The default style'
+  
+  def render
+    %{<textarea id="#{prop.symbol}_ctl" name="#{prop.symbol}"#{emit_style}>#{value}</textarea>}        
+  end
+end
+
+# CheckboxControl < Control
+
+class CheckboxControl < Control
+  setting :style, :default => '', :doc => 'The default style'
+
+  def render
+    checked = value == true ? ' checked="checked"':''
+    %{<input type="checkbox" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="true"#{emit_style}#{checked} />}
+  end
+end
+
+# :section: Relation controls.
+
+# RefersTo. Also used for BelongsTo.
+
+class RefersToControl < Control
+  def render
+    objs = rel.target_class.all    
+    if selected = value
+      selected = selected.pk
+    end
+    
+    str = %{<select id="#{rel.name}_ctl" name="#{rel.name}">}
+    str << %{<option value="nil">None</option>}
+    str << %{#{options(:labels => objs.map{|o| o.to_s}, :values => objs.map{|o| o.pk}, :selected => selected)}</select>}
+    
+    return str
+  end
+end
+
+# HasMany, ManyToMany and JoinsMany
+
+class HasManyControl < Control
+  
+  #pre :do_this, :on => :populate_object
+  
+  def render
+    str = emit_container_start
+    str << emit_js
+    if selected_items.empty?
+      str << emit_selector(all_items, :removable => false)
+    else
+      removable = selected_items.size != 1 ? true : false
+      selected_items.each do |item|
+        str << emit_selector(all_items, :selected => item.pk)
+      end
+    end
+    str << emit_container_end
+  end
+  
+  private 
+  
+  # these parts are seperated from render to make it easier
+  # to extend and customise the HasManyControl
+  
+  def all_items
+    rel.target_class.all
+  end
+  
+  def selected_items
+    values
+  end
+  
+  def emit_container_start
+    %{<div class="many_to_many_container">}
+  end
+  
+  def emit_container_end
+    %{</div>}
+  end
+  
+  # :removable controls wether the minus button is active
+  # :selected denotes the oid to flag as selected in the list
+  
+  def emit_selector(items, options={})
+    removable = options.fetch(:removable, true)
+    %{
+      <div>
+        <select class="has_many_ctl" name="#{rel.name}[]" #{emit_style}>
+          <option value="nil">None</option>
+          #{options(:labels => items.map{|o| o.to_s}, :values => items.map{|o| o.pk}, :selected => options[:selected])}
+        </select>
+        <input type="button" class="#{rel.name}_remove_btn" value=" - " onclick="rm_#{rel.name}_rel(this);" #{'disabled="disabled"' unless removable} />
+        <input type="button" class="#{rel.name}_add_btn" value=" + " onclick="add_#{rel.name}_rel(this);" />
+      </div>
+    }
+  end
+  
+  # Inline script: override this to change behavior
+  
+  def emit_js
+    %{
+      <script type="text/javascript">
+        rm_#{rel.name}_rel = function(el){
+          ctl=el.parentNode; 
+          container=ctl.parentNode; 
+          container.removeChild(ctl); 
+          inputTags = container.getElementsByTagName('input');
+          if(inputTags.length==2) 
+            inputTags[0].disabled='disabled';
+        }
+        add_#{rel.name}_rel = function(el){
+          ctl=el.parentNode; 
+          container=ctl.parentNode; 
+          node=ctl.cloneNode(true); 
+          node.getElementsByTagName('input')[0].removeAttribute('disabled'); 
+          if(container.lastChild==ctl) container.appendChild(node);
+          else container.insertBefore(node, ctl.nextSibling);
+          if(container.childNodes.length>1) container.getElementsByTagName('input')[0].disabled='';
+        }
+      </script>
+    }
+  end
+end
+  
+# The controls map.
+
+class Control
+  
+  # Setup the mapping of names => control classes
+  
+  setting :map, :doc => 'Mappings of control names => classes', :default => {
+    :fixnum => FixnumControl,
+    :float => FloatControl,
+    :boolean => CheckboxControl,
+    :checkbox => CheckboxControl,
+    :string => TextControl,
+    :textarea => TextareaControl,
+    :true_class => CheckboxControl,
+    :refers_to => RefersToControl,
+    :belongs_to => RefersToControl,
+    :has_many => HasManyControl,
+    :many_to_many => HasManyControl,
+    :joins_many => HasManyControl
+  }
+  
+  # Fetch a control, setup for 'obj' for a property, or relation 
+  # or :symbol defaults to Control if not found
+  
+  def self.fetch(obj, key, missing=self)
+    if key.kind_of? Og::Relation
+      control_sym = key[:control] || key.class.to_s.demodulize.underscore.to_sym
+    elsif key.kind_of? Property
+      control_sym = key[:control] || key.klass.to_s.underscore.to_sym
+    else
+      control_sym = key.to_sym
+    end
+    self.map.fetch(control_sym, missing).new(obj, key)
+  end
+  
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>
+# * Chris Farmiloe <chris.farmiloe@farmiloe.com>

data/lib/nitro/helper/javascript.rb

@@ -1,3 +1,7 @@
+require 'nano/inflect'
+
+require 'nitro/compiler/morphing'
+
 module Nitro
 
 # A collection of useful Javascript helpers. This modules
@@ -11,7 +15,15 @@ module Nitro
 
 module JavascriptHelper
 
-private
+  # 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
+
+  # -- older stuff --
 
   unless const_defined? :DEFAULT_JAVASCRIPT_FILES
     DEFAULT_JAVASCRIPT_FILES = [
@@ -24,7 +36,23 @@ private
   end
 
   # :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/
   
+  # Register javascript code with an HTML element of a given id with the
+  # +behaviour+ method.
+  #
+  # Example: 
+  #
+  #  behaviour '#alert', %{
+  #    el.onclick = function() {
+  #      alert('Hello world');
+  #    }    
+  #  }  
+
   def behaviour(id, js)
     @_behaviours ||= []
     @_behaviours << [id, js]
@@ -32,6 +60,24 @@ private
   end
   
   # :section: prototype.js
+  #
+  # Prototype.js is a third-party library that provides a number of functions
+  # for AJAX-style interaction with the browser. It depends on the Behaviour.js
+  # library. Prototype's homepage is http://prototype.conio.net/
+
+  # A live, or asynchronous, request is one that does not bring the user to a
+  # new page. It is used to send data back to the web server while the user is
+  # still interacting with a document.
+  #
+  # Call +live+ with the id of an achor element as a string or a symbol.
+  # Alternatively, add <tt>async="true"</tt> to the anchor (A) element. Specify the
+  # anchor to be called either as a second parameter to the +live+ method, or
+  # in the HREF option of the anchor element.
+  #
+  # Examples:
+  #
+  #  live :id_of_anchor_element [:method]
+  #  <a href="receiver" async="true">Go!</a>
 
   def live_request(id, options = {})
     __append_script_file__ 'js/behaviour.js'
@@ -57,7 +103,8 @@ private
   alias_method :live, :live_request
   alias_method :async, :live_request
   
-  # Denotes an element as toggleable.
+  # Clicking the element will make it disappear. If you want it to reappear,
+  # you'll have to call <tt>toggle()</tt>.
   
   def toggleable(id, options = {})
     __append_script_file__ 'js/prototype.js'
@@ -74,7 +121,7 @@ private
   
   # :section: script.aculo.us dragdrop.js
   
-  # Make the element dragable.
+  # The user may click and drag the element about the screen.
   
   def draggable(id, options = {})
     __append_script_file__ 'js/behaviour.js'
@@ -215,7 +262,8 @@ private
   # -----------------------------------------------------------
   # :section: general javascript helpers.
   
-  # Include external javascript file.
+  # Inserts links to the .js files necessary for your page. Call it from within
+  # HEAD. Add other script files as arguments if desired.
   
   def include_script(*files)
     return if @_script_files.nil? and files.empty?
@@ -253,13 +301,15 @@ private
   end
   alias_method :helper_css, :emit_css
 
-  # Emits the aggregated helper javascript.
+  # Call this in your template/page to include the javascript statements that
+  # link your HTML to the javascript libraries. Must be called after the HTML
+  # elements involved, i.e., at the bottom of the page.
   #--
   # FIXME: refactor this!
   #++
   
   def emit_script
-    code = %|<script type="text/javascript">\n|
+    code = %|<script type="text/javascript">\n<!--\n|
     unless @_behaviours.empty?
       code << %|var _behaviours = {\n|
       compo = []
@@ -276,6 +326,7 @@ private
         #{@_script.join("\n")}
     | if @_script
     code << %|
+      //-->
       </script>
     |
   end
@@ -307,6 +358,35 @@ private
 
 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/pager.rb

@@ -218,6 +218,11 @@ class Pager
   end
   alias_method :links, :navigation
 
+  def navigation_needed?
+    @page_count > 1
+  end
+  alias_method :navigation?, :navigation_needed?
+
 private
 
   # Generate the target URI.

data/lib/nitro/helper/prototype.rb

@@ -0,0 +1,49 @@
+module Nitro
+
+module PrototypeHelper
+
+  def remote_function()
+  end
+
+  #--
+  # TODO: resolve html
+  #++
+  
+  class JavascriptGenerator
+    attr_accessor :buffer
+    
+    def initialize
+      @buffer = ''
+    end
+
+    # 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)
+      record "new Insertion.#{position.to_s.camelize}(#{id.inspect}, #{html.inspect})"
+    end
+
+    def replace_html(id, html, options = {})
+      record "Element.update(#{id.inspect}, #{html.inspect})"
+    end
+   
+  private
+    
+    def record(code)
+      code = "#{line.to_s.chomp.gsub /\;$/, ''};"
+      @buffer << code
+      return code
+    end    
+    
+  end
+
+
+
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>