window_rails 0.2.10 → 0.2.11

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== v0.2.11
+* Provides windowing methods to ActionView::Base for JS templates
+* Removes deprecated rake tasks
+
 == v0.2.10
 * Fixes close window bug
 

data/LICENSE

@@ -1,6 +1,6 @@
 Current WindowRails License:
 
-Copyright (c) 2011 Chris Roberts <chrisroberts.code@gmail.com>
+Copyright (c) 2012 Chris Roberts <chrisroberts.code@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -4,7 +4,7 @@ WindowRails is a plugin for Rails that provides easy to use AJAXy windows. It is
 completely on {jQueryUI}[http://jquery-ui.com] with helpers for Rails to make it easy to 
 use from a Rails app.
 
-WindowRails is now happily compatible with Rails 2 and Rails 3.
+WindowRails is now happily compatible with Rails 2 and Rails 3 (and now 3.1).
 
 == Requirements
 
@@ -13,7 +13,9 @@ WindowRails is now happily compatible with Rails 2 and Rails 3.
 
 == Installation
 
-  rake window_rails:install
+Add window_rails to your application Gemfile:
+
+  gem 'window_rails'
 
 === Basic examples to get you started
 
@@ -42,20 +44,24 @@ WindowRails is now happily compatible with Rails 2 and Rails 3.
     end
   end
 
-==== Linking to a window
-===== Load an entire HTML page into an IFrame
-  <%= link_to_window('Link', :iframe => {:controller => :my_controller, :action => :my_action}, :window => 'some_name') %>
-
-With this approach the contents of the HTML respond to block will be loaded into the window
+  # or via JS template:
+  # app/views/my_resources/action.js.erb
 
-===== Load a partial page directly into the DOM within the window
-  <%= link_to_window('Link', :url => {:controller => :my_controller, :action => :my_action}, :width => 400, :height => 300, :window => 'some_name') %>
-
-With this approach the content returned from the JS respond to block will be loaded into the window. No need for
-requesting the window to be created from the controller.
+  <%=
+    open_window(
+      {:partial => 'action_partial'},
+      :width => 400,
+      :height => 500,
+      :title => 'My Window',
+      :window => 'unique_window_name'
+    )
+  %>
 
 == Window Interactions
 
+Examples are shown using the old generator style. For rails 3.1 and beyond, the methods should be defined
+within the JS views
+
 ==== Opening a window via AJAX
   def open_my_window
     respond_to do |format|

data/lib/window_rails.rb

@@ -3,7 +3,10 @@ require 'window_rails/version'
 if(defined?(Rails::Engine))
   require 'window_rails/engine'
 else
-  %w(window_rails_generators window_rails_view).each do |part|
+  if(defined?(ActionView::Helpers::PrototypeHelper::JavaScriptGenerator::GeneratorMethods))
+    require 'window_rails/window_rails_generators'
+  end
+  %w(window_rails_windows window_rails_view).each do |part|
     require "window_rails/#{part}"
   end
 end

data/lib/window_rails/engine.rb

@@ -1,13 +1,12 @@
 module WindowRails
   class Engine < Rails::Engine
-    
-    rake_tasks do
-      require 'window_rails/tasks'
-    end
 
     # We do all our setup in here
     config.to_prepare do
-      %w(window_rails_generators window_rails_view).each do |part|
+      if(defined?(ActionView::Helpers::PrototypeHelper::JavaScriptGenerator::GeneratorMethods))
+        require 'window_rails/window_rails_generators'
+      end
+      %w(window_rails_windows window_rails_view).each do |part|
         require "window_rails/#{part}"
       end
     end

data/lib/window_rails/version.rb

@@ -13,5 +13,5 @@ module WindowRails
     end
   end
 
-  VERSION = Version.new('0.2.10')
+  VERSION = Version.new('0.2.11')
 end

data/lib/window_rails/window_rails_generators.rb

@@ -91,7 +91,7 @@ module WindowRailsGenerators
   end
 
   def window_setup
-    @set ||= false
+    @_window_rails_setup ||= false
     unless(@set)
       self << '
         if(typeof(window.window_rails_windows) == "undefined") {
@@ -101,7 +101,7 @@ module WindowRailsGenerators
         }
         '
     end
-    @set = true
+    @_window_rails_setup = true
     nil
   end
 
@@ -131,6 +131,7 @@ module WindowRailsGenerators
   # result will be placed in the window (basically an easy way to integrate partials:
   # page.update_window(:partial => 'my_parital'))
   def update_window(content, options={})
+    window_setup
     win = options.delete(:window)
     error = options.delete(:error)
     key = store_content(content)
@@ -228,6 +229,7 @@ module WindowRailsGenerators
   # so we aren't storing worthless junk:
   # window.window_rails_windows_array.splice(window.window_rails_windows_array.indexOf('#{win}'), 1);
   def create_window(key, win, options)
+    window_setup
     options[:auto_open] ||= false
     options[:close] = "function(event,ui){ 
       #{
@@ -313,6 +315,7 @@ module WindowRailsGenerators
   #   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={})
+    window_setup
     key = nil
     if(options[:iframe])
       iframe = @context.url_for(options.delete(:iframe))

data/lib/window_rails/window_rails_view.rb

@@ -24,7 +24,7 @@ module WindowRailsView
   # options:: Options hash supplied to windowing system
   # Extra options include :method and :delay. :delay is the number
   # of seconds to wait after page load to open window
-  def open_window(options={})
+  def open_window_deprecated(options={})
     frame_url = options.has_key?(:iframe) ? url_for(options.delete(:iframe)) : nil
     window_url = options.has_key?(:url) ? url_for(options.delete(:url)) : nil
     method = options.delete(:method) || 'get'

data/lib/window_rails/window_rails_windows.rb

@@ -0,0 +1,45 @@
+module WindowRails
+  class Holder
+    include WindowRailsGenerators
+
+    attr_accessor :context
+
+    def initialize(args={})
+      @context = args[:context]
+      @buffer = ''
+    end
+
+    def << (string)
+      @buffer << string.to_s
+    end
+
+    def window_flush
+      buf = @buffer.dup
+      @buffer = ''
+      buf
+    end
+  end
+end
+
+module WindowRails
+  module Windows
+    def self.included(base)
+      WindowRailsGenerators.instance_methods(false).each do |method|
+        base.class_eval do
+          def _window_rails_holder 
+            @_window_rails_holder ||= WindowRails::Holder.new
+          end
+
+          define_method method do |*args|
+            _window_rails_holder.context = self
+            _window_rails_holder.send(method, *args)
+            _window_rails_holder.window_flush.html_safe
+          end
+        end
+      end
+
+    end
+  end
+end
+
+ActionView::Base.send(:include, WindowRails::Windows)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: window_rails
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 2
-  - 10
-  version: 0.2.10
+  - 11
+  version: 0.2.11
 platform: ruby
 authors: 
 - Chris Roberts
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-22 00:00:00 -08:00
+date: 2012-02-10 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,7 +66,7 @@ files:
 - lib/window_rails.rb
 - lib/window_rails/engine.rb
 - lib/window_rails/window_rails_view.rb
-- lib/window_rails/tasks.rb
+- lib/window_rails/window_rails_windows.rb
 - lib/window_rails/window_rails_generators.rb
 - lib/window_rails/version.rb
 - rails/init.rb

data/lib/window_rails/tasks.rb

@@ -1,69 +0,0 @@
-require 'fileutils'
-
-namespace :window_rails  do
-
-  desc 'Install window_rails'
-  task :install do
-    FileUtils.mkdir_p(File.join(Rails.root, 'public', 'window_rails'))
-    Rake::Task['window_rails:install_javascripts'].invoke
-    Rake::Task['window_rails:install_stylesheets'].invoke
-    Rake::Task['window_rails:install_assets'].invoke
-    Rake::Task['window_rails:install_version'].invoke
-    puts '*' * 50
-    puts 'WindowRails installation is complete.'
-    puts 'NOTE: Please refer to README file for any additional setup.'
-    puts '*' * 50
-  end
-
-  task :upgrade do
-    Rake::Task['window_rails:install_javascripts'].invoke
-    Rake::Task['window_rails:install_stylesheets'].invoke
-    Rake::Task['window_rails:install_assets'].invoke
-    puts 'WindowRails files have been updated to most current version'
-  end
-
-  task :install_javascripts do
-    install_items('javascripts')
-  end
-
-  task :install_stylesheets do
-    install_items('stylesheets')
-  end
-
-  task :install_assets do
-    install_items('images')
-  end
-
-  task :install_version do
-    f = File.open(File.join(Rails.root, 'public', 'window_rails', 'version'), 'w')
-    f.write WindowRails::VERSION
-    f.close
-    puts 'Version file written'
-  end
-
-  desc 'Output current version information'
-  task :version do
-    asset_version = nil
-    if(File.exists?(File.join(Rails.root, 'public', 'window_rails', 'version')))
-      asset_version = File.read(File.join(Rails.root, 'public', 'window_rails', 'version')).strip
-    end
-    puts "Current WindowRails version: #{WindowRails::VERSION}"
-    puts "Current WindowRails assets version: #{asset_version}"
-    if(WindowRails::VERSION != asset_version.to_s)
-      puts "WARNING #{'*' * 50}"
-      puts 'WindowRails assets within project are out of date'
-      puts 'Please run: rake window_rails:upgrade'
-      puts "WARNING #{'*' * 50}"
-    end
-  end
-end
-
-def install_items(item)
-  FileUtils.mkdir_p(File.join(Rails.root, 'public', 'window_rails', item))
-  FileUtils.cp_r(
-    File.join(File.dirname(__FILE__), '..', '..', 'files', item, File::SEPARATOR, '.'), 
-    File.join(Rails.root, 'public', 'window_rails', item)
-  )
-  puts "#{item.titleize} files installed."
-end
-