RubyGems - middleman-core - Versions diffs - 3.4.0 → 3.4.1 - Mend

middleman-core 3.4.0 → 3.4.1

Files changed (51) hide show

checksums.yaml +4 -4
data/Rakefile +1 -7
data/features/clean_build.feature +18 -0
data/features/cli/preview_server-hook.feature +17 -0
data/features/cli/preview_server.feature +20 -20
data/features/data.feature +28 -0
data/features/step_definitions/queryable_steps.rb +122 -45
data/features/stylus.feature +1 -1
data/fixtures/asciidoc-app/source/hello-with-title.adoc +1 -0
data/fixtures/clean-app/config-hidden-dir-after.rb +5 -0
data/fixtures/clean-app/config-hidden-dir-before.rb +1 -0
data/fixtures/preview-server-hook-app/config.rb +19 -0
data/fixtures/preview-server-hook-app/source/index.html.erb +9 -0
data/lib/middleman-core.rb +0 -4
data/lib/middleman-core/application.rb +3 -0
data/lib/middleman-core/cli.rb +1 -1
data/lib/middleman-core/cli/build.rb +1 -1
data/lib/middleman-core/cli/server.rb +1 -1
data/lib/middleman-core/configuration.rb +1 -1
data/lib/middleman-core/core_extensions/data.rb +4 -8
data/lib/middleman-core/core_extensions/data/file_loader.rb +71 -0
data/lib/middleman-core/core_extensions/rendering.rb +8 -8
data/lib/middleman-core/core_extensions/show_exceptions.rb +1 -1
data/lib/middleman-core/dns_resolver/basic_network_resolver.rb +2 -2
data/lib/middleman-core/extensions.rb +0 -2
data/lib/middleman-core/meta_pages/sitemap_resource.rb +2 -0
data/lib/middleman-core/meta_pages/sitemap_tree.rb +1 -1
data/lib/middleman-core/preview_server.rb +9 -10
data/lib/middleman-core/preview_server/server_information.rb +12 -3
data/lib/middleman-core/preview_server/server_information_callback_proxy.rb +35 -0
data/lib/middleman-core/preview_server/server_url.rb +17 -4
data/lib/middleman-core/renderers/asciidoc.rb +1 -1
data/lib/middleman-core/renderers/liquid.rb +1 -1
data/lib/middleman-core/sitemap/extensions/content_type.rb +1 -1
data/lib/middleman-core/sitemap/store.rb +9 -8
data/lib/middleman-core/step_definitions.rb +1 -1
data/lib/middleman-core/step_definitions/builder_steps.rb +10 -12
data/lib/middleman-core/step_definitions/commandline_steps.rb +9 -9
data/lib/middleman-core/step_definitions/middleman_steps.rb +10 -2
data/lib/middleman-core/step_definitions/server_steps.rb +50 -30
data/lib/middleman-core/templates/shared/Gemfile.tt +2 -2
data/lib/middleman-core/templates/shared/config.ru +0 -1
data/lib/middleman-core/templates/shared/gitignore +3 -0
data/lib/middleman-core/util.rb +1 -1
data/lib/middleman-core/version.rb +1 -1
data/lib/middleman-more/core_extensions/default_helpers.rb +13 -2
data/lib/middleman-more/extensions/cache_buster.rb +1 -1
data/middleman-core.gemspec +4 -2
metadata +15 -5
data/.gemtest +0 -0
data/.rspec +0 -1

data/features/stylus.feature CHANGED Viewed

@@ -1,4 +1,4 @@
-@nojava
+@wip @nojava
 Feature: Stylus Updates and Partials
   Scenario: The preview server should update stylesheets when Stylus changes
     Given the Server is running at "stylus-preview-app"

data/fixtures/asciidoc-app/source/hello-with-title.adoc CHANGED Viewed

@@ -1,4 +1,5 @@
 = Page Title
+:showtitle:
 :page-layout: default
 Hello, AsciiDoc!

data/fixtures/clean-app/config-hidden-dir-after.rb ADDED Viewed

