rails_dynamic_associations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02f1e9739f27b665443124374994afc6729e4e8f
+  data.tar.gz: f5d07be362c9b98969dfe4b5b0109f6b429f2c0f
+SHA512:
+  metadata.gz: 5ee36ecaeee3642a97e3875c93c365e7323ac01ecc6fd7db0f2e67310eaf3a23aa61d9a0e351ee88b5c98f7de8d676f31fa456a1d992167dd8e37d4a9e9fd6ec
+  data.tar.gz: fc3ce8c1acbdebba32efd429e06eb5fc0b3390fc72163eb28905730f0a6293f5e0222fd67b2d89b8045a87aa138157f7b43b105bb070a7581efda2e0a0422802

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Alexander Senko, SoftPro Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# RailsDynamicAssociations
+
+Define your model associations in the database without changing the schema or models.
+
+## Features
+
+* Creates associations for your models when application starts.
+* Provides `Relation` & `Role` models.
+* No configuration code needed.
+* No code generated or inserted to your app (except migrations).
+* Adds some useful methods to `ActiveRecord` objects to handle their relations.
+
+## Installation
+
+1. Add the gem to your `Gemfile` and `bundle` it.
+2. Copy migrations to your app (`rake rails_dynamic_associations:install:migrations`).
+3. Migrate the DB (`rake db:migrate`).
+
+## Usage
+
+Add configuration records to the DB:
+
+``` ruby
+	Relation.create({
+		source_type: Person,
+		target_type: Book,
+	})
+```
+
+Or use a helper method:
+
+``` ruby
+	Relation.seed Person, Book
+```
+
+Now you have:
+
+``` ruby
+	person.books
+	book.people
+```
+
+### Roles
+
+You can create multiple role-based associations between two models.
+
+``` ruby
+	Relation.seed Person, Book, %w[
+		author
+		editor
+	]
+```
+
+You will get:
+
+``` ruby
+	person.books
+	person.authored_books
+	person.edited_books
+
+	book.people
+	book.author_people
+	book.editor_people
+```
+
+#### `User` special case
+
+In case you have set up relations with a `User` model you'll get a slightly different naming:
+
+``` ruby
+	Relation.seed User, Book, %w[
+		author
+		editor
+	]
+```
+
+``` ruby
+	book.users
+	book.authors
+	book.editors
+```
+
+###### TODO
+
+* Describe self-referential associations.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+begin
+	require 'bundler/setup'
+rescue LoadError
+	puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+	require 'rdoc/task'
+rescue LoadError
+	require 'rdoc/rdoc'
+	require 'rake/rdoctask'
+	RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+	rdoc.rdoc_dir = 'rdoc'
+	rdoc.title    = 'RailsDynamicAssociations'
+	rdoc.options << '--line-numbers'
+	rdoc.rdoc_files.include('README.md')
+	rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks
+

data/app/models/relation.rb

