praxis 2.0.pre.27 → 2.0.pre.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71228b4dd69f45eb28f8fec8782eef94fc24bdf6bb164a707d19cfade5091ac7
-  data.tar.gz: 33e2fce254db25935827d67ccc394aa7b54039212e97eaa7aae89d9006e4d5fd
+  metadata.gz: 516db7752a3c4d1e8aa48abe0967781c9f6b31a65155a18285febb30c058e823
+  data.tar.gz: f404aaf78564a04b4835c70928584a82f3313b013c71f1d5e28e78f3e814296c
 SHA512:
-  metadata.gz: 4f1bb58917fe5070e9433acdc2c2b1cbc0341eb832331f399a08bc2138fc5080397326ec2755f7e9452ec4774e931842699c4a4fa9455e0ef1231a6532f2b2d9
-  data.tar.gz: 346dbe116bab1da666e6e38b5d8a7f3863c0dcd2c97736a762fc107eaf77d879b6e9f52e5569e5ee4e4e56207b14c87b21a0cd4e4e10a2f33a34177720c682e7
+  metadata.gz: 5b1eae94ededb45b3cd48fdfe2440c5ac41af66b5c251e3a682906709d67a15d02d7463c7dc2e384fb4c217a745b7cec438b0d919e614f5f4c4c499a94cb17a4
+  data.tar.gz: fe8c7d881560b09702a4fe63680046f472efebb18aa1c09b01138b6dd9569727d29759bfc0e765095d52ec92df1c136e1de1419bf3fe282cc0b56e92cb3b1c9e

data/CHANGELOG.md

@@ -1,8 +1,11 @@
 # Praxis Changelog
 
 ## next
-
-## 2.0.pre.26
+## 2.0.pre.28
+  * Enhance the mapper's Resource property to allow for a couple more powerful options using the `as:` keyword:
+    * `as: :self` will provide a way to map any further incoming fields on top of the already existing object. This is useful when we want to expose some properties for a resource, grouped within a sub structure, but that in reality they exist directly in the resource's underlying model (i.e., to organize the information of the model in a more structured/groupable way).
+    * `as: 'association1.association2'` allows us to traverse more than 1 association, and continue applying the incoming fields under that. This is commonly used when we want to expose a relationship on a resource, which is really coming from more than a single association level depth.
+## 2.0.pre.27
   * Introduce a new `as:` option for resource's `property`, to indicate that the underlying association method it is connected to, has a different name.
     * This also will create a delegation function for the property name, that instead of calling the underlying association on the record, and wrapping the result with a resource instance, it will simply call the aliased method name (which is likely gonna hit the autogenerated code for that properyty, unless we have overriden it)
     * With this change, the selector generator (i.e., the thing that looks at the incoming `fields` parameters and calculates which select and includes are necessary to query all the data we need), will be able to understand this aliasing cases, and properly pass along, and continue expanding any nested fields that are under the property name (before this, and further inner fields would be not included as soon as we hit a property that didn't have that direct association underneath).

data/lib/praxis/mapper/selector_generator.rb

@@ -68,7 +68,24 @@ module Praxis
         # Always add the underlying association if we're overriding the name...
         if (praxis_compat_model = resource.model&.respond_to?(:_praxis_associations))
           aliased_as = resource.properties[name][:as]
-          add_association(aliased_as, fields) if resource.model._praxis_associations[aliased_as]
+          if aliased_as == :self
+            # Special keyword to add itself as the association, but still continue procesing the fields
+            # This is useful when we expose resource fields tucked inside another sub-struct, this way
+            # we can make sure that if the fields necessary to compute things inside the struct, they are preloaded
+            add(fields)
+          else
+            first, *rest = aliased_as.to_s.split('.').map(&:to_sym)
+
+            extended_fields = \
+              if rest.empty?
+                fields
+              else
+                rest.reverse.inject(fields) do |accum, prop|
+                  { prop => accum }
+                end
+              end
+            add_association(first, extended_fields) if resource.model._praxis_associations[first]
+          end
         end
         dependencies&.each do |dependency|
           # To detect recursion, let's allow mapping depending fields to the same name of the property

data/lib/praxis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Praxis
-  VERSION = '2.0.pre.27'
+  VERSION = '2.0.pre.28'
 end

data/spec/praxis/mapper/selector_generator_spec.rb

@@ -236,6 +236,55 @@ describe Praxis::Mapper::SelectorGenerator do
         end
         it_behaves_like 'a proper selector'
       end
+      context 'Deep aliased underlying associations also follows any nested fields at the end of the chain...' do
+        let(:fields) do
+          {
+            parent_id: true,
+            deep_aliased_association: {
+              name: true
+            }
+          }
+        end
+        let(:selectors) do
+          {
+            model: SimpleModel,
+            columns: %i[parent_id simple_name], # No added_column, as it does not follow the dotted reference as properties, just associations
+            tracks: {
+              parent: {
+                model: ParentModel,
+                columns: %i[id],
+                tracks: {
+                  simple_children: {
+                    model: SimpleModel,
+                    columns: %i[parent_id simple_name]
+                  }
+                }
+              }
+            }
+          }
+        end
+        it_behaves_like 'a proper selector'
+      end
+      context 'Using self for the underlying association: follows any nested fields skipping the association name and still applies dependencies' do
+        let(:fields) do
+          {
+            parent_id: true,
+            sub_struct: {
+              display_name: true
+            }
+          }
+        end
+        let(:selectors) do
+          {
+            model: SimpleModel,
+            # Parent_id is because we asked for it at the top
+            # display_name because we asked for it under sub_struct, but it is marked as :self
+            # alway_necessary_attribute because it is a dependency of sub_struct
+            columns: %i[parent_id display_name alway_necessary_attribute]
+          }
+        end
+        it_behaves_like 'a proper selector'
+      end
     end
 
     context 'string associations' do

data/spec/support/spec_resources.rb

@@ -154,6 +154,9 @@ class SimpleResource < BaseResource
   property :deep_nested_deps, dependencies: ['parent.simple_children.other_model.parent.display_name']
   property :aliased_association, as: :other_model, dependencies: [:name]
   property :overriden_aliased_association, as: :other_model, dependencies: [:name]
+  property :deep_aliased_association, as: 'parent.simple_children' , dependencies: [:name]
+
+  property :sub_struct, as: :self, dependencies: [:alway_necessary_attribute]
 
   before(:update!, :do_before_update)
   around(:update!, :do_around_update_nested)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.27
+  version: 2.0.pre.28
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2023-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport