praxis 2.0.pre.17 → 2.0.pre.21

data/lib/praxis/types/multipart_array/part_definition.rb

@@ -1,15 +1,13 @@
+# frozen_string_literal: true
+
 module Praxis
   module Types
     class MultipartArray < Attributor::Collection
       class PartDefinition
-
-        attr_accessor :payload_attribute
-        attr_accessor :headers_attribute
-        attr_accessor :filename_attribute
-
+        attr_accessor :payload_attribute, :headers_attribute, :filename_attribute
 
         def initialize(&block)
-          self.instance_eval(&block)
+          instance_eval(&block)
         end
 
         def update_attribute(attribute, options, block)
@@ -17,17 +15,17 @@ module Praxis
           attribute.type.attributes(**options, &block)
         end
 
-        def create_attribute(type=Attributor::Struct, **opts, &block)
+        def create_attribute(type = Attributor::Struct, **opts, &block)
           # TODO: how do we want to handle any referenced types?
-          return Attributor::Attribute.new(type, opts, &block)
+          Attributor::Attribute.new(type, opts, &block)
         end
 
-        def payload(type=Attributor::Struct, **opts, &block)
-          #return @payload if !block_given? && type == Attributor::Struct
+        def payload(type = Attributor::Struct, **opts, &block)
+          # return @payload if !block_given? && type == Attributor::Struct
           @payload_attribute = create_attribute(type, **opts, &block)
         end
 
-        def header(name, val=nil, **options)
+        def header(name, val = nil, **options)
           block = proc { header(name, val, **options) }
 
           if @headers_attribute
@@ -35,17 +33,16 @@ module Praxis
           else
             type = Attributor::Hash.of(key: String)
             @headers_attribute = create_attribute(type,
-                                        dsl_compiler: Praxis::ActionDefinition::HeadersDSLCompiler,
-                                        case_insensitive_load: false, # :(
-                                        allow_extra: true,
-                                        &block)
+                                                  dsl_compiler: Praxis::ActionDefinition::HeadersDSLCompiler,
+                                                  case_insensitive_load: false, # :(
+                                                  allow_extra: true,
+                                                  &block)
           end
         end
 
-        def filename(type=String, **opts)
+        def filename(type = String, **opts)
           @filename_attribute = create_attribute(type, **opts)
         end
-
       end
     end
   end

data/lib/praxis/types/multipart_array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'praxis/types/multipart_array/part_definition'
 
 module Praxis
@@ -12,6 +14,7 @@ module Praxis
       @identifier = MediaTypeIdentifier.load('multipart/form-data').freeze
 
       def self.inherited(klass)
+        super
         klass.instance_eval do
           @attributes = FuzzyHash.new
           @saved_blocks = []
@@ -26,38 +29,32 @@ module Praxis
           @part_attribute = nil
 
           @identifier = MediaTypeIdentifier.load('multipart/form-data').freeze
-
         end
       end
 
       class << self
-        attr_reader :attributes
-        attr_reader :multiple
-        attr_reader :options
-        attr_reader :identifier
+        attr_reader :attributes, :multiple, :options, :identifier
       end
 
       def self.constructable?
         true
       end
 
-      def self.construct(constructor_block, _options={})
+      def self.construct(constructor_block, _options = {})
         Class.new(self, &constructor_block)
       end
 
-      def self.name_type(type=nil)
+      def self.name_type(type = nil)
         return @name_type if type.nil?
 
         @name_type = Attributor.resolve_type type
       end
 
-      def self.payload_type(type=nil, **opts, &block)
+      def self.payload_type(type = nil, **opts, &block)
         if type.nil?
-          if block_given?
-            type = Attributor::Struct
-          else
-            return @payload_type
-          end
+          return @payload_type unless block_given?
+
+          type = Attributor::Struct
         end
         @payload_type = Attributor.resolve_type(type)
         @payload_attribute = Attributor::Attribute.new(@payload_type, **opts, &block)
@@ -70,13 +67,13 @@ module Praxis
       end
 
       def self.part_attribute
-        @part_attribute ||= Attributor::Attribute.new(Praxis::MultipartPart, payload_attribute: self.payload_attribute)
+        @part_attribute ||= Attributor::Attribute.new(Praxis::MultipartPart, payload_attribute: payload_attribute)
       end
 
-      def self.part(name, payload_type=nil, multiple: false, filename: false, **opts, &block)
+      def self.part(name, payload_type = nil, multiple: false, filename: false, **opts, &block)
         @attributes.default_proc = nil
 
-        if name.kind_of?(Regexp)
+        if name.is_a?(Regexp)
           raise 'part with regexp name may not take :multiple option' if multiple
           raise 'part with regexp name may not be required' if opts[:required] == true
         end
@@ -85,9 +82,7 @@ module Praxis
 
         compiler = Attributor::DSLCompiler.new(self, **opts)
 
-        if filename
-          filename_attribute = compiler.define('filename', String, required: true)
-        end
+        filename_attribute = compiler.define('filename', String, required: true) if filename
 
         if block_given?
           definition = PartDefinition.new(&block)
@@ -95,35 +90,31 @@ module Praxis
           header_attribute = definition.headers_attribute
           filename_attribute = definition.filename_attribute || filename_attribute
 
-          self.attributes[name] = compiler.define(name, Praxis::MultipartPart,
-                                                  payload_attribute: payload_attribute,
-                                                  headers_attribute: header_attribute,
-                                                  filename_attribute: filename_attribute
-                                                  )
+          attributes[name] = compiler.define(name, Praxis::MultipartPart,
+                                             payload_attribute: payload_attribute,
+                                             headers_attribute: header_attribute,
+                                             filename_attribute: filename_attribute)
         else
           payload_attribute = compiler.define(name, payload_type || self.payload_type, **opts)
-          self.attributes[name] = compiler.define(name, Praxis::MultipartPart,
-                                                  payload_attribute: payload_attribute,
-                                                  filename_attribute: filename_attribute
-                                                  )
+          attributes[name] = compiler.define(name, Praxis::MultipartPart,
+                                             payload_attribute: payload_attribute,
+                                             filename_attribute: filename_attribute)
         end
       end
 
-      def self.file(name, payload_type=nil, filename: nil, **opts, &block)
-        self.part(name, payload_type, filename: true, **opts, &block)
+      def self.file(name, payload_type = nil, **opts, &block)
+        part(name, payload_type, filename: true, **opts, &block)
       end
 
-      def self.load(value, context=Attributor::DEFAULT_ROOT_CONTEXT, content_type:nil)
-        return value if value.kind_of?(self) || value.nil?
+      def self.load(value, _context = Attributor::DEFAULT_ROOT_CONTEXT, content_type: nil)
+        return value if value.is_a?(self) || value.nil?
 
-        if value.kind_of?(::String) && content_type.nil?
-          raise ArgumentError, "content_type is required to load values of type String for #{Attributor.type_name(self)}"
-        end
+        raise ArgumentError, "content_type is required to load values of type String for #{Attributor.type_name(self)}" if value.is_a?(::String) && content_type.nil?
 
-        parser = Praxis::MultipartParser.new({'Content-Type' => content_type}, value)
+        parser = Praxis::MultipartParser.new({ 'Content-Type' => content_type }, value)
         preamble, parts = parser.parse
 
-        instance = self.new
+        instance = new
         instance.push(*parts)
 
         instance.preamble = preamble
@@ -132,22 +123,23 @@ module Praxis
         instance
       end
 
-      def self.example(context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
-        example = self.new
+      def self.example(context = Attributor::DEFAULT_ROOT_CONTEXT, **_options)
+        example = new
 
-        self.attributes.each do |name, attribute|
-          next if name.kind_of? Regexp
-          sub_context = self.generate_subcontext(context, name)
+        attributes.each do |name, attribute|
+          next if name.is_a? Regexp
+
+          sub_context = generate_subcontext(context, name)
 
           part = attribute.example(sub_context)
           part.name = name
           example.push part
 
-          if self.multiple.include? name
-            part = attribute.example(sub_context + ['2'])
-            part.name = name
-            example.push part
-          end
+          next unless multiple.include? name
+
+          part = attribute.example(sub_context + ['2'])
+          part.name = name
+          example.push part
         end
 
         example
@@ -174,36 +166,35 @@ module Praxis
       #   profileImage:  # Part 3 (an image)
       #     type: string
       #     format: binary
-      # 
-      # NOTE: not sure if this 
-      def self.as_openapi_request_body( attribute_options: {} )
+      #
+      # NOTE: not sure if this
+      def self.as_openapi_request_body(attribute_options: {})
         hash = { type: json_schema_type }
-        opts = self.options.merge( attribute_options )
+        opts = options.merge(attribute_options)
         hash[:description] = opts[:description] if opts[:description]
         hash[:default] = opts[:default] if opts[:default]
 
-        unless self.attributes.empty?
+        unless attributes.empty?
           props = {}
           encoding = {}
-          self.attributes.each do |part_name, part_attribute|
+          attributes.each do |part_name, part_attribute|
             part_example = part_attribute.example
             key_to_use = part_name.is_a?(Regexp) ? part_name.source : part_name
-            
-            part_info = {}
+
             if (payload_attribute = part_attribute.options[:payload_attribute])
               props[key_to_use] = payload_attribute.as_json_schema(example: part_example.payload)
             end
-            #{
+            # {
             # contentType: 'fff',
             # headers: {
             #   custom1: 'safd'
             # }
-            if (headers_attribute = part_attribute.options[:headers_attribute])
-              # Does this 'Content-Type' string check work?...can it be a symbol? what does it mean anyway?
-              encoding[key_to_use][:contentType] = headers_attribute['Content-Type'] if headers_attribute['Content-Type']
-              # TODO?rethink? ...is this correct?: att a 'headers' key with some header schemas if this part have some
-              encoding[key_to_use]['headers'] = headers_attribute.as_json_schema(example: part_example.headers)
-            end
+            next unless (headers_attribute = part_attribute.options[:headers_attribute])
+
+            # Does this 'Content-Type' string check work?...can it be a symbol? what does it mean anyway?
+            encoding[key_to_use][:contentType] = headers_attribute['Content-Type'] if headers_attribute['Content-Type']
+            # TODO?rethink? ...is this correct?: att a 'headers' key with some header schemas if this part have some
+            encoding[key_to_use]['headers'] = headers_attribute.as_json_schema(example: part_example.headers)
           end
 
           hash[:properties] = props
@@ -212,27 +203,27 @@ module Praxis
         hash
       end
 
-      def self.as_json_schema( shallow: false, example: nil, attribute_options: {} )
+      def self.as_json_schema(attribute_options: {}, **_other)
         as_openapi_request_body(attribute_options: attribute_options)
       end
 
-      def self.describe(shallow=true, example: nil)
+      def self.describe(shallow = true, example: nil)
         type_name = Attributor.type_name(self)
         hash = {
           name: type_name.gsub(Attributor::MODULE_PREFIX_REGEX, ''),
-          family: self.family,
-          id: self.id
+          family: family,
+          id: id
         }
         hash[:example] = example if example
 
-        hash[:part_name] = {type: name_type.describe(true)}
+        hash[:part_name] = { type: name_type.describe(true) }
 
         unless shallow
-          hash[:attributes] = {} if self.attributes.keys.any? { |name| name.kind_of? String}
-          hash[:pattern_attributes] = {} if self.attributes.keys.any? { |name| name.kind_of? Regexp}
+          hash[:attributes] = {} if attributes.keys.any? { |name| name.is_a? String }
+          hash[:pattern_attributes] = {} if attributes.keys.any? { |name| name.is_a? Regexp }
 
           if hash.key?(:attributes) || hash.key?(:pattern_attributes)
-            self.describe_attributes(shallow, example: example).each do |name, sub_hash|
+            describe_attributes(shallow, example: example).each do |name, sub_hash|
               case name
               when String
                 hash[:attributes][name] = sub_hash
@@ -241,38 +232,30 @@ module Praxis
               end
             end
           else
-            hash[:part_payload] = {type: payload_type.describe(true)}
+            hash[:part_payload] = { type: payload_type.describe(true) }
           end
         end
         hash
       end
 
-      def self.describe_attributes(shallow=true, example: nil)
-        self.attributes.each_with_object({}) do |(part_name, part_attribute), parts|
+      def self.describe_attributes(shallow = true, example: nil)
+        attributes.each_with_object({}) do |(part_name, part_attribute), parts|
           sub_example = example.part(part_name) if example
-          if sub_example && self.multiple.include?(part_name)
-            sub_example = sub_example.first
-          end
+          sub_example = sub_example.first if sub_example && multiple.include?(part_name)
 
           sub_hash = part_attribute.describe(shallow, example: sub_example)
 
-
           if (options = sub_hash.delete(:options))
             sub_hash[:options] = {}
-            if self.multiple.include?(part_name)
-              sub_hash[:options][:multiple] = true
-            end
+            sub_hash[:options][:multiple] = true if multiple.include?(part_name)
 
-            if (payload_attribute = options.delete :payload_attribute)
-              if (required = payload_attribute.options[:required])
-                sub_hash[:options][:required] = true
-              end
+            if (payload_attribute = options.delete :payload_attribute) && payload_attribute.options[:required]
+              sub_hash[:options][:required] = true
             end
           end
 
           sub_hash[:type] = MultipartPart.describe(shallow, example: sub_example, options: part_attribute.options)
 
-
           parts[part_name] = sub_hash
         end
       end
@@ -281,14 +264,13 @@ module Praxis
       attr_reader :content_type
 
       def initialize(content_type: self.class.identifier.to_s)
+        super()
         self.content_type = content_type
       end
 
       def content_type=(content_type)
         @content_type = MediaTypeIdentifier.load(content_type)
-        if @content_type.parameters.get('boundary').nil?
-          @content_type.parameters.set 'boundary', 'Boundary_puppies'
-        end
+        @content_type.parameters.set 'boundary', 'Boundary_puppies' if @content_type.parameters.get('boundary').nil?
         @content_type
       end
 
@@ -298,9 +280,7 @@ module Praxis
 
       def push(*parts, context: Attributor::DEFAULT_ROOT_CONTEXT)
         part, *rest = parts
-        if rest.any?
-          return self.push(part, context: context).push(*rest, context:context)
-        end
+        return push(part, context: context).push(*rest, context: context) if rest.any?
 
         original_context = context
 
@@ -313,12 +293,10 @@ module Praxis
         # payload_attribute, otherwise we constrain the parts
         # to the defined names.
         attribute = if self.class.attributes.empty?
-          self.class.part_attribute
-        elsif (default_thingy = self.class.attributes[key])
-          default_thingy
-        else
-          nil
-        end
+                      self.class.part_attribute
+                    elsif (default_thingy = self.class.attributes[key])
+                      default_thingy
+                    end
 
         if attribute
           part.attribute = attribute
@@ -327,11 +305,11 @@ module Praxis
           return self << part
         elsif self.class.options[:case_insensitive_load]
           name = self.class.attributes.keys.find do |k|
-            k.kind_of?(String) && key.downcase == k.downcase
+            k.is_a?(String) && key.downcase == k.downcase
           end
           if name
             part.name = name
-            return self.push(part, context: original_context)
+            return push(part, context: original_context)
           end
         end
 
@@ -342,30 +320,39 @@ module Praxis
         if self.class.multiple.include?(name)
           self.select { |i| i.name == name }
         else
-          self.find { |i| i.name == name }
+          find { |i| i.name == name }
         end
       end
 
-      def validate(context=Attributor::DEFAULT_ROOT_CONTEXT)
-        errors = self.each_with_index.each_with_object([]) do |(part, idx), errors|
+      def part?(name)
+        any? { |i| i.name == name }
+      end
+
+      def validate(context = Attributor::DEFAULT_ROOT_CONTEXT)
+        errors = each_with_index.each_with_object([]) do |(part, idx), error_list|
           sub_context = if part.name
-            self.class.generate_subcontext(context, part.name)
-          else
-            context + ["at(#{idx})"]
-          end
+                          self.class.generate_subcontext(context, part.name)
+                        else
+                          context + ["at(#{idx})"]
+                        end
 
-          errors.push *part.validate(sub_context)
+          error_list.push(*part.validate(sub_context))
         end
 
         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 !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
 
@@ -376,15 +363,13 @@ module Praxis
       def dump(**opts)
         boundary = content_type.parameters.get 'boundary'
 
-        parts = self.collect do |part|
+        parts = collect do |part|
           part.dump(**opts)
         end
 
         all_entities = parts.join("\r\n--#{boundary}\r\n")
         "--#{boundary}\r\n#{all_entities}\r\n--#{boundary}--\r\n"
       end
-
-
     end
   end
 end

data/lib/praxis/validation_handler.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Praxis
   class ValidationHandler
-
     # Should return the Response to send back
-    def handle!(summary:, request:, stage:, errors: nil, exception: nil, **opts)
+    def handle!(summary:, errors: nil, exception: nil, **opts)
+      opts.delete(:request)
+      opts.delete(:stage)
       Responses::ValidationError.new(summary: summary, errors: errors, exception: exception, **opts)
     end
-
   end
 end

data/lib/praxis/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Praxis
-  VERSION = '2.0.pre.17'
+  VERSION = '2.0.pre.21'
 end

data/lib/praxis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack'
 require 'attributor'
 
@@ -5,7 +7,7 @@ require 'active_support/concern'
 require 'praxis/request_superclassing'
 require 'active_support/inflector'
 
-$:.unshift File.dirname(__FILE__)
+$LOAD_PATH.unshift File.dirname(__FILE__)
 
 require 'mime'
 module MIME
@@ -15,7 +17,6 @@ module MIME
 end
 
 module Praxis
-
   autoload :ActionDefinition, 'praxis/action_definition'
   autoload :ApiGeneralInfo, 'praxis/api_general_info'
   autoload :ApiDefinition, 'praxis/api_definition'
@@ -28,7 +29,7 @@ module Praxis
   autoload :ErrorHandler, 'praxis/error_handler'
   autoload :ValidationHandler, 'praxis/validation_handler'
   autoload :Exception, 'praxis/exception'
-  autoload :FileGroup,'praxis/file_group'
+  autoload :FileGroup, 'praxis/file_group'
   autoload :Plugin, 'praxis/plugin'
   autoload :PluginConcern, 'praxis/plugin_concern'
   autoload :Request, 'praxis/request'
@@ -50,7 +51,6 @@ module Praxis
   autoload :Blueprint, 'praxis/blueprint'
   autoload :FieldExpander, 'praxis/field_expander'
   autoload :Renderer, 'praxis/renderer'
-  
 
   autoload :Notifications, 'praxis/notifications'
   autoload :MiddlewareApp, 'praxis/middleware_app'
@@ -143,5 +143,4 @@ module Praxis
   require 'praxis/responses/internal_server_error'
   require 'praxis/responses/validation_error'
   require 'praxis/responses/multipart_ok'
-
 end

data/praxis.gemspec

@@ -1,36 +1,38 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'praxis/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "praxis"
+  spec.name          = 'praxis'
   spec.version       = Praxis::VERSION
-  spec.authors = ["Josep M. Blanquer","Dane Jensen"]
+  spec.authors = ['Josep M. Blanquer', 'Dane Jensen']
   spec.summary = 'Building APIs the way you want it.'
 
-  spec.email = ["blanquer@gmail.com","dane.jensen@gmail.com"]
+  spec.email = ['blanquer@gmail.com', 'dane.jensen@gmail.com']
 
-  spec.homepage = "https://github.com/praxis/praxis"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">=2.1"
+  spec.homepage = 'https://github.com/praxis/praxis'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>=2.5'
 
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
   spec.files         = `git ls-files -z`.split("\x0")
   spec.bindir = 'bin'
   spec.executables << 'praxis'
 
-  spec.add_dependency 'rack', '>= 1'
-  spec.add_dependency 'mustermann', '>=1.1', '<=2'
   spec.add_dependency 'activesupport', '>= 3'
+  spec.add_dependency 'attributor', '>= 6.0'
   spec.add_dependency 'mime', '~> 0'
-  spec.add_dependency 'attributor', '>= 5.5'
-  spec.add_dependency 'thor'
+  spec.add_dependency 'mustermann', '>=1.1', '<=2'
+  spec.add_dependency 'rack', '>= 1'
   spec.add_dependency 'terminal-table', '~> 1.4'
+  spec.add_dependency 'thor'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '>= 12.3.3'
-  
+
   if RUBY_PLATFORM !~ /java/
     spec.add_development_dependency 'pry'
     spec.add_development_dependency 'pry-byebug'
@@ -39,17 +41,16 @@ Gem::Specification.new do |spec|
   else
     spec.add_development_dependency 'jdbc-sqlite3'
   end
-  spec.add_development_dependency 'rspec', '~> 3'
-  spec.add_development_dependency 'rspec-its', '~> 1'
-  spec.add_development_dependency 'rspec-collection_matchers', '~> 1'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'fuubar', '~> 2'
   spec.add_development_dependency 'guard', '~> 2'
-  spec.add_development_dependency 'guard-rspec', '~> 4'
   spec.add_development_dependency 'guard-bundler', '~> 2'
+  spec.add_development_dependency 'guard-rspec', '~> 4'
   spec.add_development_dependency 'rack-test', '~> 0'
-  spec.add_development_dependency 'simplecov', '~> 0'
-  spec.add_development_dependency 'fuubar', '~> 2'
-  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec-collection_matchers', '~> 1'
+  spec.add_development_dependency 'rspec-its', '~> 1'
   # Just for the query selector extensions etc...
+  spec.add_development_dependency 'activerecord', '> 4', '< 7'
   spec.add_development_dependency 'sequel', '~> 5'
-  spec.add_development_dependency 'activerecord', '> 4'
 end