high_voltage 1.0.0 → 2.0.0

data/spec/dummy/public/javascripts/rails.js

@@ -0,0 +1,191 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var csrf_meta_tag = $$('meta[name=csrf-token]')[0];
+
+      if (csrf_meta_tag) {
+        var header = 'X-CSRF-Token',
+            token = csrf_meta_tag.readAttribute('content');
+
+        if (!request.options.requestHeaders) {
+          request.options.requestHeaders = {};
+        }
+        request.options.requestHeaders[header] = token;
+      }
+    }
+  });
+})();

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/high_voltage/page_finder_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe HighVoltage::PageFinder do
+  it 'produces the name of an existing template' do
+    find('existing').should eq 'pages/existing'
+  end
+
+  it 'produces the name of a nested template' do
+    find('dir/nested').should eq 'pages/dir/nested'
+  end
+
+  it 'uses a custom content path' do
+    with_content_path('other_pages/') do
+      find('also_exists').should eq 'other_pages/also_exists'
+    end
+  end
+
+  it 'exposes the content path' do
+    with_content_path('another_thing/') do
+      page_finder.content_path.should eq 'another_thing/'
+    end
+  end
+
+  it 'provides the page_id' do
+    subclass = Class.new(HighVoltage::PageFinder) do
+      def page_name
+        "the page is #{page_id}"
+      end
+    end
+
+    subclass.new('sweet page').page_name.should eq 'the page is sweet page'
+  end
+
+  private
+
+  def find(page_id)
+    page_finder(page_id).find
+  end
+
+  def page_finder(page_id = 'whatever')
+    HighVoltage::PageFinder.new(page_id)
+  end
+
+  def with_content_path(path)
+    original_content_path = HighVoltage.content_path
+    HighVoltage.content_path = path
+
+    yield
+
+    HighVoltage.content_path = original_content_path
+  end
+end

data/spec/high_voltage_spec.rb

@@ -0,0 +1,11 @@
+require 'minimal_spec_helper'
+
+describe HighVoltage do
+  it 'should be valid' do
+    HighVoltage.should be_a(Module)
+  end
+
+  it 'should be loadable without preloading rails' do
+    expect { require 'high_voltage' }.not_to raise_error
+  end
+end

data/spec/integration/navigation_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'Navigation' do
+  include Capybara::DSL
+
+  it 'should be a valid app' do
+    ::Rails.application.should be_a(Dummy::Application)
+  end
+end

data/spec/minimal_spec_helper.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+  config.mock_with :rspec
+end

data/spec/routing/routes_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe 'routes' do
+  context 'using default configuration' do
+    it 'should generate normal resource route with id' do
+      page_path('one').should eq '/pages/one'
+    end
+
+    it 'should generate normal resource route with string' do
+      page_path('one').should eq '/pages/one'
+    end
+
+    it 'should generate nested route with string' do
+      page_path('one/two').should eq '/pages/one/two'
+    end
+
+    it 'should recognize nested route' do
+      assert_recognizes(
+        {
+          :controller => 'high_voltage/pages',
+          :action => 'show',
+          :id => 'one/two'
+        },
+        '/pages/one/two'
+      )
+    end
+
+    it 'should recognize normal route' do
+      assert_recognizes(
+        {
+          :controller => 'high_voltage/pages',
+          :action => 'show',
+          :id => 'one'
+        },
+        '/pages/one'
+      )
+    end
+
+    it 'should recognize normal route with dots' do
+      assert_recognizes(
+        {
+          :controller => 'high_voltage/pages',
+          :action => 'show',
+          :id => 'one.two.three'
+        },
+        '/pages/one.two.three'
+      )
+    end
+  end
+
+  context 'using top-level routing configuration' do
+    around do |example|
+      cached_high_voltage_route_drawer = HighVoltage.route_drawer
+      HighVoltage.route_drawer = HighVoltage::RouteDrawers::Root
+      Rails.application.reload_routes!
+
+      example.run
+
+      HighVoltage.route_drawer = cached_high_voltage_route_drawer
+      Rails.application.reload_routes!
+    end
+
+    it 'should generate normal resource route with string' do
+      page_path('one').should eq '/one'
+    end
+
+    it 'should generate nested route with string' do
+      page_path('one/two').should eq '/one/two'
+    end
+  end
+
+  context 'using a custom content_path' do
+    around do |example|
+      cached_high_voltage_content_path = HighVoltage.content_path
+      HighVoltage.content_path = 'other_pages/'
+      Rails.application.reload_routes!
+
+      example.run
+
+      HighVoltage.content_path = cached_high_voltage_content_path
+      Rails.application.reload_routes!
+    end
+
+    it 'should generate normal resource route with string' do
+      page_path('one').should eq '/other_pages/one'
+    end
+
+    it 'should generate nested route with string' do
+      page_path('one/two').should eq '/other_pages/one/two'
+    end
+
+    it 'should recognize nested route' do
+      assert_recognizes(
+        {
+          :controller => 'high_voltage/pages',
+          :action => 'show',
+          :id => 'one/two'
+        },
+        '/other_pages/one/two'
+      )
+    end
+
+    it 'should recognize normal route' do
+      assert_recognizes(
+        {
+          :controller => 'high_voltage/pages',
+          :action => 'show',
+          :id => 'one'
+        },
+        '/other_pages/one'
+      )
+    end
+
+    it 'should recognize normal route with dots' do
+      assert_recognizes(
+        {
+          :controller => 'high_voltage/pages',
+          :action => 'show',
+          :id => 'one.two.three'
+        },
+        '/other_pages/one.two.three'
+      )
+    end
+  end
+
+  context 'with default configuration disabled' do
+    around do |example|
+      cached_high_voltage_routes = HighVoltage.routes
+      HighVoltage.routes = false
+      Rails.application.reload_routes!
+
+      example.run
+
+      HighVoltage.routes = cached_high_voltage_routes
+      Rails.application.reload_routes!
+    end
+
+    it 'should not recognize routes' do
+      { :get => '/pages/one/two' }.should_not be_routable
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'pry'
+require 'rails/test_help'
+require 'rspec/rails'
+require 'capybara/rails'
+
+Rails.backtrace_cleaner.remove_silencers!
+Capybara.default_driver = :rack_test
+Capybara.default_selector = :css
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each {|f| require f}
+
+RSpec.configure do |config|
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+  config.mock_with :rspec
+end

data/spec/support/caching.rb

@@ -0,0 +1,12 @@
+RSpec.configure do |config|
+  config.around(:each, enable_caching: true) do |example|
+    ActionController::Base.perform_caching = true
+    old_cache_store = ActionController::Base.cache_store
+    ActionController::Base.cache_store = :memory_store
+
+    example.run
+
+    ActionController::Base.cache_store = old_cache_store
+    ActionController::Base.perform_caching = false
+  end
+end

data/spec/support/concern_reload.rb

@@ -0,0 +1,11 @@
+def concern_reload
+  HighVoltage::PagesController.class_eval do
+    if respond_to?(:caches_action)
+      caches_action :show, if: -> { HighVoltage.action_caching }
+    end
+
+    if respond_to?(:caches_page)
+      caches_page :show, if: -> { HighVoltage.page_caching }
+    end
+  end
+end