association_scope 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3cdd5ffca0653bd30600b32060a42de12505e41af7beae5a4faf750e95189925
+  data.tar.gz: ce11c4a40bf02a01ca03e7d06ababdda30bc7c01012cd7b91241a2101ec19d70
+SHA512:
+  metadata.gz: 8e380d107ae796069965a993e4ef4c375caea859450e018dffd0f0f53cea917696f7e4fcfd34f556d5b0e0d805e33ad4590cb1acdba115e76691f96884d43f8a
+  data.tar.gz: b54e0f129fb76f8815c19997e7fdfe3b130bd316c38d4085f566592bfa10d2b3b1b37ecc4a416faa35e8d3d7e681ed7e2849b588955b7c207b5e380ee9403301

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 datae
+
+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,78 @@
+[![RSpec](https://github.com/datae95/association_scope/actions/workflows/rspec.yml/badge.svg)](https://github.com/datae95/association_scope/actions/workflows/rspec.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+
+# AssociationScope
+I always wondered, why there was no functionality to use associations not only on `ActiveRecord` objects but on scopes as well.
+When I have
+```ruby
+current_user.topics # => #<ActiveRecord::Relation [...]>
+```
+why can't I use the same construction on a collection of users like
+```ruby
+current_user.friends.topics # => #<ActiveRecord::Relation [...]>
+```
+and retrieve the collection of topics, my friends posted?
+Instead I wrote weird scopes like
+```ruby
+class Topic < ApplicationRecord
+  belongs_to :user
+  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.
+And `belongs_to` is the easiest part.
+
+When you have this problem, the AssociationScope gem is for you!
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'association_scope', git: 'https://github.com/datae95/association_scope', branch: :main
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+After installation you can use `acts_as_association_scope` in your models:
+```ruby
+class Topic < ApplicationRecord
+  belongs_to :user
+  acts_as_association_scope
+end
+```
+Now you can use your associations as scopes and chain other scopes with them.
+When you have the classes `User` with many `Topic`s and every `Topic` has many `Post`s with many `Comment`s and all of them use `acts_as_association_scope`, you can write
+```ruby
+User.first.topics.posts.comments
+```
+to retrieve all comments of all posts of all topics of your first user.
+
+## Known Issues
+* This gem works with `reflections`.
+To make this work, the `acts_as_association_scope` call has to be below your association definitions.
+```ruby
+# won't work
+class Topic
+  acts_as_association_scope
+  belongs_to :user
+end
+
+# works
+class Topic
+  belongs_to :user
+  acts_as_association_scope
+end
+```
+* Database views do not have a primary key.
+To use `distinct` on rows, all values of this row must be of types other than json.
+Workaround: Migrate JSON columns to JSONB.
+* Error messages are not raised during application start, but on first instantiation, because of the order in which classes are loaded.
+
+## Development
+Clone the app and run `bundle`.
+To use `rails console` you have to navigate to the dummy application `cd spec/dummy`.

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/association_scope.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "association_scope/version"
+require "association_scope/scope"
+require "association_scope/scope/has_many_reflection"
+require "association_scope/scope/has_one_reflection"
+require "association_scope/scope/belongs_to_reflection"
+require "association_scope/scope/has_and_belongs_to_many_reflection"
+require "association_scope/scope/through_reflection"
+
+require "association_scope/errors/association_missing_error"
+
+module AssociationScope
+end
+
+module ActiveRecord
+  class Base
+    def self.acts_as_association_scope(only: reflections.keys, except: [])
+      # Apply given filters.
+      # Don't be picky about singular or plural.
+      raise ArgumentError, "Don't use :only and :except together!" unless only == reflections.keys || except == []
+
+      only = only.map { |o| o.to_s }
+      except = except.map { |e| e.to_s }
+
+      ::AssociationScope::Scope.inject_scopes(self, only - except)
+    end
+  end
+end

data/lib/association_scope/errors/association_missing_error.rb

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

data/lib/association_scope/scope.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module AssociationScope
+  class Scope
+    attr_reader :model, :association
+
+    def initialize(model, association)
+      @model = model
+      @association = association
+    end
+
+    def self.inject_scopes(model, reflections)
+      model.reflections.slice(*reflections).each do |association, details|
+        scope_type = details.class.to_s.split("::").last
+
+        "AssociationScope::Scope::#{scope_type}".constantize.new(model, association).apply
+      end
+    end
+  end
+end

data/lib/association_scope/scope/belongs_to_reflection.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module AssociationScope
+  class Scope
+    class BelongsToReflection < Scope
+      def apply
+        association = @association
+        details = model.reflections[association]
+        class_name = details.options[:class_name]&.constantize || association.camelize.constantize
+        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
+
+        model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          scope association.pluralize, -> do
+            if foreign_key.present?
+              class_name
+                .joins("JOIN #{table_name} ON #{table_name}.#{foreign_key} = #{own_table_name}.id")
+            else
+              class_name
+                .joins(table_name)
+            end
+              .where(table_name => { association_name =>
+                select("#{association_name}_id".to_sym) })
+              .distinct
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/association_scope/scope/has_and_belongs_to_many_reflection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module AssociationScope
+  class Scope
+    class HasAndBelongsToManyReflection < Scope
+      def apply
+        association = @association.pluralize
+        details = model.reflections[association]
+        class_name = 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)
+
+          scope association, -> do
+            class_name
+              .joins(table_name)
+              .where(table_name => self)
+              .distinct
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/association_scope/scope/has_many_reflection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module AssociationScope
+  class Scope
+    class HasManyReflection < Scope
+      def apply
+        details = model.reflections[@association]
+        class_name = details.options[:class_name]&.constantize || association.singularize.camelize.constantize
+        association = @association.pluralize
+        column_name = 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)
+
+          scope association, -> do
+            class_name
+              .where(column_name => self)
+              .distinct
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/association_scope/scope/has_one_reflection.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module AssociationScope
+  class Scope
+    class HasOneReflection < HasManyReflection
+    end
+  end
+end

data/lib/association_scope/scope/through_reflection.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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
+
+        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
+
+        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)
+              .distinct
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/association_scope/version.rb

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

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: association_scope
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- datae
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+description: AssociationScope adds useful scopes targeting Associations in ActiveRecord.
+email:
+- accounts@datae.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/association_scope.rb
+- lib/association_scope/errors/association_missing_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
+- lib/association_scope/scope/has_many_reflection.rb
+- lib/association_scope/scope/has_one_reflection.rb
+- lib/association_scope/scope/through_reflection.rb
+- lib/association_scope/version.rb
+homepage: https://github.com/datae95/association_scope
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/datae95/association_scope
+  source_code_uri: https://github.com/datae95/association_scope
+  changelog_uri: https://github.com/datae95/association_scope/changelog
+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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: AssociationScope adds useful scopes targeting Associations in ActiveRecord.
+test_files: []