praxis 2.0.pre.17 → 2.0.pre.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dafcffa2e0d146f5b601ed796cb482c5068482757fc2f88770783536da52ad7e
-  data.tar.gz: c6f8875641b0e418128dd8f8a923a3df639b1a409e65976472c24b6fac52f90e
+  metadata.gz: 269b2403359c2a9ec0b591d695a5146ff648d16046d82ec52162086d0006bbb7
+  data.tar.gz: 3f28eebb4e3ceecd39a7ba5969df7ece5feafe93c3fd6b5d0dfb17df92f22fcd
 SHA512:
-  metadata.gz: 4728bf36f52fd0bf1f73c9efe02190cde40308be2378232897570deab1aa9e5fcbd1ca2b4335b9ad168c4eedda18143a512512e6c132d851b6f6c9447e891d19
-  data.tar.gz: 1d689d714604b4841f4059b1ef9734f1ceae0a9afcc7e7d75286be28f67cfe2a51cb86fafdd6c66b2ac40acc72bd431c12ad1b33aa91990ceecd690abc9e01ad
+  metadata.gz: 800cf53e02f7322a8db37212c16b3e53827bc50acbf630a58d2027397120c2c9044c81ae919a2855b7c3635786113526712cb6b882e505fbc0c1f46042ed8f5c
+  data.tar.gz: bd0969b6aa8618b78d3a2f42b9e14d5c5f5d776019bd1b697a66e3dbbbe3a6535c475d806edb64f82d16b370ba76cf8effd4fe73d03adc5934cd48446e3096b5

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## next
 
+## 2.0.pre.18
+* Upgraded to newest Attributor, which cleans up the required: true semantics to only work on keys, and introduces null: true for nullability of values (independent from presence of keys or not)
+* Fixed a selector generator bug that would occur when using deep nested resource dependencies as strings 'foo.bar.baz.bam'. In this cases only partial tracking of relationships would be built, which could cause to not fully eager load DB queries.
 ## 2.0.pre.17
 * Changed the Parameter Filtering to use left outer joins (and extra conditions), to allow for the proper results when OR clauses are involved in certain configurations.
 * Built support for allowing filtering directly on associations using `!` and `!!` operators. This allows to filter results where 

data/lib/praxis/action_definition.rb

@@ -124,8 +124,8 @@ module Praxis
     def payload(type=Attributor::Struct, **opts, &block)
       return @payload if !block && ( opts.nil? || opts.empty? ) && type == Attributor::Struct
 
-      unless( opts.key? :required )
-        opts[:required] = true # Make the payload required by default
+      unless opts.key?(:required)
+        opts = {required: true, null: false}.merge(opts) # Make the payload required and non-nullable by default
       end
 
       if @payload

data/lib/praxis/blueprint.rb

@@ -321,18 +321,33 @@ module Praxis
       @validating = true
 
       errors = []
-      self.class.attributes.each do |sub_attribute_name, sub_attribute|
-        sub_context = self.class.generate_subcontext(context, sub_attribute_name)
-        value = self.send(sub_attribute_name)
-        keys_with_values << sub_attribute_name unless value.nil?
+      keys_provided = []
+
+      self.class.attributes.each do |key, attribute|
+        sub_context = self.class.generate_subcontext(context, key)
+        value = _get_attr(key)
+        keys_provided << key if @object.key?(key)
 
         if value.respond_to?(:validating) # really, it's a thing with sub-attributes
           next if value.validating
         end
