guard-jekyll-plus 2.0.0 → 2.0.1

data/spec/lib/guard/jekyll-plus/server_spec.rb

@@ -0,0 +1,79 @@
+require 'guard/jekyll_plus/server'
+
+# stub for tests to avoid requiring
+unless Object.const_defined?(:Rack)
+  module Rack
+    class Handler
+      class Thin
+      end
+    end
+
+    class Server
+      def initialize(_options)
+      end
+
+      def server
+      end
+
+      def start
+      end
+    end
+  end
+end
+
+RSpec.describe Guard::JekyllPlus::Server do
+  let(:config) { instance_double(Guard::JekyllPlus::Config) }
+  subject { described_class.new(config) }
+
+  before do
+    allow(Thread).to receive(:new) do |&block|
+      block.call
+    end
+
+    allow(Process).to receive(:fork) do |&block|
+      block.call
+    end
+
+    allow(Process).to receive(:wait)
+    allow(Process).to receive(:kill)
+
+    allow_any_instance_of(Rack::Server).to receive(:start)
+    allow(Jekyll::Commands::Serve).to receive(:process)
+  end
+
+  describe '#start' do
+    before do
+      allow(config).to receive(:host)
+      allow(config).to receive(:baseurl)
+      allow(config).to receive(:port)
+      allow(config).to receive(:info)
+      allow(config).to receive(:jekyll_serve_options)
+    end
+
+    context 'when Rack is available' do
+      before do
+        allow(Kernel).to receive(:require)
+        allow(config).to receive(:server_root)
+        allow(config).to receive(:rack_config)
+        allow(config).to receive(:rack_environment)
+        allow(File).to receive(:exist?).with('config.ru').and_return(false)
+      end
+
+      it 'starts the Rack server' do
+        expect_any_instance_of(Rack::Server).to receive(:start)
+        subject.start
+      end
+    end
+
+    context 'when Rack is not available' do
+      before do
+        allow(Kernel).to receive(:require).and_raise(LoadError)
+      end
+
+      it 'starts the Jekyll server' do
+        expect(Jekyll::Commands::Serve).to receive(:process)
+        subject.start
+      end
+    end
+  end
+end

data/spec/lib/guard/jekyll-plus_spec.rb

@@ -0,0 +1,114 @@
+require 'guard/compat/test/helper'
+require 'guard/jekyll_plus'
+
+RSpec.describe Guard::JekyllPlus do
+  let(:server) { instance_double(Guard::JekyllPlus::Server) }
+  let(:config) { instance_double(Guard::JekyllPlus::Config) }
+  let(:builder) { instance_double(Guard::JekyllPlus::Builder) }
+
+  before do
+    allow(Guard::Compat::UI).to receive(:info)
+
+    allow(Guard::JekyllPlus::Config).to receive(:new).and_return(config)
+    allow(Guard::JekyllPlus::Server).to receive(:new).and_return(server)
+    allow(Guard::JekyllPlus::Builder).to receive(:new).and_return(builder)
+
+    allow(config).to receive(:info)
+    allow(config).to receive(:source)
+    allow(config).to receive(:destination)
+  end
+
+  describe '#initialize' do
+    it 'sets up the configuration' do
+      options = double('options')
+      expect(Guard::JekyllPlus::Config).to receive(:new).with(options)
+      described_class.new(options)
+    end
+  end
+
+  describe '#start' do
+    before do
+      allow(config).to receive(:serve?)
+      allow(builder).to receive(:build)
+    end
+
+    it 'processes the site' do
+      expect(builder).to receive(:build)
+      subject.start
+    end
+
+    context 'when not serving' do
+      before do
+        allow(config).to receive(:serve?).and_return(false)
+      end
+
+      it 'does not start the server' do
+        expect(server).to_not receive(:start)
+        subject.start
+      end
+    end
+
+    context 'when serving' do
+      before do
+        allow(config).to receive(:serve?).and_return(true)
+      end
+
+      it 'starts the server' do
+        expect(server).to receive(:start)
+        subject.start
+      end
+    end
+  end
+
+  describe '#run_on_modifications' do
+    before do
+      allow(builder).to receive(:modified)
+    end
+
+    context 'with normal modifications' do
+      before do
+        allow(config).to receive(:config_file?).and_return(false)
+      end
+
+      it 'updates based on given paths' do
+        paths = [double('paths')]
+        expect(builder).to receive(:modified).with(paths)
+        subject.run_on_modifications(paths)
+      end
+    end
+
+    context 'with changed config' do
+      before do
+        allow(config).to receive(:config_file?).and_return(true)
+
+        # after config changes
+        allow(builder).to receive(:build)
+        allow(server).to receive(:stop)
+        allow(config).to receive(:reload)
+        allow(config).to receive(:serve?).and_return(false)
+      end
+
+      it 'reloads config' do
+        paths = [double('paths')]
+        expect(builder).to receive(:reload)
+        subject.run_on_modifications(paths)
+      end
+    end
+  end
+
+  describe '#run_on_additions' do
+    it 'updates based on given paths' do
+      paths = [double('paths')]
+      expect(builder).to receive(:added).with(paths)
+      subject.run_on_additions(paths)
+    end
+  end
+
+  describe '#run_on_removals' do
+    it 'updates based on given paths' do
+      paths = [double('paths')]
+      expect(builder).to receive(:removed).with(paths)
+      subject.run_on_removals(paths)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  # config.warnings = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  # config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.before do
+    %w(cp rm_r rm mkdir mkdir_p).each do |meth|
+      allow(FileUtils).to receive(meth) do |*args|
+        fail "stub me: FileUtils.#{meth}(#{args.map(&:inspect).join(', ')})"
+      end
+    end
+
+    %w(exist?).each do |meth|
+      allow(File).to receive(meth) do |*args|
+        fail "stub me: File.#{meth}(#{args.map(&:inspect).join(', ')})"
+      end
+    end
+
+    %w([]).each do |meth|
+      allow(Dir).to receive(meth) do |*args|
+        fail "stub me: Dir.#{meth}(#{args.map(&:inspect).join(', ')})"
+      end
+    end
+  end
+end

