nanoc 4.0.0a1 → 4.0.0a2

data/lib/nanoc/base/views/mutable_item_collection.rb

@@ -7,12 +7,37 @@ module Nanoc
       Nanoc::MutableItemView
     end
 
+    # Creates a new item and adds it to the site’s collection of items.
+    #
+    # @param [String] content The uncompiled item content (if it is a textual
+    #   item) or the path to the filename containing the content (if it is a
+    #   binary item).
+    #
+    # @param [Hash] attributes A hash containing this item's attributes.
+    #
+    # @param [Nanoc::Identifier, String] identifier This item's identifier.
+    #
+    # @param [Hash] params Extra parameters.
+    #
+    # @option params [Symbol, nil] :binary (true) Whether or not this item is
+    #   binary
+    #
+    # @return [self]
     def create(content, attributes, identifier, params = {})
       @items << Nanoc::Int::Item.new(content, attributes, identifier, params)
+      self
     end
 
+    # Deletes every item for which the block evaluates to true.
+    #
+    # @yieldparam [Nanoc::ItemView] item
+    #
+    # @yieldreturn [Boolean]
+    #
+    # @return [self]
     def delete_if(&block)
       @items.delete_if(&block)
+      self
     end
   end
 end

data/lib/nanoc/base/views/mutable_layout.rb

@@ -2,6 +2,11 @@
 
 module Nanoc
   class MutableLayoutView < Nanoc::LayoutView
+    # Sets the value for the given attribute.
+    #
+    # @param [Symbol] key
+    #
+    # @see Hash#[]=
     def []=(key, value)
       unwrap[key] = value
     end

data/lib/nanoc/base/views/mutable_layout_collection.rb

@@ -7,12 +7,30 @@ module Nanoc
       Nanoc::MutableLayoutView
     end
 
-    def create(content, attributes, identifier, params = {})
-      @layouts << Nanoc::Int::Layout.new(content, attributes, identifier, params)
+    # Creates a new layout and adds it to the site’s collection of layouts.
+    #
+    # @param [String] content The layout content.
+    #
+    # @param [Hash] attributes A hash containing this layout's attributes.
+    #
+    # @param [Nanoc::Identifier, String] identifier This layout's identifier.
+    #
+    # @return [self]
+    def create(content, attributes, identifier)
+      @layouts << Nanoc::Int::Layout.new(content, attributes, identifier)
+      self
     end
 
+    # Deletes every layout for which the block evaluates to true.
+    #
+    # @yieldparam [Nanoc::LayoutView] layout
+    #
+    # @yieldreturn [Boolean]
+    #
+    # @return [self]
     def delete_if(&block)
       @layouts.delete_if(&block)
+      self
     end
   end
 end

data/lib/nanoc/cli/cleaning_stream.rb

@@ -119,6 +119,21 @@ module Nanoc::CLI
       @stream.winsize = (arg)
     end
 
+    # @see IO.sync
+    def sync
+      @stream.sync
+    end
+
+    # @see IO.sync=
+    def sync=(arg)
+      @stream.sync = arg
+    end
+
+    # @see IO.sync=
+    def external_encoding
+      @stream.external_encoding
+    end
+
     protected
 
     def _nanoc_clean(s)

data/lib/nanoc/cli/commands/create-site.rb

@@ -19,6 +19,11 @@ module Nanoc::CLI::Commands
     end
 
     DEFAULT_CONFIG = <<EOS unless defined? DEFAULT_CONFIG
+# The syntax to use for patterns in the Rules file. Can be either `"glob"`
+# (default) or `null`. The former will enable glob patterns, which behave like
+# Ruby’s File.fnmatch. The latter will enable nanoc 3.x-style patterns.
+pattern_syntax: glob
+
 # A list of file extensions that nanoc will consider to be textual rather than
 # binary. If an item with an extension not in this list is found,  the file
 # will be considered as binary.
@@ -83,6 +88,8 @@ data_sources:
     # UTF-8 (which they should be!), change this.
     encoding: utf-8
 
+    identifier_style: full
+
 # Configuration for the “check” command, which run unit tests on the site.
 checks:
   # Configuration for the “internal_links” checker, which checks whether all
@@ -98,44 +105,19 @@ EOS
     DEFAULT_RULES = <<EOS unless defined? DEFAULT_RULES
 #!/usr/bin/env ruby
 
