roadie 4.0.0 → 5.0.0

data/lib/roadie/net_http_provider.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'set'
-require 'uri'
-require 'net/http'
+require "set"
+require "uri"
+require "net/http"
 
 module Roadie
   # @api public
@@ -34,19 +34,29 @@ module Roadie
 
     def find_stylesheet!(url)
       response = download(url)
-      if response.kind_of? Net::HTTPSuccess
+      if response.is_a? Net::HTTPSuccess
         Stylesheet.new(url, response_body(response))
       else
-        raise CssNotFound.new(url, "Server returned #{response.code}: #{truncate response.body}", self)
+        raise CssNotFound.new(
+          css_name: url,
+          message: "Server returned #{response.code}: #{truncate response.body}",
+          provider: self
+        )
       end
     rescue Timeout::Error
-      raise CssNotFound.new(url, "Timeout", self)
+      raise CssNotFound.new(css_name: url, message: "Timeout", provider: self)
     end
 
-    def to_s() inspect end
-    def inspect() "#<#{self.class} whitelist: #{whitelist.inspect}>" end
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "#<#{self.class} whitelist: #{whitelist.inspect}>"
+    end
 
     private
+
     def host_set(hosts)
       hosts.each { |host| validate_host(host) }.to_set
     end
@@ -63,7 +73,11 @@ module Roadie
       if access_granted_to?(uri.host)
         get_response(uri)
       else
-        raise CssNotFound.new(url, "#{uri.host} is not part of whitelist!", self)
+        raise CssNotFound.new(
+          css_name: url,
+          message: "#{uri.host} is not part of whitelist!",
+          provider: self
+        )
       end
     end
 
@@ -71,7 +85,7 @@ module Roadie
       if RUBY_VERSION >= "2.0.0"
         Net::HTTP.get_response(uri)
       else
-        Net::HTTP.start(uri.host, uri.port, use_ssl: (uri.scheme == 'https')) do |http|
+        Net::HTTP.start(uri.host, uri.port, use_ssl: (uri.scheme == "https")) do |http|
           http.request(Net::HTTP::Get.new(uri.request_uri))
         end
       end
@@ -92,7 +106,7 @@ module Roadie
     def response_body(response)
       # Make sure we respect encoding because Net:HTTP will encode body as ASCII by default
       # which will break if the response is not compatible.
-      supplied_charset = response.type_params['charset']
+      supplied_charset = response.type_params["charset"]
       body = response.body
 
       if supplied_charset

data/lib/roadie/null_provider.rb

@@ -6,13 +6,26 @@ module Roadie
   # Use it to ignore missing assets or in your tests when you need a provider
   # but you do not care what it contains or that it is even referenced at all.
   class NullProvider
-    def find_stylesheet(name) empty_stylesheet end
-    def find_stylesheet!(name) empty_stylesheet end
+    def find_stylesheet(name)
+      empty_stylesheet
+    end
 
-    def to_s() inspect end
-    def inspect() "#<#{self.class}>" end
+    def find_stylesheet!(name)
+      empty_stylesheet
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "#<#{self.class}>"
+    end
 
     private
-    def empty_stylesheet() Stylesheet.new "(null)", "" end
+
+    def empty_stylesheet
+      Stylesheet.new "(null)", ""
+    end
   end
 end

data/lib/roadie/null_url_rewriter.rb

@@ -7,8 +7,12 @@ module Roadie
   # Used whenever client does not pass any URL options and no URL rewriting
   # should take place.
   class NullUrlRewriter
-    def initialize(generator = nil) end
-    def transform_dom(dom) end
+    def initialize(generator = nil)
+    end
+
+    def transform_dom(dom)
+    end
+
     def transform_css(css)
       css
     end

data/lib/roadie/path_rewriter_provider.rb

@@ -59,7 +59,10 @@ module Roadie
       if new_path
         provider.find_stylesheet!(new_path)
       else
-        raise CssNotFound, "Filter returned #{new_path.inspect}"
+        raise CssNotFound.new(
+          css_name: path,
+          message: "Filter returned #{new_path.inspect}"
+        )
       end
     end
   end

data/lib/roadie/provider_list.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module Roadie
   # An asset provider that just composes a list of other asset providers.
@@ -25,7 +25,7 @@ module Roadie
     # @overload wrap(provider1, provider2, ...)
     #   @return a new {ProviderList} with all the passed providers in it.
     def self.wrap(*providers)
-      if providers.size == 1 && providers.first.class == self
+      if providers.size == 1 && providers.first.instance_of?(self)
         providers.first
       else
         new(providers.flatten)
