middleman-livereload 3.4.2 → 3.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 217907b3c501015710ffe9d761d85be9c911ea25
-  data.tar.gz: 0dfa34929cb855664d4c850615c481471900abab
+SHA256:
+  metadata.gz: ac51978c5650bf89df058f304a8dd7a5f42aeb360ca9eb8642ce8619d8f3ad9c
+  data.tar.gz: 6999099989b1fa0fa85096f623b2b10453819e62efa6c5b26584d4008999d68b
 SHA512:
-  metadata.gz: 482e8d1846e95ca2bbc92d0478550b91eec7b322c4dda2452252052373a829dd5f28fe73224ac442e36f21f49cb17ed1ed1a2e2fa9b7491ef8eb748474d059b9
-  data.tar.gz: 65da27476b7bddae0b62673047c89f078c86ed6e180759224005512e30cc2ef0c5704276fef6e3c00378a19b40e42ee8d2ecfe5ac8874e836d507d4de5b97578
+  metadata.gz: 74eed67bfc417007cb3998c767a464d998e8b30d521153471abd575b8a247c67c89d159470360f2c622255d8b58f229172e75a38353ade602fe35c2e8e89d67a
+  data.tar.gz: c54f7cf4d6f46337473512d02b664f1b3c25699173b1c559c134017ac94c2342003e908bf2cf191f7d6c819b634dff2922dfe9efb3716472f3ac37f0aea6e9b1

data/.devcontainer/Dockerfile

@@ -0,0 +1,20 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.166.1/containers/ruby/.devcontainer/base.Dockerfile
+
+# [Choice] Ruby version: 3, 3.0, 2, 2.7, 2.6, 2.5
+ARG VARIANT="3"
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+# [Option] Install Node.js
+ARG INSTALL_NODE="true"
+ARG NODE_VERSION="lts/*"
+RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,35 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.166.1/containers/ruby
+{
+	"name": "Ruby",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": { 
+			// Update 'VARIANT' to pick a Ruby version: 3, 3.0, 2, 2.7, 2.6, 2.5
+			"VARIANT": "2.7",
+			// Options
+			"INSTALL_NODE": "true",
+			"NODE_VERSION": "lts/*"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": { 
+		"terminal.integrated.shell.linux": "/bin/bash"
+	},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"rebornix.Ruby"
+	],
+	
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+
+}

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -1,9 +1,12 @@
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-  - jruby-19mode
-
+  - ruby-head
+  - 2.2.2
+  - 2.1
+  - 2.0
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
 gemfile:
   - Gemfile
 

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+(unreleased)
+===
+
+* Support secure sockets (WSS) with options for TLS certificate & private key.
+
 3.3.0
 ===
 

data/Gemfile

@@ -1,9 +1,6 @@
 source "https://rubygems.org"
 
-git "git://github.com/middleman/middleman.git", :branch => "v3-stable" do
-  # gem "middleman"
-  gem "middleman-core"
-end
+gem "middleman", github: "middleman/middleman", branch: "master"
 
 # Specify your gem's dependencies in middleman-blog.gemspec
 gemspec

data/README.md

@@ -11,7 +11,7 @@ gem install middleman
 middleman init MY_PROJECT
 ```
 
-If you already have a Middleman project: Add `gem "middleman-livereload", "~> 3.3.0"` to your `Gemfile` and run `bundle install`
+If you already have a Middleman project: Add `gem "middleman-livereload", "~> 3.4.3"` to your `Gemfile` and run `bundle install`
 
 ## Configuration
 
@@ -22,13 +22,17 @@ activate :livereload
 The extension supports a number of options that can be given to the `activate` statement. Eg:
 
 ```
-activate :livereload, :apply_js_live => false
+activate :livereload, apply_js_live: false
 ```
 
 #### `:host` and `:port`
 
 Livereload's listener host/port, these options get passed to ::Rack::LiveReload  middleware. Defaults:`'0.0.0.0'` and `'35729'`.
 
+#### `:js_host` and `:js_port`
+
+Similar to the `:host` and `:port` options, but allow you to specify a different host and port at the frontend Javascript level than at the backend EventMachine level. Useful when running behind a proxy or on a Docker VM. Defaults to `:host` and `:port`.
+
 #### `:apply_js_live` and `:apply_css_live`
 
 Whether live reload should attempt to reload javascript / css 'in-place', without complete reload of the page. Both default to `true`.
@@ -39,6 +43,26 @@ Whether live reload should attempt to reload javascript / css 'in-place', withou
 
 Disable Flash polyfil for browsers that support native WebSockets.
 
+#### `:ignore`
+
+Array of patterns for paths that must be ignored. These files will not be injected with the LiveReload script.
+
+`String#match` is used for ignoring, so you can use any valid Ruby regular expression in this array.
+
+#### `:livereload_css_target`
+
+CSS file to reload when detecting @imported partial was modified. Default `stylesheets/all.css`).  
+To opt out set `livereload_css_target: nil`.
+
+#### `:livereload_css_pattern`
+
+Regexp matching filenames that should trigger reload of :livereload_css_target when changed. Default: `Regexp.new('_.*\.css')`.
+
+#### `:wss_certificate` and `:wss_private_key`
+
+Support secure sockets (WSS) by passing TLS certificate & private key, for
+example if you're using `middleman server --https` in development.
+
 ## Build & Dependency Status
 
 [![Gem Version](https://badge.fury.io/rb/middleman-livereload.png)][gem]
@@ -48,7 +72,7 @@ Disable Flash polyfil for browsers that support native WebSockets.
 
 ## Community
 
-The official community forum is available at: http://forum.middlemanapp.com
+The official community forum is available at: https://forum.middlemanapp.com
 
 ## Bug Reports
 
@@ -71,9 +95,9 @@ The best way to get quick responses to your issues and swift fixes to your bugs
 
 Copyright (c) 2010-2013 Thomas Reynolds. MIT Licensed, see [LICENSE] for details.
 
-[middleman]: http://middlemanapp.com
+[middleman]: https://middlemanapp.com
 [gem]: https://rubygems.org/gems/middleman-livereload
-[travis]: http://travis-ci.org/middleman/middleman-livereload
+[travis]: https://travis-ci.org/middleman/middleman-livereload
 [gemnasium]: https://gemnasium.com/middleman/middleman-livereload
 [codeclimate]: https://codeclimate.com/github/middleman/middleman-livereload
 [LICENSE]: https://github.com/middleman/middleman-livereload/blob/master/LICENSE.md

data/Rakefile

@@ -1,6 +1,12 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
 require 'cucumber/rake/task'
 
 Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
@@ -14,7 +20,7 @@ end
 
 require 'rake/clean'
 
-task :test => ["cucumber"]
+task :test => ["spec", "cucumber"]
 
 desc "Build HTML documentation"
 task :doc do

data/lib/middleman-livereload/extension_3_1.rb

@@ -3,11 +3,18 @@ require 'middleman-livereload/reactor'
 
 module Middleman
   class LiveReloadExtension < Extension
-    option :port, '35729', 'Port to bind the LiveReload API server to'
+    option :port, '35729', 'Port to bind the LiveReload API server to listen to'
     option :apply_js_live, true, 'Apply JS changes live, without reloading'
     option :apply_css_live, true, 'Apply CSS changes live, without reloading'
     option :no_swf, false, 'Disable Flash WebSocket polyfill for browsers that support native WebSockets'
     option :host, Socket.ip_address_list.find(->{ Addrinfo.ip 'localhost' }, &:ipv4_private?).ip_address, 'Host to bind LiveReload API server to'
+    option :ignore, [], 'Array of patterns for paths that must be ignored'
+    option :js_port, nil, 'Port to connect the LiveReload Javascript to (if different than :port)'
+    option :js_host, nil, 'Host to connect LiveReload Javascript to (if different than :host)'
+    option :livereload_css_target, 'stylesheets/all.css', 'CSS file to load when a @imported CSS partials are modified'
+    option :livereload_css_pattern, Regexp.new('_.*\.css'), 'Regexp matching filenames that trigger live reloading target'
+    option :wss_certificate, nil, 'Path to an X.509 certificate to use for the websocket server'
+    option :wss_private_key, nil, 'Path to an RSA private key for the websocket certificate'
 
     def initialize(app, options_hash={}, &block)
       super
@@ -18,49 +25,62 @@ module Middleman
         return unless app.environment == :development
       end
 
-      @reactor = nil
-
       port = options.port.to_i
       host = options.host
+      js_port = options.js_port || port
+      js_host = options.js_host || host
       no_swf = options.no_swf
+      ignore = options.ignore
       options_hash = options.to_h
+      livereload_css_target = options.livereload_css_target
+      livereload_css_pattern = options.livereload_css_pattern
+
+      extension = self
 
       app.ready do
-        if @reactor
-          @reactor.app = self
-        else
-          @reactor = ::Middleman::LiveReload::Reactor.new(options_hash, self)
+        reactor = ::Middleman::LiveReload::Reactor.create(options_hash, self)
+
+        ignored = lambda do |file|
+          return true if app.files.respond_to?(:ignored?) && app.files.send(:ignored?, file)
+          ignore.any? { |i| file.to_s.match(i) }
         end
 
-        files.changed do |file|
-          next if files.respond_to?(:ignored?) && files.send(:ignored?, file)
+        app.files.changed do |file|
+          next if ignored.call(file)
 
           logger.debug "LiveReload: File changed - #{file}"
 
           reload_path = "#{Dir.pwd}/#{file}"
 
-          file_url = sitemap.file_to_path(file)
+          file_url = app.sitemap.file_to_path(file)
           if file_url
-            file_resource = sitemap.find_resource_by_path(file_url)
+            file_resource = app.sitemap.find_resource_by_path(file_url)
             if file_resource
               reload_path = file_resource.url
             end
           end
 
-          @reactor.reload_browser(reload_path)
+          # handle imported partials
+          # load target file instead of triggering full page refresh
+          if livereload_css_pattern.match(file.to_s) and not livereload_css_target.nil?
+            logger.info("LiveReload: CSS import changed, reloading target")
+            reload_path = livereload_css_target
+          end
+
+          reactor.reload_browser(reload_path)
         end
 
-        files.deleted do |file|
-          next if files.respond_to?(:ignored?) && files.send(:ignored?, file)
+        app.files.deleted do |file|
+          next if ignored.call(file)
 
           logger.debug "LiveReload: File deleted - #{file}"
 
-          @reactor.reload_browser("#{Dir.pwd}/#{file}")
+          reactor.reload_browser("#{Dir.pwd}/#{file}")
         end
 
         # Use the vendored livereload.js source rather than trying to get it from Middleman
         # https://github.com/johnbintz/rack-livereload#which-livereload-script-does-it-use
-        use ::Rack::LiveReload, :port => port, :host => host, :no_swf => no_swf, :source => :vendored
+        app.use ::Rack::LiveReload, port: js_port, host: js_host, no_swf: no_swf, source: :vendored, ignore: ignore
       end
     end
   end

data/lib/middleman-livereload/reactor.rb

@@ -1,24 +1,36 @@
 require 'em-websocket'
 require 'json'
+require 'middleman-livereload/wss'
 
 module Middleman
   module LiveReload
     class Reactor
       attr_reader :thread, :web_sockets, :app
 
+      def self.create(options, app)
+        if @reactor
+          @reactor.app = app
+        else
+          @reactor = new(options, app)
+        end
+
+        @reactor
+      end
+
       def initialize(options, app)
         @app = app
         @web_sockets = []
         @options     = options
         @thread      = start_threaded_reactor(options)
+        @mutex       = Thread::Mutex.new
       end
 
       def app= app
-        Thread.exclusive { @app = app }
+        @mutex.synchronize { @app = app }
       end
 
       def logger
-        Thread.exclusive { @app.logger }
+        @mutex.synchronize { @app.logger }
       end
 
       def stop
@@ -40,10 +52,11 @@ module Middleman
       end
 
       def start_threaded_reactor(options)
+        wss = Wss.new(@options[:wss_certificate], @options[:wss_private_key])
         Thread.new do
           EventMachine.run do
-            logger.info "== LiveReload accepting connections from http://#{options[:host]}:#{options[:port]}"
-            EventMachine.start_server(options[:host], options[:port], EventMachine::WebSocket::Connection, {}) do |ws|
+            logger.info "== LiveReload accepting connections from #{wss.scheme}://#{options[:host]}:#{options[:port]}"
+            EventMachine.start_server(options[:host], options[:port], EventMachine::WebSocket::Connection, wss.to_options) do |ws|
               ws.onopen do
                 begin
                   ws.send "!!ver:1.6"

data/lib/middleman-livereload/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module LiveReload
-    VERSION = "3.4.2"
+    VERSION = "3.4.7"
   end
 end

data/lib/middleman-livereload/wss.rb

@@ -0,0 +1,42 @@
+module Middleman
+  module LiveReload
+    class Wss
+      def initialize(certificate, private_key)
+        @certificate = certificate
+        @private_key = private_key
+        validate!
+      end
+
+      def valid?
+        @certificate && @private_key
+      end
+
+      def to_options
+        return {} unless valid?
+        {
+          secure: true,
+          tls_options: {
+            private_key_file: @private_key,
+            cert_chain_file: @certificate
+          }
+        }
+      end
+
+      def scheme
+        valid? ? "wss" : "ws"
+      end
+
+      private
+
+      def present?
+        @certificate || @private_key
+      end
+
+      def validate!
+        if present? && !valid?
+          raise ArgumentError.new, "You must provide both :wss_certificate and :wss_private_key"
+        end
+      end
+    end
+  end
+end

data/spec/middleman-livereload/wss_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+require "middleman-livereload/wss"
+
+module Middleman
+  module LiveReload
+    RSpec.describe Wss do
+      let(:wss) { Wss.new certificate, private_key }
+
+      it "prevents missing certificate or private_key" do
+        expect { Wss.new nil, "y" }.to raise_error(ArgumentError, /both :wss_certificate and :wss_private_key/)
+      end
+
+      describe "#scheme" do
+        subject { wss.scheme }
+
+        context "no certificate and no private key" do
+          let(:certificate) { nil }
+          let(:private_key) { nil }
+
+          it { is_expected.to eq "ws" }
+        end
+
+        context "certificate and private key" do
+          let(:certificate) { "x" }
+          let(:private_key) { "y" }
+
+          it { is_expected.to eq "wss" }
+        end
+      end
+
+      describe "#to_options" do
+        subject { wss.to_options }
+
+        context "no certificate and no private key" do
+          let(:certificate) { nil }
+          let(:private_key) { nil }
+
+          it { is_expected.to eq Hash.new }
+        end
+
+        context "certificate and private key" do
+          let(:certificate) { "x" }
+          let(:private_key) { "y" }
+          let(:options) do
+            {
+              secure: true,
+              tls_options: {
+                private_key_file: private_key,
+                cert_chain_file: certificate
+              }
+            }
+          end
+
+          it { is_expected.to eq options }
+        end
+      end
+
+      describe "#valid?" do
+        subject { wss.valid? }
+
+        context "no certificate and no private key" do
+          let(:certificate) { nil }
+          let(:private_key) { nil }
+
+          it { is_expected.to be_falsey }
+        end
+
+        context "certificate and private key" do
+          let(:certificate) { "x" }
+          let(:private_key) { "y" }
+
+          it { is_expected.to be_truthy }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-livereload
 version: !ruby/object:Gem::Version
-  version: 3.4.2
+  version: 3.4.7
 platform: ruby
 authors:
 - Thomas Reynolds
@@ -10,48 +10,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-26 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rack-livereload
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.15
 - !ruby/object:Gem::Dependency
   name: em-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
 description: LiveReload support for Middleman
@@ -63,8 +63,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -77,8 +80,11 @@ files:
 - lib/middleman-livereload/extension_3_1.rb
 - lib/middleman-livereload/reactor.rb
 - lib/middleman-livereload/version.rb
+- lib/middleman-livereload/wss.rb
 - lib/middleman_extension.rb
 - middleman-livereload.gemspec
+- spec/middleman-livereload/wss_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/middleman/middleman-livereload
 licenses:
 - MIT
@@ -89,21 +95,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: LiveReload support for Middleman
-test_files:
-- features/.gitkeep
-- fixtures/.gitkeep
-has_rdoc: 
+test_files: []