praxis 2.0.pre.22 → 2.0.pre.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcf3359dc0ac9062c61efc934673d9bf5dfdda43e5abfbc9abc41d3030a7a00e
-  data.tar.gz: 04ffe07b27222f714b8da5e756cc9e1733b76d066a9e1bf5a3d15358dc7e6662
+  metadata.gz: 7f399850436ae7099b3d2bcef4f1d0648b094af1d307f47498d92c3ce275379a
+  data.tar.gz: 5f1fa0dbad1f3cf54de9c1a398f93f72c994fe7e61e081ab0e4af3e90f1941b0
 SHA512:
-  metadata.gz: f90af4ae85f4170a850d7d7637758c0c2d878271befa2fe437da8c994ac78657eebd28831bb0945a74ca48aa93a91d42e8b734fd70f3996984e427ad6850a7ae
-  data.tar.gz: b8eaa60ce2ba599b94f4b844339df8501ca295f3e1efb9a0f5dd38b9c4551aa64f108ba3a28913d06a22748dab11fee5c4bd8f9cfb8d2e85b1c456fb3284a5b3
+  metadata.gz: a1bb3ad07b0376ea46601104c0c5539cf39c4027e787f5228366cc5d5d7ff2a0ec44b8bf516ae3692ddd4ce781e4695faf760cb46750ad052e66f0618b454b71
+  data.tar.gz: 0d9689af7ec169f05a39113c69deb470f70cb41425b0aca71102fd7bb32f877fb8dfca73737ec6935b3b6afcf43e79d670881344c56cffdf13ee9162126c2a05

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## next
 
