RubyGems - apotomo - Versions diffs - 0.1.1 - Mend

apotomo 0.1.1

Files changed (74) hide show

data/Gemfile +10 -0
data/Gemfile.lock +47 -0
data/README +141 -0
data/README.rdoc +141 -0
data/Rakefile +78 -0
data/TODO +36 -0
data/app/cells/apotomo/child_switch_widget/switch.html.erb +1 -0
data/app/cells/apotomo/child_switch_widget/switch.rhtml +1 -0
data/app/cells/apotomo/deep_link_widget.rb +27 -0
data/app/cells/apotomo/deep_link_widget/setup.html.erb +20 -0
data/app/cells/apotomo/java_script_widget.rb +12 -0
data/app/cells/apotomo/tab_panel_widget.rb +87 -0
data/app/cells/apotomo/tab_panel_widget/display.html.erb +57 -0
data/app/cells/apotomo/tab_widget.rb +18 -0
data/app/cells/apotomo/tab_widget/display.html.erb +1 -0
data/config/routes.rb +3 -0
data/generators/widget/USAGE +15 -0
data/generators/widget/templates/functional_test.rb +8 -0
data/generators/widget/templates/view.html.erb +2 -0
data/generators/widget/templates/view.html.haml +3 -0
data/generators/widget/templates/widget.rb +8 -0
data/generators/widget/widget_generator.rb +34 -0
data/lib/apotomo.rb +59 -0
data/lib/apotomo/caching.rb +37 -0
data/lib/apotomo/container_widget.rb +10 -0
data/lib/apotomo/deep_link_methods.rb +90 -0
data/lib/apotomo/event.rb +9 -0
data/lib/apotomo/event_handler.rb +23 -0
data/lib/apotomo/event_methods.rb +102 -0
data/lib/apotomo/invoke_event_handler.rb +24 -0
data/lib/apotomo/javascript_generator.rb +57 -0
data/lib/apotomo/persistence.rb +139 -0
data/lib/apotomo/proc_event_handler.rb +18 -0
data/lib/apotomo/rails/controller_methods.rb +161 -0
data/lib/apotomo/rails/view_helper.rb +95 -0
data/lib/apotomo/rails/view_methods.rb +7 -0
data/lib/apotomo/request_processor.rb +92 -0
data/lib/apotomo/stateful_widget.rb +8 -0
data/lib/apotomo/transition.rb +46 -0
data/lib/apotomo/tree_node.rb +186 -0
data/lib/apotomo/version.rb +5 -0
data/lib/apotomo/widget.rb +289 -0
data/lib/apotomo/widget_shortcuts.rb +36 -0
data/rails/init.rb +0 -0
data/test/fixtures/application_widget_tree.rb +2 -0
data/test/rails/controller_methods_test.rb +206 -0
data/test/rails/rails_integration_test.rb +99 -0
data/test/rails/view_helper_test.rb +77 -0
data/test/rails/view_methods_test.rb +40 -0
data/test/rails/widget_generator_test.rb +47 -0
data/test/support/assertions_helper.rb +13 -0
data/test/support/test_case_methods.rb +68 -0
data/test/test_helper.rb +77 -0
data/test/unit/apotomo_test.rb +20 -0
data/test/unit/container_test.rb +20 -0
data/test/unit/event_handler_test.rb +67 -0
data/test/unit/event_methods_test.rb +83 -0
data/test/unit/event_test.rb +30 -0
data/test/unit/invoke_test.rb +123 -0
data/test/unit/javascript_generator_test.rb +90 -0
data/test/unit/onfire_integration_test.rb +19 -0
data/test/unit/persistence_test.rb +240 -0
data/test/unit/render_test.rb +203 -0
data/test/unit/request_processor_test.rb +178 -0
data/test/unit/stateful_widget_test.rb +135 -0
data/test/unit/test_addressing.rb +111 -0
data/test/unit/test_caching.rb +54 -0
data/test/unit/test_jump_to_state.rb +89 -0
data/test/unit/test_tab_panel.rb +72 -0
data/test/unit/test_widget_shortcuts.rb +45 -0
data/test/unit/transition_test.rb +33 -0
data/test/unit/widget_shortcuts_test.rb +68 -0
data/test/unit/widget_test.rb +24 -0
metadata +215 -0

data/test/rails/rails_integration_test.rb ADDED Viewed

@@ -0,0 +1,99 @@
+require File.join(File.dirname(__FILE__), %w(.. test_helper))
+class RailsIntegrationTest < ActionController::TestCase
+  def simulate_request!
+    @controller.instance_eval { @apotomo_request_processor = nil }
+    @controller.session = Marshal.load(Marshal.dump(@controller.session))
+  end
+  context "A Rails controller" do
+    setup do
+      @controller = ApotomoController.new
+      @controller.session = {}
+      @controller.params  = {}
+      #@mum = mouse_mock('mum', 'snuggle') { def snuggle; render; end }
+      @mum = MouseCell.new('mum', :snuggle)
+      @mum.instance_eval{ def snuggle; render; end }
+      @controller.instance_variable_set(:@mum, @mum)
+      @controller.instance_eval do
+        def widget
+          use_widgets do |root|
+            root << @mum
+          end
+          render :text => render_widget('mum')
+        end
+      end
+    end
+    should "freeze the widget tree once after each request" do
+      assert_equal 0, @controller.session.size
+      get 'widget'
+      assert_equal 1, @controller.session[:apotomo_stateful_branches].size
+    end
+    should "invoke a #use_widgets block only once per session" do
+      #assert_equal 1, @controller.apotomo_root.size
+      get 'widget'
+      assert_response :success
+      assert_equal 1, @controller.session[:apotomo_stateful_branches].size
+      simulate_request!
+      get 'widget'
+      assert_equal 1, @controller.session[:apotomo_stateful_branches].size
+      assert_response :success
+      simulate_request!
+      get 'widget'
+      assert_response :success
+      assert_equal 2, @controller.apotomo_root.size, "mum added multiple times"
+    end
+    should "provide the rails view helpers in state views" do
+      @mum.instance_eval do
+        def snuggle; render :view => :make_me_squeak; end
+      end
+      get 'widget'
+      assert_select "a", "Squeak!"
+    end
+    should "contain a freshly flushed tree when ?flush_widgets=1 is set" do
+      get 'widget'
+      assert_response :success
+      assert @controller.apotomo_request_processor.widgets_flushed?
+      simulate_request!
+      get 'widget'
+      assert_response :success
+      assert_not @controller.apotomo_request_processor.widgets_flushed?
+      simulate_request!
+      get 'widget', :flush_widgets => 1
+      assert_response :success  # will fail if no #use_widgets block invoked
+      assert @controller.apotomo_request_processor.widgets_flushed?
+    end
+    should "render updates to the parent window for an iframe request" do
+      get 'widget'
+      assert_response :success
+      @controller.apotomo_root['mum'].respond_to_event :squeak, :with => :snuggle
+      simulate_request!
+      get 'render_event_response', :source => 'mum', :type => :squeak, :apotomo_iframe => true
+      assert_response :success
+      assert_equal 'text/html', @response.content_type
+      assert_equal "<html><body><script type='text/javascript' charset='utf-8'>\nvar loc = document.location;\nwith(window.parent) { setTimeout(function() { window.eval('<div id=\\\"mum\\\"><snuggle><\\/snuggle><\\/div>'); window.loc && loc.replace('about:blank'); }, 1) }\n</script></body></html>", @response.body
+    end
+  end
+end

data/test/rails/view_helper_test.rb ADDED Viewed

