nanoc 4.0.0b1 → 4.0.0b2

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

@@ -1,95 +1,10 @@
 # encoding: utf-8
 
 module Nanoc
-  class ItemCollectionView
-    include Enumerable
-
-    # @api private
-    def initialize(items)
-      @items = items
-    end
-
-    # @api private
-    def unwrap
-      @items
-    end
-
+  class ItemCollectionView < ::Nanoc::IdentifiableCollectionView
     # @api private
     def view_class
       Nanoc::ItemView
     end
-
-    # Calls the given block once for each item, passing that item as a parameter.
-    #
-    # @yieldparam [Nanoc::ItemView] item
-    #
-    # @yieldreturn [void]
-    #
-    # @return [self]
-    def each
-      @items.each { |i| yield view_class.new(i) }
-      self
-    end
-
-    # @return [Integer]
-    def size
-      @items.size
-    end
-
-    # @overload at(string)
-    #
-    #   Finds the item whose identifier matches the given string.
-    #
-    #   @param [String] string
-    #
-    #   @return [nil] if no item matches the string
-    #
-    #   @return [Nanoc::ItemView] if an item was found
-    def at(arg)
-      item = @items.at(arg)
-      item && view_class.new(item)
-    end
-
-    # Finds all items whose identifier matches the given argument.
-    #
-    # @param [String, Regex] arg
-    #
-    # @return [Enumerable<Nanoc::ItemView>]
-    def find_all(arg)
-      pat = Nanoc::Int::Pattern.from(arg)
-      @items.select { |i| pat.match?(i.identifier) }
-    end
-
-    # @overload [](string)
-    #
-    #   Finds the item whose identifier matches the given string.
-    #
-    #   If the glob syntax is enabled, the string can be a glob, in which case
-    #   this method finds the first item that matches the given glob.
-    #
-    #   @param [String] string
-    #
-    #   @return [nil] if no item matches the string
-    #
-    #   @return [Nanoc::ItemView] if an item was found
-    #
-    # @overload [](regex)
-    #
-    #   Finds the item whose identifier matches the given regular expression.
-    #
-    #   @param [Regex] regex
-    #
-    #   @return [nil] if no item matches the regex
-    #
-    #   @return [Nanoc::ItemView] if an item was found
-    def [](arg)
-      res = @items[arg]
-      case res
-      when nil
-        nil
-      else
-        view_class.new(res)
-      end
-    end
   end
 end

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

@@ -1,66 +1,10 @@
 # encoding: utf-8
 
 module Nanoc
-  class LayoutCollectionView
-    include Enumerable
-
-    # @api private
-    def initialize(layouts)
-      @layouts = layouts
-    end
-
-    # @api private
-    def unwrap
-      @layouts
-    end
-
+  class LayoutCollectionView < ::Nanoc::IdentifiableCollectionView
     # @api private
     def view_class
       Nanoc::LayoutView
     end
-
-    # Calls the given block once for each layout, passing that layout as a parameter.
-    #
-    # @yieldparam [Nanoc::LayoutView] layout
-    #
-    # @yieldreturn [void]
-    def each
-      @layouts.each { |l| yield view_class.new(l) }
-      self
-    end
-
-    # @overload [](string)
-    #
-    #   Finds the item whose identifier matches the given string.
-    #
-    #   If the glob syntax is enabled, the string can be a glob, in which case
-    #   this method finds the first item that matches the given glob.
-    #
-    #   @param [String] string
-    #
-    #   @return [nil] if no item matches the string
-    #
-    #   @return [Nanoc::ItemView] if an item was found
-    #
-    # @overload [](regex)
-    #
-    #   Finds the item whose identifier matches the given regular expression.
-    #
-    #   @param [Regex] regex
-    #
-    #   @return [nil] if no item matches the regex
-    #
-    #   @return [Nanoc::ItemView] if an item was found
-    def [](arg)
-      layout = @layouts.find { |l| l.identifier == arg }
-      return view_class.new(layout) if layout
-
-      # FIXME: this should only work if globs are enabled
-      pat = Nanoc::Int::Pattern.from(arg)
-      layout = @layouts.find { |l| pat.match?(l.identifier) }
-      return view_class.new(layout) if layout
-
-      nil
-    end
   end
 end

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

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Nanoc
+  class MutableIdentifiableCollectionView < Nanoc::IdentifiableCollectionView
+    # Deletes every object for which the block evaluates to true.
+    #
+    # @yieldparam [#identifier] object
+    #
+    # @yieldreturn [Boolean]
+    #
+    # @return [self]
+    def delete_if(&block)
+      @objects.delete_if { |o| yield(view_class.new(o)) }
+      self
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Nanoc
-  class MutableItemCollectionView < Nanoc::ItemCollectionView
+  class MutableItemCollectionView < Nanoc::MutableIdentifiableCollectionView
     # @api private
     def view_class
       Nanoc::MutableItemView
@@ -24,19 +24,7 @@ module Nanoc
     #
     # @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)
+      @objects << Nanoc::Int::Item.new(content, attributes, identifier, params)
       self
     end
   end

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Nanoc
-  class MutableLayoutCollectionView < Nanoc::LayoutCollectionView
+  class MutableLayoutCollectionView < Nanoc::MutableIdentifiableCollectionView
     # @api private
     def view_class
       Nanoc::MutableLayoutView
@@ -17,19 +17,7 @@ module Nanoc
     #
     # @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)
+      @objects << Nanoc::Int::Layout.new(content, attributes, identifier)
       self
     end
   end

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

@@ -6,6 +6,7 @@ summary 'create a site'
 description "
 Create a new site at the given path. The site will use the `filesystem_unified` data source by default, but this can be changed using the `--datasource` command-line option.
 "
+flag nil, :force, "Force creation of new site. Disregards previous existence of site in destination"
 
 module Nanoc::CLI::Commands
   class CreateSite < ::Nanoc::CLI::CommandRunner
@@ -20,9 +21,9 @@ module Nanoc::CLI::Commands
 
     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
+# (default) or `"legacy"`. The former will enable glob patterns, which behave
+# like Ruby’s File.fnmatch. The latter will enable nanoc 3.x-style patterns.
+string_pattern_type: 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
@@ -47,8 +48,8 @@ enable_output_diff: false
 
 prune:
   # Whether to automatically remove files not managed by nanoc from the output
-  # directory. For safety reasons, this is turned off by default.
-  auto_prune: false
+  # directory.
+  auto_prune: true
 
   # Which files and directories you want to exclude from pruning. If you version
   # your output directory, you should probably exclude VCS directories such as
@@ -88,7 +89,7 @@ data_sources:
     # UTF-8 (which they should be!), change this.
     encoding: utf-8
 
-    identifier_style: full
+    identifier_type: full
 
 # Configuration for the “check” command, which run unit tests on the site.
 checks:
@@ -106,13 +107,29 @@ EOS
 #!/usr/bin/env ruby
 
 compile '/**/*.html' do
-  filter :erb
   layout '/default.*'
 end
 
+# This is an example rule that matches Markdown (.md) files, and filters them
+# using the :kramdown filter. It is commented out by default, because kramdown
+# is not bundled with nanoc or Ruby.
+#
+#compile '/**/*.md' do
+#  filter :kramdown
+#  layout '/default.*'
+#end
+
 compile '/**/*' do
 end
 
+route '/**/*.{html,md}' do
+  if item.identifier =~ '/index.*'
+    '/index.html'
+  else
+    item.identifier.without_ext + '/index.html'
+  end
+end
+
 route '/**/*' do
   item.identifier.to_s
 end
@@ -121,6 +138,10 @@ layout '/**/*', :erb
 EOS
 
     DEFAULT_ITEM = <<EOS unless defined? DEFAULT_ITEM
+---
+title: Home
+---
+
 <h1>A Brand New nanoc Site</h1>
 
 <p>You’ve just created a new nanoc site. The page you are looking at right now is the home page for your site. To get started, consider replacing this default homepage with your own customized homepage. Some pointers on how to do so:</p>
@@ -280,8 +301,10 @@ EOS
       data_source = options[:datasource] || 'filesystem_unified'
 
       # Check whether site exists
-      if File.exist?(path) && (!File.directory?(path) || !(Dir.entries(path) - %w{ . .. }).empty?)
-        raise Nanoc::Int::Errors::GenericTrivial, "A site at '#{path}' already exists."
+      if File.exist?(path) && (!File.directory?(path) || !(Dir.entries(path) - %w{ . .. }).empty?) && !options[:force]
+        raise Nanoc::Int::Errors::GenericTrivial,
+          "The site was not created because '#{path}' already exists. " +
+          "Re-run the command using --force to create the site anyway."
       end
 
       # Check whether data source exists
@@ -302,41 +325,22 @@ EOS
         FileUtils.mkdir_p('lib')
         FileUtils.mkdir_p('output')
 
-        # Config
-        File.open('nanoc.yaml', 'w') { |io| io.write(DEFAULT_CONFIG) }
-        Nanoc::Int::NotificationCenter.post(:file_created, 'nanoc.yaml')
-
-        # Rules
-        File.open('Rules', 'w') do |io|
-          io.write DEFAULT_RULES
-        end
-        Nanoc::Int::NotificationCenter.post(:file_created, 'Rules')
-
-        # Home page
-        File.open('content/index.html', 'w') do |io|
-          io << '---' << "\n"
-          io << 'title: Home' << "\n"
-          io << '---' << "\n"
-          io << "\n"
-          io << DEFAULT_ITEM
-        end
-        Nanoc::Int::NotificationCenter.post(:file_created, 'content/index.html')
-
-        # Style sheet
-        File.open('content/stylesheet.css', 'w') do |io|
-          io << DEFAULT_STYLESHEET
-        end
-        Nanoc::Int::NotificationCenter.post(:file_created, 'content/stylesheet.css')
-
-        # Layout
-        File.open('layouts/default.html', 'w') do |io|
-          io << DEFAULT_LAYOUT
-        end
-        Nanoc::Int::NotificationCenter.post(:file_created, 'layouts/default.html')
+        write('nanoc.yaml', DEFAULT_CONFIG)
+        write('Rules', DEFAULT_RULES)
+        write('content/index.html', DEFAULT_ITEM)
+        write('content/stylesheet.css', DEFAULT_STYLESHEET)
+        write('layouts/default.html', DEFAULT_LAYOUT)
       end
 
       puts "Created a blank nanoc site at '#{path}'. Enjoy!"
     end
+
+    private
+
+    def write(filename, content)
+      File.write(filename, content)
+      Nanoc::Int::NotificationCenter.post(:file_created, filename)
+    end
   end
 end
 

data/lib/nanoc/data_sources/filesystem.rb

@@ -129,7 +129,7 @@ module Nanoc::DataSources
         unless [0, 1].include?(meta_filenames.size)
           raise "Found #{meta_filenames.size} meta files for #{basename}; expected 0 or 1"
         end
-        unless config[:identifier_style] == 'full'
+        unless config[:identifier_type] == 'full'
           unless [0, 1].include?(content_filenames.size)
             raise "Found #{content_filenames.size} content files for #{basename}; expected 0 or 1"
           end

data/lib/nanoc/data_sources/filesystem_unified.rb

@@ -87,8 +87,8 @@ 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)
+      if config[:identifier_type] == 'full'
+        return Nanoc::Identifier.new(filename)
       end
 
       if filename =~ /(^|\/)index(\.[^\/]+)?$/
@@ -96,7 +96,7 @@ module Nanoc::DataSources
       else
         regex = @config && @config[:allow_periods_in_identifiers] ? /\.[^\/\.]+$/ : /\.[^\/]+$/
       end
-      filename.sub(regex, '').__nanoc_cleaned_identifier
+      Nanoc::Identifier.new(filename.sub(regex, ''), type: :legacy)
     end
   end
 end

data/lib/nanoc/data_sources/filesystem_verbose.rb

@@ -61,11 +61,11 @@ module Nanoc::DataSources
 
     # See {Nanoc::DataSources::Filesystem#identifier_for_filename}.
     def identifier_for_filename(filename)
-      if config[:identifier_style] == 'full'
-        return Nanoc::Identifier.new(filename, style: :full)
+      if config[:identifier_type] == 'full'
+        return Nanoc::Identifier.new(filename)
       end
 
-      filename.sub(/[^\/]+\.yaml$/, '')
+      Nanoc::Identifier.new(filename.sub(/[^\/]+\.yaml$/, ''), type: :legacy)
     end
   end
 end

data/lib/nanoc/filters/erb.rb

@@ -9,10 +9,10 @@ module Nanoc::Filters
     #
     # @param [String] content The content to filter
     #
-    # @option params [Integer] safe_level (nil) The safe level (`$SAFE`) to
+    # @option params [Integer] :safe_level (nil) The safe level (`$SAFE`) to
     #   use while running this filter
     #
-    # @option params [String] trim_mode (nil) The trim mode to use
+    # @option params [String] :trim_mode (nil) The trim mode to use
     #
     # @return [String] The filtered content
     def run(content, params = {})