guard-livereload 2.4.0 → 2.5.0

data/Rakefile

@@ -1,5 +1,21 @@
 require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+require "rspec/core/rake_task"
+
+def ci?
+  ENV["CI"] == "true"
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = ci?
+end
+
+default_tasks = [:spec]
+
+unless ci?
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new(:rubocop)
+  default_tasks << :rubocop
+end
+
+task default: default_tasks

data/guard-livereload.gemspec

@@ -4,24 +4,23 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'guard/livereload/version'
 
 Gem::Specification.new do |s|
-  s.name         = "guard-livereload"
+  s.name         = 'guard-livereload'
   s.version      = Guard::LiveReloadVersion::VERSION
   s.author       = 'Thibaud Guillaume-Gentil'
   s.email        = 'thibaud@thibaud.me'
   s.summary      = 'Guard plugin for livereload'
   s.description  = "Guard::LiveReload automatically reloads your browser when 'view' files are modified."
   s.homepage     = 'https://rubygems.org/gems/guard-livereload'
-  s.license      = "MIT"
+  s.license      = 'MIT'
 
   s.files        = `git ls-files`.split($/)
   s.test_files   = s.files.grep(%r{^spec/})
   s.require_path = 'lib'
 
   s.add_dependency 'guard',        '~> 2.8'
+  s.add_dependency 'guard-compat', '~> 1.0'
   s.add_dependency 'em-websocket', '~> 0.5'
   s.add_dependency 'multi_json',   '~> 1.8'
 
   s.add_development_dependency 'bundler', '>= 1.3.5'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
 end

data/js/{livereload.js → livereload.js.erb}