@@ -0,0 +1,77 @@
+require File.join(File.dirname(__FILE__), *%w[.. test_helper])
+require 'action_view/test_case'
+class ViewHelperTest < ActionView::TestCase
+  tests Apotomo::Rails::ViewHelper
+  context "A widget state view" do
+    setup do
+      barn_controller!
+      @cell = mouse_mock('mum')
+    end
+    teardown do
+      Apotomo.js_framework = :prototype
+    end
+    should "respond to #link_to_event" do
+      assert_dom_equal "<a href=\"#\" onclick=\"new Ajax.Request('/barn/render_event_response?source=mum&amp;type=footsteps', {asynchronous:true, evalScripts:true}); return false;\">Walk!</a>",
+      link_to_event("Walk!", :footsteps)
+    end
+    should "respond to #form_to_event" do
+      assert_dom_equal "<form onsubmit=\"new Ajax.Request('/barn/render_event_response?source=mum&amp;type=footsteps', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;\" method=\"post\" action=\"/barn/render_event_response?source=mum&amp;type=footsteps\">",
+      form_to_event(:footsteps)
+    end
+    should "respond to #multipart_form_to_event" do
+      assert_dom_equal "<iframe name=\"apotomo_iframe\" id=\"apotomo_iframe\" style=\"display: none;\"></iframe><form enctype=\"multipart/form-data\" method=\"post\" action=\"/barn/render_event_response?apotomo_iframe=true&amp;source=mum&amp;type=footsteps\" target=\"apotomo_iframe\">",
+      multipart_form_to_event(:footsteps)
+    end
+    should "render multipart form if :multipart => true" do
+      assert_dom_equal "<iframe name=\"apotomo_iframe\" id=\"apotomo_iframe\" style=\"display: none;\"></iframe><form enctype=\"multipart/form-data\" method=\"post\" action=\"/barn/render_event_response?apotomo_iframe=true&amp;source=mum&amp;type=footsteps\" target=\"apotomo_iframe\">",
+      form_to_event(:footsteps, :multipart => true)
+    end
+    should "respond to #trigger_event" do
+      assert_dom_equal "new Ajax.Request(\"/barn/render_event_response?source=mum&type=footsteps\")",
+      trigger_event(:footsteps)
+    end
+    should "render RightJS if set" do
+      Apotomo.js_framework = :right
+      assert_dom_equal "new Xhr(\"/barn/render_event_response?source=mum&type=footsteps\", {evalScripts:true}).send()", trigger_event(:footsteps)
+    end
+    should "respond to #url_for_event" do
+      assert_equal("/barn/render_event_response?source=mum&type=footsteps", url_for_event(:footsteps))
+    end
+    should "respond to #widget_div" do
+      assert_equal '<div class="widget" id="mum">squeak!</div>', widget_div { "squeak!" }
+    end
+    context "#widget_javascript" do
+      should "usually render a javascript block" do
+        assert_equal "<script type=\"text/javascript\">\n//<![CDATA[\nalert(\"Beer!\")\n//]]>\n</script>", widget_javascript { 'alert("Beer!")' }
+      end
+      should "be quiet if suppress_js is set" do
+        @suppress_js = true ### TODO: use a local, not an instance variable.
+        assert_equal nil, widget_javascript { 'alert("Beer!")' }
+      end
+      should_eventually "capture" do
+      puts "capturing"
+        v = ActionView::Base.new
+        c = v.capture do "capture me!" end
+        puts c.inspect
+      end
+    end
+  end
+end

data/test/rails/view_methods_test.rb ADDED Viewed

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), *%w[.. test_helper])
+class ViewMethodsTest < ActionController::TestCase
+  context "A Rails controller view" do
+    setup do
+      @controller = ApotomoController.new
+      @controller.extend Apotomo::Rails::ControllerMethods
+      @controller.session = {}
+      @controller.instance_variable_set(:@mum, mouse_mock('mum', 'snuggle') {def snuggle; render; end})
+      @controller.instance_eval do
+        def widget
+          use_widgets do |root|
+            root << @mum
+          end
+          render :inline => "<%= render_widget 'mum' %>"
+        end
+      end
+    end
+    should "respond to render_widget" do
+      get :widget
+      assert_select "#mum>snuggle"
+    end
+    should "respond to url_for_event" do
+      @controller.instance_eval do
+        def widget
+          use_widgets do |root|
+            root << @mum
+          end
+          render :inline => "<%= url_for_event :footsteps, :source => 'mum' %>"
+        end
+      end
+      get :widget
+      assert_equal "/apotomo/render_event_response?source=mum&type=footsteps", @response.body
+    end
+  end
+end

data/test/rails/widget_generator_test.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), %w(.. test_helper))
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+Rails::Generator::Base.append_sources Rails::Generator::PathSource.new(:apotomo, File.join(File.dirname(__FILE__)+'/../../generators'))
+class WidgetGeneratorTest < Test::Unit::TestCase
+  context "Running script/generate widget" do
+    setup do
+      FileUtils.mkdir_p(fake_rails_root)
+      @original_files = file_list
+    end
+    teardown do
+      FileUtils.rm_r(fake_rails_root)
+    end
+    context "MouseWidget squeak snuggle" do
+      should "create the standard assets" do
+        Rails::Generator::Scripts::Generate.new.run(%w(widget MouseWidget squeak snuggle), :destination => fake_rails_root)
+        files = (file_list - @original_files)
+        assert files.include?(fake_rails_root+"/app/cells/mouse_widget.rb")
+        assert files.include?(fake_rails_root+"/app/cells/mouse_widget/squeak.html.erb")
+        assert files.include?(fake_rails_root+"/app/cells/mouse_widget/snuggle.html.erb")
+        assert files.include?(fake_rails_root+"/test/widgets/mouse_widget_test.rb")
+      end
+      should "create haml assets with --haml" do
+        Rails::Generator::Scripts::Generate.new.run(%w(widget MouseWidget squeak snuggle --haml), :destination => fake_rails_root)
+        files = (file_list - @original_files)
+        assert files.include?(fake_rails_root+"/app/cells/mouse_widget.rb")
+        assert files.include?(fake_rails_root+"/app/cells/mouse_widget/squeak.html.haml")
+        assert files.include?(fake_rails_root+"/app/cells/mouse_widget/snuggle.html.haml")
+        assert files.include?(fake_rails_root+"/test/widgets/mouse_widget_test.rb")
+      end
+    end
+  end
+  private
+  def fake_rails_root
+    File.join(File.dirname(__FILE__), 'rails_root')
+  end
+  def file_list
+    Dir.glob(File.join(fake_rails_root, "**/*"))
+  end
+end

data/test/support/assertions_helper.rb ADDED Viewed

@@ -0,0 +1,13 @@
+# encoding: utf-8
+module Apotomo
+  module AssertionsHelper
+    def assert_selekt(content, *args)
+      assert_select(HTML::Document.new(content).root, *args)
+    end
+    def assert_not(assertion)
+      assert !assertion
+    end
+  end
+end

data/test/support/test_case_methods.rb ADDED Viewed

