middleman-core 4.3.0.rc.1 → 4.3.0.rc.2

data/lib/middleman-core/template_renderer.rb

@@ -33,7 +33,7 @@ module Middleman
     # @param [Symbol] preferred_engine
     # @return [String]
     Contract IsA['Middleman::Application'], Or[String, Symbol], Symbol => Maybe[IsA['Middleman::SourceFile']]
-    def self.locate_layout(app, name, preferred_engine=nil)
+    def self.locate_layout(app, name, preferred_engine = nil)
       resolve_opts = {}
       resolve_opts[:preferred_engine] = preferred_engine unless preferred_engine.nil?
 
@@ -41,7 +41,7 @@ module Middleman
       layout_file = resolve_template(app, File.join(app.config[:layouts_dir], name.to_s), resolve_opts)
 
       # If we didn't find it, check root
-      layout_file = resolve_template(app, name, resolve_opts) unless layout_file
+      layout_file ||= resolve_template(app, name, resolve_opts)
 
       # Return the path
       layout_file
@@ -52,7 +52,7 @@ module Middleman
     # @option options [Boolean] :preferred_engine If set, try this engine first, then fall back to any engine.
     # @return [String, Boolean] Either the path to the template, or false
     Contract IsA['Middleman::Application'], Or[Symbol, String], Maybe[Hash] => Maybe[IsA['Middleman::SourceFile']]
-    def self.resolve_template(app, request_path, options={})
+    def self.resolve_template(app, request_path, options = {})
       # Find the path by searching
       relative_path = Util.strip_leading_slash(request_path.to_s)
 
@@ -80,12 +80,12 @@ module Middleman
 
         # Cache lookups in build mode only
         file = if app.build?
-          cache.fetch(path_with_ext, preferred_engine) do
-            app.files.find(:source, path_with_ext, globbing)
-          end
-        else
-          app.files.find(:source, path_with_ext, globbing)
-        end
+                 cache.fetch(path_with_ext, preferred_engine) do
+                   app.files.find(:source, path_with_ext, globbing)
+                 end
+               else
+                 app.files.find(:source, path_with_ext, globbing)
+               end
 
         found_template = file if file && (preferred_engine.nil? || ::Middleman::Util.tilt_class(file[:full_path].to_s))
         break if found_template
@@ -109,7 +109,7 @@ module Middleman
     # @param [Hash] opts
     # @return [String]
     Contract Hash, Hash => String
-    def render(locs={}, opts={}, &block)
+    def render(locs = {}, opts = {}, &block)
       path = @path.dup
       locals = locs.dup.freeze
       options = opts.dup
@@ -132,7 +132,7 @@ module Middleman
       @app.extensions.add_exposed_to_context(context)
 
       locals.each do |k, _|
-        next unless context.respond_to?(k) && ![:current_path, :paginate, :page_articles, :blog_controller, :lang, :locale, :data].include?(k.to_sym)
+        next unless context.respond_to?(k) && !%i[current_path paginate page_articles blog_controller lang locale data].include?(k.to_sym)
 
         msg = "Template local `#{k}` tried to overwrite an existing context value. Please rename the key when passing to `locals`"
 
@@ -149,16 +149,19 @@ module Middleman
 
       # If we need a layout and have a layout, use it
       layout_file = fetch_layout(engine, options)
+
       if layout_file
-        content = if layout_file = fetch_layout(engine, options)
-          layout_renderer = ::Middleman::FileRenderer.new(@app, layout_file[:relative_path].to_s)
+        layout_file = fetch_layout(engine, options)
 
-          ::Middleman::Util.instrument 'builder.output.resource.render-layout', path: File.basename(layout_file[:relative_path].to_s) do
-            layout_renderer.render(locals, options, context) { content }
-          end
-        else
-          content
-        end
+        content = if layout_file
+                    layout_renderer = ::Middleman::FileRenderer.new(@app, layout_file[:relative_path].to_s)
+
+                    ::Middleman::Util.instrument 'builder.output.resource.render-layout', path: File.basename(layout_file[:relative_path].to_s) do
+                      layout_renderer.render(locals, options, context) { content }
+                    end
+                  else
+                    content
+                  end
       end
 
       # Return result
@@ -209,25 +212,24 @@ module Middleman
       # The engine for the layout can be set in options, engine_options or passed
       # into this method
       layout_engine = if opts.key?(:layout_engine)
-        opts[:layout_engine]
-      elsif engine_options.key?(:layout_engine)
-        engine_options[:layout_engine]
-      else
-        engine
-      end
+                        opts[:layout_engine]
+                      elsif engine_options.key?(:layout_engine)
+                        engine_options[:layout_engine]
+                      else
+                        engine
+                      end
 
       # Automatic mode
       if local_layout == :_auto_layout
         # Look for :layout of any extension
         # If found, use it. If not, continue
         locate_layout(:layout, layout_engine)
-      elsif layout_file = locate_layout(local_layout, layout_engine)
-        # Look for specific layout
-        # If found, use it. If not, error.
+      else
+        layout_file = locate_layout(local_layout, layout_engine)
+
+        raise ::Middleman::TemplateRenderer::TemplateNotFound, "Could not locate layout: #{local_layout}" unless layout_file
 
         layout_file
-      else
-        raise ::Middleman::TemplateRenderer::TemplateNotFound, "Could not locate layout: #{local_layout}"
       end
     end
 
@@ -236,7 +238,7 @@ module Middleman
     # @param [Symbol] preferred_engine
     # @return [String]
     Contract Or[String, Symbol], Symbol => Maybe[IsA['Middleman::SourceFile']]
-    def locate_layout(name, preferred_engine=nil)
+    def locate_layout(name, preferred_engine = nil)
       self.class.locate_layout(@app, name, preferred_engine)
     end
 
@@ -245,7 +247,7 @@ module Middleman
     # @param [Hash] options
     # @return [Array<String, Symbol>, Boolean]
     Contract String, Hash => ArrayOf[Or[String, Symbol]]
-    def resolve_template(request_path, options={})
+    def resolve_template(request_path, options = {})
       self.class.resolve_template(@app, request_path, options)
     end
   end

data/lib/middleman-core/util.rb

@@ -16,8 +16,8 @@ module Middleman
     module_function
 
     # Facade for ActiveSupport/Notification
-    def instrument(name, payload={}, &block)
-      suffixed_name = name =~ /\.middleman$/ ? name.dup : "#{name}.middleman"
+    def instrument(name, payload = {}, &block)
+      suffixed_name = /\.middleman$/.match?(name) ? name.dup : "#{name}.middleman"
       ::ActiveSupport::Notifications.instrument(suffixed_name, payload, &block)
     end
   end

data/lib/middleman-core/util/binary.rb

@@ -32,7 +32,9 @@ module Middleman
         else
           dot_ext = ext.to_s[0] == '.' ? ext.dup : ".#{ext}"
 
-          if mime = ::Rack::Mime.mime_type(dot_ext, nil)
+          mime = ::Rack::Mime.mime_type(dot_ext, nil)
+
+          if mime
             !nonbinary_mime?(mime)
           else
             file_contents_include_binary_bytes?(path.to_s)

data/lib/middleman-core/util/data.rb

@@ -45,7 +45,7 @@ module Middleman
       # @param [String] path
       # @return [Array<Hash, String>]
       Contract IsA['Middleman::SourceFile'], Maybe[Symbol] => [Hash, Maybe[String]]
-      def parse(file, frontmatter_delims, known_type=nil)
+      def parse(file, frontmatter_delims, known_type = nil)
         full_path = file[:full_path]
         return [{}, nil] if ::Middleman::Util.binary?(full_path) || file[:types].include?(:binary)
 
@@ -110,7 +110,7 @@ module Middleman
       Contract String, Pathname => Hash
       def parse_yaml(content, full_path)
         c = ::Middleman::Util.instrument 'parse.yaml' do
-          ::YAML.load(content)
+          ::YAML.safe_load(content)
         end
         c ? symbolize_recursive(c) : {}
       rescue StandardError, ::Psych::SyntaxError => error

data/lib/middleman-core/util/files.rb

@@ -119,7 +119,7 @@ module Middleman
 
       all_extensions.uniq!
 
-      app.sitemap.resources.select { |r|
+      app.sitemap.resources.select do |r|
         if r.file_descriptor
           local_extensions = collect_extensions(r.file_descriptor[:full_path].to_s)
           local_extensions |= sass_type_aliasing unless (local_extensions & sass_type_aliasing).empty?
@@ -131,7 +131,7 @@ module Middleman
         else
           false
         end
-      }.map(&:file_descriptor)
+      end.map(&:file_descriptor)
     end
   end
 end

data/lib/middleman-core/util/paths.rb

@@ -7,7 +7,6 @@ require 'tilt'
 
 require 'middleman-core/contracts'
 
-# rubocop:disable ModuleLength
 module Middleman
   module Util
     extend Memoist
@@ -72,24 +71,24 @@ module Middleman
     # @param [Hash] options Data to pass through.
     # @return [String]
     Contract ::Middleman::Application, Symbol, Or[String, Symbol], Hash => String
-    def asset_path(app, kind, source, options={})
+    def asset_path(app, kind, source, options = {})
       return source if source.to_s.include?('//') || source.to_s.start_with?('data:')
 
       asset_folder = case kind
-      when :css
-        app.config[:css_dir]
-      when :js
-        app.config[:js_dir]
-      when :images
-        app.config[:images_dir]
-      when :fonts
-        app.config[:fonts_dir]
-      else
-        kind.to_s
-      end
+                     when :css
+                       app.config[:css_dir]
+                     when :js
+                       app.config[:js_dir]
+                     when :images
+                       app.config[:images_dir]
+                     when :fonts
+                       app.config[:fonts_dir]
+                     else
+                       kind.to_s
+                     end
 
       source = source.to_s.tr(' ', '')
-      ignore_extension = (kind == :images || kind == :fonts) # don't append extension
+      ignore_extension = %i[images fonts].include? kind # don't append extension
       source << ".#{kind}" unless ignore_extension || source.end_with?(".#{kind}")
       asset_folder = '' if source.start_with?('/') # absolute path
 
@@ -103,7 +102,7 @@ module Middleman
     # @param [Hash] options Data to pass through.
     # @return [String] The fully qualified asset url
     Contract ::Middleman::Application, String, String, Hash => String
-    def asset_url(app, path, prefix='', options={})
+    def asset_url(app, path, prefix = '', options = {})
       # Don't touch assets which already have a full path
       return path if path.include?('//') || path.start_with?('data:')
 
@@ -118,18 +117,20 @@ module Middleman
       # relative path, since it only takes absolute url paths.
       dest_path = url_for(app, path, options.merge(relative: false))
 
-      result = if resource = app.sitemap.find_resource_by_path(dest_path)
-        resource.url
-      elsif resource = app.sitemap.find_resource_by_destination_path(dest_path)
-        resource.url
-      else
-        path = ::File.join(prefix, path)
-        if resource = app.sitemap.find_resource_by_path(path)
-          resource.url
-        else
-          ::File.join(app.config[:http_prefix], path)
-        end
-      end
+      resource = app.sitemap.find_resource_by_path(dest_path) || app.sitemap.find_resource_by_destination_path(dest_path)
+
+      result = if resource
+                 resource.url
+               else
+                 path = ::File.join(prefix, path)
+                 resource = app.sitemap.find_resource_by_path(path)
+
+                 if resource
+                   resource.url
+                 else
+                   ::File.join(app.config[:http_prefix], path)
+                 end
+               end
 
       final_result = ::Addressable::URI.encode(
         relative_path_from_resource(
@@ -149,19 +150,19 @@ module Middleman
     # or a Resource, this will produce the nice URL configured for that
     # path, respecting :relative_links, directory indexes, etc.
     Contract ::Middleman::Application, Or[String, Symbol, ::Middleman::Sitemap::Resource], Hash => String
-    def url_for(app, path_or_resource, options={})
+    def url_for(app, path_or_resource, options = {})
       if path_or_resource.is_a?(String) || path_or_resource.is_a?(Symbol)
         r = app.sitemap.find_resource_by_page_id(path_or_resource)
 
-        path_or_resource = r ? r : path_or_resource.to_s
+        path_or_resource = r || path_or_resource.to_s
       end
 
       # Handle Resources and other things which define their own url method
       url = if path_or_resource.respond_to?(:url)
-        path_or_resource.url
-      else
-        path_or_resource.dup
-      end
+              path_or_resource.url
+            else
+              path_or_resource.dup
+            end
 
       # Try to parse URL
       begin
@@ -209,20 +210,22 @@ module Middleman
 
       if resource
         uri.path = if this_resource
-          ::Addressable::URI.encode(
-            relative_path_from_resource(
-              this_resource,
-              resource_url,
-              effective_relative
-            )
-          )
-        else
-          resource_url
-        end
+                     ::Addressable::URI.encode(
+                       relative_path_from_resource(
+                         this_resource,
+                         resource_url,
+                         effective_relative
+                       )
+                     )
+                   else
+                     resource_url
+                   end
       end
 
       # Support a :query option that can be a string or hash
-      if query = options[:query]
+      query = options[:query]
+
+      if query
         uri.query = query.respond_to?(:to_param) ? query.to_param : query.to_s
       end
 

data/lib/middleman-core/util/rack.rb

@@ -27,8 +27,8 @@ module Middleman
       url_fn_prefix = 'url('
 
       body.dup.gsub(matcher) do |match|
-        opening_character = $1
-        asset_path = $2
+        opening_character = Regexp.last_match(1)
+        asset_path = Regexp.last_match(2)
 
         if asset_path.start_with?(url_fn_prefix)
           opening_character << url_fn_prefix
@@ -40,7 +40,7 @@ module Middleman
         begin
           uri = ::Middleman::Util.parse_uri(asset_path)
 
-          if uri.relative? && uri.host.nil? && !(asset_path =~ /^[^\/].*[a-z]+\.[a-z]+\/.*/)
+          if uri.relative? && uri.host.nil? && asset_path !~ /^[^\/].*[a-z]+\.[a-z]+\/.*/
             dest_path = ::Middleman::Util.url_for(app, asset_path, relative: false, current_resource: current_resource)
 
             resource = app.sitemap.find_resource_by_destination_path(dest_path)

data/lib/middleman-core/util/uri_templates.rb

@@ -54,6 +54,7 @@ module Middleman
 
         parameterized_string.chars.to_a.each_with_index do |char, i|
           next unless char == '?' && str[i].bytes.count != 1
+
           parameterized_string[i] = str[i]
         end
 

data/lib/middleman-core/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   # Current Version
   # @return [String]
-  VERSION = '4.3.0.rc.1'.freeze unless const_defined?(:VERSION)
+  VERSION = '4.3.0.rc.2'.freeze unless const_defined?(:VERSION)
 end

data/middleman-core.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.files        = `git ls-files -z`.split("\0")
   s.test_files   = `git ls-files -z -- {fixtures,features}/*`.split("\0")
   s.require_path = 'lib'
-  s.required_ruby_version = '>= 2.2.0'
+  s.required_ruby_version = '>= 2.3.0'
 
   # Core
   s.add_dependency('bundler', ['~> 1.1'])
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency('padrino-helpers', ['~> 0.13.0'])
   s.add_dependency('addressable', ['~> 2.3'])
   s.add_dependency('memoist', ['~> 0.14'])
+  s.add_dependency('backports', ['~> 3.11'])
 
   # Watcher
   s.add_dependency('listen', ['~> 3.0'])
@@ -53,7 +54,7 @@ Gem::Specification.new do |s|
   s.add_dependency('execjs', ['~> 2.0'])
 
   # Testing
-  s.add_dependency('contracts', ['~> 0.13'])
+  s.add_dependency('contracts', ['~> 0.16.0'])
 
   # Hash stuff
   s.add_dependency('hashie', ['~> 3.4'])

data/spec/middleman-core/callbacks_spec.rb

@@ -2,7 +2,7 @@
 require 'middleman-core/callback_manager'
 
 describe ::Middleman::CallbackManager do
-  it "adds a simple key" do
+  it 'adds a simple key' do
     counters = {
       test1: 0,
       test2: 0,
@@ -26,7 +26,7 @@ describe ::Middleman::CallbackManager do
     expect(counters[:test3]).to eq 0
   end
 
-  it "callbacks run in order" do
+  it 'callbacks run in order' do
     result = []
 
     m = ::Middleman::CallbackManager.new
@@ -39,24 +39,24 @@ describe ::Middleman::CallbackManager do
     expect(result.join('')).to eq '123'
   end
 
-  it "adds a nested key" do
+  it 'adds a nested key' do
     counters = {
       test1: 0,
       test1a: 0
     }
 
     m = ::Middleman::CallbackManager.new
-    m.add([:test1, :a]) { |n| counters[:test1a] += n }
+    m.add(%i[test1 a]) { |n| counters[:test1a] += n }
     m.add(:test1) { counters[:test1] += 1 }
 
-    m.execute([:test1, :a], [2])
-    m.execute([:test1, :b], [5])
+    m.execute(%i[test1 a], [2])
+    m.execute(%i[test1 b], [5])
 
     expect(counters[:test1]).to eq 0
     expect(counters[:test1a]).to eq 2
   end
 
-  it "works in isolation" do
+  it 'works in isolation' do
     m1 = ::Middleman::CallbackManager.new
     m2 = ::Middleman::CallbackManager.new
 
@@ -77,7 +77,7 @@ describe ::Middleman::CallbackManager do
     expect(counters[:test2]).to eq 5
   end
 
-  it "installs to arbitrary instances" do
+  it 'installs to arbitrary instances' do
     instance = Class.new(Object).new
 
     m = ::Middleman::CallbackManager.new
@@ -88,11 +88,11 @@ describe ::Middleman::CallbackManager do
     instance.execute_callbacks(:ready, [2])
     instance.execute_callbacks(:ready2, [10])
     instance.execute_callbacks([:ready], [20])
-    instance.execute_callbacks([:ready, :two], [20])
+    instance.execute_callbacks(%i[ready two], [20])
     expect(counter).to eq 2
   end
 
-  it "executes in default scope" do
+  it 'executes in default scope' do
     instance = Class.new(Object).new
     m = ::Middleman::CallbackManager.new
     m.install_methods!(instance, [:ready])
@@ -104,10 +104,12 @@ describe ::Middleman::CallbackManager do
 
     instance.execute_callbacks(:ready)
 
+    # rubocop:disable Style/CaseEquality
     expect(internal_self) === instance
+    # rubocop:enable Style/CaseEquality
   end
 
-  it "executes in custom scope" do
+  it 'executes in custom scope' do
     instance = Class.new(Object).new
     m = ::Middleman::CallbackManager.new
     m.install_methods!(instance, [:ready])
@@ -124,9 +126,8 @@ describe ::Middleman::CallbackManager do
     instance.ready(&external_instance.method(:when_ready))
 
     instance.execute_callbacks(:ready, [5])
-    
+
     expect(external_instance[:scope]).to eq external_instance
     expect(external_instance[:counter]).to eq 5
   end
-
-end
+end