media_types 2.2.0 → 2.3.0

data/lib/media_types/dsl.rb

@@ -1,172 +1,172 @@
-# frozen_string_literal: true
-
-require 'set'
-
-require 'media_types/constructable'
-require 'media_types/validations'
-
-require 'media_types/dsl/errors'
-
-module MediaTypes
-  module Dsl
-    def self.included(base)
-      base.extend ClassMethods
-      base.class_eval do
-        class << self
-          attr_accessor :media_type_name_for, :media_type_combinations, :media_type_validations, :symbol_keys
-
-          private
-
-          attr_accessor :media_type_constructable, :symbol_base, :media_type_registrar
-        end
-        base.media_type_combinations = Set.new
-      end
-    end
-
-    module ClassMethods
-      def to_constructable
-        raise UninitializedConstructable if media_type_constructable.nil?
-
-        media_type_constructable.dup.tap do |constructable|
-          constructable.__setobj__(self)
-        end
-      end
-
-      def symbol_keys?
-        if symbol_keys.nil?
-          MediaTypes.get_key_expectation(self)
-        else
-          symbol_keys
-        end
-      end
-
-      def string_keys?
-        !symbol_keys?
-      end
-
-      def valid?(output, **opts)
-        to_constructable.valid?(output, **opts)
-      end
-
-      def valid_unsafe?(output, media_type = to_constructable, **opts)
-        opts[:expected_key_type] = string_keys? ? String : Symbol
-        validations.find(media_type).valid?(output, backtrace: ['.'], **opts)
-      end
-
-      def validate!(output, **opts)
-        assert_sane!
-        to_constructable.validate!(output, **opts)
-      end
-
-      def validate_unsafe!(output, media_type = to_constructable, **opts)
-        opts[:expected_key_type] = string_keys? ? String : Symbol
-        validations.find(media_type).validate(output, backtrace: ['.'], **opts)
-      end
-
-      def validatable?(media_type = to_constructable)
-        return false unless validations
-
-        resolved = validations.find(media_type, -> { nil })
-
-        !resolved.nil?
-      end
-
-      def register
-        registrations.to_a.map do |registerable|
-          MediaTypes.register(registerable)
-          registerable
-        end
-      end
-
-      def view(v)
-        to_constructable.view(v)
-      end
-
-      def version(v)
-        to_constructable.version(v)
-      end
-
-      def identifier_format
-        self.media_type_name_for = proc do |type:, view:, version:, suffix:|
-          yield(type: type, view: view, version: version, suffix: suffix)
-        end
-      end
-
-      def identifier
-        to_constructable.to_s
-      end
-
-      def available_validations
-        media_type_combinations.map do |a|
-          _, view, version = a
-          view(view).version(version)
-        end
-      end
-
-      def schema_for(constructable)
-        validations.find(constructable)
-      end
-
-      def assert_sane!
-        return if media_type_validations.scheme.asserted_sane?
-
-        media_type_validations.run_fixture_validations(symbol_keys?)
-      end
-
-      private
-
-      def use_name(name)
-        if media_type_name_for.nil?
-          self.media_type_name_for = proc do |type:, view:, version:, suffix:|
-            resolved_org = nil
-            if defined?(organisation)
-              resolved_org = organisation
-            else
-              resolved_org = MediaTypes.get_organisation(self)
-
-              if resolved_org.nil?
-              raise OrganisationNotSetError,
-                format('Implement the class method "organisation" in %<klass>s or specify a global organisation using MediaTypes::set_organisation', klass: self)
-              end
-            end
-            raise ArgumentError, 'Unable to create a name for a schema with a nil name.' if type.nil?
-            raise ArgumentError, 'Unable to create a name for a schema with a nil organisation.' if resolved_org.nil?
-
-            result = "application/vnd.#{resolved_org}.#{type}"
-            result += ".v#{version}" unless version.nil?
-            result += ".#{view}" unless view.nil?
-            result += "+#{suffix}" unless suffix.nil?
-            result
-          end
-        end
-        self.media_type_constructable = Constructable.new(self, type: name)
-      end
-
-      def expect_string_keys
-        raise KeyTypeExpectationError, 'Key expectation already set' unless symbol_keys.nil?
-
-        self.symbol_keys = false
-      end
-
-      def expect_symbol_keys
-        raise KeyTypeExpectationError, 'Key expectation already set' unless symbol_keys.nil?
-
-        self.symbol_keys = true
-      end
-
-      def validations(&block)
-        return lookup_validations unless block_given?
-
-        self.media_type_validations = Validations.new(to_constructable, &block)
-
-        self
-      end
-
-      def lookup_validations
-        raise MissingValidationError, "No validations defined for #{name}" if media_type_validations.nil?
-
-        media_type_validations
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'set'
+
+require 'media_types/constructable'
+require 'media_types/validations'
+
+require 'media_types/dsl/errors'
+
+module MediaTypes
+  module Dsl
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        class << self
+          attr_accessor :media_type_name_for, :media_type_combinations, :media_type_validations, :symbol_keys
+
+          private
+
+          attr_accessor :media_type_constructable, :symbol_base, :media_type_registrar
+        end
+        base.media_type_combinations = Set.new
+      end
+    end
+
+    module ClassMethods
+      def to_constructable
+        raise UninitializedConstructable if media_type_constructable.nil?
+
+        media_type_constructable.dup.tap do |constructable|
+          constructable.__setobj__(self)
+        end
+      end
+
+      def symbol_keys?
+        if symbol_keys.nil?
+          MediaTypes.get_key_expectation(self)
+        else
+          symbol_keys
+        end
+      end
+
+      def string_keys?
+        !symbol_keys?
+      end
+
+      def valid?(output, **opts)
+        to_constructable.valid?(output, **opts)
+      end
+
+      def valid_unsafe?(output, media_type = to_constructable, **opts)
+        opts[:expected_key_type] = string_keys? ? String : Symbol
+        validations.find(media_type).valid?(output, backtrace: ['.'], **opts)
+      end
+
+      def validate!(output, **opts)
+        assert_sane!
+        to_constructable.validate!(output, **opts)
+      end
+
+      def validate_unsafe!(output, media_type = to_constructable, **opts)
+        opts[:expected_key_type] = string_keys? ? String : Symbol
+        validations.find(media_type).validate(output, backtrace: ['.'], **opts)
+      end
+
+      def validatable?(media_type = to_constructable)
+        return false unless validations
+
+        resolved = validations.find(media_type, -> { nil })
+
+        !resolved.nil?
+      end
+
+      def register
+        registrations.to_a.map do |registerable|
+          MediaTypes.register(registerable)
+          registerable
+        end
+      end
+
+      def view(v)
+        to_constructable.view(v)
+      end
+
+      def version(v)
+        to_constructable.version(v)
+      end
+
+      def identifier_format
+        self.media_type_name_for = proc do |type:, view:, version:, suffix:|
+          yield(type: type, view: view, version: version, suffix: suffix)
+        end
+      end
+
+      def identifier
+        to_constructable.to_s
+      end
+
+      def available_validations
+        media_type_combinations.map do |a|
+          _, view, version = a
+          view(view).version(version)
+        end
+      end
+
+      def schema_for(constructable)
+        validations.find(constructable)
+      end
+
+      def assert_sane!
+        return if media_type_validations.scheme.asserted_sane?
+
+        media_type_validations.run_fixture_validations(symbol_keys?)
+      end
+
+      private
+
+      def use_name(name)
+        if media_type_name_for.nil?
+          self.media_type_name_for = proc do |type:, view:, version:, suffix:|
+            resolved_org = nil
+            if defined?(organisation)
+              resolved_org = organisation
+            else
+              resolved_org = MediaTypes.get_organisation(self)
+
+              if resolved_org.nil?
+              raise OrganisationNotSetError,
+                format('Implement the class method "organisation" in %<klass>s or specify a global organisation using MediaTypes::set_organisation', klass: self)
+              end
+            end
+            raise ArgumentError, 'Unable to create a name for a schema with a nil name.' if type.nil?
+            raise ArgumentError, 'Unable to create a name for a schema with a nil organisation.' if resolved_org.nil?
+
+            result = "application/vnd.#{resolved_org}.#{type}"
+            result += ".v#{version}" unless version.nil?
+            result += ".#{view}" unless view.nil?
+            result += "+#{suffix}" unless suffix.nil?
+            result
+          end
+        end
+        self.media_type_constructable = Constructable.new(self, type: name)
+      end
+
+      def expect_string_keys
+        raise KeyTypeExpectationError, 'Key expectation already set' unless symbol_keys.nil?
+
+        self.symbol_keys = false
+      end
+
+      def expect_symbol_keys
+        raise KeyTypeExpectationError, 'Key expectation already set' unless symbol_keys.nil?
+
+        self.symbol_keys = true
+      end
+
+      def validations(&block)
+        return lookup_validations unless block_given?
+
+        self.media_type_validations = Validations.new(to_constructable, &block)
+
+        self
+      end
+
+      def lookup_validations
+        raise MissingValidationError, "No validations defined for #{name}" if media_type_validations.nil?
+
+        media_type_validations
+      end
+    end
+  end
+end

data/lib/media_types/errors.rb

@@ -1,19 +1,25 @@
-# frozen_string_literal: true
-
-module MediaTypes
-  module Errors
-    # Raised when trying to set a module key expectation twice
-    class KeyExpectationSetError < StandardError
-      def initialize(mod:)
-        super(format('%<mod>s already has a key expectation set', mod: mod.name))
-      end
-    end
-
-    # Raised when trying to set a module key expectation while default expectation already used
-    class KeyExpectationUsedError < StandardError
-      def initialize(mod:)
-        super(format('Unable to change key type expectation for %<mod>s since its current expectation is already used', mod: mod.name))
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module MediaTypes
+  module Errors
+    # Raised when trying to set a module key expectation twice
+    class KeyExpectationSetError < StandardError
+      def initialize(mod:)
+        super(format('%<mod>s already has a key expectation set', mod: mod.name))
+      end
+    end
+
+    # Raised when trying to set a module key expectation while default expectation already used
+    class KeyExpectationUsedError < StandardError
+      def initialize(mod:)
+        super(format('Unable to change key type expectation for %<mod>s since its current expectation is already used', mod: mod.name))
+      end
+    end
+
+    class CollectionDefinitionNotFound < StandardError
+      def initialize(current, target)
+        super(format('Unable to use %<target>s as a collection inside %<current>s, no such schema has been defined.', current: current, target: target))
+      end
+    end
+  end
+end

data/lib/media_types/formatter.rb

@@ -1,56 +1,56 @@
-# frozen_string_literal: true
-
-require 'media_types/object'
-
-module MediaTypes
-  class Formatter < DelegateClass(Hash)
-
-    class << self
-      def call(*args, **options)
-        new(*args, **options).call
-      end
-    end
-
-    def call
-      filtered_arguments = arguments
-      return template if MediaTypes::Object.new(filtered_arguments).empty?
-
-      format(rework_template(filtered_arguments), filtered_arguments)
-    end
-
-    private
-
-    def template
-      fetch(:format)
-    end
-
-    def rework_template(filtered_arguments)
-      filtered_arguments.reduce(template) do |reworked, (key, value)|
-        next reworked if MediaTypes::Object.new(value).present?
-
-        reworked.gsub(/[.+](%<[A-z]+>)/) do |match|
-          partial_format = "%<#{key}>"
-          match.include?(partial_format) ? partial_format : match
-        end
-      end
-    end
-
-    def format_view(view)
-      MediaTypes::Object.new(view).present? && ".#{view}" || ''
-    end
-
-    def arguments
-      # noinspection RubyBlockToMethodReference
-      {
-        version: self[:version],
-        suffix: self[:suffix],
-        type: self[:type],
-        view: self[:view]
-      }.select { |argument,| argument_present?(argument) }
-    end
-
-    def argument_present?(argument)
-      template.include?("%<#{argument}>")
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'media_types/object'
+
+module MediaTypes
+  class Formatter < DelegateClass(Hash)
+
+    class << self
+      def call(*args, **options)
+        new(*args, **options).call
+      end
+    end
+
+    def call
+      filtered_arguments = arguments
+      return template if MediaTypes::Object.new(filtered_arguments).empty?
+
+      format(rework_template(filtered_arguments), filtered_arguments)
+    end
+
+    private
+
+    def template
+      fetch(:format)
+    end
+
+    def rework_template(filtered_arguments)
+      filtered_arguments.reduce(template) do |reworked, (key, value)|
+        next reworked if MediaTypes::Object.new(value).present?
+
+        reworked.gsub(/[.+](%<[A-z]+>)/) do |match|
+          partial_format = "%<#{key}>"
+          match.include?(partial_format) ? partial_format : match
+        end
+      end
+    end
+
+    def format_view(view)
+      MediaTypes::Object.new(view).present? && ".#{view}" || ''
+    end
+
+    def arguments
+      # noinspection RubyBlockToMethodReference
+      {
+        version: self[:version],
+        suffix: self[:suffix],
+        type: self[:type],
+        view: self[:view]
+      }.select { |argument,| argument_present?(argument) }
+    end
+
+    def argument_present?(argument)
+      template.include?("%<#{argument}>")
+    end
+  end
+end

data/lib/media_types/hash.rb

@@ -1,21 +1,21 @@
-module MediaTypes
-  class Hash < SimpleDelegator
-    def class
-      __getobj__.class
-    end
-
-    def ===(other)
-      __getobj__ === other # rubocop:disable Style/CaseEquality
-    end
-
-    def slice(*keep_keys)
-      if __getobj__.respond_to?(:slice)
-        return __getobj__.slice(*keep_keys)
-      end
-
-      h = {}
-      keep_keys.each { |key| h[key] = fetch(key) if key?(key) }
-      h
-    end
-  end
-end
+module MediaTypes
+  class Hash < SimpleDelegator
+    def class
+      __getobj__.class
+    end
+
+    def ===(other)
+      __getobj__ === other # rubocop:disable Style/CaseEquality
+    end
+
+    def slice(*keep_keys)
+      if __getobj__.respond_to?(:slice)
+        return __getobj__.slice(*keep_keys)
+      end
+
+      h = {}
+      keep_keys.each { |key| h[key] = fetch(key) if key?(key) }
+      h
+    end
+  end
+end

data/lib/media_types/object.rb

@@ -1,35 +1,35 @@
-# frozen_string_literal: true
-
-module MediaTypes
-  class Object < SimpleDelegator
-    def class
-      __getobj__.class
-    end
-
-    def ===(other)
-      __getobj__ === other # rubocop:disable Style/CaseEquality
-    end
-
-    def blank?
-      if __getobj__.respond_to?(:blank?)
-        return __getobj__.blank?
-      end
-
-      if __getobj__.respond_to?(:empty?)
-        return __getobj__.empty?
-      end
-
-      if __getobj__.respond_to?(:length)
-        return __getobj__.length.zero?
-      end
-
-      !__getobj__
-    end
-
-    alias empty? blank?
-
-    def present?
-      !blank?
-    end
-  end
-end
+# frozen_string_literal: true
+
+module MediaTypes
+  class Object < SimpleDelegator
+    def class
+      __getobj__.class
+    end
+
+    def ===(other)
+      __getobj__ === other # rubocop:disable Style/CaseEquality
+    end
+
+    def blank?
+      if __getobj__.respond_to?(:blank?)
+        return __getobj__.blank?
+      end
+
+      if __getobj__.respond_to?(:empty?)
+        return __getobj__.empty?
+      end
+
+      if __getobj__.respond_to?(:length)
+        return __getobj__.length.zero?
+      end
+
+      !__getobj__
+    end
+
+    alias empty? blank?
+
+    def present?
+      !blank?
+    end
+  end
+end

data/lib/media_types/scheme/allow_nil.rb

@@ -1,30 +1,30 @@
-# frozen_string_literal: true
-
-require 'delegate'
-require 'media_types/scheme/any_of'
-
-module MediaTypes
-  class Scheme
-    class << self
-      # noinspection RubyClassMethodNamingConvention
-      ##
-      # Allows the wrapped +klazz+ to be nil
-      #
-      # @param [Class] klazz the class that +it+ must be the if +it+ is not NilClass
-      # @return [CaseEqualityWithList]
-      def AllowNil(klazz) # rubocop:disable Naming/MethodName
-        AnyOf(NilClass, klazz)
-      end
-    end
-
-    # noinspection RubyInstanceMethodNamingConvention
-    ##
-    # Allows the wrapped +klazz+ to be nil
-    #
-    # @param [Class] klazz the class that +it+ must be the if +it+ is not NilClass
-    # @return [CaseEqualityWithList]
-    def AllowNil(klazz) # rubocop:disable Naming/MethodName
-      self.class.AllowNil(klazz)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'delegate'
+require 'media_types/scheme/any_of'
+
+module MediaTypes
+  class Scheme
+    class << self
+      # noinspection RubyClassMethodNamingConvention
+      ##
+      # Allows the wrapped +klazz+ to be nil
+      #
+      # @param [Class] klazz the class that +it+ must be the if +it+ is not NilClass
+      # @return [CaseEqualityWithList]
+      def AllowNil(klazz) # rubocop:disable Naming/MethodName
+        AnyOf(NilClass, klazz)
+      end
+    end
+
+    # noinspection RubyInstanceMethodNamingConvention
+    ##
+    # Allows the wrapped +klazz+ to be nil
+    #
+    # @param [Class] klazz the class that +it+ must be the if +it+ is not NilClass
+    # @return [CaseEqualityWithList]
+    def AllowNil(klazz) # rubocop:disable Naming/MethodName
+      self.class.AllowNil(klazz)
+    end
+  end
+end