-        errors.concat(sub_attribute.validate(value, sub_context))
+
+        # Isn't this handled by the requirements validation? NO! we might want to combine
+        if attribute.options[:required] && !@object.key?(key)
+          errors.concat ["Attribute #{Attributor.humanize_context(sub_context)} is required."]
+        end
+        if @object[key].nil?
+          if !Attributor::Attribute.nullable_attribute?(attribute.options) && @object.key?(key) # It is only nullable if there's an explicite null: true (undefined defaults to false)
+            errors.concat ["Attribute #{Attributor.humanize_context(sub_context)} is not nullable."]
+          end
+          # No need to validate the attribute further if the key wasn't passed...(or we would get nullable errors etc..cause the attribute has no
+          # context if its containing key was even passed (and there might not be a containing key for a top level attribute anyways))
+        else
+          errors.concat attribute.validate(value, sub_context)
+        end
       end
-      self.class.attribute.type.requirements.each do |req|
-        validation_errors = req.validate(keys_with_values, context)
+      self.class.attribute.type.requirements.each do |requirement|
+        validation_errors = requirement.validate(keys_provided, context)
         errors.concat(validation_errors) unless validation_errors.empty?
       end
       errors

data/lib/praxis/dispatcher.rb

@@ -1,9 +1,9 @@
 module Praxis
 
   CONTEXT_FOR = {
-    params: [Attributor::AttributeResolver::ROOT_PREFIX, "params".freeze],
-    headers: [Attributor::AttributeResolver::ROOT_PREFIX, "headers".freeze],
-    payload: [Attributor::AttributeResolver::ROOT_PREFIX, "payload".freeze]
+    params: [Attributor::ROOT_PREFIX, "params".freeze],
+    headers: [Attributor::ROOT_PREFIX, "headers".freeze],
+    payload: [Attributor::ROOT_PREFIX, "payload".freeze]
   }.freeze
 
   class Dispatcher

data/lib/praxis/mapper/selector_generator.rb

@@ -98,10 +98,10 @@ module Praxis::Mapper
       when Symbol
         map_property(dependency, true)
       when String
-        head, tail = dependency.split('.').collect(&:to_sym)
+        head, *tail = dependency.split('.').collect(&:to_sym)
         raise "String dependencies can not be singular" if tail.nil?
 
-        add_association(head, {tail => true})
+        add_association(head, tail.reverse.inject({}) { |hash, dep| { dep => hash } })
       end
     end
 

data/lib/praxis/request.rb

@@ -142,18 +142,23 @@ module Praxis
     def validate_headers(context)
       return [] unless action.headers
 
+      return ["Attribute #{Attributor.humanize_context(context)} is required."] if action.headers.options[:required] == true && self.headers.nil?
+
       action.headers.validate(self.headers, context)
     end
 
     def validate_params(context)
       return [] unless action.params
 
+      return ["Attribute #{Attributor.humanize_context(context)} is required."] if action.params.options[:required] == true && self.params.nil?
+
       action.params.validate(self.params, context)
     end
 
     def validate_payload(context)
       return [] unless action.payload
 
+      return ["Attribute #{Attributor.humanize_context(context)} is required."] if action.payload.options[:required] == true && self.payload.nil?
       action.payload.validate(self.payload, context)
     end
 

data/lib/praxis/request_stages/validate_params_and_headers.rb

@@ -38,12 +38,6 @@ module Praxis
           )
         end
 
-        attribute_resolver = Attributor::AttributeResolver.new
-        Attributor::AttributeResolver.current = attribute_resolver
-
-        attribute_resolver.register("headers",request.headers)
-        attribute_resolver.register("params",request.params)
-
         errors = request.validate_headers(CONTEXT_FOR[:headers])
         errors += request.validate_params(CONTEXT_FOR[:params])
         if errors.any?

data/lib/praxis/request_stages/validate_payload.rb

@@ -27,7 +27,6 @@ module Praxis
               stage: name
             )
           end
-          Attributor::AttributeResolver.current.register("payload",request.payload)
 
           errors = request.validate_payload(CONTEXT_FOR[:payload])
           if errors.any?

data/lib/praxis/types/multipart_array.rb

@@ -346,6 +346,10 @@ module Praxis
         end
       end
 
