nanoc 3.5.0 → 3.6.0

data/Gemfile

@@ -20,6 +20,7 @@ gem 'mime-types'
 gem 'mustache'
 gem 'nokogiri', '~> 1.5.5'
 gem 'pandoc-ruby'
+gem 'pry'
 gem 'pygments.rb'
 gem 'rack'
 gem 'rake'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    nanoc (3.5.0b1)
-      cri (~> 2.2)
+    nanoc (3.6.0)
+      cri (~> 2.3)
 
 GEM
   remote: http://rubygems.org/
@@ -36,11 +36,12 @@ GEM
       nokogiri (~> 1.5.0)
       ruby-hmac
     formatador (0.2.4)
-    haml (3.1.7)
+    haml (4.0.0)
+      tilt
     handlebars (0.3.2)
       commonjs (~> 0.2.3)
       therubyracer (~> 0.11.1)
-    json (1.7.6)
+    json (1.7.7)
     kramdown (0.14.2)
     less (2.2.2)
       commonjs (~> 0.2.6)
@@ -51,26 +52,31 @@ GEM
     maruku (0.6.1)
       syntax (>= 1.0.0)
     metaclass (0.0.1)
-    mime-types (1.19)
-    minitest (4.5.0)
+    method_source (0.8.1)
+    mime-types (1.21)
+    minitest (4.6.1)
     mocha (0.13.2)
       metaclass (~> 0.0.1)
-    multi_json (1.5.0)
+    multi_json (1.6.1)
     mustache (0.99.4)
     net-scp (1.0.4)
       net-ssh (>= 1.99.1)
-    net-ssh (2.6.3)
+    net-ssh (2.6.5)
     nokogiri (1.5.6)
     pandoc-ruby (0.6.0)
     posix-spawn (0.3.6)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     pygments.rb (0.3.7)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.1.0)
-    rack (1.5.0)
+    rack (1.5.2)
     rainpress (1.0)
     rake (10.0.3)
-    rdiscount (1.6.8)
-    rdoc (3.12)
+    rdiscount (2.0.7)
+    rdoc (3.12.1)
       json (~> 1.4)
     redcarpet (2.2.2)
     ref (1.0.2)
@@ -80,6 +86,7 @@ GEM
     slim (1.3.6)
       temple (~> 0.5.5)
       tilt (~> 1.3.3)
+    slop (3.4.3)
     syntax (1.0.0)
     systemu (2.5.2)
     temple (0.5.5)
@@ -96,7 +103,7 @@ GEM
       json
       nokogiri
     yajl-ruby (1.1.0)
-    yard (0.8.3)
+    yard (0.8.4.1)
     yuicompressor (1.2.0)
 
 PLATFORMS
@@ -125,6 +132,7 @@ DEPENDENCIES
   nanoc!
   nokogiri (~> 1.5.5)
   pandoc-ruby
+  pry
   pygments.rb
   rack
   rainpress

data/NEWS.md

@@ -1,5 +1,28 @@
 # nanoc news
 
+## 3.6 (2013-02-24)
+
+Features:
+
+* Added `sync` command, allowing data sources to update local caches of
+  external data [Justin Hileman]
+* Added `#ignore` compiler DSL method
+* Allowed accessing items by identifier using e.g. `@items['/about/']`
+* Added `shell` command
+
+Enhancements:
+
+* Renamed the nanoc configuration file from `config.yaml` to `nanoc.yaml`
+
+Fixes:
+
+* Updated references to old web site and old repository
+* Made `require` errors mention Bundler if appropriate
+* Fixed bug which caused pruner not to delete directories in some cases [@reima]
+* Made `check` command exit with the proper exit status
+* Added support for the `HTML_TOC` Redcarpet renderer
+* Made `stale` check honor files excluded by the pruner
+
 ## 3.5 (2013-01-27)
 
 Major changes:

data/README.md

@@ -1,3 +1,8 @@
+[![Build Status](https://travis-ci.org/nanoc/nanoc.png)](https://travis-ci.org/nanoc/nanoc)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/nanoc/nanoc)
+
+**Please take a moment and [donate](http://pledgie.com/campaigns/9282) to nanoc. A lot of time has gone into developing nanoc, and I would like to keep the current pace. Your support will ensure that nanoc will continue to improve.**
+
 # nanoc 3
 
 nanoc is a simple but very flexible static site generator written in Ruby.
@@ -9,9 +14,7 @@ Note: This documentation looks best with Yardoc, not RDoc.
 
 ## Resources
 
-The [nanoc web site](http://nanoc.stoneship.org) contains a few useful
-resources to help you get started with nanoc. If you need further assistance,
-the following places will help you out:
+The [nanoc web site](http://nanoc.ws) contains a few useful resources to help you get started with nanoc. If you need further assistance, the following places will help you out:
 
 * The [discussion group](http://groups.google.com/group/nanoc)
 * The [IRC channel](irc://chat.freenode.net/#nanoc)

data/doc/yardoc_templates/default/layout/html/footer.erb

@@ -1,10 +1,19 @@
 <%= superb %>
 <script type="text/javascript">
-var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
-document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+    var _gaq = _gaq || [];
+    var pluginUrl = '//www.google-analytics.com/plugins/ga/inpage_linkid.js';
+    _gaq.push(['_require', 'inpage_linkid', pluginUrl]);
+    _gaq.push(['_setAccount', 'UA-15639968-1']);
+    _gaq.push(['_setDomainName', 'nanoc.ws']);
+    _gaq.push(['_setAllowLinker', true]);
+    _gaq.push(['_trackPageview']);
+
+    (function() {
+        var ga = document.createElement('script');
+        ga.type = 'text/javascript';
+        ga.async = true;
+        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+        var s = document.getElementsByTagName('script')[0];
+        s.parentNode.insertBefore(ga, s);
+     })();
 </script>
-<script type="text/javascript">
-try {
-var pageTracker = _gat._getTracker("UA-15639968-1");
-pageTracker._trackPageview();
-} catch(err) {}</script>

data/lib/nanoc.rb

@@ -3,7 +3,7 @@
 module Nanoc
 
   # The current nanoc version.
-  VERSION = '3.5.0'
+  VERSION = '3.6.0'
 
   # @return [String] A string containing information about this nanoc version
   #   and its environment (Ruby engine and version, Rubygems version if any).

data/lib/nanoc/base.rb

@@ -19,6 +19,7 @@ module Nanoc
   autoload 'Configuration',        'nanoc/base/source_data/configuration'
   autoload 'DataSource',           'nanoc/base/source_data/data_source'
   autoload 'Item',                 'nanoc/base/source_data/item'
+  autoload 'ItemArray',            'nanoc/base/source_data/item_array'
   autoload 'Layout',               'nanoc/base/source_data/layout'
   autoload 'Site',                 'nanoc/base/source_data/site'
 

data/lib/nanoc/base/compilation/compiler_dsl.rb

@@ -190,6 +190,37 @@ module Nanoc
       @rules_collection.add_item_routing_rule(routing_rule)
     end
 
+    # Creates a pair of compilation and routing rules that indicate that the
+    # specified item(s) should be ignored, e.g. compiled and routed with an
+    # empty rule. The items are selected using an identifier, which may either
+    # be a string containing the `*` wildcard, or a regular expression.
+    #
+    # This meta-rule will be applicable to reps with a name equal to
+    # `:default`; this can be changed by giving an explicit `:rep` parameter.
+    #
+    # @param [String] identifier A pattern matching identifiers of items that
+    #   should be processed using this meta-rule
+    #
+    # @option params [Symbol] :rep (:default) The name of the representation
+    #   that should be routed using this rule
+    #
+    # @return [void]
+    #
+    # @example Suppressing compilation and output for all all `/foo/*` items.
+    #
+    #     ignore '/foo/*'
+    def ignore(identifier, params={})
+      raise ArgumentError.new("#ignore does not require a block") if block_given?
+
+      rep_name = params[:rep] || :default
+
+      compilation_rule = Rule.new(identifier_to_regex(identifier), rep_name, proc { })
+      @rules_collection.add_item_compilation_rule(compilation_rule)
+
+      routing_rule = Rule.new(identifier_to_regex(identifier), rep_name, proc { }, :snapshot_name => :last)
+      @rules_collection.add_item_routing_rule(routing_rule)
+    end
+
     # Includes an additional rules file in the current rules collection.
     #
     # @param [String] name The name of the rules file — an ".rb" extension is

data/lib/nanoc/base/compilation/filter.rb

@@ -77,6 +77,31 @@ module Nanoc
         (@to || :text) == :binary
       end
 
+      # @overload requires(*requires)
+      #   Sets the required libraries for this filter.
+      #   @param [Array<String>] requires A list of library names that are required
+      #   @return [void]
+      # @overload requires
+      #   Returns the required libraries for this filter.
+      #   @return [Enumerable<String>] This filter’s list of library names that are required
+      def requires(*requires)
+        if requires.size > 0
+          @requires = requires
+        else
+          @requires || []
+        end
+      end
+
+      # Requires the filter’s required library if necessary.
+      #
+      # @return [void]
+      def setup
+        @setup ||= begin
+          self.requires.each { |r| require r }
+          true
+        end
+      end
+
     end
 
     # Creates a new filter that has access to the given assigns.
@@ -88,6 +113,15 @@ module Nanoc
       super
     end
 
+    # Sets up the filter and runs the filter. This method passes its arguments
+    # to {#run} unchanged and returns the return value from {#run}.
+    #
+    # @see {#run}
+    def setup_and_run(*args)
+      self.class.setup
+      self.run(*args)
+    end
+
     # Runs the filter on the given content or filename.
     #
     # @abstract

data/lib/nanoc/base/result_data/item_rep.rb

@@ -333,7 +333,7 @@ module Nanoc
 
         # Run filter
         source = self.binary? ? temporary_filenames[:last] : @content[:last]
-        result = filter.run(source, filter_args)
+        result = filter.setup_and_run(source, filter_args)
         if klass.to_binary?
           temporary_filenames[:last] = filter.output_filename
         else
@@ -398,7 +398,7 @@ module Nanoc
         Nanoc::NotificationCenter.post(:filtering_started,  self, filter_name)
 
         # Layout
-        @content[:last] = filter.run(layout.raw_content, filter_args)
+        @content[:last] = filter.setup_and_run(layout.raw_content, filter_args)
 
         # Create "post" snapshot
         snapshot(:post, :final => false)
@@ -458,7 +458,7 @@ module Nanoc
     end
 
     def inspect
-      "<#{self.class} name=#{self.name} binary=#{self.binary?} raw_path=#{self.raw_path} item.identifier=#{self.item.identifier}>"
+      "<#{self.class} name=\"#{self.name}\" binary=#{self.binary?} raw_path=\"#{self.raw_path}\" item.identifier=\"#{self.item.identifier}\">"
     end
 
   private

data/lib/nanoc/base/source_data/code_snippet.rb

@@ -44,7 +44,7 @@ module Nanoc
     end
 
     def inspect
-      "<#{self.class} filename=#{self.filename}>"
+      "<#{self.class} filename=\"#{self.filename}\">"
     end
 
     # @return [String] The checksum for this object. If its contents change,

data/lib/nanoc/base/source_data/data_source.rb

@@ -148,6 +148,18 @@ module Nanoc
     def update
     end
 
+    # Sync the content for this data source with an external source.
+    # This method is called by the `nanoc sync` command so that data sources may
+    # update local caches of external data, such as items fetched from
+    # third-party APIs.
+    #
+    # Subclasses may override this method, but are not required to do so; the
+    # default implementation simply does nothing.
+    #
+    # @return [void]
+    def sync
+    end
+
     # Returns the list of items (represented by {Nanoc::Item}) in this site.
     # The default implementation simply returns an empty array.
     #

data/lib/nanoc/base/source_data/item.rb

@@ -240,7 +240,7 @@ module Nanoc
     end
 
     def inspect
-      "<#{self.class} identifier=#{self.identifier} binary?=#{self.binary?}>"
+      "<#{self.class} identifier=\"#{self.identifier}\" binary?=#{self.binary?}>"
     end
 
     # @return [String] The checksum for this object. If its contents change,

data/lib/nanoc/base/source_data/item_array.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+module Nanoc
+
+  # Acts as an array, but allows fetching items using identifiers, e.g. `@items['/blah/']`.
+  class ItemArray
+
+    include Enumerable
+
+    extend Forwardable
+
+    DELEGATED_METHODS = Array.instance_methods + Enumerable.instance_methods - [ :[], :slice, :at, :initialize, :freeze ]
+    def_delegators :@items, *DELEGATED_METHODS
+
+    def initialize
+      @items = []
+    end
+
+    def freeze
+      @items.freeze
+      self.build_mapping
+      super
+    end
+
+    def [](*args)
+      if 1 == args.size && args.first.is_a?(String)
+        self.item_with_identifier(args.first)
+      else
+        @items[*args]
+      end
+    end
+    alias_method :slice, :[]
+
+    def at(arg)
+      if arg.is_a?(String)
+        self.item_with_identifier(arg)
+      else
+        @items[arg]
+      end
+    end
+
+    protected
+
+    def item_with_identifier(identifier)
+      if self.frozen?
+        @mapping[identifier]
+      else
+        @items.find { |i| i.identifier == identifier }
+      end
+    end
+
+    def build_mapping
+      @mapping = {}
+      @items.each do |item|
+        @mapping[item.identifier] = item
+      end
+      @mapping.freeze
+    end
+
+  end
+
+end

data/lib/nanoc/base/source_data/layout.rb

@@ -82,7 +82,7 @@ module Nanoc
     end
 
     def inspect
-      "<#{self.class} identifier=#{self.identifier}>"
+      "<#{self.class} identifier=\"#{self.identifier}\">"
     end
 
     # @return [String] The checksum for this object. If its contents change,

data/lib/nanoc/base/source_data/site.rb

@@ -277,6 +277,21 @@ module Nanoc
       @unloading = false
     end
 
+    # @return [Boolean] true if the current working directory is a nanoc site, false otherwise
+    #
+    # @api private
+    def self.cwd_is_nanoc_site?
+      !self.config_filename_for_cwd.nil?
+    end
+
+    # @return [String] filename of the nanoc config file in the current working directory, or nil if there is none
+    #
+    # @api private
+    def self.config_filename_for_cwd
+      filenames = %w( nanoc.yaml config.yaml )
+      filenames.find { |f| File.file?(f) }
+    end
+
   private
 
     # Loads this site’s code and executes it.
@@ -305,7 +320,7 @@ module Nanoc
       @items_loaded = true
 
       # Get items
-      @items = []
+      @items = Nanoc::ItemArray.new
       data_sources.each do |ds|
         items_in_ds = ds.items
         items_in_ds.each do |i|
@@ -340,8 +355,14 @@ module Nanoc
           warn 'WARNING: Calling Nanoc::Site.new with a directory that is not the current working directory is not supported. It is recommended to change the directory before calling Nanoc::Site.new. For example, instead of Nanoc::Site.new(\'abc\'), use Dir.chdir(\'abc\') { Nanoc::Site.new(\'.\') }.'
         end
 
-        # Read config from config.yaml in given dir
-        config_path = File.join(dir_or_config_hash, 'config.yaml')
+        # Read config from nanoc.yaml/config.yaml in given dir
+        config_path = Dir.chdir(dir_or_config_hash) do
+          filename = self.class.config_filename_for_cwd
+          if filename.nil?
+            raise Nanoc::Errors::GenericTrivial, 'Could not find nanoc.yaml or config.yaml in the current working directory'
+          end
+          File.join(dir_or_config_hash, filename)
+        end
         @config = DEFAULT_CONFIG.merge(YAML.load_file(config_path).symbolize_keys_recursively)
         @config[:data_sources].map! { |ds| ds.symbolize_keys_recursively }
       else