@@ -1,3 +1,4 @@
+// <%= "guard-livereload options: #{options.inspect}" %>
  (function() {
    var __customevents = {}, __protocol = {}, __connector = {}, __timer = {}, __options = {}, __reloader = {}, __livereload = {}, __less = {}, __startup = {};
 
@@ -732,9 +733,9 @@
          return this.waitUntilCssLoads(clone, function() {
            var additionalWaitingTime;
            if (/AppleWebKit/.test(navigator.userAgent)) {
-           additionalWaitingTime = 5;
+             additionalWaitingTime = <%= options[:js_apple_webkit_extra_wait_time] || 5 %>;
            } else {
-             additionalWaitingTime = 200;
+             additionalWaitingTime = <%= options[:js_default_extra_wait_time] || 200 %>;
            }
            return _this.Timer.start(additionalWaitingTime, function() {
              var _ref;
@@ -1052,4 +1053,4 @@
    CustomEvents.bind(document, 'LiveReloadShutDown', function() {
      return LiveReload.shutDown();
    });
- })();
+ })();

data/lib/guard/livereload.rb

@@ -1,22 +1,28 @@
-require 'guard'
-require 'guard/plugin'
+require 'guard/compat/plugin'
 
 module Guard
   class LiveReload < Plugin
     require 'guard/livereload/websocket'
     require 'guard/livereload/reactor'
+    require 'guard/livereload/snippet'
 
     attr_accessor :reactor, :options
 
     def initialize(options = {})
       super
+
+      js_path = File.expand_path('../../../js/livereload.js.erb', __FILE__)
       @options = {
         host:           '0.0.0.0',
         port:           '35729',
         apply_css_live: true,
         override_url:   false,
-        grace_period:   0
+        grace_period:   0,
+        js_template: js_path
       }.merge(options)
+
+      js_path = @options[:js_template]
+      @options[:livereload_js_path] = Snippet.new(js_path, @options).path
     end
 
     def start
@@ -31,6 +37,5 @@ module Guard
       sleep options[:grace_period]
       reactor.reload_browser(paths)
     end
-
   end
 end

data/lib/guard/livereload/reactor.rb

@@ -18,19 +18,19 @@ module Guard
 
       def reload_browser(paths = [])
         msg = "Reloading browser: #{paths.join(' ')}"
-        UI.info msg
+        Compat::UI.info msg
         if options[:notify]
-          Notifier.notify(msg, title: 'Reloading browser', image: :success)
+          Compat::UI.notify(msg, title: 'Reloading browser', image: :success)
         end
 
         paths.each do |path|
           data = _data(path)
-          UI.debug(data)
+          Compat::UI.debug(data)
           web_sockets.each { |ws| ws.send(MultiJson.encode(data)) }
         end
       end
 
-    private
+      private
 
       def _data(path)
         data = {
@@ -45,20 +45,26 @@ module Guard
       end
 
       def _start_reactor
-        EventMachine.epoll
+        EventMachine.epoll  if EventMachine.epoll?
+        EventMachine.kqueue if EventMachine.kqueue?
         EventMachine.run do
-          EventMachine.start_server(options[:host], options[:port], WebSocket, {}) do |ws|
+          EventMachine.start_server(
+            options[:host],
+            options[:port],
+            WebSocket,
+            options
+          ) do |ws|
             ws.onopen    { _connect(ws) }
             ws.onclose   { _disconnect(ws) }
             ws.onmessage { |msg| _print_message(msg) }
           end
-          UI.info "LiveReload is waiting for a browser to connect."
+          Compat::UI.info 'LiveReload is waiting for a browser to connect.'
         end
       end
 
       def _connect(ws)
         @connections_count += 1
-        UI.info "Browser connected." if connections_count == 1
+        Compat::UI.info 'Browser connected.' if connections_count == 1
 
         ws.send MultiJson.encode(
           command:    'hello',
@@ -67,8 +73,8 @@ module Guard
         )
         @web_sockets << ws
       rescue
-        UI.error $!
-        UI.error $!.backtrace
+        Compat::UI.error $!
+        Compat::UI.error $!.backtrace
       end
 
       def _disconnect(ws)
@@ -77,9 +83,8 @@ module Guard
 
       def _print_message(message)
         message = MultiJson.decode(message)
-        UI.info "Browser URL: #{message['url']}" if message['command'] == 'url'
+        Compat::UI.info "Browser URL: #{message['url']}" if message['command'] == 'url'
       end
-
     end
   end
 end

data/lib/guard/livereload/snippet.rb

@@ -0,0 +1,23 @@
+require 'erb'
+require 'tempfile'
+
+require 'guard/compat/plugin'
+
+module Guard
+  class LiveReload < Plugin
+    class Snippet
+      attr_reader :path
+      attr_reader :options
+
+      def initialize(template, options)
+        @options = options # for ERB context
+        tmpfile = Tempfile.new('livereload.js')
+        source = IO.read(template)
+        data = ERB.new(source).result(binding)
+        tmpfile.write(data)
+        tmpfile.close
+        @path = tmpfile.path
+      end
+    end
+  end
+end

data/lib/guard/livereload/templates/Guardfile

@@ -1,8 +1,38 @@
 guard 'livereload' do
-  watch(%r{app/views/.+\.(erb|haml|slim)$})
+  extensions = {
+    css: :css,
+    scss: :css,
+    sass: :css,
+    js: :js,
+    coffee: :js,
+    html: :html,
+    png: :png,
+    gif: :gif,
+    jpg: :jpg,
+    jpeg: :jpeg,
+    # less: :less, # uncomment if you want LESS stylesheets done in browser
+  }
+
+  rails_view_exts = %w(erb haml slim)
+
+  # file types LiveReload may optimize refresh for
+  compiled_exts = extensions.values.uniq
+  watch(%r{public/.+\.(#{compiled_exts * '|'})})
+
+  extensions.each do |ext, type|
+    watch(%r{
+          (?:app|vendor)
+          (?:/assets/\w+/(?<path>[^.]+) # path+base without extension
+           (?<ext>\.#{ext})) # matching extension (must be first encountered)
+          (?:\.\w+|$) # other extensions
+          }x) do |m|
+      path = m[1]
+      "/assets/#{path}.#{type}"
+    end
+  end
+
+  # file needing a full reload of the page anyway
+  watch(%r{app/views/.+\.(#{rails_view_exts * '|'})$})
   watch(%r{app/helpers/.+\.rb})
-  watch(%r{public/.+\.(css|js|html)})
   watch(%r{config/locales/.+\.yml})
-  # Rails Assets Pipeline
-  watch(%r{(app|vendor)(/assets/\w+/(.+\.(css|js|html|png|jpg))).*}) { |m| "/assets/#{m[3]}" }
 end

data/lib/guard/livereload/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module LiveReloadVersion
-    VERSION = '2.4.0'
+    VERSION = '2.5.0'
   end
 end

data/lib/guard/livereload/websocket.rb

@@ -6,6 +6,10 @@ require 'uri'
 module Guard
   class LiveReload
     class WebSocket < EventMachine::WebSocket::Connection
+      def initialize(options)
+        @livereload_js_path = options[:livereload_js_path]
+        super
+      end
 
       def dispatch(data)
         parser = Http::Parser.new
@@ -14,14 +18,9 @@ module Guard
         request_path = '.' + URI.parse(parser.request_url).path
         request_path += '/index.html' if File.directory? request_path
         if parser.http_method != 'GET' || parser.upgrade?
-          super #pass the request to websocket
-        elsif request_path == './livereload.js'
-          _serve_file(_livereload_js_file)
-        elsif File.readable?(request_path) && !File.directory?(request_path)
-          _serve_file(request_path)
+          super # pass the request to websocket
         else
-          send_data("HTTP/1.1 404 Not Found\r\nContent-Type: text/plain\r\nContent-Length: 13\r\n\r\n404 Not Found")
-          close_connection_after_writing
+          _serve(request_path)
         end
       end
 
@@ -29,7 +28,15 @@ module Guard
 
       def _serve_file(path)
         UI.debug "Serving file #{path}"
-        send_data "HTTP/1.1 200 OK\r\nContent-Type: #{_content_type(path)}\r\nContent-Length: #{File.size path}\r\n\r\n"
+
+        data = [
+          'HTTP/1.1 200 OK',
+          'Content-Type: %s',
+          'Content-Length: %s',
+          '',
+          '']
+        data = format(data * "\r\n", _content_type(path), File.size(path))
+        send_data(data)
         stream_file_data(path).callback { close_connection_after_writing }
       end
 
@@ -45,10 +52,20 @@ module Guard
         end
       end
 
-      def _livereload_js_file
-        File.expand_path("../../../../js/livereload.js", __FILE__)
+      def _livereload_js_path
+        @livereload_js_path
       end
 
+      def _serve(path)
+        return _serve_file(_livereload_js_path) if path == './livereload.js'
+        return _serve_file(path) if _readable_file(path)
+        send_data("HTTP/1.1 404 Not Found\r\nContent-Type: text/plain\r\nContent-Length: 13\r\n\r\n404 Not Found")
+        close_connection_after_writing
+      end
+
+      def _readable_file(path)
+        File.readable?(path) && !File.directory?(path)
+      end
     end
   end
 end

data/spec/lib/guard/livereload/reactor_spec.rb

@@ -1,28 +1,32 @@
-require 'spec_helper'
-
-describe Guard::LiveReload::Reactor do
+RSpec.describe Guard::LiveReload::Reactor do
   let(:paths) { %w[stylesheets/layout.css stylesheets/style.css] }
-  before { allow(Guard::UI).to receive(:info) }
 
-  describe "#reload_browser(paths = [])" do
-    it "displays a message" do
-      expect(Guard::UI).to receive(:info).
+  before do
+    allow(Guard::Compat::UI).to receive(:info)
+    allow(Guard::Compat::UI).to receive(:debug)
+    allow(Guard::Compat::UI).to receive(:error)
+    allow(Guard::Compat::UI).to receive(:warning)
+  end
+
+  describe '#reload_browser(paths = [])' do
+    it 'displays a message' do
+      expect(Guard::Compat::UI).to receive(:info).
         with('Reloading browser: stylesheets/layout.css stylesheets/style.css')
       new_live_reactor.reload_browser(paths)
     end
 
     it 'by default does not send notification' do
-      expect(::Guard::Notifier).to_not receive(:notify)
+      expect(Guard::Compat::UI).to_not receive(:notify)
       new_live_reactor.reload_browser(paths)
     end
 
     it 'optionally pushes notification' do
-      expect(::Guard::Notifier).to receive(:notify).
+      expect(Guard::Compat::UI).to receive(:notify).
         with(kind_of(String), have_key(:title))
       new_live_reactor(notify: true).reload_browser(paths)
     end
 
-    it "each web socket receives send with data containing default options for each path modified" do
+    it 'each web socket receives send with data containing default options for each path modified' do
       reactor = new_live_reactor
       paths.each do |path|
         reactor.web_sockets.each do |ws|
@@ -32,7 +36,7 @@ describe Guard::LiveReload::Reactor do
       reactor.reload_browser(paths)
     end
 
-    it "each web socket receives send with data containing custom options for each path modified" do
+    it 'each web socket receives send with data containing custom options for each path modified' do
       reactor = new_live_reactor(apply_css_live: false, apply_js_live: false)
       paths.each do |path|
         reactor.web_sockets.each do |ws|
@@ -43,20 +47,20 @@ describe Guard::LiveReload::Reactor do
     end
   end
 
-  describe "#_connect(ws)" do
+  describe '#_connect(ws)' do
     let(:ws)      { double.as_null_object }
     let(:reactor) { new_live_reactor }
 
-    it "displays a message once" do
-      expect(Guard::UI).to receive(:info).with("Browser connected.").once
+    it 'displays a message once' do
+      expect(Guard::Compat::UI).to receive(:info).with('Browser connected.').once
       reactor.send(:_connect, ws)
       reactor.send(:_connect, ws)
     end
 
-    it "increments the connection count" do
-      expect {
+    it 'increments the connection count' do
+      expect do
         reactor.send(:_connect, ws)
-      }.to change { reactor.connections_count }.from(0).to 1
+      end.to change { reactor.connections_count }.from(0).to 1
     end
   end
 

data/spec/lib/guard/livereload/snippet_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe Guard::LiveReload::Snippet do
+  let(:options) { { foo: :bar } }
+
+  let(:template) { '/foo/livereload.js.erb' }
+  let(:contents) { '// <%= options[:foo] %>' }
+
+  subject { described_class.new(template, options) }
+
+  let(:tmpfile) { instance_double(Tempfile) }
+
+  before do
+    allow(File).to receive(:expand_path) do |*args|
+      fail "stub called for File.expand_path(#{args.map(&:inspect) * ','})"
+    end
+
+    allow(IO).to receive(:read) do |*args|
+      fail "stub called for IO.read(#{args.map(&:inspect) * ','})"
+    end
+
+    allow(IO).to receive(:read).with(template).and_return(contents)
+
+    allow(Tempfile).to receive(:new).and_return(tmpfile)
+    allow(tmpfile).to receive(:path).and_return('/tmp/livereload-123')
+    allow(tmpfile).to receive(:write)
+    allow(tmpfile).to receive(:close)
+  end
+
+  describe '#initialize' do
+    it 'evaluates the js snippet file' do
+      expect(tmpfile).to receive(:write).with('// bar')
+      subject
+    end
+
+    it 'closes the tmpfile' do
+      expect(tmpfile).to receive(:close)
+      subject
+    end
+  end
+
+  describe '#path' do
+    it 'is set to a tmpfile with the ERB result' do
+      expect(subject.path).to eq '/tmp/livereload-123'
+    end
+  end
+end