guard-nanoc 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Yann Lugrin
+
+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.rdoc

@@ -0,0 +1,52 @@
+= Guard::Nanoc
+
+Nanoc guard automatically rebuilds nanoc site files when modified (like nanoc watch)
+
+- Compatible with Nanoc 3.1.x
+- Tested on Ruby 1.8.6, 1.8.7 & 1.9.2.
+
+== Install
+
+Please be sure to have {guard}[http://github.com/guard/guard] installed before continue.
+
+Install the gem:
+
+    gem install guard-nanoc
+
+Add it to your Gemfile (inside test group):
+
+    gem 'guard-nanoc'
+
+Add guard definition to your Guardfile by running this command:
+
+    guard init nanoc
+
+== Usage
+
+Please read {guard usage doc}[http://github.com/guard/guard#readme]
+
+== Guardfile
+
+Nanoc guard can be really be adapated to all kind of projects.
+Please read {guard doc}[http://github.com/guard/guard#readme] for more info about Guardfile DSL.
+
+=== Standard ruby gems
+
+    guard 'nanoc' do
+      watch('^config.yaml')
+      watch('^Rules')
+      watch('^layouts/*')
+      watch('^content/**/*')
+    end
+
+== Development
+
+- Source hosted at {GitHub}[http://github.com/guard/guard-nanoc]
+- Report issues/Questions/Feature requests on {GitHub Issues}[http://github.com/guard/guard-nanoc/issues]
+
+Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
+you make.
+
+== Authors
+
+{Yann Lugrin}[http://github.com/yannlugrin]

data/lib/guard/nanoc.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'guard'
+require 'guard/guard'
+
+module Guard
+  class Nanoc < Guard
+
+    autoload :Runner, 'guard/nanoc/runner'
+
+    def initialize(watchers = [], options = {})
+      super
+
+      @runner = Runner.new(options)
+    end
+
+    def start
+      true
+    end
+
+    def stop
+      true
+    end
+
+    def reload
+      true
+    end
+
+    def run_all
+      @runner.run
+    end
+
+    def run_on_change(paths = [])
+      @runner.run
+    end
+
+  end
+end

data/lib/guard/nanoc/notifier.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require 'guard'
+
+module Guard
+  class NanocNotifier
+
+    def self.guard_message(result, created, updated, skipped, duration)
+      message = ''
+      if result
+        message << "%d created, %d updated, %d skipped\nin %.1f seconds." % [created, updated, skipped, duration]
+      else
+        message << "Site can't be compiled,\nplease check."
+      end
+      message
+    end
+
+    # failed | success
+    def self.guard_image(result)
+      icon = if result
+        :success
+      else
+        :failed
+      end
+    end
+
+    def self.notify(result, created, updated, skipped, duration)
+      message = guard_message(result, created, updated, skipped, duration)
+      image   = guard_image(result)
+
+      ::Guard::Notifier.notify(message, :title => 'Nanoc site', :image => image)
+    end
+
+  end
+end

data/lib/guard/nanoc/runner.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+module Guard
+  class Nanoc
+    class Runner
+      class << self
+        
+        def run(options = {})
+          Runner.new(options).run
+        end
+
+      end
+
+      def initialize(options = {})
+        @options = {
+          :bundler => File.exist?("#{Dir.pwd}/Gemfile"),
+          :rubygems => false,
+          :notify => true
+        }.merge(options)
+      end
+
+      def run(options = {})
+        message = options[:message] || 'Running Nanoc compiler'
+        UI.info message, :reset => true
+        system(nanoc_command)
+      end
+
+      def notify?
+        @options[:notify]
+      end
+
+      def bundler?
+        @options[:bundler]
+      end
+
+      def rubygems?
+        !bundler? && @options[:rubygems]
+      end
+
+      private
+
+      def nanoc_command
+        cmd_parts = []
+        cmd_parts << "bundle exec" if bundler?
+        cmd_parts << 'ruby'
+        cmd_parts << '-r rubygems' if rubygems?
+        cmd_parts << '-r bundler/setup' if bundler?
+        cmd_parts << "-r #{File.expand_path('../runners/default_nanoc_runner.rb', __FILE__)}"
+        if notify?
+          cmd_parts << '-e \'GUARD_NOTIFY=true; DefaultNanocRunner.run\''
+        else
+          cmd_parts << '-e \'GUARD_NOTIFY=false; DefaultNanocRunner.run\''
+        end
+        cmd_parts.join(' ')
+      end
+
+    end
+  end
+end
+

data/lib/guard/nanoc/runners/default_nanoc_runner.rb

@@ -0,0 +1,161 @@
+# encoding: utf-8
+#
+# Some parts of this code come from Nanoc3 and is licenced under MIT
+# with copyright 2007-2010 Denis Defreyne and contributors
+#
+require 'nanoc3'
+require 'nanoc3/cli/logger'
+require 'guard/nanoc/notifier'
+
+class DefaultNanocRunner
+  attr_reader :site, :compiled_reps, :skipped_reps
+
+  class << self
+
+    def run
+      DefaultNanocRunner.new.run
+    end
+
+  end
+
+  def initialize
+    @site = Nanoc3::Site.new('.')
+
+    @compiled_reps = 0
+    @skipped_reps  = 0
+    @rep_times     = {}
+
+    setup_notifications
+  end
+
+  def run
+    start_at = Time.now
+
+    @created_reps = 0
+    @updated_reps = 0
+    @skipped_reps = 0
+    @rep_times    = {}
+
+    begin
+      puts 'Compiling site...'
+      site.load_data
+      site.compiler.run(nil, :force => false)
+
+      # success
+      reps = site.items.map { |i| i.reps }.flatten
+
+      reps.select { |r| !r.compiled? }.each do |rep|
+        next if rep.raw_path.nil?
+        duration = @rep_times[rep.raw_path]
+        Nanoc3::CLI::Logger.instance.file(:high, :skip, rep.raw_path, duration)
+        @skipped_reps += 1
+      end
+      
+      end_at = Time.now - start_at
+      puts
+      puts "Site compiled in %.2f seconds" % end_at
+      Guard::NanocNotifier.notify(true, @created_reps, @updated_reps, @skipped_reps, end_at) if GUARD_NOTIFY
+
+    rescue Exception => e
+      # failure
+      puts 'Failed to compile site'
+      print_error(e)
+      Guard::NanocNotifier.notify(false, 0, 0, 0, Time.now - start_at) if GUARD_NOTIFY
+    end
+
+  end
+
+  private
+
+  def setup_notifications
+    Nanoc3::NotificationCenter.on(:compilation_started) do |rep|
+      @rep_times[rep.raw_path] = Time.now
+    end
+
+    Nanoc3::NotificationCenter.on(:compilation_ended) do |rep|
+      @rep_times[rep.raw_path] = Time.now - @rep_times[rep.raw_path]
+
+      action = if rep.created?
+        @created_reps += 1
+        :create
+      elsif rep.modified?
+        @updated_reps += 1
+        :update
+      elsif !rep.compiled?
+        nil
+      else
+        :identical
+      end
+
+      unless action.nil?
+        duration = @rep_times[rep.raw_path]
+        Nanoc3::CLI::Logger.instance.file(:high, action, rep.raw_path, duration)
+      end
+
+    end
+  end
+
+  def print_error(error)
+    $stderr.puts
+    
+    # Header
+    $stderr.puts '+--- /!\ ERROR /!\ -------------------------------------------+'
+    $stderr.puts '| An exception occured while running nanoc. If you think this |'
+    $stderr.puts '| is a bug in nanoc, please do report it at                   |'
+    $stderr.puts '| <http://projects.stoneship.org/trac/nanoc/newticket> --     |'
+    $stderr.puts '| thanks in advance!                                          |'
+    $stderr.puts '+-------------------------------------------------------------+'
+              
+    # Exception and resolution (if any)
+    $stderr.puts
+    $stderr.puts '=== MESSAGE:'
+    $stderr.puts
+    $stderr.puts "#{error.class}: #{error.message}"
+    resolution = resolution_for(error)
+    $stderr.puts "#{resolution}" if resolution
+    
+    # Compilation stack
+    $stderr.puts
+    $stderr.puts '=== COMPILATION STACK:'
+    $stderr.puts
+    if ((self.site && self.site.compiler.stack) || []).empty?
+      $stderr.puts "  (empty)"
+    else
+      self.site.compiler.stack.reverse.each do |obj|
+        if obj.is_a?(Nanoc3::ItemRep)
+          $stderr.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
+        else # layout
+          $stderr.puts "  - [layout] #{obj.identifier}"
+        end
+      end
+    end
+
+    # Backtrace
+    require 'enumerator'
+    $stderr.puts
+    $stderr.puts '=== BACKTRACE:'
+    $stderr.puts
+    $stderr.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
+  end
+
+  def resolution_for(error)
+    case error
+    when LoadError
+      # Get gem name
+      lib_name = error.message.match(/no such file to load -- ([^\s]+)/)[1]
+      gem_name = GEM_NAMES[$1]
+   
+      # Build message
+      if gem_name
+        "Try installing the '#{gem_name}' gem (`gem install #{gem_name}`) and then re-running the command."
+      end
+    when RuntimeError
+      if error.message =~ /^can't modify frozen/
+        "You attempted to modify immutable data. Some data, such as " \
+        "item/layout attributes and raw item/layout content, can no " \
+        "longer be modified once compilation has started."
+      end
+    end
+  end
+
+end

data/lib/guard/nanoc/templates/Guardfile

@@ -0,0 +1,6 @@
+guard 'nanoc' do
+  watch('^config.yaml')
+  watch('^Rules')
+  watch('^layouts\/')
+  watch('^content\/')
+end

data/lib/guard/nanoc/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module Guard
+  module NanocVersion
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: guard-nanoc
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Yann Lugrin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 2
+        - 1
+        version: 0.2.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nanoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 3
+        - 1
+        - 5
+        version: 3.1.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id004
+description: Guard::Nanoc automatically rebuilds nanoc site files when modified (like nanoc watch)
+email: 
+- yann.lugrin@sans-savoir.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/guard/nanoc.rb
+- lib/guard/nanoc/runners/default_nanoc_runner.rb
+- lib/guard/nanoc/templates/Guardfile
+- lib/guard/nanoc/notifier.rb
+- lib/guard/nanoc/runner.rb
+- lib/guard/nanoc/version.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://rubygems.org/gems/guard-nanoc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --main=README.rdoc
+- --exclude='(lib|test|spec)|(Gem|Guard|Rake)file'
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: guard-nanoc
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Guard gem for Nanoc
+test_files: []
+