dom_routes 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d22b5e3bf4b4ed86c0ec81f3893b9eb816fe9c4a
-  data.tar.gz: 7bf8af4328d168ca2962c90c1c224e474f0eaeb5
+  metadata.gz: e37ed1c50927dd43b2437bfa6f44993b5ce9854f
+  data.tar.gz: 138ec9f80d4ef9656a9511fe16ecc3136051a448
 SHA512:
-  metadata.gz: 6aaa57b3e5f3c7fc7dcde76a01481acf0b33bb461f2610266e8470109b056e19a916c8bcbe0410868c8cdd036b60ec498bbeb0263d0e095d34e927a3ac451b41
-  data.tar.gz: 572b34d0253c084ea2094d4846c1e7b05966ccaf2d70510d990a2409760822b564e04a60d6a2b6376aa331a9b2afe680e73bfa3d3501dc93656a96ef2418d25d
+  metadata.gz: a3516463f94b1d7bc0870edaea4c1064f33d0c0cdd43a5ead360ae4c5e0aa4350f355962af5fb137363da0610a7000b56eafd6c217c7cdaed8b6079b9f0f86e2
+  data.tar.gz: 9c6c42476dbd9c4c4957fc74a8368607255dfc85c0949043c1320b09daf735f918da1e82a8690b58649a164272b5e9db45b57237ba69603c78419233f361467b

data/.gitignore

@@ -16,4 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 
+spec/fake_app/log/*
+
 .idea/

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+script: xvfb-run rspec
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+gemfile:
+  - gemfiles/Gemfile-rails.3.2.x
+  - gemfiles/Gemfile-rails.4.0.x
+  - gemfiles/Gemfile-rails.4.1.x
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/README.md

@@ -3,6 +3,8 @@ Auto-magical scaffolding for
 [Paul Irish's DOM-based Routing](http://www.paulirish.com/2009/markup-based-unobtrusive-comprehensive-dom-ready-execution/)
 (or Garber-Irish Implementation) way of organizing your javascript.
 
+__Works with turbolinks__
+
 ## Purpose
 Javascript is hard to organize and debugging ajax is a mess. This is one method to organizing your javascript neatly by mirroring the controllers and having all the it outside of your HTML views.
 
@@ -28,18 +30,20 @@ DR.routes = {
 ```
 ### What happens
 After, requests to `demos#demo_action` with format `html` will call the following functions (if they exist):
-* `DR.routes.all.html.before`
+* `DR.routes.application.html.before`
 * `DR.routes.demos.html.before`
-* `DR.routes.demos.html.demo_action` (with parameters if given)
+* `DR.routes.application.html.demo_action`
+* `DR.routes.demos.html.demo_action`
 * `DR.routes.demos.html.after`
-* `DR.routes.all.html.after`
+* `DR.routes.application.html.after`
 
 `js` format is also supported, i.e.:
-* `DR.routes.all.js.before`
+* `DR.routes.application.js.before`
 * `DR.routes.demos.js.before`
-* `DR.routes.demos.js.demo_action` (with parameters if given)
+* `DR.routes.application.js.demo_action`
+* `DR.routes.demos.js.demo_action`
 * `DR.routes.demos.js.after`
-* `DR.routes.all.js.after`
+* `DR.routes.application.js.after`
 
 ## Installation
 Add this line to your application's `Gemfile`:
@@ -96,8 +100,10 @@ So if a `html` request is sent to `demos#edit`, `DR.routes.demos.html.edit` is c
 
 For a `js` request sent to `demos#new`, `DR.routes.demos.js.new` is called and nothing else happens.
 
-### Passing parameters
-__Optional__ Parameters are passed from a JSON DSL (such as [jbuilder](https://github.com/rails/jbuilder/)) and is passed as the `params` object to the function. You can pass any JSON object.
+### Templates and parameters
+__Optional__ Parameters are passed from a JSON DSL (such as [jbuilder](https://github.com/rails/jbuilder/))
+and is passed as the `params` object to the function.
+You can pass any JSON object as a template.
 
 #### HTML
 `app/views/demos/edit_params.js.jbuilder`:
@@ -111,6 +117,7 @@ DR.routes.demos.html.edit({ alert_message: "ploop" });
 is called automatically.
 
 #### Javascript
+For javascript to work, a template must exist.
 `app/views/demos/new.js.jbuilder`:
 ```ruby
 json.log_message "loggggggggggggg"

data/dom_routes.gemspec

@@ -18,8 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rails', '>= 3.1'
+  spec.add_dependency 'rails', '>= 3.2'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "capybara-webkit"
+  spec.add_development_dependency "rspec-rails", "~> 2.14.0"
+  spec.add_development_dependency "jbuilder"
+  spec.add_development_dependency "jquery-rails"
   spec.add_development_dependency "rake"
 end

data/gemfiles/Gemfile-rails.3.2.x

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'dom_routes', :path => '..'
+
+gem 'rails', '~> 3.2.0'
+gem 'capybara-webkit'
+gem 'rspec-rails', '~> 2.14.0'
+gem 'jbuilder'
+gem 'jquery-rails'

data/gemfiles/Gemfile-rails.4.0.x

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'dom_routes', :path => '..'
+
+gem 'rails', '~> 4.0.0'
+gem 'capybara-webkit'
+gem 'rspec-rails', '~> 2.14.0'
+gem 'jbuilder'
+gem 'jquery-rails'

data/gemfiles/Gemfile-rails.4.1.x

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'dom_routes', :path => '..'
+
+gem 'rails', '~> 4.1.0'
+gem 'capybara-webkit'
+gem 'rspec-rails', '~> 2.14.0'
+gem 'jbuilder'
+gem 'jquery-rails'

data/lib/dom_routes/version.rb

@@ -1,3 +1,3 @@
 module DomRoutes
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/lib/dom_routes/view_helpers.rb

@@ -42,6 +42,7 @@ module DomRoutes
     end
 
     def execute_js_route(js_route=self.js_route, format=formats.first)
+      js_route = extract_js_route(js_route)
       controller_path, action = js_route.parts
       lambda = -> do
         if format == :html
@@ -61,10 +62,9 @@ module DomRoutes
             else
               %Q/
                     DR.define_namespace('DR.routes', {
-                        params: #{js_params_namespace},
-                        init: function() { DR.exec_all(DR.routes.params); },
+                        params: #{js_params_namespace}
                     });
-                    $(DR.routes.init);
+                    $(function() { DR.exec_all(#{js_params_namespace}); });
                   /
             end
             }

data/spec/fake_app/app/assets/javascripts/application.js

@@ -0,0 +1,54 @@
+//= require jquery_ujs
+//= require dom_routes
+//= require_self
+//= require_tree .
+
+test_append = function(controller_namespace, filter, params) {
+    var $div = $(document.createElement('div'));
+    $div.attr("filter", controller_namespace + "." + params.format + "." + filter);
+    $div.append(params.s);
+    $('#test_append').append($div);
+};
+
+create_routes = function(controller_namespace) {
+    var test = function(filter, params) {
+        test_append(controller_namespace, filter, params);
+    };
+
+    DR.define(controller_namespace, {
+        html: {
+            before: function(params) {
+                test("before", params);
+            },
+            index: function(params) {
+                test("index", params);
+            },
+            with_parameters: function(params) {
+                test("with_parameters", params);
+            },
+            manually_execute: function(params) {
+                test("manually_execute", params);
+            },
+            different_route: function(params) {
+                test("different_route", params);
+            },
+            redirect: function(params) {
+                test("redirect", params);
+            },
+            after: function(params) {
+                test("after", params);
+            }
+        },
+        js: {
+            before: function(params) {
+                test("before", params);
+            },
+            with_parameters: function(params) {
+                test("with_parameters", params);
+            },
+            after: function(params) {
+                test("after", params);
+            }
+        }
+    });
+};

data/spec/fake_app/app/assets/javascripts/routes/application_routes.js

@@ -0,0 +1 @@
+create_routes('application');

data/spec/fake_app/app/assets/javascripts/routes/dashboard/users_routes.js

@@ -0,0 +1 @@
+create_routes('dashboard.users');

data/spec/fake_app/app/assets/javascripts/routes/users_routes.js

@@ -0,0 +1 @@
+create_routes('users');

data/spec/fake_app/app/controllers.rb

@@ -0,0 +1,39 @@
+class ApplicationController < ActionController::Base
+  self.append_view_path File.join(File.dirname(__FILE__), "views")
+end
+
+module BaseController
+  extend ActiveSupport::Concern
+
+  def index
+    render_users
+  end
+  def with_parameters
+  end
+
+  protected
+  def render_users
+    render "users/#{action_name}"
+  end
+end
+
+class UsersController < ApplicationController
+  include BaseController
+
+  def manually_execute
+  end
+
+  def different_route
+    self.js_route = "users/index"
+  end
+
+  def redirect
+    flash_js_route
+    redirect_to users_path
+  end
+end
+module Dashboard
+  class UsersController < ApplicationController
+    include BaseController
+  end
+end

data/spec/fake_app/app/helpers.rb

@@ -0,0 +1,5 @@
+module ApplicationHelper
+  def params_test(json)
+    json.s "params_test"
+  end
+end

data/spec/fake_app/app/views/dashboard/users/with_parameters_params.js.jbuilder

@@ -0,0 +1 @@
+params_test(json)

data/spec/fake_app/app/views/layouts/application.html.erb

@@ -0,0 +1,11 @@
+<html>
+<head>
+  <%= javascript_include_tag "//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js" %>
+  <%= javascript_include_tag "application" %>
+</head>
+<body data-controller="<%= js_route.controller_path %>" data-action="<%= js_route.action %>">
+<div id="test_append"></div>
+<%= yield %>
+<%= execute_js_routes %>
+</body>
+</html>

data/spec/fake_app/app/views/users/manually_execute.html.erb

@@ -0,0 +1 @@
+<%= execute_js_route "users#index" %>

data/spec/fake_app/app/views/users/with_parameters.html.erb

@@ -0,0 +1 @@
+<%= link_to "ajax_link", '/users/with_parameters', remote: true %>

data/spec/fake_app/app/views/users/with_parameters.js.jbuilder

@@ -0,0 +1 @@
+params_test(json)

data/spec/fake_app/app/views/users/with_parameters_params.js.jbuilder

@@ -0,0 +1 @@
+params_test(json)

data/spec/fake_app/fake_app.rb

@@ -0,0 +1,29 @@
+require 'rails'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require "sprockets/railtie"
+
+require 'jbuilder'
+require 'jquery-rails'
+require 'dom_routes'
+
+module FakeApp
+  class Application < Rails::Application
+    config.secret_token = 'Listen to your heart. Be brave. Do what you gotta do.'
+    config.session_store :cookie_store, :key => 'session_store'
+    config.active_support.deprecation = :log
+    config.eager_load = false
+
+    config.root = File.dirname(__FILE__)
+  end
+end
+FakeApp::Application.initialize!
+
+%w[routes].each do |file|
+  require "fake_app/#{file}"
+end
+
+%w[controllers helpers].each do |file|
+  require "fake_app/app/#{file}"
+end
+ActionView::Base.send :include, ApplicationHelper

data/spec/fake_app/routes.rb

@@ -0,0 +1,18 @@
+FakeApp::Application.routes.draw do
+  resources :users, :only => [:index] do
+    collection do
+      get :with_parameters
+      get :manually_execute
+      get :different_route
+      get :redirect
+    end
+  end
+
+  namespace :dashboard do
+    resources :users, :only => [:index] do
+      collection do
+        get :with_parameters
+      end
+    end
+  end
+end

data/spec/features/dom_routes_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+feature 'invoke correct dom route', :js => true do
+  def filters(controller_namespace, action, js=false)
+    formats = %w[html]
+    if js; formats += %w[js] end
+
+    formats.map do |format|
+      format_filters = %W[before #{action} after].map do |filter|
+        ["application.#{format}.#{filter}", "#{controller_namespace}.#{format}.#{filter}"]
+      end.flatten
+      format_filters[-1], format_filters[-2] = format_filters[-2], format_filters[-1]
+      format_filters
+    end.flatten
+  end
+
+  def test_elements(filters)
+    within '#test_append' do
+      all('div').zip(filters).each do |div, filter|
+        div[:filter].should == filter
+
+        if @parameters
+          div.text.should == "params_test"
+        end
+      end
+    end
+  end
+
+  context 'without parameters' do
+    before :all do
+      @parameters = false
+    end
+
+    scenario 'with basic controller' do
+      visit '/users'
+      test_elements filters('users', "index")
+    end
+
+    scenario 'with namespaced controller' do
+      visit '/dashboard/users'
+      test_elements filters('dashboard.users', "index")
+    end
+
+
+    scenario "with manual execution" do
+      visit '/users/manually_execute'
+      test_elements (filters('users', "index") + filters('users', 'manually_execute'))
+    end
+
+    scenario "with different route" do
+      visit '/users/different_route'
+      test_elements filters('users', "index")
+    end
+
+    scenario "with redirect" do
+      visit '/users/redirect'
+      test_elements (filters('users', 'redirect') + filters('users', "index"))
+    end
+  end
+
+  context 'with parameters' do
+    before :all do
+      @parameters = true
+    end
+
+    scenario 'with basic controller' do
+      visit '/users/with_parameters'
+      test_elements filters('users', "with_parameters")
+    end
+
+    scenario 'with namespaced controller' do
+      visit '/dashboard/users/with_parameters'
+      test_elements filters('dashboard.users', "with_parameters")
+    end
+
+    scenario 'with ajax' do
+      visit '/users/with_parameters'
+      click_link "ajax_link"
+      test_elements filters('users', "with_parameters", true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fake_app/fake_app'
+require 'capybara-webkit'
+require 'rspec/rails'
+
+Capybara.javascript_driver = :webkit

metadata

@@ -1,66 +1,123 @@
 --- !ruby/object:Gem::Specification
 name: dom_routes
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - s12chung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-webkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ' Auto-magical scaffolding for Paul Irish''s DOM-based Routing way of
-  organizing your javascript. '
+description: " Auto-magical scaffolding for Paul Irish's DOM-based Routing way of
+  organizing your javascript. "
 email:
 - steve@placemarkhq.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -68,10 +125,32 @@ files:
 - app/assets/javascripts/dom_routes.js
 - app/views/layouts/application.js.erb
 - dom_routes.gemspec
+- gemfiles/Gemfile-rails.3.2.x
+- gemfiles/Gemfile-rails.4.0.x
+- gemfiles/Gemfile-rails.4.1.x
 - lib/dom_routes.rb
 - lib/dom_routes/controller.rb
 - lib/dom_routes/version.rb
 - lib/dom_routes/view_helpers.rb
+- spec/fake_app/app/assets/javascripts/application.js
+- spec/fake_app/app/assets/javascripts/routes/application_routes.js
+- spec/fake_app/app/assets/javascripts/routes/dashboard/users_routes.js
+- spec/fake_app/app/assets/javascripts/routes/users_routes.js
+- spec/fake_app/app/controllers.rb
+- spec/fake_app/app/helpers.rb
+- spec/fake_app/app/views/dashboard/users/with_parameters.html.erb
+- spec/fake_app/app/views/dashboard/users/with_parameters_params.js.jbuilder
+- spec/fake_app/app/views/layouts/application.html.erb
+- spec/fake_app/app/views/users/different_route.html.erb
+- spec/fake_app/app/views/users/index.html.erb
+- spec/fake_app/app/views/users/manually_execute.html.erb
+- spec/fake_app/app/views/users/with_parameters.html.erb
+- spec/fake_app/app/views/users/with_parameters.js.jbuilder
+- spec/fake_app/app/views/users/with_parameters_params.js.jbuilder
+- spec/fake_app/fake_app.rb
+- spec/fake_app/routes.rb
+- spec/features/dom_routes_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -82,19 +161,38 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Auto-magical scaffolding for Paul Irish's DOM-based Routing way of organizing
   your javascript.
-test_files: []
+test_files:
+- spec/fake_app/app/assets/javascripts/application.js
+- spec/fake_app/app/assets/javascripts/routes/application_routes.js
+- spec/fake_app/app/assets/javascripts/routes/dashboard/users_routes.js
+- spec/fake_app/app/assets/javascripts/routes/users_routes.js
+- spec/fake_app/app/controllers.rb
+- spec/fake_app/app/helpers.rb
+- spec/fake_app/app/views/dashboard/users/with_parameters.html.erb
+- spec/fake_app/app/views/dashboard/users/with_parameters_params.js.jbuilder
+- spec/fake_app/app/views/layouts/application.html.erb
+- spec/fake_app/app/views/users/different_route.html.erb
+- spec/fake_app/app/views/users/index.html.erb
+- spec/fake_app/app/views/users/manually_execute.html.erb
+- spec/fake_app/app/views/users/with_parameters.html.erb
+- spec/fake_app/app/views/users/with_parameters.js.jbuilder
+- spec/fake_app/app/views/users/with_parameters_params.js.jbuilder
+- spec/fake_app/fake_app.rb
+- spec/fake_app/routes.rb
+- spec/features/dom_routes_spec.rb
+- spec/spec_helper.rb