@@ -0,0 +1,5 @@
+set :build_dir, ".build"
+ignore "/should_be_ignored.html"
+page "/should_be_ignored2.html", :ignore => true
+page "/target_ignore.html", :proxy => "/should_be_ignored3.html", :ignore => true

data/fixtures/clean-app/config-hidden-dir-before.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ set :build_dir, ".build"

data/fixtures/preview-server-hook-app/config.rb ADDED Viewed

@@ -0,0 +1,19 @@
+set :layout, false
+class MyFeature < Middleman::Extension
+  def initialize(app, options_hash = {}, &block)
+    super
+    app.before_server do |server_information|
+      puts "/// #{server_information.listeners.first} ///"
+      puts "/// #{server_information.port} ///"
+      puts "/// #{server_information.server_name} ///"
+      puts "/// #{server_information.site_addresses.first} ///"
+      puts "/// ### END ### ///"
+    end
+  end
+end
+::Middleman::Extensions.register(:my_feature, MyFeature)
+activate :my_feature

data/fixtures/preview-server-hook-app/source/index.html.erb ADDED Viewed

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>preview-server-hook-app</title>
+  </head>
+  <body>
+    <h1>preview-server-hook-app</h1>
+  </body>
+</html>

data/lib/middleman-core.rb CHANGED Viewed

@@ -1,9 +1,5 @@
 # rubocop:disable FileName
-# Setup our load paths
-libdir = File.expand_path(File.dirname(__FILE__))
-$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 # Top-level Middleman namespace
 module Middleman
   # Backwards compatibility namespace

data/lib/middleman-core/application.rb CHANGED Viewed

@@ -41,6 +41,9 @@ module Middleman
     # Runs after the build is finished
     define_hook :after_build
+    # Runs before the preview server is started
+    define_hook :before_server
     # Mix-in helper methods. Accepts either a list of Modules
     # and/or a block to be evaluated
     # @return [void]

data/lib/middleman-core/cli.rb CHANGED Viewed

@@ -5,7 +5,7 @@ require 'thor/group'
 # CLI Module
 module Middleman
   module Cli
-    # The base task from which everything else etends
+    # The base task from which everything else extends
     class Base < Thor
       class << self
         def start(*args)

data/lib/middleman-core/cli/build.rb CHANGED Viewed

@@ -167,7 +167,7 @@ module Middleman::Cli
       paths = ::Middleman::Util.all_files_under(@build_dir).map(&:realpath).select(&:file?)
       @to_clean += paths.select do |path|
-        path.to_s !~ /\/\./ || path.to_s =~ /\.(htaccess|htpasswd)/
+        path.relative_path_from(@build_dir.realpath).to_s !~ /\/\./ || path.to_s =~ /\.(htaccess|htpasswd)/
       end
       return unless RUBY_PLATFORM =~ /darwin/

data/lib/middleman-core/cli/server.rb CHANGED Viewed

@@ -16,7 +16,7 @@ module Middleman::Cli
                   desc: 'The port Middleman will listen on'
     method_option :server_name,
                   aliases: '-s',
-                  desc: 'The server name name Middleman will use'
+                  desc: 'The server name Middleman will use'
     method_option :bind_address,
                   aliases: '-b',
                   desc: 'The bind address Middleman will listen on'

data/lib/middleman-core/configuration.rb CHANGED Viewed

@@ -48,7 +48,7 @@ module Middleman
         self.class.config
       end
-      # Backwards compatibilty with old Sinatra template interface
+      # Backwards compatibility with old Sinatra template interface
       #
       # @deprecated Prefer accessing settings through "config".
       #

data/lib/middleman-core/core_extensions/data.rb CHANGED Viewed

@@ -7,9 +7,7 @@ module Middleman
       class << self
         # @private
         def registered(app)
-          # Data formats
-          require 'yaml'
-          require 'json'
+          require 'middleman-core/core_extensions/data/file_loader'
           app.config.define_setting :data_dir, 'data', 'The directory data files are stored in'
           app.send :include, InstanceMethods
@@ -95,11 +93,9 @@ module Middleman
           data_path = full_path.relative_path_from(root + @app.config[:data_dir])
-          if %w(.yaml .yml).include?(extension)
-            data = YAML.load_file(full_path)
-          elsif extension == '.json'
-            data = JSON.parse(full_path.read)
-          else
+          begin
+            data = FileLoader.new.load(full_path)
+          rescue FileLoader::NoFileLoaderFoundError
             return
           end

data/lib/middleman-core/core_extensions/data/file_loader.rb ADDED Viewed

@@ -0,0 +1,71 @@
+require 'yaml'
+require 'json'
+module Middleman
+  module CoreExtensions
+    module Data
+      # Load data files
+      class FileLoader
+        # No parser available
+        class NoFileLoaderFoundError < StandardError; end
+        # Load yaml files
+        class YamlFileLoader
+          def match?(file)
+            %w(.yaml .yml).include? File.extname(file)
+          end
+          # @param [Pathname] file
+          def load(file)
+            YAML.load_file(file)
+          rescue Psych::SyntaxError, StandardError => e
+            $stderr.puts %(Loading data file "#{file}" failed due to an error: #{e.message})
+            {}
+          end
+        end
+        # Load json files
+        class JsonFileLoader
+          def match?(file)
+            '.json' == File.extname(file)
+          end
+          # @param [Pathname] file
+          def load(file)
+            JSON.parse(file.read)
+          rescue => e
+            $stderr.puts %(Loading data file "#{file}" failed due to an error: #{e.message})
+            {}
+          end
+        end
+        # Default loader
+        #
+        # Always fails
+        class NilFileLoader
+          def match?(file)
+            raise NoFileLoaderFoundError
+          end
+        end
+        private
+        attr_reader :loaders
+        public
+        def initialize
+          @loaders = []
+          @loaders << YamlFileLoader.new
+          @loaders << JsonFileLoader.new
+          @loaders << NilFileLoader.new
+        end
+        # Load file using loader
+        def load(file)
+          loaders.find { |l| l.match? file }.load(file)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-core/core_extensions/rendering.rb CHANGED Viewed

@@ -214,7 +214,7 @@ module Middleman
           locals = options[:locals]
           if ::Tilt[found_partial]
-            # Render the partial if found, otherwide throw exception
+            # Render the partial if found, otherwise throw exception
             _render_with_all_renderers(found_partial, locals, self, options, &block)
           else
             read_template_file(found_partial)
@@ -265,7 +265,7 @@ module Middleman
           # Try to work around: https://github.com/middleman/middleman/issues/501
           locs = locs.dup
-          # Detect the remdering engine from the extension
+          # Detect the rendering engine from the extension
           extension = File.extname(path)
           engine = extension[1..-1].to_sym
@@ -296,10 +296,10 @@ module Middleman
           # Allow hooks to manipulate the template before render
           self.class.callbacks_for_hook(:before_render).each do |callback|
             # Uber::Options::Value doesn't respond to call
-            newbody = if callback.respond_to?(:call)
-              callback.call(body, path, locs, template_class)
+            newbody = if callback.is_a? ::Uber::Options::Value
+              callback.call(self, body, path, locs, template_class)
             elsif callback.respond_to?(:evaluate)
-              callback.evaluate(self, body, path, locs, template_class)
+              callback.call(body, path, locs, template_class)
             end
             body = newbody if newbody # Allow the callback to return nil to skip it
           end
@@ -315,10 +315,10 @@ module Middleman
           # Allow hooks to manipulate the result after render
           self.class.callbacks_for_hook(:after_render).each do |callback|
             # Uber::Options::Value doesn't respond to call
-            newcontent = if callback.respond_to?(:call)
-              content = callback.call(content, path, locs, template_class)
+            newcontent = if callback.is_a? ::Uber::Options::Value
+              callback.call(self, content, path, locs, template_class)
             elsif callback.respond_to?(:evaluate)
-              content = callback.evaluate(self, content, path, locs, template_class)
+              callback.call(content, path, locs, template_class)
             end
             content = newcontent if newcontent # Allow the callback to return nil to skip it
           end

data/lib/middleman-core/core_extensions/show_exceptions.rb CHANGED Viewed

@@ -15,7 +15,7 @@ module Middleman
           # When in dev
           app.configure :development do
-            # Include middlemare
+            # Include middleware
             use ::Rack::ShowExceptions if config[:show_exceptions]
           end
         end

data/lib/middleman-core/dns_resolver/basic_network_resolver.rb CHANGED Viewed

@@ -21,7 +21,7 @@ module Middleman
       #   Array of Names
       def getnames(ip)
         resolver.getnames(ip.to_s).map(&:to_s)
-      rescue Resolv::ResolvError, Errno::EADDRNOTAVAIL
+      rescue Resolv::ResolvError, Errno::EADDRNOTAVAIL, Errno::ENETUNREACH
         []
       end
@@ -34,7 +34,7 @@ module Middleman
       #   Array of ipaddresses
       def getaddresses(name)
         resolver.getaddresses(name.to_s).map(&:to_s)
-      rescue Resolv::ResolvError, Errno::EADDRNOTAVAIL
+      rescue Resolv::ResolvError, Errno::EADDRNOTAVAIL, Errno::ENETUNREACH
         []
       end

data/lib/middleman-core/extensions.rb CHANGED Viewed

@@ -56,8 +56,6 @@ module Middleman
     #
     # @private
     def load_extensions_in_path
-      require 'rubygems'
       extensions = rubygems_latest_specs.select do |spec|
         spec_has_file?(spec, EXTENSION_FILE)
       end

data/lib/middleman-core/meta_pages/sitemap_resource.rb CHANGED Viewed

@@ -1,4 +1,6 @@
 require 'padrino-helpers'
+require 'padrino-helpers/output_helpers'
+require 'padrino-helpers/tag_helpers'
 module Middleman
   module MetaPages

data/lib/middleman-core/meta_pages/sitemap_tree.rb CHANGED Viewed

@@ -59,7 +59,7 @@ module Middleman
         if path_parts.size == 1
           sitemap_class = SitemapResource
-          # Allow special sitemap resources to use custom metadata view calsses
+          # Allow special sitemap resources to use custom metadata view classes
           sitemap_class = resource.meta_pages_class if resource.respond_to? :meta_pages_class
           @children[first_part] = sitemap_class.new(resource)

data/lib/middleman-core/preview_server.rb CHANGED Viewed

@@ -5,6 +5,7 @@ require 'middleman-core/meta_pages'
 require 'middleman-core/logger'
 require 'middleman-core/preview_server/server_information'
 require 'middleman-core/preview_server/server_url'
+require 'middleman-core/preview_server/server_information_callback_proxy'
 # rubocop:disable GlobalVars
 module Middleman
@@ -13,10 +14,6 @@ module Middleman
       attr_reader :app, :ssl_certificate, :ssl_private_key, :environment, :server_information
       delegate :logger, to: :app
-      def https?
-        @https
-      end
       # Start an instance of Middleman::Application
       # @return [void]
       def start(opts={})
@@ -26,6 +23,7 @@ module Middleman
         @options = opts
         @server_information = ServerInformation.new
+        @server_information.https = (@options[:https] == true)
         # New app evaluates the middleman configuration. Since this can be
         # invalid as well, we need to evaluate the configuration BEFORE
@@ -42,9 +40,9 @@ module Middleman
         logger.debug %(== Server information is provided by #{server_information.handler})
         logger.debug %(== The Middleman is running in "#{environment}" environment)
-        logger.debug format('== The Middleman preview server is bind to %s', ServerUrl.new(hosts: server_information.listeners, port: server_information.port, https: https?).to_bind_addresses.join(', '))
-        logger.info format('== View your site at %s', ServerUrl.new(hosts: server_information.site_addresses, port: server_information.port, https: https?).to_urls.join(', '))
-        logger.info format('== Inspect your site configuration at %s', ServerUrl.new(hosts: server_information.site_addresses, port: server_information.port, https: https?).to_config_urls.join(', '))
+        logger.debug format('== The Middleman preview server is bound to %s', ServerUrl.new(hosts: server_information.listeners, port: server_information.port, https: server_information.https?).to_bind_addresses.join(', '))
+        logger.info format('== View your site at %s', ServerUrl.new(hosts: server_information.site_addresses, port: server_information.port, https: server_information.https?).to_urls.join(', '))
+        logger.info format('== Inspect your site configuration at %s', ServerUrl.new(hosts: server_information.site_addresses, port: server_information.port, https: server_information.https?).to_config_urls.join(', '))
         @initialized ||= false
         return if @initialized
@@ -56,6 +54,8 @@ module Middleman
         # reloading later on.
         ::Middleman::Profiling.report('server_start')
+        app.run_hook(:before_server, ServerInformationCallbackProxy.new(server_information))
         loop do
           @webrick.start
@@ -153,7 +153,6 @@ module Middleman
         logger.warn format('== The Middleman uses a different port "%s" then the configured one "%s" because some other server is listening on that port.', server_information.port, configured_port) unless @app.config[:port] == configured_port
-        @https        = @app.config[:https]
         @environment  = @app.config[:environment]
         @ssl_certificate = @app.config[:ssl_certificate]
@@ -199,7 +198,7 @@ module Middleman
         @listener.start
       end
-      # Trap some interupt signals and shut down smoothly
+      # Trap some interrupt signals and shut down smoothly
       # @return [void]
       def register_signal_handlers
         %w(INT HUP TERM QUIT).each do |sig|
@@ -224,7 +223,7 @@ module Middleman
           DoNotReverseLookup: true
         }
-        if https?
+        if server_information.https?
           http_opts[:SSLEnable] = true
           if ssl_certificate || ssl_private_key

data/lib/middleman-core/preview_server/server_information.rb CHANGED Viewed

@@ -20,6 +20,8 @@ module Middleman
       public
+      attr_writer :https
       def initialize(opts={})
         @resolver     = opts.fetch(:resolver, DnsResolver.new)
         @validator    = opts.fetch(:validator, ServerInformationValidator.new)
@@ -64,13 +66,15 @@ module Middleman
         @bind_address = config[:bind_address]
         @port         = config[:port]
         @server_name  = config[:server_name]
+        @https        = config[:https]
         config[:bind_address] = bind_address
-        config[:port] = port
-        config[:server_name] = server_name
+        config[:port]         = port
+        config[:server_name]  = server_name
+        config[:https]        = https?
       end
-      # Make information of internal server class avaible to make debugging
+      # Make information of internal server class available to make debugging
       # easier. This can be used to log the class which was used to determine
       # the preview server settings
       #
@@ -139,6 +143,11 @@ module Middleman
       def listeners
         information.listeners
       end
+      # Is https enabled?
+      def https?
+        @https == true
+      end
     end
   end
 end

data/lib/middleman-core/preview_server/server_information_callback_proxy.rb ADDED Viewed

@@ -0,0 +1,35 @@
+module Middleman
+  class PreviewServer
+    # This class wraps server information to be used in call back
+    #
+    # * listeners
+    # * port
+    # * server name
+    # * site_addresses
+    #
+    # All information is "dupped" and the callback is not meant to be used to
+    # modify these information.
+    class ServerInformationCallbackProxy
+      attr_reader :server_name, :port, :site_addresses, :listeners
+      def initialize(server_information)
+        @listeners   = ServerUrl.new(
+          hosts: server_information.listeners,
+          port: server_information.port,
+          https: server_information.https?,
+          format_output: false
+        ).to_bind_addresses
+        @port           = server_information.port
+        @server_name    = server_information.server_name.dup unless server_information.server_name == nil
+        @site_addresses = ServerUrl.new(
+          hosts: server_information.site_addresses,
+          port: server_information.port,
+          https: server_information.https?,
+          format_output: false
+        ).to_urls
+      end
+    end
+  end
+end