@@ -0,0 +1,78 @@
+class Relation < ActiveRecord::Base
+	belongs_to :source, polymorphic: true
+	belongs_to :target, polymorphic: true
+	belongs_to :role
+
+	delegate :name, to: :role, allow_nil: true
+
+	RailsDynamicAssociations.directions.each &-> (attribute, direction) do
+		scope "#{direction}_abstract", -> (object = nil) {
+			if object then
+				send direction, object
+			else
+				all
+			end.
+				where "#{attribute}_id"   => nil
+		}
+
+		scope "#{direction}_general", -> {
+			send("#{direction}_abstract").
+				where "#{attribute}_type" => nil
+		}
+
+		scope direction, -> (object) {
+			case object
+			when nil then
+				all
+			when Symbol then
+				send "#{direction}_#{object}"
+			when Class then
+				where "#{attribute}_type" => object.base_class
+			else
+				where "#{attribute}_type" => object.class.base_class,
+				      "#{attribute}_id"   => object.id
+			end
+		}
+	end
+
+	scope :abstract, -> {
+		of_abstract.to_abstract
+	}
+
+	scope :applied, -> {
+		where.not source_id: nil,
+		          target_id: nil
+	}
+
+	scope :named, -> (*names) {
+		if names.present? then
+			where     roles: { name: names.flatten.map(&:to_s) }
+		else
+			where.not roles: { name: nil }
+		end.
+			includes :role
+	}
+
+	def self.seed source, target, roles = nil
+		(roles.present? ? by_roles(roles) : [ self ]).map do |scope|
+			scope.create source_type: source,
+			             target_type: target
+		end
+	end
+
+	def self.by_roles *names
+		Role.find_or_create_named(*names).
+			map &:relations
+	end
+
+
+	# Using polymorphic associations in combination with single table inheritance (STI) is
+	# a little tricky. In order for the associations to work as expected, ensure that you
+	# store the base model for the STI models in the type column of the polymorphic
+	# association.
+	for reflection in reflections.values.select { |r| r.options[:polymorphic] } do
+		define_method "#{reflection.name}_type=" do |type|
+			super type && type.to_s.classify.constantize.base_class.to_s
+		end
+	end
+end

data/app/models/role.rb

@@ -0,0 +1,32 @@
+class Role < ActiveRecord::Base
+	has_many :relations
+
+	validates :name, presence: true, uniqueness: true
+
+	scope :named, -> (*names) {
+		where name: names.flatten.map(&:to_s)
+	}
+
+	scope :available, -> {
+		includes(:relations).
+			where relations: { id: Relation.of_abstract } # TODO: simplify
+	}
+
+	scope :in, -> (object) {
+		where relations: { id: object.source_relations } # TODO: simplify
+	}
+
+	scope :for, -> (subject) {
+		where relations: { id: subject.target_relations } # TODO: simplify
+	}
+
+	def self.find_or_create_named *names
+		names.flatten!
+		names.compact!
+
+		(existing = named(names)).all +
+			(names - existing.map(&:name)).map { |name|
+				create name: name
+			}
+	end
+end

data/config/initializers/model_associations.rb

@@ -0,0 +1,9 @@
+ActiveSupport.on_load :model_class do
+	for type in RailsDynamicAssociations.directions.keys do
+		for relation in send("#{type}_relations").abstract.select(&:"#{type}_type") do
+			setup_relation type, relation.send("#{type}_type").constantize, relation.role do |association|
+				attr_accessible "#{association.to_s.singularize}_ids"
+			end
+		end
+	end if self != Relation and Relation.table_exists? # needed for DB migrations & schema initializing
+end

data/db/migrate/01_create_roles.rb

@@ -0,0 +1,10 @@
+class CreateRoles < ActiveRecord::Migration
+	def change
+		create_table :roles do |t|
+			t.string :name
+			t.timestamps
+		end
+
+		add_index :roles, :name, unique: true
+	end
+end

data/db/migrate/02_create_relations.rb

@@ -0,0 +1,14 @@
+class CreateRelations < ActiveRecord::Migration
+	def change
+		create_table :relations do |t|
+			t.references :source, polymorphic: { default: 'User' }
+			t.references :target, polymorphic: true
+			t.references :role
+
+			t.timestamps
+		end
+
+		add_index :relations, [ :source_id, :source_type, :target_id, :target_type, :role_id ], unique: true,
+		          name: 'index_relations_on_source_and_target_and_role'
+	end
+end

data/lib/core_ext/string.rb

@@ -0,0 +1,8 @@
+##
+# TODO: refactor
+#
+class String
+	def passivize
+		sub(/(e?d?|[eo]r|ant)$/, 'ed')
+	end unless method_defined? :passivize
+end

data/lib/rails_dynamic_associations/active_record/associations.rb

