hawkins 2.0.2 → 2.0.3

data/lib/hawkins/liveserve.rb

@@ -6,8 +6,7 @@ module Hawkins
       class << self
         COMMAND_OPTIONS = {
           "swf"      => ["--swf", "Use Flash for WebSockets support"],
-          # TODO Should probably only accept fnmatch-esque strings and convert them to regexs
-          "ignore"   => ["--ignore [REGEX]", "Files not to reload"],
+          "ignore"   => ["--ignore GLOB1[,GLOB2[,...]]", "Files not to reload"],
           "min_delay" => ["--min-delay [SECONDS]", "Minimum reload delay"],
           "max_delay" => ["--max-delay [SECONDS]", "Maximum reload delay"],
           "reload_port" => ["--reload-port [PORT]", Integer, "Port for LiveReload to listen on"],
@@ -30,9 +29,7 @@ module Hawkins
             end
 
             cmd.action do |_, opts|
-              # TODO need to figure out how to set defaults correctly
               opts["reload_port"] ||= LIVERELOAD_PORT
-
               opts["serving"] = true
               opts["watch"] = true unless opts.key?("watch")
               start(opts)
@@ -41,19 +38,22 @@ module Hawkins
         end
 
         def start(opts)
-          opts = configuration_from_options(opts)
-
-          @running = Queue.new
-          @reload_reactor = LiveReloadReactor.new(opts)
-          @reload_reactor.start
+          config = opts["config"]
+          @reload_reactor = nil
+          register_reload_hooks(opts)
           Jekyll::Commands::Build.process(opts)
+          opts["config"] = config
           LiveServe.process(opts)
         end
 
         def process(opts)
+          opts = configuration_from_options(opts)
           destination = opts["destination"]
           setup(destination)
 
+          @running = Queue.new
+          @reload_reactor.start(opts)
+
           @server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
 
           @server.mount("#{opts['baseurl']}/__livereload",
@@ -73,6 +73,38 @@ module Hawkins
           @server.shutdown if running?
         end
 
+        private
+        def register_reload_hooks(opts)
+          require_relative "websockets"
+          @reload_reactor = LiveReloadReactor.new
+
+          Jekyll::Hooks.register(:site, :post_render) do |site|
+            regenerator = Jekyll::Regenerator.new(site)
+            @changed_pages = site.pages.select do |p|
+              regenerator.regenerate?(p)
+            end
+          end
+
+          # A note on ignoring files: LiveReload errs on the side of reloading when it
+          # comes to the message it gets.  If, for example, a page is ignored but a CSS
+          # file linked in the page isn't, the page will still be reloaded if the CSS
+          # file is contained in the message sent to LiveReload.  Additionally, the
+          # path matching is very loose so that a message to reload "/" will always
+          # lead the page to reload since every page starts with "/".
+          Jekyll::Hooks.register(:site, :post_write) do
+            unless @changed_pages.nil? || !@reload_reactor.running?
+              ignore, @changed_pages = @changed_pages.partition do |p|
+                Array(opts["ignore"]).any? do |filter|
+                  File.fnmatch(filter, Jekyll.sanitized_path(p.relative_path))
+                end
+              end
+              Jekyll.logger.debug "LiveReload:", "Ignoring #{ignore.map(&:relative_path)}"
+              @reload_reactor.reload(@changed_pages)
+            end
+            @changed_pages = nil
+          end
+        end
+
         # Do a base pre-setup of WEBRick so that everything is in place
         # when we get ready to party, checking for an setting up an error page
         # and making sure our destination exists.

data/lib/hawkins/post.rb

@@ -63,6 +63,7 @@ module Hawkins
 
           content = <<-CONTENT
             ---
+            layout: post
             title: #{title}
             ---
           CONTENT

data/lib/hawkins/servlet.rb

@@ -18,7 +18,7 @@ module Hawkins
         end
 
         def skip_processing?
-          !html? || chunked? || inline? || ignored? || bad_browser?
+          !html? || chunked? || inline? || bad_browser?
         end
 
         def chunked?
@@ -29,11 +29,6 @@ module Hawkins
           @res['Content-Disposition'] =~ %r{^inline}
         end
 
-        def ignored?
-          path = @req.query_string.nil? ? @req.path_info : "#{@req.path_info}?#{@req.query_string}"
-          @options["ignore"] && @options["ignore"].any? { |filter| path[filter] }
-        end
-
         def bad_browser?
           BAD_USER_AGENTS.any? { |pattern| @req['User-Agent'] =~ pattern }
         end
@@ -63,12 +58,17 @@ module Hawkins
         end
 
         def process!
+          # @body will usually be a File object but Strings occur in rare cases
+          # that occur for reasons unknown to me.
           @new_body = []
-          begin
-            @body.each { |line| @new_body << line.to_s }
-          ensure
-            # @body will be a File object
-            @body.close
+          if @body.respond_to?(:each)
+            begin
+              @body.each { |line| @new_body << line.to_s }
+            ensure
+              @body.close
+            end
+          else
+            @new_body = @body.lines
           end
 
           @content_length = 0
@@ -102,19 +102,12 @@ module Hawkins
             <script type="text/javascript" src="<%= @options["baseurl"] %>/__livereload/web_socket.js"></script>
           <% end %>
           <script type="text/javascript">
-            HAWKINS_LIVERELOAD_PORT = <%= @options["reload_port"] %>;
-            HAWKINS_LIVERELOAD_PROTOCOL = <%= livereload_protocol %>;
+            document.write('<script src="<%= livereload_source %>"></' + 'script>');
           </script>
-          <script type="text/javascript" src="<%= livereload_source %>"></script>
           TEMPLATE
           ERB.new(Jekyll::Utils.strip_heredoc(template))
         end
 
-        def livereload_protocol
-          use_ssl = @options["ssl_cert"] && @options["ssl_key"]
-          use_ssl ? '"wss://"' : '"ws://"'
-        end
-
         def livereload_source
           use_ssl = @options["ssl_cert"] && @options["ssl_key"]
           protocol = use_ssl ? "https" : "http"

data/lib/hawkins/version.rb

@@ -1,3 +1,3 @@
 module Hawkins
-  VERSION = "2.0.2".freeze
+  VERSION = "2.0.3".freeze
 end

data/lib/hawkins/websockets.rb

@@ -7,19 +7,27 @@ module Hawkins
   # despite the fact that the protocol itself uses WebSockets.  This custom connection
   # class addresses the dual protocols that the server needs to understand.
   class HttpAwareConnection < EventMachine::WebSocket::Connection
-    attr_reader :reload_file
+    attr_reader :reload_body, :reload_size
 
     def initialize(opts)
+      em_opts = {}
       @ssl_enabled = opts['ssl_cert'] && opts['ssl_key']
       if @ssl_enabled
-        opts[:tls_options] = {
+        em_opts[:tls_options] = {
           :private_key_file => Jekyll.sanitized_path(opts['source'], opts['ssl_key']),
           :cert_chain_file => Jekyll.sanitized_path(opts['source'], opts['ssl_cert']),
         }
-        opts[:secure] = true
+        em_opts[:secure] = true
       end
-      super
-      @reload_file = File.join(LIVERELOAD_DIR, "livereload.js")
+
+      # Too noisy even for debug level logging.
+      # em_opts[:debug] = true
+
+      super(em_opts)
+
+      reload_file = File.join(LIVERELOAD_DIR, "livereload.js")
+      @reload_body = File.read(reload_file)
+      @reload_size = File.size(reload_file)
     end
 
     def dispatch(data)
@@ -33,14 +41,13 @@ module Hawkins
         headers = [
           'HTTP/1.1 200 OK',
           'Content-Type: application/javascript',
-          "Content-Length: #{File.size(reload_file)}",
+          "Content-Length: #{reload_size}",
           '',
           '',
         ].join("\r\n")
         send_data(headers)
-        stream_file_data(reload_file).callback do
-          close_connection_after_writing
-        end
+        send_data(reload_body)
+        close_connection_after_writing
       else
         body = "This port only serves livereload.js over HTTP.\n"
         headers = [
@@ -61,23 +68,22 @@ module Hawkins
     attr_reader :thread
     attr_reader :opts
 
-    def initialize(opts)
-      @opts = opts
+    def initialize
       @thread = nil
       @websockets = []
       @connections_count = 0
     end
 
     def stop
+      EM.stop if EM.reactor_running?
       Jekyll.logger.debug("LiveReload Server:", "halted")
-      @thread.kill unless @thread.nil?
     end
 
     def running?
       !@thread.nil? && @thread.alive?
     end
 
-    def start
+    def start(opts)
       @thread = Thread.new do
         # Use epoll if the kernel supports it
         EM.epoll
@@ -99,22 +105,8 @@ module Hawkins
           end
         end
       end
-
-      Jekyll::Hooks.register(:site, :post_render) do |site|
-        regenerator = Jekyll::Regenerator.new(site)
-        @changed_pages = site.pages.select do |p|
-          regenerator.regenerate?(p)
-        end
-      end
-
-      Jekyll::Hooks.register(:site, :post_write) do
-        reload(@changed_pages) unless @changed_pages.nil?
-        @changed_pages = nil
-      end
     end
 
-    private
-
     # For a description of the protocol see http://feedback.livereload.com/knowledgebase/articles/86174-livereload-protocol
     def reload(pages)
       pages.each do |p|

data/test/test_liveserve.rb

@@ -117,7 +117,8 @@ module Hawkins
         client.ssl_config.add_trust_ca(cert)
         content = client.get_content(
           "https://#{opts['host']}:#{opts['port']}/#{opts['baseurl']}/hello.html")
-        expect(content).to include('HAWKINS_LIVERELOAD_PROTOCOL = "wss://";')
+        expect(content).to include(
+          "src=\"https://#{opts['host']}:#{opts['reload_port']}/livereload.js")
       end
 
       it "serves nothing else over HTTP on the default LiveReload port" do
@@ -131,9 +132,7 @@ module Hawkins
         opts = serve(standard_opts)
         content = client.get_content(
           "http://#{opts['host']}:#{opts['port']}/#{opts['baseurl']}/hello.html")
-        expect(content).to include("HAWKINS_LIVERELOAD_PORT = #{opts['reload_port']}")
-        expect(content).to include('HAWKINS_LIVERELOAD_PROTOCOL = "ws://";')
-        expect(content).to include("livereload.js?snipver=1")
+        expect(content).to include("livereload.js?snipver=1&port=#{opts['livereload_port']}")
         expect(content).to include("I am a simple web page")
       end
 

data/test/test_post.rb

@@ -37,6 +37,7 @@ module Hawkins
         title = "1999"
         expected_body = <<-BODY.gsub(/^\s*/, '')
         ---
+        layout: post
         title: #{title}
         ---
         BODY
@@ -60,6 +61,7 @@ module Hawkins
         title = "Raspberry Beret"
         expected_body = <<-BODY.gsub(/^\s*/, '')
         ---
+        layout: post
         title: #{title}
         ---
         BODY
@@ -152,7 +154,7 @@ module Hawkins
 
         %w(xemacs emacs).each do |editor|
           allow(Commands::Post).to receive(:exec)
-            .with(editor, '+3', /#{expected_file}/)
+            .with(editor, '+4', /#{expected_file}/)
             .and_return(nil)
           stub_const("ENV", ENV.to_h.tap { |h| h['VISUAL'] = editor })
           expect do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hawkins
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Alex Wood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -202,6 +202,7 @@ files:
 - ".document"
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md