apotomo 0.1.1

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 2.3.8"
+gem "cells", "3.3.4"
+gem "onfire"
+gem "jeweler"
+
+# for test env:
+gem "shoulda"
+gem "mocha"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.8)
+      actionpack (= 2.3.8)
+    actionpack (2.3.8)
+      activesupport (= 2.3.8)
+      rack (~> 1.1.0)
+    activerecord (2.3.8)
+      activesupport (= 2.3.8)
+    activeresource (2.3.8)
+      activesupport (= 2.3.8)
+    activesupport (2.3.8)
+    cells (3.3.4)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    mocha (0.9.8)
+      rake
+    onfire (0.1.0)
+    rack (1.1.0)
+    rails (2.3.8)
+      actionmailer (= 2.3.8)
+      actionpack (= 2.3.8)
+      activerecord (= 2.3.8)
+      activeresource (= 2.3.8)
+      activesupport (= 2.3.8)
+      rake (>= 0.8.3)
+    rake (0.8.7)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cells (= 3.3.4)
+  jeweler
+  mocha
+  onfire
+  rails (~> 2.3.8)
+  shoulda

data/README

@@ -0,0 +1,141 @@
+how does Apotomo handle Ajax and JavaScript?
+framework abstraction with JavascriptGenerator
+
+no manual AJAX-routes for dozens of controllers, one generic route to rule them all
+
+= Apotomo
+
+Apotomo is a stateful widget component framework for Rails.
+
+It is good for you if you
+It is perfect for building AJAXed Rich Client Applications.
+It is suitable for iGoogle-like widgets, dashboards, portals, or even full-blown interactive web apps.
+* Development Teams, where separate teams can work on separate components
+
+== Widgets
+
+=== Widget Trees
+
+
+== Events
+
+=== Event Handlers
+
+== AJAX
+
+== Statefulness vs. Stateless
+
+
+
+A stateful WHAT?
+
+Well, you know that. In Rails, people tend to have fat controllers. One controller action renders the complete page. While many programmers try to separate their code into helpers, controller actions, RJS logic and partials, it is still the controller that has to care about when to update what, and how!
+
+
+In Apotomo, it is the opposite. Widgets are small, autonomous components that look and feel like controllers. These tiny monsters listen to events and thus keep updating themselves on the page via AJAX. However, there's no JavaScript for you - they're pure Ruby.
+
+
+== Man, gimme code!
+
+Let's use the famous and tiresome counter example.
+
+ class CounterCell < Apotomo::StatefulWidget
+   transition :from => :display, :to => :increment
+   
+   def display
+     respond_to_event :counterClick, :with => :increment
+  	  
+     @count = 0
+     render		# renders display.html.erb
+   end
+
+   def increment
+     @count += 1	# @count is simply there - that's stateful.
+     render :view => :display
+   end
+ end
+  
+Since this widget calls <tt>render</tt> it surely needs a view.
+
+ <!-- I'm display.html.erb -->
+  
+ <h1><%= @count %></h1>
+ 
+ <%= link_to_event "Increment me!", :counterClick %>
+
+
+We now plug the widget in a page.
+
+ class ExistingController < ApplicationController
+   include Apotomo::ControllerHelper
+
+   def some_action
+     # do what you want...
+     
+     use_widgets do |root|
+       root << cell(:counter, :display, 'my_first_counter')
+     end
+   end
+ end
+
+As soon as the widget is rendered it will jump to its <tt>:display</tt> state which initializes the counter and renders itself.
+
+Speaking of rendering: how do we place the widget in our controller?
+
+  <!-- I'm some_action.html.erb -->
+  <p>
+  	<%= render_widget 'my_first_counter' %>
+
+Ok, so this renders the widget in our controller page.
+
+When clicking the link it updates automatically on the screen showing the incremented value. Wow.
+
+
+== That's cool!
+Yes, it is.
+
+== Is there more?
+Apotomo got a load of features.
+
+[Composability]     Widgets can range from small standalone components to nested widget trees like dashboards or forms. Remember that each widget can have any number of children.
+  
+[Bubbling events]   Widgets can trigger events and watch out for them. While events bubble up from their triggering source to root they can be observed, providing a way to implement loosely coupled, distributable components.
+  
+[Deep Linking]      Apotomo deals with deep links (or url fragments) out-of-the-box while using SWFAddress. Components that register for deep linking will update as soon as the deep link changes. That makes your application back-button-safe!
+  
+[Testing]           Needless to say that it is simply easier to test small components instead of fat do-it-all controllers.
+
+
+Give it a try- you will love the power and simplicity of real stateful components!
+
+
+== Bugs, Community
+Please visit http://apotomo.de, the official project page with <em>lots</em> of examples.
+Join the mailing list and visit us in the IRC channel. More information is
+here[http://apotomo.de/download].
+
+
+== License
+Copyright (c) 2007-2010 Nick Sutterer <apotonick@gmail.com>
+
+The MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+

data/README.rdoc

@@ -0,0 +1,141 @@
+how does Apotomo handle Ajax and JavaScript?
+framework abstraction with JavascriptGenerator
+
+no manual AJAX-routes for dozens of controllers, one generic route to rule them all
+
+= Apotomo
+
+Apotomo is a stateful widget component framework for Rails.
+
+It is good for you if you
+It is perfect for building AJAXed Rich Client Applications.
+It is suitable for iGoogle-like widgets, dashboards, portals, or even full-blown interactive web apps.
+* Development Teams, where separate teams can work on separate components
+
+== Widgets
+
+=== Widget Trees
+
+
+== Events
+
+=== Event Handlers
+
+== AJAX
+
+== Statefulness vs. Stateless
+
+
+
+A stateful WHAT?
+
+Well, you know that. In Rails, people tend to have fat controllers. One controller action renders the complete page. While many programmers try to separate their code into helpers, controller actions, RJS logic and partials, it is still the controller that has to care about when to update what, and how!
+
+
+In Apotomo, it is the opposite. Widgets are small, autonomous components that look and feel like controllers. These tiny monsters listen to events and thus keep updating themselves on the page via AJAX. However, there's no JavaScript for you - they're pure Ruby.
+
+
+== Man, gimme code!
+
+Let's use the famous and tiresome counter example.
+
+ class CounterCell < Apotomo::StatefulWidget
+   transition :from => :display, :to => :increment
+   
+   def display
+     respond_to_event :counterClick, :with => :increment
+  	  
+     @count = 0
+     render		# renders display.html.erb
+   end
+
+   def increment
+     @count += 1	# @count is simply there - that's stateful.
+     render :view => :display
+   end
+ end
+  
+Since this widget calls <tt>render</tt> it surely needs a view.
+
+ <!-- I'm display.html.erb -->
+  
+ <h1><%= @count %></h1>
+ 
+ <%= link_to_event "Increment me!", :counterClick %>
+
+
+We now plug the widget in a page.
+
+ class ExistingController < ApplicationController
+   include Apotomo::ControllerHelper
+
+   def some_action
+     # do what you want...
+     
+     use_widgets do |root|
+       root << cell(:counter, :display, 'my_first_counter')
+     end
+   end
+ end
+
+As soon as the widget is rendered it will jump to its <tt>:display</tt> state which initializes the counter and renders itself.
+
+Speaking of rendering: how do we place the widget in our controller?
+
+  <!-- I'm some_action.html.erb -->
+  <p>
+  	<%= render_widget 'my_first_counter' %>
+
+Ok, so this renders the widget in our controller page.
+
+When clicking the link it updates automatically on the screen showing the incremented value. Wow.
+
+
+== That's cool!
+Yes, it is.
+
+== Is there more?
+Apotomo got a load of features.
+
+[Composability]     Widgets can range from small standalone components to nested widget trees like dashboards or forms. Remember that each widget can have any number of children.
+  
+[Bubbling events]   Widgets can trigger events and watch out for them. While events bubble up from their triggering source to root they can be observed, providing a way to implement loosely coupled, distributable components.
+  
+[Deep Linking]      Apotomo deals with deep links (or url fragments) out-of-the-box while using SWFAddress. Components that register for deep linking will update as soon as the deep link changes. That makes your application back-button-safe!
+  
+[Testing]           Needless to say that it is simply easier to test small components instead of fat do-it-all controllers.
+
+
+Give it a try- you will love the power and simplicity of real stateful components!
+
+
+== Bugs, Community
+Please visit http://apotomo.de, the official project page with <em>lots</em> of examples.
+Join the mailing list and visit us in the IRC channel. More information is
+here[http://apotomo.de/download].
+
+
+== License
+Copyright (c) 2007-2010 Nick Sutterer <apotonick@gmail.com>
+
+The MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+

data/Rakefile

@@ -0,0 +1,78 @@
+require "rubygems"
+require "bundler"
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the Apotomo plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+namespace 'rdoc' do
+	desc 'Generate documentation for Apotomo.'
+	Rake::RDocTask.new(:build) do |rdoc|
+		rdoc.rdoc_dir = 'rdoc'
+		rdoc.title    = 'Apotomo API'
+		rdoc.options << '--line-numbers' << '--inline-source' << '-m README'
+		
+		rdoc.rdoc_files.include('lib/**/*.rb')
+		rdoc.rdoc_files.include('app/**/*.rb')
+		rdoc.rdoc_files.include('test/*.rb')
+		rdoc.rdoc_files.include('README')
+	end
+	
+	desc 'Upload the rdocs to apotomo.rubyforge.org.'
+	task :upload do
+		sh %{ scp -r rdoc nix@rubyforge.org:/var/www/gforge-projects/apotomo/ }
+	end
+end
+
+# Gem managment tasks.
+#
+# == Bump gem version (any):
+#
+#   rake version:bump:major
+#   rake version:bump:minor
+#   rake version:bump:patch
+#
+# == Generate gemspec, build & install locally:
+#
+#   rake gemspec
+#   rake build
+#   sudo rake install
+#
+# == Git tag & push to origin/master
+#
+#   rake release
+#
+# == Release to Gemcutter.org:
+#
+#   rake gemcutter:release
+#
+require 'jeweler'
+require 'lib/apotomo/version'
+
+Jeweler::Tasks.new do |spec|
+  spec.name         = "apotomo"
+  spec.version      = ::Apotomo::VERSION
+  spec.summary      = %{Event-driven Widgets for Rails with optional Statefulness.}
+  spec.description  = "A generic widget framework for Rails. Event-driven. Clean. Fast. Free optional statefulness included."
+  spec.homepage     = "http://apotomo.de"
+  spec.authors      = ["Nick Sutterer"]
+  spec.email        = "apotonick@gmail.com"
+
+  spec.files = FileList["[A-Z]*", File.join(*%w[{generators,lib,rails,app,config} ** *]).to_s]
+  
+  spec.add_dependency 'cells', '~> 3.3'
+  spec.add_dependency 'activesupport', '>= 2.3.0'
+  spec.add_dependency 'onfire', '>= 0.1.0'
+end
+
+Jeweler::GemcutterTasks.new

data/TODO

@@ -0,0 +1,36 @@
+Testing
+-------
+- provide something like #assert_transition to test if FSM goes where we want
+- assert_update/assert_execute, to assert which components are updated (e.g. after
+  event chain)
+
+State Machine
+-------------
+- better debug-output for transitions
+- make #transition_map friendly, maybe some more sophisticated DSL
+
+Parameter
+---------
+- introduce #my_param or something similar so widgets can only access parameters really 
+  addressed to them. or let #param do this per default.
+
+Persistence
+-----------
+- only save id of ActiveRecords, to avoid big sessions (discuss whether this is necessary)
+- provide session storage alternatives, like encoding in url or hidden field
+- introduce a rake task to clear the frozen tree
+
+Events
+------
+- only send back the newer EventHandler content when more than one event was triggered
+  and the content of an earlier EventHandler is overridden.
+- provide scrambling of the event url, so users can not trigger events out of scope
+- check if an EventHandler is executed in scope, meaning the triggering event was valid.
+
+Apotobug
+--------
+- return exception reports as text, not HTML, for better reading in Firebug.
+
+StatefulWidget
+--------------
+- provide an ordered list of rendered child views.