@@ -0,0 +1,101 @@
+require 'active_support/concern'
+
+module RailsDynamicAssociations::ActiveRecord
+	module Associations
+		extend ActiveSupport::Concern
+
+		module ClassMethods
+			protected
+
+			def setup_relation type, target = self, role = nil
+				define_association type, target
+				define_association type, target, role if role
+
+				for association, method in RailsDynamicAssociations.self_referential_recursive do
+					define_recursive_methods association, method if association.in? reflections and not method_defined? method
+				end
+			end
+
+			private
+
+			def define_relations_association type, target = self, role = nil
+				:"#{role ? association_name(type, target, role).to_s.singularize : type}_relations".tap do |association|
+					unless association.in? reflections then
+						has_many association, conditions: role && { role_id: role.id },
+						         as: (RailsDynamicAssociations.directions.keys - [ type ]).first, class_name: 'Relation'
+					end
+				end
+			end
+
+			def define_association type, target = self, role = nil
+				unless (association = association_name(type, target, role)).in? reflections then
+					has_many association,
+					         through:     define_relations_association(type, target, role),
+					         source:      type,
+					         source_type: target.base_class.name,
+					         class_name:  target.name
+
+					define_association_with_roles association unless role
+
+					yield association if block_given?
+				end
+			end
+
+			def define_association_with_roles association
+				redefine_method "#{association}_with_roles" do |*roles|
+					send(association).where(
+						relations: {
+							role_id: Role.named(roles).pluck(:id)
+						}
+					)
+				end
+			end
+
+			def define_recursive_methods association, method, tree_method = "#{method.to_s.singularize}_tree", distance_method = "#{method}_with_distance"
+				redefine_method tree_method do
+					send(association).inject([]) { |tree, node|
+						tree << node << node.send(tree_method)
+					}.reject &:blank?
+				end
+
+				redefine_method distance_method do
+					(with_distance = -> (level, distance) {
+						if level.is_a? Array then
+							level.inject(ActiveSupport::OrderedHash.new) { |hash, node|
+								hash.merge with_distance[node, distance.next]
+							}
+						else
+							{ level => distance }
+						end
+					})[send(tree_method), 0]
+				end
+
+				redefine_method method do
+					send(tree_method).flatten
+				end
+			end
+
+			def association_name type, target = self, role = nil
+				if role then
+					if target == self || target <= User then
+						{
+							source: role.name,
+							target: "#{role.name.passivize}_#{target.name.split('::').reverse.join}",
+						}[type]
+					else
+						"#{{
+							source: role.name,
+							target: role.name.passivize,
+						}[type]}_#{association_name type, target}"
+					end
+				else
+					if target == self then
+						RailsDynamicAssociations.self_referential_recursive[type].to_s
+					else
+						target.name.split('::').reverse.join
+					end
+				end.tableize.to_sym
+			end
+		end
+	end
+end

data/lib/rails_dynamic_associations/active_record/relations.rb

@@ -0,0 +1,62 @@
+require 'active_support/concern'
+
+module RailsDynamicAssociations::ActiveRecord
+	module Relations
+		extend ActiveSupport::Concern
+
+		included do
+			extend  ClassAndInstanceMethods
+			include ClassAndInstanceMethods
+		end
+
+		module ClassMethods
+			RailsDynamicAssociations.opposite_directions.each &-> (association, method) do
+				define_method "#{association}_relations" do
+					Relation.send method, self
+				end
+			end
+		end
+
+		module ClassAndInstanceMethods
+			# TODO: use keyword arguments
+			def find_relations args = {}
+				directions = RailsDynamicAssociations.directions
+
+				for association, method in directions do
+					args[association] = args.delete method
+				end
+
+				as = [ args[:as] ].flatten
+
+				if directions.keys.inject(nil) { |r, k| !r ^ !args[k] } then # direction specified
+					for association, method in directions do
+						next unless args[association]
+
+						return (as.present? ?
+							source_relations.named(as) :
+							source_relations
+						).send method, args[association]
+					end
+				else # both directions
+					directions.map do |association, method|
+						as.present? ?
+							send("#{association}_relations").named(as) :
+							send("#{association}_relations")
+					end.sum
+				end
+			end
+
+			def relative? args = {}
+				find_relations(args).
+					present?
+			end
+
+			def relatives args = {}
+				find_relations(args).
+					map { |r|
+						([ r.source, r.target ] - [ self ]).first
+					}.uniq
+			end
+		end
+	end
+end

