heritage 0.1.0

data/heritage_demo/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/heritage_demo/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/heritage_demo/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/heritage_demo/test/fixtures/blog_posts.yml

@@ -0,0 +1,9 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+one:
+  predecessor_id: 1
+  body: MyText
+
+two:
+  predecessor_id: 1
+  body: MyText

data/heritage_demo/test/fixtures/image_posts.yml

@@ -0,0 +1,9 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+one:
+  predecessor_id: 1
+  aspect: 1
+
+two:
+  predecessor_id: 1
+  aspect: 1

data/heritage_demo/test/fixtures/posts.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+one:
+  heir_id: 1
+  heir_type: MyString
+  title: MyString
+
+two:
+  heir_id: 1
+  heir_type: MyString
+  title: MyString

data/heritage_demo/test/functional/blog_posts_controller_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class BlogPostsControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/heritage_demo/test/functional/image_posts_controller_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ImagePostsControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/heritage_demo/test/functional/posts_controller_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class PostsControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/heritage_demo/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'rails/performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionDispatch::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/heritage_demo/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/heritage_demo/test/unit/blog_post_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class BlogPostTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/heritage_demo/test/unit/helpers/blog_posts_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class BlogPostsHelperTest < ActionView::TestCase
+end

data/heritage_demo/test/unit/helpers/image_posts_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class ImagePostsHelperTest < ActionView::TestCase
+end

data/heritage_demo/test/unit/helpers/posts_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class PostsHelperTest < ActionView::TestCase
+end

data/heritage_demo/test/unit/image_post_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ImagePostTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/heritage_demo/test/unit/post_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class PostTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/lib/heritage.rb

@@ -0,0 +1,5 @@
+require 'rails'
+
+module Heritage
+  require 'heritage/railtie'
+end

data/lib/heritage/active_record/acts_as_heir.rb

@@ -0,0 +1,57 @@
+module Heritage
+  module ActiveRecord
+    module ActsAsHeir
+      
+      def acts_as_heir_of(predecessor_symbol)
+        extend ClassMethods
+        include InstanceMethods
+        
+        class_attribute :_predecessor_klass, :_predecessor_symbol
+        self._predecessor_symbol = predecessor_symbol
+        self._predecessor_klass = Object.const_get(predecessor_symbol.to_s.capitalize)
+        
+        has_one :predecessor, :as => :heir, :class_name => predecessor_symbol.to_s.capitalize, :autosave => true, :dependent => :destroy
+
+        alias_method_chain :predecessor, :build
+        
+        self._predecessor_klass.content_columns.map(&:name).each do |att|
+          define_method(att) do
+            predecessor.send(att)
+          end
+          define_method("#{att}=") do |val|
+            predecessor.send("#{att}=",val)
+          end
+        end
+        
+        # We need to make sure that updated_at values in the predecessor table is updated when the heir is saved.
+        after_update :touch_predecessor
+        
+        # Expose methods from predecessor
+        self._predecessor_klass.get_heritage_exposed_methods.each do |method_symbol|
+          define_method(method_symbol.to_s) do |*args|
+            if args.length > 0
+              predecessor.send(method_symbol.to_s, args)
+            else
+              predecessor.send(method_symbol.to_s)
+            end
+          end
+        end
+      end
+      
+      module ClassMethods
+        
+      end
+      
+      module InstanceMethods
+        def predecessor_with_build(attributes = {})
+          predecessor_without_build || build_predecessor(attributes)
+        end
+        
+        def touch_predecessor
+          predecessor.touch
+        end
+      end
+      
+    end
+  end
+end

data/lib/heritage/active_record/acts_as_predecessor.rb

@@ -0,0 +1,31 @@
+module Heritage
+  module ActiveRecord
+    module ActsAsPredecessor
+      
+      def acts_as_predecessor(options = {})
+        extend ClassMethods
+        include InstanceMethods
+        
+        options[:exposes] ||= []
+        class_attribute :_acts_as_predecessor_settings
+        self._acts_as_predecessor_settings = options
+        
+        belongs_to :heir, :polymorphic => true, :touch => true
+      end
+      
+      module ClassMethods
+        
+        def get_heritage_exposed_methods
+          result = self._acts_as_predecessor_settings[:exposes]
+          result.is_a?(Array) ? result : [result]
+        end
+        
+      end
+      
+      module InstanceMethods
+        
+      end
+      
+    end
+  end
+end

data/lib/heritage/railtie.rb

@@ -0,0 +1,20 @@
+require 'rails'
+
+module Heritage
+  
+  class Railtie < Rails::Railtie
+    
+    initializer 'heritage' do |app|
+      
+      ActiveSupport.on_load(:active_record) do
+        require 'heritage/active_record/acts_as_predecessor'
+        require 'heritage/active_record/acts_as_heir'
+        ::ActiveRecord::Base.send(:extend, Heritage::ActiveRecord::ActsAsPredecessor)
+        ::ActiveRecord::Base.send(:extend, Heritage::ActiveRecord::ActsAsHeir)
+      end
+      
+    end
+    
+  end
+  
+end