navi 0.0.2

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

@@ -0,0 +1,315 @@
+/**
+ * Unobtrusive scripting adapter for jQuery
+ *
+ * Requires jQuery 1.4.4 or later.
+ * https://github.com/rails/jquery-ujs
+
+ * Uploading file using rails.js
+ * =============================
+ *
+ * By default, browsers do not allow files to be uploaded via AJAX. As a result, if there are any non-blank file fields
+ * in the remote form, this adapter aborts the AJAX submission and allows the form to submit through standard means.
+ *
+ * The `ajax:aborted:file` event allows you to bind your own handler to process the form submission however you wish.
+ *
+ * Ex:
+ *     $('form').live('ajax:aborted:file', function(event, elements){
+ *       // Implement own remote file-transfer handler here for non-blank file inputs passed in `elements`.
+ *       // Returning false in this handler tells rails.js to disallow standard form submission
+ *       return false;
+ *     });
+ *
+ * The `ajax:aborted:file` event is fired when a file-type input is detected with a non-blank value.
+ *
+ * Third-party tools can use this hook to detect when an AJAX file upload is attempted, and then use
+ * techniques like the iframe method to upload the file instead.
+ *
+ * Required fields in rails.js
+ * ===========================
+ *
+ * If any blank required inputs (required="required") are detected in the remote form, the whole form submission
+ * is canceled. Note that this is unlike file inputs, which still allow standard (non-AJAX) form submission.
+ *
+ * The `ajax:aborted:required` event allows you to bind your own handler to inform the user of blank required inputs.
+ *
+ * !! Note that Opera does not fire the form's submit event if there are blank required inputs, so this event may never
+ *    get fired in Opera. This event is what causes other browsers to exhibit the same submit-aborting behavior.
+ *
+ * Ex:
+ *     $('form').live('ajax:aborted:required', function(event, elements){
+ *       // Returning false in this handler tells rails.js to submit the form anyway.
+ *       // The blank required inputs are passed to this function in `elements`.
+ *       return ! confirm("Would you like to submit the form with missing info?");
+ *     });
+ */
+
+(function($) {
+  // Shorthand to make it a little easier to call public rails functions from within rails.js
+  var rails;
+
+  $.rails = rails = {
+    // Link elements bound by jquery-ujs
+    linkClickSelector: 'a[data-confirm], a[data-method], a[data-remote]',
+
+    // Form elements bound by jquery-ujs
+    formSubmitSelector: 'form',
+
+    // Form input elements bound by jquery-ujs
+    formInputClickSelector: 'form input[type=submit], form input[type=image], form button[type=submit], form button:not([type])',
+
+    // Form input elements disabled during form submission
+    disableSelector: 'input[data-disable-with], button[data-disable-with], textarea[data-disable-with]',
+
+    // Form input elements re-enabled after form submission
+    enableSelector: 'input[data-disable-with]:disabled, button[data-disable-with]:disabled, textarea[data-disable-with]:disabled',
+
+    // Form required input elements
+    requiredInputSelector: 'input[name][required]:not([disabled]),textarea[name][required]:not([disabled])',
+
+    // Form file input elements
+    fileInputSelector: 'input:file',
+
+    // Make sure that every Ajax request sends the CSRF token
+    CSRFProtection: function(xhr) {
+      var token = $('meta[name="csrf-token"]').attr('content');
+      if (token) xhr.setRequestHeader('X-CSRF-Token', token);
+    },
+
+    // Triggers an event on an element and returns false if the event result is false
+    fire: function(obj, name, data) {
+      var event = $.Event(name);
+      obj.trigger(event, data);
+      return event.result !== false;
+    },
+
+    // Default confirm dialog, may be overridden with custom confirm dialog in $.rails.confirm
+    confirm: function(message) {
+      return confirm(message);
+    },
+
+    // Default ajax function, may be overridden with custom function in $.rails.ajax
+    ajax: function(options) {
+      return $.ajax(options);
+    },
+
+    // Submits "remote" forms and links with ajax
+    handleRemote: function(element) {
+      var method, url, data,
+        dataType = element.data('type') || ($.ajaxSettings && $.ajaxSettings.dataType);
+
+      if (rails.fire(element, 'ajax:before')) {
+
+        if (element.is('form')) {
+          method = element.attr('method');
+          url = element.attr('action');
+          data = element.serializeArray();
+          // memoized value from clicked submit button
+          var button = element.data('ujs:submit-button');
+          if (button) {
+            data.push(button);
+            element.data('ujs:submit-button', null);
+          }
+        } else {
+          method = element.data('method');
+          url = element.attr('href');
+          data = element.data('params') || null; 
+       }
+
+        rails.ajax({
+          url: url, type: method || 'GET', data: data, dataType: dataType,
+          // stopping the "ajax:beforeSend" event will cancel the ajax request
+          beforeSend: function(xhr, settings) {
+            if (settings.dataType === undefined) {
+              xhr.setRequestHeader('accept', '*/*;q=0.5, ' + settings.accepts.script);
+            }
+            return rails.fire(element, 'ajax:beforeSend', [xhr, settings]);
+          },
+          success: function(data, status, xhr) {
+            element.trigger('ajax:success', [data, status, xhr]);
+          },
+          complete: function(xhr, status) {
+            element.trigger('ajax:complete', [xhr, status]);
+          },
+          error: function(xhr, status, error) {
+            element.trigger('ajax:error', [xhr, status, error]);
+          }
+        });
+      }
+    },
+
+    // Handles "data-method" on links such as:
+    // <a href="/users/5" data-method="delete" rel="nofollow" data-confirm="Are you sure?">Delete</a>
+    handleMethod: function(link) {
+      var href = link.attr('href'),
+        method = link.data('method'),
+        csrf_token = $('meta[name=csrf-token]').attr('content'),
+        csrf_param = $('meta[name=csrf-param]').attr('content'),
+        form = $('<form method="post" action="' + href + '"></form>'),
+        metadata_input = '<input name="_method" value="' + method + '" type="hidden" />';
+
+      if (csrf_param !== undefined && csrf_token !== undefined) {
+        metadata_input += '<input name="' + csrf_param + '" value="' + csrf_token + '" type="hidden" />';
+      }
+
+      form.hide().append(metadata_input).appendTo('body');
+      form.submit();
+    },
+
+    /* Disables form elements:
+      - Caches element value in 'ujs:enable-with' data store
+      - Replaces element text with value of 'data-disable-with' attribute
+      - Adds disabled=disabled attribute
+    */
+    disableFormElements: function(form) {
+      form.find(rails.disableSelector).each(function() {
+        var element = $(this), method = element.is('button') ? 'html' : 'val';
+        element.data('ujs:enable-with', element[method]());
+        element[method](element.data('disable-with'));
+        element.attr('disabled', 'disabled');
+      });
+    },
+
+    /* Re-enables disabled form elements:
+      - Replaces element text with cached value from 'ujs:enable-with' data store (created in `disableFormElements`)
+      - Removes disabled attribute
+    */
+    enableFormElements: function(form) {
+      form.find(rails.enableSelector).each(function() {
+        var element = $(this), method = element.is('button') ? 'html' : 'val';
+        if (element.data('ujs:enable-with')) element[method](element.data('ujs:enable-with'));
+        element.removeAttr('disabled');
+      });
+    },
+
+   /* For 'data-confirm' attribute:
+      - Fires `confirm` event
+      - Shows the confirmation dialog
+      - Fires the `confirm:complete` event
+
+      Returns `true` if no function stops the chain and user chose yes; `false` otherwise.
+      Attaching a handler to the element's `confirm` event that returns a `falsy` value cancels the confirmation dialog.
+      Attaching a handler to the element's `confirm:complete` event that returns a `falsy` value makes this function
+      return false. The `confirm:complete` event is fired whether or not the user answered true or false to the dialog.
+   */
+    allowAction: function(element) {
+      var message = element.data('confirm'),
+          answer = false, callback;
+      if (!message) { return true; }
+
+      if (rails.fire(element, 'confirm')) {
+        answer = rails.confirm(message);
+        callback = rails.fire(element, 'confirm:complete', [answer]);
+      }
+      return answer && callback;
+    },
+
+    // Helper function which checks for blank inputs in a form that match the specified CSS selector
+    blankInputs: function(form, specifiedSelector, nonBlank) {
+      var inputs = $(), input,
+        selector = specifiedSelector || 'input,textarea';
+      form.find(selector).each(function() {
+        input = $(this);
+        // Collect non-blank inputs if nonBlank option is true, otherwise, collect blank inputs
+        if (nonBlank ? input.val() : !input.val()) {
+          inputs = inputs.add(input);
+        }
+      });
+      return inputs.length ? inputs : false;
+    },
+
+    // Helper function which checks for non-blank inputs in a form that match the specified CSS selector
+    nonBlankInputs: function(form, specifiedSelector) {
+      return rails.blankInputs(form, specifiedSelector, true); // true specifies nonBlank
+    },
+
+    // Helper function, needed to provide consistent behavior in IE
+    stopEverything: function(e) {
+      $(e.target).trigger('ujs:everythingStopped');
+      e.stopImmediatePropagation();
+      return false;
+    },
+
+    // find all the submit events directly bound to the form and
+    // manually invoke them. If anyone returns false then stop the loop
+    callFormSubmitBindings: function(form) {
+      var events = form.data('events'), continuePropagation = true;
+      if (events !== undefined && events['submit'] !== undefined) {
+        $.each(events['submit'], function(i, obj){
+          if (typeof obj.handler === 'function') return continuePropagation = obj.handler(obj.data);
+        });
+      }
+      return continuePropagation;
+    }
+  };
+
+  // ajaxPrefilter is a jQuery 1.5 feature
+  if ('ajaxPrefilter' in $) {
+    $.ajaxPrefilter(function(options, originalOptions, xhr){ rails.CSRFProtection(xhr); });
+  } else {
+    $(document).ajaxSend(function(e, xhr){ rails.CSRFProtection(xhr); });
+  }
+
+  $(rails.linkClickSelector).live('click.rails', function(e) {
+    var link = $(this);
+    if (!rails.allowAction(link)) return rails.stopEverything(e);
+
+    if (link.data('remote') !== undefined) {
+      rails.handleRemote(link);
+      return false;
+    } else if (link.data('method')) {
+      rails.handleMethod(link);
+      return false;
+    }
+  });
+
+  $(rails.formSubmitSelector).live('submit.rails', function(e) {
+    var form = $(this),
+      remote = form.data('remote') !== undefined,
+      blankRequiredInputs = rails.blankInputs(form, rails.requiredInputSelector),
+      nonBlankFileInputs = rails.nonBlankInputs(form, rails.fileInputSelector);
+
+    if (!rails.allowAction(form)) return rails.stopEverything(e);
+
+    // skip other logic when required values are missing or file upload is present
+    if (blankRequiredInputs && rails.fire(form, 'ajax:aborted:required', [blankRequiredInputs])) {
+      return rails.stopEverything(e);
+    }
+
+    if (remote) {
+      if (nonBlankFileInputs) {
+        return rails.fire(form, 'ajax:aborted:file', [nonBlankFileInputs]);
+      }
+
+      // If browser does not support submit bubbling, then this live-binding will be called before direct
+      // bindings. Therefore, we should directly call any direct bindings before remotely submitting form.
+      if (!$.support.submitBubbles && rails.callFormSubmitBindings(form) === false) return rails.stopEverything(e);
+
+      rails.handleRemote(form);
+      return false;
+    } else {
+      // slight timeout so that the submit button gets properly serialized
+      setTimeout(function(){ rails.disableFormElements(form); }, 13);
+    }
+  });
+
+  $(rails.formInputClickSelector).live('click.rails', function(event) {
+    var button = $(this);
+
+    if (!rails.allowAction(button)) return rails.stopEverything(event);
+
+    // register the pressed submit button
+    var name = button.attr('name'),
+      data = name ? {name:name, value:button.val()} : null;
+
+    button.closest('form').data('ujs:submit-button', data);
+  });
+
+  $(rails.formSubmitSelector).live('ajax:beforeSend.rails', function(event) {
+    if (this == event.target) rails.disableFormElements($(this));
+  });
+
+  $(rails.formSubmitSelector).live('ajax:complete.rails', function(event) {
+    if (this == event.target) rails.enableFormElements($(this));
+  });
+
+})( jQuery );

