flutterby 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c87a6c4e67963aa5d66c2225d60b9e228a2d852
-  data.tar.gz: 896782e01a481af93bc5da7d9a277bc9252d9f29
+  metadata.gz: 98bf6013901069664a2281251125dbc4f2b82bf1
+  data.tar.gz: 677647c5e11088fbf5091fe7aa3e5a121a48c37a
 SHA512:
-  metadata.gz: 52dcaab598ca23c831ff348a3fdeb56124a4ce663c45c36ba47d4211370d602f8b1e0389de27fc9ec830b79abe0761dcbfe5c64a47834de46f17b75418424e72
-  data.tar.gz: 760b7537767012d5b6d044c537d461bfd52514c2feeb5bf114d4213de1805add17e09eaff1225cb2af0381076f1c6f4f2f99201a644a638dce558ebee55d5392
+  metadata.gz: cd149d0e3efa73a1692fc9b940f09dbaef6379864721c396b6f7103d624973477da40fcdab67e600051b7d5c53b5cc9445a871b4f37136a60506c5c2929410a1
+  data.tar.gz: 94648d86b9e989b8dc523a345aa4b655e54c13e1faf6fa58766a2174faffde2eeefb9458968e3496cc69207f462ea8328256fefaa38f1f4d9946b50594088dd4

data/lib/flutterby.rb

@@ -10,7 +10,6 @@ require "flutterby/version"
 require "flutterby/node"
 require "flutterby/filters"
 require "flutterby/view"
-require "flutterby/server"
 
 
 module Flutterby
@@ -22,7 +21,9 @@ module Flutterby
     name ||= ::File.basename(fs_path)
 
     if ::File.exist?(fs_path)
-      Node.new(name, fs_path: fs_path, parent: parent)
+      Node.new(name, fs_path: fs_path, parent: parent).tap do |node|
+        node.preprocess!
+      end
     else
       raise "Path #{fs_path} could not be found."
     end

data/lib/flutterby/cli.rb

@@ -1,5 +1,8 @@
-require 'commander'
 require 'flutterby'
+require 'flutterby/exporter'
+require "flutterby/server"
+
+require 'commander'
 require 'benchmark'
 
 Flutterby.logger.level = Logger::INFO
@@ -32,7 +35,7 @@ Commander.configure do
 
         # Export site
         say color("💾  Exporting site...", :bold)
-        root.export(into: options.out)
+        Flutterby::Exporter.new(root).export!(into: options.out)
       end
 
       say color("✅  Done. (took #{sprintf "%.2f", time}s)", :green, :bold)

data/lib/flutterby/exporter.rb

@@ -0,0 +1,31 @@
+module Flutterby
+  class Exporter
+    def initialize(root)
+      @root = root
+    end
+
+    def export!(into:)
+      @root.paths.each do |path, node|
+        if node.should_publish?
+          path = ::File.expand_path(::File.join(into, node.url))
+
+          if node.file?
+            # Make sure directory exists
+            FileUtils.mkdir_p(::File.dirname(path))
+
+            # Write file
+            ::File.write(path, node.render)
+            logger.info "Exported #{node.url}"
+          end
+        end
+      end
+    end
+
+
+    private
+
+    def logger
+      @logger ||= Flutterby.logger
+    end
+  end
+end

data/lib/flutterby/filters.rb

@@ -1,43 +1,40 @@
 module Flutterby
   module Filters
-    def apply!(file)
-      body = file.source
+    def apply!(node)
+      node.body = node.source
 
       # Apply all filters
-      file.filters.each do |filter|
-        meth = "process_#{filter}"
+      node.filters.each do |filter|
+        meth = "process_#{filter}!"
 
-        # Set the file's extension to the requested filter. The filter
-        # itself can, of course, override this (eg. the "md" filter can default
-        # the extension to "html".)
-        #
-        file.ext = filter
-
-        # Now apply the actual filter!
-        #
         if Filters.respond_to?(meth)
-          body = Filters.send(meth, body, file)
+          Filters.send(meth, node)
         end
       end
+    end
 
-      file.body = body
+    def process_rb!(node)
+      # extend the node
+      mod = Module.new
+      mod.class_eval(node.body)
+      node.extend(mod)
+      node.filter! if node.respond_to?(:filter!)
     end
 
-    def process_erb(input, file)
-      tilt("erb", input).render(file.view)
+    def process_erb!(node)
+      node.body = tilt("erb", node.body).render(node.view)
     end
 
-    def process_slim(input, file)
-      tilt("slim", input).render(file.view)
+    def process_slim!(node)
+      node.body = tilt("slim", node.body).render(node.view)
     end
 