-# A few helpful tips about the Rules file:
-#
-# * The string given to #compile and #route are matching patterns for
-#   identifiers--not for paths. Therefore, you can’t match on extension.
-#
-# * The order of rules is important: for each item, only the first matching
-#   rule is applied.
-#
-# * Item identifiers start and end with a slash (e.g. “/about/” for the file
-#   “content/about.html”). To select all children, grandchildren, … of an
-#   item, use the pattern “/about/*/”; “/about/*” will also select the parent,
-#   because “*” matches zero or more characters.
-
-compile '*' do
-  if item[:extension] == 'css'
-    # don’t filter stylesheets
-  elsif item.binary?
-    # don’t filter binary items
-  else
-    filter :erb
-    layout 'default'
-  end
+compile '/**/*.html' do
+  filter :erb
+  layout '/default.*'
 end
 
-route '*' do
-  if item[:extension] == 'css'
-    # Write item with identifier /foo/ to /foo.css
-    item.identifier.chop + '.css'
-  elsif item.binary?
-    # Write item with identifier /foo/ to /foo.ext
-    item.identifier.chop + (item[:extension] ? '.' + item[:extension] : '')
-  else
-    # Write item with identifier /foo/ to /foo/index.html
-    item.identifier + 'index.html'
-  end
+compile '/**/*' do
+end
+
+route '/**/*' do
+  item.identifier.to_s
 end
 
-layout '*', :erb
+layout '/**/*', :erb
 EOS
 
     DEFAULT_ITEM = <<EOS unless defined? DEFAULT_ITEM
@@ -261,7 +243,7 @@ EOS
   <head>
     <meta charset="utf-8">
     <title>A Brand New nanoc Site - <%= @item[:title] %></title>
-    <link rel="stylesheet" href="<%= @items['/stylesheet/'].path %>">
+    <link rel="stylesheet" href="<%= @items['/stylesheet.*'].path %>">
 
     <!-- you don't need to keep this, but it's cool for stats! -->
     <meta name="generator" content="nanoc <%= Nanoc::VERSION %>">

data/lib/nanoc/cli/commands/shell.rb

@@ -20,11 +20,14 @@ module Nanoc::CLI::Commands
     protected
 
     def env
+      self.class.env_for_site(site)
+    end
+
+    def self.env_for(site)
       {
-        site: site,
-        items: site.items,
-        layouts: site.layouts,
-        config: site.config
+        items: Nanoc::ItemCollectionView.new(site.items),
+        layouts: Nanoc::LayoutCollectionView.new(site.layouts),
+        config: Nanoc::ConfigView.new(site.config),
       }
     end
   end

data/lib/nanoc/data_sources.rb

@@ -5,7 +5,6 @@ module Nanoc::DataSources
   autoload 'Filesystem',         'nanoc/data_sources/filesystem'
   autoload 'FilesystemUnified',  'nanoc/data_sources/filesystem_unified'
   autoload 'FilesystemVerbose',  'nanoc/data_sources/filesystem_verbose'
-  autoload 'Static',             'nanoc/data_sources/static'
 
   Nanoc::DataSource.register '::Nanoc::DataSources::FilesystemVerbose',  :filesystem_verbose
   Nanoc::DataSource.register '::Nanoc::DataSources::FilesystemUnified',  :filesystem_unified

data/lib/nanoc/data_sources/filesystem.rb

@@ -33,15 +33,6 @@ module Nanoc::DataSources
 
     protected
 
-    # Creates a new object (item or layout) on disk in dir_name according to
-    # the given identifier. The file will have its attributes taken from the
-    # attributes hash argument and its content from the content argument.
-    def create_object(_dir_name, _content, _attributes, _identifier, _params = {})
-      raise NotImplementedError.new(
-        "#{self.class} does not implement ##{name}"
-      )
-    end
-
     # Creates instances of klass corresponding to the files in dir_name. The
     # kind attribute indicates the kind of object that is being loaded and is
     # used solely for debugging purposes.
@@ -54,96 +45,104 @@ module Nanoc::DataSources
     #
     # @see Nanoc::DataSources::Filesystem#load_objects
     def load_objects(dir_name, kind, klass)
-      all_split_files_in(dir_name).map do |base_filename, (meta_ext, content_ext)|
-        # Get filenames
-        meta_filename    = filename_for(base_filename, meta_ext)
-        content_filename = filename_for(base_filename, content_ext)
-
-        # Read content and metadata
-        is_binary = content_filename && !@site.config[:text_extensions].include?(File.extname(content_filename)[1..-1])
-        if is_binary && klass == Nanoc::Int::Item
-          meta                = (meta_filename && YAML.load_file(meta_filename)) || {}
-          content_or_filename = content_filename
-        elsif is_binary && klass == Nanoc::Int::Layout
-          raise "The layout file '#{content_filename}' is a binary file, but layouts can only be textual"
-        else
-          meta, content_or_filename = parse(content_filename, meta_filename, kind)
-        end
-
-        # Get attributes
-        attributes = {
-          filename: content_filename,
-          content_filename: content_filename,
-          meta_filename: meta_filename,
-          extension: content_filename ? ext_of(content_filename)[1..-1] : nil,
-        }.merge(meta)
-
-        # Get identifier
-        if meta_filename
-          identifier = identifier_for_filename(meta_filename[(dir_name.length + 1)..-1])
-        elsif content_filename
-          identifier = identifier_for_filename(content_filename[(dir_name.length + 1)..-1])
-        else
-          raise 'meta_filename and content_filename are both nil'
+      res = []
+
+      all_split_files_in(dir_name).each do |base_filename, (meta_ext, content_exts)|
+        content_exts.each do |content_ext|
+          # Get filenames
+          meta_filename    = filename_for(base_filename, meta_ext)
+          content_filename = filename_for(base_filename, content_ext)
+
+          # Read content and metadata
+          is_binary = content_filename && !@site.config[:text_extensions].include?(File.extname(content_filename)[1..-1])
+          if is_binary && klass == Nanoc::Int::Item
+            meta                = (meta_filename && YAML.load_file(meta_filename)) || {}
+            content_or_filename = content_filename
+          elsif is_binary && klass == Nanoc::Int::Layout
+            raise "The layout file '#{content_filename}' is a binary file, but layouts can only be textual"
+          else
+            meta, content_or_filename = parse(content_filename, meta_filename, kind)
+          end
+
+          # Get attributes
+          attributes = {
+            filename: content_filename,
+            content_filename: content_filename,
+            meta_filename: meta_filename,
+            extension: content_filename ? ext_of(content_filename)[1..-1] : nil,
+          }.merge(meta)
+
+          # Get identifier
+          if meta_filename
+            identifier = identifier_for_filename(meta_filename[dir_name.length..-1])
+          elsif content_filename
+            identifier = identifier_for_filename(content_filename[dir_name.length..-1])
+          else
+            raise 'meta_filename and content_filename are both nil'
+          end
+
+          # Get modification times
+          meta_mtime = meta_filename ? File.stat(meta_filename).mtime : nil
+          content_mtime = content_filename ? File.stat(content_filename).mtime : nil
+          if meta_mtime && content_mtime
+            mtime = meta_mtime > content_mtime ? meta_mtime : content_mtime
+          elsif meta_mtime
+            mtime = meta_mtime
+          elsif content_mtime
+            mtime = content_mtime
+          else
+            raise 'meta_mtime and content_mtime are both nil'
+          end
+
+          # Create layout object
+          res << klass.new(
+            content_or_filename, attributes, identifier,
+            binary: is_binary, mtime: mtime
+          )
         end
-
-        # Get modification times
-        meta_mtime = meta_filename ? File.stat(meta_filename).mtime : nil
-        content_mtime = content_filename ? File.stat(content_filename).mtime : nil
-        if meta_mtime && content_mtime
-          mtime = meta_mtime > content_mtime ? meta_mtime : content_mtime
-        elsif meta_mtime
-          mtime = meta_mtime
-        elsif content_mtime
-          mtime = content_mtime
-        else
-          raise 'meta_mtime and content_mtime are both nil'
-        end
-
-        # Create layout object
-        klass.new(
-          content_or_filename, attributes, identifier,
-          binary: is_binary, mtime: mtime
-        )
       end
+
+      res
     end
 
-    # Finds all items/layouts/... in the given base directory. Returns a hash
-    # in which the keys are the file's dirname + basenames, and the values a
-    # pair consisting of the metafile extension and the content file
-    # extension. The meta file extension or the content file extension can be
-    # nil, but not both. Backup files are ignored. For example:
+    # e.g.
     #
     #   {
-    #     'content/foo' => [ 'yaml', 'html' ],
-    #     'content/bar' => [ 'yaml', nil    ],
-    #     'content/qux' => [ nil,    'html' ]
+    #     'content/foo' => [ 'yaml', ['html', 'md'] ],
+    #     'content/bar' => [ 'yaml', [nil]          ],
+    #     'content/qux' => [ nil,    ['html']       ]
     #   }
     def all_split_files_in(dir_name)
-      grouped_filenames =
+      by_basename =
         all_files_in(dir_name)
         .reject   { |fn| fn =~ /(~|\.orig|\.rej|\.bak)$/ }
         .group_by { |fn| basename_of(fn) }
 
-      grouped_filenames.each_pair do |key, filenames|
+      all = {}
+
+      by_basename.each_pair do |basename, filenames|
         # Divide
         meta_filenames    = filenames.select { |fn| ext_of(fn) == '.yaml' }
         content_filenames = filenames.select { |fn| ext_of(fn) != '.yaml' }
 
         # Check number of files per type
         unless [0, 1].include?(meta_filenames.size)
-          raise "Found #{meta_filenames.size} meta files for #{key}; expected 0 or 1"
+          raise "Found #{meta_filenames.size} meta files for #{basename}; expected 0 or 1"
         end
-        unless [0, 1].include?(content_filenames.size)
-          raise "Found #{content_filenames.size} content files for #{key}; expected 0 or 1"
+        unless config[:identifier_style] == 'full'
+          unless [0, 1].include?(content_filenames.size)
+            raise "Found #{content_filenames.size} content files for #{basename}; expected 0 or 1"
+          end
         end
 
-        # Reorder elements and convert to extnames
-        filenames[0] = meta_filenames[0] ? 'yaml' : nil
-        filenames[1] = content_filenames[0] ? ext_of(content_filenames[0])[1..-1] || '' : nil
+        all[basename] = []
+        all[basename][0] =
+          meta_filenames[0] ? 'yaml' : nil
+        all[basename][1] =
+          content_filenames.any? ? content_filenames.map { |fn| ext_of(fn)[1..-1] || '' } : [nil]
       end
 
-      grouped_filenames
+      all
     end
 
     # Returns all files in the given directory and directories below it.

data/lib/nanoc/data_sources/filesystem_unified.rb

@@ -73,33 +73,6 @@ module Nanoc::DataSources
 
     private
 
-    # See {Nanoc::DataSources::Filesystem#create_object}.
-    def create_object(dir_name, content, attributes, identifier, params = {})
-      # Check for periods
-      if (@config.nil? || !@config[:allow_periods_in_identifiers]) && identifier.include?('.')
-        raise "Attempted to create an object in #{dir_name} with identifier #{identifier} containing a period, but allow_periods_in_identifiers is not enabled in the site configuration. (Enabling allow_periods_in_identifiers may cause the site to break, though.)"
-      end
-
-      # Determine path
-      ext = params[:extension] || '.html'
-      path = dir_name + (identifier == '/' ? '/index.html' : identifier[0..-2] + ext)
-      parent_path = File.dirname(path)
-
-      # Notify
-      Nanoc::Int::NotificationCenter.post(:file_created, path)
-
-      # Write item
-      FileUtils.mkdir_p(parent_path)
-      File.open(path, 'w') do |io|
-        meta = attributes.__nanoc_stringify_keys_recursively
-        unless meta == {}
-          io.write(YAML.dump(meta).strip + "\n")
-          io.write("---\n")
-        end
-        io.write(content)
-      end
-    end
-
     # See {Nanoc::DataSources::Filesystem#filename_for}.
     def filename_for(base_filename, ext)
       if ext.nil?
@@ -114,6 +87,10 @@ module Nanoc::DataSources
     # Returns the identifier derived from the given filename, first stripping
     # the given directory name off the filename.
     def identifier_for_filename(filename)
+      if config[:identifier_style] == 'full'
+        return Nanoc::Identifier.new(filename, style: :full)
+      end
+
       if filename =~ /(^|\/)index(\.[^\/]+)?$/
         regex = @config && @config[:allow_periods_in_identifiers] ? /\/?(index)?(\.[^\/\.]+)?$/ : /\/?index(\.[^\/]+)?$/
       else