jekyll-browsersync 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef4e2533e894b7a00104e9665fbbf20d2c8ad3d0
+  data.tar.gz: 8b6dd382b6c26f75c9ad7baa4f5745b7528e993c
+SHA512:
+  metadata.gz: 7af612def7489b52db670a105b48a92427d2f661a7e40028a93c1ab575b179af8672fb903484845d93b9d98cc1711664a79771552d8def01c32b595d4965bdc9
+  data.tar.gz: 62031004e1188ff064a2d90608c960e4cbc935f630cf7cc8c26ec2312dfb0c9a7c449f2e58f91d9d08e0d205ca9a36d8f046644dc54ce0e5e5bf96180b6e50f6

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016 Matthew Loberg
+
+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.

data/README.md

@@ -0,0 +1,47 @@
+# Jekyll Browsersync
+
+Add live reloading to your Jekyll development using [Browsersync](https://www.browsersync.io/).
+
+## Requirements
+
+* Jekyll >= 3
+* [Browsersync](https://www.browsersync.io/) installed
+  * globally (`npm install -g browser-sync` ) **OR**
+  * locally (`npm install browser-sync`)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jekyll-browsersync', group: [:jekyll_plugins]
+
+Then install it
+
+    $ bundle
+
+## Usage
+
+Once you have it installed, you should have a new `browser-sync` command under Jekyll.
+
+    $ bundle exec jekyll browser-sync
+
+If you have Browsersync installed in a custom location, you can specify this with the
+`--browser-sync` option.
+
+    $ bundle exec jekyll browsersync --browser-sync ~/bin/browser-sync
+
+If you would like to serve the site using https, use the `--https` option.
+
+    $ bundle exec jekyll bs --https
+
+## Contributing
+
+1. Fork it (https://github.com/mloberg/jekyll-browsersync/fork)
+2. Create your feature branch (`git checkout -b feature/my-awesome-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-awesome-feature`)
+5. Create new Pull Request
+
+## TODO
+
+* Write tests

data/lib/jekyll-browsersync/command.rb

@@ -0,0 +1,129 @@
+require 'pty'
+
+module Mlo
+  module Jekyll
+    module BrowserSync
+      class Command < ::Jekyll::Command
+        class << self
+          DEFAULT_BROWSERSYNC_PATH = 'node_modules/.bin/browser-sync'
+          COMMAND_OPTIONS = {
+            "https"              => ["--https", "Use HTTPS"],
+            "host"               => ["host", "-H", "--host [HOST]", "Host to bind to"],
+            "open_url"           => ["-o", "--open-url", "Launch your site in a browser"],
+            "port"               => ["-P", "--port [PORT]", "Port to listen on"],
+            "show_dir_listing"   => ["--show-dir-listing",
+              "Show a directory listing instead of loading your index file."],
+            "skip_initial_build" => ["skip_initial_build", "--skip-initial-build",
+              "Skips the initial site build which occurs before the server is started."],
+            "ui_port"            => ["--ui-port [PORT]",
+              "The port for Browsersync UI to run on"],
+            "browsersync"        => ["--browser-sync [PATH]",
+              "Specify the path to the Browsersync binary if in custom location."],
+          }.freeze
+
+          def init_with_program(prog)
+            prog.command("browser-sync") do |cmd|
+              cmd.syntax "browser-sync [options]"
+              cmd.description 'Serve a Jekyll site using Browsersync.'
+              cmd.alias :browsersync
+              cmd.alias :bs
+
+              add_build_options(cmd)
+
+              COMMAND_OPTIONS.each do |key, val|
+                cmd.option key, *val
+              end
+
+              cmd.action do |_, opts|
+                opts['serving'] = true
+                opts['watch'] = true unless opts.key?('watch')
+                opts['incremental'] = true unless opts.key?('incremental')
+                opts['port'] = 4000 unless opts.key?('port')
+                opts['host'] = '127.0.0.1' unless opts.key?('host')
+                opts['ui_port'] = 3001 unless opts.key?('ui_port')
+                opts['browsersync'] = locate_browsersync unless opts.key?('browsersync')
+
+                validate!(opts)
+
+                config = opts['config']
+                ::Jekyll::Commands::Build.process(opts)
+                opts['config'] = config
+                Command.process(opts)
+              end
+            end
+          end
+
+          def process(opts)
+            opts = configuration_from_options(opts)
+            destination = opts['destination']
+
+            cmd = [
+              opts['browsersync'],
+              'start',
+              "--server #{destination}",
+              "--files #{destination}",
+              "--port #{opts['port']}",
+              "--host #{opts['host']}",
+              "--ui-port #{opts['ui_port']}",
+            ]
+
+            cmd << '--https' if opts['https']
+            cmd << '--no-open' unless opts['open_url']
+            cmd << '--directory' if opts['show_dir_listing']
+
+            PTY.spawn(cmd.join(' ')) do |stdout, stdin, pid|
+              trap("INT") { Process.kill 'INT', pid }
+
+              ::Jekyll.logger.info "Server address:", server_address(opts)
+              ::Jekyll.logger.info "UI address:", server_address(opts, 'ui')
+
+              begin
+                stdout.each { |line| ::Jekyll.logger.debug line.rstrip }
+              rescue
+              end
+            end
+          end
+
+          private
+
+          def locate_browsersync
+            return DEFAULT_BROWSERSYNC_PATH if File.exists?(DEFAULT_BROWSERSYNC_PATH)
+            return which('browser-sync')
+          end
+
+          # Validate command options
+          def validate!(opts)
+            browsersync_version = `#{opts['browsersync']} --version 2>/dev/null`
+
+            raise RuntimeError.new('Unable to locate browser-sync binary.') if browsersync_version.empty?
+          end
+
+          def server_address(opts, server = nil)
+            format("%{protocol}://%{address}:%{port}%{baseurl}", {
+              :protocol => opts['https'] ? 'https' : 'http',
+              :address => opts['host'],
+              :port => server == 'ui' ? opts['ui_port'] : opts['port'],
+              :baseurl => opts['baseurl'] ? "#{opts["baseurl"]}/" : '',
+            })
+          end
+
+          # Cross-platform way of finding an executable in the $PATH.
+          #
+          # See: http://stackoverflow.com/a/5471032/1264736
+          #
+          #   which('ruby') #=> /usr/bin/ruby
+          def which(cmd)
+            exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+            ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+              exts.each { |ext|
+                exe = File.join(path, "#{cmd}#{ext}")
+                return exe if File.executable?(exe) && !File.directory?(exe)
+              }
+            end
+            return nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-browsersync/version.rb

@@ -0,0 +1,7 @@
+module Mlo
+  module Jekyll
+    module BrowserSync
+      VERSION = '0.0.1'
+    end
+  end
+end

data/lib/jekyll-browsersync.rb

@@ -0,0 +1,2 @@
+require "jekyll-browsersync/command"
+require "jekyll-browsersync/version"

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-browsersync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Loberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-06 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.0
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Add live reloading to Jekyll using Browsersync.
+email:
+- loberg.matt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-browsersync/command.rb
+- lib/jekyll-browsersync/version.rb
+- lib/jekyll-browsersync.rb
+- README.md
+- LICENSE
+homepage: https://github.com/mloberg/jekyll-browsersync
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Add live reloading to Jekyll using Browsersync.
+test_files: []