-    def process_md(input, file)
-      file.ext = "html"
-      Slodown::Formatter.new(input).complete.to_s
+    def process_md!(node)
+      node.body = Slodown::Formatter.new(node.body).complete.to_s
     end
 
-    def process_scss(input, file)
-      Sass::Engine.new(input, syntax: :scss).render
+    def process_scss!(node)
+      node.body = Sass::Engine.new(node.body, syntax: :scss).render
     end
 
     def tilt(format, body)

data/lib/flutterby/node.rb

@@ -3,26 +3,22 @@ require 'benchmark'
 module Flutterby
   class Node
     attr_accessor :parent, :ext, :source, :body
-    attr_reader :name, :filters, :fs_path, :data, :children
+    attr_reader :name, :filters, :fs_path, :data, :children, :paths
 
-    def initialize(name, parent: nil, fs_path: nil)
-      @parent  = parent
-      @data    = {}
+    def initialize(name, parent: nil, fs_path: nil, source: nil)
+      @fs_path = fs_path ? ::File.expand_path(fs_path) : nil
+      @source  = source
 
       # Extract name, extension, and filters from given name
       parts    = name.split(".")
       @name    = parts.shift
+      @ext     = parts.shift
       @filters = parts.reverse
 
-      # We're assuming the extension is the name of the final filter
-      # that will be applied. This may not be always correct, since filters
-      # can also change a file's extension.
-      #
-      @ext     = @filters.last
-
-      # If a filesystem path was given, read the node from disk
-      if fs_path
-        @fs_path = ::File.expand_path(fs_path)
+      # Register this node with its parent
+      if parent
+        @parent = parent
+        parent.children << self
       end
 
       reload!
@@ -32,13 +28,10 @@ module Flutterby
     # Children
     #
 
-    def reset_children!
-      @children = []
-    end
-
-    def add_child(node)
-      node.parent = self
-      children << node
+    def register!
+      if file?
+        root.paths[url] = self
+      end
     end
 
     def find_child(name)
@@ -145,51 +138,71 @@ module Flutterby
     #
 
     def reload!
-      @body = nil
-      reset_children!
+      @body     = nil
+      @data     = {}
+      @children = []
+      @paths    = {}
+
+      load_from_filesystem! if @fs_path
+    end
+
+    def preprocess!
+      # First of all, we want to make sure all nodes have their
+      # available extensions loaded.
+      #
+      walk_tree do |node|
+        node.load_extension! if node.should_publish?
+      end
 
-      # Load contents from filesystem
+      # Now do another pass, prerendering stuff where necessary,
+      # extracting data, registering URLs to be exported, etc.
       #
+      walk_tree do |node|
+        node.render_body! if node.should_prerender?
+        node.extract_data!
+        node.register! if node.should_publish?
+      end
+    end
+
+    def should_prerender?
+      should_publish? && !folder? &&
+        (["json", "yaml", "rb"] & filters).any?
+    end
+
+    def load_from_filesystem!
       if @fs_path
         if ::File.directory?(fs_path)
           Dir[::File.join(fs_path, "*")].each do |entry|
-            if node = Flutterby.from(entry, parent: self)
-              add_child(node)
-            end
+            name = ::File.basename(entry)
+            Flutterby::Node.new(name, parent: self, fs_path: entry)
           end
         else
           @source = ::File.read(fs_path)
-
-          # Extract date from name
-          if name =~ %r{^(\d\d\d\d\-\d\d?\-\d\d?)\-}
-            @data['date'] = Time.parse($1)
-          end
-
-          # Read remaining data from frontmatter. Data in frontmatter
-          # will always have precedence!
-          @data.merge! parse_frontmatter
-
-          # Do some extra processing depending on extension
-          meth = "read_#{ext}"
-          send(meth) if respond_to?(meth)
         end
       end
-
-      # If this node is the root node, perform some preprocessing
-      if root?
-        preprocess!
-      end
     end
 
-    def preprocess!
-      walk_tree do |node|
-        node.render_body! if node.should_preprocess?
+    def extract_data!
+      # Extract date from name
+      if name =~ %r{^(\d\d\d\d\-\d\d?\-\d\d?)\-}
+        data['date'] = Time.parse($1)
       end
+
+      # Read remaining data from frontmatter. Data in frontmatter
+      # will always have precedence!
+      parse_frontmatter!
+
+      # Do some extra processing depending on extension
+      meth = "read_#{ext}!"
+      send(meth) if respond_to?(meth)
     end
 
-    def should_preprocess?
-      should_publish? && !folder? &&
-        (filters.include?("json") || filters.include?("yaml"))
+    def load_extension!
+      if extension = sibling("_node.rb")
+        mod = Module.new
+        mod.class_eval(extension.body)
+        extend mod
+      end
     end
 
     #
@@ -234,66 +247,30 @@ module Flutterby
 
 
 
-    #
-    # Exporting
-    #
-
-    def export(into:)
-      if should_publish?
-        time = Benchmark.realtime do
-          write_static(into: into)
-        end
-
-        logger.info "Exported #{url}"
-      end
-    end
-
-    def write_static(into:)
-      if folder?
-        # write children, acting as a directory
-
-        path = full_fs_path(base: into)
-        Dir.mkdir(path) unless ::File.exists?(path)
-
-        children.each do |child|
-          child.export(into: path)
-        end
-      else
-        # write a file
-        ::File.write(full_fs_path(base: into), render)
-      end
-    end
-
-    def should_publish?
-      !name.start_with?("_")
-    end
-
 
     #
     # Front Matter Parsing
     #
 
-    def parse_frontmatter
-      data = {}
-
-      # YAML Front Matter
-      if @source.sub!(/\A\-\-\-\n(.+)\n\-\-\-\n/m, "")
-        data.merge! YAML.load($1)
-      end
+    def parse_frontmatter!
+      if @source
+        # YAML Front Matter
+        if @source.sub!(/\A\-\-\-\n(.+)\n\-\-\-\n/m, "")
+          data.merge! YAML.load($1)
+        end
 
-      # TOML Front Matter
-      if @source.sub!(/\A\+\+\+\n(.+)\n\+\+\+\n/m, "")
-        data.merge! TOML.parse($1)
+        # TOML Front Matter
+        if @source.sub!(/\A\+\+\+\n(.+)\n\+\+\+\n/m, "")
+          data.merge! TOML.parse($1)
+        end
       end
-
-      data
     end
 
-    def read_json
+    def read_json!
       data.merge!(JSON.parse(body))
     end
 
-    def read_yaml
+    def read_yaml!
       data.merge!(YAML.load(body))
     end
 
@@ -314,10 +291,18 @@ module Flutterby
       children.any?
     end
 
+    def file?
+      !folder?
+    end
+
     def page?
       !folder? && ext == "html"
     end
 
+    def should_publish?
+      !name.start_with?("_")
+    end
+
     def logger
       Flutterby.logger
     end

data/lib/flutterby/server.rb

@@ -37,14 +37,15 @@ module Flutterby
       req  = Rack::Request.new(env)
       res = Rack::Response.new([], 200, {})
 
-      parts = req.path.split("/").reject(&:empty?)
-
-      result = catch :halt do
-        serve(@root, parts, req, res)
-      end
+      # Look for target node in path registry
+      if node = find_node_for_path(req.path)
+        # Determine MIME type
+        mime_type = MIME::Types.type_for(node.ext) || "text/plain"
 
-      case result
-      when :error_404 then
+        # Build response
+        res.headers["Content-Type"] = mime_type
+        res.body = [node.render]
+      else
         res.status = 404
         res.headers["Content-Type"] = "text/html"
         res.body = ["404"]
@@ -53,30 +54,10 @@ module Flutterby
       res
     end
 
-    def serve(node, parts, req, res)
-      # halt if we're not supposed to serve current node
-      throw :halt, :error_404 unless node.should_publish?
-
-      # If there are parts left, find them and delegate to the next
-      # node in the chain; otherwise, render this specific node.
-      #
-      if parts.any?
-        if child = node.find(parts.shift)
-          serve(child, parts, req, res)
-        else
-          throw :halt, :error_404
-        end
-      elsif child = node.find("index")
-        serve(child, parts, req, res)
-      else
-        # Determine MIME type
-        mime_type = MIME::Types.type_for(node.ext) || "text/plain"
-
-        # Build response
-        res.headers["Content-Type"] = mime_type
-        res.body = [node.render]
-        throw :halt
-      end
+    def find_node_for_path(path)
+      @root.paths[path] ||
+      @root.paths[path + ".html"] ||
+      @root.paths[::File.join(path, "index.html")]
     end
   end
 end

data/lib/flutterby/version.rb

@@ -1,3 +1,3 @@
 module Flutterby
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flutterby
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Hendrik Mans
@@ -243,6 +243,7 @@ files:
 - flutterby.gemspec
 - lib/flutterby.rb
 - lib/flutterby/cli.rb
+- lib/flutterby/exporter.rb
 - lib/flutterby/filters.rb
 - lib/flutterby/node.rb
 - lib/flutterby/server.rb