symmetry 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: bc2f0af03b14a6d059fc2ef7ab5085503d93f73a
-  data.tar.gz: b7f9423a384a2239bbb38522ed8e46f77b287787
+  metadata.gz: eeaa72663ec6aa7831238b732485f139048bd0df
+  data.tar.gz: b5a31fb66056e892132fdc796061b830c24e64f9
 !binary "U0hBNTEy":
-  metadata.gz: 4c732c5f9d47f9eaffcdd13c55c31cc488cf93743cb240dd7968c7fd025cd06d6acf4ac2e5b7c73ea32be69b70ca9e2c26bb4f31a8d8c62fa7a522c892acea9e
-  data.tar.gz: b325e1b03eab6d8316c4bc4fd1d5e6ca5ab3294128cf82be2504109dcb749db2d785495c85e1003c7a41b02e315ddaf4e351646e9cd33fd23adebf4a7000fabc
+  metadata.gz: 51cc648a21f96c9e162c920c399c5e118f12a4e082f5ba1e3d1e4d44653a3cb756e2e5445e29c09483d8d02b2a696c92d073e6b4f882b1911e21b618786cf287
+  data.tar.gz: b6b8a19ab82cf76eec806912cc25a1fe833f867c7d51954f3719d4f00216746aa8650d6fcd49c7b1cc4216624f132247d6817351e0d73979afd894775db2811b

data/README.rdoc

