middleman-core-with-external-sources-watch-fix 4.1.0

data/lib/middleman-core/extensions/cache_buster.rb

@@ -0,0 +1,23 @@
+# The Cache Buster extension
+class Middleman::Extensions::CacheBuster < ::Middleman::Extension
+  option :exts, %w(.css .png .jpg .jpeg .webp .svg .svgz .js .gif), 'List of extensions that get cache busters strings appended to them.'
+  option :sources, %w(.css .htm .html .js .php .xhtml), 'List of extensions that are searched for bustable assets.'
+  option :ignore, [], 'Regexes of filenames to skip adding query strings to'
+  option :rewrite_ignore, [], 'Regexes of filenames to skip processing for path rewrites'
+
+  def initialize(app, options_hash={}, &block)
+    super
+
+    app.rewrite_inline_urls id: :cache_buster,
+                            url_extensions: options.exts,
+                            source_extensions: options.sources,
+                            ignore: options.ignore,
+                            rewrite_ignore: options.rewrite_ignore,
+                            proc: method(:rewrite_url)
+  end
+
+  Contract String, Or[String, Pathname], Any => String
+  def rewrite_url(asset_path, _dirpath, _request_path)
+    asset_path + '?' + Time.now.strftime('%s')
+  end
+end

data/lib/middleman-core/extensions/directory_indexes.rb

@@ -0,0 +1,26 @@
+# Directory Indexes extension
+class Middleman::Extensions::DirectoryIndexes < ::Middleman::Extension
+  # This should run after most other sitemap manipulators so that it
+  # gets a chance to modify any new resources that get added.
+  self.resource_list_manipulator_priority = 100
+
+  # Update the main sitemap resource list
+  # @return Array<Middleman::Sitemap::Resource>
+  Contract ResourceList => ResourceList
+  def manipulate_resource_list(resources)
+    index_file = app.config[:index_file]
+    new_index_path = "/#{index_file}"
+
+    resources.each do |resource|
+      # Check if it would be pointless to reroute
+      next if resource.destination_path == index_file ||
+              resource.destination_path.end_with?(new_index_path) ||
+              File.extname(index_file) != resource.ext
+
+      # Check if file metadata (options set by "page" in config.rb or frontmatter) turns directory_index off
+      next if resource.options[:directory_index] == false
+
+      resource.destination_path = resource.destination_path.chomp(File.extname(index_file)) + new_index_path
+    end
+  end
+end

data/lib/middleman-core/extensions/external_pipeline.rb

@@ -0,0 +1,42 @@
+class Middleman::Extensions::ExternalPipeline < ::Middleman::Extension
+  self.supports_multiple_instances = true
+
+  option :name, nil, 'The name of the pipeline', required: true
+  option :command, nil, 'The command to initialize', required: true
+  option :source, nil, 'Path to merge into sitemap', required: true
+  option :latency, 0.25, 'Latency between refreshes of source'
+  option :disable_background_execution, false, "Don't run the command in a separate background thread"
+
+  def initialize(app, config={}, &block)
+    super
+
+    require 'thread'
+
+    @watcher = app.files.watch :source,
+                               path: File.expand_path(options[:source], app.root),
+                               latency: options[:latency],
+                               frontmatter: false
+
+    logger.info "== Executing: `#{options[:command]}`"
+
+    if app.build? || options[:disable_background_execution]
+      watch_command!
+    else
+      ::Thread.new { watch_command! }
+    end
+  end
+
+  def watch_command!
+    ::IO.popen(options[:command], 'r') do |pipe|
+      while buf = pipe.gets
+        without_newline = buf.sub(/\n$/, '')
+        logger.info "== External: #{without_newline}" if without_newline.length > 0
+      end
+    end
+
+    @watcher.poll_once!
+  rescue ::Errno::ENOENT => e
+    logger.error "== External: Command failed with message: #{e.message}"
+    exit(1)
+  end
+end

data/lib/middleman-core/extensions/gzip.rb

