guard-jekyll-plus 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be72288508230bb15f897c6a90e3e3acadbfd133
-  data.tar.gz: 5d2617be237688069afa09a0ca1e520f67ae1c63
+  metadata.gz: 076743d79bba521d0febc7610d79d83fff4e3e06
+  data.tar.gz: 32a121773ebec897e7799df0de0db78aca64710e
 SHA512:
-  metadata.gz: 026b9320d2df6366b31badc431cf5a4f30595f7cb8ab184320354e141a7707e7390e76a2b6a7f44f80a3fecd02a7206c79d5907c3f6f7e94126855a003408ca3
-  data.tar.gz: 1556ec62c7a9d61cecbcfb62582e3d1f605b3c4cef1101b3a67d629a7b8f4c6ffd02565d363da2aebddfd719c437a1e6a19c2778e6ae9e0f49c57703345ef6fa
+  metadata.gz: df7d740d999f05818c70cb31b089538f96cdec8544706905be63582917aea9964e36c49ce707a7f62eb82d5a4ad5ff9a4c65a74c168d798bd8ef26833a1be6e0
+  data.tar.gz: 54a1aca7708d5aeb3a0cb64c83afebd742569b688d373a5c9846d19d4e488c7e6a06353902d2b18686234e37e854d3207201c9ddce87eafd443bb659dc12cab3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - Guardfile
+
+Style/FileName:
+  Exclude:
+    - lib/guard/jekyll-plus.rb
+    - spec/lib/guard/jekyll-plus_spec.rb

data/.rubocop_todo.yml

@@ -0,0 +1,32 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-15 14:17:36 +0100 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 34
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 250
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 25
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 2
+Style/Documentation:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+guard-jekyll-plus

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-### 2.0.0
+### 2.0.1 - 12-15-2014
+
+- Changed guard template name for better compatibility with Guard's naming scheme.
+
+### 2.0.0 - 12-15-2014
 
 - Updated to work with Guard 2.x
 
@@ -51,7 +55,7 @@
 
 ### 1.3.0
 
-- Changed guard name to jekyll-plus to help Guard properly init the Guardfile.
+- Changed guard name to jekyll_plus to help Guard properly init the Guardfile.
 
 ### 1.2.3
 

data/Gemfile

@@ -1,4 +1,14 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in guard-jekyll-plus.gemspec
-gemspec
+# Specify your gem's dependencies in guard-jekyll_plus.gemspec
+#
+# NOTE: it's more convenient to use gemspec for bare-minimum test deps
+# and the Gemfile for any extra dev gems
+gemspec development_group: :test
+
+group :development do
+  gem 'guard-rspec', require: false
+  gem 'guard-rubocop', require: false
+  gem 'pry'
+  gem 'pry-byebug'
+end

data/Guardfile

@@ -0,0 +1,30 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+group :bdd, halt_on_fail: true do
+  guard :rspec, cmd: "bundle exec rspec", all_on_start: false do
+    require "guard/rspec/dsl"
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop, all_on_start: false do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/README.md

@@ -42,7 +42,7 @@ Navigate to your Jekyll project directory and create a Guardfile using:
 Or if you already have a Guardfile, add a Jekyll guard.
 
 ```ruby
-guard "jekyll-plus" do
+guard "jekyll_plus" do
   watch /.*/
   ignore /^_site/
 end
@@ -66,7 +66,7 @@ If your Jekyll project has a non-standard directory stucture like this:
 You would do this instead:
 
 ```ruby
-guard "jekyll-plus" do
+guard "jekyll_plus" do
   watch /^source/
   watch /_config.yml/
 end
@@ -97,7 +97,7 @@ This guard has these configurations.
 To use Jekyll's built-in server, simply set `:serve => true` in your rack options
 
 ```ruby
-guard "jekyll-plus", :serve => true do
+guard "jekyll_plus", :serve => true do
   watch /.*/
   ignore /^_site/
 end
@@ -115,7 +115,7 @@ If you wish to use your own rack server configuration, simply drop a `config.ru`
 Here's how you would add `txt` to the list of file extensions which triggers a Jekyll build.
 
 ```ruby
-guard "jekyll-plus", :extensions => ['txt'] do
+guard "jekyll_plus", :extensions => ['txt'] do
   watch /.*/
   ignore /^_site/
 end
