nanoc3 3.0.9 → 3.1.0a1

data/lib/nanoc3/data_sources/filesystem_combined.rb

@@ -1,214 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::DataSources
-
-  # = Items
-  #
-  # The filesystem data source stores its items in nested directories. A item
-  # is represented by a single file. The root directory is the 'content'
-  # directory.
-  #
-  # The metadata for a item is embedded into the file itself. It is stored at
-  # the top of the file, between '---' (three dashes) separators. For example:
-  #
-  #   ---
-  #   title: "Moo!"
-  #   ---
-  #   h1. Hello!
-  #
-  # The identifier of a item is determined as follows. A file with an
-  # 'index.*' filename, such as 'index.txt', will have the filesystem path
-  # with the 'index.*' part stripped as a identifier. For example,
-  # 'foo/bar/index.html' will have '/foo/bar/' as identifier. In other cases,
-  # the identifier is calculated by stripping the extension; if there is more
-  # than one extension, only the last extension is stripped and the previous
-  # extensions will be part of the identifier.
-  #
-  # A file with a filename not starting with 'index.', such as 'foo.html',
-  # will have an identifier ending in 'foo/'. For example, 'foo/bar.html' will
-  # have '/foo/bar/' as identifier.
-  #
-  # Note that it is possible for two different, separate files to have the
-  # same identifier. It is therefore recommended to avoid such situations.
-  #
-  # Some more examples:
-  #
-  #   content/index.html          --> /
-  #   content/foo.html            --> /foo/
-  #   content/foo/index.html      --> /foo/
-  #   content/foo/bar.html        --> /foo/bar/
-  #   content/foo/bar/index.html  --> /foo/bar/
-  #
-  # File extensions are ignored by nanoc. The file extension does not
-  # determine the filters to run on it; the metadata in the file defines the
-  # list of filters.
-  #
-  # = Layouts
-  #
-  # Layouts are stored as files in the 'layouts' directory. Similar to items,
-  # each layout consists of a metadata part and a content part, separated by
-  # '---' (three dashes).
-  #
-  # The identifier for layouts is generated the same way as identifiers for
-  # items (see above for details).
-  #
-  # = Code Snippets
-  #
-  # Code snippets are stored in '.rb' files in the 'lib' directory. Code
-  # snippets can reside in sub-directories.
-  class FilesystemCombined < Nanoc3::DataSource
-
-    include Nanoc3::DataSources::FilesystemCommon
-
-    ########## VCSes ##########
-
-    attr_accessor :vcs
-
-    def vcs
-      @vcs ||= Nanoc3::Extra::VCSes::Dummy.new
-    end
-
-    ########## Preparation ##########
-
-    def up
-    end
-
-    def down
-    end
-
-    def setup
-      # Create directories
-      %w( content layouts lib ).each do |dir|
-        FileUtils.mkdir_p(dir)
-        vcs.add(dir)
-      end
-    end
-
-    ########## Loading data ##########
-
-    def items
-      files('content', true).map do |filename|
-        # Read and parse data
-        meta, content = *parse_file(filename, 'item')
-
-        # Get attributes
-        attributes = meta.merge(:file => Nanoc3::Extra::FileProxy.new(filename))
-
-        # Get actual identifier
-        identifier = filename_to_identifier(filename, /^content/)
-
-        # Get mtime
-        mtime = File.stat(filename).mtime
-
-        # Build item
-        Nanoc3::Item.new(content, attributes, identifier, mtime)
-      end
-    end
-
-    def layouts
-      files('layouts', true).map do |filename|
-        # Read and parse data
-        meta, content = *parse_file(filename, 'layout')
-
-        # Get actual identifier
-        identifier = filename_to_identifier(filename, /^layouts/)
-
-        # Get mtime
-        mtime = File.stat(filename).mtime
-
-        # Build layout
-        Nanoc3::Layout.new(content, meta, identifier, mtime)
-      end.compact
-    end
-
-    ########## Creating data ##########
-
-    # Creates a new item with the given content, attributes and identifier.
-    def create_item(content, attributes, identifier)
-      # Determine path
-      if identifier == '/'
-        path = 'content/index.html'
-      else
-        path = 'content' + identifier[0..-2] + '.html'
-      end
-      parent_path = File.dirname(path)
-
-      # Notify
-      Nanoc3::NotificationCenter.post(:file_created, path)
-
-      # Write item
-      FileUtils.mkdir_p(parent_path)
-      File.open(path, 'w') do |io|
-        io.write(YAML.dump(attributes.stringify_keys) + "\n")
-        io.write("---\n")
-        io.write(content)
-      end
-    end
-
-    # Creates a new layout with the given content, attributes and identifier.
-    def create_layout(content, attributes, identifier)
-      # Determine path
-      path = 'layouts' + identifier[0..-2] + '.html'
-      parent_path = File.dirname(path)
-
-      # Notify
-      Nanoc3::NotificationCenter.post(:file_created, path)
-
-      # Write layout
-      FileUtils.mkdir_p(parent_path)
-      File.open(path, 'w') do |io|
-        io.write(YAML.dump(attributes.stringify_keys) + "\n")
-        io.write("---\n")
-        io.write(content)
-      end
-    end
-
-  private
-
-    # Returns a list of all files in +dir+, ignoring any unwanted files (files
-    # that end with '~', '.orig', '.rej' or '.bak').
-    #
-    # +recursively+:: When +true+, finds files in +dir+ as well as its
-    #                 subdirectories; when +false+, only searches +dir+
-    #                 itself.
-    def files(dir, recursively)
-      glob = File.join([dir] + (recursively ? [ '**', '*' ] : [ '*' ]))
-      Dir[glob].reject { |f| File.directory?(f) or f =~ /(~|\.orig|\.rej|\.bak)$/ }
-    end
-
-    # Parses the file named +filename+ and returns an array with its first
-    # element a hash with the file's metadata, and with its second element the
-    # file content itself.
-    def parse_file(filename, kind)
-      # Split file
-      pieces = File.read(filename).split(/^(-{5}|-{3})/).compact
-      if pieces.size < 4
-        raise RuntimeError.new(
-          "The file '#{filename}' does not seem to be a nanoc #{kind}"
-        )
-      end
-
-      # Parse
-      meta    = YAML.load(pieces[2]) || {}
-      content = pieces[4..-1].join.strip
-
-      [ meta, content ]
-    end
-
-    def filename_to_identifier(filename, regex)
-      identifier = filename.sub(regex, '')
-      if filename =~ /\/index\.[^\/]+$/
-        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /index\.[^\/\.]+$/ : /index\.[^\/]+$/)
-        identifier.sub!(regex, '')
-      else
-        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\.[^\/\.]+$/      : /\.[^\/]+$/)
-        identifier.sub!(regex, '')
-      end
-      identifier << '/'
-
-      identifier
-    end
-
-  end
-
-end

data/lib/nanoc3/data_sources/filesystem_common.rb

@@ -1,22 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::DataSources
-
-  # The Nanoc3::DataSources::FilesystemCommon module provides code
-  # snippet-loading and rule-loading methods that are used by both the
-  # filesystem and the filesystem_combined data sources.
-  module FilesystemCommon
-
-    def code_snippets
-      Dir['lib/**/*.rb'].sort.map do |filename|
-        Nanoc3::CodeSnippet.new(
-          File.read(filename),
-          filename.sub(/^lib\//, ''),
-          File.stat(filename).mtime
-        )
-      end
-    end
-
-  end
-
-end

data/lib/nanoc3/data_sources/filesystem_compact.rb

@@ -1,256 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::DataSources
-
-  # The filesystem_combined data source is the default data source for a new
-  # nanoc site. It stores all data as files on the hard disk.
-  #
-  # None of the methods are documented in this file. See Nanoc3::DataSource
-  # for documentation on the overridden methods instead.
-  #
-  # = Items
-  #
-  # Items are stored as pairs of two files: a content file, containing the
-  # actual item content, and a meta file, containing the item's attributes,
-  # formatted as YAML. The content file and the corresponding meta file have
-  # the same filename but not the same extension; the meta file's extension is
-  # .yaml.
-  #
-  # Items are stored in the "content" directory of the nanoc site.
-  #
-  # The home page item, located at /, is represented by an index.yaml meta
-  # file, along with its corresponding content file.
-  #
-  # Subitems of other pages can be achieved in two ways: they can either be
-  # nested in directories and named "index" such as the home page item, or
-  # they can simply be given a non-"index" name.
-  #
-  # The identifier is calculated by stripping the extension; if there is more
-  # than one extension, only the last extension is stripped and the previous
-  # extensions will be part of the identifier.
-  #
-  # For example, this directory structure:
-  #
-  #   content/
-  #     index.html
-  #     index.yaml
-  #     about.html
-  #     about.yaml
-  #     journal.html
-  #     journal.yaml
-  #     journal/
-  #       2005.html
-  #       2005.yaml
-  #       2005/
-  #         a-very-old-post.html
-  #         a-very-old-post.yaml
-  #         another-very-old-post.html
-  #         another-very-old-post.yaml
-  #         foo.entry.html
-  #         foo.entry.yaml
-  #     myst/
-  #       index.html
-  #       index.yaml
-  #
-  # … corresponds with the following items:
-  #
-  #   /
-  #   /about/
-  #   /journal/
-  #   /journal/2005/
-  #   /journal/2005/a-very-old-post/
-  #   /journal/2005/another-very-old-post/
-  #   /journal/2005/foo.entry/
-  #   /myst/
-  #
-  # = Layouts
-  #
-  # Layouts are stored the same way as items, except that they are stored in
-  # the "layouts" directory instead of the "content" directory.
-  #
-  # The identifier for layouts is generated the same way as identifiers for
-  # items (see above for details).
-  #
-  # = Code Snippets
-  #
-  # Code snippets are stored in '.rb' files in the 'lib' directory. Code
-  # snippets can reside in sub-directories.
-  class FilesystemCompact < Nanoc3::DataSource
-
-    include Nanoc3::DataSources::FilesystemCommon
-
-    ########## VCSes ##########
-
-    attr_accessor :vcs
-
-    def vcs
-      @vcs ||= Nanoc3::Extra::VCSes::Dummy.new
-    end
-
-    ########## Preparation ##########
-
-    def setup
-      # Create directories
-      %w( content layouts lib ).each do |dir|
-        FileUtils.mkdir_p(dir)
-        vcs.add(dir)
-      end
-    end
-
-    ########## Loading data ##########
-
-    def items
-      meta_filenames('content').map do |meta_filename|
-        # Read metadata
-        meta = YAML.load_file(meta_filename) || {}
-
-        # Get content
-        content_filename = content_filename_for_meta_filename(meta_filename)
-        content = File.read(content_filename)
-
-        # Get attributes
-        attributes = meta.merge(:file => Nanoc3::Extra::FileProxy.new(content_filename))
-
-        # Get identifier
-        identifier = identifier_for_meta_filename(meta_filename.sub(/^content/, ''))
-
-        # Get modification times
-        meta_mtime    = File.stat(meta_filename).mtime
-        content_mtime = File.stat(content_filename).mtime
-        mtime         = meta_mtime > content_mtime ? meta_mtime : content_mtime
-
-        # Create item object
-        Nanoc3::Item.new(content, attributes, identifier, mtime)
-      end
-    end
-
-    def layouts
-      meta_filenames('layouts').map do |meta_filename|
-        # Get content
-        content_filename  = content_filename_for_meta_filename(meta_filename)
-        content           = File.read(content_filename)
-
-        # Get attributes
-        attributes = YAML.load_file(meta_filename) || {}
-
-        # Get identifier
-        identifier = identifier_for_meta_filename(meta_filename.sub(/^layouts/, ''))
-
-        # Get modification times
-        meta_mtime    = File.stat(meta_filename).mtime
-        content_mtime = File.stat(content_filename).mtime
-        mtime         = meta_mtime > content_mtime ? meta_mtime : content_mtime
-
-        # Create layout object
-        Nanoc3::Layout.new(content, attributes, identifier, mtime)
-      end
-    end
-
-    ########## Creating data ##########
-
-    # Creates a new item with the given content, attributes and identifier.
-    def create_item(content, attributes, identifier)
-      # Get filenames
-      base_path = 'content' + (identifier == '/' ? '/index' : identifier[0..-2])
-      meta_filename    = base_path + '.yaml'
-      content_filename = base_path + '.html'
-
-      # Notify
-      Nanoc3::NotificationCenter.post(:file_created, meta_filename)
-      Nanoc3::NotificationCenter.post(:file_created, content_filename)
-
-      # Create files
-      FileUtils.mkdir_p(File.dirname(meta_filename))
-      File.open(meta_filename,    'w') { |io| io.write(YAML.dump(attributes.stringify_keys)) }
-      File.open(content_filename, 'w') { |io| io.write(content) }
-    end
-
-    # Creates a new layout with the given content, attributes and identifier.
-    def create_layout(content, attributes, identifier)
-      # Get filenames
-      base_path = 'layouts' + identifier[0..-2]
-      meta_filename    = base_path + '.yaml'
-      content_filename = base_path + '.html'
-
-      # Notify
-      Nanoc3::NotificationCenter.post(:file_created, meta_filename)
-      Nanoc3::NotificationCenter.post(:file_created, content_filename)
-
-      # Create files
-      FileUtils.mkdir_p(File.dirname(meta_filename))
-      File.open(meta_filename,    'w') { |io| io.write(YAML.dump(attributes.stringify_keys)) }
-      File.open(content_filename, 'w') { |io| io.write(content) }
-    end
-
-  private
-
-    ########## Custom functions ##########
-
-    # Returns the identifier for the given meta filename. This method assumes
-    # that the base is already stripped. The identifier is calculated by
-    # stripping the extension; if there is more than one extension, only the
-    # last extension is stripped and the previous extensions will be part of
-    # the identifier.
-    #
-    # For example:
-    #
-    #   /foo.yaml           -> /foo/
-    #   /foo/index.yaml     -> /foo/
-    #   /foo/foo.yaml       -> /foo/foo/
-    #   /foo/bar.yaml       -> /foo/bar/
-    #   /foo/bar.entry.yaml -> /foo/bar.entry/
-    def identifier_for_meta_filename(meta_filename)
-      # Split into components
-      components = meta_filename.gsub(%r{(^/|/$)}, '').split('/')
-      if @config && @config[:allow_periods_in_identifiers]
-        components[-1].sub!(/\.yaml$/, '')
-      else
-        components[-1].sub!(/\.[^\/\.]+$/, '')
-      end
-
-      if components[-1] == 'index'
-        components[0..-2].join('/').cleaned_identifier
-      else
-        components.join('/').cleaned_identifier
-      end
-    end
-
-    # Returns the list of all meta files in the given base directory as well
-    # as its subdirectories.
-    def meta_filenames(base)
-      Dir[base + '/**/*.yaml']
-    end
-
-    # Returns the filename of the content file corresponding to the given meta
-    # file, ignoring any unwanted files (files that end with '~', '.orig',
-    # '.rej' or '.bak')
-    def content_filename_for_meta_filename(meta_filename)
-      # Find all files
-      if @config && @config[:allow_periods_in_identifiers]
-      	base_filename = File.basename(meta_filename, '.yaml')
-      	dirname       = File.dirname(meta_filename)
-      	filenames     = Dir.entries(dirname).select { |f| f =~ /^#{base_filename}\.[^.]+$/ }.map { |f| "#{dirname}/#{f}" }
-      else
-        filenames = Dir[meta_filename.sub(/\.yaml$/, '.*')]
-      end
-
-      # Reject meta files
-      filenames.reject! { |f| f =~ /\.yaml$/ }
-
-      # Reject backups
-      filenames.reject! { |f| f =~ /(~|\.orig|\.rej|\.bak)$/ }
-
-      # Make sure there is only one content file
-      if filenames.size != 1
-        raise RuntimeError.new(
-          "Expected 1 content file for the metafile #{meta_filename} but found #{filenames.size}"
-        )
-      end
-
-      # Return content filename
-      filenames.first
-    end
-
-  end
-
-end

data/lib/nanoc3/extra/context.rb

@@ -1,24 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::Extra
-
-  # Nanoc3::Extra::Context provides a context and a Binding for use in various
-  # filters, such as the ERB and Haml one.
-  class Context
-
-    # Creates a new context based off the contents of the hash. Each pair in
-    # the hash will be converted to an instance variable. For example, passing
-    # the hash { :foo => 'bar' } will cause @foo to have the value "bar".
-    def initialize(hash)
-      hash.each_pair do |key, value|
-        instance_variable_set('@' + key.to_s, value)
-      end
-    end
-
-    # Returns a binding for this context.
-    def get_binding
-      binding
-    end
-
-  end
-end

data/lib/nanoc3/package.rb

@@ -1,107 +0,0 @@
-# encoding: utf-8
-
-require 'singleton'
-
-module Nanoc3
-
-  # Nanoc3::Package is a singleton that contains metadata about the nanoc
-  # project, which is used for packaging releases.
-  class Package
-
-    include Singleton
-
-    # The name of the application.
-    def name
-      'nanoc3'
-    end
-
-    # The files to include in the package. This is also the list of files that
-    # will be included in the documentation (with the exception of the files
-    # in undocumented_files).
-    def files
-      @files ||= (%w( ChangeLog LICENSE NEWS.rdoc Rakefile README.rdoc ) +
-        Dir['bin/**/*'] +
-        Dir['lib/**/*'] +
-        Dir['vendor/**/*']).reject { |f| File.directory?(f) }
-    end
-
-    # The files that are included in the documentation by default.
-    def files_documented_by_default
-      Dir['lib/**/*'].reject { |f| File.directory?(f) }
-    end
-
-    # The files that should not be included in the documentation.
-    def files_not_in_documentation
-      Dir['lib/**/*.rake'] +
-      Dir['vendor/**/*'].reject { |f| File.directory?(f) }
-    end
-
-    # The files that should be included in the documentation.
-    def files_in_documentation
-      files - files_not_in_documentation
-    end
-
-    # The files that are not documented by RDoc by default, but should still
-    # be included in the documentation.
-    def extra_rdoc_files
-      files_in_documentation - files_documented_by_default
-    end
-
-    # The name of the file that should be used as entry point for the
-    # documentation.
-    def main_documentation_file
-      'README.rdoc'
-    end
-
-    # The Gem::Specification used for packaging.
-    def gem_spec
-      @gem_spec ||= Gem::Specification.new do |s|
-        s.name                  = self.name
-        s.version               = Nanoc3::VERSION
-        s.platform              = Gem::Platform::RUBY
-        s.summary               = 'a tool that runs on your local computer ' +
-                                  'and compiles Markdown, Textile, Haml, ' +
-                                  '... documents into static web pages'
-        s.description           = s.summary
-        s.homepage              = 'http://nanoc.stoneship.org/'
-        s.rubyforge_project     = 'nanoc'
-
-        s.author                = 'Denis Defreyne'
-        s.email                 = 'denis.defreyne@stoneship.org'
-
-        s.post_install_message  = <<EOS
-------------------------------------------------------------------------------
-Thanks for installing nanoc 3.0! Here are some resources to help you get started:
-
-* The tutorial at <http://nanoc.stoneship.org/tutorial/>
-* The manual at <http://nanoc.stoneship.org/manual/>
-* The discussion group at <http://groups.google.com/group/nanoc>
-* The IRC channel #nanoc on Freenode
-
-Because nanoc 3.0 has a lot of new features, be sure to check out the nanoc blog at <http://nanoc.stoneship.org/blog/> for details about this release.
-
-Enjoy!
-------------------------------------------------------------------------------
-EOS
-
-        s.required_ruby_version = '>= 1.8.5'
-
-        s.has_rdoc              = true
-        s.extra_rdoc_files      = self.extra_rdoc_files
-        s.rdoc_options          = []
-        s.rdoc_options          += [ '--title', self.name                    ]
-        s.rdoc_options          += [ '--main',  self.main_documentation_file ]
-        self.files_not_in_documentation.each do |file|
-          s.rdoc_options        += [ '--exclude', file ]
-        end
-
-        s.files                 = self.files
-        s.executables           = [ 'nanoc3' ]
-        s.require_path          = 'lib'
-        s.bindir                = 'bin'
-      end
-    end
-
-  end
-
-end

data/vendor/cri/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2009‒2010 Denis Defreyne and contributors
-
-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/vendor/cri/README

@@ -1,4 +0,0 @@
-Cri
-===
-
-Cri is a library for building easy-to-use commandline tools.

data/vendor/cri/Rakefile

@@ -1,25 +0,0 @@
-##### Requirements
-
-# Rake etc
-require 'rake'
-require 'minitest/unit'
-
-# Cri itself
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
-require 'cri'
-
-##### Testing
-
-desc 'Runs all tests'
-task :test do
-  ENV['QUIET'] ||= 'true'
-
-  $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/..'))
-
-  MiniTest::Unit.autorun
-
-  test_files = Dir['test/test_*.rb']
-  test_files.each { |f| require f }
-end
-
-task :default => :test