@@ -0,0 +1,114 @@
+# This extension Gzips assets and pages when building.
+# Gzipped assets and pages can be served directly by Apache or
+# Nginx with the proper configuration, and pre-zipping means that we
+# can use a more agressive compression level at no CPU cost per request.
+#
+# Use Nginx's gzip_static directive, or AddEncoding and mod_rewrite in Apache
+# to serve your Gzipped files whenever the normal (non-.gz) filename is requested.
+#
+# Pass the :exts options to customize which file extensions get zipped (defaults
+# to .css, .htm, .html, .js, and .xhtml
+#
+class Middleman::Extensions::Gzip < ::Middleman::Extension
+  option :exts, %w(.css .htm .html .js .svg .xhtml), 'File extensions to Gzip when building.'
+  option :ignore, [], 'Patterns to avoid gzipping'
+  option :overwrite, false, 'Overwrite original files instead of adding .gz extension.'
+
+  class NumberHelpers
+    include ::Padrino::Helpers::NumberHelpers
+  end
+
+  def initialize(app, options_hash={})
+    super
+
+    require 'zlib'
+    require 'stringio'
+    require 'find'
+    require 'thread'
+  end
+
+  def after_build(builder)
+    num_threads = 4
+    paths = ::Middleman::Util.all_files_under(app.config[:build_dir])
+    total_savings = 0
+
+    # Fill a queue with inputs
+    in_queue = Queue.new
+    paths.each do |path|
+      in_queue << path if should_gzip?(path)
+    end
+    num_paths = in_queue.size
+
+    # Farm out gzip tasks to threads and put the results in in_queue
+    out_queue = Queue.new
+    num_threads.times.each do
+      Thread.new do
+        while path = in_queue.pop
+          out_queue << gzip_file(path.to_s)
+        end
+      end
+    end
+
+    # Insert a nil for each thread to stop it
+    num_threads.times do
+      in_queue << nil
+    end
+
+    old_locale = I18n.locale
+    I18n.locale = :en # use the english localizations for printing out file sizes to make sure the localizations exist
+
+    num_paths.times do
+      output_filename, old_size, new_size = out_queue.pop
+
+      next unless output_filename
+
+      total_savings += (old_size - new_size)
+      size_change_word = (old_size - new_size) > 0 ? 'smaller' : 'larger'
+      builder.trigger :created, "#{output_filename} (#{NumberHelpers.new.number_to_human_size((old_size - new_size).abs)} #{size_change_word})"
+    end
+
+    builder.trigger :gzip, '', "Total gzip savings: #{NumberHelpers.new.number_to_human_size(total_savings)}"
+    I18n.locale = old_locale
+  end
+
+  Contract String => [Maybe[String], Maybe[Num], Maybe[Num]]
+  def gzip_file(path)
+    input_file = File.open(path, 'rb').read
+    output_filename = options.overwrite ? path : path + '.gz'
+    input_file_time = File.mtime(path)
+
+    # Check if the right file's already there
+    if !options.overwrite && File.exist?(output_filename) && File.mtime(output_filename) == input_file_time
+      return [nil, nil, nil]
+    end
+
+    File.open(output_filename, 'wb') do |f|
+      gz = Zlib::GzipWriter.new(f, Zlib::BEST_COMPRESSION)
+      gz.mtime = input_file_time.to_i
+      gz.write input_file
+      gz.close
+    end
+
+    # Make the file times match, both for Nginx's gzip_static extension
+    # and so we can ID existing files. Also, so even if the GZ files are
+    # wiped out by build --clean and recreated, we won't rsync them over
+    # again because they'll end up with the same mtime.
+    File.utime(File.atime(output_filename), input_file_time, output_filename)
+
+    old_size = File.size(path)
+    new_size = File.size(output_filename)
+
+    [output_filename, old_size, new_size]
+  end
+
+  private
+
+  # Whether a path should be gzipped
+  # @param [Pathname] path A destination path
+  # @return [Boolean]
+  Contract Pathname => Bool
+  def should_gzip?(path)
+    path = path.sub app.config[:build_dir] + '/', ''
+    options.exts.include?(path.extname) && options.ignore.none? { |ignore| Middleman::Util.path_match(ignore, path.to_s) }
+  end
+end

data/lib/middleman-core/extensions/lorem.rb

@@ -0,0 +1,176 @@
+class Middleman::Extensions::Lorem < ::Middleman::Extension
+  helpers do
+    # Access to the Lorem object
+    # @return [Middleman::Extensions::Lorem::LoremObject]
+    def lorem
+      LoremObject
+    end
+
+    # Return a placeholder image using placekitten.com
+    #
+    # @param [String] size
+    # @param [Hash] options
+    # @return [String]
+    def placekitten(size, options={})
+      options[:domain] = 'http://placekitten.com'
+      lorem.image(size, options)
+    end
+  end
+
+  # Adapted from Frank:
+  # https://github.com/blahed/frank/
+  # Copyright (c) 2010 Travis Dunn
+  #
+  #   Permission is hereby granted, free of charge, to any person
+  #   obtaining a copy of this software and associated documentation
+  #   files (the "Software"), to deal in the Software without
+  #   restriction, including without limitation the rights to use,
+  #   copy, modify, merge, publish, distribute, sublicense, and/or sell
+  #   copies of the Software, and to permit persons to whom the
+  #   Software is furnished to do so, subject to the following
+  #   conditions:
+  #
+  #   The above copyright notice and this permission notice shall be
+  #   included in all copies or substantial portions of the Software.
+  #
+  #   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  #   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+  #   OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  #   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+  #   HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+  #   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  #   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+  #   OTHER DEALINGS IN THE SOFTWARE.
+  module LoremObject
+    class << self
+      # Words for use in lorem text
+      WORDS = %w(alias consequatur aut perferendis sit voluptatem accusantium doloremque aperiam eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo aspernatur aut odit aut fugit sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt neque dolorem ipsum quia dolor sit amet consectetur adipisci velit sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem ut enim ad minima veniam quis nostrum exercitationem ullam corporis nemo enim ipsam voluptatem quia voluptas sit suscipit laboriosam nisi ut aliquid ex ea commodi consequatur quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae et iusto odio dignissimos ducimus qui blanditiis praesentium laudantium totam rem voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident sed ut perspiciatis unde omnis iste natus error similique sunt in culpa qui officia deserunt mollitia animi id est laborum et dolorum fuga et harum quidem rerum facilis est et expedita distinctio nam libero tempore cum soluta nobis est eligendi optio cumque nihil impedit quo porro quisquam est qui minus id quod maxime placeat facere possimus omnis voluptas assumenda est omnis dolor repellendus temporibus autem quibusdam et aut consequatur vel illum qui dolorem eum fugiat quo voluptas nulla pariatur at vero eos et accusamus officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae itaque earum rerum hic tenetur a sapiente delectus ut aut reiciendis voluptatibus maiores doloribus asperiores repellat).freeze
+
+      # Get one placeholder word
+      # @return [String]
+      def word
+        words(1)
+      end
+
+      # Get some number of placeholder words
+      # @param [Fixnum] total
+      # @return [String]
+      def words(total)
+        (1..total).map do
+          randm(WORDS)
+        end.join(' ')
+      end
+
+      # Get one placeholder sentence
+      # @return [String]
+      def sentence
+        sentences(1)
+      end
+
+      # Get some number of placeholder sentences
+      # @param [Fixnum] total
+      # @return [String]
+      def sentences(total)
+        (1..total).map do
+          words(randm(4..15)).capitalize
+        end.join('. ')
+      end
+
+      # Get one placeholder paragraph
+      # @return [String]
+      def paragraph
+        paragraphs(1)
+      end
+
+      # Get some number of placeholder paragraphs
+      # @param [Fixnum] total
+      # @return [String]
+      def paragraphs(total)
+        (1..total).map do
+          sentences(randm(3..7)).capitalize
+        end.join("\n\n")
+      end
+
+      # Get a placeholder date
+      # @param [String] fmt
+      # @return [String]
+      def date(fmt='%a %b %d, %Y')
+        y = rand(20) + 1990
+        m = rand(12) + 1
+        d = rand(31) + 1
+        Time.local(y, m, d).strftime(fmt)
+      end
+
+      # Get a placeholder name
+      # @return [String]
+      def name
+        "#{first_name} #{last_name}"
+      end
+
+      # Get a placeholder first name
+      # @return [String]
+      def first_name
+        names = 'Judith Angelo Margarita Kerry Elaine Lorenzo Justice Doris Raul Liliana Kerry Elise Ciaran Johnny Moses Davion Penny Mohammed Harvey Sheryl Hudson Brendan Brooklynn Denis Sadie Trisha Jacquelyn Virgil Cindy Alexa Marianne Giselle Casey Alondra Angela Katherine Skyler Kyleigh Carly Abel Adrianna Luis Dominick Eoin Noel Ciara Roberto Skylar Brock Earl Dwayne Jackie Hamish Sienna Nolan Daren Jean Shirley Connor Geraldine Niall Kristi Monty Yvonne Tammie Zachariah Fatima Ruby Nadia Anahi Calum Peggy Alfredo Marybeth Bonnie Gordon Cara John Staci Samuel Carmen Rylee Yehudi Colm Beth Dulce Darius inley Javon Jason Perla Wayne Laila Kaleigh Maggie Don Quinn Collin Aniya Zoe Isabel Clint Leland Esmeralda Emma Madeline Byron Courtney Vanessa Terry Antoinette George Constance Preston Rolando Caleb Kenneth Lynette Carley Francesca Johnnie Jordyn Arturo Camila Skye Guy Ana Kaylin Nia Colton Bart Brendon Alvin Daryl Dirk Mya Pete Joann Uriel Alonzo Agnes Chris Alyson Paola Dora Elias Allen Jackie Eric Bonita Kelvin Emiliano Ashton Kyra Kailey Sonja Alberto Ty Summer Brayden Lori Kelly Tomas Joey Billie Katie Stephanie Danielle Alexis Jamal Kieran Lucinda Eliza Allyson Melinda Alma Piper Deana Harriet Bryce Eli Jadyn Rogelio Orlaith Janet Randal Toby Carla Lorie Caitlyn Annika Isabelle inn Ewan Maisie Michelle Grady Ida Reid Emely Tricia Beau Reese Vance Dalton Lexi Rafael Makenzie Mitzi Clinton Xena Angelina Kendrick Leslie Teddy Jerald Noelle Neil Marsha Gayle Omar Abigail Alexandra Phil Andre Billy Brenden Bianca Jared Gretchen Patrick Antonio Josephine Kyla Manuel Freya Kellie Tonia Jamie Sydney Andres Ruben Harrison Hector Clyde Wendell Kaden Ian Tracy Cathleen Shawn'.split(' ')
+        names[rand(names.size)]
+      end
+
+      # Get a placeholder last name
+      # @return [String]
+      def last_name
+        names = "Chung Chen Melton Hill Puckett Song Hamilton Bender Wagner McLaughlin McNamara Raynor Moon Woodard Desai Wallace Lawrence Griffin Dougherty Powers May Steele Teague Vick Gallagher Solomon Walsh Monroe Connolly Hawkins Middleton Goldstein Watts Johnston Weeks Wilkerson Barton Walton Hall Ross Chung Bender Woods Mangum Joseph Rosenthal Bowden Barton Underwood Jones Baker Merritt Cross Cooper Holmes Sharpe Morgan Hoyle Allen Rich Rich Grant Proctor Diaz Graham Watkins Hinton Marsh Hewitt Branch Walton O'Brien Case Watts Christensen Parks Hardin Lucas Eason Davidson Whitehead Rose Sparks Moore Pearson Rodgers Graves Scarborough Sutton Sinclair Bowman Olsen Love McLean Christian Lamb James Chandler Stout Cowan Golden Bowling Beasley Clapp Abrams Tilley Morse Boykin Sumner Cassidy Davidson Heath Blanchard McAllister McKenzie Byrne Schroeder Griffin Gross Perkins Robertson Palmer Brady Rowe Zhang Hodge Li Bowling Justice Glass Willis Hester Floyd Graves Fischer Norman Chan Hunt Byrd Lane Kaplan Heller May Jennings Hanna Locklear Holloway Jones Glover Vick O'Donnell Goldman McKenna Starr Stone McClure Watson Monroe Abbott Singer Hall Farrell Lucas Norman Atkins Monroe Robertson Sykes Reid Chandler Finch Hobbs Adkins Kinney Whitaker Alexander Conner Waters Becker Rollins Love Adkins Black Fox Hatcher Wu Lloyd Joyce Welch Matthews Chappell MacDonald Kane Butler Pickett Bowman Barton Kennedy Branch Thornton McNeill Weinstein Middleton Moss Lucas Rich Carlton Brady Schultz Nichols Harvey Stevenson Houston Dunn West O'Brien Barr Snyder Cain Heath Boswell Olsen Pittman Weiner Petersen Davis Coleman Terrell Norman Burch Weiner Parrott Henry Gray Chang McLean Eason Weeks Siegel Puckett Heath Hoyle Garrett Neal Baker Goldman Shaffer Choi Carver".split(' ')
+        names[rand(names.size)]
+      end
+
+      # Get a placeholder 140 character tweet about Philip the Purple Otter
+      # Via http://www.kevadamson.com/talking-of-design/article/140-alternative-characters-to-lorem-ipsum
+      # @return [String]
+      def tweet
+        tweets = ['Far away, in a forest next to a river beneath the mountains, there lived a small purple otter called Philip. Philip likes sausages. The End.',
+                  'He liked the quality sausages from Marks & Spencer but due to the recession he had been forced to shop in a less desirable supermarket. End.',
+                  'He awoke one day to find his pile of sausages missing. Roger the greedy boar with human eyes, had skateboarded into the forest & eaten them!']
+        tweets[rand(tweets.size)]
+      end
+
+      # Get a placeholder email address
+      # @return [String]
+      def email
+        delimiters = ['_', '-', '']
+        domains = %w(gmail.com yahoo.com hotmail.com email.com live.com me.com mac.com aol.com fastmail.com mail.com)
+        username = name.gsub(/[^\w]/, delimiters[rand(delimiters.size)])
+        "#{username}@#{domains[rand(domains.size)]}".downcase
+      end
+
+      # Get a placeholder image, using placehold.it by default
+      # @param [String] size
+      # @param [Hash] options
+      # @return [String]
+      def image(size, options={})
+        domain           = options[:domain] || 'http://placehold.it'
+        src              = "#{domain}/#{size}"
+        hex              = %w(a b c d e f 0 1 2 3 4 5 6 7 8 9)
+        background_color = options[:background_color]
+        color            = options[:color]
+
+        if options[:random_color]
+          background_color = hex.sample(6).join
+          color = hex.sample(6).join
+        end
+
+        src << "/#{background_color.sub(/^#/, '')}" if background_color
+        src << '/ccc' if background_color.nil? && color
+        src << "/#{color.sub(/^#/, '')}" if color
+        src << "&text=#{Rack::Utils.escape(options[:text])}" if options[:text]
+
+        src
+      end
+
+      # Pick a random item from a given range
+      # @param [Range] range
+      # @return [Object]
+      def randm(range)
+        a = range.to_a
+        a[rand(a.length)]
+      end
+    end
+  end
+end

