roadie 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ac28a4d983148b5e8c799804e754b81d9d7a04b4ef97f97bcc6592d37a74bed
-  data.tar.gz: 9dbeb2fb1d41e301bf7d7c4049e476da22604bfc70047f6dc843ab6c1a489048
+  metadata.gz: 39c01590157057fcedad04740a1594a45f18150d74c7e8fe071dd3aea6908e1f
+  data.tar.gz: 490cc578b42057ca635ce613d8e50b05401b0a07597761f70423467aa99aa673
 SHA512:
-  metadata.gz: 5146cfb6152aad59b410670b792788bc84af5a9064c353628fae6cc1a1b2a2854703872990c47788c9369fef4469ee15b0040f192aeda1e32dcd8eef934e6327
-  data.tar.gz: 80418199d7ea29608e7997ee4ccfb591dbe8bd1eb3c609b59e8fc857b0d056103fcc9e74fafab6cd32f041ea8051870c41a5e6807b24d4c233e46803ab498750
+  metadata.gz: d71f85f1aba91c711351972b65074835f690f62d0cd4a0feb663f67df89a86d8acddc855fe7be4e23601fe3b0508c1558f6c18cc260c69c1ad5b1b1857ad04e2
+  data.tar.gz: 1d708c10a62800d44efbe825601546a8713b953f81a2549d91a23e74e26048839adc418d38c38bbd08bd885bc6504a3a07c5cca46f94d3ad147d347f3086ffaa

data/.github/workflows/main.yml

@@ -41,3 +41,6 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         uses: amoeba/standardrb-action@v2
+    permissions:
+      checks: write
+      contents: read

data/Changelog.md

@@ -1,8 +1,13 @@
 ### dev
 
-[full changelog](https://github.com/Mange/roadie/compare/v5.0.1...master)
+[full changelog](https://github.com/Mange/roadie/compare/v5.1.0...master)
 
-Nothing yet.
+### 5.1.0
+
+[full changelog](https://github.com/Mange/roadie/compare/v5.0.1...v5.1.0)
+
+* Support passing serialization options to Nokogiri with `serialization_options=` method -
+  [Dmytro Savochkin](https://github.com/dmytro-savochkin). (#171)
 
 ### 5.0.1
 

data/README.md

@@ -94,6 +94,8 @@ Your document instance can be configured with several options:
 * `external_asset_providers` - A list of asset providers that are invoked when absolute CSS URLs are referenced. See below.
 * `before_transformation` - A callback run before transformation starts.
 * `after_transformation` - A callback run after transformation is completed.
+* `serialization_options` - An integer bitmap of options passed along to Nokogiri during serialization.
+By default it's `Nokogiri::XML::Node::SaveOptions::NO_DECLARATION | Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS`.
 
 ### Making URLs absolute ###
 

data/lib/roadie/document.rb

@@ -42,6 +42,10 @@ module Roadie
     # which would change the styling on the page
     attr_accessor :merge_media_queries
 
+    # Integer representing a bitmap set of options used by Nokogiri during serialization.
+    # For the complete set of available options look into +Nokogiri::XML::Node::SaveOptions+.
+    attr_reader :serialization_options
+
     # The mode to generate markup in. Valid values are `:html` (default) and `:xhtml`.
     attr_reader :mode
 
@@ -49,6 +53,9 @@ module Roadie
     def initialize(html)
       @keep_uninlinable_css = true
       @merge_media_queries = true
+      @serialization_options =
+        Nokogiri::XML::Node::SaveOptions::NO_DECLARATION |
+        Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS
       @html = html
       @asset_providers = ProviderList.wrap(FilesystemProvider.new)
       @external_asset_providers = ProviderList.empty
@@ -137,6 +144,13 @@ module Roadie
       @external_asset_providers = ProviderList.wrap(list)
     end
 
+    # Integer representing a bitmap set of options used by Nokogiri during serialization.
+    # For the complete set of available options look into +Nokogiri::XML::Node::SaveOptions+.
+    # (To change the mode in which the document is generated use {#mode=} however.)
+    def serialization_options=(options)
+      @serialization_options = options || 0
+    end
+
     # Change the mode. The mode affects how the resulting markup is generated.
     #
     # Valid modes:
@@ -187,13 +201,7 @@ module Roadie
         xml: save_options::AS_XML
       }.fetch(mode)
 
-      dom.dup.to_html(
-        save_with: (
-          save_options::NO_DECLARATION |
-          save_options::NO_EMPTY_TAGS |
-          format
-        )
-      )
+      dom.dup.to_html(save_with: (serialization_options | format))
     end
 
     def make_url_rewriter

data/lib/roadie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Roadie
-  VERSION = "5.0.1"
+  VERSION = "5.1.0"
 end

data/spec/integration_spec.rb

@@ -398,6 +398,38 @@ describe "Roadie functionality" do
       expect(actual_result).to eq(expected_result)
     end
 
+    it "adds XML declaration into XHTML with no serialization options prohibiting it" do
+      document = Roadie::Document.new <<-HTML
+        <html>
+          <head>
+            <title>Greetings</title>
+          </head>
+        </html>
+      HTML
+
+      document.mode = :xhtml
+      document.serialization_options = 0
+      result = document.transform
+
+      expect(result).to match(/\A<\?xml[^>]*?>/i)
+    end
+
+    it "does not add XML declaration into XHTML with serialization options prohibiting it" do
+      document = Roadie::Document.new <<-HTML
+        <html>
+          <head>
+            <title>Greetings</title>
+          </head>
+        </html>
+      HTML
+
+      document.mode = :xhtml
+      document.serialization_options = Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
+      result = document.transform
+
+      expect(result).not_to match(/\A<\?xml[^>]*?>/i)
+    end
+
     describe "if merge_media_queries is set to false" do
       it "doesn't group non-inlineable media queries in the head" do
         document = Roadie::Document.new <<-HTML

data/spec/lib/roadie/document_spec.rb

@@ -17,6 +17,16 @@ module Roadie
       expect(document.url_options).to eq({host: "foo.bar"})
     end
 
+    it "has an accessor for serialization options" do
+      serialization_options = Nokogiri::XML::Node::SaveOptions::FORMAT |
+        Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS
+      document.serialization_options = serialization_options
+      expect(document.serialization_options).to eq(serialization_options)
+
+      document.serialization_options = nil
+      expect(document.serialization_options).to eq(0)
+    end
+
     it "has a setting for keeping uninlinable styles" do
       expect(document.keep_uninlinable_css).to be true
       document.keep_uninlinable_css = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roadie
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.1.0
 platform: ruby
 authors:
 - Magnus Bergmark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Making HTML emails comfortable for the Ruby rockstars