data/spec/dummy/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/spec/dummy/script/cucumber

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+vendored_cucumber_bin = Dir["#{File.dirname(__FILE__)}/../vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+if vendored_cucumber_bin
+  load File.expand_path(vendored_cucumber_bin)
+else
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'cucumber'
+  load Cucumber::BINARY
+end

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/navi/helpers_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Navi::Helpers do
+  
+end

data/spec/navi/navi_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Navi do
+  before :all do
+    # Since our test app uses :menu_item instead of the default :nav_item,
+    # Set it here
+    Navi.navigator = :menu_item
+  end
+
+  describe "with renderers," do
+    before do
+      class SomeRenderer
+      end
+    end
+
+    it "should default to Navi::Renderers::SimpleNavigation" do
+      Navi.renderer.should == Navi::Renderers::SimpleNavigation
+    end
+
+    it "should allow customization" do
+      Navi.renderer = SomeRenderer
+      Navi.renderer.should == SomeRenderer
+    end
+  end
+
+  describe "#to_navigator" do
+    describe "when the nav_item exists" do
+      it "should return the nav_item" do
+        c = Category.create
+        nav_item = MenuItem.create :navigable => c
+        c.to_navigator.should == nav_item
+      end
+    end
+
+    describe "when the nav_item does not exist" do
+      it "should return a new nav_item" do
+        c = Category.create
+        nav_item = c.to_navigator
+        nav_item.should be_new_record
+        nav_item.navigable.should == c
+      end
+    end
+
+    describe "and :label is passed" do
+      it "should create a new nav_item with the passed label" do
+        Category.create.to_navigator(:label => "Bosch").label.should == "Bosch"
+      end
+    end
+
+    describe "and :title is passed" do
+      it "should create a new nav_item with the passed title" do
+        Category.create.to_navigator(:title => "Titulo").title.should == "Titulo"
+      end
+    end
+
+    describe "when a parent is specified" do
+      it "should be created under that parent" do
+        cars = Category.create :name => "Cars"
+        chevy = Category.create :name => "Chevy"
+        cars_nav = cars.to_navigator
+        cars_nav.save
+        chevy_nav = chevy.to_navigator(:parent_id => cars_nav.id)
+        chevy_nav.save
+        chevy_nav.parent.should == cars_nav
+      end
+    end
+  end
+
+  describe "#to_navigator!" do
+    it "should immediately create the navigator item" do
+      category = Category.make
+      navigator = category.to_navigator!
+      navigator.should_not be_new_record
+    end
+  end
+end

data/spec/navi/navigator_spec.rb

@@ -0,0 +1,204 @@
+require 'spec_helper'
+
+describe MenuItem do
+  #before {reset_database}
+  describe "when configuring ordered_tree" do
+    # After we run the tests, reset the ordered tree changes we may have made
+    after { MenuItem.class_eval {
+      ordered_tree # set ordered_tree with no args
+      def scope_condition; "1"; end # this is the default scope condition in ordered_tree gem
+    } }
+
+    it "should allow overriding of ordered_tree's scope_condition" do
+      MenuItem.class_eval do
+        def scope_condition
+          "site_id = #{site_id}"
+        end
+      end
+      MenuItem.create(:site_id => 1)
+      MenuItem.create(:site_id => 2)
+      menu_item = MenuItem.create(:site_id => 1)
+      menu_item.position.should == 2
+    end
+
+    it "should allow reconfiguration of ordered_tree" do
+      MenuItem.class_eval do
+        ordered_tree :scope => :site
+      end
+      MenuItem.create(:site_id => 3)
+      MenuItem.create(:site_id => 4)
+      menu_item = MenuItem.create(:site_id => 3)
+      menu_item.position.should == 2
+    end
+  end
+
+  describe "#label" do
+    it "should return the database entry when it exists" do
+      MenuItem.new(:label => "Samba").label.should == "Samba"
+    end
+
+    describe "when label field is nil" do
+      describe "and there is a navigable model" do
+        describe "and there is a specified field" do
+          it "should default to the specified field in the navigable model" do
+            navigable Category, :label => :nombre do
+              c = Category.create :nombre => "Banana"
+              nav_item = MenuItem.new(:navigable => c)
+              nav_item.label.should == "Banana"
+            end
+          end
+        end
+
+        describe "and there is no specified field" do
+          it "should return nil" do
+            c = Category.create
+            nav_item = MenuItem.new(:navigable => c)
+            nav_item.label.should be_nil
+          end
+        end
+      end
+      
+      describe "and there is no navigable model" do
+        it "should return nil" do
+          MenuItem.new.label.should == nil
+        end
+      end
+    end
+  end
+
+  describe "#title," do
+    describe "when the title field is not nil," do
+      it "should return the value in the db" do
+        MenuItem.new(:title => "Mambo").title.should == "Mambo"
+      end
+    end
+
+    describe "when the title field is nil," do
+      describe "and there is a navigable," do
+        describe "and :title is set to a string," do
+          it "should return the string" do
+            navigable Category, :title => "Hola" do
+              c = Category.create
+              MenuItem.new(:navigable => c).title.should == "Hola"
+            end
+          end
+        end
+
+        describe "and :title is set to a Symbol," do
+          it "should look for the db column and return the value" do
+            navigable Category, :title => :nombre do
+              c = Category.create :nombre => "Mi nombre"
+              MenuItem.new(:navigable => c).title.should == "Mi nombre"
+            end
+          end
+        end
+
+        describe "and :title is set to a Proc," do
+          it "should execute the proc and return the value" do
+            navigable Category, :title => Proc.new {|x| "hi_#{x.name}"} do
+              c = Category.create :name => "there"
+              nav_item = MenuItem.new :navigable => c
+              nav_item.title.should == "hi_there"
+            end
+          end
+        end
+
+        describe "and :title is not set," do
+          it "should default to the value of the nav_item's link" do
+            c = Category.create
+            nav_item = MenuItem.new(:navigable => c)
+            nav_item.should_receive(:label).once
+            nav_item.title
+          end
+        end
+      end
+    end
+  end
+
+  describe "#link" do
+    describe "when the link field is not nil," do
+      it "should return the value" do
+        MenuItem.new(:link => "/holy/moly").link.should == "/holy/moly"
+      end
+    end
+
+    describe "when the link field is nil," do
+      describe "and there is a nav_item," do
+        it "should return the nav_item" do
+          # by returning the nav_item we can leave it up to the renderer to convert it to a URL
+          c = Category.create
+          MenuItem.new(:navigable => c).link.should == c
+        end
+      end
+
+      describe "and there is no nav_item," do
+        it "should return nil" do
+          MenuItem.new.link.should be_nil
+        end
+      end
+    end
+  end
+
+  describe "#highlights_on," do
+    describe "when the link field is not nil" do
+      it "should return the value converted to regex" do
+        MenuItem.new(:highlights_on => "holy").highlights_on.should == /holy/
+      end
+    end
+
+    describe "when the link field is nil," do
+      it "should return the same value as link" do
+        c = Category.create
+        nav_item = MenuItem.new(:navigable => c)
+        nav_item.highlights_on.should == c
+      end
+
+      describe "and there is a navigable," do
+        describe "and the :highlights_on option is set to a string," do
+          it "should return that string" do
+            navigable Category, :highlights_on => "foobar" do
+              c = Category.create
+              nav_item = MenuItem.new :navigable => c
+              nav_item.highlights_on.should == "foobar"
+            end
+          end
+        end
+
+        describe "and the :highlights_on option is set to a regexp," do
+          it "should return the regexp" do
+            navigable Category, :highlights_on => /foobar/ do
+              c = Category.create
+              nav_item = MenuItem.new :navigable => c
+              nav_item.highlights_on.should == /foobar/
+            end
+          end
+        end
+
+        describe "and the :highlights_on is set to a Proc," do
+          it "should execute the Proc on the navigable item and return the value" do
+            navigable Category, :highlights_on => Proc.new {|c| "hi_#{c.name}" } do
+              c = Category.create :name => "there"
+              nav_item = MenuItem.new :navigable => c
+              nav_item.highlights_on.should == "hi_there"
+            end
+          end
+        end
+
+        describe "and the :highlights_on is not set," do
+          it "should return the same value as the link" do
+            c = Category.create
+            nav_item = MenuItem.new(:navigable => c)
+            nav_item.highlights_on.should == nav_item.link
+          end
+        end
+      end
+
+      describe "and there is no navigable," do
+        it "should return nil" do
+          MenuItem.new.link.should be_nil
+        end
+      end
+    end
+
+  end
+end

data/spec/navi/renderers/simple_navigation_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+# SimpleNavigation can accept a array of hashes like so
+#[
+  #{:key => :main, :name => 'Main', :url => '/main', :options => {your options here}, :items => [
+    #{:key => :sub1, :name => 'Submenu 1', :url => '/sub1'},
+    #{:key => :sub2, :name => 'Submenu 2', :url => '/sub2'}
+  #]}, {...next primary item...}
+#]
+#
+# That means this is the output we need if we want to get it working with SimpleNavigation.
+
+describe Navi::Renderers::SimpleNavigation do
+  #class ControllerMock
+    #include SimpleNavigation::Helpers
+  #end
+  #it "should properly convert all the nav items to an array of hashes SimpleNavigation gem can understand" do
+    #about = Page.make(:name => "About").to_navigator!
+    #home = Page.make(:name => "Home").to_navigator!
+    #board_members = Page.make(:name => "Board Members").to_navigator!(:parent_id => about.id)
+
+    #rendered_navigation = Navi::Renderers::SimpleNavigation.render(MenuItem.roots)
+    #rendered_navigation.should == "something"
+    #[
+      #{
+        #:key => :"page_#{about.id}",
+        #:name => "About",
+        #:url => "/pages/#{about.id}",
+        #:options => {},
+        #:items => [
+          #{
+            #:key => :"page_#{board_members.id}",
+            #:name => "Board Members",
+            #:url => "/pages/#{board_members.id}",
+            #:options => {},
+            #:items => []
+          #}
+        #]
+      #},
+      #{
+        #:key => :"page_#{home.id}",
+        #:name => "Home",
+        #:url => "/pages/#{home.id}",
+        #:options => {},
+        #:items => []
+      #}
+    #]
+  #end
+end