data/lib/middleman-core/extensions/minify_css.rb

@@ -0,0 +1,118 @@
+require 'middleman-core/contracts'
+
+# Minify CSS Extension
+class Middleman::Extensions::MinifyCss < ::Middleman::Extension
+  option :inline, false, 'Whether to minify CSS inline within HTML files'
+  option :ignore, [], 'Patterns to avoid minifying'
+  option :compressor, proc {
+    require 'sass'
+    SassCompressor
+  }, 'Set the CSS compressor to use.'
+  option :content_types, %w(text/css), 'Content types of resources that contain CSS'
+  option :inline_content_types, %w(text/html text/php), 'Content types of resources that contain inline CSS'
+
+  def ready
+    # Setup Rack middleware to minify CSS
+    app.use Rack, compressor: options[:compressor],
+                  ignore: Array(options[:ignore]) + [/\.min\./],
+                  inline: options[:inline],
+                  content_types: options[:content_types],
+                  inline_content_types: options[:inline_content_types]
+  end
+
+  class SassCompressor
+    def self.compress(style, options={})
+      root_node = ::Sass::SCSS::CssParser.new(style, 'middleman-css-input', 1).parse
+      root_node.options = {}.merge!(options).merge!(style: :compressed)
+      root_node.render.strip
+    end
+  end
+
+  # Rack middleware to look for CSS and compress it
+  class Rack
+    include Contracts
+    INLINE_CSS_REGEX = /(<style[^>]*>\s*(?:\/\*<!\[CDATA\[\*\/\n)?)(.*?)((?:(?:\n\s*)?\/\*\]\]>\*\/)?\s*<\/style>)/m
+
+    # Init
+    # @param [Class] app
+    # @param [Hash] options
+    Contract RespondTo[:call], {
+      ignore: ArrayOf[PATH_MATCHER],
+      inline: Bool,
+      compressor: Or[Proc, RespondTo[:to_proc], RespondTo[:compress]]
+    } => Any
+    def initialize(app, options={})
+      @app = app
+      @ignore = options.fetch(:ignore)
+      @inline = options.fetch(:inline)
+
+      @compressor = options.fetch(:compressor)
+      @compressor = @compressor.to_proc if @compressor.respond_to? :to_proc
+      @compressor = @compressor.call if @compressor.is_a? Proc
+      @content_types = options[:content_types]
+      @inline_content_types = options[:inline_content_types]
+    end
+
+    # Rack interface
+    # @param [Rack::Environmemt] env
+    # @return [Array]
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      content_type = headers['Content-Type'].try(:slice, /^[^;]*/)
+      path = env['PATH_INFO']
+
+      minified = if @inline && minifiable_inline?(content_type)
+        minify_inline(::Middleman::Util.extract_response_text(response))
+      elsif minifiable?(content_type) && !ignore?(path)
+        minify(::Middleman::Util.extract_response_text(response))
+      end
+
+      if minified
+        headers['Content-Length'] = ::Rack::Utils.bytesize(minified).to_s
+        response = [minified]
+      end
+
+      [status, headers, response]
+    end
+
+    private
+
+    # Whether the path should be ignored
+    # @param [String] path
+    # @return [Boolean]
+    def ignore?(path)
+      @ignore.any? { |ignore| Middleman::Util.path_match(ignore, path) }
+    end
+
+    # Whether this type of content can be minified
+    # @param [String, nil] content_type
+    # @return [Boolean]
+    def minifiable?(content_type)
+      @content_types.include?(content_type)
+    end
+
+    # Whether this type of content contains inline content that can be minified
+    # @param [String, nil] content_type
+    # @return [Boolean]
+    def minifiable_inline?(content_type)
+      @inline_content_types.include?(content_type)
+    end
+
+    # Minify the content
+    # @param [String] content
+    # @return [String]
+    def minify(content)
+      @compressor.compress(content)
+    end
+
+    # Detect and minify inline content
+    # @param [String] content
+    # @return [String]
+    def minify_inline(content)
+      content.gsub(INLINE_CSS_REGEX) do
+        $1 + minify($2) + $3
+      end
+    end
+  end
+end