acts_as_eav_model 0.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/fixtures/people.yml

@@ -0,0 +1,4 @@
+marcus:
+  id: 1
+  name: Marcus Wyatt
+  email: marcus@example.com

data/spec/fixtures/person_contact_infos.yml

@@ -0,0 +1,10 @@
+marcus_aim:
+  id: 1
+  contact_id: 1
+  name: aim
+  value: marcus.wyatt
+marcus_phone:
+  id: 2
+  contact_id: 1
+  name: phone
+  value: 021 356 0986

data/spec/fixtures/post_attributes.yml

@@ -0,0 +1,15 @@
+post_one_comment:
+  id: 1
+  post_id: 1
+  name: comment
+  value: Foo Bar Industries gets two thumbs up
+post_one_intro:
+  id: 2
+  post_id: 1
+  name: intro
+  value: We deliver quality foobars to consumers nationwide and around the globe
+post_one_teaser:
+  id: 3
+  post_id: 1
+  name: teaser
+  value: Coming October 7, the foobarantator

data/spec/fixtures/posts.yml

@@ -0,0 +1,9 @@
+one:
+  id: 1
+  title: Hello World
+  body: This is my first blog post. Great!
+  
+two:
+  id: 2
+  title: Following up from my first post.
+  body: I'm working on my first plugin today.

data/spec/fixtures/preferences.yml

@@ -0,0 +1,10 @@
+marcus_project_search:
+  id: 1
+  person_id: 1
+  key: project_search
+  value: project.owner LIKE '%anderson%'
+marcus_project_order:
+  id: 2
+  person_id: 1
+  key: project_order
+  value: name

data/spec/models/eav_model_with_no_arguments_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe "ActiveRecord Model annotated with 'has_eav_behavior' with no options in declaration" do
+  fixtures :posts, :post_attributes
+
+  it "should have many attributes" do
+    post_attr = Post.find_by_title("Hello World").post_attributes
+    post_attr[0].should be_instance_of(PostAttribute)
+    post_attr.size.should == 3
+  end
+  
+  it "should create new attribute on save" do
+    blog_post = Post.find_by_title("Following up from my first post.")
+    blog_post.send :write_attribute, 'new_attribute', 'new_value'
+
+    new_attribute = blog_post.post_attributes.to_a.find do |attribute|
+      attribute.name == 'new_attribute'
+    end
+    new_attribute.should_not be_nil
+
+    blog_post.send(:read_attribute, 'new_attribute').should == 'new_value'
+    PostAttribute.find_by_name_and_post_id('new_attribute', 2).should be_nil
+    blog_post.save!
+
+    PostAttribute.find_by_name_and_post_id('new_attribute', 2).value.should == 'new_value'
+    blog_post.send(:read_attribute, 'new_attribute').should == 'new_value'
+
+  end
+
+  it "should delete attribute" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post.send(:write_attribute, 'comment', nil)
+
+    comment = blog_post.post_attributes.find_by_name('comment')
+    comment.should_not be_nil
+
+    blog_post.send(:read_attribute, 'comment').should be_nil
+    blog_post.save!
+
+    blog_post.send(:read_attribute, 'comment').should be_nil
+
+    comment = blog_post.post_attributes.find_by_name('comment')
+    blog_post.send(:read_attribute, 'comment').should be_nil
+    PostAttribute.find_by_id(1).should be_nil
+  end
+  
+  it "should write eav attributes to attributes table" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post.send(:write_attribute, 'intro', 'Blah Blah Blah')
+    blog_post.send(:read_attribute, 'intro').should == 'Blah Blah Blah'
+    PostAttribute.find(2).value.should_not == 'Blah Blah Blah'
+    blog_post.save!
+    PostAttribute.find(2).value.should == 'Blah Blah Blah'
+  end
+  
+  it "should return nil when attribute does not exist" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post.send(:read_attribute, 'not_exist').should be_nil
+  end
+  
+  it "should use method missing to make attribute seem as native property" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post.comment.should == 'Foo Bar Industries gets two thumbs up'
+    blog_post.intro.should == 'We deliver quality foobars to consumers nationwide and around the globe'
+    blog_post.teaser.should == 'Coming October 7, the foobarantator'
+  end
+  
+  it "should read attributes using subscript notation" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post['comment'].should == 'Foo Bar Industries gets two thumbs up'
+    blog_post['intro'].should == 'We deliver quality foobars to consumers nationwide and around the globe'
+    blog_post['teaser'].should == 'Coming October 7, the foobarantator'
+  end
+  
+  it "should read the attribute when invoking 'read_attribute'" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post.send(:read_attribute, 'comment').should == 'Foo Bar Industries gets two thumbs up'
+    blog_post.send(:read_attribute, 'intro').should == 'We deliver quality foobars to consumers nationwide and around the globe'
+    blog_post.send(:read_attribute, 'teaser').should == 'Coming October 7, the foobarantator'
+  end
+  
+end

data/spec/models/eav_model_with_options_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+describe "ActiveRecord Model annotated with 'has_eav_behavior' with options in declaration" do
+  fixtures :people, :preferences, :person_contact_infos
+
+  it "should be 'has_many' association on both sides" do
+    marcus = Person.find_by_name('Marcus Wyatt')
+
+    prefs = marcus.preferences
+    prefs[0].should be_instance_of(Preference)
+    prefs.size.should == 2
+
+    contact_info = marcus.person_contact_infos
+    contact_info[0].should be_instance_of(PersonContactInfo)
+    contact_info.size.should == 2
+  end
+
+  it "should only allow restricted fields when specified (:fields => %w(phone aim icq))" do
+    marcus = Person.find_by_name('Marcus Wyatt')
+    marcus.aim.should == 'marcus.wyatt'
+    lambda { marcus.doesnt_exist }.should raise_error(NoMethodError)
+  end
+
+  it "should raise 'NoMethodError' when attribute not in 'eav_attributes' method array" do
+    marcus = Person.find_by_name('Marcus Wyatt')
+
+    marcus.project_order.should == 'name'
+    lambda { marcus.project_blah }.should raise_error(NoMethodError)
+  end
+
+  it "should raise 'NoMethodError' when attribute does not satisfy 'is_eav_attribute?' method" do
+    doc = Document.new
+
+    doc.copyright_attr.should be_nil
+    lambda { doc.no_exist }.should raise_error(NoMethodError)
+
+  end
+end

data/spec/models/eav_validation_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+describe "Validations on ActiveRecord Model annotated with 'has_eav_behavior'" do
+  
+  fixtures :posts, :post_attributes
+  
+  it "should execute as normal (validates_presence_of)" do
+    post = Post.create :comment => 'No Intro', :teaser => 'This should fail'
+    post.errors[:intro].should == ["can't be blank"]
+  end
+  
+end

data/spec/schema.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), 'fixtures/document')
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table "people", :force => true do |t|
+    t.string   "name"
+    t.string   "email"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "person_contact_infos", :force => true do |t|
+    t.integer "contact_id", :null => false
+    t.string  "name",       :null => false
+    t.string  "value",      :null => false
+  end
+
+  create_table "posts", :force => true do |t|
+    t.string   "title"
+    t.text     "body"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "post_attributes", :force => true do |t|
+    t.integer "post_id", :null => false
+    t.string "name", :null => false
+    t.string "value", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "preferences", :force => true do |t|
+    t.integer "person_id", :null => false
+    t.string  "key",       :null => false
+    t.string  "value",     :null => false
+  end
+  
+  create_table "documents", :force => true do |t|
+    t.string "name", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+  
+  create_table "document_attributes", :force => true do |t|
+    t.integer "document_id", :null => false
+    t.string "name", :null => false
+    t.string "value", :null => false
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+require "rspec/rails"
+
+#ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = false
+#ActionMailer::Base.default_url_options[:host] = "test.com"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Configure capybara for integration testing
+#require "capybara/rails"
+#Capybara.default_driver   = :rack_test
+#Capybara.default_selector = :css
+
+# Run any available migration
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+plugin_fixture_path = File.expand_path(File.dirname(__FILE__) + "/fixtures/")
+$LOAD_PATH.unshift(plugin_fixture_path)
+
+RSpec.configure do |config|
+  # Remove this line if you don't want Rspec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include Rspec::Matchers
+
+  # == Mock Framework
+  config.mock_with :rspec
+  config.fixture_path=plugin_fixture_path
+end
+load(File.dirname(__FILE__) + "/dummy/db/schema.rb")