fancygrid 1.0.0

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

@@ -0,0 +1,175 @@
+(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;
+    });
+  });
+})();

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/grid_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe Fancygrid::Grid do
+  it "should get table name from model name" do
+    grid = Fancygrid::Grid.new(:ticket)
+    grid.record_table_name.should == "tickets"
+  end
+  
+  it "should get table name from class constant" do
+    grid = Fancygrid::Grid.new(:foo, Ticket)
+    grid.record_table_name.should == "tickets"
+  end
+  
+  
+end

data/spec/integration/navigation_spec.rb

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

data/spec/node_spec.rb

@@ -0,0 +1,326 @@
+require "spec_helper"
+
+describe Fancygrid::Node do
+
+  # builds a test structure with
+  # 14 leafs
+  # 3 nodes
+  # 3 levels
+  #
+  #     tickets
+  #       +- title
+  #       +- description
+  #       +- status
+  #       +- is_finished?
+  #       +- actions
+  #       +- project_id
+  #       +- project
+  #            +- title
+  #            +- class
+  #            +- actions
+  #            +- id
+  #            +- foo
+  #               +- title
+  #               +- foo
+  #               +- bar
+  #               +- id
+  #     
+  def build_testgrid
+    grid = Fancygrid::Grid.new(:ticket)
+    grid.attributes(:title, :description, :status)
+    grid.methods(:is_finished?)
+    grid.rendered(:actions)
+    grid.hidden(:project_id)
+    grid.columns_for(:project) do |p|
+      p.attributes(:title)
+      p.methods(:class)
+      p.rendered(:actions)
+      p.hidden(:id)
+      
+      p.columns_for(:foo, Project) do |f|
+        f.attributes(:title)
+        f.methods(:foo)
+        f.rendered(:bar)
+        f.hidden(:id)
+      end
+    end
+       
+    return grid 
+  end
+  
+  it "should build a fancygrid tree" do
+    
+    grid = build_testgrid  
+    grid.children.length.should be 7
+    grid.leafs.length.should be 14
+
+  end
+  
+  it "should find node by path" do
+    
+    grid = build_testgrid
+    grid.find_by_path("ticket").name.should == :ticket
+    grid.find_by_path("ticket.title").name.should == :title
+    grid.find_by_path("ticket.description").name.should == :description
+    grid.find_by_path("ticket.status").name.should == :status
+    grid.find_by_path("ticket.is_finished?").name.should == :is_finished?
+    grid.find_by_path("ticket.actions").name.should == :actions
+    grid.find_by_path("ticket.project_id").name.should == :project_id
+    
+    grid.find_by_path("ticket.project").name.should == :project
+    grid.find_by_path("ticket.project.title").name.should == :title
+    grid.find_by_path("ticket.project.class").name.should == :class
+    grid.find_by_path("ticket.project.actions").name.should == :actions
+    grid.find_by_path("ticket.project.id").name.should == :id
+    
+    grid.find_by_path("ticket.project.foo").name.should == :foo
+    grid.find_by_path("ticket.project.foo.title").name.should == :title
+    grid.find_by_path("ticket.project.foo.foo").name.should == :foo
+    grid.find_by_path("ticket.project.foo.bar").name.should == :bar
+    grid.find_by_path("ticket.project.foo.id").name.should == :id
+    
+  end
+  
+  it "should have a fancygrid instance as root" do
+    
+    grid = build_testgrid
+    grid.find_by_path("ticket").root.should be(grid)
+    grid.find_by_path("ticket.title").root.should be(grid)
+    grid.find_by_path("ticket.description").root.should be(grid)
+    grid.find_by_path("ticket.status").root.should be(grid)
+    grid.find_by_path("ticket.is_finished?").root.should be(grid)
+    grid.find_by_path("ticket.actions").root.should be(grid)
+    grid.find_by_path("ticket.project_id").root.should be(grid)
+    
+    grid.find_by_path("ticket.project").root.should be(grid)
+    grid.find_by_path("ticket.project.title").root.should be(grid)
+    grid.find_by_path("ticket.project.class").root.should be(grid)
+    grid.find_by_path("ticket.project.actions").root.should be(grid)
+    grid.find_by_path("ticket.project.id").root.should be(grid)
+    
+    grid.find_by_path("ticket.project.foo").root.should be(grid)
+    grid.find_by_path("ticket.project.foo.title").root.should be(grid)
+    grid.find_by_path("ticket.project.foo.foo").root.should be(grid)
+    grid.find_by_path("ticket.project.foo.bar").root.should be(grid)
+    grid.find_by_path("ticket.project.foo.id").root.should be(grid)
+    
+  end
+  
+  it "should be a leaf if has no children" do
+    
+    grid = build_testgrid
+    grid.find_by_path("ticket").is_leaf?.should be(false)
+    grid.find_by_path("ticket.title").is_leaf?.should be(true)
+    grid.find_by_path("ticket.description").is_leaf?.should be(true)
+    grid.find_by_path("ticket.status").is_leaf?.should be(true)
+    grid.find_by_path("ticket.is_finished?").is_leaf?.should be(true)
+    grid.find_by_path("ticket.actions").is_leaf?.should be(true)
+    grid.find_by_path("ticket.project_id").is_leaf?.should be(true)
+    
+    grid.find_by_path("ticket.project").is_leaf?.should be(false)
+    grid.find_by_path("ticket.project.title").is_leaf?.should be(true)
+    grid.find_by_path("ticket.project.class").is_leaf?.should be(true)
+    grid.find_by_path("ticket.project.actions").is_leaf?.should be(true)
+    grid.find_by_path("ticket.project.id").is_leaf?.should be(true)
+    
+    grid.find_by_path("ticket.project.foo").is_leaf?.should be(false)
+    grid.find_by_path("ticket.project.foo.title").is_leaf?.should be(true)
+    grid.find_by_path("ticket.project.foo.foo").is_leaf?.should be(true)
+    grid.find_by_path("ticket.project.foo.bar").is_leaf?.should be(true)
+    grid.find_by_path("ticket.project.foo.id").is_leaf?.should be(true)
+    
+  end
+  
+  it "should have a tag name if is a leaf" do
+    
+    grid = build_testgrid
+    grid.find_by_path("ticket").tag_name.should == nil
+    grid.find_by_path("ticket.title").tag_name.should == "tickets[title]"
+    grid.find_by_path("ticket.description").tag_name.should == "tickets[description]"
+    grid.find_by_path("ticket.status").tag_name.should == "tickets[status]"
+    grid.find_by_path("ticket.is_finished?").tag_name.should == "tickets[is_finished?]"
+    grid.find_by_path("ticket.actions").tag_name.should == "tickets[actions]"
+    grid.find_by_path("ticket.project_id").tag_name.should == "tickets[project_id]"
+    
+    grid.find_by_path("ticket.project").tag_name.should == nil
+    grid.find_by_path("ticket.project.title").tag_name.should == "projects[title]"
+    grid.find_by_path("ticket.project.class").tag_name.should == "projects[class]"
+    grid.find_by_path("ticket.project.actions").tag_name.should == "projects[actions]"
+    grid.find_by_path("ticket.project.id").tag_name.should == "projects[id]"
+    
+    grid.find_by_path("ticket.project.foo").tag_name.should == nil
+    grid.find_by_path("ticket.project.foo.title").tag_name.should == "projects[title]"
+    grid.find_by_path("ticket.project.foo.foo").tag_name.should == "projects[foo]"
+    grid.find_by_path("ticket.project.foo.bar").tag_name.should == "projects[bar]"
+    grid.find_by_path("ticket.project.foo.id").tag_name.should == "projects[id]"
+    
+  end
+  
+  it "should have a select name if is a leaf and is selectable" do
+    
+    grid = build_testgrid
+    grid.find_by_path("ticket").select_name.should == nil
+    grid.find_by_path("ticket.title").select_name.should == "tickets.title"
+    grid.find_by_path("ticket.description").select_name.should == "tickets.description"
+    grid.find_by_path("ticket.status").select_name.should == "tickets.status"
+    grid.find_by_path("ticket.is_finished?").select_name.should == nil
+    grid.find_by_path("ticket.actions").select_name.should == nil
+    grid.find_by_path("ticket.project_id").select_name.should == "tickets.project_id"
+    
+    grid.find_by_path("ticket.project").select_name.should == nil
+    grid.find_by_path("ticket.project.title").select_name.should == "projects.title"
+    grid.find_by_path("ticket.project.class").select_name.should == nil
+    grid.find_by_path("ticket.project.actions").select_name.should == nil
+    grid.find_by_path("ticket.project.id").select_name.should == "projects.id"
+    
+    grid.find_by_path("ticket.project.foo").select_name.should == nil
+    grid.find_by_path("ticket.project.foo.title").select_name.should == "projects.title"
+    grid.find_by_path("ticket.project.foo.foo").select_name.should == nil
+    grid.find_by_path("ticket.project.foo.bar").select_name.should == nil
+    grid.find_by_path("ticket.project.foo.id").select_name.should == "projects.id"
+    
+  end
+  
+  it "have a css class if is a leaf" do
+    
+    grid = build_testgrid
+    grid.find_by_path("ticket").css_class.should == nil
+    grid.find_by_path("ticket.title").css_class.should == "tickets title fg-orderable"
+    grid.find_by_path("ticket.description").css_class.should == "tickets description fg-orderable"
+    grid.find_by_path("ticket.status").css_class.should == "tickets status fg-orderable"
+    grid.find_by_path("ticket.is_finished?").css_class.should == "tickets is_finished?"
+    grid.find_by_path("ticket.actions").css_class.should == "tickets actions"
+    grid.find_by_path("ticket.project_id").css_class.should == "tickets project_id fg-orderable"
+    
+    grid.find_by_path("ticket.project").css_class.should == nil
+    grid.find_by_path("ticket.project.title").css_class.should == "projects title fg-orderable"
+    grid.find_by_path("ticket.project.class").css_class.should == "projects class"
+    grid.find_by_path("ticket.project.actions").css_class.should == "projects actions"
+    grid.find_by_path("ticket.project.id").css_class.should == "projects id fg-orderable"
+    
+    grid.find_by_path("ticket.project.foo").css_class.should == nil
+    grid.find_by_path("ticket.project.foo.title").css_class.should == "projects title fg-orderable"
+    grid.find_by_path("ticket.project.foo.foo").css_class.should == "projects foo"
+    grid.find_by_path("ticket.project.foo.bar").css_class.should == "projects bar"
+    grid.find_by_path("ticket.project.foo.id").css_class.should == "projects id fg-orderable"
+    
+  end
+  
+  it "should have an i18n path if is a leaf" do
+    
+    grid = build_testgrid
+    grid.find_by_path("ticket").i18n_path.should == nil
+    grid.find_by_path("ticket.title").i18n_path.should_not be nil
+    grid.find_by_path("ticket.description").i18n_path.should_not be nil
+    grid.find_by_path("ticket.status").i18n_path.should_not be nil
+    grid.find_by_path("ticket.is_finished?").i18n_path.should_not be nil
+    grid.find_by_path("ticket.actions").i18n_path.should_not be nil
+    grid.find_by_path("ticket.project_id").i18n_path.should_not be nil
+    
+    grid.find_by_path("ticket.project").i18n_path.should == nil
+    grid.find_by_path("ticket.project.title").i18n_path.should_not be nil
+    grid.find_by_path("ticket.project.class").i18n_path.should_not be nil
+    grid.find_by_path("ticket.project.actions").i18n_path.should_not be nil
+    grid.find_by_path("ticket.project.id").i18n_path.should_not be nil
+    
+    grid.find_by_path("ticket.project.foo").i18n_path.should == nil
+    grid.find_by_path("ticket.project.foo.title").i18n_path.should_not be nil
+    grid.find_by_path("ticket.project.foo.foo").i18n_path.should_not be nil
+    grid.find_by_path("ticket.project.foo.bar").i18n_path.should_not be nil
+    grid.find_by_path("ticket.project.foo.id").i18n_path.should_not be nil
+    
+  end
+  
+  it "should have a trace path" do
+    
+    grid = build_testgrid
+    grid.find_by_path("ticket").trace_path.should == "ticket"
+    grid.find_by_path("ticket.title").trace_path.should == "ticket.title"
+    grid.find_by_path("ticket.description").trace_path.should == "ticket.description"
+    grid.find_by_path("ticket.status").trace_path.should == "ticket.status"
+    grid.find_by_path("ticket.is_finished?").trace_path.should == "ticket.is_finished?"
+    grid.find_by_path("ticket.actions").trace_path.should == "ticket.actions"
+    grid.find_by_path("ticket.project_id").trace_path.should == "ticket.project_id"
+    
+    grid.find_by_path("ticket.project").trace_path.should == "ticket.project"
+    grid.find_by_path("ticket.project.title").trace_path.should == "ticket.project.title"
+    grid.find_by_path("ticket.project.class").trace_path.should == "ticket.project.class"
+    grid.find_by_path("ticket.project.actions").trace_path.should == "ticket.project.actions"
+    grid.find_by_path("ticket.project.id").trace_path.should == "ticket.project.id"
+    
+    grid.find_by_path("ticket.project.foo").trace_path.should == "ticket.project.foo"
+    grid.find_by_path("ticket.project.foo.title").trace_path.should == "ticket.project.foo.title"
+    grid.find_by_path("ticket.project.foo.foo").trace_path.should == "ticket.project.foo.foo"
+    grid.find_by_path("ticket.project.foo.bar").trace_path.should == "ticket.project.foo.bar"
+    grid.find_by_path("ticket.project.foo.id").trace_path.should == "ticket.project.foo.id"
+    
+  end
+  
+  
+  it "should get attributes from model" do
+    ticket = Ticket.new({
+      :title => "ticket title",
+      :description => "ticket description",
+      :status => "ticket status",
+      :project => Project.new({ :title => "project title" })
+    })
+    
+    grid = build_testgrid
+    grid.find_by_path("ticket.title").value_from(ticket).should == "ticket title"
+    grid.find_by_path("ticket.description").value_from(ticket).should == "ticket description"
+    grid.find_by_path("ticket.status").value_from(ticket).should == "ticket status"
+    grid.find_by_path("ticket.project.title").value_from(ticket).should == "project title"
+    
+  end
+  
+  it "should pass the visible option to node" do
+    
+    grid = Fancygrid::Grid.new(:ticket)
+    grid.column(:title, :visible => true )
+    grid.find_by_path("ticket.title").visible.should be true
+    
+    grid = Fancygrid::Grid.new(:ticket)
+    grid.column(:title, :visible => false )
+    grid.find_by_path("ticket.title").visible.should be false
+  end
+  
+  it "should pass the formatable option to node" do
+    
+    grid = Fancygrid::Grid.new(:ticket)
+    grid.column(:title, :formatable => true )
+    grid.find_by_path("ticket.title").formatable.should be true
+    
+    grid = Fancygrid::Grid.new(:ticket)
+    grid.column(:title, :formatable => false )
+    grid.find_by_path("ticket.title").formatable.should be false
+  end
+  
+  it "should pass the searchable option to node" do
+    
+    grid = Fancygrid::Grid.new(:ticket)
+    grid.column(:title, :searchable => true )
+    grid.find_by_path("ticket.title").searchable.should be true
+    
+    grid = Fancygrid::Grid.new(:ticket)
+    grid.column(:title, :searchable => false )
+    grid.find_by_path("ticket.title").searchable.should be false
+  end
+  
+  it "should pass the human name option to node" do
+    
+    grid = Fancygrid::Grid.new(:ticket)
+    grid.column(:title, :human_name => "custom human name" )
+    grid.find_by_path("ticket.title").human_name.should == "custom human name"
+    
+  end
+  
+  it "should pass the proc option to node" do
+    
+    ticket = Ticket.new(:title => "ticket title")
+    
+    grid = Fancygrid::Grid.new(:ticket)
+    grid.column(:title, :proc => Proc.new { |t| t.title } )
+    grid.find_by_path("ticket.title").proc_block.call(ticket).should == "ticket title"
+    grid.find_by_path("ticket.title").value_from(ticket).should == "ticket title"
+  end
+end