data/lib/rails_dynamic_associations/active_record/roles.rb

@@ -0,0 +1,24 @@
+require 'active_support/concern'
+
+module RailsDynamicAssociations::ActiveRecord
+	module Roles
+		extend ActiveSupport::Concern
+
+		included do
+			extend  ClassAndInstanceMethods
+			include ClassAndInstanceMethods
+		end
+
+		module ClassAndInstanceMethods
+			def roles to: nil, &block
+				if block_given? then
+					source_relations.instance_eval &block
+				else
+					source_relations
+				end.
+					to(to).
+						map(&:name).uniq
+			end
+		end
+	end
+end

data/lib/rails_dynamic_associations/active_record.rb

@@ -0,0 +1,9 @@
+require 'rails_dynamic_associations/active_record/associations'
+require 'rails_dynamic_associations/active_record/relations'
+require 'rails_dynamic_associations/active_record/roles'
+
+ActiveSupport.on_load :active_record do
+	include RailsDynamicAssociations::ActiveRecord::Associations
+	include RailsDynamicAssociations::ActiveRecord::Relations
+	include RailsDynamicAssociations::ActiveRecord::Roles
+end

data/lib/rails_dynamic_associations/engine.rb

@@ -0,0 +1,5 @@
+module RailsDynamicAssociations
+	class Engine < ::Rails::Engine
+		isolate_namespace RailsDynamicAssociations
+	end
+end

data/lib/rails_dynamic_associations/version.rb

@@ -0,0 +1,3 @@
+module RailsDynamicAssociations
+	VERSION = '0.1.0'
+end

data/lib/rails_dynamic_associations.rb

@@ -0,0 +1,35 @@
+require 'rails_model_load_hook'
+
+require 'rails_dynamic_associations/engine'
+require 'core_ext/string'
+
+module RailsDynamicAssociations
+	mattr_accessor :directions,
+	               :self_referential,
+	               :self_referential_recursive
+
+	self.directions = {
+		source: :of,
+		target: :to,
+	}
+
+	self.self_referential = {
+		source: :child,
+		target: :parent,
+	}
+
+	self.self_referential_recursive = {
+		parents:  :ancestors,
+		children: :descendants,
+	}
+
+	def self.opposite_directions
+		directions.each_with_object({}) do |(key, value), hash|
+			hash[key] = directions.values.find do |v|
+				v != value
+			end
+		end
+	end
+end
+
+require 'rails_dynamic_associations/active_record'

data/lib/tasks/rails_dynamic_associations_tasks.rake

@@ -0,0 +1,4 @@
+# desc 'Explaining what the task does'
+# task :rails_dynamic_associations do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rails_dynamic_associations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Senko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rails_model_load_hook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Define your model associations in the database without changing the schema
+  or models.
+email:
+- Alexander.Senko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/relation.rb
+- app/models/role.rb
+- config/initializers/model_associations.rb
+- db/migrate/01_create_roles.rb
+- db/migrate/02_create_relations.rb
+- lib/core_ext/string.rb
+- lib/rails_dynamic_associations.rb
+- lib/rails_dynamic_associations/active_record.rb
+- lib/rails_dynamic_associations/active_record/associations.rb
+- lib/rails_dynamic_associations/active_record/relations.rb
+- lib/rails_dynamic_associations/active_record/roles.rb
+- lib/rails_dynamic_associations/engine.rb
+- lib/rails_dynamic_associations/version.rb
+- lib/tasks/rails_dynamic_associations_tasks.rake
+homepage: https://github.com/softpro/rails_dynamic_associations
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: DB-driven model associations for Rails.
+test_files: []