@@ -6,4 +6,99 @@
 {<img src="https://coveralls.io/repos/djonasson/symmetry/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/djonasson/symmetry]
 {<img src="https://badge.fury.io/rb/symmetry.png" alt="Gem Version" />}[http://badge.fury.io/rb/symmetry]
 
-Symmetry gives you a simple way of creating symmetric has_and_belongs_to_many relationships (friendships, neighbors, etc.) in your Active Record models.
+Symmetry gives you a simple way of creating symmetric has_and_belongs_to_many relationships (friends, neighbors, etc.) in your Active Record models.
+
+
+== Installation
+
+Add it to your Gemfile:
+
+  gem "symmetry"
+
+Install the migrations:
+
+  rake symmetry_engine:install:migrations db:migrate
+
+
+== Usage
+
+Define a symmetric relationship:
+
+  class User < ActiveRecord::Base
+    symmetric_relationship :friends
+  end
+
+  class Country < ActiveRecord::Base
+    symmetric_relationship :neighbors, polymorphic_relationship_name: :neighborships
+  end
+
+Use it:
+
+  # User
+
+  irb(main)> u = User.create(name: "Daniel")
+  => #<User id: 1, name: "Daniel", ...>
+
+  irb(main)> u.friends
+  => []
+
+  irb(main)> u.friend_relationships
+  => []
+
+
+  # Country
+
+  irb(main)> c = Country.create(name: "Sweden")
+  => #<Country id: 1, name: "Sweden", ...>
+
+  irb(main)> c.neighbors << Country.create(name: "Norway")
+  => [#<Country id: 2, name: "Norway", ...>]
+
+  irb(main)> c.neighbors
+  => [#<Country id: 2, name: "Norway", ...>]
+
+  irb(main)> Country.find(2).neighbors
+  => [#<Country id: 1, name: "Sweden", ...>]
+
+  irb(main)> c.neighborships
+  => [#<SymmetricRelationship id: 1, owner_id: 1, owner_type: "Country", relation_id: 2, relation_type: "Country", relationship_name: "neighbors" ...>, ...]
+
+It is possible to define multiple symmetric relationships on the same model:
+
+  class Politician
+    symmetric_relationship :friends
+    symmetric_relationship :enemies
+  end
+
+  irb(main)> p1 = Politician.create(name: 'A')
+  => #<Politician id: 1, name: "A", ...>
+
+  irb(main)> p2 = Politician.create(name: 'B')
+  => #<Politician id: 2, name: "B", ...>
+
+  irb(main)> p3 = Politician.create(name: 'C')
+  => #<Politician id: 3, name: "C", ...>
+
+  irb(main)> p1.friends
+  => []
+
+  irb(main)> p1.enemies
+  => []
+
+  irb(main)> p1.friends << p2
+  => [#<Politician id: 2, name: "B", ...>]
+
+  irb(main)> p1.enemies << p3
+  => [#<Politician id: 3, name: "C", ...>]
+
+  irb(main)> p1.friends.count
+  => 1
+
+  irb(main)> p1.enemies.count
+  => 1
+
+  irb(main)> p2.friends.count
+  => 1
+
+  irb(main)> p2.enemies.count
+  => 0

data/app/models/symmetric_relationship.rb

@@ -1,28 +1,26 @@
 class SymmetricRelationship < ActiveRecord::Base
-  attr_accessible :owner_id, :owner_type, :relation_id, :relation_type
+  attr_accessible :owner_id, :owner_type, :relation_id, :relation_type, :relationship_name
 
   belongs_to :owner, polymorphic: true
   belongs_to :relation, polymorphic: true
 
-  validates :owner_id, presence: true, uniqueness: { scope: [:owner_type, :relation_id, :relation_type] }
+  validates :owner_id, presence: true, uniqueness: { scope: [:owner_type, :relation_id, :relation_type, :relationship_name] }
   validates :owner_type, presence: true
   validates :relation_id, presence: true
   validates :relation_type, presence: true
+  validates :relationship_name, presence: true
 
-  after_create :create_symetric_relation
-  after_destroy :destroy_symetric_relation
+  after_create :create_symetric_relationship
+  after_destroy :destroy_symetric_relationship
 
   private
 
-  def create_symetric_relation
-    if self.class.where(owner_id: relation_id, owner_type: relation_type, relation_id: owner_id, relation_type: owner_type).empty?
-      self.class.create(owner_id: relation_id, owner_type: relation_type, relation_id: owner_id, relation_type: owner_type)
-    end
+  def create_symetric_relationship
+    attrs = { owner_id: relation_id, owner_type: relation_type, relation_id: owner_id, relation_type: owner_type, relationship_name: relationship_name }
+    self.class.create(attrs) if self.class.where(attrs).empty?
   end
 
-  def destroy_symetric_relation
-    self.class.where(owner_id: relation_id, owner_type: relation_type, relation_id: owner_id, relation_type: owner_type).each do |record|
-      record.delete
-    end
+  def destroy_symetric_relationship
+    self.class.where(owner_id: relation_id, owner_type: relation_type, relation_id: owner_id, relation_type: owner_type, relationship_name: relationship_name).delete_all
   end
 end

data/db/migrate/20130323091106_add_relationship_name_to_symmetric_relationships.rb

@@ -0,0 +1,5 @@
+class AddRelationshipNameToSymmetricRelationships < ActiveRecord::Migration
+  def change
+    add_column :symmetric_relationships, :relationship_name, :string
+  end
+end

data/lib/symmetry/active_record.rb

@@ -1,15 +1,15 @@
 module Symmetry
   module ActiveRecord
 
-    def symmetric_relation(relation_name, options = {})
-      options.assert_valid_keys(:polymorphic_relation_name)
+    def symmetric_relationship(relationship_name, options = {})
+      options.assert_valid_keys(:polymorphic_relationship_name)
 
-      relation_name_singular = relation_name.to_s.singularize
-      polymorphic_relation_name = options[:polymorphic_relation_name].presence || "#{relation_name_singular}_relations"
+      relationship_name_singular = relationship_name.to_s.singularize
+      polymorphic_relationship_name = options[:polymorphic_relationship_name].presence || "#{relationship_name_singular}_relationships"
 
-      attr_accessible "#{relation_name_singular}_ids"
-      has_many polymorphic_relation_name, class_name: "SymmetricRelationship", as: :owner, dependent: :destroy
-      has_many relation_name, through: polymorphic_relation_name, as: :relation, source: :relation, source_type: self.name
+      attr_accessible "#{relationship_name_singular}_ids"
+      has_many polymorphic_relationship_name, class_name: "SymmetricRelationship", as: :owner, dependent: :destroy, conditions: { relationship_name: relationship_name }
+      has_many relationship_name, through: polymorphic_relationship_name, as: :relation, source: :relation, source_type: self.name
     end
 
   end

data/lib/symmetry/version.rb

@@ -1,3 +1,3 @@
 module Symmetry
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: symmetry
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniel Jonasson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-17 00:00:00.000000000 Z
+date: 2013-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,18 +16,18 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.0.0
 description: |-
   Symmetry gives you a simple way of creating symmetric
-      has_and_belongs_to_many relationships (friendships, neighbors, etc.) in
-      your Active Record models. More information can be found at:
+      has_and_belongs_to_many relationships (friends, neighbors, etc.) in your
+      Active Record models. More information can be found at:
       https://github.com/djonasson/worldwise
 email:
 - daniel@guadeo.com
@@ -37,6 +37,7 @@ extra_rdoc_files: []
 files:
 - app/models/symmetric_relationship.rb
 - config/routes.rb
+- db/migrate/20130323091106_add_relationship_name_to_symmetric_relationships.rb
 - db/migrate/20130201161328_create_symmetric_relationships.rb
 - lib/tasks/testing_tasks.rake
 - lib/symmetry/active_record.rb