window_rails 0.1.0 → 0.1.1

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== v0.1.1
+* Proper rails loading when included via gem
+* Fix for window jumping when constraints applied
+* Fix for #observe_dynamically_loaded_field when using a function instead of callback
+* Make IFrame usage optional
+
 == v0.1.0
 * Lots of cleanup
 * Better builders available

data/README.rdoc

@@ -1,14 +1,18 @@
-++ Important note ++
-
-This is still in its infancy and is pretty unstable. This will be removed once it's ready
-for initial release.
-
 == WindowRails
 
 WindowRails is a plugin for Rails that provides easy to use AJAXy windows. It is based
 completely on {Prototype Window}[http://prototype-window.xilinus.com/] with helpers for
 Rails to make it easy to use from a Rails app.
 
+== Configuration
+
+After install, add these in the head of your application.html.erb file:
+
+  <%= javascript_include_tag 'window_rails/window' %>
+  <%= stylesheet_link_tag *%w(/themes/alphacube /themes/default /themes/alert) %>
+  
+Alphacube is the default theme used by window_rails. Be sure to add the css link if you plan on using other themes.
+
 === Basic examples to get you started
 
 ==== Linking to a window
@@ -65,4 +69,4 @@ Rails to make it easy to use from a Rails app.
 == License
 
 * Prototype Window was released under the MIT license
-* WindowRails continues on under the MIT license
+* WindowRails continues on under the MIT license

data/files/javascripts/window.js

@@ -287,8 +287,13 @@ Window.prototype = {
   },
   
   setAjaxContent: function(url, options, showCentered, showModal) {
-    this.showFunction = showCentered ? "showCenter" : "show";
-    this.showModal = showModal || false;
+    if(showCentered){
+      this.showFunction = showCentered ? "showCenter" : "show";
+      this.showModal = showModal || false;
+    } else {
+      this.showFunction = null;
+      this.showModal = null;
+    }
   
     options = options || {};
 
@@ -309,7 +314,9 @@ Window.prototype = {
     if (this.onComplete)
       this.onComplete(originalRequest);
     this.onComplete = null;
-    this[this.showFunction](this.showModal)
+    if(this.showFunction){
+      this[this.showFunction](this.showModal)
+    }
   },
   
   setURL: function(url) {
@@ -537,8 +544,9 @@ Window.prototype = {
     if (this.constraint && this.useLeft && this.useTop) {
       var width = this.options.parent == document.body ? WindowUtilities.getPageSize().windowWidth : this.options.parent.getDimensions().width;
 
+      // the -10 gives a bit of pad to reduce window from jumping screen
       if (left < this.constraintPad.left)
-        left = this.constraintPad.left;
+        left = this.constraintPad.left - 10;
       if (left + this.width + this.widthE + this.widthW > width - this.constraintPad.right) 
         left = width - this.constraintPad.right - this.width - this.widthE - this.widthW;
     }

data/lib/window_rails/version.rb

@@ -1,3 +1,3 @@
 module WindowRails
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/window_rails/window_rails_generators.rb

@@ -54,6 +54,10 @@ module WindowRailsGenerators
     self << check_for_window(win, error){ update_window_contents(content, win) }
   end
   
+  # name:: Name of the window
+  # error:: Will throw an alert if window is not found
+  # Checks for a window of the given name. If a block is provided, it will be executed
+  # if the window is found
   def check_for_window(name, error)
     if(name.blank?)
       self <<  "if(Windows.windows.values().size() > 0){"
@@ -65,13 +69,18 @@ module WindowRailsGenerators
     self << "else { alert('Unexpected error. Failed to locate window for output.'); }" if error
   end
   
+  # Simply wraps a block within an else statement
   def else_block
     self << "else {"
     yield if block_given?
     self << "}"
   end
   
-  def update_window_contents(content, win)
+  # content:: String content
+  # win:: Name of window
+  # Updates the contents of the window. If no window name is provided, the topmost window
+  # will be updated
+  def update_window_contents(content, win=nil)
     unless(win.blank?)
       self << "Windows.getWindowByName('#{escape_javascript(win)}').setHTMLContent('#{escape_javascript(content)}');"
     else
@@ -79,7 +88,9 @@ module WindowRailsGenerators
     end
   end
 
-  def focus_window(win)
+  # win:: Name of window
+  # Will focus the window. If no name provided, topmost window will be focused
+  def focus_window(win=nil)
     unless(win.blank?)
       self << "Windows.focus(Windows.getWindowByName('#{escape_javascript(win)}').getId());"
     else
@@ -87,13 +98,27 @@ module WindowRailsGenerators
     end
   end
 
+  # content:: String content
+  # win:: Name of window
+  # options:: Options to be passed onto window
+  # Creates a new window. Generally this should not be called,
+  # rather #open_window should be used
   def create_window(content, win, options)
     self << "var myWin = new Window({#{options.map{|k,v|"#{escape_javascript(k.to_s)}:'#{escape_javascript(v.to_s)}'"}.join(', ')}});"
     self << "Windows.registerByName('#{escape_javascript(win)}', myWin);" unless win.blank?
-    self << "myWin.setHTMLContent('#{escape_javascript(content)}');" unless content.blank?
+    if(content.is_a?(Hash) && content[:url])
+      self << "myWin.setAjaxContent('#{escape_javascript(content[:url])}');"
+    elsif(!content.blank?)
+      self << "myWin.setHTMLContent('#{escape_javascript(content.to_s)}');"
+    end
     self << "myWin.setCloseCallback(function(win){ win.destroy(); return true; });"
   end
   
+  # win:: Name of window
+  # modal:: True if window should be modal
+  # Shows the window centered on the screen. If no window name is provided
+  # it will default to the last created window. Generally this should not
+  # be called, rather #open_window should be used
   def show_window(win, modal)
     s = nil
     unless(win.blank?)
@@ -104,6 +129,10 @@ module WindowRailsGenerators
     self << "#{s}.showCenter(#{modal ? 'true' : 'false'});"
   end
   
+  # win:: Name of window
+  # constraints:: Constaint hash {:left, :right, :top, :bottom}
+  # Sets the constraints on the window. Generally this should not be used,
+  # rather #open_window should be used
   def apply_window_constraints(win, constraints)
     opts = {:left => 0, :right => 0, :top => 0, :bottom => 0}
     opts.merge!(constraints) if constraints.is_a?(Hash)
@@ -118,15 +147,23 @@ module WindowRailsGenerators
   
   # content:: Content for window
   # options:: Hash of options
-  #   * modal -> Window should be modal
-  #   * window -> Name to reference window (used for easy updating and closing)
-  #   * constraints -> Hash containing top,left,right,bottom values for padding from edges. False value will turn off constraints (window can travel out of viewport)
-  #   * url -> URL to load into the window
-  #   * width -> Width of the window
-  #   * height -> Height of the window
-  #   * className -> Theme name for the window
-  #   * no_update -> Set to true to force creation of a new window even if window of same name already exists (defaults to false)
-  # Creates a new window and displays it at the center of the viewport.
+  #   * :modal -> Window should be modal
+  #   * :window -> Name to reference window (used for easy updating and closing)
+  #   * :constraints -> Hash containing top,left,right,bottom values for padding from edges. False value will turn off constraints (window can travel out of viewport)
+  #   * :iframe -> URL to load within an IFrame in the window
+  #   * :width -> Width of the window
+  #   * :height -> Height of the window
+  #   * :className -> Theme name for the window
+  #   * :no_update -> Set to true to force creation of a new window even if window of same name already exists (defaults to false)
+  # Creates a new window and displays it at the center of the viewport. Content can be provided as
+  # a string, or as a Hash. If :url is defined, the window will be loaded with the contents of the request. If not, the hash
+  # will be passed to #render and the string will be displayed.
+  # Important note:
+  #   There are two ways to load remote content. The first is to use :url => 'http://host/page.html' for content. This will
+  #   load the contents directly into the window. The second is to set content to nil and pass :iframe => 'http://host/page.html'
+  #   in the options. This later form will load the contents within an IFrame in the window. This is useful in that it will
+  #   be isolated from the current page, but this isolation means it cannot communicate with other windows on the page (including
+  #   its own).
   def open_window(content, options={})
     modal = options.delete(:modal)
     win = options.delete(:window)
@@ -198,10 +235,16 @@ module WindowRailsGenerators
     end
   end
   
+  # field_id:: DOM ID of form element to observe
+  # options:: Options
+  # Helper for observing fields that have been dynamically loaed into the DOM. Works like
+  # #observe_field but not as full featured. 
   def observe_dynamically_loaded_field(field_id, options={})
     f = options.delete(:function)
     unless(f)
       f = "function(event){ new Ajax.Request('#{escape_javascript(@context.url_for(options[:url]).to_s)}', {asynchronous:true, evalScripts:true,parameters:'#{escape_javascript(options[:with].to_s)}='+$('#{escape_javascript(options[:with].to_s)}').getValue()})}"
+    else
+      f = "function(event){ #{f}; }"
     end
     self << "if($('#{escape_javascript(field_id.to_s)}')){ $('#{escape_javascript(field_id.to_s)}').observe('change', #{f}); }"
   end

data/lib/window_rails/window_rails_view.rb

@@ -1,10 +1,14 @@
 module WindowRailsView
   
   # name:: Name of the link
-  # options:: Hash of optional values. These options are simply passed
-  # on to the activate_window method
+  # options:: Hash of options values.
+  # Creates a link to a window. Content is defined by a url in the options hash using :url or :iframe. 
+  # If :url is used, the content is loaded into the window within the page. If :iframe is used
+  # the content is loaded into the window within an IFrame on the page. Generally, if you are calling
+  # a method that simply renders out a partial, you want to use :url. If you are calling something
+  # that returns an entire page, :iframe will likely be the ticket.
   def link_to_window(name, options={})
-    link_to_remote(name, :url => {:controller => :window_rails, :action => :open_window, :window_url => url_for(options.delete(:url)), :window_options => options})
+    link_to_remote(name, :url => {:controller => :window_rails, :action => :open_window, :window_url => url_for(options.delete(:url)), :iframe_url => url_for(options.delete(:iframe)), :window_options => options})
   end
   
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: window_rails
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Chris Roberts
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-10 00:00:00 -08:00
+date: 2010-12-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,10 +26,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 5
         segments: 
-        - 0
-        version: "0"
+        - 2
+        - 3
+        version: "2.3"
   type: :runtime
   version_requirements: *id001
 description: Windows for Rails