nanoc3 3.0.0

data/lib/nanoc3/data_sources/delicious.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+module Nanoc3::DataSources
+
+  # Nanoc3::DataSources::Delicious provides for a delicious.com bookmarks from
+  # a single user as items (Nanoc3::Item instances).
+  #
+  # The configuration must have a "username" attribute containing the username
+  # of the account from which to fetch the bookmarks.
+  #
+  # The items returned by this data source will be mounted at {root}/{id},
+  # where +id+ is a sequence number that is not necessarily unique for this
+  # bookmark (because delicious.com unfortunately does not provide unique IDs
+  # for each bookmark).
+  #
+  # The items returned by this data source will have the following attributes:
+  #
+  # +:url+:: The URL the bookmark leads to.
+  #
+  # +:description+:: The description (title, usually) of the bookmark.
+  #
+  # +:tags+:: An array of tags (strings) for this bookmark.
+  #
+  # +:date+:: The timestamp when this bookmark was created (a Time object).
+  #
+  # +:note+:: The personal note for this bookmark (can be nil).
+  #
+  # +:author+:: The username of the person storing the bookmark.
+  class Delicious < Nanoc3::DataSource
+
+    def items
+      @items ||= begin
+        require 'json'
+        require 'time'
+
+        # Get data
+        @http_client ||= Nanoc3::Extra::CHiCk::Client.new
+        status, headers, data = *@http_client.get("http://feeds.delicious.com/v2/json/#{self.config[:username]}")
+
+        # Parse as JSON
+        raw_items = JSON.parse(data)
+
+        # Convert to items
+        raw_items.enum_with_index.map do |raw_item, i|
+          # Get data
+          content = raw_item['n']
+          attributes = {
+            :url         => raw_item['u'],
+            :description => raw_item['d'],
+            :tags        => raw_item['t'],
+            :date        => Time.parse(raw_item['dt']),
+            :note        => raw_item['n'],
+            :author      => raw_item['a']
+          }
+          identifier = "/#{i}/"
+          mtime = nil
+
+          # Build item
+          Nanoc3::Item.new(content, attributes, identifier, mtime)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/nanoc3/data_sources/filesystem.rb

@@ -0,0 +1,231 @@
+# encoding: utf-8
+
+module Nanoc3::DataSources
+
+  # The filesystem 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
+  #
+  # The filesystem data source stores its items in nested directories. Each
+  # directory represents a single item. The root directory is the 'content'
+  # directory.
+  #
+  # Every directory has a content file and a meta file. The content file
+  # contains the actual item content, while the meta file contains the item's
+  # metadata, formatted as YAML.
+  #
+  # Both content files and meta files are named after its parent directory
+  # (i.e. item). For example, a item named 'foo' will have a directory named
+  # 'foo', with e.g. a 'foo.markdown' content file and a 'foo.yaml' meta file.
+  #
+  # Content file extensions are not used for determining the filter that
+  # should be run; the meta file defines the list of filters. The meta file
+  # extension must always be 'yaml', though.
+  #
+  # Content files can also have the 'index' basename. Similarly, meta files
+  # can have the 'meta' basename. For example, a parent directory named 'foo'
+  # can have an 'index.txt' content file and a 'meta.yaml' meta file. This is
+  # to preserve backward compatibility.
+  #
+  # = Layouts
+  #
+  # Layouts are stored as directories in the 'layouts' directory. Each layout
+  # contains a content file and a meta file. The content file contain the
+  # actual layout, and the meta file describes how the item should be handled
+  # (contains the filter that should be used).
+  #
+  # For backward compatibility, a layout can also be a single file in the
+  # 'layouts' directory. Such a layout cannot have any metadata; the filter
+  # used for this layout is determined from the file extension.
+  #
+  # = Code Snippets
+  #
+  # Code snippets are stored in '.rb' files in the 'lib' directory. Code
+  # snippets can reside in sub-directories.
+  class Filesystem < 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
+      meta_filenames('content').map do |meta_filename|
+        # Read metadata
+        meta = YAML.load_file(meta_filename) || {}
+
+        # Get content
+        content_filename = content_filename_for_dir(File.dirname(meta_filename))
+        content = File.read(content_filename)
+
+        # Get attributes
+        attributes = meta.merge(:file => Nanoc3::Extra::FileProxy.new(content_filename))
+
+        # Get identifier
+        identifier = meta_filename.sub(/^content/, '').sub(/[^\/]+\.yaml$/, '')
+
+        # 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_dir(File.dirname(meta_filename))
+        content           = File.read(content_filename)
+
+        # Get attributes
+        attributes = YAML.load_file(meta_filename) || {}
+
+        # Get identifier
+        identifier = meta_filename.sub(/^layouts\//, '').sub(/\/[^\/]+\.yaml$/, '')
+
+        # 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)
+      # Determine base path
+      last_component = identifier.split('/')[-1] || 'content'
+      base_path = 'content' + identifier + last_component
+
+      # Get filenames
+      dir_path         = 'content' + identifier
+      meta_filename    = 'content' + identifier + last_component + '.yaml'
+      content_filename = 'content' + identifier + last_component + '.html'
+                                     
+      # Notify
+      Nanoc3::NotificationCenter.post(:file_created, meta_filename)
+      Nanoc3::NotificationCenter.post(:file_created, content_filename)
+
+      # Create files
+      FileUtils.mkdir_p(dir_path)
+      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)
+      # Determine base path
+      last_component = identifier.split('/')[-1]
+      base_path = 'layouts' + identifier + last_component
+
+      # Get filenames
+      dir_path         = 'layouts' + identifier
+      meta_filename    = 'layouts' + identifier + last_component + '.yaml'
+      content_filename = 'layouts' + identifier + last_component + '.html'
+
+      # Notify
+      Nanoc3::NotificationCenter.post(:file_created, meta_filename)
+      Nanoc3::NotificationCenter.post(:file_created, content_filename)
+
+      # Create files
+      FileUtils.mkdir_p(dir_path)
+      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 list of all meta files in the given base directory as well
+    # as its subdirectories.
+    def meta_filenames(base)
+      # Find all possible meta file names
+      filenames = Dir[base + '/**/*.yaml']
+
+      # Filter out invalid meta files
+      good_filenames = []
+      bad_filenames  = []
+      filenames.each do |filename|
+        if filename =~ /meta\.yaml$/ or filename =~ /([^\/]+)\/\1\.yaml$/
+          good_filenames << filename
+        else
+          bad_filenames << filename
+        end
+      end
+
+      # Warn about bad filenames
+      unless bad_filenames.empty?
+        raise RuntimeError.new(
+          "The following files appear to be meta files, " +
+          "but have an invalid name:\n  - " +
+          bad_filenames.join("\n  - ")
+        )
+      end
+
+      good_filenames
+    end
+
+    # Returns the filename of the content file in the given directory,
+    # ignoring any unwanted files (files that end with '~', '.orig', '.rej' or
+    # '.bak')
+    def content_filename_for_dir(dir)
+      # Find all files
+      filename_glob_1 = dir.sub(/([^\/]+)$/, '\1/\1.*')
+      filename_glob_2 = dir.sub(/([^\/]+)$/, '\1/index.*')
+      filenames = (Dir[filename_glob_1] + Dir[filename_glob_2]).uniq
+
+      # 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 in #{dir} but found #{filenames.size}"
+        )
+      end
+
+      # Return content filename
+      filenames.first
+    end
+
+  end
+
+end

data/lib/nanoc3/data_sources/filesystem_combined.rb

@@ -0,0 +1,202 @@
+# 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.
+  #
+  # 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).
+  #
+  # = 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
+        if filename =~ /\/index\.[^\/]+$/
+          identifier = filename.sub(/^content/, '').sub(/index\.[^\/]+$/, '') + '/'
+        else
+          identifier = filename.sub(/^content/, '').sub(/\.[^\/]+$/, '') + '/'
+        end
+
+        # 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
+        if filename =~ /\/index\.[^\/]+$/
+          identifier = filename.sub(/^layouts/, '').sub(/index\.[^\/]+$/, '') + '/'
+        else
+          identifier = filename.sub(/^layouts/, '').sub(/\.[^\/]+$/, '') + '/'
+        end
+
+        # 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 < 3
+        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
+
+  end
+
+end

data/lib/nanoc3/data_sources/filesystem_common.rb

@@ -0,0 +1,22 @@
+# 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