association_scope 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6737d583c54a2ce44c51f9313544bc2b73d5d083b86fa502b6e82bbca3c48d1
-  data.tar.gz: b85b28120cf9b7ac32a92f47db2ce4526391734188e9c13fcdfcb0762c177ba3
+  metadata.gz: 67d2f037f4c3007105757fe5b90f5307eb56614979e7cd4fa83d9036b5584321
+  data.tar.gz: d775072058420799584cf18dc27d80c246070dfd2ae1246e084f0a25acf3aa44
 SHA512:
-  metadata.gz: 162342ebf690b58e11a7ebb201073ac17bbeec4bd57e4b51c5f88a1ee2b1077182e98430e604d343fc31a237f615cafd7a736fcf99beb700dd4ee004d401d74f
-  data.tar.gz: 17e05e72a62217351f2d7bca06d6e0d2477ee9445df53cfb16681e728630cca3e6b2309b490fb50d6e5d6d175e1e0d7ecbb65fd81889eb54cdc714ff219006a9
+  metadata.gz: 5aa81882d47e6207b82deb659f43f3010e83d985fe1bed9a411e29c5796082509c4d19f4435bfdbb9d8a636878c06ac3dde49e7543bf5f7b7db38ec4583d0504
+  data.tar.gz: 22d3f940c21d6e1722eef994d0294a80d6e3f80a87a3bbadba1f457f1eeb6ef54fecc6ef3c9d761100213dcdc669f04c5f242cc8e95f4546151639f15727eb25

data/README.md

@@ -19,7 +19,7 @@ class Topic < ApplicationRecord
   scope :of_users, -> (users) { joins(:user).where(users: users) }
 end
 ```
-over and over again across all of my models to write `Topic.of_users(current_user.friends)` when I wanted to write `current_user.friends.topics` instead.
+over and over again across all of my models to write something like `Topic.of_users(current_user.friends)` when I wanted to write `current_user.friends.topics` instead.
 And `belongs_to` is the easiest part.
 
 When you have this problem, the AssociationScope gem is for you!
@@ -57,6 +57,23 @@ Topic.all.users
 ```
 to retrieve the users of all of the topics of your application.
 
+### Migration from `.of_model`
+When you already use any form of `.of_model` scope, you can replace it with association scopes:
+
+```ruby
+# replace
+Topic.of_users(current_user.friends)
+# with
+current_user.friends.topics
+```
+When you chain scopes, you have to merge with the previous scope:
+```ruby
+# replace
+scope.of_users(users)
+# with
+users.topics.merge(scope)
+```
+
 ## Known Issues
 * This gem works with `reflections`.
 To make this work, the `has_association_scope_on` call has to be below your association definitions.

data/lib/association_scope/errors/association_missing_error.rb

@@ -11,7 +11,7 @@ module AssociationScope
     end
 
     def message
-      "Association #{association} missing in #{missing_in}!"
+      "Association :#{association} missing in #{missing_in}!"
     end
   end
 end

data/lib/association_scope/errors/polymorphic_association_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module AssociationScope
+  class PolymorphicAssociationError < StandardError
+    attr_accessor :association,
+      :model
+
+    def initialize(association: nil, model: nil)
+      @association = association
+      @model = model
+    end
+
+    def message
+      "Association :#{association} is polymorph in #{model}!"
+    end
+  end
+end

data/lib/association_scope/scope/belongs_to_reflection.rb

@@ -4,22 +4,16 @@ module AssociationScope
   class Scope
     class BelongsToReflection < Scope
       def apply
+        if reflection_details.options[:polymorphic]
+          raise PolymorphicAssociationError.new association: association, model: model
+        end
+
         association = @association
-        details = model.reflections[association]
-        class_name = details.options[:class_name]&.constantize || association.camelize.constantize
+        class_name = reflection_details.options[:class_name]&.constantize || association.camelize.constantize
+        foreign_key = reflection_details.options[:foreign_key]
         association_name = association.to_s.underscore.to_sym
-        foreign_key = details.options[:foreign_key]
         own_table_name = class_name.to_s.pluralize.underscore
-
-        inverse_reflection = class_name.reflections[model.to_s.underscore.singularize] || class_name.reflections[model.to_s.underscore.pluralize]
-        case inverse_reflection&.source_reflection&.class&.to_s&.split("::")&.last
-        when "HasOneReflection"
-          table_name = model.to_s.underscore.to_sym
-        when "HasManyReflection"
-          table_name = model.to_s.underscore.pluralize.to_sym
-        else
-          raise AssociationMissingError.new missing_in: class_name, association: model.to_s.underscore.pluralize
-        end
+        table_name = table_name class_name
 
         model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           scope association.pluralize, -> do
@@ -36,6 +30,27 @@ module AssociationScope
           end
         RUBY
       end
+
+      private
+
+      def table_name(class_name)
+        case inverse_reflection(class_name)&.source_reflection&.class&.to_s&.split("::")&.last
+        when "HasOneReflection"
+          model.to_s.underscore.to_sym
+        when "HasManyReflection"
+          model.to_s.underscore.pluralize.to_sym
+        else
+          raise AssociationMissingError.new missing_in: class_name, association: model.to_s.underscore.pluralize
+        end
+      end
+
+      def inverse_reflection(class_name)
+        class_name.reflections[model.to_s.underscore.singularize] || class_name.reflections[model.to_s.underscore.pluralize]
+      end
+
+      def reflection_details
+        model.reflections[association]
+      end
     end
   end
 end

data/lib/association_scope/scope/has_and_belongs_to_many_reflection.rb

@@ -5,13 +5,12 @@ module AssociationScope
     class HasAndBelongsToManyReflection < Scope
       def apply
         association = @association.pluralize
-        details = model.reflections[association]
-        class_name = details.options[:class_name]&.constantize || association.singularize.camelize.constantize
+        class_name = reflection_details.options[:class_name]&.constantize || association.singularize.camelize.constantize
         table_name = model.to_s.underscore.pluralize.to_sym
 
-        model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          raise AssociationMissingError.new(missing_in: class_name, association: table_name) unless class_name.reflections.has_key?(table_name.to_s)
+        raise AssociationMissingError.new(missing_in: class_name, association: table_name) unless class_name.reflections.has_key?(table_name.to_s)
 
+        model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           scope association, -> do
             class_name
               .joins(table_name)
@@ -20,6 +19,12 @@ module AssociationScope
           end
         RUBY
       end
+
+      private
+
+      def reflection_details
+        model.reflections[association]
+      end
     end
   end
 end

data/lib/association_scope/scope/has_many_reflection.rb

@@ -4,14 +4,14 @@ module AssociationScope
   class Scope
     class HasManyReflection < Scope
       def apply
-        details = model.reflections[@association]
-        class_name = details.options[:class_name]&.constantize || association.singularize.camelize.constantize
+        class_name = reflection_details.options[:class_name]&.constantize || association.singularize.camelize.constantize
+
         association = @association.pluralize
-        column_name = model.to_s.underscore
+        column_name = reflection_details.options[:as] || model.to_s.underscore
 
-        model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          raise AssociationMissingError.new(missing_in: class_name, association: column_name) unless class_name.reflections.has_key?(column_name)
+        raise AssociationMissingError.new(missing_in: class_name, association: column_name) unless class_name.reflections.has_key?(column_name.to_s)
 
+        model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           scope association, -> do
             class_name
               .where(column_name => self)
@@ -19,6 +19,12 @@ module AssociationScope
           end
         RUBY
       end
+
+      private
+
+      def reflection_details
+        model.reflections[@association]
+      end
     end
   end
 end

data/lib/association_scope/scope/has_one_reflection.rb

@@ -3,6 +3,7 @@
 module AssociationScope
   class Scope
     class HasOneReflection < HasManyReflection
+      # works the same way like has_many reflections
     end
   end
 end

data/lib/association_scope/scope/through_reflection.rb

@@ -4,24 +4,14 @@ module AssociationScope
   class Scope
     class ThroughReflection < Scope
       def apply
-        details = model.reflections[@association]
         association = @association
-        class_name = details.options[:class_name]&.constantize || association.singularize.camelize.constantize
+        class_name = reflection_details.options[:class_name]&.constantize || association.singularize.camelize.constantize
+        first_join = inverse_reflection(class_name)&.options&.fetch(:through, nil) || inverse_reflection(class_name)&.options&.fetch(:source, nil)
+        second_join = compute_second_join class_name
 
-        inverse = details.options[:inverse_of]&.to_s || model.to_s.underscore
-        inverse_reflection = class_name.reflections[inverse.singularize] || class_name.reflections[inverse.pluralize]
-
-        first_join = inverse_reflection&.options&.fetch(:through, nil) || inverse_reflection&.options&.fetch(:source, nil)
-
-        reflection_type = inverse_reflection&.source_reflection&.class&.to_s&.split("::")&.last
-        second_join = if %w[HasOneReflection BelongsToReflection].include?(reflection_type)
-          model.to_s.underscore.to_sym
-        else
-          model.to_s.underscore.pluralize.to_sym
-        end
+        raise AssociationMissingError.new missing_in: class_name, association: inverse unless inverse_reflection(class_name)
 
         model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          raise AssociationMissingError.new missing_in: class_name, association: inverse unless inverse_reflection
           scope association.pluralize, -> do
             class_name
               .joins(first_join => second_join)
@@ -29,6 +19,32 @@ module AssociationScope
           end
         RUBY
       end
+
+      private
+
+      def reflection_details
+        model.reflections[association]
+      end
+
+      def inverse
+        reflection_details.options[:inverse_of]&.to_s || model.to_s.underscore
+      end
+
+      def inverse_reflection class_name
+        class_name.reflections[inverse.singularize] || class_name.reflections[inverse.pluralize]
+      end
+
+      def reflection_type class_name
+        inverse_reflection(class_name)&.source_reflection&.class&.to_s&.split("::")&.last
+      end
+
+      def compute_second_join class_name
+        if %w[HasOneReflection BelongsToReflection].include?(reflection_type(class_name))
+          model.to_s.underscore.to_sym
+        else
+          model.to_s.underscore.pluralize.to_sym
+        end
+      end
     end
   end
 end

data/lib/association_scope/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AssociationScope
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/association_scope.rb

@@ -9,6 +9,7 @@ require "association_scope/scope/has_and_belongs_to_many_reflection"
 require "association_scope/scope/through_reflection"
 
 require "association_scope/errors/association_missing_error"
+require "association_scope/errors/polymorphic_association_error"
 
 module AssociationScope
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: association_scope
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - datae
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-07 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.2
 description: AssociationScope adds useful scopes targeting Associations in ActiveRecord.
 email:
 - accounts@datae.de
@@ -78,6 +92,7 @@ files:
 - Rakefile
 - lib/association_scope.rb
 - lib/association_scope/errors/association_missing_error.rb
+- lib/association_scope/errors/polymorphic_association_error.rb
 - lib/association_scope/scope.rb
 - lib/association_scope/scope/belongs_to_reflection.rb
 - lib/association_scope/scope/has_and_belongs_to_many_reflection.rb
@@ -100,14 +115,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: AssociationScope adds useful scopes targeting Associations in ActiveRecord.