@@ -33,7 +33,9 @@ module Roadie
     end
 
     # Returns a new empty list.
-    def self.empty() new([]) end
+    def self.empty
+      new([])
+    end
 
     def initialize(providers)
       @providers = providers
@@ -55,13 +57,13 @@ module Roadie
     def find_stylesheet!(name)
       errors = []
       @providers.each do |provider|
-        begin
-          return provider.find_stylesheet!(name)
-        rescue CssNotFound => error
-          errors << error
-        end
+        return provider.find_stylesheet!(name)
+      rescue CssNotFound => error
+        errors << error
       end
-      raise ProvidersFailed.new(name, self, errors)
+      raise ProvidersFailed.new(
+        css_name: name, providers: self, errors: errors
+      )
     end
 
     def to_s
@@ -69,12 +71,14 @@ module Roadie
         # Indent every line one level
         provider.to_s.split("\n").join("\n\t")
       }
-      "ProviderList: [\n\t#{list.join(",\n\t")}\n]"
+      "ProviderList: [\n\t#{list.join(",\n\t")}\n]\n"
     end
 
     # ProviderList can be coerced to an array. This makes Array#flatten work
     # with it, among other things.
-    def to_ary() to_a end
+    def to_ary
+      to_a
+    end
 
     # @!method each
     #   @see Array#each

data/lib/roadie/rspec/asset_provider.rb

@@ -45,7 +45,10 @@ shared_examples_for "roadie asset provider" do |options|
     it "raises Roadie::CssNotFound on invalid stylesheets" do
       expect {
         subject.find_stylesheet!(invalid_name)
-      }.to raise_error Roadie::CssNotFound, Regexp.new(Regexp.quote(invalid_name))
+      }.to raise_error(
+        Roadie::CssNotFound,
+        Regexp.new(Regexp.quote(invalid_name))
+      )
     end
   end
 end

data/lib/roadie/rspec.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require 'roadie/rspec/asset_provider'
-require 'roadie/rspec/cache_store'
+require "roadie/rspec/asset_provider"
+require "roadie/rspec/cache_store"

data/lib/roadie/selector.rb

@@ -37,9 +37,17 @@ module Roadie
       !(pseudo_element? || at_rule? || pseudo_function?)
     end
 
-    def to_s() selector end
-    def to_str() to_s end
-    def inspect() selector.inspect end
+    def to_s
+      selector
+    end
+
+    def to_str
+      to_s
+    end
+
+    def inspect
+      selector.inspect
+    end
 
     # {Selector}s are equal to other {Selector}s if, and only if, their string
     # representations are equal.
@@ -52,9 +60,11 @@ module Roadie
     end
 
     protected
+
     attr_reader :selector
 
     private
+
     BAD_PSEUDO_FUNCTIONS = %w[
       :active :focus :hover :link :target :visited
       :-ms-input-placeholder :-moz-placeholder
@@ -63,11 +73,11 @@ module Roadie
     ].freeze
 
     def pseudo_element?
-      selector.include? '::'
+      selector.include? "::"
     end
 
     def at_rule?
-      selector[0, 1] == '@'
+      selector[0, 1] == "@"
     end
 
     def pseudo_function?

data/lib/roadie/style_attribute_builder.rb

@@ -11,10 +11,11 @@ module Roadie
     end
 
     def attribute_string
-      Deduplicator.apply(stable_sort(@styles).map(&:to_s)).join(';')
+      Deduplicator.apply(stable_sort(@styles).map(&:to_s)).join(";")
     end
 
     private
+
     def stable_sort(list)
       # Ruby's sort is unstable for performance reasons. We need it to be
       # stable, e.g. to preserve order of elements that are compared equal in

data/lib/roadie/style_block.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module Roadie
   # @api private
@@ -39,7 +39,7 @@ module Roadie
     # @return {String}
     def to_s
       # NB - leave off redundant final semicolon - see https://www.w3.org/TR/CSS2/syndata.html#declaration
-      "#{selector}{#{properties.map(&:to_s).join(';')}}"
+      "#{selector}{#{properties.map(&:to_s).join(";")}}"
     end
 
     private
@@ -49,7 +49,7 @@ module Roadie
     # @media only screen and (max-width: 600px) {...} cannot be inlined
     # @return {Boolean}
     def inlinable_media?
-      @media.none? { |media_query| media_query.include? '(' }
+      @media.none? { |media_query| media_query.include? "(" }
     end
   end
 end

data/lib/roadie/style_property.rb

@@ -38,14 +38,15 @@ module Roadie
     end
 
     def to_s
-      [property, value_with_important].join(':')
+      [property, value_with_important].join(":")
     end
 
     def inspect
-      "#{to_s} (#{specificity})"
+      "#{self} (#{specificity})"
     end
 
     private
+
     def value_with_important
       if important
         "#{value} !important"

data/lib/roadie/stylesheet.rb

@@ -8,7 +8,7 @@ module Roadie
   # @attr_reader [String] name the name of the stylesheet ("stylesheets/main.css", "Admin user styles", etc.). The name of the stylesheet will be visible if any errors occur.
   # @attr_reader [Array<StyleBlock>] blocks
   class Stylesheet
-    BOM = (+"\xEF\xBB\xBF").force_encoding('UTF-8').freeze
+    BOM = (+"\xEF\xBB\xBF").force_encoding("UTF-8").freeze
 
     attr_reader :name, :blocks
 
@@ -21,23 +21,12 @@ module Roadie
       @blocks = parse_blocks(css.sub(BOM, ""))
     end
 
-    # @yield [selector, properties]
-    # @yieldparam [Selector] selector
-    # @yieldparam [Array<StyleProperty>] properties
-    # @deprecated Iterate over the #{blocks} instead. Will be removed on version 4.0.
-    def each_inlinable_block(&block)
-      # #map and then #each in order to support chained enumerations, etc. if
-      # no block is provided
-      inlinable_blocks.map { |style_block|
-        [style_block.selector, style_block.properties]
-      }.each(&block)
-    end
-
     def to_s
       blocks.join("\n")
     end
 
     private
+
     def inlinable_blocks
       blocks.select(&:inlinable?)
     end

data/lib/roadie/url_generator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'set'
+require "set"
 
 module Roadie
   # @api private
@@ -23,8 +23,15 @@ module Roadie
     # @option url_options [String] :scheme URL scheme ("http" is default)
     # @option url_options [String] :protocol alias for :scheme
     def initialize(url_options)
-      raise ArgumentError, "No URL options were specified" unless url_options
-      raise ArgumentError, "No :host was specified; options are: #{url_options.inspect}" unless url_options[:host]
+      unless url_options
+        raise ArgumentError, "No URL options were specified"
+      end
+
+      unless url_options[:host]
+        raise ArgumentError,
+          "No :host was specified; options were: #{url_options.inspect}"
+      end
+
       validate_options url_options
 
       @url_options = url_options
@@ -58,7 +65,7 @@ module Roadie
     # @param [String] base The base which the relative path comes from
     # @return [String] an absolute URL
     def generate_url(path, base = "/")
-      return root_uri.to_s if path.nil? or path.empty?
+      return root_uri.to_s if path.nil? || path.empty?
       return path if path_is_anchor?(path)
       return add_scheme(path) if path_is_schemeless?(path)
       return path if Utils.path_is_absolute?(path)
@@ -67,13 +74,20 @@ module Roadie
     end
 
     protected
+
     attr_reader :root_uri, :scheme
 
     private
+
     def build_root_uri
       path = make_absolute url_options[:path]
       port = parse_port url_options[:port]
-      URI::Generic.build(scheme: scheme, host: url_options[:host], port: port, path: path)
+      URI::Generic.build(
+        scheme: scheme,
+        host: url_options[:host],
+        port: port,
+        path: path
+      )
     end
 
     def add_scheme(path)
@@ -98,7 +112,7 @@ module Roadie
 
     # Strip :// from any scheme, if present
     def normalize_scheme(scheme)
-      return 'http' unless scheme
+      return "http" unless scheme
       scheme.to_s[/^\w+/]
     end
 
@@ -119,7 +133,7 @@ module Roadie
     end
 
     def path_is_anchor?(path)
-      path.start_with? '#'
+      path.start_with? "#"
     end
 
     VALID_OPTIONS = Set[:host, :port, :path, :protocol, :scheme].freeze
@@ -127,7 +141,9 @@ module Roadie
     def validate_options(options)
       keys = Set.new(options.keys)
       unless keys.subset? VALID_OPTIONS
-        raise ArgumentError, "Passed invalid options: #{(keys - VALID_OPTIONS).to_a}, valid options are: #{VALID_OPTIONS.to_a}"
+        raise ArgumentError,
+          "Passed invalid options: #{(keys - VALID_OPTIONS).to_a}, " \
+            "valid options are: #{VALID_OPTIONS.to_a}"
       end
     end
   end

data/lib/roadie/url_rewriter.rb

@@ -25,9 +25,9 @@ module Roadie
       dom.css(
         "a[href]:not([data-roadie-ignore]), " \
           "img[src]:not([data-roadie-ignore]), " \
-          "*[style]:not([data-roadie-ignore])",
+          "*[style]:not([data-roadie-ignore])"
       ).each do |element|
-        transform_element_style element if element.has_attribute?('style')
+        transform_element_style element if element.has_attribute?("style")
         transform_element element
       end
       nil
@@ -49,7 +49,10 @@ module Roadie
     end
 
     private
-    def generate_url(*args) @generator.generate_url(*args) end
+
+    def generate_url(*args)
+      @generator.generate_url(*args)
+    end
 
     # Regexp matching all the url() declarations in CSS
     #

data/lib/roadie/utils.rb

@@ -10,7 +10,7 @@ module Roadie
       #
       # URLs that start with double slashes (//css/app.css) are also absolute
       # in modern browsers, but most email clients do not understand them.
-      return true if path =~ %r{^(\w+:|//)}
+      return true if %r{^(\w+:|//)}.match?(path)
 
       begin
         !URI.parse(path).relative?

data/lib/roadie/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-
 module Roadie
-  VERSION = "4.0.0"
+  VERSION = "5.0.0"
 end

data/lib/roadie.rb

@@ -3,30 +3,30 @@
 module Roadie
 end
 
-require 'roadie/version'
-require 'roadie/errors'
+require "roadie/version"
+require "roadie/errors"
 
-require 'roadie/utils'
-require 'roadie/deduplicator'
+require "roadie/utils"
+require "roadie/deduplicator"
 
-require 'roadie/stylesheet'
-require 'roadie/selector'
-require 'roadie/style_property'
-require 'roadie/style_attribute_builder'
-require 'roadie/style_block'
+require "roadie/stylesheet"
+require "roadie/selector"
+require "roadie/style_property"
+require "roadie/style_attribute_builder"
+require "roadie/style_block"
 
-require 'roadie/asset_provider'
-require 'roadie/provider_list'
-require 'roadie/filesystem_provider'
-require 'roadie/null_provider'
-require 'roadie/net_http_provider'
-require 'roadie/cached_provider'
-require 'roadie/path_rewriter_provider'
+require "roadie/asset_provider"
+require "roadie/provider_list"
+require "roadie/filesystem_provider"
+require "roadie/null_provider"
+require "roadie/net_http_provider"
+require "roadie/cached_provider"
+require "roadie/path_rewriter_provider"
 
-require 'roadie/asset_scanner'
-require 'roadie/markup_improver'
-require 'roadie/url_generator'
-require 'roadie/url_rewriter'
-require 'roadie/null_url_rewriter'
-require 'roadie/inliner'
-require 'roadie/document'
+require "roadie/asset_scanner"
+require "roadie/markup_improver"
+require "roadie/url_generator"
+require "roadie/url_rewriter"
+require "roadie/null_url_rewriter"
+require "roadie/inliner"
+require "roadie/document"

data/roadie.gemspec

@@ -1,35 +1,33 @@
-# frozen_string_literal: true
 # roadie.gemspec
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 $:.push File.expand_path("../lib", __FILE__)
-require 'roadie/version'
+require "roadie/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'roadie'
-  s.version     = Roadie::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Magnus Bergmark']
-  s.email       = ['magnus.bergmark@gmail.com']
-  s.homepage    = 'http://github.com/Mange/roadie'
-  s.summary     = %q{Making HTML emails comfortable for the Ruby rockstars}
-  s.description = %q{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.4"
-
-  s.add_dependency 'nokogiri', '~> 1.8'
-  s.add_dependency 'css_parser', '~> 1.4'
-
-  s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
-  s.add_development_dependency 'rubocop', '0.75.0'
-  s.add_development_dependency 'webmock', '~> 3.0'
+  s.name = "roadie"
+  s.version = Roadie::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Magnus Bergmark"]
+  s.email = ["magnus.bergmark@gmail.com"]
+  s.homepage = "http://github.com/Mange/roadie"
+  s.summary = "Making HTML emails comfortable for the Ruby rockstars"
+  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.add_dependency "nokogiri", "~> 1.8"
+  s.add_dependency "css_parser", "~> 1.4"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rspec-collection_matchers", "~> 1.0"
+  s.add_development_dependency "webmock", "~> 3.0"
 
   s.extra_rdoc_files = %w[README.md Changelog.md]
   s.require_paths = %w[lib]
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
 end
-

data/spec/hash_as_cache_store_spec.rb

@@ -4,6 +4,6 @@ require "spec_helper"
 require "roadie/rspec"
 
 describe "Using Hash as a cache store" do
-  subject(:hash) { Hash.new }
+  subject(:hash) { {} }
   it_behaves_like "roadie cache store"
 end