+## 2.0.pre.24
+ Assorted set of fixes and cleanup:
+  * better forwarding signature for query methods
+  * Fix the way with which to decide how to wrap an association (based on Enumerable isn't right, as Hashes are Enumerable as well). Wrapping decision
+    is now made based on the association type, and not the shape of the resulting type.
+  * Built handling of some multivalue and/or fuzzy matching cases in filtering params
+  * unrestrict mustermann's dependent version
+  * Support options and even passing a full type (instead of a block) in signature definitions (TypedMethods for resources)
+
+## 2.0.pre.22
+  * Small fix in OpenAPI doc generation, which would detect and report more output types, even if they are only defined within the
+    children of anonymous types.
+
 ## 2.0.pre.22
   * Introduced Resource callbacks (an includeable concern). Callbacks allow you to define methods or blocks to be executed `before`, `after` or `around` any existing method in the resource. Class-level callbacks are defined with `self.xxxxx`. These methods will be executed within the instance of the resource (i.e., in the same context of the original) and must be defined with the same parameter signature. For around methods, only blocks can be used, and to call the original (inner) one, one needs to yield.
   * Introduced QueryMethods for resources (an includeable concern). QueryMethods expose handy querying methods (`.get`, `.get!`, `.all`, `.first` and `.last` ) which will reach into the underlying ORM (i.e., right now, only ActiveModelCompat is supported) to perform the desired loading of data (and subsequent wrapping of results in resource instances).

data/lib/praxis/docs/open_api/media_type_object.rb

@@ -26,8 +26,19 @@ module Praxis
           # NOTE2: we should just create a $ref here unless it's an anon mediatype...
           return {} if type.is_a? SimpleMediaType # NOTE: skip if it's a SimpleMediaType?? ... is that correct?
 
-          the_schema = if type.anonymous? || !(type < Praxis::MediaType) # Avoid referencing  custom/simple Types? (i.e., just MTs)
-                         SchemaObject.new(info: type).dump_schema(shallow: false, allow_ref: false)
+          the_schema = if type.anonymous? || !(type < Praxis::MediaType)
+                         # Avoid referencing custom/simple types (i.e. just MTs). As a corner case,
+                         # dig into collections (which are anonymous) provided their member is not.
+                         # This isn't germane to content attributes, but is necessary to ensure that we visit every
+                         # non-anonymous type so that our emitted scheme covers the whole "surface area" of all
+                         # actions.
+                         underlying_type = type
+                         underlying_type = underlying_type.member_type while underlying_type < Attributor::Collection
+
+                         SchemaObject.new(info: type).dump_schema(
+                           shallow: false,
+                           allow_ref: type < Attributor::Collection && !underlying_type.anonymous?
+                         )
                        else
                          SchemaObject.new(info: type).dump_schema(shallow: true, allow_ref: true)
                        end

data/lib/praxis/extensions/attribute_filtering/filtering_params.rb

@@ -250,7 +250,8 @@ module Praxis
             next unless item[:value].presence
 
             fuzzy_match = attr_filters[:fuzzy_match]
-            errors << "Fuzzy matching for #{attr_name} is not allowed (yet '*' was found in the value)" if item[:fuzzy] && !item[:fuzzy].empty? && !fuzzy_match
+            # If fuzzy matches aren't allowed, but there is one passed in (or in the case of a multimatch, any of the ones in it), we disallow it
+            errors << "Fuzzy matching for #{attr_name} is not allowed (yet '*' was found in the value)" if item[:fuzzy] && !fuzzy_match && !(item[:fuzzy].is_a?(Array) && item[:fuzzy].compact.empty?)
           end
         end
 
@@ -258,7 +259,29 @@ module Praxis
         def dump
           parsed_array.each_with_object([]) do |item, arr|
             field = item[:name]
-            arr << "#{field}#{item[:op]}#{item[:value]}"
+            value = \
+              if item[:value].is_a?(Array)
+                item[:value].map.with_index do |i, idx|
+                  case item[:fuzzy][idx]
+                  when nil
+                    i
+                  when :start
+                    "*#{i}"
+                  when :end
+                    "#{i}*"
+                  end
+                end.join(',')
+              else
+                case item[:fuzzy]
+                when nil
+                  item[:value]
+                when :start
+                  "*#{item[:value]}"
+                when :end
+                  "#{item[:value]}*"
+                end
+              end
+            arr << "#{field}#{item[:op]}#{value}"
           end.join('&')
         end
 

data/lib/praxis/mapper/resource.rb

@@ -177,13 +177,24 @@ module Praxis
         return unless association_resource_class
 
         memoized_variables << name
+
+        # Add the call to wrap (for true collections) or simply for_record if it's a n:1 association
+        wrapping = \
+          case association_spec.fetch(:type)
+          when :one_to_many, :many_to_many
+            "@__#{name} ||= #{association_resource_class}.wrap(records)"
+          else
+            "@__#{name} ||= #{association_resource_class}.for_record(records)"
+          end
+
         module_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{name}
           return @__#{name} if instance_variable_defined?("@__#{name}")
 
           records = record.#{name}
           return nil if records.nil?
-          @__#{name} ||= #{association_resource_class}.wrap(records)
+
+          #{wrapping}
         end
         RUBY
       end

data/lib/praxis/mapper/resources/query_methods.rb

@@ -13,8 +13,8 @@ module Praxis
             QueryProxy.new(klass: self).including(args)
           end
 
-          def all(args = {})
-            QueryProxy.new(klass: self).all(args)
+          def all(...)
+            QueryProxy.new(klass: self).all(...)
           end
 
           def get(args)

data/lib/praxis/mapper/resources/query_proxy.rb

@@ -22,7 +22,7 @@ module Praxis
           base = klass.model._add_includes(klass.model, @_includes) # includes(nil) seems to have no effect
           record = base._get(condition)
 
-          record.nil? ? nil : klass.wrap(record)
+          record.nil? ? nil : klass.for_record(record)
         end
 
         def get!(condition)

data/lib/praxis/mapper/resources/typed_methods.rb

@@ -40,17 +40,25 @@ module Praxis
               super
             end
 
-            def signature(method_name, &block)
+            # It can take options to be passed to the attribute's block of the constructed struct
+            # It can take an already existing struct instead of a block/options
+            def signature(method_name, same_as_type = nil, **opts, &block)
               method = method_name.to_sym
               @signatures ||= {}
+              raise "signature definition for #{method_name}: need to pass either an existing type or a block, not both" if block_given? && same_as_type
+
               if block_given?
                 type =
                   Class.new(Attributor::Struct) do
-                    attributes do
+                    attributes(**opts) do
                       instance_eval(&block)
                     end
                   end
                 @signatures[method] = type
+              elsif same_as_type
+                raise "Options for signature definition for #{method_name} are not supported when passing an already existing type" unless opts.empty?
+
+                @signatures[method] = same_as_type
               else
                 @signatures[method]
               end

data/lib/praxis/version.rb

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

data/praxis.gemspec

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

data/spec/praxis/extensions/attribute_filtering/filtering_params_spec.rb

@@ -278,12 +278,46 @@ describe Praxis::Extensions::AttributeFiltering::FilteringParams do
             expect(subject.first).to match(/Fuzzy matching for content is not allowed/)
           end
         end
+        context 'given a fuzzy string in only one of the values' do
+          let(:filters_string) { 'content=IAmNotFuzzy,IAmAString*' }
+          it 'errors out' do
+            expect(subject).to_not be_empty
+            expect(subject.first).to match(/Fuzzy matching for content is not allowed/)
+          end
+        end
         context 'given a non-fuzzy string' do
           let(:filters_string) { 'content=IAmAString' }
           it 'validates properly' do
             expect(subject).to be_empty
           end
         end
+        context 'given a non-fuzzy string for a multivalue' do
+          let(:filters_string) { 'content=IAmAString,IAmAnotherString' }
+          it 'validates properly' do
+            expect(subject).to be_empty
+          end
+        end
+      end
+    end
+  end
+
+  context '.dump' do
+    context 'round trips for different types' do
+      it 'round trips for different types of values and operators' do
+        str = 'one=11&two!=22&three>=33&four<=4&five<5&six>6&seven!&eight!!'
+        expect(described_class.load(str).dump).to eq(str)
+      end
+      it 'round trips for multivalues' do
+        str = 'filtername=1,2,3'
+        expect(described_class.load(str).dump).to eq(str)
+      end
+      it 'round trips for fuzzies' do
+        str = 'filtername=file*'
+        expect(described_class.load(str).dump).to eq(str)
+      end
+      it 'round trips for fuzzies in multivalues' do
+        str = 'filtername=1,*2,3*'
+        expect(described_class.load(str).dump).to eq(str)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.22
+  version: 2.0.pre.24
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-16 00:00:00.000000000 Z
+date: 2022-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -60,9 +60,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -70,9 +67,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement