praxis 2.0.pre.26 → 2.0.pre.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcecd5fd9fb69d436e75297f383ffeaa63373caf8ddfbefdb7361230c981ffc8
-  data.tar.gz: a5e00599183864a2fec4a3f197accaa8c8724fdd40400d91917a460bbd72f8aa
+  metadata.gz: 516db7752a3c4d1e8aa48abe0967781c9f6b31a65155a18285febb30c058e823
+  data.tar.gz: f404aaf78564a04b4835c70928584a82f3313b013c71f1d5e28e78f3e814296c
 SHA512:
-  metadata.gz: cf23dd0e2cd395df1a956216987023b1427e50268a964a770d2b1649206a115ae345a91adefaf067d612c64f04b312f1e508e1dc8f56dfa1157a395c038ac31f
-  data.tar.gz: fd01611ba7921490e8fdfee9073ab83fab85130e4428271e1d0f448cde5afd844da6a2a930bbff206f6b9832589bc425d5fc15231eb44a7c47842942305e4b40
+  metadata.gz: 5b1eae94ededb45b3cd48fdfe2440c5ac41af66b5c251e3a682906709d67a15d02d7463c7dc2e384fb4c217a745b7cec438b0d919e614f5f4c4c499a94cb17a4
+  data.tar.gz: fe8c7d881560b09702a4fe63680046f472efebb18aa1c09b01138b6dd9569727d29759bfc0e765095d52ec92df1c136e1de1419bf3fe282cc0b56e92cb3b1c9e

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Praxis Changelog
 
 ## next
+## 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).
 
 ## 2.0.pre.26
   * Make POST action forwarding more robust against technically malformed GET requests with no body but passing `Content-Type`. This could cause issues when using the `enable_large_params_proxy_action` DSL.

data/lib/praxis/mapper/resource.rb

@@ -60,8 +60,10 @@ module Praxis
         end
       end
 
-      def self.property(name, dependencies: nil, through: nil)
-        properties[name] = { dependencies: dependencies, through: through }
+      # The `as:` can be used for properties that correspond to an underlying association of a different name. With this the selector generator, is able to not only add
+      # any extra dependencies needed for the property, but it also follow and pass any incoming nested fields when necessary (as opposed to only add dependencies and discard nested fields)
+      def self.property(name, dependencies: nil, through: nil, as: name) # rubocop:disable Naming/MethodParameterName
+        properties[name] = { dependencies: dependencies, through: through, as: as }
       end
 
       def self.batch_computed(attribute, with_instance_method: true, &block)
@@ -119,11 +121,27 @@ module Praxis
       def self.define_model_accessors
         return if model.nil?
 
+        define_aliased_methods
+
         model._praxis_associations.each do |k, v|
           define_model_association_accessor(k, v) unless instance_methods.include? k
         end
       end
 
+      def self.define_aliased_methods
+        with_different_alias_name = properties.reject { |name, opts| name == opts[:as] }
+        with_different_alias_name.each do |prop_name, opts|
+          next if instance_methods.include? prop_name
+
+          # Straight call to another association method (that we will generate automatically in our association accessors)
+          module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{prop_name}
+              #{opts[:as]}
+            end
+          RUBY
+        end
+      end
+
       def self.hookup_callbacks
         return unless ancestors.include?(Praxis::Mapper::Resources::Callbacks)
 

data/lib/praxis/mapper/selector_generator.rb

@@ -66,8 +66,27 @@ module Praxis
       def add_property(name, fields)
         dependencies = resource.properties[name][:dependencies]
         # Always add the underlying association if we're overriding the name...
