media_types 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54061285d1504ab09d4fc7299bf242ad4e0a7529
-  data.tar.gz: d1cff5bf120ff2f5cd570887f3e351117466e54e
+  metadata.gz: 60e6f4948af77b72e970849c287e89e9f1666470
+  data.tar.gz: 5f2e3f281075c813da57bfe85e391559b17fc02c
 SHA512:
-  metadata.gz: 283abdbba4639fbabb39223ed943c495289a2a2f607055e1c00d1b789d6612d604d3de5b7bf4d4e5d644acd9e4d46316e2e92319354f71278059f0c42697b5eb
-  data.tar.gz: 2a57915b68ebab50f5820ee472499aea29d9bbeaa17f5cab416419c8ab3acba7f094c1934c50e2458b9c3728f71c5c6f845de6ec6e6e55bac666143ff48030dd
+  metadata.gz: 22592d00055a373b235c543968cf88631becab9b7d97ee60c371661af5eca417c7a5e120f8f7fc2a7a0bea5fb21535b0fc94d89691a55f81dc229e5fa548b54e
+  data.tar.gz: cd4799ba03f74d0d10aa8c6de20dafb1cc836c85ca609ee273d34fdbea0266f174adbe29a6570099659d52ff551d8cd0b6bcf132fbc6f75a0e08984d626f94d9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.5.1
+
+- Fix merging optional attributes
+- Change `#inspect` to look like a tree
+
 # 0.5.0
 
 - Change internal representation of key to symbol

data/Gemfile.lock

@@ -1,44 +1,44 @@
-PATH
-  remote: .
-  specs:
-    media_types (0.5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    awesome_print (1.8.0)
-    builder (3.2.3)
-    docile (1.3.1)
-    json (2.1.0)
-    minitest (5.11.3)
-    minitest-ci (3.4.0)
-      minitest (>= 5.0.6)
-    minitest-reporters (1.3.4)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    rake (10.5.0)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-
-PLATFORMS
-  x64-mingw32
-
-DEPENDENCIES
-  awesome_print
-  bundler (~> 1.16)
-  media_types!
-  minitest (~> 5.0)
-  minitest-ci
-  minitest-reporters
-  rake (~> 10.0)
-  simplecov
-
-BUNDLED WITH
-   1.16.4
+PATH
+  remote: .
+  specs:
+    media_types (0.5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    awesome_print (1.8.0)
+    builder (3.2.3)
+    docile (1.3.1)
+    json (2.1.0)
+    minitest (5.11.3)
+    minitest-ci (3.4.0)
+      minitest (>= 5.0.6)
+    minitest-reporters (1.3.4)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (10.5.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.16)
+  media_types!
+  minitest (~> 5.0)
+  minitest-ci
+  minitest-reporters
+  rake (~> 10.0)
+  simplecov
+
+BUNDLED WITH
+   1.16.4

data/README.md

@@ -37,6 +37,10 @@ You can define media types by inheriting from this base type, or create your own
 require 'media_types'
 
 class Venue < MediaTypes::Base
+  def self.base_format
+    'application/vnd.mydomain.%<type>s.v%<version>.s%<view>s+%<suffix>s'
+  end
+  
   media_type 'venue', defaults: { suffix: :json, version: 2 }
 
   validations do
@@ -85,10 +89,6 @@ class Venue < MediaTypes::Base
     suffix :json
     suffix :xml
   end
-  
-  def self.base_format
-    'application/vnd.mydomain.%<type>s.v%<version>.s%<view>s+%<suffix>s'
-  end
 end
 ```
 

data/lib/media_types/scheme/allow_nil.rb

@@ -4,6 +4,18 @@ require 'delegate'
 
 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
@@ -11,7 +23,7 @@ module MediaTypes
     # @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)
+      self.class.AllowNil(klazz)
     end
   end
 end

data/lib/media_types/scheme/any_of.rb

@@ -16,6 +16,18 @@ module MediaTypes
       end
     end
 
+    class << self
+      # noinspection RubyClassMethodNamingConvention
+      ##
+      # Allows +it+ to be any of the wrapped +klazzes+
+      #
+      # @param [Array<Class>] klazzes the classes that are valid for +it+
+      # @return [CaseEqualityWithList]
+      def AnyOf(*klazzes) # rubocop:disable Naming/MethodName
+        CaseEqualityWithList.new(klazzes)
+      end
+    end
+
     # noinspection RubyInstanceMethodNamingConvention
     ##
     # Allows +it+ to be any of the wrapped +klazzes+
@@ -23,7 +35,7 @@ module MediaTypes
     # @param [Array<Class>] klazzes the classes that are valid for +it+
     # @return [CaseEqualityWithList]
     def AnyOf(*klazzes) # rubocop:disable Naming/MethodName
-      CaseEqualityWithList.new(klazzes)
+      self.class.AnyOf(*klazzes)
     end
   end
 end

data/lib/media_types/scheme/attribute.rb

@@ -14,17 +14,12 @@ module MediaTypes
       # @param [TrueClass, FalseClass] allow_nil if true, nil? is allowed
       #
       def initialize(type, allow_nil: false)
-        self.type = type
-        self.allow_nil = allow_nil
+        self.type = allow_nil ? AllowNil(type) : type
 
         freeze
       end
 
       def validate!(output, options, **_opts)
-        if output.nil?
-          return true if allow_nil
-        end
-
         return true if type === output # rubocop:disable Style/CaseEquality
         raise ValidationError,
               format(
@@ -36,7 +31,7 @@ module MediaTypes
       end
 
       def inspect
-        "[Scheme::Attribute type=#{type} nil=#{allow_nil}]"
+        "[Scheme::Attribute of #{type.inspect}]"
       end
 
       private

data/lib/media_types/scheme/missing_validation.rb

@@ -12,13 +12,20 @@ module MediaTypes
 
       def raise_strict!(key:, backtrace:, strict_keys:)
         raise StrictValidationError, format(
-          'Unknown key %<key>s in output at [%<backtrace>s]. Expected one of: %<strict_keys>s',
+          "Unknown key %<key>s in data.\n" \
+          "\tFound at: %<backtrace>s\n" \
+          "\tExpected:\n\n" \
+          '%<strict_keys>s',
           key: key.inspect,
           backtrace: backtrace.join('->'),
-          strict_keys: strict_keys
+          strict_keys: strict_keys.inspect(1)
         )
       end
 
+      def inspect
+        '((raise when strict))'
+      end
+
     end
   end
 end

data/lib/media_types/scheme/not_strict.rb

@@ -8,7 +8,7 @@ module MediaTypes
       end
 
       def inspect
-        '[Scheme::NotStrict]'
+        '((noop: not strict))'
       end
     end
   end

data/lib/media_types/scheme/rules.rb

@@ -45,6 +45,14 @@ module MediaTypes
         self
       end
 
+      ##
+      # Returns the keys that are not options
+      #
+      # @see #add
+      # #see #merge
+      #
+      # @return [Array<Symbol>] required keys
+      #
       def required
         clone.tap do |cloned|
           optional_keys.each do |key|
@@ -59,13 +67,38 @@ module MediaTypes
         end
       end
 
+      ##
+      # Merges another set of rules into a clone of this one
+      #
+      # @param [Rules, ::Hash] the other rules
+      # @return [Rules] a clone
+      #
       def merge(rules)
-        __getobj__.merge!(rules)
-        self
+        clone.instance_exec do
+          __setobj__(__getobj__.merge(rules))
+          if rules.respond_to?(:optional_keys, true)
+            optional_keys.push(*rules.send(:optional_keys))
+          end
+
+          self
+        end
+      end
+
+      def inspect(indent = 0)
+        prefix = '  ' * indent
+        [
+          "#{prefix}[Rules n=#{keys.length} optional=#{optional_keys.length}]",
+          "#{prefix}  #{inspect_format_attribute(indent, '*', default)}",
+          *keys.map { |key| "#{prefix}  #{inspect_format_attribute(indent, key)}" },
+          "#{prefix}[/Rules]"
+        ].join("\n")
       end
 
-      def inspect
-        "[Scheme::Rules n=#{keys.length} default=#{default}]"
+      def inspect_format_attribute(indent, key, value = self[key])
+        [
+          [key.to_s, optional_keys.include?(key) && '(optional)' || nil].compact.join(' '),
+          value.is_a?(Scheme) || value.is_a?(Rules) ? "\n#{value.inspect(indent + 2)}" : value.inspect
+        ].join(': ')
       end
 
       alias get []

data/lib/media_types/scheme.rb

@@ -351,8 +351,13 @@ module MediaTypes
       end.link(*args, **opts, &block)
     end
 
-    def inspect
-      "[Scheme]#{rules}[/Scheme]"
+    def inspect(indentation = 0)
+      tabs = '  ' * indentation
+      [
+        "#{tabs}[Scheme]",
+        rules.inspect(indentation + 1),
+        "#{tabs}[/Scheme]"
+      ].join("\n")
     end
 
     private

data/lib/media_types/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: media_types
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld