somehow_has_relation 0.0.1

data/test/dummy3/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/test/dummy3/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/test/dummy3/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/test/somehow_has_relation_test.rb

@@ -0,0 +1,114 @@
+require 'test_helper'
+
+class SomehowHasRelationTest < ActiveSupport::TestCase
+  setup do
+    Post.somehow_has
+  end
+
+  test "somehow_has_relation is a Module" do
+    assert_kind_of Module, SomehowHasRelation
+  end
+
+  test "ActiveRecord::Base should have a somehow_has method" do
+    assert ActiveRecord::Base.methods.include? :somehow_has.to_s
+  end
+
+  test "when somehow_has is called, it should define SOMEHOW_HAS_RELATION" do
+    assert Post.const_defined?('SOMEHOW_HAS_RELATION')
+  end
+
+  test "an Hash of parameters should be passed to somehow_has" do
+    assert_equal Hash, Post::SOMEHOW_HAS_RELATION.class
+  end
+
+  test "reinitialize when somehow_has is called more than once" do
+    params = {:newparam => 'newvalue'}
+    Post.somehow_has params
+    assert_equal params, Post::SOMEHOW_HAS_RELATION
+  end
+
+  test "relations should work even when somehow_has has not been defined for first step" do
+    @post = Post.create(:author => Author.create, :comments => [Comment.create, Comment.create])
+
+    assert_equal @post.author, @post.related_author
+    assert_equal @post.comments, @post.related_comments
+  end
+
+  test "1-step relation defines a method prefixed with related_ for standard associations methods" do
+    @post = Post.create(:author => Author.create, :comments => [Comment.create, Comment.create])
+
+    Post.somehow_has :one => :author
+    assert_equal @post.author, @post.related_author
+
+    Post.somehow_has :many => :comments
+    assert_equal @post.comments, @post.related_comments
+  end
+
+  test "1-step relations also looks for belongs_to associations (with :has_one)" do
+    @bio = Bio.create(:author => Author.create)
+
+    Bio.somehow_has :one => :author
+    assert_equal @bio.author, @bio.related_author
+  end
+
+  test "2-steps relations use :through and define a related_ prefixed method named as the last association" do
+    comments = [Comment.create, Comment.create]
+    @author = Author.create(:bio => Bio.create(:comments => comments))
+
+    Author.somehow_has :many => :comments, :through => :bio
+    assert_equal comments, @author.related_comments
+  end
+
+  test "2-steps relations should return an array of arrays when there are nested has_many associations" do
+    comments1, comments2 = [Comment.create, Comment.create], [Comment.create, Comment.create]
+    posts = [Post.create(:comments => comments1), Post.create(:comments => comments2)]
+    @author = Author.create(:posts => posts)
+
+    Post.somehow_has :many => :comments
+    Author.somehow_has :many => :comments, :through => :posts
+    assert_equal [comments1, comments2].flatten, @author.related_comments
+  end
+
+  test "3-steps relations should work just like 2-steps and n-steps relations" do
+    comments1, comments2 = [Comment.create, Comment.create], [Comment.create, Comment.create]
+    posts = [Post.create(:comments => comments1), Post.create(:comments => comments2)]
+    author = Author.create(:posts => posts)
+    @bio = Bio.create(:author => author)
+
+    Post.somehow_has :many => :comments
+    Author.somehow_has :many => :comments, :through => :posts
+    Bio.somehow_has :many => :comments, :through => :author
+    assert_equal [comments1, comments2].flatten, @bio.related_comments
+  end
+
+  test "somehow_has takes an :if argument which specifies a Proc to check against relations" do
+    new_comment, old_comment = Comment.create, Comment.create
+    old_comment.update_attribute :created_at, 1.day.ago
+    recent_comments = Proc.new{|comment| comment.created_at >= 1.hour.ago }
+    @author = Author.create(:posts => [Post.create(:comments => [new_comment, old_comment])])
+
+    Author.somehow_has :many => :comments, :through => :posts, :if => recent_comments
+    assert_equal [new_comment], @author.related_comments
+  end
+
+  test "somehow_has takes an :if argument which specifies a Symbol for a method that returns a boolean to check against relations" do
+    new_comment, old_comment = Comment.create, Comment.create
+    old_comment.update_attribute :created_at, 1.day.ago
+    @author = Author.create(:posts => [Post.create(:comments => [new_comment, old_comment])])
+
+    Author.somehow_has :many => :comments, :through => :posts, :if => :recent?
+    assert_equal [new_comment], @author.related_comments
+  end
+
+  test "somehow_has takes an :as argument which overloads the defined related_%{relation_name} method name" do
+    Post.somehow_has :many => :comments, :as => :blabla
+    assert Post.instance_methods.include? :blabla.to_s
+  end
+
+  test ":if argument should also work for somehow_has :one" do
+    @bio = Bio.create(:author => Author.create)
+
+    Bio.somehow_has :one => :author, :if => Proc.new{|author| author.created_at <= 10.years.ago}
+    assert_nil @bio.related_author
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+ENV["RAILS_VER"] ||= "2"
+
+require "somehow_has_relation"
+
+require File.expand_path("../dummy#{ENV["RAILS_VER"]}/config/environment.rb",  __FILE__)
+
+if ENV["RAILS_VER"] == "2"
+  require "test_help" 
+else
+  require "rails/test_help"
+end
+
+require 'redgreen'
+
+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#{ENV["RAILS_VER"]}/db/migrate/", __FILE__)
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification 
+name: somehow_has_relation
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matteo Latini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-18 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: simple recursive activerecord relations for rails2 and rails3
+email: 
+- mtylty@gmail.com
+- m.latini@caspur.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/somehow_has_relation.rb
+- lib/somehow_has_relation/version.rb
+- somehow_has_relation.gemspec
+- test/dummy2/README
+- test/dummy2/Rakefile
+- test/dummy2/app/controllers/application_controller.rb
+- test/dummy2/app/helpers/application_helper.rb
+- test/dummy2/app/models/author.rb
+- test/dummy2/app/models/bio.rb
+- test/dummy2/app/models/comment.rb
+- test/dummy2/app/models/post.rb
+- test/dummy2/config/boot.rb
+- test/dummy2/config/database.yml
+- test/dummy2/config/environment.rb
+- test/dummy2/config/environments/development.rb
+- test/dummy2/config/environments/production.rb
+- test/dummy2/config/environments/test.rb
+- test/dummy2/config/initializers/backtrace_silencers.rb
+- test/dummy2/config/initializers/cookie_verification_secret.rb
+- test/dummy2/config/initializers/inflections.rb
+- test/dummy2/config/initializers/mime_types.rb
+- test/dummy2/config/initializers/new_rails_defaults.rb
+- test/dummy2/config/initializers/session_store.rb
+- test/dummy2/config/locales/en.yml
+- test/dummy2/config/routes.rb
+- test/dummy2/db/development.sqlite3
+- test/dummy2/db/migrate/20110316130454_create_posts.rb
+- test/dummy2/db/migrate/20110316142731_create_authors.rb
+- test/dummy2/db/migrate/20110316144725_create_comments.rb
+- test/dummy2/db/migrate/20110316154717_remove_post_id_from_author.rb
+- test/dummy2/db/migrate/20110316154912_add_author_id_to_post.rb
+- test/dummy2/db/migrate/20110316155523_create_bios.rb
+- test/dummy2/db/migrate/20110316155643_add_bio_id_to_comment.rb
+- test/dummy2/db/seeds.rb
+- test/dummy2/db/test.sqlite3
+- test/dummy2/log/development.log
+- test/dummy2/log/production.log
+- test/dummy2/log/server.log
+- test/dummy2/log/test.log
+- test/dummy2/public/404.html
+- test/dummy2/public/422.html
+- test/dummy2/public/500.html
+- test/dummy2/public/favicon.ico
+- test/dummy2/public/images/rails.png
+- test/dummy2/public/index.html
+- test/dummy2/public/javascripts/application.js
+- test/dummy2/public/javascripts/controls.js
+- test/dummy2/public/javascripts/dragdrop.js
+- test/dummy2/public/javascripts/effects.js
+- test/dummy2/public/javascripts/prototype.js
+- test/dummy2/public/robots.txt
+- test/dummy2/script/about
+- test/dummy2/script/console
+- test/dummy2/script/dbconsole
+- test/dummy2/script/destroy
+- test/dummy2/script/generate
+- test/dummy2/script/performance/benchmarker
+- test/dummy2/script/performance/profiler
+- test/dummy2/script/plugin
+- test/dummy2/script/runner
+- test/dummy2/script/server
+- test/dummy2/test/fixtures/authors.yml
+- test/dummy2/test/fixtures/bios.yml
+- test/dummy2/test/fixtures/comments.yml
+- test/dummy2/test/fixtures/posts.yml
+- test/dummy2/test/unit/author_test.rb
+- test/dummy2/test/unit/bio_test.rb
+- test/dummy2/test/unit/comment_test.rb
+- test/dummy2/test/unit/post_test.rb
+- test/dummy3/.gitignore
+- test/dummy3/Rakefile
+- test/dummy3/app/controllers/application_controller.rb
+- test/dummy3/app/helpers/application_helper.rb
+- test/dummy3/app/models/author.rb
+- test/dummy3/app/models/bio.rb
+- test/dummy3/app/models/comment.rb
+- test/dummy3/app/models/post.rb
+- test/dummy3/app/views/layouts/application.html.erb
+- test/dummy3/config.ru
+- test/dummy3/config/application.rb
+- test/dummy3/config/boot.rb
+- test/dummy3/config/database.yml
+- test/dummy3/config/environment.rb
+- test/dummy3/config/environments/development.rb
+- test/dummy3/config/environments/production.rb
+- test/dummy3/config/environments/test.rb
+- test/dummy3/config/initializers/backtrace_silencers.rb
+- test/dummy3/config/initializers/inflections.rb
+- test/dummy3/config/initializers/mime_types.rb
+- test/dummy3/config/initializers/secret_token.rb
+- test/dummy3/config/initializers/session_store.rb
+- test/dummy3/config/locales/en.yml
+- test/dummy3/config/routes.rb
+- test/dummy3/db/migrate/20110317224541_create_posts.rb
+- test/dummy3/db/migrate/20110317224616_create_bios.rb
+- test/dummy3/db/migrate/20110317224637_create_comments.rb
+- test/dummy3/db/migrate/20110317230301_create_authors.rb
+- test/dummy3/db/seeds.rb
+- test/dummy3/lib/tasks/.gitkeep
+- test/dummy3/public/404.html
+- test/dummy3/public/422.html
+- test/dummy3/public/500.html
+- test/dummy3/public/favicon.ico
+- test/dummy3/public/images/rails.png
+- test/dummy3/public/index.html
+- test/dummy3/public/javascripts/application.js
+- test/dummy3/public/javascripts/controls.js
+- test/dummy3/public/javascripts/dragdrop.js
+- test/dummy3/public/javascripts/effects.js
+- test/dummy3/public/javascripts/prototype.js
+- test/dummy3/public/javascripts/rails.js
+- test/dummy3/public/robots.txt
+- test/dummy3/public/stylesheets/.gitkeep
+- test/dummy3/script/rails
+- test/somehow_has_relation_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/mtylty/somehow_has_relation
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: somehow_has_relation
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: somehow_has_relation is a tiny gem that makes it easy to traverse multiple  ActiveRecord associations by defining a somehow_has method. When somehow_has is defined on multiple models, the gem will try to look  recursively to find other models on which somehow_has has been defined.
+test_files: []
+