activerecord-query 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdf9b2ff6e244407f97068227e4db1514e85e4a6912178845a12123ad4f952af
-  data.tar.gz: d0b9acdfb57e77f20e82fe34d36b7158c9ae3c667af80807c1659d78269b5669
+  metadata.gz: 1b5d00fe2f0a7e79c492fdc554b5cab1e63f75f0875688a3623a44fb17afcc77
+  data.tar.gz: ff43a4a19ad4fc673352eb3fdd846828b7e7b69ff2bc1f5e3ad391971c67a46f
 SHA512:
-  metadata.gz: '06893476dc21302c35ca1db93973abaf91dc8e1bcc58a27d4ae83a66a68e9ac7f87d2054f0d9ec31a9d76ec4a638a5b01054877d3d911561916a477d1c010740'
-  data.tar.gz: 83bd2598980986b424f694b06cf49acf609764030dbb226f326fc34f389143f59d77497d1fde0b7c497881b9cd5c6bcf49bc36c2976c5727bdd7da762cd19b90
+  metadata.gz: 1f36bd0c44715ef2070ee62bf5e13bccf094ba2c84aee6a95136f5f9820d75200b4b2229ce54e2ae2718f602a9d07a0acba62b56b2c0a9db9df98d52a5888868
+  data.tar.gz: 39dfe1d3d50d9a9c0dc5ce1ee41f1cca4e26176d5ae90d9703131041cc9ff3727fb8c8b5a9e13dbdd736d823cc3661284c79b0f2c93d5809afd4ac749bf7bc97

data/README.md

@@ -273,7 +273,7 @@ class PostQuery < ActiveRecordQuery::Base
 end
 ```
 
-#### Joins
+#### Inner Join
 The `join` method defines one/many relationships with the current resource (`from` state).
 The following example has a Post and Author models, the way we define a join is the same as 
 defining a `joins` on activerecord (check the active record querying doc.).
@@ -300,6 +300,33 @@ class PostQuery < ActiveRecordQuery::Base
 end
 ```
 
+#### Left Outer Join
+The `left_outer_join` method defines one/many relationships with the current resource (`from` state).
+The following example has a Post and Author models, the way we define a left outer join is the same as
+defining a `left_outer_joins` on activerecord (check the active record querying doc.).
+Right after defined the join, a new method will be available for retrieve the columns
+from the new resource, the `posts` method on the example bellow. Every relationship listed in
+the args will be converted to a method with the same name.
+```ruby
+# models
+class Post < ActiveRecord::Base
+  belongs_to :author
+end
+
+class Author < ActiveRecord::Base
+  has_many :posts
+end
+
+# query
+class PostQuery < ActiveRecordQuery::Base
+  from Author
+  left_outer_join :posts
+  
+  # the `posts` helper will be available
+  where posts.title == 'A title'
+end
+```
+
 
 #### Group by
 To apply a GROUP BY clause to the query, you can use the `group_by` method.

data/lib/active_record_query/concerns/joinable.rb

@@ -1,14 +1,16 @@
 module ActiveRecordQuery
+  # The module defines the join and left_outer_join macros.
   module Joinable
     extend ActiveSupport::Concern
 
+    # The object holds the columns called from a joined resource.
     class JoinedResource
       def initialize(resource)
         @resource = resource
       end
 
-      def method_missing(m, *args, &block)
-        Column.new(Arel::Table.new(resource), m)
+      def method_missing(method_name, *_args, &block)
+        Column.new(Arel::Table.new(resource), method_name)
       end
 
       private
@@ -20,7 +22,16 @@ module ActiveRecordQuery
       def join(*args)
         arg_stacker = ArgumentStacker.new(self, :join)
         arg_stacker.add(args)
-        args.to_s.split(/\W+/).compact.each do |resource_name|
+        define_table_resources_from_join(args)
+      end
+
+      def left_outer_join(*args)
+        ArgumentStacker.new(self, :left_outer_join).add(args)
+        define_table_resources_from_join(args)
+      end
+
+      def define_table_resources_from_join(join_args)
+        join_args.to_s.split(/\W+/).compact.each do |resource_name|
           define_singleton_method(resource_name) do
             JoinedResource.new(resource_name.pluralize)
           end
@@ -30,6 +41,7 @@ module ActiveRecordQuery
 
     included do
       add_feature :build_joins
+      add_feature :build_left_outer_joins
     end
 
     def build_joins(scope)
@@ -39,5 +51,13 @@ module ActiveRecordQuery
       end
       scope
     end
+
+    def build_left_outer_joins(scope)
+      arg_stacker = ArgumentStacker.new(self, :left_outer_join)
+      arg_stacker.list.each do |join_params|
+        scope = scope.left_outer_joins(join_params)
+      end
+      scope
+    end
   end
 end

data/lib/active_record_query/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-query
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Marcos Felipe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-05 00:00:00.000000000 Z
+date: 2022-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord