flutterby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83e24d1e73103a5cef7b60efcf5a21951e474c66
-  data.tar.gz: f25f5763a2a10b7190e9ea5a827ef716bba729f7
+  metadata.gz: 679b8fba9c9fda2c5e70df5bb73a16903be5181f
+  data.tar.gz: 5a27688b1713d0bd8bb49695afcb1bb9272682e6
 SHA512:
-  metadata.gz: fc8ecf0efc0a1615d0149b1a94b0eb3fef7cd27db54147de26238646313f2dc679b74335cc69671364f1d04f43c96d72112ff7b596a27c883256808449622aa4
-  data.tar.gz: d7ed0d77dde3726cc718c0420f1d1f3a5732c17a9906329d945b7eb607ccce3fa183659a7b92787edcb024bb39883f04cbcf6982a43675da21be31b576ba860d
+  metadata.gz: b24fcfd4c696520de83fcc2f6a0318f7e3895bf558bdc30145ccf8eca1af57845fca6c393ceac928edcfa3afaf5f99409324d9027269c88a89fd698d6512c35c
+  data.tar.gz: 8a2827f70bc5484a202d9f147e7c0cb0ba04ee3e95106041ceb8439e014321b01474a9273e3d2bcbbcba740eed03263c4d5b86bdb848a453cf13602647da2edb

data/.travis.yml

@@ -1,7 +1,9 @@
 sudo: false
 language: ruby
 rvm:
+  - 2.2.6
   - 2.3.3
   - 2.4.0
 before_install: gem install bundler -v 1.13.6
+cache: bundler
 script: bundle exec rake

data/.yardopts

@@ -0,0 +1,2 @@
+--exclude lib/templates/
+--embed-mixin "Flutterby::Node::*"

data/CHANGES.md

@@ -1,5 +1,18 @@
 # Version History
 
+### 0.5.0 (2017-01-24)
+
+- **NEW:** Nodes have two new attributes, `prefix` and `slug`, which are automatically generated from the node's name. If the name starts with a combination of decimals and dashes, these will become the `prefix`, and the remainder auf the name the `suffix`. For example, a name of `123-introduction` will result in a prefix of `123` and a slug of `introduction`. As before, a prefix that looks like a date (eg. `2017-04-01-introduction`) will automatically be parsed into `data[:date]`.
+- **NEW:** When nodes are being spawned, their names will be changed to their slugs by default (ie. any prefix contained in the original name will be removed.) For example, a `123-foo.html.md` will be exported as just `foo.html`.
+- **NEW:** Nodes now have first-class support of a node title through the new `title` attribute. This will either use `data[:title]`, when available, or generate a title from `slug` (eg. a node named `hello-world.html.md` will automatically have a title of `Hello World`.)
+- **NEW:** You can now also access a node's data using a convenient dot syntax; eg. `node.data.foo.bar` will return `node.data[:foo][:bar]`. If you're on Ruby 2.3 or newer, this allows you to use the safe navigation operator; eg. `data.foo&.bar`.
+- **BREAKING CHANGE:** The `_node.rb` mechanism is gone. In its stead, you can now add `_init.rb` files that will be evaluated automatically; those can use the new `extend_siblings` and `extend_parent` convenience methods to extend all available siblings (or the parent) with the specified module or block.
+- **NEW:** These node extensions can now supply an `on_setup` block that will be executed after the tree has been fully spawned. You can use these setup blocks to further modify the tree.
+- **NEW:** The `flutterby build` and `flutterby serve` CLI commands now provide additional debug output when started with the `--debug` option.
+- **NEW:** Added `Node#create` as a convenience method for creating new child nodes below a given node.
+- **CHANGE:** Some massive refactoring, the primary intent being to perform the rendering of nodes in a thread-safe manner.
+
+
 ### 0.4.0 (2017-01-21)
 
 - **NEW:** Flutterby views now have a `tag` helper method available that can generate HTML tags programatically.

data/README.md

@@ -1,4 +1,4 @@
-# Flutterby
+# Flutterby 🦋
 
 ### A flexible, Ruby-powered static site generator.
 
@@ -17,8 +17,9 @@
 
 - [Blog post introducing Flutterby](http://hmans.io/posts/2017/01/11/flutterby.html)
 - [New project template](https://github.com/hmans/flutterby/tree/master/lib/templates/new_project) (example code)
+- [Code Reference Documentation](http://www.rubydoc.info/github/hmans/flutterby)
 - [Version History](https://github.com/hmans/flutterby/blob/master/CHANGES.md)
-- [Roadmap](https://github.com/hmans/flutterby/projects/1)
+- [Issues/Roadmap](https://github.com/hmans/flutterby/issues)
 - [Sites built with Flutterby](https://github.com/hmans/flutterby/wiki/Sites-built-with-Flutterby) (add yours!)
 
 

data/bin/yard

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yard")

data/bin/yardoc

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yardoc")

data/bin/yri

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yri")

data/flutterby.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'awesome_print', '~> 0'
   spec.add_development_dependency 'gem-release', '~> 0'
   spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'yard', '~> 0.9'
 
   spec.add_dependency 'erubis', '~> 2.7'
   spec.add_dependency 'erubis-auto', '~> 1.0'

data/lib/flutterby.rb

@@ -3,7 +3,9 @@ require 'toml'
 require 'mime-types'
 require 'json'
 
+require "flutterby/dotaccess"
 require "flutterby/version"
+require "flutterby/tree_walker"
 require "flutterby/node"
 require "flutterby/filters"
 require "flutterby/view"

data/lib/flutterby/cli.rb

@@ -21,10 +21,13 @@ module Flutterby
     end
 
     desc "build", "Build your static site"
-    option :in, default: "./site/", aliases: [:i]
-    option :out, default: "./_build/", aliases: [:o]
+    option :in, default: "./site/", aliases: ["-i"]
+    option :out, default: "./_build/", aliases: ["-o"]
+    option :debug, default: false, aliases: ["-d"], type: :boolean
 
     def build
+      Flutterby.logger.level = options.debug ? Logger::DEBUG : Logger::INFO
+
       # Simplify logger output
       Flutterby.logger.formatter = proc do |severity, datetime, progname, msg|
         " • #{msg}\n"
@@ -49,10 +52,13 @@ module Flutterby
 
 
     desc "serve", "Serve your site locally"
-    option :in, default: "./site/", aliases: [:i]
-    option :port, default: 4004, aliases: [:p], type: :numeric
+    option :in, default: "./site/", aliases: ["-i"]
+    option :port, default: 4004, aliases: ["-p"], type: :numeric
+    option :debug, default: false, aliases: ["-d"], type: :boolean
 
     def serve
+      Flutterby.logger.level = options.debug ? Logger::DEBUG : Logger::INFO
+
       say_hi
 
       say color("📚  Importing site...", :bold)
@@ -61,8 +67,8 @@ module Flutterby
       say color("🌲  Read #{root.tree_size} nodes.", :green, :bold)
 
       say color("🌤  Serving your Flutterby site on http://localhost:#{options.port} - enjoy! \\o/", :bold)
-      server = Flutterby::Server.new(root, port: options.port)
-      server.run!
+      server = Flutterby::Server.new(root)
+      server.run!(port: options.port)
     end
 
 

data/lib/flutterby/dotaccess.rb

@@ -0,0 +1,31 @@
+module Dotaccess
+  class Proxy
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def method_missing(meth, *args)
+      if @hash.respond_to?(meth)
+        @hash.send(meth, *args)
+      elsif meth =~ %r{\A(.+)=\Z}
+        @hash[$1] = args.first
+      elsif v = (@hash[meth] || @hash[meth.to_s])
+        v.is_a?(Hash) ? Proxy.new(v) : v
+      else
+        nil
+      end
+    end
+
+    def [](k)
+      @hash[k]
+    end
+
+    def ==(o)
+      @hash == o
+    end
+  end
+
+  def self.[](hash)
+    Proxy.new(hash)
+  end
+end

data/lib/flutterby/exporter.rb

@@ -5,25 +5,27 @@ module Flutterby
     end
 
     def export!(into:)
-      @root.paths.each do |path, node|
-        if node.should_publish?
-          path = ::File.expand_path(::File.join(into, node.url))
+      export_node(@root, into: into)
+    end
+
+    private
+
+    def export_node(node, into:)
+      return unless node.should_publish?
 
-          if node.file?
-            # Make sure directory exists
-            FileUtils.mkdir_p(::File.dirname(path))
+      path = ::File.expand_path(::File.join(into, node.full_name))
 
-            # Write file
-            ::File.write(path, node.render(layout: true))
-            logger.info "Exported #{node.url}"
-          end
+      if node.file?
+        ::File.write(path, node.render(layout: true))
+        logger.info "Exported #{node.url}"
+      else
+        FileUtils.mkdir_p(path)
+        node.children.each do |child|
+          export_node(child, into: path)
         end
       end
     end
 
-
-    private
-
     def logger
       @logger ||= Flutterby.logger
     end

data/lib/flutterby/filters.rb

@@ -8,19 +8,19 @@ require 'flutterby/markdown_formatter'
 
 module Flutterby
   module Filters
-    def self.apply!(node)
-      node.body = node.source.try(:html_safe)
+    def self.apply!(view)
+      view._body = view.source.try(:html_safe)
 
       # Apply all filters
-      node.filters.each do |filter|
+      view.node.filters.each do |filter|
         meth = "process_#{filter}!"
 
         if Filters.respond_to?(meth)
-          Filters.send(meth, node)
-        elsif template = tilt(filter, node.body)
-          node.body = template.render(node.view).html_safe
+          Filters.send(meth, view)
+        elsif template = tilt(filter, view._body)
+          view._body = template.render(view).html_safe
         else
-          Flutterby.logger.warn "Unsupported filter '#{filter}' for #{node.url}"
+          Flutterby.logger.warn "Unsupported filter '#{filter}' for #{view.node.url}"
         end
       end
     end
@@ -43,23 +43,23 @@ module Flutterby
   end
 end
 
-Flutterby::Filters.add("rb") do |node|
-  node.instance_eval(node.body)
+Flutterby::Filters.add("rb") do |view|
+  view._body = view.instance_eval(view._body)
 end
 
-Flutterby::Filters.add(["md", "markdown"]) do |node|
-  node.body = Flutterby::MarkdownFormatter.new(node.body).complete.to_s.html_safe
+Flutterby::Filters.add(["md", "markdown"]) do |view|
+  view._body = Flutterby::MarkdownFormatter.new(view._body).complete.to_s.html_safe
 end
 
-Flutterby::Filters.add("scss") do |node|
+Flutterby::Filters.add("scss") do |view|
   sass_options = {
     syntax: :scss,
     load_paths: []
   }
 
-  if node.fs_path
-    sass_options[:load_paths] << File.dirname(node.fs_path)
+  if view.node.fs_path
+    sass_options[:load_paths] << File.dirname(view.node.fs_path)
   end
 
-  node.body = Sass::Engine.new(node.body, sass_options).render
+  view._body = Sass::Engine.new(view._body, sass_options).render
 end

data/lib/flutterby/node.rb

@@ -1,14 +1,16 @@
-require 'benchmark'
+require 'flutterby/node_extension'
 
 module Flutterby
   class Node
     attr_accessor :name, :ext, :source
-    attr_writer :body
-    attr_reader :filters, :parent, :fs_path, :children, :paths
+    attr_reader :filters, :parent, :fs_path, :children
+    attr_reader :prefix, :slug
+    attr_reader :_setup_procs
 
     def initialize(name, parent: nil, fs_path: nil, source: nil)
       @fs_path = fs_path ? ::File.expand_path(fs_path) : nil
       @source  = source
+      @_setup_procs = []
 
       # Extract name, extension, and filters from given name
       parts    = name.split(".")
@@ -24,21 +26,66 @@ module Flutterby
       reload!
     end
 
-    concerning :Children do
-      def register_url!
-        if file? && should_publish?
-          root.paths[url] = self
-        end
+    module Paths
+      # Returns the node's URL.
+      #
+      def url
+        ::File.join(parent ? parent.url : "/", full_name)
       end
+    end
 
-      def find_child(name)
-        if name.include?(".")
-          @children.find { |c| c.full_name == name }
-        else
-          @children.find { |c| c.name == name }
+    include Paths
+
+
+    module Tree
+      # Returns the tree's root node.
+      #
+      def root
+        parent ? parent.root : self
+      end
+
+      # Returns true if this node is also the tree's root node.
+      #
+      def root?
+        root == self
+      end
+
+      def sibling(name)
+        parent && parent.find(name)
+      end
+
+      # Returns this node's siblings (ie. other nodes within the
+      # same folder node.)
+      #
+      def siblings
+        parent && (parent.children - [self])
+      end
+
+      # Among this node's children, find a node by its name. If the
+      # name passed as an argument includes a dot, the name will match against
+      # the full name of the children; otherwise, just the base name.
+      #
+      # Examples:
+      #
+      #     # returns the first child called "index"
+      #     find_child("index")
+      #
+      #     # returns the child called "index" with extension "html"
+      #     find_child("index.html")
+      #
+      def find_child(name, opts = {})
+        name_attr = name.include?(".") ? "full_name" : "name"
+
+        @children.find do |c|
+          (c.should_publish? || !opts[:public_only]) &&
+            (c.send(name_attr) == name)
         end
       end
 
+      def emit_child(name)
+        # Override this to dynamically create child nodes.
+      end
+
       def tree_size
         children.inject(children.length) do |count, child|
           count + child.tree_size
@@ -46,109 +93,89 @@ module Flutterby
       end
 
       def parent=(new_parent)
+        # Remove from previous parent
         if @parent
           @parent.children.delete(self)
         end
 
+        # Assign new parent (it may be nil)
         @parent = new_parent
 
-        @parent.children << self
+        # Notify new parent
+        if @parent
+          @parent.children << self
+        end
       end
 
       # Returns all children that will compile to a HTML page.
       #
       def pages
-        children.select { |c| c.ext == "html" && c.should_publish? }
-      end
-    end
-
-    concerning :Paths do
-      def path
-        parent ? ::File.join(parent.path, full_name) : full_name
-      end
-
-      def url
-        ::File.join(parent ? parent.url : "/", full_name)
-      end
-
-      def full_fs_path(base:)
-        ::File.expand_path(::File.join(base, full_name))
-      end
-    end
-
-
-    concerning :Tree do
-      def root
-        parent ? parent.root : self
-      end
-
-      def root?
-        root == self
-      end
-
-      def sibling(name)
-        parent && parent.find(name)
+        children.select { |c| c.page? }
       end
 
-      def siblings
-        parent && parent.children
+      # Creates a new node, using the specified arguments, as a child
+      # of this node.
+      #
+      def create(name, **args)
+        args[:parent] = self
+        Node.new(name.to_s, **args)
       end
 
-      def find(path)
-        return self if path.nil? || path.empty?
+      def find(path, opts = {})
+        path = path.to_s
+        return self if path.empty?
 
         # remove duplicate slashes
-        path.gsub!(%r{/+}, "/")
+        path = path.gsub(%r{/+}, "/")
 
         case path
+        # ./foo/...
         when %r{^\./?} then
-          parent ? parent.find($') : root.find($')
+          parent ? parent.find($', opts) : root.find($', opts)
+
+        # /foo/...
         when %r{^/} then
-          root.find($')
+          root.find($', opts)
+
+        # foo/...
         when %r{^([^/]+)/?} then
-          child = find_child($1)
-          $'.empty? ? child : child.find($')
+          # Use the next path part to find a child by that name.
+          # If no child can't be found, try to emit a child, but
+          # not if the requested name starts with an underscore.
+          if child = find_child($1, opts) || (emit_child($1) unless $1.start_with?("_"))
+            # Depending on the tail of the requested find expression,
+            # either return the found node, or ask it to find the tail.
+            $'.empty? ? child : child.find($', opts)
+          end
         end
       end
+    end
 
-      # Walk the tree up, invoking the passed block for every node
-      # found on the way, passing the node as its only argument.
-      #
-      def walk_up(val = nil, &blk)
-        val = blk.call(self, val)
-        parent ? parent.walk_up(val, &blk) : val
-      end
+    include Tree
 
-      # Walk the graph from the root to this node. Just like walk_up,
-      # except the block will be called on higher level nodes first.
-      #
-      def walk_down(val = nil, &blk)
-        val = parent ? parent.walk_up(val, &blk) : val
-        blk.call(self, val)
-      end
 
-      # Walk the entire tree, top to bottom.
+    module Reading
+      # (Re-)loads the node from the filesystem, if it's a filesystem based
+      # node.
       #
-      def walk_tree(val = nil, &blk)
-        val = blk.call(self, val)
-        children.each do |child|
-          val = child.walk_tree(val, &blk)
-        end
-
-        val
-      end
-    end
-
-    concerning :Reading do
       def reload!
-        @body     = nil
         @data     = nil
+        @data_proxy = nil
+        @prefix   = nil
+        @slug     = nil
         @children = []
-        @paths    = {}
 
         load_from_filesystem! if @fs_path
+
+        extract_data!
+      end
+
+      def data
+        @data_proxy ||= Dotaccess[@data]
       end
 
+      private
+
       def load_from_filesystem!
         if @fs_path
           if ::File.directory?(fs_path)
@@ -161,32 +188,41 @@ module Flutterby
           end
         end
       end
-    end
 
-    concerning :Data do
-      def data
-        extract_data! if @data.nil?
-        @data
-      end
+      private
 
       def extract_data!
-        @data ||= {}
+        @data ||= {}.with_indifferent_access
+
+        # Extract prefix and slug
+        if name =~ %r{\A([\d-]+)-(.+)\Z}
+          @prefix = $1
+          @slug = $2
+        else
+          @slug = name
+        end
 
-        # Extract date from name
-        if name =~ %r{^(\d\d\d\d\-\d\d?\-\d\d?)\-}
+        # Change this node's name to the slug. This may be made optional
+        # in the future.
+        @name = @slug
+
+        # Extract date from prefix if possible
+        if prefix =~ %r{\A(\d\d\d\d\-\d\d?\-\d\d?)\Z}
           @data['date'] = Date.parse($1)
         end
 
         # Read remaining data from frontmatter. Data in frontmatter
         # will always have precedence!
-        parse_frontmatter!
+        extract_frontmatter!
 
-        # Do some extra processing depending on extension
+        # Do some extra processing depending on extension. This essentially
+        # means that your .json etc. files will be rendered at least once at
+        # bootup.
         meth = "read_#{ext}!"
-        send(meth) if respond_to?(meth)
+        send(meth) if respond_to?(meth, true)
       end
 
-      def parse_frontmatter!
+      def extract_frontmatter!
         @data || {}
 
         if @source
@@ -203,11 +239,11 @@ module Flutterby
       end
 
       def read_json!
-        @data.merge!(JSON.parse(body))
+        @data.merge!(JSON.parse(render))
       end
 
       def read_yaml!
-        @data.merge!(YAML.load(body))
+        @data.merge!(YAML.load(render))
       end
 
       def read_yml!
@@ -215,85 +251,95 @@ module Flutterby
       end
 
       def read_toml!
-        @data.merge!(TOML.parse(body))
+        @data.merge!(TOML.parse(render))
       end
     end
 
-    concerning :Staging do
+    include Reading
+
+
+
+    module Staging
       def stage!
-        # First of all, we want to make sure all nodes have their
-        # available extensions loaded.
+        # First of all, we want to make sure all initializers
+        # (`_init.rb` files) are executed, starting at the top of the tree.
         #
-        walk_tree do |node|
-          node.load_extension! unless node.name == "_node"
+        TreeWalker.walk_tree(self) do |node|
+          if node.full_name == "_init.rb"
+            logger.debug "Executing initializer #{node.url}"
+            node.instance_eval(node.render)
+          end
         end
 
-        # Now do another pass, prerendering stuff where necessary,
-        # extracting data, registering URLs to be exported, etc.
+        # In a second pass, walk the tree to invoke any available
+        # setup methods.
         #
-        walk_tree do |node|
-          node.render_body! if node.should_prerender?
-          node.register_url! if node.should_publish?
+        TreeWalker.walk_tree(self) do |node|
+          node.perform_setup!
         end
       end
 
-      def load_extension!
-        if extension = sibling("_node.rb")
-          instance_eval(extension.body)
+      # Perform setup for this node. The setup step is run after the
+      # tree has been built up completely. It allows you to perform one-time
+      # setup operations that, for example, modify the tree (like sorting blog
+      # posts into date-specific subnodes.)
+      #
+      # Your nodes (or their extensions) may overload this method, but you
+      # may also simply use the `setup { ... }` syntax in a node extension
+      # to define a block of code to be run at setup time.
+      #
+      def perform_setup!
+        _setup_procs.each do |p|
+          instance_exec(&p)
         end
       end
 
-      def should_prerender?
-        !folder? &&
-          (["json", "yml", "yaml", "rb", "toml"] & filters).any?
+      # Extend all of this node's siblings. See {#extend_all}.
+      #
+      def extend_siblings(*mods, &blk)
+        extend_all(siblings, *mods, &blk)
       end
-    end
 
-
-    concerning :Rendering do
-      def view
-        @view ||= View.for(self)
+      # Extend this node's parent. See {#extend_all}.
+      #
+      def extend_parent(*mods, &blk)
+        extend_all([parent], *mods, &blk)
       end
 
-      def render_body!
-        time = Benchmark.realtime do
-          Filters.apply!(self)
+      # Extend all of the specified `nodes` with the specified module(s). If
+      # a block is given, the nodes will be extended with the code found
+      # in the block.
+      #
+      def extend_all(nodes, *mods, &blk)
+        if block_given?
+          mods << NodeExtension.new(&blk)
         end
 
-        logger.info "Rendered #{url} in #{sprintf "%.1f", time * 1000}ms"
-      end
-
-      def body
-        if @body.nil?
-          data   # make sure data is lazy-loaded
-          render_body!
+        nodes.each do |n|
+          n.extend(*mods)
         end
-
-        @body
       end
+    end
 
-      def render(opts = {})
-        layout = opts[:layout]
-        view.opts.merge!(opts)
-        (layout && apply_layout?) ? apply_layout(body) : body
-      end
+    include Staging
 
-      def apply_layout(input)
-        walk_up(input) do |node, current|
-          if layout = node.sibling("_layout")
-            tilt = Flutterby::Filters.tilt(layout.ext, layout.source)
-            tilt.render(view) { current }.html_safe
-          else
-            current
-          end
-        end
+
+    module Rendering
+      # Returns a freshly created {View} instance for this node.
+      #
+      def view(opts = {})
+        View.for(self, opts)
       end
 
-      def apply_layout?
-        page?
+      # Creates a new {View} instance through {#view} and uses it to
+      # render this node. Returns the rendered page as a string.
+      #
+      def render(opts = {})
+        view(opts).render!
       end
     end
 
+    include Rendering
 
 
 
@@ -302,8 +348,16 @@ module Flutterby
     # Misc
     #
 
+    # Returns the node's title. If there is a `:title` key in {#data}, its
+    # value will be used; otherwise, as a fallback, it will generate a
+    # human-readable title from {#slug}.
+    #
+    def title
+      data[:title] || slug.try(:titleize)
+    end
+
     def to_s
-      "<#{self.class} #{self.path}>"
+      "<#{self.class} #{self.url}>"
     end
 
     def full_name
@@ -315,11 +369,11 @@ module Flutterby
     end
 
     def file?
-      !folder?
+      !folder? && should_publish?
     end
 
     def page?
-      !folder? && ext == "html"
+      file? && ext == "html"
     end
 
     def should_publish?
@@ -330,9 +384,10 @@ module Flutterby
       Flutterby.logger
     end
 
-    def copy(new_name)
+    def copy(new_name, data = {})
       dup.tap do |c|
         c.name = new_name
+        c.data.merge!(data)
         parent.children << c
       end
     end

data/lib/flutterby/node_extension.rb

@@ -0,0 +1,23 @@
+module Flutterby
+  # NodeExtension is a subclass of Module that also provides a convenient
+  # `setup` method for quick creation of initialization code. It's used
+  # to wrap the blocks of code passed to {Node#extend_all} and friends,
+  # but can also be used directly through `NodeExtension.new { ... }`.
+  #
+  class NodeExtension < Module
+    def initialize(*args)
+      @_setup_procs = []
+      super
+    end
+
+    def extended(base)
+      if @_setup_procs.any?
+        base._setup_procs.append(*@_setup_procs)
+      end
+    end
+
+    def on_setup(&blk)
+      @_setup_procs << blk
+    end
+  end
+end

data/lib/flutterby/server.rb

@@ -4,12 +4,11 @@ require 'better_errors'
 
 module Flutterby
   class Server
-    def initialize(root, port: 4004)
+    def initialize(root)
       @root = root
-      @port = port
     end
 
-    def run!
+    def run!(port: 4004)
       # Set up listener
       listener = Listen.to(@root.fs_path) do |modified, added, removed|
         # puts "modified absolute path: #{modified}"
@@ -40,11 +39,11 @@ module Flutterby
 
       # Go!
       listener.start
-      server.run app, Port: @port, Logger: Flutterby.logger
+      server.run app, Port: port, Logger: Flutterby.logger
     end
 
     def call(env)
-      req  = Rack::Request.new(env)
+      req = Rack::Request.new(env)
       res = Rack::Response.new([], 200, {})
 
       # Look for target node in path registry
@@ -65,9 +64,11 @@ module Flutterby
     end
 
     def find_node_for_path(path)
-      @root.paths[path] ||
-      @root.paths[path + ".html"] ||
-      @root.paths[::File.join(path, "index.html")]
+      if node = @root.find(path, public_only: true)
+        # If the node is a folder, try and find its "index" node.
+        # Otherwise, use the node directly.
+        node.folder? ? node.find('index') : node
+      end
     end
   end
 end

data/lib/flutterby/tree_walker.rb

@@ -0,0 +1,37 @@
+module Flutterby
+  # A helper module with methods to walk across a node tree in various
+  # directions and variations and perform a block of code on each passed node.
+  #
+  module TreeWalker
+    extend self
+
+    # Walk the tree up, invoking the passed block for every node
+    # found on the way, passing the node as its only argument.
+    #
+    def walk_up(node, val = nil, &blk)
+      val = blk.call(node, val)
+      node.parent ? walk_up(node.parent, val, &blk) : val
+    end
+
+    # Walk the graph from the root to the specified node. Just like {#walk_up},
+    # except the block will be called on higher level nodes first.
+    #
+    def walk_down(node, val = nil, &blk)
+      val = node.parent ? walk_up(node.parent, val, &blk) : val
+      blk.call(node, val)
+    end
+
+    # Walk the entire tree, top to bottom, starting with its root, and then
+    # descending into its child layers.
+    #
+    def walk_tree(node, val = nil, &blk)
+      val = blk.call(node, val)
+
+      node.children.each do |child|
+        val = walk_tree(child, val, &blk)
+      end
+
+      val
+    end
+  end
+end

data/lib/flutterby/version.rb

@@ -1,3 +1,3 @@
 module Flutterby
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/flutterby/view.rb

@@ -1,6 +1,9 @@
+require 'benchmark'
+
 module Flutterby
   class View
-    attr_reader :node, :opts
+    attr_reader :node, :opts, :source
+    attr_accessor :_body
     alias_method :page, :node
 
     # Include ERB::Util from ActiveSupport. This will provide
@@ -10,9 +13,41 @@ module Flutterby
     #
     include ERB::Util
 
-    def initialize(node)
+    def initialize(node, opts = {})
       @node = node
-      @opts = {}
+      @opts = opts
+      @source = node.source
+      @_body = nil
+    end
+
+    def render!
+      time = Benchmark.realtime do
+        Filters.apply!(self)
+
+        # Apply layouts
+        if opts[:layout] && node.page?
+          @_body = apply_layout!(@_body)
+        end
+      end
+
+      logger.info "Rendered #{node.url} in #{sprintf "%.1f", time * 1000}ms"
+
+      @_body
+    end
+
+    def apply_layout!(input)
+      TreeWalker.walk_up(node, input) do |node, current|
+        if layout = node.sibling("_layout")
+          tilt = Flutterby::Filters.tilt(layout.ext, layout.source)
+          tilt.render(self) { current }.html_safe
+        else
+          current
+        end
+      end
+    end
+
+    def to_s
+      @_body ||= render!
     end
 
     def date_format(date, fmt)
@@ -24,7 +59,11 @@ module Flutterby
     end
 
     def render(expr, *args)
-      find(expr).render(*args)
+      if expr.is_a?(Node)
+        expr.render(*args)
+      else
+        find(expr).render(*args)
+      end
     end
 
     def find(*args)
@@ -35,7 +74,7 @@ module Flutterby
       node.siblings(*args)
     end
 
-    def tag(name, attributes)
+    def tag(name, attributes = {})
       ActiveSupport::SafeBuffer.new.tap do |output|
         attributes_str = attributes.keys.sort.map do |k|
           %{#{h k}="#{h attributes[k]}"}
@@ -61,16 +100,20 @@ module Flutterby
       tag(:pre, class: "debug") { h obj.to_yaml }
     end
 
+    def logger
+      @logger ||= Flutterby.logger
+    end
+
     class << self
       # Factory method that returns a newly created view for the given node.
       # It also makes sure all available _view.rb extensions are loaded.
       #
-      def for(file)
+      def for(node, *args)
         # create a new view instance
-        view = new(file)
+        view = new(node, *args)
 
         # walk the tree up to dynamically extend the view
-        file.walk_down do |e|
+        TreeWalker.walk_down(node) do |e|
           if view_node = e.sibling("_view.rb")
             case view_node.ext
             when "rb" then

data/lib/templates/new_project/site/_config.yaml

@@ -0,0 +1,9 @@
+# This is your site's configuration file.
+
+site:
+  title: My Flutterby Site
+  description: >
+    This is my new <a href="https://github.com/hmans/flutterby">Flutterby</a> Site. I should probably
+    change this description in my site's configuration file,
+    found at ./site/_config.yaml. Or I can just leave it as is.
+    Isn't choice wonderful?

data/lib/templates/new_project/site/_layout.slim

@@ -2,7 +2,8 @@ doctype html
 html 
   head
     meta charset="utf-8"
-    title = config["site"]["title"]
+    title = config.site.title
+    meta name="viewport" content="width=device-width, initial-scale=1.0"
 
     // highlight.js for syntax highlighting 
     link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.9.0/styles/default.min.css"
@@ -17,4 +18,4 @@ html
       = yield
       
       footer role="main"
-        == config["site"]["description"]
+        == config.site.description

data/lib/templates/new_project/site/blog/_init.rb

@@ -0,0 +1,11 @@
+# A _init.rb file contains Ruby code that will be executed when
+# your application boots up. Use it to extend and modify other nodes!
+#
+# In this simple example, we're simply adding some convenience methods to
+# all available blog posts for easier access to specific pieces of data.
+
+extend_siblings do
+  def date
+    data.date
+  end
+end

data/lib/templates/new_project/site/blog/_layout.slim

@@ -4,4 +4,4 @@ article.post
 
   h1 = page.title
 
-  = page.body
+  = yield

data/lib/templates/new_project/site/blog/hello-world.html.md.tt

@@ -8,7 +8,7 @@ date: <%= Date.today.to_s %>
 
 This sample project is set up as a simple blog, but of course you can do so much more with Flutterby. Just head straight into your project's `site` directory and mix things up. Some files you should look at:
 
-| `/_config.toml` | Your site configuration. |
+| `/_config.yaml` | Your site configuration. |
 | `/css/styles.css.scss` | Your stylesheet. [Sass]-powered, of course! |
 | `/_layout.slim` | Your global site layout. |
 | `/posts/_layout.slim` | Your post-specific layout. |

data/lib/templates/new_project/site/index.html.slim

@@ -1,4 +1,4 @@
-h1 = config["site"]["title"]
+h1 = config.site.title
 
 p This is my new website! #{link_to "Find out more", "/about.html"}.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutterby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Hendrik Mans
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-21 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -343,6 +357,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
@@ -352,28 +367,34 @@ files:
 - bin/rake
 - bin/rspec
 - bin/setup
+- bin/yard
+- bin/yardoc
+- bin/yri
 - exe/flutterby
 - flutterby.gemspec
 - lib/flutterby.rb
 - lib/flutterby/cli.rb
+- lib/flutterby/dotaccess.rb
 - lib/flutterby/exporter.rb
 - lib/flutterby/filters.rb
 - lib/flutterby/markdown_formatter.rb
 - lib/flutterby/node.rb
+- lib/flutterby/node_extension.rb
 - lib/flutterby/server.rb
+- lib/flutterby/tree_walker.rb
 - lib/flutterby/version.rb
 - lib/flutterby/view.rb
 - lib/templates/new_project/.gitignore
 - lib/templates/new_project/Gemfile.tt
 - lib/templates/new_project/README.md
 - lib/templates/new_project/bin/flutterby
-- lib/templates/new_project/site/_config.toml
+- lib/templates/new_project/site/_config.yaml
 - lib/templates/new_project/site/_layout.slim
 - lib/templates/new_project/site/_view.rb
 - lib/templates/new_project/site/about.html.md
+- lib/templates/new_project/site/blog/_init.rb
 - lib/templates/new_project/site/blog/_layout.slim
 - lib/templates/new_project/site/blog/_list.html.slim
-- lib/templates/new_project/site/blog/_node.rb
 - lib/templates/new_project/site/blog/_view.rb
 - lib/templates/new_project/site/blog/hello-world.html.md.tt
 - lib/templates/new_project/site/css/styles.css.scss

data/lib/templates/new_project/site/_config.toml

@@ -1,10 +0,0 @@
-# This is your site's configuration file.
-
-[site]
-title = "My Flutterby Site"
-description = """
-This is my new <a href="https://github.com/hmans/flutterby">Flutterby</a> Site. I should probably
-change this description in my site's configuration file,
-found at ./site/_config.toml. Or I can just leave it as is.
-Isn't choice wonderful?
-"""

data/lib/templates/new_project/site/blog/_node.rb

@@ -1,14 +0,0 @@
-# A _node.rb will be run against all nodes from the same directory -- use it
-# to enhance the Ruby objects representing these nodes with extra methods
-# or behavior.
-#
-# In this example, we're simply adding some convenience methods for easier
-# access to specific pieces of data.
-
-def date
-  data["date"]
-end
-
-def title
-  data["title"]
-end