apotomo 0.1.4 → 1.0.0.beta1

data/Gemfile

@@ -1,11 +1,14 @@
 source "http://rubygems.org"
 
-gem "rails", "~> 2.3.8"
-gem "cells", "3.3.4"
+gem "rails", "~> 3.0.0"
+gem "cells", :path => "/home/nick/projects/cells"#"3.4.1"
 gem "onfire"
 gem "hooks", "~> 0.1.2"
+
+
 gem "jeweler"
 
 # for test env:
 gem "shoulda"
 gem "mocha"
+gem 'sqlite3-ruby', '1.2.5', :require => 'sqlite3'	# needed in router_test, whatever.

data/Gemfile.lock

@@ -1,49 +1,98 @@
+PATH
+  remote: /home/nick/projects/cells
+  specs:
+    cells (3.4.2)
+
 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)
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
     gemcutter (0.6.1)
     git (1.2.5)
     hooks (0.1.2)
+    i18n (0.4.1)
     jeweler (1.4.0)
       gemcutter (>= 0.1.0)
       git (>= 1.2.5)
       rubyforge (>= 2.0.0)
     json_pure (1.4.6)
+    mail (2.2.6.1)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
     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)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
     rake (0.8.7)
     rubyforge (2.0.4)
       json_pure (>= 1.1.7)
     shoulda (2.11.3)
+    sqlite3-ruby (1.2.5)
+    thor (0.14.3)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  cells (= 3.3.4)
+  cells!
   hooks (~> 0.1.2)
   jeweler
   mocha
   onfire
-  rails (~> 2.3.8)
+  rails (~> 3.0.0)
   shoulda
+  sqlite3-ruby (= 1.2.5)

data/Rakefile

@@ -11,9 +11,9 @@ desc 'Default: run unit tests.'
 task :default => :test
 
 desc 'Test the Apotomo plugin.'
-Rake::TestTask.new(:test) do |t|
+  Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.test_files = FileList['test/unit/*_test.rb', 'test/rails/*_test.rb']# - ['test/rails/capture_test.rb']
   t.verbose = true
 end
 
@@ -24,16 +24,16 @@ require '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.summary      = %{Web components for Rails.}
+  spec.description  = "Web components 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["app/.jeweler_doesnt_like_empty_directories", "[A-Z]*", File.join(*%w[{generators,lib,rails,app,config} ** *]).to_s]
+  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 'cells', '~> 3.4.2'
+  spec.add_dependency 'rails', '>= 3.0.0'
   spec.add_dependency 'onfire', '>= 0.1.0'
   spec.add_dependency 'hooks', '~> 0.1.2'
 end

data/config/routes.rb

@@ -1,3 +1,3 @@
-ActionController::Routing::Routes.draw do |map|
-  map.apotomo_event ':controller/render_event_response', :action => 'render_event_response'
-end
+Rails.application.routes.draw do |map|
+  match ":controller/render_event_response", :to => "#render_event_response", :as => "apotomo_event"
+end

data/lib/apotomo/persistence.rb

@@ -42,59 +42,29 @@ module Apotomo
     end
     
     
-    # Serializes the widget node structure (not children, not content).
-    def dump_node
-      field_sep = self.class.field_sep
-      "#{@name}#{field_sep}#{self.class}#{field_sep}#{root? ? @name : parent.name}"
+    def dump_tree
+      collect  { |n|  [n.class, n.name, n.root? ? nil : n.parent.name] }
     end
     
-    # Serializes the tree structure.
-    def _dump(depth)
-      inject("") { |str, node| str << node.dump_node << self.class.node_sep }
-    end
     
     module ClassMethods
-      def field_sep;  '|';  end
-      def node_sep;   "\n"; end
-      
-      # Creates an empty widget instance from <tt>line</tt>.
-      def load_node(line)
-        name, klass, parent = line.split(field_sep)
-        [klass.constantize.new(name, nil), parent]
-      end
-      
-      def _load(str)
-        nodes = {}
-        root  = nil
-        str.split(node_sep).each do |line|
-          node, parent = load_node(line)
-          nodes[node.name] = node
-          
-          if node.name == parent # we're at the root node.
-            root = node and next
-          end
-          
-          nodes[parent].add(node)
-        end
-        root
-      end
-      
+      # Dump the shit to storage.
       def freeze_for(storage, root)
         storage[:apotomo_stateful_branches] = []
         storage[:apotomo_widget_ivars]      = {}
         
         stateful_branches_for(root).each do |branch|
           branch.freeze_data_to(storage[:apotomo_widget_ivars])  # save ivars.
-          storage[:apotomo_stateful_branches] << [branch, branch.parent.name]
-          branch.root!  # disconnect from tree.
+          storage[:apotomo_stateful_branches] << branch.dump_tree
         end
       end
       
-      def thaw_for(storage, root)
+      # Create tree from storage and add branches to root/stateless parents.
+      def thaw_for(controller, storage, root)
         branches = storage.delete(:apotomo_stateful_branches) || []
-        branches.each do |config|
-          branch = config.first
-          parent = root.find_widget(config.last) or raise "Couldn't find parent `#{config.last}` for `#{branch.name}`"
+        branches.each do |data|
+          branch = load_tree(controller, data)
+          parent = root.find_widget(data.first.last) or raise "Couldn't find parent `#{data.first.last}` for `#{branch.name}`"
           
           parent << branch
           branch.thaw_data_from(storage.delete(:apotomo_widget_ivars) || {})
@@ -102,16 +72,9 @@ module Apotomo
         
         root
       end
-  
-      def thaw_from(storage)
-        root = storage[:apotomo_root]
-        root.thaw_data_from(storage.fetch(:apotomo_widget_ivars, {}))
-        root
-      end
       
       def frozen_widget_in?(storage)
-        branches = storage[:apotomo_stateful_branches]
-        branches.present? and branches.first.first.kind_of? Apotomo::StatefulWidget
+        storage[:apotomo_stateful_branches].kind_of? Array
       end
       
       def flush_storage(storage)
@@ -134,6 +97,16 @@ module Apotomo
         stateful_roots
       end
       
+    private
+      def load_tree(parent_controller, cold_widgets)
+        root = nil
+        cold_widgets.each do |data|
+          node = data[0].new(parent_controller, data[1], "")
+          root = node and next unless root
+          root.find_widget(data[2]) << node
+        end
+        root
+      end
     end
   end
-end
+end

data/lib/apotomo/rails/view_helper.rb

@@ -22,14 +22,6 @@ module Apotomo
         js_generator.xhr(url_for_event(type, options))
       end
       
-      # Creates a link that triggers an event via AJAX.
-      # This link will <em>only</em> work in JavaScript-able browsers.
-      #
-      # Note that the link is created using #link_to_remote.
-      def link_to_event(title, type, options={}, html_options={})
-        link_to_remote(title, {:url => url_for_event(type, options)}, html_options)
-      end
-      
       # Creates a form tag that triggers an event via AJAX when submitted.
       # See StatefulWidget::address_for_event for options.
       #
@@ -49,7 +41,7 @@ module Apotomo
         html_options.reverse_merge! :target         => :apotomo_iframe, :multipart => true
         
         # i hate rails:
-        concat('<iframe id="apotomo_iframe" name="apotomo_iframe" style="display: none;"></iframe>') << form_tag(url_for_event(type, options), html_options, &block)
+        concat('<iframe id="apotomo_iframe" name="apotomo_iframe" style="display: none;"></iframe>'.html_safe) << form_tag(url_for_event(type, options), html_options, &block)
       end
       
       # Returns the url to trigger a +type+ event from the currently rendered widget.
@@ -62,7 +54,7 @@ module Apotomo
       #   #=> http://apotomo.de/mouse/process_event_request?type=paginate&source=mouse&page=2
       def url_for_event(type, options={})
         options.reverse_merge! :source => widget_id
-        controller.url_for_event(type, options)
+        @cell.url_for_event(type, options) # FIXME: don't access @parent_controller but @cell.
       end
       
       ### TODO: test me.
@@ -73,7 +65,7 @@ module Apotomo
       ### TODO: test me.
       ### DISCUSS: rename to rendered_children ?
       def content
-        @rendered_children.collect{|e| e.last}.join("\n")
+        @rendered_children.collect{|e| e.last}.join("\n").html_safe
       end
       
       # needs: suppress_javascript

data/lib/apotomo/request_processor.rb

@@ -1,20 +1,17 @@
 module Apotomo
   class RequestProcessor
-    include WidgetShortcuts
-    
     attr_reader :session, :root
     
     def initialize(controller, session, options={}, has_widgets_blocks=[])
       @session              = session
       @widgets_flushed      = false
       
-      @root = widget('apotomo/widget', 'root')
-      @root.controller = controller
+      @root = Widget.new(controller, 'root', :display)
       
       attach_stateless_blocks_for(has_widgets_blocks, @root, controller)
       
       if options[:flush_widgets].blank? and ::Apotomo::StatefulWidget.frozen_widget_in?(session)  
-        @root = ::Apotomo::StatefulWidget.thaw_for(session, @root)
+        @root = ::Apotomo::StatefulWidget.thaw_for(controller, session, @root)
       else
         #@root = flushed_root
         
@@ -27,14 +24,14 @@ module Apotomo
     def attach_stateless_blocks_for(blocks, root, controller)
       blocks.each do |blk|
         if blk.arity == 1
-          blk.call(root) and next # fixes misbehaviour in ruby 1.8.
+          #blk.call(root) and next # fixes misbehaviour in ruby 1.8.
+          root.instance_exec(root, &blk) and next
         end
-        
-        blk.call(root, controller)  
+        ### FIXME: use Widget.has_widgets func.
+        root.instance_exec(root, controller, &blk)  
       end
     end
     
-    
     def flushed_root
       StatefulWidget.flush_storage(session)
       @widgets_flushed = true
@@ -95,4 +92,4 @@ module Apotomo
       options
     end
   end
-end
+end

data/lib/apotomo/transition.rb

@@ -26,7 +26,7 @@ module Apotomo::Transition
     # to the start state.
     def transition(options)
       if from = options[:from]
-        class_transitions[from] = options[:to]
+        class_transitions[from.to_s] = options[:to]
       elsif loop = options[:in]
         transition :from => loop, :to => loop
       end
@@ -41,6 +41,6 @@ module Apotomo::Transition
     # Returns the next state for <tt>state</tt> or nil. A next state must have been defined 
     # with #transition.
     def next_state_for(state)
-      self.class.class_transitions[state]
+      self.class.class_transitions[state.to_s]
     end
 end

data/lib/apotomo/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Apotomo
-  VERSION = '0.1.4'
+  VERSION = '1.0.0.beta1'
 end

data/lib/apotomo/widget.rb

@@ -35,10 +35,6 @@ module Apotomo
     attr_writer   :controller
     attr_accessor :version
     
-    #class << self
-    #  include WidgetShortcuts
-    #end
-    
     include TreeNode
     
     include Onfire
@@ -56,30 +52,29 @@ module Apotomo
       self.class.callbacks_for_hook(name).each { |blk| instance_exec(*args, &blk) }
     end
     
-    
     def add_has_widgets_blocks(*)
       run_widget_hook(:has_widgets, self)
     end
     after_initialize :add_has_widgets_blocks
     
     
-    # Constructor which needs a unique id for the widget and one or multiple start states.
-    # <tt>start_state</tt> may be a symbol or an array of symbols.    
-    def initialize(id, start_state, opts={})
-      @opts         = opts
+    # Constructor which needs a unique id for the widget and one or multiple start states.  
+    def initialize(parent_controller, id, start_state, opts={})
+      super(parent_controller, opts)  # do that as long as cells do need a parent_controller.
+      
       @name         = id
       @start_state  = start_state
 
       @visible      = true
-      @version      = 0
+      @version      = 0 ### DISCUSS: neeed in stateLESS?
       
-      @cell         = self
+      @cell         = self  ### DISCUSS: needed?
       
       run_hook(:after_initialize, id, start_state, opts)
     end
     
     def last_state
-      @state_name
+      action_name
     end
     
     def visible?
@@ -93,7 +88,7 @@ module Apotomo
     end
     
     def unfreezable_ivars
-      [:@childrenHash, :@children, :@parent, :@controller, :@cell, :@invoke_block, :@rendered_children, :@page_updates, :@opts,
+      [:@childrenHash, :@children, :@parent, :@parent_controller, :@_request, :@_config, :@cell, :@invoke_block, :@rendered_children, :@page_updates, :@opts,
       :@suppress_javascript ### FIXME: implement with ActiveHelper and :locals.
       
       ]
@@ -126,13 +121,6 @@ module Apotomo
     end
     
     
-    
-    # called in Cell::Base#render_state
-    def dispatch_state(state)
-      send(state, &@invoke_block)
-    end
-    
-    
     # Render the view for the current state. Usually called at the end of a state method.
     #
     # ==== Options
@@ -184,11 +172,10 @@ module Apotomo
       
       options[:locals].reverse_merge!(:rendered_children => rendered_children)
       
-      @controller = controller # that dependency SUCKS.
       @suppress_js = options[:suppress_js]    ### FIXME: implement with ActiveHelper and :locals.
       
       
-      render_view_for(options, @state_name) # defined in Cell::Base.
+      render_view_for(options, action_name) # defined in Cell::Base.
     end
     
     alias_method :emit, :render
@@ -242,7 +229,7 @@ module Apotomo
     end
     
     def render_children(invoke_options={})
-      returning rendered_children = ActiveSupport::OrderedHash.new do
+      ActiveSupport::OrderedHash.new.tap do |rendered_children|
         visible_children.each do |kid|
           child_state = decide_state_for(kid, invoke_options)
           logger.debug "    #{kid.name} -> #{child_state}"
@@ -295,8 +282,8 @@ module Apotomo
       find {|node| node.name.to_s == widget_id.to_s}
     end
     
-    def controller
-      root? ? @controller : root.controller
+    def url_for_event(*args)
+      parent_controller.url_for_event(*args)
     end
     
     alias_method :widget_id, :name

data/lib/apotomo/widget_shortcuts.rb

@@ -12,7 +12,7 @@ module Apotomo
     #
     #   widget('jquery/tabs', 'panel')
     def widget(class_name, id, state=:display, *args)
-      object = constant_for(class_name).new(id, state, *args)
+      object = constant_for(class_name).new(parent_controller, id, state, *args)
       yield object if block_given?
       object
     end

data/lib/apotomo.rb

@@ -40,6 +40,9 @@ module Apotomo
       yield self
     end
   end
+  
+  class Engine < Rails::Engine
+  end
 end
 
 require 'apotomo/javascript_generator'
@@ -49,3 +52,6 @@ require 'apotomo/widget'
 require 'apotomo/stateful_widget'
 require 'apotomo/container_widget'
 require 'apotomo/widget_shortcuts'
+require 'apotomo/rails/controller_methods'
+
+#require 'apotomo/engine' if defined?(Rails)

data/lib/generators/apotomo/templates/view.erb

@@ -0,0 +1,7 @@
+<h1>
+  <%= class_name %>#<%= @state %>
+</h1>
+
+<p>
+  Find me in <%= @path %>
+</p>

data/lib/generators/apotomo/templates/view.haml

@@ -0,0 +1,4 @@
+%h1
+  <%= class_name %>#<%= @state %>
+%p
+  Find me in <%= @path %>

data/{generators/widget → lib/generators/apotomo}/templates/widget.rb

@@ -1,8 +1,9 @@
 class <%= class_name %> < Apotomo::Widget
+
 <% for action in actions -%>
   def <%= action %>
     render
   end
-  
+
 <% end -%>
 end

data/lib/generators/apotomo/templates/widget_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class <%= class_name %>Test < Apotomo::TestCase
+<% for state in @states -%>
+  test "<%= state %>" do
+    invoke :<%= state %>
+    assert_select "p"
+  end
+  
+<% end %>
+end

data/lib/generators/apotomo/widget_generator.rb

@@ -0,0 +1,19 @@
+require 'generators/cells/cell_generator'
+
+module Apotomo
+  module Generators
+    class WidgetGenerator < Cells::Generators::CellGenerator
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      
+      def create_cell_file
+        puts "creating #{file_name}.rb"
+        template 'widget.rb', File.join('app/cells', class_path, "#{file_name}.rb")
+      end
+      
+      def create_test
+        @states = actions
+        template 'widget_test.rb', File.join('test/widgets/', "#{file_name}_test.rb")
+      end
+    end
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+#require "dummy"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!