data/test/Guardfile

@@ -1,8 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard "jekyll-plus", :config => ['_config.yml', '_override.yml'], :serve => true do
-  watch /.*/
-  ignore /^_site/
+ignore(/^_site/)
+guard 'jekyll_plus', config: ['_config.yml', '_override.yml'], serve: true do
+  watch(/.*/)
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-jekyll-plus
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -16,14 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.3
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +73,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: nenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -88,19 +122,41 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-gemset"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - guard-jekyll-plus.gemspec
-- lib/guard/jekyll-plus.rb
-- lib/guard/jekyll-plus/templates/Guardfile
-- lib/guard/jekyll-plus/version.rb
+- lib/guard/jekyll_plus.rb
+- lib/guard/jekyll_plus/builder.rb
+- lib/guard/jekyll_plus/builder/action.rb
+- lib/guard/jekyll_plus/builder/adder.rb
+- lib/guard/jekyll_plus/builder/modifier.rb
+- lib/guard/jekyll_plus/builder/rebuilder.rb
+- lib/guard/jekyll_plus/builder/remover.rb
+- lib/guard/jekyll_plus/config.rb
+- lib/guard/jekyll_plus/server.rb
+- lib/guard/jekyll_plus/templates/Guardfile
+- lib/guard/jekyll_plus/version.rb
 - lib/rack/config.ru
+- spec/lib/guard/jekyll-plus/builder/adder_spec.rb
+- spec/lib/guard/jekyll-plus/builder/modifier_spec.rb
+- spec/lib/guard/jekyll-plus/builder/rebuilder_spec.rb
+- spec/lib/guard/jekyll-plus/builder/remover_spec.rb
+- spec/lib/guard/jekyll-plus/builder_spec.rb
+- spec/lib/guard/jekyll-plus/config_spec.rb
+- spec/lib/guard/jekyll-plus/server_spec.rb
+- spec/lib/guard/jekyll-plus_spec.rb
+- spec/spec_helper.rb
 - test/.gitignore
 - test/404.html
-- test/Gemfile
 - test/Guardfile
 - test/Testfile
 - test/_config.yml
@@ -135,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Guard plugin for Jekyll which intelligently handles changes to static and

data/lib/guard/jekyll-plus.rb

@@ -1,300 +0,0 @@
-# encoding: UTF-8
-
-require 'benchmark'
-require 'guard/plugin'
-require 'jekyll'
-
-begin
-  require 'rack'
-rescue LoadError
-end
-
-module Guard
-  class Jekyllplus < Plugin
-    def initialize(options = {})
-      super
-
-      default_extensions = ['md','mkd','mkdn','markdown','textile','html','haml','slim','xml','yml','sass','scss']
-
-      @options = {
-        :extensions     => [],
-        :config         => ['_config.yml'],
-        :serve          => false,
-        :rack_config    => nil,
-        :drafts         => false,
-        :future         => false,
-        :config_hash    => nil,
-        :silent         => false,
-        :msg_prefix     => 'Jekyll'
-      }.merge(options)
-
-      @config = load_config(@options)
-      @source = local_path @config['source']
-      @destination = local_path @config['destination']
-      @msg_prefix = @options[:msg_prefix]
-
-      # Convert array of extensions into a regex for matching file extensions eg, /\.md$|\.markdown$|\.html$/i
-      # 
-      extensions  = @options[:extensions].concat(default_extensions).flatten.uniq
-      @extensions = Regexp.new extensions.map { |e| (e << '$').gsub('\.', '\\.') }.join('|'), true
-
-      # set Jekyll server thread to nil
-      @server_thread = nil
-
-    end
-
-    def load_config(options)
-      config = jekyll_config(options)
-
-      # Override configuration with guard option values
-      config['show_drafts'] ||= options[:drafts]
-      config['future']      ||= options[:future]
-      config
-    end
-
-    def reload_config!
-      UI.info "Reloading Jekyll configuration!"
-      @config = load_config(@options)
-    end
-
-    def start
-      if @options[:serve]
-        build
-        start_server
-        UI.info "#{@msg_prefix} " + "watching and serving at #{@config['host']}:#{@config['port']}#{@config['baseurl']}" unless @config[:silent]
-      else
-        build
-        UI.info "#{@msg_prefix} " + "watching" unless @config[:silent]
-      end
-    end
-
-    def reload
-      stop if !@server_thread.nil? and @server_thread.alive?
-      reload_config!
-      start
-    end
-
-    def reload_server
-      stop_server
-      start_server
-    end
-
-    def stop
-      stop_server
-    end
-
-    def run_on_modifications(paths)
-      # At this point we know @options[:config] is going to be an Array
-      # thanks to the call the jekyll_config earlier.
-      reload_config! if @options[:config].map { |f| paths.include?(f) }.any?
-      matched = jekyll_matches paths
-      unmatched = non_jekyll_matches paths
-      if matched.size > 0
-        build(matched, "Files changed: ", "  ~ ".yellow)
-      elsif unmatched.size > 0
-        copy(unmatched)
-      end
-    end
-
-    def run_on_additions(paths)
-      matched = jekyll_matches paths
-      unmatched = non_jekyll_matches paths
-
-      if matched.size > 0
-        build(matched, "Files added: ", "  + ".green)
-      elsif unmatched.size > 0
-        copy(unmatched)
-      end
-    end
-
-    def run_on_removals(paths)
-      matched = jekyll_matches paths
-      unmatched = non_jekyll_matches paths
-
-      if matched.size > 0
-        build(matched, "Files removed: ", "  x ".red)
-      elsif unmatched.size > 0
-        remove(unmatched)
-      end
-    end
-
-
-    private
-
-    def build(files = nil, message = '', mark = nil)
-      begin
-        UI.info "#{@msg_prefix} #{message}" + "building...".yellow unless @config[:silent]
-        if files
-          puts '| ' # spacing
-          files.each { |file| puts '|' + mark + file }
-          puts '| ' # spacing
-        end
-        elapsed = Benchmark.realtime { build_site(@config) }
-        UI.info "#{@msg_prefix} " + "build completed in #{elapsed.round(2)}s ".green + "#{@source} → #{@destination}" unless @config[:silent]
-      rescue Exception
-        UI.error "#{@msg_prefix} build has failed" unless @config[:silent]
-        stop_server
-        throw :task_has_failed
-      end
-    end
-
-    # Copy static files to destination directory
-    #
-    def copy(files=[])
-      files = ignore_stitch_sources files
-      if files.size > 0
-        begin
-          message = 'copied file'
-          message += 's' if files.size > 1
-          UI.info "#{@msg_prefix} #{message.green}" unless @config[:silent]
-          puts '| ' #spacing
-          files.each do |file|
-            if(!check_jekyll_exclude(file))
-              path = destination_path file
-              FileUtils.mkdir_p File.dirname(path)
-              FileUtils.cp file, path
-              puts '|' + "  → ".green + path
-            else
-              puts '|' + "  ~ ".yellow + "Jekyll exclude: Ignoring changes to #{file}".yellow
-            end
-          end
-          puts '| ' #spacing
-
-        rescue Exception
-          UI.error "#{@msg_prefix} copy has failed" unless @config[:silent]
-          UI.error e
-          stop_server
-          throw :task_has_failed
-        end
-        true
-      end
-    end
-
-    def ignore_stitch_sources(files)
-      if ENV['GUARD_STITCH_PLUS_FILES']
-        ignore = ENV['GUARD_STITCH_PLUS_FILES'].split(',')
-        files.reject {|f| ignore.include? f }
-      else
-        files
-      end
-
-    end
-
-    # Remove deleted source file/directories from destination
-    #
-    def remove(files=[])
-      files = ignore_stitch_sources files
-      # Ensure at least one file still exists (other scripts may clean up too)
-      if files.select {|f| File.exist? f }.size > 0
-        begin
-          message = 'removed file'
-          message += 's' if files.size > 1
-          UI.info "#{@msg_prefix} #{message.red}" unless @config[:silent]
-          puts '| ' #spacing
-
-          files.each do |file|
-            path = destination_path file
-            if File.exist? path
-              FileUtils.rm path
-              puts '|' + "  x ".red + path
-            end
-
-            dir = File.dirname path
-            if Dir[dir+'/*'].empty?
-              FileUtils.rm_r(dir)
-              puts '|' + "  x ".red + dir
-            end
-          end
-          puts '| ' #spacing
-
-        rescue Exception
-          UI.error "#{@msg_prefix} remove has failed" unless @config[:silent]
-          UI.error e
-          stop_server
-          throw :task_has_failed
-        end
-        true
-      end
-    end
-
-    def jekyll_matches(paths)
-      paths.select { |file| file =~ @extensions }
-    end
-
-    def non_jekyll_matches(paths)
-      paths.select { |file| !file.match(/^_/) and !file.match(@extensions) }
-    end
-
-    def jekyll_config(options)
-      if options[:config_hash]
-        config = options[:config_hash]
-      elsif options[:config]
-        options[:config] = [options[:config]] unless options[:config].is_a? Array
-        config = options
-      end
-      Jekyll.configuration(config)
-    end
-
-    def check_jekyll_exclude(path)
-      return @config['exclude'].any? {|f| File.fnmatch?(path, f)}
-    end
-
-    def rack_config(root)
-      ENV['RACK_ROOT'] = root
-      default_config = File.expand_path("../rack/config.ru", File.dirname(__FILE__))
-      local_config = File.exist?('config.ru') ? 'config.ru' : nil
-
-      config = (@config['rack_config'] || local_config || default_config)
-      { :config => config, :Port => @config['port'], :Host => @config['host'], :environment => 'development' }
-    end
-
-    def local_path(path)
-      Dir.chdir('.')
-      current = Dir.pwd
-      path = path.sub current, ''
-      if path == ''
-        './'
-      else
-        path.sub(/^\//, '')
-      end
-    end
-
-    def build_site(options)
-      Jekyll.logger.log_level = :error
-      site = Jekyll::Site.new(options)
-      Jekyll.logger.log_level = :info
-      site.process
-    end
-    
-
-    def destination_path(file)
-      if @source =~ /^\./
-        File.join @destination, file
-      else
-        file.sub(/^#{@source}/, "#{@destination}")
-      end
-    end
-
-    def server(config)
-      if defined? ::Rack
-        Thread.new { ::Rack::Server.start(rack_config(@destination)) }
-        UI.info "#{@msg_prefix} running Rack" unless @config[:silent]
-      else
-        Thread.new { Jekyll::Commands::Serve.process(config) }
-      end
-    end
-
-    def start_server
-      if @server_thread.nil?
-        @server_thread = server(@config)
-      else
-        UI.warning "#{@msg_prefix} using an old server thread!"
-      end
-    end
-
-    def stop_server
-      @server_thread.kill unless @server_thread.nil?
-      @server_thread = nil
-    end
-  end
-end