records_with_records 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d95f6bc84336cf13b99aaa7708d169df2200877fe25b8982f2444fcb493a9cf1
-  data.tar.gz: f7c38d0f50a645185fd738ab3bd96204fc7d79fee7f25c2004f27c66c1d9e460
+  metadata.gz: 76ac2aa88e2257ff4fdfc74fe6a4dc5a51f5d51c59c178cafe1deec245faff6d
+  data.tar.gz: 2332feb2a12cb5188d6bd8f0e34cdd945d1aeef982ae713c5b1646e3ed539dd4
 SHA512:
-  metadata.gz: ba78d4452bcc62d4a67e7aaa058d56949b83aab68391664090608174fb5bb70fba08fe9b7facf752d266929f128b8139f232a2c03cd074ef6b61f6359258bc2e
-  data.tar.gz: 9f45042332ef18b2418a80113678f82a4dbc71b8d69c848bf647287be390e7ab4f20781354c2eac0172123822a258c13f38ddec6bef408bf048c294dd7edfbe6
+  metadata.gz: '0867c27d46b2275d0130155249825a2ad8b99dbe92495942d1bc01a5e7c82eb4864dd58af68d8403cb6916eaa33a3b77a87f9c5bdf17356c16e3988b22afb16e'
+  data.tar.gz: a63ba8b9cbffac1e97afd0bae3c4f5810cb7023993d64f23b6c47f4c2825da5deb7a194819779d5c78cfdc4bb0b8c80f444cf9eeafcf339e66f02bbabac38b66

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    records_with_records (0.1.1)
+    records_with_records (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,6 @@
 # RecordsWithRecords
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/records_with_records`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem aims to simplify exists queries
 
 ## Installation
 
@@ -21,8 +19,50 @@ Or install it yourself as:
     $ gem install records_with_records
 
 ## Usage
+Assume you have a relation like this
+```ruby
+class User < ActiveRecord::Base
+  has_many :received_messages, class_name: 'Message', foreign_key: :receiver_id
+end
+```
+### Exists
+To get all Users with associated Messages you would write
+```ruby
+User.where(Message.where('receiver_id = users.id').arel.exists)
+=> SELECT "users".* FROM "users" WHERE EXISTS (SELECT "messages".* FROM "messages" WHERE (receiver_id = users.id))
+```
+Instead you can now write
+```ruby
+User.where_exists(:received_messages)
+=> SELECT "users".* FROM "users" WHERE EXISTS (SELECT "messages".* FROM "messages" WHERE ("messages"."receiver_id" = "users"."id"))
+```
+### Not exists
+Querying records without associated records is also possible
+```ruby
+User.where_not_exists(:received_messages)
+=> SELECT "users".* FROM "users" WHERE NOT (EXISTS (SELECT "messages".* FROM "messages" WHERE ("messages"."receiver_id" = "users"."id")))
+```
+
+### Additional scope
+You can pass a scope as second argument
+```ruby
+User.where_not_exists(:received_messages, -> { where(received_at: 5.hours.ago..) })
+=> SELECT "users".* FROM "users" WHERE NOT (EXISTS (SELECT "messages".* FROM "messages" WHERE "messages"."received_at" >= $1 AND ("messages"."receiver_id" = "users"."id"))) [["received_at", "2021-05-01 04:16:42.325804"]]
+```
+
+### Association scope
+Scopes defined on the association are also applied
+```ruby
+class User < ActiveRecord::Base
+  has_many :pending_messages, -> { where(messages: {received_at: nil}) }, class_name: 'Message', foreign_key: :receiver_id
+end
+
+
+```
+
+## Caveats
+Querying on the existance of `belongs_to` associations is currently not possible.
 
-TODO: Write usage instructions here
 
 ## Development
 

data/lib/records_with_records.rb

@@ -15,13 +15,13 @@ module RecordsWithRecords
   module ClassMethods
 
     # Returns records of included model where +assoc+ exists
-    def where_exists(assoc, scope = nil)
-      where(exist(find_reflection(assoc), scope))
+    def where_exists(association, scope = nil)
+      where(exist(find_reflection(association), scope))
     end
 
     # Returns records of included model where +assoc+ exists not
-    def where_not_exists(assoc, scope = nil)
-      where.not(exist(find_reflection(assoc), scope))
+    def where_not_exists(association, scope = nil)
+      where.not(exist(find_reflection(association), scope))
     end
 
     def respond_to_missing?(name, *args)

data/lib/records_with_records/association.rb

@@ -20,14 +20,13 @@ class Association
 
   def apply_scopes(scope)
     scope = scope&.instance_exec(&@assoc_scope) if @assoc_scope
-    scope = scope&.instance_exec(&@reflection_scope) if @reflection_scope
+    scope = scope&.instance_exec(&@reflection.scope) if @reflection.scope
     scope
   end
 
   class HasMany < Association
     def scope
-      scp = @reflection.klass.all
-      apply_scopes(scp)
+      apply_scopes(@reflection.klass.all)
     end
 
     def foreign_key
@@ -56,4 +55,6 @@ class Association
       @reflection.source_reflection
     end
   end
+
+  # TODO: Add belongs_to association
 end

data/lib/records_with_records/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RecordsWithRecords
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: records_with_records
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dario Litz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-30 00:00:00.000000000 Z
+date: 2021-05-01 00:00:00.000000000 Z
 dependencies: []
 description: An extension for Active Record for querying records with or without associated
   records