jekyll-browsersync 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 04a0f50ba201fde043c6874cdf70f6b5a3f85cd7
-  data.tar.gz: 2d0bc3b8f65bfe0d20efdb40372f7a62d04abf54
+SHA256:
+  metadata.gz: 3daf4e2e9f728e4d3c2f7b7b583d50b4e69bef505d3df61ecf9af403d1b02bed
+  data.tar.gz: 0a752341328b67d3c4b2869107687f065b4a046b7c012faa01f3d6d693e14557
 SHA512:
-  metadata.gz: 770a2aa80db19a1b86d95a2c8f270f3ff0826f09fac8b878de52329c14b23e8de92469680bf22acfe89e7c39bdb94888db4237ba836e973ba786766995f246ab
-  data.tar.gz: 4acead2b9aa338db4b7117d14d14e92069d8de4daf819e1a292677d043a291d8adf77da64d52b60755bacf87aaf8254e59875a97dc2fa2e963b0e57e97f66a0b
+  metadata.gz: 4753f6aa2535427f22bd0c31fb274cefe62ee509967d2c5c63614d8e1bcb3ec395ea298543895b574fb24de05f66c52f8b36bb815d84483e12e52f41a30f549d
+  data.tar.gz: b9e0c73c16d932b4f0350deb4e641f9f0c2066f8f255cc1580e4649cdcd56a6dc8396426e913db0481d176e778220004f18cec705c57b06f4c6fe2880e82ea8d

data/lib/jekyll-browsersync.rb

@@ -1,2 +1,12 @@
+# frozen_string_literal: true
+
 require "jekyll-browsersync/command"
 require "jekyll-browsersync/version"
+
+module Mlo
+  module Jekyll
+    module BrowserSync
+      DEFAULT_BROWSERSYNC_PATH = "node_modules/.bin/browser-sync"
+    end
+  end
+end

data/lib/jekyll-browsersync/command.rb

@@ -1,125 +1,67 @@
-require 'pty'
+# frozen_string_literal: true
+
+require "pty"
+require "tty-which"
 
 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("browsersync") do |cmd|
-              cmd.syntax "browsersync [options]"
-              cmd.description 'Serve a Jekyll site using Browsersync.'
-              cmd.alias :'browser-sync'
-              cmd.alias :bs
-
-              add_build_options(cmd)
-
-              COMMAND_OPTIONS.each do |key, val|
-                cmd.option key, *val
-              end
-
-              cmd.action do |args, opts|
-                puts args.inspect
-                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, args)
-              end
-            end
-          end
-
-          def process(opts, args)
-            opts = configuration_from_options(opts)
-            destination = opts['destination']
+        def self.init_with_program(prog)
+          prog.command(:browsersync) do |c|
+            c.syntax "browsersync [options]"
+            c.description "Serve the site using Browsersync"
 
-            args << "--server #{destination}"
-            args << "--files #{destination}"
-            args << "--port #{opts['port']}"
-            args << "--host #{opts['host']}"
-            args << "--ui-port #{opts['ui_port']}"
-            args << '--https' if opts['https']
-            args << '--no-open' unless opts['open_url']
-            args << '--directory' if opts['show_dir_listing']
+            options.each { |opt| c.option(*opt) }
 
-            cmd = "#{opts['browsersync']} start #{args.join(' ')}"
+            add_build_options(c)
 
-            PTY.spawn(cmd) 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
+            c.action { |args, options| process(args, options) }
           end
+        end
 
-          private
+        def self.options
+          [
+            ["host", "-H", "--host [HOST]", "Host to bind to"],
+            ["port", "-P", "--port [PORT]", "Port to listen on"],
+            ["open", "-o", "--open", "Launch your site in a browser"],
+            ["browsersync", "-e", "--cli [PATH]", "Path to browsersync CLI"],
+          ]
+        end
 
-          def locate_browsersync
-            return DEFAULT_BROWSERSYNC_PATH if File.exists?(DEFAULT_BROWSERSYNC_PATH)
-            return which('browser-sync')
+        def self.process(args = [], options = {})
+          config = configuration_from_options(options)
+          config["serving"] = true
+          config["watch"] = true unless config.key?("watch")
+
+          cli = config["browsersync"] || self.browsersync()
+          args << "--server #{config["destination"]}"
+          args << "--files #{config["destination"]}"
+          args << "--port #{config["port"]}"
+          args << "--host #{config["host"]}"
+          args << "--no-open" unless config["open"]
+          cmd = "#{cli} start #{args.join(" ")}"
+
+          if `#{cli} --version 2>/dev/null`.empty?
+            raise "Unable to locate browser-sync binary."
           end
 
-          # Validate command options
-          def validate!(opts)
-            browsersync_version = `#{opts['browsersync']} --version 2>/dev/null`
+          ::Jekyll::Commands::Build.process(config)
 
-            raise RuntimeError.new('Unable to locate browser-sync binary.') if browsersync_version.empty?
+          PTY.spawn(cmd) do |stdout, stdin, pid|
+            trap("INT") { Process.kill "INT", pid }
+    
+            begin
+              stdout.each { |line| ::Jekyll.logger.info(line.rstrip) }
+            rescue
+            end
           end
+        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
+        private
 
-          # 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
+        def self.browsersync
+          File.exists?(DEFAULT_BROWSERSYNC_PATH) ? DEFAULT_BROWSERSYNC_PATH : TTY::Which.which("browser-sync")
         end
       end
     end

data/lib/jekyll-browsersync/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Mlo
   module Jekyll
     module BrowserSync
-      VERSION = '0.1.0'
+      VERSION = "1.0.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-browsersync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Loberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-09 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: tty-which
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -65,8 +79,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
-- README.md
 - lib/jekyll-browsersync.rb
 - lib/jekyll-browsersync/command.rb
 - lib/jekyll-browsersync/version.rb
@@ -82,15 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Add live reloading to Jekyll using Browsersync.

data/LICENSE

@@ -1,19 +0,0 @@
-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

@@ -1,52 +0,0 @@
-# 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 `browsersync` command under Jekyll.
-
-    $ bundle exec jekyll browsersync
-
-If you have Browsersync installed in a custom location, you can specify this with the
-`--browser-sync` option.
-
-    $ bundle exec jekyll browser-sync --browser-sync ~/bin/browser-sync
-
-If you would like to serve the site using https, use the `--https` option.
-
-    $ bundle exec jekyll bs --https
-
-If you have any other options you would like passed to the Browsersync command,
-pass them as arguments.
-
-    $ bundle exec jekyll browsersync -- --no-notify
-
-## 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