acts_as_belongable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99724979e1ee56f88f57d31b9fccae9fc557d6f5c03f3e09feecbbbb58587122
-  data.tar.gz: 8ea8c8e9c2b4de93e9a2db1ad9e5a56cde09c6b9e2fc953a236aaecd422607ad
+  metadata.gz: 0e1b930cccce191245c3a42a9fa2393b3750b12226accd0704b8f0b0db773181
+  data.tar.gz: a016181335cf789ca4e51241430d81cbc0ee892e9e6bafdb9f2ee555ecde83f6
 SHA512:
-  metadata.gz: a135d7308b3fbaf37d83b639b9c2962180d6211a57ca904c22995e2b6264b1a4a0cf6028a6f8aedd5423e3446ea72eec78bfa73a54fa48b18d5e44e6ae10c781
-  data.tar.gz: 01f1e856c96e217f41d8c6973006d8c8e478158d5a830fb5d27cdf315fb598883d81279445888f177206bb0b07815f886c621d177224e58ee09625ba35c57b5a
+  metadata.gz: c1d863ddd63d603e99b3beff19866f4a426066c3758b68a456f1a5231934797536d7c8718d87142e6bc57a636c2620a0a5973f2194ec776632331e3e5109c11a
+  data.tar.gz: f4ec1b730bf5795c5fcaadbd90fda303623ac5b4791d4545573e12d0fd83019117a27875bd63247db4b51f7050422799147701b479599695cbc11c13240f684a

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 * nothing yet
 
+### 1.1.0 - 2018/01/20
+
+* features
+    * add scopes
+
 ### 1.0.0 - 2018/01/20
 
 * initial release

data/README.md

@@ -14,6 +14,7 @@ acts_as_belongable is a Rubygem that provides an associations engine for Rails a
     * [acts_as_belonger](#acts_as_belonger)
     * [acts_as_belongable](#acts_as_belongable)
     * [acts_as_list](#acts_as_list)
+    * [Scopes](#scopes)
 * [To Do](#to-do)
 * [Contributing](#contributing)
     * [Contributors](#contributors)
@@ -123,6 +124,47 @@ acts_as_belongable integrates with [acts_as_list](). It adds a `position` column
 c.add_belongable Event.first, position: 1
 ```
 
+### Scopes
+
+You can use scopes to add details to an relation:
+
+```ruby
+u = User.first
+e = u.create_belongable 'Event'
+c = u.create_belongable 'Conference'
+u = User.last
+u.add_belongable 'Event', scope: 'collaboration'
+u.add_belongable 'Conference', scope: 'collaboration'
+
+# Get all belongables with a specific scope
+u.belongables_with_scope :collaboration
+
+# Get `Event` belongables with a specific scope
+u.belongables_with_scope :collaboration, 'Event'
+
+# Get all belongers with a specific scope
+e.belongers_with_scope :collaboration
+
+# Get `User` belongers with a specific scope
+e.belongers_with_scope :collaboration, 'User'
+```
+
+You are also able to restrict associations to specific scopes:
+
+```ruby
+class User < ApplicationRecord
+    acts_as_belonger
+    belonger :conference_collaborations, 'Conference', scope: :collaboration
+    belonger :conference_attendings, 'User', scope: :membership
+end
+
+class Conference < ApplicationRecord
+    acts_as_belongable
+    belongable :collaborators, 'User', scope: :collaboration
+    belongable :attendees, 'User', scope: :membership
+end
+```
+
 ---
 
 ## To Do

data/app/models/concerns/acts_as_belongable/belongable.rb

@@ -9,8 +9,16 @@ module ActsAsBelongable
                 has_many :belongable_belongings, as: :belongable, class_name: 'Belonging', dependent: :destroy
             end
 
-            def belongable name, source_type
-                has_many name.to_sym, through: :belongable_belongings, source: :belonger, source_type: source_type.to_s
+            def belongable name, source_type, options = {}
+                if options.has_key? :scope
+                    belongable_belongings_with_scope options[:scope]
+                    through = "belongable_belongings_#{options[:scope]}".to_sym
+                end
+                through ||= :belongable_belongings
+                has_many name.to_sym, through: through, source: :belonger, source_type: source_type.to_s
+            end
+            def belongable_belongings_with_scope scope
+                has_many "belongable_belongings_#{scope}".to_sym, -> { where(scope: scope.to_s) }, as: :belongable, class_name: 'Belonging', dependent: :destroy
             end
         end
 
@@ -24,12 +32,20 @@ module ActsAsBelongable
         end
 
         def create_belonger class_name, options = {}
+            belonging_options = options.delete :belonging
             object = class_name.constantize.create options
-            self.add_to_belonger object
+            self.add_to_belonger object, belonging_options
+            object
         end
         def create_belonger! class_name, options = {}
+            belonging_options = options.delete :belonging
             object = class_name.constantize.create! options
-            self.add_to_belonger! object
+            self.add_to_belonger! object, belonging_options
+            object
+        end
+
+        def belongers_with_scope scope, source_type = nil
+            self.belongable_belongings.where(scope: scope.to_s).map { |belonging| source_type.nil? || belonging.belonger.class.name == source_type ? belonging.belonger : nil }.compact
         end
 
     end

data/app/models/concerns/acts_as_belongable/belonger.rb

@@ -9,8 +9,16 @@ module ActsAsBelongable
                 has_many :belonger_belongings, as: :belonger, class_name: 'Belonging', dependent: :destroy
             end
 
-            def belonger name, source_type
-                has_many name.to_sym, through: :belonger_belongings, source: :belongable, source_type: source_type.to_s
+            def belonger name, source_type, options = {}
+                if options.has_key? :scope
+                    belonger_belongings_with_scope options[:scope]
+                    through = "belonger_belongings_#{options[:scope]}".to_sym
+                end
+                through ||= :belonger_belongings
+                has_many name.to_sym, through: through, source: :belongable, source_type: source_type.to_s
+            end
+            def belonger_belongings_with_scope scope
+                has_many "belonger_belongings_#{scope}".to_sym, -> { where(scope: scope.to_s) }, as: :belonger, class_name: 'Belonging', dependent: :destroy
             end
         end
 
@@ -24,12 +32,20 @@ module ActsAsBelongable
         end
 
         def create_belongable class_name, options = {}
+            belonging_options = options.delete :belonging
             object = class_name.constantize.create options
-            self.add_belongable object
+            self.add_belongable object, belonging_options
+            object
         end
         def create_belongable! class_name, options = {}
+            belonging_options = options.delete :belonging
             object = class_name.constantize.create! options
-            self.add_belongable! object
+            self.add_belongable! object, belonging_options
+            object
+        end
+
+        def belongables_with_scope scope, source_type = nil
+            self.belonger_belongings.where(scope: scope.to_s).map { |belonging| source_type.nil? || belonging.belongable.class.name == source_type ? belonging.belongable : nil }.compact
         end
 
     end

data/lib/acts_as_belongable/version.rb

@@ -1,5 +1,5 @@
 module ActsAsBelongable
 
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
 
 end

data/lib/generators/templates/migration.rb.erb

@@ -5,6 +5,7 @@ class ActsAsBelongableMigration < ActiveRecord::Migration<%= migration_version %
             t.references :belonger, polymorphic: true, index: true
             t.references :belonging, polymorphic: true, index: true
 
+            t.string :scope
             t.integer :position
 
             t.timestamps null: false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_belongable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonas Hübotter