RubyGems - media_types-serialization - Versions diffs - 1.3.9 → 2.0.0 - Mend

media_types-serialization 1.3.9 → 2.0.0

Files changed (42) hide show

checksums.yaml +4 -4
data/.github/workflows/ci.yml +32 -32
data/.github/workflows/publish-bookworm.yml +33 -0
data/.github/workflows/publish-sid.yml +33 -0
data/.gitignore +22 -12
data/.idea/.rakeTasks +7 -7
data/.idea/dictionaries/Derk_Jan.xml +6 -6
data/.idea/encodings.xml +3 -3
data/.idea/inspectionProfiles/Project_Default.xml +5 -5
data/.idea/media_types-serialization.iml +76 -76
data/.idea/misc.xml +6 -6
data/.idea/modules.xml +7 -7
data/.idea/runConfigurations/test.xml +19 -19
data/.idea/vcs.xml +5 -5
data/CHANGELOG.md +190 -178
data/CODE_OF_CONDUCT.md +74 -74
data/Gemfile +4 -4
data/LICENSE.txt +21 -21
data/README.md +1048 -1035
data/Rakefile +10 -10
data/bin/console +14 -14
data/bin/setup +8 -8
data/lib/media_types/problem.rb +67 -67
data/lib/media_types/serialization/base.rb +269 -216
data/lib/media_types/serialization/error.rb +193 -193
data/lib/media_types/serialization/fake_validator.rb +53 -53
data/lib/media_types/serialization/serialization_dsl.rb +135 -117
data/lib/media_types/serialization/serialization_registration.rb +245 -245
data/lib/media_types/serialization/serializers/api_viewer.rb +383 -136
data/lib/media_types/serialization/serializers/common_css.rb +212 -168
data/lib/media_types/serialization/serializers/endpoint_description_serializer.rb +80 -80
data/lib/media_types/serialization/serializers/fallback_not_acceptable_serializer.rb +85 -85
data/lib/media_types/serialization/serializers/fallback_unsupported_media_type_serializer.rb +58 -58
data/lib/media_types/serialization/serializers/input_validation_error_serializer.rb +93 -93
data/lib/media_types/serialization/serializers/problem_serializer.rb +111 -104
data/lib/media_types/serialization/utils/accept_header.rb +77 -77
data/lib/media_types/serialization/utils/accept_language_header.rb +82 -82
data/lib/media_types/serialization/version.rb +7 -7
data/lib/media_types/serialization.rb +682 -671
data/media_types-serialization.gemspec +48 -48
metadata +17 -16
data/Gemfile.lock +0 -137

data/lib/media_types/serialization/serializers/problem_serializer.rb CHANGED Viewed

@@ -1,104 +1,111 @@
-# frozen_string_literal: true
-require 'erb'
-require 'media_types/serialization/base'
-require 'media_types/serialization/utils/accept_language_header'
-module MediaTypes
-  module Serialization
-    module Serializers
-      class ProblemSerializer < MediaTypes::Serialization::Base
-        unvalidated 'application/vnd.delftsolutions.problem'
-        disable_wildcards
-        output do |problem, _, context|
-          raise 'No translations defined, add at least one title' unless problem.translations.keys.any?
-          accept_language_header = Utils::AcceptLanguageHeader.new(
-            context.request.get_header(HEADER_ACCEPT_LANGUAGE) || ''
-          )
-          translation_entry = accept_language_header.map do |locale|
-            problem.translations.keys.find do |l|
-              l.start_with? locale.locale
-            end
-          end.compact.first || problem.translations.keys.first
-          translation = problem.translations[translation_entry]
-          title = translation[:title]
-          detail = translation[:detail] || problem.error.message
-          problem.custom_attributes.each do |key, value|
-            attribute key, value
-          end
-          attribute :type, problem.type
-          attribute :title, title unless title.nil?
-          attribute :detail, detail unless detail.nil?
-          attribute :instance, problem.instance unless problem.instance.nil?
-          emit
-        end
-        output_alias 'application/problem+json'
-        output_raw view: :html do |problem, _, context|
-          accept_language_header = Utils::AcceptLanguageHeader.new(
-            context.request.get_header(HEADER_ACCEPT_LANGUAGE) || ''
-          )
-          translation_entry = accept_language_header.map do |locale|
-            problem.translations.keys.find do |l|
-              l.starts_with? locale.locale
-            end
-          end.compact.first || problem.translations.keys.first
-          translation = problem.translations[translation_entry]
-          title = translation[:title]
-          detail = translation[:detail] || problem.error.message
-          detail_lang = translation[:detail].nil? ? 'en' : translation_entry
-          input = OpenStruct.new(
-            title: title,
-            detail: detail,
-            help_url: problem.type,
-            css: CommonCSS.css
-          )
-          template = ERB.new <<-TEMPLATE
-            <html lang="en">
-              <head>
-                <meta content="width=device-width, initial-scale=1" name="viewport">
-                <title>Error - <%= CGI::escapeHTML(title) %></title>
-                <style>
-                  <%= css.split("\n").join("\n      ") %>
-                </style>
-              </head>
-              <body>
-                <header>
-                  <div id="logo"></div>
-                  <h1>Error</h1>
-                </header>
-                <section id="content">
-                  <nav>
-                    <section id="description" lang="#{translation_entry}">
-                      <h2><a href="<%= help_url %>"><%= CGI::escapeHTML(title) %></a></h2>
-                    </section>
-                  </nav>
-                  <main lang="#{detail_lang}">
-                    <p><%= detail %>
-                  </main>
-                </section>
-                <!-- Made with ❤ by: https://delftsolutions.com -->
-              </body>
-            </html>
-          TEMPLATE
-          template.result(input.instance_eval { binding })
-        end
-        enable_wildcards
-        output_alias_optional 'text/html', view: :html
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+require 'erb'
+require 'media_types/serialization/base'
+require 'media_types/serialization/utils/accept_language_header'
+module MediaTypes
+  module Serialization
+    module Serializers
+      class ProblemSerializer < MediaTypes::Serialization::Base
+        unvalidated 'application/vnd.delftsolutions.problem'
+        disable_wildcards
+        output do |problem, _, context|
+          raise 'No translations defined, add at least one title' unless problem.translations.keys.any?
+          accept_language_header = Utils::AcceptLanguageHeader.new(
+            context.request.get_header(HEADER_ACCEPT_LANGUAGE) || ''
+          )
+          translation_entry = accept_language_header.map do |locale|
+            problem.translations.keys.find do |l|
+              l.start_with? locale.locale
+            end
+          end.compact.first || problem.translations.keys.first
+          translation = problem.translations[translation_entry]
+          title = translation[:title]
+          detail = translation[:detail] || problem.error.message
+          problem.custom_attributes.each do |key, value|
+            attribute key, value
+          end
+          hidden do
+            link :type, href: problem.type
+          end
+          attribute :type, problem.type
+          attribute :title, title unless title.nil?
+          attribute :detail, detail unless detail.nil?
+          attribute :instance, problem.instance unless problem.instance.nil?
+          emit
+        end
+        output_alias 'application/problem+json'
+        output_raw view: :html do |problem, _, context|
+          accept_language_header = Utils::AcceptLanguageHeader.new(
+            context.request.get_header(HEADER_ACCEPT_LANGUAGE) || ''
+          )
+          translation_entry = accept_language_header.map do |locale|
+            problem.translations.keys.find do |l|
+              l.starts_with? locale.locale
+            end
+          end.compact.first || problem.translations.keys.first
+          translation = problem.translations[translation_entry]
+          hidden do
+            link :type, href: problem.type
+          end
+          title = translation[:title]
+          detail = translation[:detail] || problem.error.message
+          detail_lang = translation[:detail].nil? ? 'en' : translation_entry
+          input = OpenStruct.new(
+            title: title,
+            detail: detail,
+            help_url: problem.type,
+            css: CommonCSS.css
+          )
+          template = ERB.new <<-TEMPLATE
+            <html lang="en">
+              <head>
+                <meta content="width=device-width, initial-scale=1" name="viewport">
+                <title>Error - <%= CGI::escapeHTML(title) %></title>
+                <style>
+                  <%= css.split("\n").join("\n      ") %>
+                </style>
+              </head>
+              <body>
+                <header>
+                  <div id="logo"></div>
+                  <h1>Error</h1>
+                </header>
+                <section id="content">
+                  <nav>
+                    <section id="description" lang="#{translation_entry}">
+                      <h2><a href="<%= help_url %>"><%= CGI::escapeHTML(title) %></a></h2>
+                    </section>
+                  </nav>
+                  <main lang="#{detail_lang}">
+                    <p><%= detail %>
+                  </main>
+                </section>
+                <!-- Made with ❤ by: https://delftsolutions.com -->
+              </body>
+            </html>
+          TEMPLATE
+          template.result(input.instance_eval { binding })
+        end
+        enable_wildcards
+        output_alias_optional 'text/html', view: :html
+      end
+    end
+  end
+end

data/lib/media_types/serialization/utils/accept_header.rb CHANGED Viewed

@@ -1,77 +1,77 @@
-=begin
-The MIT License (MIT)
-Copyright (c) 2019 Derk-Jan Karrenbeld
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-=end
-require 'media_types/serialization/utils/header_list'
-module MediaTypes
-  module Serialization
-    module Utils
-      class AcceptHeader < DelegateClass(Array)
-        def initialize(value)
-          __setobj__ HeaderList.new(value, entry_klazz: AcceptHeader::Entry)
-        end
-        class Entry
-          def initialize(media_type, index:, parameters:)
-            self.media_type = media_type
-            self.parameters = parameters
-            self.index = index
-            freeze
-          end
-          attr_reader :media_type
-          # noinspection RubyInstanceMethodNamingConvention
-          def q
-            parameters.fetch(:q) { 1.0 }.to_f
-          end
-          def <=>(other)
-            quality = other.q <=> q
-            return quality unless quality.zero?
-            index <=> other.send(:index)
-          end
-          def [](parameter)
-            parameters.fetch(String(parameter).to_sym)
-          end
-          def to_header
-            to_s
-          end
-          def to_s
-            [media_type].concat(parameters.map { |k, v| "#{k}=#{v}" }).compact.reject(&:empty?).join('; ')
-          end
-          private
-          attr_writer :media_type
-          attr_accessor :parameters, :index
-        end
-      end
-    end
-  end
-end
+=begin
+The MIT License (MIT)
+Copyright (c) 2019 Derk-Jan Karrenbeld
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+=end
+require 'media_types/serialization/utils/header_list'
+module MediaTypes
+  module Serialization
+    module Utils
+      class AcceptHeader < DelegateClass(Array)
+        def initialize(value)
+          __setobj__ HeaderList.new(value, entry_klazz: AcceptHeader::Entry)
+        end
+        class Entry
+          def initialize(media_type, index:, parameters:)
+            self.media_type = media_type
+            self.parameters = parameters
+            self.index = index
+            freeze
+          end
+          attr_reader :media_type
+          # noinspection RubyInstanceMethodNamingConvention
+          def q
+            parameters.fetch(:q) { 1.0 }.to_f
+          end
+          def <=>(other)
+            quality = other.q <=> q
+            return quality unless quality.zero?
+            index <=> other.send(:index)
+          end
+          def [](parameter)
+            parameters.fetch(String(parameter).to_sym)
+          end
+          def to_header
+            to_s
+          end
+          def to_s
+            [media_type].concat(parameters.map { |k, v| "#{k}=#{v}" }).compact.reject(&:empty?).join('; ')
+          end
+          private
+          attr_writer :media_type
+          attr_accessor :parameters, :index
+        end
+      end
+    end
+  end
+end

data/lib/media_types/serialization/utils/accept_language_header.rb CHANGED Viewed

@@ -1,82 +1,82 @@
-=begin
-The MIT License (MIT)
-Copyright (c) 2019 Derk-Jan Karrenbeld
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-=end
-require 'media_types/serialization/utils/header_list'
-module MediaTypes
-  module Serialization
-    module Utils
-      class AcceptLanguageHeader < DelegateClass(Array)
-        def initialize(value)
-          __setobj__ HeaderList.new(value, entry_klazz: Entry)
-        end
-        class Entry
-          DELIMITER = '-'
-          attr_reader :locale, :region, :language
-          def initialize(locale, index:, parameters:)
-            self.locale = locale
-            # TODO: support extlang correctly, maybe we don't even need this
-            self.language, self.region = locale.split(DELIMITER)
-            self.parameters = parameters
-            self.index = index
-            freeze
-          end
-          # noinspection RubyInstanceMethodNamingConvention
-          def q
-            parameters.fetch(:q) { 1.0 }.to_f
-          end
-          def <=>(other)
-            quality = other.q <=> q
-            return quality unless quality.zero?
-            index <=> other.send(:index)
-          end
-          def [](parameter)
-            parameters.fetch(String(parameter).to_sym)
-          end
-          def to_header
-            to_s
-          end
-          def to_s
-            [locale].concat(parameters.map { |k, v| "#{k}=#{v}" }).compact.reject(&:empty?).join('; ')
-          end
-          private
-          attr_writer :locale, :region, :language
-          attr_accessor :parameters, :index
-        end
-      end
-    end
-  end
-end
+=begin
+The MIT License (MIT)
+Copyright (c) 2019 Derk-Jan Karrenbeld
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+=end
+require 'media_types/serialization/utils/header_list'
+module MediaTypes
+  module Serialization
+    module Utils
+      class AcceptLanguageHeader < DelegateClass(Array)
+        def initialize(value)
+          __setobj__ HeaderList.new(value, entry_klazz: Entry)
+        end
+        class Entry
+          DELIMITER = '-'
+          attr_reader :locale, :region, :language
+          def initialize(locale, index:, parameters:)
+            self.locale = locale
+            # TODO: support extlang correctly, maybe we don't even need this
+            self.language, self.region = locale.split(DELIMITER)
+            self.parameters = parameters
+            self.index = index
+            freeze
+          end
+          # noinspection RubyInstanceMethodNamingConvention
+          def q
+            parameters.fetch(:q) { 1.0 }.to_f
+          end
+          def <=>(other)
+            quality = other.q <=> q
+            return quality unless quality.zero?
+            index <=> other.send(:index)
+          end
+          def [](parameter)
+            parameters.fetch(String(parameter).to_sym)
+          end
+          def to_header
+            to_s
+          end
+          def to_s
+            [locale].concat(parameters.map { |k, v| "#{k}=#{v}" }).compact.reject(&:empty?).join('; ')
+          end
+          private
+          attr_writer :locale, :region, :language
+          attr_accessor :parameters, :index
+        end
+      end
+    end
+  end
+end

data/lib/media_types/serialization/version.rb CHANGED Viewed

@@ -1,7 +1,7 @@
-# frozen_string_literal: true
-module MediaTypes
-  module Serialization
-    VERSION = '1.3.9'
-  end
-end
+# frozen_string_literal: true
+module MediaTypes
+  module Serialization
+    VERSION = '2.0.0'
+  end
+end