+      def part?(name)
+        self.any?{ |i| i.name == name }
+      end
+
       def validate(context=Attributor::DEFAULT_ROOT_CONTEXT)
         errors = self.each_with_index.each_with_object([]) do |(part, idx), errors|
           sub_context = if part.name
@@ -359,13 +363,18 @@ module Praxis
 
         self.class.attributes.each do |name, attribute|
           payload_attribute = attribute.options[:payload_attribute]
-          next unless payload_attribute.options[:required]
-          next if self.part(name)
 
-          sub_context = self.class.generate_subcontext(context, name)
-          errors.push *payload_attribute.validate_missing_value(sub_context)
+          if !self.part?(name)
+            if payload_attribute.options[:required]
+              sub_context = self.class.generate_subcontext(context, name)
+              errors.push "Attribute #{Attributor.humanize_context(sub_context)} is required"
+            end
+            # Return, don't bother checking nullability as it hasn't been provided
+          elsif !self.part(name) && !Attribute.nullable_attribute?(payload_attribute.options)
+            sub_context = self.class.generate_subcontext(context, name)
+            errors.push "Attribute #{Attributor.humanize_context(sub_context)} is not nullable"
+          end
         end
-
         errors
       end
 

data/lib/praxis/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  VERSION = '2.0.pre.17'
+  VERSION = '2.0.pre.18'
 end

data/praxis.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mustermann', '>=1.1', '<=2'
   spec.add_dependency 'activesupport', '>= 3'
   spec.add_dependency 'mime', '~> 0'
-  spec.add_dependency 'attributor', '>= 5.5'
+  spec.add_dependency 'attributor', '>= 6.0'
   spec.add_dependency 'thor'
   spec.add_dependency 'terminal-table', '~> 1.4'
 

data/spec/praxis/action_definition_spec.rb

@@ -153,15 +153,16 @@ describe Praxis::ActionDefinition do
       it 'includes the requirements in the param struct type' do
         errors = action.params.load(value).validate
         expect(errors).to have(1).item
-        expect(errors.first).to match(/Key one is required/)
+        expect(errors.first).to match('Attribute $.key(:one) is required.')
       end
     end
 
   end
 
   describe '#payload' do
-    it 'defaults to being required if omitted' do
+    it 'defaults to being required and non nullable if omitted' do
       expect(subject.payload.options[:required]).to be(true)
+      expect(subject.payload.options[:null]).to be(false)
     end
 
 

data/spec/praxis/mapper/selector_generator_spec.rb

@@ -320,6 +320,40 @@ describe Praxis::Mapper::SelectorGenerator do
         it_behaves_like 'a proper selector'
       end      
 
