RubyGems - jekyll-livereload - Versions diffs - 0.1.0 - Mend

jekyll-livereload 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

checksums.yaml +7 -0
data/.gitignore +16 -0
data/.rspec +2 -0
data/Gemfile +4 -0
data/History.markdown +5 -0
data/LICENSE.txt +22 -0
data/README.md +63 -0
data/Rakefile +1 -0
data/jekyll-livereload.gemspec +24 -0
data/js/livereload.js +1183 -0
data/lib/jekyll-livereload.rb +29 -0
data/lib/jekyll-livereload/build.rb +35 -0
data/lib/jekyll-livereload/serve.rb +34 -0
data/lib/jekyll-livereload/version.rb +5 -0
data/lib/jekyll-livereload/websocket.rb +170 -0
metadata +100 -0

data/lib/jekyll-livereload.rb ADDED

@@ -0,0 +1,29 @@
+require 'jekyll'
+module Jekyll
+  module Livereload
+    LIVERELOAD_PORT = 35729
+    LIVERELOAD_DIR = File.expand_path("../js", File.dirname(__FILE__))
+    class << self
+      attr_accessor(:pages, :reactor)
+      def pages
+        @pages ||= []
+      end
+    end
+    require "jekyll-livereload/build"
+    require "jekyll-livereload/serve"
+    require "jekyll-livereload/version"
+    require "jekyll-livereload/websocket"
+  end
+end
+# Add livereload support the Jekyll
+class << Jekyll::Commands::Serve
+  prepend Jekyll::Livereload::Serve
+end
+class << Jekyll::Commands::Build
+  prepend Jekyll::Livereload::Build
+end

data/lib/jekyll-livereload/build.rb ADDED

@@ -0,0 +1,35 @@
+require 'json'
+# Register Hooks, if livereload is enabled
+module Jekyll
+  module Livereload
+    module Build
+      def process(opts)
+        opts['host'] = 'localhost' unless opts.key?('host')
+        opts['reload_port'] = Livereload::LIVERELOAD_PORT unless opts.key?('reload_port')
+        if opts['livereload']
+          Jekyll::Hooks.register(:site, :post_render) do |site|
+            regenerator = Jekyll::Regenerator.new(site)
+            Livereload.pages = site.pages.select do |p|
+              regenerator.regenerate?(p)
+            end
+          end
+          Jekyll::Hooks.register([:pages, :documents], :post_render) do |doc|
+            doc.output.sub!(/<head>(.*)<\/head>/m, "<head>\\1#{reload_script(opts)}</head>")
+          end
+          Jekyll::Hooks.register :site, :post_write do
+            Livereload.reactor.reload() unless Livereload.reactor.nil?
+          end
+        end
+        super opts
+      end
+      private
+      def reload_script(opts)
+        "<script src=\"http://#{opts['host']}:#{opts['reload_port']}/livereload.js\"></script>"
+      end
+    end
+  end
+end

data/lib/jekyll-livereload/serve.rb ADDED

@@ -0,0 +1,34 @@
+# Allows us to add more option parameter to the serve command
+module Mercenary
+  class Command
+    def command(cmd_name)
+      Jekyll.logger.debug "Refined Command"
+      cmd = @commands[cmd_name] || Command.new(cmd_name, self)
+      yield cmd
+      @commands[cmd_name] = cmd
+    end
+  end
+end
+# Monkey Patch the Serve command to do a few things before the built-in
+# Serve command methods are invoked.
+module Jekyll
+  module Livereload
+    module Serve
+      def init_with_program(prog)
+        prog.command(:serve) do |c|
+          c.option 'livereload', '-L', '--livereload', 'Inject Livereload.js and run a WebSocket Server'
+          c.option 'reload_port', '-R', '--reload_port [PORT]', Integer, 'Port to serve Livereload on'
+        end
+        super prog
+      end
+      def process(opts)
+        Livereload.reactor = Livereload::Reactor.new(opts)
+        Livereload.reactor.start
+        super opts
+      end
+    end
+  end
+end

data/lib/jekyll-livereload/version.rb ADDED

@@ -0,0 +1,5 @@
+module Jekyll
+  module Livereload
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll-livereload/websocket.rb ADDED

