roadie 5.0.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ac28a4d983148b5e8c799804e754b81d9d7a04b4ef97f97bcc6592d37a74bed
-  data.tar.gz: 9dbeb2fb1d41e301bf7d7c4049e476da22604bfc70047f6dc843ab6c1a489048
+  metadata.gz: d61e03043b7a3086eeccdb7ca1e804ca3eebb5b6dabcc96d09bd5a7daa06b845
+  data.tar.gz: d48918c67a5fe53b88e1b2607269fdf353457e8829cc7dba84bdab3f308426d3
 SHA512:
-  metadata.gz: 5146cfb6152aad59b410670b792788bc84af5a9064c353628fae6cc1a1b2a2854703872990c47788c9369fef4469ee15b0040f192aeda1e32dcd8eef934e6327
-  data.tar.gz: 80418199d7ea29608e7997ee4ccfb591dbe8bd1eb3c609b59e8fc857b0d056103fcc9e74fafab6cd32f041ea8051870c41a5e6807b24d4c233e46803ab498750
+  metadata.gz: 7e646c9a1864e7eb00fef92649583203721b551194ae9c5dd8f979200f8fae06f84b0298252dc3f851585f45047a66ae8f10c417dcdda776046cfc5c59267c0a
+  data.tar.gz: 0f01356119714952a4715ae0db43b96dc964168572943e7a9837cdbadadf493db56440484a6d6564fcccec6cbbc125076bf1cade4e588674ad9802dd7120d5a0

data/.github/workflows/main.yml

@@ -15,11 +15,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.6", "2.7", "3.0", "3.1"]
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # This setup is not compatible with the way Travis CI was
       # setup, so the cache will only work for the root folder.
@@ -34,10 +34,19 @@ jobs:
 
       - uses: codecov/codecov-action@v2
 
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: standardrb
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        uses: amoeba/standardrb-action@v2
+  # Does not work. The action runs in Ruby 2.6, which is not compatible with
+  # the gem and fails to install.
+  # This is very strange considering that the source of the action uses a
+  # Dockerfile with Ruby 2.7. However, I don't want to spend time to fix this
+  # in a passively maintained gem.
+  #
+  # lint:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: standardrb
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #       uses: amoeba/standardrb-action@v2
+  #   permissions:
+  #     checks: write
+  #     contents: read

data/.rubocop.yml

@@ -1,5 +1,9 @@
-AllCops:
-  DisabledByDefault: true
+require:
+  - standard
+
+inherit_gem:
+  standard: config/base.yml
 
-Style/FrozenStringLiteralComment:
-  Enabled: true
+AllCops:
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7

data/.solargraph.yml

@@ -8,9 +8,5 @@ exclude:
   - ".bundle/**/*"
 require: []
 domains: []
-plugins:
-  - solargraph-standardrb
-reporters:
-  - standardrb
 require_paths: []
 max_files: 5000

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 2.7

data/Changelog.md

@@ -1,8 +1,21 @@
 ### dev
 
-[full changelog](https://github.com/Mange/roadie/compare/v5.0.1...master)
+[full changelog](https://github.com/Mange/roadie/compare/v5.2.0...master)
 
-Nothing yet.
+### 5.2.0
+
+[full changelog](https://github.com/Mange/roadie/compare/v5.1.0...v5.2.0)
+
+* Upgrade to Nokogiri `~>` 1.15.
+* Drop support for Ruby 2.6.
+* Add official support for Ruby 3.2.
+
+### 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/Gemfile

@@ -8,3 +8,4 @@ gem "codecov", group: :test, require: false
 # Not actually required to run the tests for the gem, but a real convenience
 # for local development.
 gem "standard", group: [:test, :development], require: false
+gem "solargraph", group: [:test, :development], require: false

data/README.md

@@ -54,7 +54,7 @@ Install & Usage
 [Add this gem to your Gemfile as recommended by Rubygems](http://rubygems.org/gems/roadie) and run `bundle install`.
 
 ```ruby
-gem 'roadie', '~> 4.0'
+gem 'roadie', '~> 5.2'
 ```
 
 You can then create a new instance of a Roadie document:
@@ -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 ###
 
@@ -448,10 +450,10 @@ Build Status
 
 Tested with Github CI using:
 
-* MRI 2.6
 * MRI 2.7
 * MRI 3.0
 * MRI 3.1
+* MRI 3.2
 
 Let me know if you want any other runtime supported officially.
 

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/null_url_rewriter.rb

@@ -8,6 +8,7 @@ module Roadie
   # should take place.
   class NullUrlRewriter
     def initialize(generator = nil)
+      # Intentionally left blank.
     end
 
     def transform_dom(dom)

data/lib/roadie/version.rb

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

data/roadie.gemspec

@@ -15,9 +15,9 @@ Gem::Specification.new do |s|
   s.description = "Roadie tries to make sending HTML emails a little less painful by inlining stylesheets and rewriting relative URLs for you."
   s.license = "MIT"
 
-  s.required_ruby_version = ">= 2.6"
+  s.required_ruby_version = ">= 2.7"
 
-  s.add_dependency "nokogiri", "~> 1.8"
+  s.add_dependency "nokogiri", "~> 1.15"
   s.add_dependency "css_parser", "~> 1.4"
 
   s.add_development_dependency "rake"
@@ -29,5 +29,4 @@ Gem::Specification.new do |s|
   s.require_paths = %w[lib]
 
   s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- spec/*`.split("\n")
 end

data/spec/integration_spec.rb

@@ -251,8 +251,7 @@ describe "Roadie functionality" do
       result = parse_html document.transform
 
       expect(result.at_css("a.one")["href"]).to eq("https://myapp.com/rails/app/about_us")
-      # Nokogiri still treats the attribute as an URL and escapes it.
-      expect(result.at_css("a.two")["href"]).to eq("%24UNSUBSCRIBE_URL")
+      expect(result.at_css("a.two")["href"]).to eq("$UNSUBSCRIBE_URL")
 
       expect(result).to have_styling("color" => "green").at_selector("a.one")
       expect(result).to have_styling("color" => "green").at_selector("a.two")
@@ -398,6 +397,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

data/spec/lib/roadie/style_block_spec.rb

@@ -39,7 +39,7 @@ module Roadie
       context "when one of media queries includes feature condition" do
         it "returns false" do
           selector = double "Selector", inlinable?: "maybe"
-          expect(StyleBlock.new(selector, [], [:all, :'screen (min-width: 300px)']).inlinable?).to be(false)
+          expect(StyleBlock.new(selector, [], [:all, :"screen (min-width: 300px)"]).inlinable?).to be(false)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roadie
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.2.0
 platform: ruby
 authors:
 - Magnus Bergmark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: css_parser
   requirement: !ruby/object:Gem::Requirement
@@ -104,11 +104,11 @@ extra_rdoc_files:
 - README.md
 - Changelog.md
 files:
-- ".autotest"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".solargraph.yml"
+- ".standard.yml"
 - ".yardopts"
 - Changelog.md
 - Gemfile
@@ -190,50 +190,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: Making HTML emails comfortable for the Ruby rockstars
-test_files:
-- spec/fixtures/big_em.css
-- spec/fixtures/stylesheets/green.css
-- spec/hash_as_cache_store_spec.rb
-- spec/integration_spec.rb
-- spec/lib/roadie/asset_scanner_spec.rb
-- spec/lib/roadie/cached_provider_spec.rb
-- spec/lib/roadie/css_not_found_spec.rb
-- spec/lib/roadie/deduplicator_spec.rb
-- spec/lib/roadie/document_spec.rb
-- spec/lib/roadie/filesystem_provider_spec.rb
-- spec/lib/roadie/inliner_spec.rb
-- spec/lib/roadie/markup_improver_spec.rb
-- spec/lib/roadie/net_http_provider_spec.rb
-- spec/lib/roadie/null_provider_spec.rb
-- spec/lib/roadie/null_url_rewriter_spec.rb
-- spec/lib/roadie/path_rewriter_provider_spec.rb
-- spec/lib/roadie/provider_list_spec.rb
-- spec/lib/roadie/selector_spec.rb
-- spec/lib/roadie/style_attribute_builder_spec.rb
-- spec/lib/roadie/style_block_spec.rb
-- spec/lib/roadie/style_property_spec.rb
-- spec/lib/roadie/stylesheet_spec.rb
-- spec/lib/roadie/test_provider_spec.rb
-- spec/lib/roadie/url_generator_spec.rb
-- spec/lib/roadie/url_rewriter_spec.rb
-- spec/lib/roadie/utils_spec.rb
-- spec/shared_examples/asset_provider.rb
-- spec/shared_examples/url_rewriter.rb
-- spec/spec_helper.rb
-- spec/support/have_attribute_matcher.rb
-- spec/support/have_node_matcher.rb
-- spec/support/have_selector_matcher.rb
-- spec/support/have_styling_matcher.rb
-- spec/support/have_xpath_matcher.rb
-- spec/support/test_provider.rb
+test_files: []

data/.autotest

@@ -1,10 +0,0 @@
-# Override autotest default magic to rerun all tests every time a
-# change is detected on the file system.
-class Autotest
-  def get_to_green
-    begin
-      rerun_all_tests
-      wait_for_changes unless all_good
-    end until all_good
-  end
-end