+      context 'that are several attriutes deep' do
+        let(:fields) { { deep_nested_deps: true } }
+        let(:selectors) do
+          {
+            model: SimpleModel,
+            columns: [:parent_id],
+            tracks: {
+              parent: {
+                model: ParentModel,
+                columns: [:id], # No FKs in the source model for one_to_many
+                tracks: {
+                  simple_children: { 
+                    columns: [:parent_id, :other_model_id],
+                    model: SimpleModel,
+                    tracks: {
+                      other_model: {
+                        model: OtherModel,
+                        columns: [:id, :parent_id],
+                        tracks: {
+                          parent: {
+                            model: ParentModel,
+                            columns: [:id, :simple_name, :other_attribute]
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        end
+        it_behaves_like 'a proper selector'
+      end
     end
   end
 end

data/spec/praxis/request_spec.rb

@@ -17,9 +17,9 @@ describe Praxis::Request do
 
   let(:context) do
     {
-      params: [Attributor::AttributeResolver::ROOT_PREFIX, "params".freeze],
-      headers: [Attributor::AttributeResolver::ROOT_PREFIX, "headers".freeze],
-      payload: [Attributor::AttributeResolver::ROOT_PREFIX, "payload".freeze]
+      params: [Attributor::ROOT_PREFIX, "params".freeze],
+      headers: [Attributor::ROOT_PREFIX, "headers".freeze],
+      payload: [Attributor::ROOT_PREFIX, "payload".freeze]
     }.freeze
   end
 

data/spec/praxis/trait_spec.rb

@@ -24,7 +24,7 @@ describe Praxis::Trait do
 
       headers do
         header "Authorization"
-        key "Header2", String, required: true
+        key "Header2", String, required: true, null: false
       end
 
     end
@@ -42,10 +42,11 @@ describe Praxis::Trait do
     its([:params, :order, :type, :name]) { should eq 'String' }
     its([:routing, :prefix]) { should eq '/:app_name'}
 
-    its([:headers, "Header2"]) { should include({required: true}) }
+    its([:headers, "Header2"]) { should include({required: true, null: false}) }
     context 'using the special DSL syntax for headers' do
       subject(:dsl_header) { describe[:headers]["Authorization"] }
       its([:required]){ should be(true) }
+      its([:null]){ should be_nil }
       its([:type]){ should eq( { :id=>"Attributor-String", :name=>"String", :family=>"string"} )}
     end
 

data/spec/spec_app/design/media_types/instance.rb

@@ -10,7 +10,7 @@ class Instance < Praxis::MediaType
 
     attribute :href, String
 
-    attribute :root_volume, Volume
+    attribute :root_volume, Volume, null: true
 
     attribute :volumes, Volume::Collection
     

data/spec/spec_app/design/resources/instances.rb

@@ -57,7 +57,7 @@ module ApiResources
         attribute :create_identity_map, Attributor::Boolean, default: false
       end
 
-      payload required: false do
+      payload required: false, null: true do
         attribute :something, String
         attribute :optional, String, default: "not given"
       end
@@ -140,7 +140,7 @@ module ApiResources
         attribute :id
       end
 
-      payload required: false do
+      payload required: false, null: true do
         attribute :when, DateTime
       end
 

data/spec/support/spec_blueprints.rb

@@ -9,8 +9,8 @@ class PersonBlueprint < Praxis::Blueprint
     attribute :full_name, FullName
     attribute :aliases, Attributor::Collection.of(FullName)
 
-    attribute :address, AddressBlueprint, example: proc { |person, context| AddressBlueprint.example(context, resident: person) }
-    attribute :work_address, AddressBlueprint
+    attribute :address, AddressBlueprint, null: true, example: proc { |person, context| AddressBlueprint.example(context, resident: person) }
+    attribute :work_address, AddressBlueprint, null: true
 
     attribute :prior_addresses, Attributor::Collection.of(AddressBlueprint)
     attribute :parents do
@@ -21,7 +21,7 @@ class PersonBlueprint < Praxis::Blueprint
     attribute :tags, Attributor::Collection.of(String)
     attribute :href, String
     attribute :alive, Attributor::Boolean, default: true
-    attribute :myself, PersonBlueprint
+    attribute :myself, PersonBlueprint, null: true
     attribute :friends, Attributor::Collection.of(PersonBlueprint)
     attribute :metadata, Attributor::Hash
   end

data/spec/support/spec_resources.rb

@@ -93,6 +93,8 @@ end
 
 class ParentResource < BaseResource
   model ParentModel
+
+  property :display_name, dependencies: [:simple_name, :id, :other_attribute]
 end
 
 class SimpleResource < BaseResource
@@ -117,6 +119,8 @@ class SimpleResource < BaseResource
   property :everything_from_parent, dependencies: ['parent.*']
   property :circular_dep, dependencies: [ :circular_dep, :column1 ]
   property :no_deps, dependencies: []
+
+  property :deep_nested_deps, dependencies: [ 'parent.simple_children.other_model.parent.display_name']
 end
 
 class YamlArrayResource < BaseResource

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.17
+  version: 2.0.pre.18
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -79,14 +79,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement