edifice 1.0 → 1.1.0

data/edifice.gemspec

@@ -18,4 +18,10 @@ Gem::Specification.new do |s|
   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_development_dependency 'rake'
+  s.add_development_dependency 'rails'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'jquery-rails'
 end

data/lib/edifice.rb

@@ -1,7 +1,8 @@
-require 'edifice/helper'
 require 'edifice/controller'
+require 'edifice/helper'
 require 'edifice/renderer'
 
+
 module Edifice
   require 'edifice/engine' if defined?(Rails)
 end
@@ -9,4 +10,4 @@ end
 ActionController::Base.send :include, Edifice::Controller
 ActionMailer::Base.send :include, Edifice::Controller
 ActionView::Base.send :include, Edifice::Helper
-ActionView::Renderer.send :include, Edifice::Renderer
+ActionView::Renderer.send :include, Edifice::Renderer

data/lib/edifice/controller.rb

@@ -1,5 +1,4 @@
 module Edifice
-  
   module Controller
     def self.included(controller)
       controller.helper_method(:view_path, :view_path_normalized, 

data/lib/edifice/version.rb

@@ -1,3 +1,3 @@
 module Edifice
-  VERSION = "1.0"
+  VERSION = "1.1.0"
 end

data/spec/edifice_controller_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe TestController do
+  include RSpec::Rails::ControllerExampleGroup
+  render_views
+  
+  it 'should set correct body classes' do
+    get :base
+    assert_select 'body.c_test.v_base.l_application'
+  end
+  
+  it 'should set correct meta tags' do
+    get :base
+    
+    assert_select 'meta[name=edifice-view_path][content=test]'
+    assert_select 'meta[name=edifice-view_name][content=base]'
+    assert_select 'meta[name=edifice-layout][content=application]'
+  end
+  
+  it 'should set correct response headers' do
+    get :base
+    
+    response.headers.keys.should include('x-edifice-view_path', 'x-edifice-view_name', 'x-edifice-layout')
+    response.headers['x-edifice-view_path'].should ==('test')
+    response.headers['x-edifice-view_name'].should ==('base')
+    response.headers['x-edifice-layout'].should ==('application')
+  end
+end

data/spec/javascript_event_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'javascript events', :type => :request, :js => true do
+  it "should fire the onReady event" do
+    visit('/test/base')
+    
+    # this gets added onReady
+    page.should have_selector('h1.ready')
+  end
+  
+  it "should fire the onLoad event" do
+    visit('/test/base')
+    
+    # this gets added onReady
+    page.should have_selector('h1.load')
+  end
+  
+  it "should fire the onReady event via AJAX" do
+    visit('/test/empty')
+    page.should have_no_selector('h1.ready')
+    
+    page.evaluate_script('jQuery.get("/test/base")')
+    page.should have_selector('h1.ready')
+  end
+end

data/spec/pjax_support_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'pjax support', :type => :request, :js => true do
+  it "should alter the metatags when using pjax" do
+    visit('/test/empty')
+    page.should have_selector('meta[name=edifice-view_name][content=empty]')
+    
+    page.evaluate_script('jQuery.pjax({url: "/test/base", container: "body"})')
+    page.should have_selector('meta[name=edifice-view_name][content=base]')
+  end
+  
+  it "should not alter the metatags otherwise" do
+    visit('/test/empty')
+    page.should have_selector('meta[name=edifice-view_name][content=empty]')
+    
+    page.evaluate_script('jQuery.ajax("/test/base")')
+    page.should have_selector('meta[name=edifice-view_name][content=empty]')
+  end
+  
+  it "should alter the body classes when using pjax" do
+    visit('/test/empty')
+    page.should have_selector('body.v_empty')
+    
+    page.evaluate_script('jQuery.pjax({url: "/test/base", container: "body"})')
+    page.should have_selector('body.v_base')
+  end
+  
+  it "should not alter the body classes otherwise" do
+    visit('/test/empty')
+    page.should have_selector('body.v_empty')
+    
+    page.evaluate_script('jQuery.ajax("/test/base")')
+    page.should have_selector('body.v_empty')
+  end
+end

data/{test/rails3 → spec/rails3.1}/.gitignore

@@ -2,3 +2,4 @@
 db/*.sqlite3
 log/*.log
 tmp/
+.sass-cache/

data/spec/rails3.1/app/assets/javascripts/application.js

@@ -0,0 +1,10 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require edifice
+//= require_tree .

data/spec/rails3.1/app/assets/javascripts/test/base.js

@@ -0,0 +1,11 @@
+(function($) {
+  window.testBase = {
+    onReady: function() {
+      $('body').append('<h1 class="ready">');
+    },
+    
+    onLoad: function() {
+      $('body').append('<h1 class="load">');
+    }
+  }
+}(jQuery));

data/spec/rails3.1/app/assets/javascripts/vendor/jquery-pjax.js

@@ -0,0 +1,264 @@
+// jquery.pjax.js
+// copyright chris wanstrath
+// https://github.com/defunkt/jquery-pjax
+
+(function($){
+
+// When called on a link, fetches the href with ajax into the
+// container specified as the first parameter or with the data-pjax
+// attribute on the link itself.
+//
+// Tries to make sure the back button and ctrl+click work the way
+// you'd expect.
+//
+// Accepts a jQuery ajax options object that may include these
+// pjax specific options:
+//
+// container - Where to stick the response body. Usually a String selector.
+//             $(container).html(xhr.responseBody)
+//      push - Whether to pushState the URL. Defaults to true (of course).
+//   replace - Want to use replaceState instead? That's cool.
+//
+// For convenience the first parameter can be either the container or
+// the options object.
+//
+// Returns the jQuery object
+$.fn.pjax = function( container, options ) {
+  if ( options )
+    options.container = container
+  else
+    options = $.isPlainObject(container) ? container : {container:container}
+
+  // We can't persist $objects using the history API so we must use
+  // a String selector. Bail if we got anything else.
+  if ( options.container && typeof options.container !== 'string' ) {
+    throw "pjax container must be a string selector!"
+    return false
+  }
+
+  return this.live('click', function(event){
+    // Middle click, cmd click, and ctrl click should open
+    // links in a new tab as normal.
+    if ( event.which > 1 || event.metaKey )
+      return true
+
+    var defaults = {
+      url: this.href,
+      container: $(this).attr('data-pjax'),
+      clickedElement: $(this),
+      fragment: null
+    }
+
+    $.pjax($.extend({}, defaults, options))
+
+    event.preventDefault()
+  })
+}
+
+
+// Loads a URL with ajax, puts the response body inside a container,
+// then pushState()'s the loaded URL.
+//
+// Works just like $.ajax in that it accepts a jQuery ajax
+// settings object (with keys like url, type, data, etc).
+//
+// Accepts these extra keys:
+//
+// container - Where to stick the response body. Must be a String.
+//             $(container).html(xhr.responseBody)
+//      push - Whether to pushState the URL. Defaults to true (of course).
+//   replace - Want to use replaceState instead? That's cool.
+//
+// Use it just like $.ajax:
+//
+//   var xhr = $.pjax({ url: this.href, container: '#main' })
+//   console.log( xhr.readyState )
+//
+// Returns whatever $.ajax returns.
+var pjax = $.pjax = function( options ) {
+  var $container = $(options.container),
+      success = options.success || $.noop
+
+  // We don't want to let anyone override our success handler.
+  delete options.success
+
+  // We can't persist $objects using the history API so we must use
+  // a String selector. Bail if we got anything else.
+  if ( typeof options.container !== 'string' )
+    throw "pjax container must be a string selector!"
+
+  options = $.extend(true, {}, pjax.defaults, options)
+
+  if ( $.isFunction(options.url) ) {
+    options.url = options.url()
+  }
+
+  options.context = $container
+
+  options.success = function(data){
+    if ( options.fragment ) {
+      // If they specified a fragment, look for it in the response
+      // and pull it out.
+      var $fragment = $(data).find(options.fragment)
+      if ( $fragment.length )
+        data = $fragment.children()
+      else
+        return window.location = options.url
+    } else {
+        // If we got no data or an entire web page, go directly
+        // to the page and let normal error handling happen.
+        if ( !$.trim(data) || /<html/i.test(data) )
+          return window.location = options.url
+    }
+
+    // Make it happen.
+    this.html(data)
+
+    // If there's a <title> tag in the response, use it as
+    // the page's title.
+    var oldTitle = document.title,
+        title = $.trim( this.find('title').remove().text() )
+    if ( title ) document.title = title
+
+    // No <title>? Fragment? Look for data-title and title attributes.
+    if ( !title && options.fragment ) {
+      title = $fragment.attr('title') || $fragment.data('title')
+    }
+
+    var state = {
+      pjax: options.container,
+      fragment: options.fragment,
+      timeout: options.timeout
+    }
+
+    // If there are extra params, save the complete URL in the state object
+    var query = $.param(options.data)
+    if ( query != "_pjax=true" )
+      state.url = options.url + (/\?/.test(options.url) ? "&" : "?") + query
+
+    if ( options.replace ) {
+      window.history.replaceState(state, document.title, options.url)
+    } else if ( options.push ) {
+      // this extra replaceState before first push ensures good back
+      // button behavior
+      if ( !pjax.active ) {
+        window.history.replaceState($.extend({}, state, {url:null}), oldTitle)
+        pjax.active = true
+      }
+
+      window.history.pushState(state, document.title, options.url)
+    }
+
+    // Google Analytics support
+    if ( (options.replace || options.push) && window._gaq )
+      _gaq.push(['_trackPageview'])
+
+    // If the URL has a hash in it, make sure the browser
+    // knows to navigate to the hash.
+    var hash = window.location.hash.toString()
+    if ( hash !== '' ) {
+      window.location.href = hash
+    }
+
+    // Invoke their success handler if they gave us one.
+    success.apply(this, arguments)
+  }
+
+  // Cancel the current request if we're already pjaxing
+  var xhr = pjax.xhr
+  if ( xhr && xhr.readyState < 4) {
+    xhr.onreadystatechange = $.noop
+    xhr.abort()
+  }
+
+  pjax.options = options
+  pjax.xhr = $.ajax(options)
+  $(document).trigger('pjax', [pjax.xhr, options])
+
+  return pjax.xhr
+}
+
+
+pjax.defaults = {
+  timeout: 650,
+  push: true,
+  replace: false,
+  // We want the browser to maintain two separate internal caches: one for
+  // pjax'd partial page loads and one for normal page loads. Without
+  // adding this secret parameter, some browsers will often confuse the two.
+  data: { _pjax: true },
+  type: 'GET',
+  dataType: 'html',
+  beforeSend: function(xhr){
+    this.trigger('pjax:start', [xhr, pjax.options])
+    // start.pjax is deprecated
+    this.trigger('start.pjax', [xhr, pjax.options])
+    xhr.setRequestHeader('X-PJAX', 'true')
+  },
+  error: function(xhr, textStatus, errorThrown){
+    if ( textStatus !== 'abort' )
+      window.location = pjax.options.url
+  },
+  complete: function(xhr){
+    this.trigger('pjax:end', [xhr, pjax.options])
+    // end.pjax is deprecated
+    this.trigger('end.pjax', [xhr, pjax.options])
+  }
+}
+
+
+// Used to detect initial (useless) popstate.
+// If history.state exists, assume browser isn't going to fire initial popstate.
+var popped = ('state' in window.history), initialURL = location.href
+
+
+// popstate handler takes care of the back and forward buttons
+//
+// You probably shouldn't use pjax on pages with other pushState
+// stuff yet.
+$(window).bind('popstate', function(event){
+  // Ignore inital popstate that some browsers fire on page load
+  var initialPop = !popped && location.href == initialURL
+  popped = true
+  if ( initialPop ) return
+
+  var state = event.state
+
+  if ( state && state.pjax ) {
+    var container = state.pjax
+    if ( $(container+'').length )
+      $.pjax({
+        url: state.url || location.href,
+        fragment: state.fragment,
+        container: container,
+        push: false,
+        timeout: state.timeout
+      })
+    else
+      window.location = location.href
+  }
+})
+
+
+// Add the state property to jQuery's event object so we can use it in
+// $(window).bind('popstate')
+if ( $.inArray('state', $.event.props) < 0 )
+  $.event.props.push('state')
+
+
+// Is pjax supported by this browser?
+$.support.pjax =
+  window.history && window.history.pushState && window.history.replaceState
+  // pushState isn't reliable on iOS yet.
+  && !navigator.userAgent.match(/(iPod|iPhone|iPad|WebApps\/.+CFNetwork)/)
+
+
+// Fall back to normalcy for older browsers.
+if ( !$.support.pjax ) {
+  $.pjax = function( options ) {
+    window.location = $.isFunction(options.url) ? options.url() : options.url
+  }
+  $.fn.pjax = function() { return this }
+}
+
+})(jQuery);

data/spec/rails3.1/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/