@@ -129,7 +129,7 @@ which don't match these extensions will be simply copied over to the destination
 Here's how you might tell Jekyll to read from multiple configuration files.
 
 ```ruby
-guard "jekyll-plus", :config => ['settings.yml', 'override.yml'] do
+guard "jekyll_plus", :config => ['settings.yml', 'override.yml'] do
   watch /.*/
   ignore /^_site/
 end

data/Rakefile

@@ -1 +1,9 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'nenv'
+
+require 'rspec/core/rake_task'
+rspec = RSpec::Core::RakeTask.new do |t|
+  t.verbose = Nenv.ci?
+end
+
+task default: rspec.name

data/guard-jekyll-plus.gemspec

@@ -1,28 +1,33 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'guard/jekyll-plus/version'
+require 'guard/jekyll_plus/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "guard-jekyll-plus"
+  gem.name          = 'guard-jekyll-plus'
   gem.version       = Guard::JekyllPlusVersion::VERSION
-  gem.authors       = ["Brandon Mathis"]
-  gem.email         = ["brandon@imathis.com"]
-  gem.description   = %q{A Guard plugin for smarter Jekyll watching}
-  gem.summary       = %q{A Guard plugin for Jekyll which intelligently handles changes to static and template files, only running a Jekyll build when necessary. }
-  gem.homepage      = "http://github.com/imathis/guard-jekyll-plus"
+  gem.authors       = ['Brandon Mathis']
+  gem.email         = ['brandon@imathis.com']
+  gem.description   = 'A Guard plugin for smarter Jekyll watching'
+  gem.summary       = 'A Guard plugin for Jekyll which intelligently handles'\
+                      ' changes to static and template files, only running a'\
+                      ' Jekyll build when necessary. '
+
+  gem.homepage      = 'http://github.com/imathis/guard-jekyll-plus'
   gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.require_paths = ['lib']
 
-  gem.add_dependency 'guard', '~> 2.8'
+  gem.add_dependency 'guard', '~> 2.10', '>= 2.10.3'
+  gem.add_dependency 'guard-compat', '~> 1.1'
   gem.add_dependency 'jekyll', '>= 1.0.0'
 
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "pry-byebug"
+  # Note: we use these for test depedencies, because it's more convenient
+  # to use Gemfile for development deps
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'nenv', '~> 0.1'
 
-  if RUBY_VERSION >= "2"
-    gem.add_development_dependency "bundler"
-  end
+  gem.add_development_dependency 'bundler' if RUBY_VERSION >= '2'
 end

data/lib/guard/jekyll_plus.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+
+require 'pathname'
+
+require 'jekyll'
+
+require 'guard/compat/plugin'
+
+require 'guard/jekyll_plus/server'
+require 'guard/jekyll_plus/config'
+require 'guard/jekyll_plus/builder'
+
+module Guard
+  class JekyllPlus < Plugin
+    def initialize(options = {})
+      super
+
+      @config = Config.new(options)
+      @server = Server.new(@config)
+      @builder = Builder.new(@config)
+    end
+
+    def start
+      @builder.build
+      @server.start if @config.serve?
+      @config.info 'watching'
+    end
+
+    def reload
+      stop
+      @config.info 'Reloading Jekyll configuration!'
+      @config.reload
+      @builder.reload
+      start
+    end
+
+    def stop
+      @server.stop
+    end
+
+    def run_on_modifications(paths)
+      reload if paths.any? { |f| @config.config_file?(f) }
+      @builder.modified(paths)
+    end
+
+    def run_on_additions(paths)
+      @builder.added(paths)
+    end
+
+    def run_on_removals(paths)
+      @builder.removed(paths)
+    end
+  end
+end

data/lib/guard/jekyll_plus/builder.rb

@@ -0,0 +1,46 @@
+require 'jekyll'
+
+require 'guard/jekyll_plus/config'
+
+require 'guard/jekyll_plus/builder/modifier'
+require 'guard/jekyll_plus/builder/adder'
+require 'guard/jekyll_plus/builder/remover'
+require 'guard/jekyll_plus/builder/rebuilder'
+
+module Guard
+  class JekyllPlus < Plugin
+    class Builder
+      def initialize(config)
+        @config = config
+        reload
+      end
+
+      def reload
+        Jekyll.logger.log_level = :error
+        @site = ::Jekyll::Site.new(@config.jekyll_config)
+        Jekyll.logger.log_level = :info
+
+        @adder = Adder.new(@config, @site)
+        @modifier = Modifier.new(@config, @site)
+        @remover = Remover.new(@config, @site)
+        @rebuilder = Rebuilder.new(@config, @site)
+      end
+
+      def build
+        @rebuilder.update
+      end
+
+      def added(paths)
+        @adder.update(paths)
+      end
+
+      def modified(paths)
+        @modifier.update(paths)
+      end
+
+      def removed(paths)
+        @remover.update(paths)
+      end
+    end
+  end
+end

data/lib/guard/jekyll_plus/builder/action.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+
+require 'benchmark'
+require 'jekyll'
+require 'guard/compat/plugin'
+
+require 'guard/jekyll_plus/config'
+
+module Guard
+  class JekyllPlus < Plugin
+    class Builder
+      class Action
+        def initialize(config, site)
+          @config, @site = config, site
+        end
+
+        def jekyll_matches(paths)
+          paths.select { |file| file =~ @config.extensions }
+        end
+
+        def non_jekyll_matches(paths)
+          paths.select do |file|
+            !file.match(/^_/) && !file.match(@config.extensions)
+          end
+        end
+
+        def build(files, message, mark)
+          @config.info [message, 'building...'.yellow].join(' ')
+
+          if files
+            puts '| ' # spacing
+            files.each { |file| puts '|' + mark + file }
+            puts '| ' # spacing
+          end
+
+          elapsed = Benchmark.realtime { @site.process }.round(2)
+
+          change = format('%s → %s', @config.source, @config.destination)
+          @config.info format('build completed in %ss '.green + change, elapsed)
+
+          # rescue almost everything because Jekyll::Convertible forwards
+          # every plugin-specific exception it encounters
+        rescue StandardError => e
+          @config.error 'build has failed'
+          @config.error e.to_s
+          throw :task_has_failed
+        end
+
+        def ignore_stitch_sources(files)
+          return files unless (ignore = ENV['GUARD_STITCH_PLUS_FILES'])
+
+          ignore = ignore.split(',')
+          files.reject { |f| ignore.include? f }
+        end
+
+        def pluralize(word, array)
+          "#{word}#{array.size > 1 ? 's' : ''}"
+        end
+
+        def destination_path(file)
+          if @config.source =~ /^\./
+            File.join @config.destination, file
+          else
+            file.sub(/^#{@config.source}/, "#{@config.destination}")
+          end
+        end
+
+        def build_was_needed(paths)
+          matched = jekyll_matches(paths)
+          return false  if matched.empty?
+          build(matched, @msg, @mark)
+        end
+
+        def update(paths)
+          return if build_was_needed(paths)
+
+          unmatched = non_jekyll_matches(paths)
+          return if unmatched.empty?
+          files = ignore_stitch_sources(unmatched)
+          return if files.empty?
+
+          do_update(files)
+          footer
+        rescue RuntimeError, SystemCallError => e
+          @config.error "#{@name} has failed"
+          @config.error e.to_s
+          throw :task_has_failed
+        end
+
+        def copy(src, dst)
+          if @config.excluded?(src)
+            puts '|' + ('  ~ ' + "Ignoring excluded file: #{src}").yellow
+            return
+          end
+
+          FileUtils.mkdir_p File.dirname(dst)
+          FileUtils.cp src, dst
+          puts '|' + '  → '.green + dst
+        end
+
+        def remove(path)
+          if File.exist? path
+            FileUtils.rm path
+            puts '|' + '  → '.red + path
+          end
+
+          dir = File.dirname path
+          return if Dir[dir + '/*'].any?
+
+          FileUtils.rm_rk(dir)
+          puts '|' + '  x '.red + dir
+        end
+
+        def header(files)
+          plural = files.nil? ? '' : pluralize('file', files.size)
+          @config.info [@activity, plural].join(' ').send(@color)
+          puts '| ' unless files.nil? # spacing
+        end
+
+        def footer
+          puts '| ' # spacing
+        end
+      end
+    end
+  end
+end