@@ -0,0 +1,170 @@
+# Credit Alex Wood (https://github.com/awood) for most of this code.
+# This was modified to work with both version 3.0.5 and 3.1.3 of Jekyll
+# The MIT License (MIT)
+#
+# Copyright (c) 2014 Alex Wood
+#
+# 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.
+require 'json'
+require 'em-websocket'
+require 'http/parser'
+module Jekyll
+  module Livereload
+    # The LiveReload protocol requires the server to serve livereload.js over HTTP
+    # 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
+      def initialize(opts)
+        super
+        @reload_file = File.join(LIVERELOAD_DIR, "livereload.js")
+      end
+      def dispatch(data)
+        parser = Http::Parser.new
+        parser << data
+        # WebSockets requests will have a Connection: Upgrade header
+        if parser.http_method != 'GET' || parser.upgrade?
+          super
+        elsif parser.request_url =~ /^\/livereload.js/
+          headers = [
+            'HTTP/1.1 200 OK',
+            'Content-Type: application/javascript',
+            "Content-Length: #{File.size(reload_file)}",
+            '',
+            '',
+          ].join("\r\n")
+          send_data(headers)
+          stream_file_data(reload_file).callback do
+            close_connection_after_writing
+          end
+        else
+          body = "This port only serves livereload.js over HTTP.\n"
+          headers = [
+            'HTTP/1.1 400 Bad Request',
+            'Content-Type: text/plain',
+            "Content-Length: #{body.bytesize}",
+            '',
+            '',
+          ].join("\r\n")
+          send_data(headers)
+          send_data(body)
+          close_connection_after_writing
+        end
+      end
+    end
+    class Reactor
+      attr_reader :thread
+      attr_reader :opts
+      def initialize(opts)
+        @opts = opts
+        @thread = nil
+        @websockets = []
+        @connections_count = 0
+        trap("INT") { stop }
+      end
+      def stop
+        @thread.kill unless @thread.nil?
+        Jekyll.logger.debug("LiveReload Server:", "halted")
+      end
+      def running?
+        !@thread.nil? && @thread.alive?
+      end
+      def start
+        @thread = Thread.new do
+          # Use epoll if the kernel supports it
+          EM.epoll
+          # TODO enable SSL
+          EM.run do
+            Jekyll.logger.info("LiveReload Server:", "#{@opts['host']}:#{@opts['reload_port']}")
+            EM.start_server(@opts['host'], @opts['reload_port'], HttpAwareConnection, @opts) do |ws|
+              ws.onopen do |handshake|
+                connect(ws, handshake)
+              end
+              ws.onclose do
+                disconnect(ws)
+              end
+              ws.onmessage do |msg|
+                print_message(msg)
+              end
+            end
+          end
+        end
+      end
+      # For a description of the protocol see http://feedback.livereload.com/knowledgebase/articles/86174-livereload-protocol
+      def reload
+        Livereload.pages.each do |p|
+          msg = {
+            :command => 'reload',
+            :path => p.path,
+            :liveCSS => true,
+          }
+          # TODO Add support for override URL?
+          # See http://feedback.livereload.com/knowledgebase/articles/86220-preview-css-changes-against-a-live-site-then-uplo
+          Jekyll.logger.debug("LiveReload:", "Reloading #{p.path}")
+          @websockets.each do |ws|
+            ws.send(JSON.dump(msg))
+          end
+        end
+        Livereload.pages.clear
+      end
+      private
+      def connect(ws, _handshake)
+        @connections_count += 1
+        Jekyll.logger.info("LiveReload:", "Browser connected") if @connections_count == 1
+        ws.send(
+          JSON.dump(
+            :command => 'hello',
+            :protocols => ['http://livereload.com/protocols/official-7'],
+            :serverName => 'jekyll livereload',
+          ))
+        @websockets << ws
+      end
+      def disconnect(ws)
+        @websockets.delete(ws)
+      end
+      def print_message(json_message)
+        msg = JSON.parse(json_message)
+        # Not sure what the 'url' command even does in LiveReload
+        Jekyll.logger.info("LiveReload:", "Browser URL: #{msg['url']}") if msg['command'] == 'url'
+      end
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-livereload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert DeRose
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description:
+email:
+- RobertDeRose@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- History.markdown
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-livereload.gemspec
+- js/livereload.js
+- lib/jekyll-livereload.rb
+- lib/jekyll-livereload/build.rb
+- lib/jekyll-livereload/serve.rb
+- lib/jekyll-livereload/version.rb
+- lib/jekyll-livereload/websocket.rb
+homepage: https://github.com/RobertDeRose/jekyll-livereload
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.5.1
+signing_key:
+specification_version: 4
+summary: Adds LiveReload support to Jekyll's included Server
+test_files: []