media_types 2.0.1 → 2.1.0

data/lib/media_types/scheme/errors.rb

@@ -2,6 +2,7 @@
 
 module MediaTypes
   class Scheme
+    class ConflictingTypeDefinitionError < ArgumentError; end
 
     # Base class for all validations errors
     class ValidationError < ArgumentError; end
@@ -12,6 +13,38 @@ module MediaTypes
     # Raised when trying to register a key twice
     class DuplicateKeyError < ArgumentError; end
 
+    class DuplicateSymbolKeyError < DuplicateKeyError
+      MESSAGE_TEMPLATE = '%<rule_type>s rule with key :%<key>s has already been defined. Please remove one of the two.'
+
+      def initialize(rule_type, key)
+        super(format(MESSAGE_TEMPLATE, rule_type: rule_type, key: key))
+      end
+    end
+
+    class DuplicateStringKeyError < DuplicateKeyError
+      MESSAGE_TEMPLATE = '%<rule_type>s rule with key %<key>s has already been defined. Please remove one of the two.'
+
+      def initialize(rule_type, key)
+        super(format(MESSAGE_TEMPLATE, { rule_type: rule_type, key: key }))
+      end
+    end
+
+    class StringOverwritingSymbolError < DuplicateKeyError
+      MESSAGE_TEMPLATE = 'Trying to add %<rule_type>s rule String key %<key>s while a Symbol with the same name already exists. Please remove one of the two.'
+
+      def initialize(rule_type, key)
+        super(format(MESSAGE_TEMPLATE, { rule_type: rule_type, key: key }))
+      end
+    end
+
+    class SymbolOverwritingStringError < DuplicateKeyError
+      MESSAGE_TEMPLATE = 'Trying to add %<rule_type>s rule with Symbol key :%<key>s while a String key with the same name already exists. Please remove one of the two.'
+
+      def initialize(rule_type, key)
+        super(format(MESSAGE_TEMPLATE, { rule_type: rule_type, key: key }))
+      end
+    end
+
     # Raised when it did not expect more data, but there was more left
     class StrictValidationError < ValidationError; end
 
@@ -23,5 +56,32 @@ module MediaTypes
 
     # Raised when it expected more data but there wasn't any left
     class ExhaustedOutputError < ValidationError; end
+
+    # Raised when trying to override a non default rule scheme in the Rules Hash's default object method
+    class OverwritingRuleError < ArgumentError; end
+
+    class DuplicateAnyRuleError < OverwritingRuleError
+      def message
+        "An 'any' rule has already been defined. Please remove one of the two."
+      end
+    end
+
+    class DuplicateNotStrictRuleError < OverwritingRuleError
+      def message
+        "The 'not_strict' rule has already been defined. Please remove one of the two."
+      end
+    end
+
+    class NotStrictOverwritingAnyError < OverwritingRuleError
+      def message
+        "An 'any' rule has already been defined. Setting 'not_strict' will override that rule. Please remove one of the two."
+      end
+    end
+
+    class AnyOverwritingNotStrictError < OverwritingRuleError
+      def message
+        "The 'not_strict' rule has already been defined. Setting 'any' will override that rule. Please remove one of the two."
+      end
+    end
   end
 end

data/lib/media_types/scheme/links.rb

@@ -31,6 +31,21 @@ module MediaTypes
         "[Scheme::Links #{links.keys}]"
       end
 
+      def run_fixture_validations(expect_symbol_keys, backtrace = [])
+        fixture_errors = @links.flat_map {|key, rule|
+          if rule.is_a?(Scheme)
+            begin
+              rule.run_fixture_validations(expect_symbol_keys, backtrace.dup.append(key))
+              nil
+            rescue AssertionError => e
+              e.fixture_errors
+            end
+          end
+        }.compact
+
+        raise AssertionError.new(fixture_errors) unless fixture_errors.empty?
+      end
+
       private
 
       attr_accessor :links

data/lib/media_types/scheme/output_type_guard.rb

@@ -18,8 +18,6 @@ module MediaTypes
       end
 
       def call
-        #puts @rules
-        #puts "input: <#{output}>, type: <#{expected_type.name}>"
         return unless expected_type && !(expected_type === output) # rubocop:disable Style/CaseEquality
         raise_type_error!(type: output.class, backtrace: options.backtrace)
       end
@@ -30,7 +28,7 @@ module MediaTypes
 
       def raise_type_error!(type:, backtrace:)
         raise OutputTypeMismatch, format(
-          'Expected a %<expected>s, got a %<actual>s at %<backtrace>s',
+          'Expected %<expected>s, got %<actual>s at %<backtrace>s',
           expected: expected_type,
           actual: type,
           backtrace: backtrace.join('->')

data/lib/media_types/scheme/rules.rb

@@ -14,6 +14,7 @@ module MediaTypes
         self.allow_empty = allow_empty
         self.expected_type = expected_type
         self.optional_keys = []
+        self.original_key_type = {}
 
         self.default = MissingValidation.new
       end
@@ -27,13 +28,44 @@ module MediaTypes
       end
 
       def add(key, val, optional: false)
+        validate_input(key, val)
+
         normalized_key = normalize_key(key)
         __getobj__[normalized_key] = val
         optional_keys << normalized_key if optional
+        original_key_type[normalized_key] = key.class
 
         self
       end
 
+      def validate_input(key, val)
+        raise KeyTypeError, "Unexpected key type #{key.class.name}, please use either a symbol or string." unless key.is_a?(String) || key.is_a?(Symbol)
+
+        validate_key_name(key, val)
+      end
+
+      def validate_key_name(key, val)
+        return unless has_key?(key)
+
+        if key.is_a?(Symbol)
+          duplicate_symbol_key_name(key, val)
+        else
+          duplicate_string_key_name(key, val)
+        end
+      end
+
+      def duplicate_symbol_key_name(key, val)
+        raise DuplicateSymbolKeyError.new(val.class.name.split('::').last, key) if get_original_key_type(key) == Symbol
+
+        raise SymbolOverwritingStringError.new(val.class.name.split('::').last, key)
+      end
+
+      def duplicate_string_key_name(key, val)
+        raise DuplicateStringKeyError.new(val.class.name.split('::').last, key) if get_original_key_type(key) == String
+
+        raise StringOverwritingSymbolError.new(val.class.name.split('::').last, key)
+      end
+
       def []=(key, val)
         add(key, val, optional: false)
       end
@@ -105,17 +137,36 @@ module MediaTypes
         ].join(': ')
       end
 
+      def has_key?(key)
+        __getobj__.key?(normalize_key(key))
+      end
+
+      def get_original_key_type(key)
+        raise format('Key %<key>s does not exist', key: key) unless has_key?(key)
+
+        original_key_type[normalize_key(key)]
+      end
+
+      def default=(input_default)
+        unless default.nil?
+          raise DuplicateAnyRuleError if !(default.is_a?(MissingValidation) || default.is_a?(NotStrict)) && !(input_default.is_a?(MissingValidation) || input_default.is_a?(NotStrict))
+          raise DuplicateNotStrictRuleError if default.is_a?(NotStrict) && input_default.is_a?(NotStrict)
+          raise NotStrictOverwritingAnyError if !(default.is_a?(MissingValidation) || default.is_a?(NotStrict)) && input_default.is_a?(NotStrict)
+          raise AnyOverwritingNotStrictError if default.is_a?(NotStrict) && !(input_default.is_a?(MissingValidation) || input_default.is_a?(NotStrict))
+        end
+        super(input_default)
+      end
+
       alias get []
       alias remove delete
 
       private
 
-      attr_accessor :allow_empty, :optional_keys
+      attr_accessor :allow_empty, :optional_keys, :original_key_type
       attr_writer :expected_type
 
       def normalize_key(key)
-        # Because default ruby hashes don't treat symbols and string equal we can't normalize them here.
-        key
+        String(key).to_sym
       end
     end
   end

data/lib/media_types/scheme/rules_exhausted_guard.rb

@@ -36,6 +36,16 @@ module MediaTypes
 
       def iterate(mark)
         OutputIteratorWithPredicate.call(output, options, rules: rules) do |key, value, options:, context:|
+          unless key.class == options.expected_key_type || rules.get(key).class == NotStrict
+            raise ValidationError,
+                format(
+                  'Expected key as %<type>s, got %<actual>s at [%<backtrace>s]',
+                  type: options.expected_key_type,
+                  actual: key.class,
+                  backtrace: options.trace(key).backtrace.join('->')
+                )
+          end
+
           mark.call(key)
 
           rules.get(key).validate!(

data/lib/media_types/scheme/validation_options.rb

@@ -3,13 +3,14 @@
 module MediaTypes
   class Scheme
     class ValidationOptions
-      attr_accessor :exhaustive, :strict, :backtrace, :context
+      attr_accessor :exhaustive, :strict, :backtrace, :context, :expected_key_type
 
-      def initialize(context = {}, exhaustive: true, strict: true, backtrace: [])
+      def initialize(context = {}, exhaustive: true, strict: true, backtrace: [], expected_key_type:)
         self.exhaustive = exhaustive
         self.strict = strict
         self.backtrace = backtrace
         self.context = context
+        self.expected_key_type = expected_key_type
       end
 
       def inspect
@@ -27,7 +28,7 @@ module MediaTypes
       end
 
       def with_backtrace(backtrace)
-        ValidationOptions.new(context, exhaustive: exhaustive, strict: strict, backtrace: backtrace)
+        ValidationOptions.new(context, exhaustive: exhaustive, strict: strict, backtrace: backtrace, expected_key_type: expected_key_type)
       end
 
       def trace(*traces)
@@ -35,7 +36,7 @@ module MediaTypes
       end
 
       def exhaustive!
-        ValidationOptions.new(context, exhaustive: true, strict: strict, backtrace: backtrace)
+        ValidationOptions.new(context, exhaustive: true, strict: strict, backtrace: backtrace, expected_key_type: expected_key_type)
       end
     end
   end

data/lib/media_types/testing/assertions.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MediaTypes
+  module Testing
+    module Assertions
+      def assert_media_type_format(media_type, output, **opts)
+        return pass unless media_type.validatable?
+
+        assert media_type.validate!(output, **opts)
+      end
+
+      def assert_mediatype(mediatype)
+        mediatype.assert_sane!
+        assert mediatype.media_type_validations.scheme.asserted_sane?
+      rescue MediaTypes::AssertionError => e
+        flunk e.message
+      end
+    end
+  end
+end

data/lib/media_types/validations.rb

@@ -12,6 +12,8 @@ module MediaTypes
   #
   class Validations
 
+    attr_reader :scheme
+
     ##
     # Creates a new stack of validations
     #
@@ -44,12 +46,12 @@ module MediaTypes
       end
     end
 
-    def method_missing(method_name, *arguments, &block)
+    def method_missing(method_name, *arguments, **kwargs, &block)
       if scheme.respond_to?(method_name)
         media_type.__getobj__.media_type_combinations ||= Set.new
         media_type.__getobj__.media_type_combinations.add(media_type.as_key)
-      
-        return scheme.send(method_name, *arguments, &block)
+
+        return scheme.send(method_name, *arguments, **kwargs, &block)
       end
 
       super
@@ -61,7 +63,8 @@ module MediaTypes
 
     private
 
-    attr_accessor :media_type, :registry, :scheme
+    attr_accessor :media_type, :registry
+    attr_writer :scheme
 
     ##
     # Switches the inner block to a specific version

data/lib/media_types/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MediaTypes
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

data/media_types.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'bundler', '>= 1.16.1'
+  spec.add_development_dependency 'bundler', '>= 2'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'oj'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: media_types
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 - Max Maton
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.1
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.1
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +125,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -132,9 +133,10 @@ files:
 - lib/media_types.rb
 - lib/media_types/constructable.rb
 - lib/media_types/dsl.rb
+- lib/media_types/dsl/errors.rb
+- lib/media_types/errors.rb
 - lib/media_types/formatter.rb
 - lib/media_types/hash.rb
-- lib/media_types/minitest/assert_media_type_format.rb
 - lib/media_types/object.rb
 - lib/media_types/scheme.rb
 - lib/media_types/scheme/allow_nil.rb
@@ -152,6 +154,7 @@ files:
 - lib/media_types/scheme/rules.rb
 - lib/media_types/scheme/rules_exhausted_guard.rb
 - lib/media_types/scheme/validation_options.rb
+- lib/media_types/testing/assertions.rb
 - lib/media_types/validations.rb
 - lib/media_types/version.rb
 - lib/media_types/views.rb
@@ -159,7 +162,7 @@ files:
 homepage: https://github.com/SleeplessByte/media-types-ruby
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,8 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Library to create media type definitions, schemes and validations
 test_files: []

data/lib/media_types/minitest/assert_media_type_format.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module MediaTypes
-  module Assertions
-    def assert_media_type_format(media_type, output, **opts)
-      return pass unless media_type.validatable?
-      assert media_type.validate!(output, **opts)
-    end
-  end
-end