apotomo 1.2.3 → 1.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab4ff5d6b948831051158089f36e5d1fcc51a6dc
+  data.tar.gz: e9a1e8f5307939371bb65eec32838fdfc2c959fd
+SHA512:
+  metadata.gz: bbba581bafc616e601e27064061147b369cd510b6842ff0c2bd4612288a1f57bcaddf11947eb5264da482b5324f0233a9a718c60c490080ea4f114081ba70d36
+  data.tar.gz: a44b757bb6f0a490f08826680e08ec747a01db2abe95004acf4781188e5f564ee9fa7cb6a557bb348374a824b779f2e19a98ddef682c227cff381199434d3f26

data/.gitignore

@@ -1,5 +1,9 @@
-pkg/*
+.DS_Store
+pkg
 *.gem
+.*~
 .bundle
-test/dummy/log/*
-test/dummy/tmp/*
+Gemfile*.lock
+test/dummy/log/
+test/dummy/tmp/
+/.rvmrc

data/.travis.yml

@@ -1,12 +1,10 @@
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - rbx-18mode
-  - rbx-19mode
-  - ree
-  - jruby-18mode
-  - jruby-19mode
-  - jruby-head
+  - 2.0.0
 notifications:
   irc: "irc.freenode.org#cells"
+gemfile:
+  - gemfiles/Gemfile.rails3-0
+  - gemfiles/Gemfile.rails3-1
+  - gemfiles/Gemfile.rails3-2
+  - gemfiles/Gemfile.rails4-0

data/CHANGES.textile

@@ -1,3 +1,7 @@
+h2. 1.2.4
+
+* Make it work with Rails 4.
+
 h2. 1.2.3
 
 * Maintenance release to make happy people happy.
@@ -10,7 +14,7 @@ h2. 1.2.1
 
 h3. Changes
   * Save the <code>@options</code> hash in the constructor since we cannot rely on cells anymore.
-  
+
 h2. 1.2.0
 
 h3. Changes
@@ -21,7 +25,7 @@ h3. Changes
   * Removed @#param@ in favor of @#options@.
   * Removed @#emit@ in favor of @#render@.
   * Removed @#remove_all!@ and @#remove_from_parent!@. Did you ever use these?
-  
+
 h2. 1.1.4
 
 h3. Changes
@@ -33,7 +37,7 @@ h2. 1.1.1
 h3. Additions
   * You can now attach event handlers to other widgets simply by using the @:passing@ option: @responds_to_event :click, :passing => :root@.
   * If you want to debug events, just include the (WIP) @apotomo/debugging@ file and watch your server output on the console.
-  
+
 h3. Changes
   * @Widget.responds_to_event@ is inheritable now.
   * The generator now places namespaced widgets into the correct sub-directories.
@@ -68,7 +72,7 @@ h3. Removals
   * Removed #cell, #container and #section widget shortcuts.
   * Removed @rendered_children@ local in views. Use #render_widget.
   * Removed ContainerWidget, nobody needs it.
-  
+
 h3. Bugfixes
   * Widget.responds_to_event no longer shares its options with multiple widget instances of the same class.
 
@@ -94,7 +98,7 @@ h2. 1.0.2
 
 h3. Changes
   * removals from ViewHelper: #trigger_event, #form_to_event and friends as they use deprecated Rails helpers.
-  
+
 h3. Bugfixes
   * Widget#fire now accepts payload data for the fired event.
   * triggered states now receive the event object if they expect one argument.

data/README.md

@@ -0,0 +1,211 @@
+# Apotomo
+
+**Web Components for Rails.**
+
+[![TravisCI Build Status](https://secure.travis-ci.org/apotonick/apotomo.png)](http://travis-ci.org/apotonick/apotomo)
+
+## Overview
+
+Do you need an _interactive user interface_ for your Rails application? A cool Rich Client Application with dashboards, portlets and AJAX, Drag&Drop and jQuery?
+
+Is your controller gettin' fat? And your partial-helper-AJAX pile is getting out of control?
+
+Do you want a framework to make the implementation easier? _You want Apotomo._ 
+
+**Apotomo** is based on [Cells](http://github.com/apotonick/cells), the popular View Components framework for Rails.
+
+It gives you widgets and encapsulation, bubbling events, AJAX page updates, rock-solid testing and more. Check out <http://apotomo.de> for more information.
+
+## Installation
+
+Easy as hell. You just need Ruby 1.9.3/2.0.0 and Rails 3/4.
+
+Add Apotomo to your `Gemfile`:
+
+```ruby
+gem `apotomo`
+```
+
+## Example
+
+A _shitty_ example is worse than a _shitty_ framework, so let's choose wisely...
+
+Say you had a blog application. The page showing the post should have a comments block, with a list of comments and a form to post a new comment. Submitting should validate and send back the updated comments list, via AJAX.
+
+Let's wrap that comments block in a widget.
+
+## Generate
+
+Go and generate a widget stub.
+
+```shell
+rails generate apotomo:widget Comments display write -e haml
+```
+
+```
+create  app/widgets/
+create  app/widgets/comments_widget.rb
+create  app/widgets/comments/
+create  app/widgets/comments/display.html.haml
+create  app/widgets/comments/write.html.haml
+create  test/widgets/
+create  test/widgets/comments_widget_test.rb
+```
+
+Nothing special.
+
+## Plug it in
+
+You now tell your controller about the new widget.
+
+```ruby
+class PostsController < ApplicationController
+  
+  has_widgets do |root|
+    root << widget(:comments, :post => @post)
+  end
+```
+
+This creates a widget instance called `comments_widget` from the class CommentsWidget.  We pass the current post into the widget - the block is executed in controller instance context, that's were `@post` comes from. Handy, isn't it?
+
+## Render the widget
+
+Rendering usually happens in your controller view, `app/views/posts/show.html.haml`, for instance.
+
+```haml
+%h1= @post.title
+%p
+  = @post.body
+%p
+  = render_widget :comments
+```
+
+## Write the widget
+
+A widget is like a cell which is like a mini-controller.
+
+```ruby
+class CommentsWidget < Apotomo::Widget
+  responds_to_event :post
+  
+  def display(args)
+    @comments = args[:post].comments # the parameter from outside.
+
+    render
+  end
+```
+
+Having `display` as the default state when rendering, this method collects comments to show and renders its view.
+
+And look at line 2 - if encountering a `:post` event we invoke `#post`, which is simply another state. How cool is that? 
+
+```ruby
+  def post(event)
+    @comment = Comment.new :post_id => event[:post_id]
+    @comment.update_attributes event[:comment] # a bit like params[].
+    
+    update :state => :display
+  end
+end
+```
+
+The event is processed with three steps in our widget:
+
+* create the new comment
+* re-render the `display` state
+* update itself on the page
+
+Apotomo helps you focusing on your app and takes away the pain of _action dispatching_ and _page updating_.
+
+## Triggering events
+
+So how and where is the `:post` event triggered?
+
+Take a look at the widget's view `display.html.haml`.
+
+```haml
+= widget_div do
+  %ul
+    - for comment in @comments
+      %li= comment.text
+  
+  = form_for :comment, :url => url_for_event(:post), :remote => true do |f|
+    = f.text_field :text
+    = f.submit
+```
+
+That's a lot of familiar view code, almost looks like a _partial_.
+
+As soon as the form is submitted, the form gets serialized and sent using the standard Rails mechanisms. The interesting part here is the endpoint URL returned by #url_for_event as it will trigger an Apotomo event.
+
+## Event processing
+
+Now what happens when the event request is sent? Apotomo - again - does three things for you, it
+
+* _accepts the request_ on a special event route it adds to your app
+* _triggers the event_ in your ruby widget tree, which will invoke the `#post` state in our comment widget
+* _sends back_ the page updates your widgets rendered
+
+## JavaScript Agnosticism
+
+In this example, we use jQuery for triggering. We could  also use Prototype, RightJS, YUI, or a self-baked framework, that's up to you.
+
+Also, updating the page is in your hands. Where Apotomo provides handy helpers as `#replace`, you could also _emit your own JavaScript_.
+
+Look, `replace` basically generates
+
+```ruby
+jQuery("comments").replaceWith(<the rendered view>);
+```
+
+If that's not what you want, do
+
+```ruby
+def post(event)
+  if event[:comment][:text].explicit?
+    render :text => 'alert("Hey, you wanted to submit a pervert comment!");'
+  end
+end
+```
+
+Apotomo doesn't depend on _any_ JS framework - you choose!
+
+## Testing
+
+Apotomo comes with its own test case and assertions to _build rock-solid web components_.
+
+```ruby
+class CommentsWidgetTest < Apotomo::TestCase
+  has_widgets do |root|
+    root << widget(:comments, :post => @pervert_post)
+  end
+  
+  def test_render
+    render_widget :comments
+    assert_select "li#me"
+    
+    trigger :post, :comment => {:text => "Sex on the beach"}
+    assert_response 'alert("Hey, you wanted to submit a pervert comment!");'
+  end
+end
+```
+
+You can render your widgets, spec the markup, trigger events and assert the event responses, so far. If you need more, let us know!
+
+## Bubbling events
+
+Note: Let's write this paragraph!
+
+## Bugs, Community
+
+Please visit <http://apotomo.de>, the official project page with _lots_ of examples.
+
+If you have questions, visit us in the IRC channel #cells at irc.freenode.org.
+
+If you wanna be cool, subscribe to our [feed](http://feeds.feedburner.com/Apotomo)!
+
+## License
+
+Copyright (c) 2007-2013 Nick Sutterer <apotonick@gmail.com>
+
+Released under the MIT License.

data/apotomo.gemspec

@@ -13,19 +13,19 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/apotonick/apotomo"
   s.summary     = %q{Web components for Rails.}
   s.description = %q{Web component framework for Rails providing widgets that trigger events and know when and how to update themselves with AJAX.}
-  
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
   s.add_dependency "cells",   ">= 3.6.7"
   s.add_dependency "onfire",  "~> 0.2.0"
-  s.add_dependency "hooks",   "~> 0.2.0"
+  s.add_dependency "hooks",   "~> 0.3.0"
 
-  s.add_development_dependency "shoulda"
   s.add_development_dependency "rake"
   s.add_development_dependency "slim"
   s.add_development_dependency "haml"
   s.add_development_dependency "tzinfo"
+  s.add_development_dependency "minitest", "~> 4.7.5"
 end

data/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  match ":controller/render_event_response", :to => "#render_event_response", :as => "apotomo_event"
+  match ":controller/render_event_response", :to => "#render_event_response", :as => "apotomo_event", :via => [:get, :post]
 end

data/gemfiles/Gemfile.rails3-0

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in apotomo.gemspec
+gemspec path: '../'
+
+gem 'railties', '~> 3.0.0'

data/gemfiles/Gemfile.rails3-1

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in apotomo.gemspec
+gemspec path: '../'
+
+gem 'railties', '~> 3.1.0'

data/gemfiles/Gemfile.rails3-2

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in apotomo.gemspec
+gemspec path: '../'
+
+gem 'railties', '~> 3.2.0'

data/gemfiles/Gemfile.rails4-0

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in apotomo.gemspec
+gemspec path: '../'
+
+gem 'railties', '~> 4.0.0'

data/lib/apotomo/javascript_generator.rb

@@ -24,7 +24,7 @@ module Apotomo
     
     module Prototype
       def prototype;              end
-      def element(id);            "$(\"#{id}\")"; end
+      def element(id);            "jQuery(\"#{id}\")"; end
       def update(id, markup);     element(id) + '.update("'+escape(markup)+'");'; end
       def replace(id, markup);    element(id) + '.replace("'+escape(markup)+'");'; end
       def update_id(id, markup);  update(id, markup); end
@@ -33,7 +33,7 @@ module Apotomo
     
     module Right
       def right;                  end
-      def element(id);            "$(\"#{id}\")"; end
+      def element(id);            "jQuery(\"#{id}\")"; end
       def update(id, markup);     element(id) + '.update("'+escape(markup)+'");'; end
       def replace(id, markup);    element(id) + '.replace("'+escape(markup)+'");'; end
       def update_id(id, markup);  update(id, markup); end
@@ -42,7 +42,7 @@ module Apotomo
     
     module Jquery
       def jquery;                 end
-      def element(id);            "$(\"#{id}\")"; end
+      def element(id);            "jQuery(\"#{id}\")"; end
       def update(id, markup);     element(id) + '.html("'+escape(markup)+'");'; end
       def replace(id, markup);    element(id) + '.replaceWith("'+escape(markup)+'");'; end
       def update_id(id, markup);  update("##{id}", markup); end

data/lib/apotomo/test_case.rb

@@ -19,7 +19,7 @@ module Apotomo
   #
   #     it "should redraw on :update" do
   #       trigger :update
-  #       assert_response "$(\"post-comments\").update ..."
+  #       assert_response "jQuery(\"post-comments\").update ..."
   #     end
   #
   # For unit testing, you can grab an instance of your tested widget.
@@ -35,12 +35,12 @@ module Apotomo
       extend ActiveSupport::Concern
 
       include Cell::TestCase::CommonTestMethods
-      
+
       attr_reader :view_assigns
-      
+
       def setup
         super # defined in Cell::TestCase::CommonTestMethods.
-        
+
         @controller.instance_eval do
           def controller_path
             'barn'
@@ -48,13 +48,14 @@ module Apotomo
         end
         @controller.extend Apotomo::Rails::ControllerMethods
       end
-      
+
       # Renders the widget +name+.
       def render_widget(*args)
         @view_assigns = extract_state_ivars_for(root[args.first]) do
           @last_invoke = root.render_widget(*args)
         end
-        
+        cleanup_assigns!(@view_assigns)
+
         @last_invoke
       end
 
@@ -76,11 +77,16 @@ module Apotomo
            self.instance_exec(root, &blk)
         end
       end
-      
+
       def parent_controller
         @controller
       end
 
+    private
+      def cleanup_assigns!(assigns)
+        assigns.delete(:lookup_context) # dirty but it works.
+      end
+
       module ClassMethods
         def has_widgets_blocks
           @has_widgets
@@ -98,7 +104,7 @@ module Apotomo
     # Example:
     #
     #   trigger :submit, :source => "post-comments"
-    #   assert_response "alert(\":submit clicked!\")", /\$\("post-comments"\).update/
+    #   assert_response "alert(\":submit clicked!\")", /\jQuery\("post-comments"\).update/
     def assert_response(*content)
       updates = root.page_updates
 

data/lib/apotomo/version.rb

@@ -1,3 +1,3 @@
 module Apotomo
-  VERSION = '1.2.3'
+  VERSION = '1.2.4'
 end

data/lib/apotomo/widget/javascript_methods.rb

@@ -15,12 +15,12 @@ module Apotomo
     #
     # will render the current state's view and wrap it like
     #
-    #   "$(\"#mouse\").replaceWith(\"<div id=\\\"mouse\\\">hungry!<\\/div>\")"
+    #   "jQuery(\"#mouse\").replaceWith(\"<div id=\\\"mouse\\\">hungry!<\\/div>\")"
     #
     # You may pass a selector and pass options to render here, as well.
     #
     #     replace "#jerry h1", :view => :squeak 
-    #     #=> "$(\"#jerry h1\").replaceWith(\"<div id=\\\"mouse\\\">squeak!<\\/div>\")"
+    #     #=> "jQuery(\"#jerry h1\").replaceWith(\"<div id=\\\"mouse\\\">squeak!<\\/div>\")"
     def replace(*args)
       wrap_in_javascript_for(:replace, *args)
     end
@@ -30,7 +30,7 @@ module Apotomo
     # Example for +:jquery+:
     #
     #   update :view => :peek
-    #   #=> "$(\"#mouse\").html(\"looking...")"
+    #   #=> "jQuery(\"#mouse\").html(\"looking...")"
     def update(*args)
       wrap_in_javascript_for(:update, *args)
     end

data/lib/apotomo/widget/tree_node.rb

@@ -3,7 +3,7 @@ module Apotomo
     include Enumerable
     include Apotomo::WidgetShortcuts::DSL
 
-    attr_reader :name, :childrenHash
+    attr_reader :childrenHash
     attr_accessor :parent
   
     def setup_tree_node(parent)

data/lib/apotomo/widget.rb

@@ -68,7 +68,9 @@ module Apotomo
     abstract!
     undef :display  # We don't want #display to be listed in #internal_methods.
     
+    attr_reader :name
     alias_method :widget_id, :name
+
     attr_reader :options
     
     after_initialize do
@@ -106,9 +108,7 @@ module Apotomo
     # a state method.
     #
     # ==== Options
-    # * <tt>:view</tt> - Renders +view+. Defaults to the current state name.
-    # * <tt>:state</tt> - Invokes the +state+ method and returns whatever the state returns.
-    # * See http://rdoc.info/gems/cells/3.5.4/Cell/Rails#render-instance_method
+    # * See http://rdoc.info/gems/cells/Cell/Rails:render
     #
     # Example:
     #  class MouseWidget < Apotomo::Widget

data/lib/generators/apotomo/widget_generator.rb

@@ -15,7 +15,7 @@ module Apotomo
       source_root File.expand_path('../../templates', __FILE__)
       
       hook_for(:template_engine)
-      hook_for(:test_framework)  # TODO: implement rspec-apotomo.
+      hook_for(:test_framework)
       
       check_class_collision :suffix => "Widget"
       

data/lib/generators/templates/view.slim

@@ -1,4 +1,3 @@
-h1
-  <%= class_name %>Widget#<%= @state %>
-p
-  Find me in <%= @path %>
+= widget_div do
+  h1 <%= class_name %>Widget#<%= @state %>
+  p Find me in <%= @path %>

data/test/apotomo_test.rb

@@ -1,20 +1,31 @@
 require '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
+class ApotomoTest < MiniTest::Spec
+  describe "The main module ::Apotomo" do
+    describe "when setting #js_framework" do
+      before do
+        Apotomo.js_framework = :jquery
+      end
+
+      it "respond to #js_framework" do
+        assert_equal :jquery, Apotomo.js_framework
+      end
+
+      it "respond to #js_generator" do
+        assert_kind_of Apotomo::JavascriptGenerator, Apotomo.js_generator
+      end
+
+      it "include correct javascript framework module" do
+        assert Apotomo.js_generator.is_a?(Apotomo::JavascriptGenerator::Jquery)
+        assert_respond_to Apotomo.js_generator, :jquery
+      end
     end
-    
-    should "have a setup method" do
-      Apotomo.setup { |config| config.js_framework = :prototype }
-      assert_respond_to Apotomo.js_generator, :prototype
+
+    it "respond to #setup" do
+      Apotomo.setup { |config| config.js_framework = :jquery }
+      # TODO: Apotomo expect #js_framework
+      assert_respond_to Apotomo.js_generator, :jquery
     end
   end
 end
+

data/test/dummy/config/routes.rb

@@ -1,59 +1,4 @@
 Dummy::Application.routes.draw do
-  # The priority is based upon order of creation:
-  # first created -> highest priority.
-
-  # Sample of regular route:
-  #   match 'products/:id' => 'catalog#view'
-  # Keep in mind you can assign values other than :controller and :action
-
-  # Sample of named route:
-  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
-  # This route can be invoked with purchase_url(:id => product.id)
-
-  # Sample resource route (maps HTTP verbs to controller actions automatically):
-  #   resources :products
-
-  # Sample resource route with options:
-  #   resources :products do
-  #     member do
-  #       get 'short'
-  #       post 'toggle'
-  #     end
-  #
-  #     collection do
-  #       get 'sold'
-  #     end
-  #   end
-
-  # Sample resource route with sub-resources:
-  #   resources :products do
-  #     resources :comments, :sales
-  #     resource :seller
-  #   end
-
-  # Sample resource route with more complex sub-resources
-  #   resources :products do
-  #     resources :comments
-  #     resources :sales do
-  #       get 'recent', :on => :collection
-  #     end
-  #   end
-
-  # Sample resource route within a namespace:
-  #   namespace :admin do
-  #     # Directs /admin/products/* to Admin::ProductsController
-  #     # (app/controllers/admin/products_controller.rb)
-  #     resources :products
-  #   end
-
-  # You can have the root of your site routed with "root"
-  # just remember to delete public/index.html.
-  # root :to => "welcome#index"
-
-  # See how all your routes lay out with "rake routes"
-
-  # This is a legacy wild controller route that's not recommended for RESTful applications.
-  # Note: This route will make all actions in every controller accessible via GET requests.
-  match "barn/widget", :to => "barn#widget"
-  match ':controller(/:action(/:id(.:format)))'
+  get "barn/widget", :to => "barn#widget"
+  get ':controller(/:action(/:id(.:format)))'
 end