-        praxis_compat_model = resource.model&.respond_to?(:_praxis_associations)
-        add_association(name, fields) if praxis_compat_model && resource.model._praxis_associations.key?(name)
+        if (praxis_compat_model = resource.model&.respond_to?(:_praxis_associations))
+          aliased_as = resource.properties[name][: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
           # but properly detecting if it's a real association...in which case we've already added it above

data/lib/praxis/version.rb

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

data/spec/praxis/mapper/resource_spec.rb

@@ -5,6 +5,8 @@ require 'spec_helper'
 describe Praxis::Mapper::Resource do
   let(:parent_record) { ParentModel.new(id: 100, name: 'george sr') }
   let(:parent_records) { [ParentModel.new(id: 101, name: 'georgia'), ParentModel.new(id: 102, name: 'georgina')] }
+  let(:other_model) { OtherModel.new(name: 'other george') }
+
   let(:record) { SimpleModel.new(id: 103, name: 'george xvi') }
   let(:model) { SimpleModel }
 
@@ -16,15 +18,19 @@ describe Praxis::Mapper::Resource do
       subject(:properties) { resource.properties }
 
       it 'includes directly-set properties' do
-        expect(properties[:other_resource]).to eq(dependencies: [:other_model], through: nil)
+        expect(properties[:other_resource]).to eq(dependencies: [:other_model], through: nil, as: :other_resource)
+      end
+
+      it 'includes aliases as well if different from name' do
+        expect(properties[:aliased_association]).to eq(dependencies: [:name], through: nil, as: :other_model)
       end
 
       it 'inherits from a superclass' do
-        expect(properties[:href]).to eq(dependencies: [:id], through: nil)
+        expect(properties[:href]).to eq(dependencies: [:id], through: nil, as: :href)
       end
 
       it 'properly overrides a property from the parent' do
-        expect(properties[:name]).to eq(dependencies: [:simple_name], through: nil)
+        expect(properties[:name]).to eq(dependencies: [:simple_name], through: nil, as: :name)
       end
     end
   end
@@ -106,6 +112,19 @@ describe Praxis::Mapper::Resource do
         expect(parents.collect(&:record)).to match_array(parent_records)
       end
     end
+
+    context 'for aliased properties' do
+      before { expect(record).to receive(:other_model).and_return(other_model) }
+      it 'skips creation of aliased method if the resource already has it defined' do
+        expect(subject.overriden_aliased_association).to be_kind_of(OtherModel) # Our override return a bare model
+        expect(subject.method(:overriden_aliased_association).source_location).to_not include(%r{/mapper/resource.rb$}) # Not created by us
+      end
+
+      it 'creates the aliased method name, instead of the property name' do
+        expect(subject.aliased_association).to be_kind_of(OtherResource) # Calling the other generated method also wraps it
+        expect(subject.method(:aliased_association).source_location).to include(%r{/mapper/resource.rb$}) # created by us
+      end
+    end
   end
 
   context 'resource_delegate' do

data/spec/praxis/mapper/selector_generator_spec.rb

@@ -213,6 +213,78 @@ describe Praxis::Mapper::SelectorGenerator do
         end
         it_behaves_like 'a proper selector'
       end
+      context 'Aliased underlying associations follows any nested fields...' do
+        let(:fields) do
+          {
+            parent_id: true,
+            aliased_association: {
+              display_name: true
+            }
+          }
+        end
+        let(:selectors) do
+          {
+            model: SimpleModel,
+            columns: %i[other_model_id parent_id simple_name],
+            tracks: {
+              other_model: {
+                model: OtherModel,
+                columns: %i[id name]
+              }
+            }
+          }
+        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

@@ -125,6 +125,12 @@ class SimpleResource < BaseResource
     other_model
   end
 
+  def overriden_aliased_association
+    # My custom override (instead of the auto-generated delegator)
+    # For fun, we'll just return the raw model, without wrapping it in the resource
+    record.other_model
+  end
+
   batch_computed(:computed_name) do |rows_by_id:|
     rows_by_id.transform_values do |v|
       "BATCH_COMPUTED_#{v.name}"
@@ -146,6 +152,11 @@ class SimpleResource < BaseResource
   property :no_deps, dependencies: []
 
   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.26
+  version: 2.0.pre.28
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2023-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport