flutterby 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f25431bf9e8f2dafc67f58b966c2fde5a368055
-  data.tar.gz: f32e383638dfc175617f1f5a3af8eff54ca288e9
+  metadata.gz: 912db5fb0467b2ea17535d27a16f7d5cae9c4844
+  data.tar.gz: bc120fb8c0db94fe25f9894183c2ac784c8c7723
 SHA512:
-  metadata.gz: 59134f58f623e20cc2e168671e43dfa7012577c90108db6f6bb0bb92af52a990f2f2629a6cd00a55da4aa43aff5c86155572e5f9d3c81c0804419f256b4f1f72
-  data.tar.gz: 7900512a1c3d2cf8d193c3c427d6c4f06d16cef75c5b3be817f7db3bf658685e15654894a6f2cbf352a96922b12e6dd2e28f260a972fdafbd80732dcc1cc3109
+  metadata.gz: 2f00d281c3fc731e97877ee6c091d38a5589ed3ff6bcddc0301f6b5b4a78a1b6357585af2facbbe314c2134233e2e349108d789e34c75e11f502e9617d5a58f2
+  data.tar.gz: 2c054331bd42b2c1fc898694ec1b9446d8fa04d8e53f728feaff8ba13885c27e6ac0d22e738f9191998e47619c46309e8820deccf53c40b2e08c9d4ae80f4d9d

data/CHANGES.md

@@ -1,6 +1,12 @@
 # Version History
 
-### HEAD
+### 0.5.2 (2017-01-25)
+
+- **NEW:** Just like `find`, there is now also a `find!` that will raise an exception when the specified node could not be found.
+- **NEW:** Nodes can now control the layout(s) that will be applied to them in their front matter through the `layout` keyword.
+
+
+### 0.5.1 (2017-01-24)
 
 - **NEW:** Views now provide an `extend_view` method that you can (and should) use in `_view.rb` extensions.
 - **NEW:** Improved log output, especially when using `--debug`.

data/lib/flutterby/filters.rb

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

data/lib/flutterby/layout.rb

@@ -0,0 +1,49 @@
+module Flutterby
+  module Layout
+    extend self
+
+    # Determines which layouts should be applied to the view object (based on
+    # the node it is rendering), and then applies each of these layouts in order,
+    # modifying the view in place.
+    #
+    def apply!(body, view:)
+      collect_layouts(view).inject(body) do |acc, layout|
+        tilt = Flutterby::Filters.tilt(layout.ext, layout.source)
+        tilt.render(view) { acc }.html_safe
+      end
+    end
+
+    private
+
+    def collect_layouts(view)
+      layouts = []
+
+      # Collect layouts explicitly configured for node
+      if defined? view.node.layout
+        Array(view.node.layout).each do |sel|
+          # If a false is explicity specified, that's all the layouts
+          # we're expected to render
+          return layouts if sel == false
+
+          if layout = view.node.find(sel)
+            layouts << layout
+          else
+            raise "No layout found for path expression '#{sel}'"
+          end
+        end
+      end
+
+      # Decide on a starting node for walking the tree upwards
+      start = layouts.any? ? layouts.last.parent : view.node
+
+      # Walk the tree up, collecting any layout files found on our way
+      TreeWalker.walk_up(start) do |node|
+        if layout = node.sibling("_layout")
+          layouts << layout
+        end
+      end
+
+      layouts
+    end
+  end
+end

data/lib/flutterby/node.rb

@@ -121,6 +121,13 @@ module Flutterby
         Node.new(name.to_s, **args)
       end
 
+      # Like {find}, but raises an exception when the specified node could not
+      # be found.
+      #
+      def find!(path, *args)
+        find(path, *args) || raise("Could not find node for path expression '#{path}'")
+      end
+
       def find(path, opts = {})
         path = path.to_s
         return self if path.empty?
@@ -223,8 +230,6 @@ module Flutterby
       end
 
       def extract_frontmatter!
-        @data || {}
-
         if @source
           # YAML Front Matter
           if @source.sub!(/\A\-\-\-\n(.+)\n\-\-\-\n/m, "")
@@ -325,17 +330,11 @@ module Flutterby
 
 
     module Rendering
-      # Returns a freshly created {View} instance for this node.
-      #
-      def view(opts = {})
-        View.for(self, opts)
-      end
-
-      # Creates a new {View} instance through {#view} and uses it to
+      # Creates a new {View} instance and uses it to
       # render this node. Returns the rendered page as a string.
       #
       def render(opts = {})
-        view(opts).render!
+        View.for(self, opts).render!
       end
     end
 
@@ -356,6 +355,13 @@ module Flutterby
       data[:title] || slug.try(:titleize)
     end
 
+    # Returns the layout(s) configured for this node. This is sourced from
+    # the node's {data} attribute, so it can be set from front matter.
+    #
+    def layout
+      data[:layout]
+    end
+
     def to_s
       "<#{self.class} #{self.url}>"
     end

data/lib/flutterby/version.rb

@@ -1,3 +1,3 @@
 module Flutterby
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/lib/flutterby/view.rb

@@ -1,9 +1,9 @@
 require 'benchmark'
+require 'flutterby/layout'
 
 module Flutterby
   class View
-    attr_reader :node, :opts, :source
-    attr_accessor :_body
+    attr_reader :node, :opts
     alias_method :page, :node
 
     # Include ERB::Util from ActiveSupport. This will provide
@@ -16,17 +16,17 @@ module Flutterby
     def initialize(node, opts = {})
       @node = node
       @opts = opts
-      @source = node.source
-      @_body = nil
     end
 
     def render!
+      output = node.source.try(:html_safe)
+
       time = Benchmark.realtime do
-        Filters.apply!(self)
+        output = Filters.apply!(output, view: self)
 
         # Apply layouts
         if opts[:layout] && node.page?
-          @_body = apply_layout!(@_body)
+          output = Layout.apply!(output, view: self)
         end
       end
 
@@ -41,22 +41,7 @@ module Flutterby
 
       logger.debug "Rendered #{node.url.colorize(:blue)} in #{sprintf("%.1fms", time * 1000).colorize(color)}"
 
-      @_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!
+      output
     end
 
     def date_format(date, fmt)
@@ -76,7 +61,11 @@ module Flutterby
     end
 
     def find(*args)
-      node.find(*args) or raise "No node found for #{args}"
+      node.find(*args)
+    end
+
+    def find!(*args)
+      node.find!(*args)
     end
 
     def siblings(*args)
@@ -117,6 +106,8 @@ module Flutterby
       extend(*mods)
     end
 
+    private
+
     def logger
       @logger ||= Flutterby.logger
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutterby
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Hendrik Mans
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -391,6 +391,7 @@ files:
 - lib/flutterby/dotaccess.rb
 - lib/flutterby/exporter.rb
 - lib/flutterby/filters.rb
+- lib/flutterby/layout.rb
 - lib/flutterby/markdown_formatter.rb
 - lib/flutterby/node.rb
 - lib/flutterby/node_extension.rb