injection 2.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/observer_inject_spec.rb

@@ -0,0 +1,228 @@
+require 'spec_helper'
+
+describe Injection::ObserverExtension do
+  subject { MyObserver.instance }
+  before do
+    @observations = []
+  end
+
+  it "should be able to define observations in a declaritive way" do
+    ActiveRecord::Callbacks::CALLBACKS.sort {|a,b| a.to_s <=> b.to_s}.each do |callback|
+      subject.update(callback, @observations)
+    end
+    
+    @observations.size.should == ActiveRecord::Callbacks::CALLBACKS.size
+    verify_after_observations
+    verify_before_observations
+    @observations.should be_empty
+  end
+  
+  it "should be able to define multiple on conditionals for validation observations" do
+    number_of_after_observations = 0
+    number_of_before_observations = 0
+    saved_record = nil
+    
+    EmptyObserver.class_eval do
+      after :validation do |record|
+        saved_record = record
+        number_of_after_observations = number_of_after_observations + 1
+      end
+      
+      before :validation do |record|
+        saved_record = record
+        number_of_before_observations = number_of_before_observations + 1
+      end
+    end
+    
+    observer = EmptyObserver.instance
+    
+    observer.update(:after_validation, "foo")
+    assert_equal "foo", saved_record, "wrong record"
+    
+    observer.update(:after_validation, "bar")
+    assert_equal "bar", saved_record, "wrong record"
+    
+    assert_equal 2, number_of_after_observations
+    
+    observer.update(:before_validation, "foo2")
+    assert_equal "foo2", saved_record, "wrong record"
+    observer.update(:before_validation, "bar2")
+    assert_equal "bar2", saved_record, "wrong record"
+    
+    assert_equal 2, number_of_before_observations
+  end
+  
+  it "should raise an error if invalid observations are given" do
+    assert_error(RuntimeError, "after_foo is not an observable action") do
+      MyObserver.class_eval do
+        after :foo do
+        end
+      end
+    end
+    
+    assert_error(RuntimeError, "before_bar is not an observable action") do
+      MyObserver.class_eval do 
+        before :bar do
+        end
+      end
+    end
+  end
+  
+  it "should inject from context when calling instance" do
+    observer = InjectedRecordObserver.instance
+    assert_same observer, InjectedRecordObserver.instance
+    verify_record_has_observer(observer, InjectedRecord)
+    verify_record_has_observer(observer, SubClassedInjectedRecord)
+    verify_record_has_observer(observer, DistantAncestorOfInjectedRecord)
+    
+    assert_kind_of MyObject, observer.my_object, "should be a MyObject instance"
+    assert_kind_of AnotherObject, observer.another_object, "should be AnotherObject instance"
+  end
+  
+  it "supports inheritance" do
+    observer = BigBangObserver.instance
+    assert_kind_of(MyObject, observer.my_object)
+    verify_record_has_observer(observer, BigBang)
+    
+    observer = GalaxyObserver.instance
+    assert_kind_of(MyObject, observer.my_object)
+    assert_kind_of(AnotherObject, observer.another_object)
+    verify_record_has_observer(observer, Galaxy)
+      
+    observer = SolarSystemObserver.instance
+    assert_kind_of(MyObject, observer.my_object)
+    assert_kind_of(AnotherObject, observer.another_object)
+    verify_record_has_observer(observer, SolarSystem)
+  end
+  
+  it "runs its own example" do
+    monkey = mock(:monkey)
+    target = BananaObserver.send(:new, :monkey => monkey)
+    banana = Banana.new
+
+    monkey.should_receive(:peels).with(banana)
+    target.update(:before_create, banana)
+  end
+  
+  #
+  # HELPERS
+  #
+
+  def verify_record_has_observer(observer, record)
+    record.count_observers.should > 0
+    assert_equal 1, record.count_observers
+    observers = record.add_observer(observer)
+    assert_same observer, observers.shift
+    assert_same observer, observers.shift
+  end
+  
+  def verify_after_observations
+    verify_observation(@observations.shift, :when => "after", :operation => "commit")
+    verify_observation(@observations.shift, :when => "after", :operation => "create")
+    verify_observation(@observations.shift, :when => "after", :operation => "destroy")
+    verify_observation(@observations.shift, :when => "after", :operation => "find")
+    verify_observation(@observations.shift, :when => "after", :operation => "initialize")
+    verify_observation(@observations.shift, :when => "after", :operation => "rollback")
+    verify_observation(@observations.shift, :when => "after", :operation => "save")
+    verify_observation(@observations.shift, :when => "after", :operation => "touch")
+    verify_observation(@observations.shift, :when => "after", :operation => "update")
+    verify_observation(@observations.shift, :when => "after", :operation => "validation")
+
+    verify_observation(@observations.shift, :when => "around", :operation => "create")
+    verify_observation(@observations.shift, :when => "around", :operation => "destroy")
+    verify_observation(@observations.shift, :when => "around", :operation => "save")
+    verify_observation(@observations.shift, :when => "around", :operation => "update")
+
+  end
+  
+  def verify_before_observations
+    verify_observation(@observations.shift, :when => "before", :operation => "create")
+    verify_observation(@observations.shift, :when => "before", :operation => "destroy")
+    verify_observation(@observations.shift, :when => "before", :operation => "save")
+    verify_observation(@observations.shift, :when => "before", :operation => "update")
+    verify_observation(@observations.shift, :when => "before", :operation => "validation")
+  end
+  
+  def verify_observation(actual, expected)
+    assert_equal expected, actual, "observations were not the same"
+  end
+  
+  def assert_error(err_type,*patterns,&block)
+    assert_not_nil block, "assert_error requires a block"
+    assert((err_type and err_type.kind_of?(Class)), "First argument to assert_error has to be an error type")
+    err = assert_raise(err_type) do
+      block.call
+    end
+    patterns.each do |pattern|
+      case pattern
+      when Regexp
+        assert_match(pattern, err.message) 
+      else
+        assert_equal pattern, err.message
+      end
+    end
+  end
+end
+
+class ObservableRecord < ActiveRecord::Base; end
+class MyObserver < ActiveRecord::Observer
+  observe ObservableRecord
+  
+  ActiveRecord::Callbacks::CALLBACKS.each do |callback|
+    actions = callback.to_s.split("_")
+    if actions.size == 2
+      case actions[0]
+        when "after"
+          after actions[1] do |record|
+            record << {:when => "after", :operation => actions[1]}
+          end
+        when "before"
+          before actions[1] do |record|
+            record << {:when => "before", :operation => actions[1]}
+          end
+        when "around"
+          around actions[1] do |record|
+            record << {:when => "around", :operation => actions[1]}
+          end
+      end
+    end
+  end
+end
+
+class EmptyObserver < ActiveRecord::Observer
+  observe ObservableRecord
+end
+
+class InjectedRecord < ActiveRecord::Base; end
+class SubClassedInjectedRecord < InjectedRecord; end
+class DistantAncestorOfInjectedRecord < SubClassedInjectedRecord; end
+class InjectedRecordObserver < ActiveRecord::Observer
+  inject :my_object, :another_object
+  attr_reader :my_object, :another_object
+end
+
+# Bad inheritance hierarchy, but whatever
+class BigBang < ActiveRecord::Base; end
+class BigBangObserver < ActiveRecord::Observer 
+  inject :my_object 
+  attr_accessor :my_object 
+end
+
+class Galaxy < ActiveRecord::Base; end
+class GalaxyObserver < BigBangObserver 
+  inject :another_object
+  attr_accessor :another_object, :my_object
+end
+
+class SolarSystem < ActiveRecord::Base; end
+class SolarSystemObserver < GalaxyObserver
+end
+
+class Banana < ActiveRecord::Base; end
+class BananaObserver < ActiveRecord::Observer
+  inject :monkey
+
+  before :create do |banana|
+    @monkey.peels(banana)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+# 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 = true
+# ActionMailer::Base.default_url_options[:host] = "test.com"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# 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 }
+
+module Helpers
+  def injection_context
+    Injection.context
+  end
+    
+  def set_context(path)
+    Injection.context_file = path
+    Injection.reset_context
+  end
+end
+
+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
+  config.include Helpers
+  
+  # == Mock Framework
+  config.mock_with :rspec
+end