@@ -0,0 +1,68 @@
+module Apotomo
+  module TestCaseMethods
+    # Provides a ready-to-use mouse widget instance.
+    def mouse_mock(id='mouse', start_state=:eating, opts={}, &block)
+      #mouse = mouse_class_mock.new(id, start_state, opts)
+      mouse = MouseCell.new(id, start_state, opts)
+      mouse.instance_eval &block if block_given?
+      mouse.controller = @controller
+      mouse
+    end
+    def mouse_class_mock(&block)
+      klass = Class.new(MouseCell)
+      klass.instance_eval &block if block_given?
+      klass
+    end
+    def mum_and_kid!
+      @mum = mouse_mock('mum', :answer_squeak)
+        @mum << @kid = mouse_mock('kid', :peek)
+      @mum.respond_to_event :squeak, :with => :answer_squeak
+      @mum.respond_to_event :squeak, :from => 'kid', :with => :alert
+      @mum.respond_to_event :footsteps, :with => :escape
+      @kid.respond_to_event :footsteps, :with => :peek
+      @mum.instance_eval do
+        def list; @list ||= []; end
+        def answer_squeak;  self.list << 'answer squeak'; render :text => "squeak", :render_children => false; end
+        def alert;          self.list << 'be alerted';    render :text => "alert!", :render_children => false; end
+        def escape;         self.list << 'escape';        render :text => "escape", :render_children => false; end
+      end
+      @kid.instance_eval do
+        def peek;           root.list << 'peek'; render :text => "" end
+      end
+      @mum
+    end
+    def barn_controller!
+      @controller = Class.new(ActionController::Base) do
+        def self.default_url_options; {:controller => :barn}; end
+      end.new
+      @controller.class.instance_eval { include Apotomo::Rails::ControllerMethods }
+      @controller.extend ActionController::UrlWriter
+      @controller.params  = {}
+      @controller.session = {}
+    end
+    def hibernate_widget(widget, session = {})
+      widget.freeze_to(session)
+      session = Marshal.load(Marshal.dump(session))
+      Apotomo::StatefulWidget.thaw_from(session)
+    end
+    def hibernate(widget, session = {})
+      Apotomo::StatefulWidget.freeze_for(session, widget)
+      session = Marshal.load(Marshal.dump(session))
+      Apotomo::StatefulWidget.thaw_for(session, widget('apotomo/widget', 'root'))
+    end
+  end
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,77 @@
+# wycats says...
+require 'bundler'
+Bundler.setup
+#require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require 'mocha/integration'
+require 'cells'
+Cell::Base.add_view_path File.expand_path(File.dirname(__FILE__) + "/fixtures")
+puts Cell::Base.view_paths
+require 'apotomo'
+require 'apotomo/widget_shortcuts'
+require 'apotomo/rails/controller_methods'
+require 'apotomo/rails/view_methods'
+#require 'apotomo/assertions_helper'
+# Load test support files.
+Dir[File.join(File.dirname(__FILE__), *%w[support ** *.rb]).to_s].each { |f| require f }
+Test::Unit::TestCase.class_eval do
+  include Apotomo::WidgetShortcuts
+  include Apotomo::TestCaseMethods
+  include Apotomo::AssertionsHelper
+  def setup
+    @controller = ApotomoController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @controller.request   = @request
+    @controller.response  = @response
+    @controller.params    = {}
+    @controller.session   = @session = {}
+  end
+end
+class ApotomoController < ActionController::Base
+  include Apotomo::Rails::ControllerMethods
+end
+class MouseCell < Apotomo::StatefulWidget
+  def eating; render; end
+end
+class RenderingTestCell < Apotomo::StatefulWidget
+  attr_reader :brain
+  attr_reader :rendered_children
+  def jump
+    jump_to_state :check_state
+  end
+end
+# We need to setup a fake route for the controller tests.
+ActionController::Routing::Routes.draw do |map|
+  map.connect 'apotomo/:action', :controller => 'apotomo'
+  map.connect 'barn/:action', :controller => 'barn'
+end
+require File.join(File.dirname(__FILE__), '..', 'config/routes.rb') ### TODO: let rails engine handle that.
+module ::Rails
+  def logger(*args); end
+end

data/test/unit/apotomo_test.rb ADDED Viewed

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../test_helper'
+class ApotomoTest < Test::Unit::TestCase
+  context "The main module" do
+    should "save the JavascriptGenerator instance when setting js_framework" do
+      Apotomo.js_framework = :jquery
+      assert_respond_to Apotomo.js_generator, :jquery
+    end
+    should "have an accessor for js_framework" do
+      Apotomo.js_framework = :jquery
+      assert_equal :jquery, Apotomo.js_framework
+    end
+    should "have a setup method" do
+      Apotomo.setup { |config| config.js_framework = :prototype }
+      assert_respond_to Apotomo.js_generator, :prototype
+    end
+  end
+end