flutterby 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6568ea63c5bdde201dbc5a1b742075e9cdf98353
-  data.tar.gz: e6b105a6a82e813e8bae5d41c81ff1a61d721c3e
+  metadata.gz: 6269342eafe0fdbe1eddad019ecd44ebd5aea360
+  data.tar.gz: 6e9c64dda3163516e527b48247546226e943be0f
 SHA512:
-  metadata.gz: 59b76bd0e67caa50af779351c25081cc2626e1074c6ebf323bc5a6b5f88d5c9e64850ec68c5beab7f109cbb3672f8f480530c0d7f4a0dc17e05dcb6189aa9817
-  data.tar.gz: 18de50df6ce8bc75282b8b97f4c010bfae23aab5f053397e4bbb18abea8600bcbc0581f04ac18c3e847f1da0beb3fb0a5e4576041392525723117b3a20a4ea99
+  metadata.gz: d850ecf93387945baf0e1d7fdb8cf7368cd474c8c24f2d536a9a7ae6d53b0fa2b6c363a078a3ab561af88c333f66af7feb306a6a297ca337af53d3e44917e05e
+  data.tar.gz: 46c17e31c18fbd87c86e5795f15fdd35b3edcccf365d84305e5e828e5228b21022a2a7b4faa55961059bdad3ecf521dd52ee10956aa9d90a3e6b5eb3d9065797

data/README.md

@@ -19,6 +19,26 @@ the _experimental_ bit, though. Use with care, if at all!)
 - Produce a fun screencast to explain what the heck is going on here!
 - More tests, of course!
 
+## How does Flutterby work?
+
+A loose collection of notes on how Flutterby actually generates your site -- mostly intended as rubberducking with myself.
+
+- Flutterby reads a _source directory_ and writes a static website into a _target directory_. (It can also serve a live version of your site.)
+- Before it writes (or serves) anything, it reads the entire contents from the source directory into a graph of plain old Ruby objects. Each of these objects represents a file (or folder) from your site.
+- Flutterby then walks this tree to write the resulting static site, optionally _applying filters_ first. For example, `index.html.md` will be exported as `index.html` after applying a Markdown filter.
+- These filters can be anything that modifies the Ruby object. Some examples:
+  - Rendering Markdown to HTML
+  - Parsing and executing ERB, Slim, HAML and other templating engines
+  - Processing Sass, CoffeeScript and the likes
+  - Leaving the current body intact, but modifying file attributes like the generated file's extension
+- Filters can be chained at any length you require.
+- Ruby code embedded in ERB, Slim etc. templates can interact with this object graph to do funky stuff like:
+  - including the rendered contents of another object (ie. partials)
+  - query the graph for certain objects (eg. "all objects in `/posts` that have `published_at` set")
+  - and much more, I guess!
+- When a `_layout` object is available in the same folder as the rendered object, it will be used to wrap the object's rendered output. These layout files stack, so you can have a `/posts/_layout.erb` with the layout for a single post, and a `/_layout.erb` with the layout of your site.
+- When a `_view.rb` object is available in the same folder as the rendered object, it will be evaluated against the current view, allowing you to define your own view helpers. Like layouts, these will stack.
+- Files and folders starting with underscores (eg. `_header.html`) will never be exported.
 
 ## License
 

data/lib/flutterby.rb

@@ -2,6 +2,7 @@ require "flutterby/version"
 require "flutterby/entity"
 require "flutterby/file"
 require "flutterby/folder"
+require "flutterby/filters"
 require "flutterby/view"
 require "flutterby/server"
 

data/lib/flutterby/entity.rb

@@ -1,19 +1,18 @@
 module Flutterby
   class Entity
-    attr_accessor :parent
-    attr_reader :name, :ext, :filters, :fs_path, :data, :children
+    attr_accessor :parent, :ext
+    attr_reader :name, :filters, :fs_path, :data, :children
 
     def initialize(name, parent: nil, fs_path: nil)
+      @parent  = parent
       @data    = {}
       reset_children!
 
       # Extract name, extension, and filters from given name
-      parts = name.split(".")
-      @name = parts.shift
-      @ext  = parts.shift
+      parts    = name.split(".")
+      @name    = parts.shift
       @filters = parts.reverse
-
-      self.parent = parent
+      @ext     = @filters.last || "html"
 
       # If a filesystem path was given, read the entity from disk
       if fs_path
@@ -61,7 +60,7 @@ module Flutterby
     end
 
     def url
-      @url ||= ::File.join(parent ? parent.url : "/", full_name)
+      ::File.join(parent ? parent.url : "/", full_name)
     end
 
     def full_fs_path(base:)
@@ -144,7 +143,7 @@ module Flutterby
     end
 
     def full_name
-      @full_name ||= [name, ext].compact.join(".")
+      [name, ext].compact.join(".")
     end
 
     def page?

data/lib/flutterby/file.rb

@@ -8,15 +8,15 @@ require 'json'
 
 module Flutterby
   class File < Entity
-    attr_reader :contents
+    attr_accessor :source, :body
 
     def reload!
-      @filtered_contents = nil
+      @body = nil
       super
     end
 
     def read
-      @contents = ::File.read(fs_path)
+      @source = ::File.read(fs_path)
 
       # Extract date from name
       if name =~ %r{^(\d\d\d\d\-\d\d?\-\d\d?)\-}
@@ -36,32 +36,21 @@ module Flutterby
       data = {}
 
       # YAML Front Matter
-      if @contents.sub!(/\A\-\-\-\n(.+)\n\-\-\-\n/m, "")
+      if @source.sub!(/\A\-\-\-\n(.+)\n\-\-\-\n/m, "")
         data.merge! YAML.load($1)
       end
 
       # TOML Front Matter
-      if @contents.sub!(/\A\+\+\+\n(.+)\n\+\+\+\n/m, "")
+      if @source.sub!(/\A\+\+\+\n(.+)\n\+\+\+\n/m, "")
         data.merge! TOML.parse($1)
       end
 
       data
     end
 
-    def filtered_contents
-      @filtered_contents ||= begin
-        result = @contents
-
-        # Apply all filters
-        filters.each do |filter|
-          meth = "process_#{filter}"
-          if respond_to?(meth)
-            result = send(meth, result)
-          end
-        end
-
-        result
-      end
+    def body
+      Filters.apply!(self) if @body.nil?
+      @body
     end
 
     def page?
@@ -76,31 +65,12 @@ module Flutterby
       end
     end
 
-    def process_erb(input)
-      tilt = Tilt["erb"].new { input }
-      tilt.render(view)
-    end
-
-    def process_slim(input)
-      tilt = Tilt["slim"].new { input }
-      tilt.render(view)
-    end
-
-    def process_md(input)
-      Slodown::Formatter.new(input).complete.to_s
-    end
-
-    def process_scss(input)
-      engine = Sass::Engine.new(input, syntax: :scss)
-      engine.render
-    end
-
     def read_json
-      data.merge!(JSON.parse(contents))
+      data.merge!(JSON.parse(@source))
     end
 
     def read_yaml
-      data.merge!(YAML.load(contents))
+      data.merge!(YAML.load(@source))
     end
 
     def apply_layout(input)
@@ -117,7 +87,7 @@ module Flutterby
 
       # Apply all layouts in order
       layouts.each do |layout|
-        tilt = Tilt[layout.ext].new { layout.contents }
+        tilt = Tilt[layout.ext].new { layout.source }
         output = tilt.render(view) { output }
       end
 
@@ -129,8 +99,7 @@ module Flutterby
     end
 
     def render(layout: true)
-      rendered = filtered_contents
-      (layout && apply_layout?) ? apply_layout(rendered) : rendered
+      (layout && apply_layout?) ? apply_layout(body) : body
     end
 
     def write_static(path)

data/lib/flutterby/filters.rb

@@ -0,0 +1,41 @@
+module Flutterby
+  module Filters
+    def apply!(file)
+      body = file.source
+
+      # Apply all filters
+      file.filters.each do |filter|
+        meth = "process_#{filter}"
+
+        if Filters.respond_to?(meth)
+          body = Filters.send(meth, body, file)
+        end
+      end
+
+      file.body = body
+    end
+
+    def process_erb(input, file)
+      tilt("erb", input).render(file.view)
+    end
+
+    def process_slim(input, file)
+      tilt("slim", input).render(file.view)
+    end
+
+    def process_md(input, file)
+      file.ext = "html"
+      Slodown::Formatter.new(input).complete.to_s
+    end
+
+    def process_scss(input, file)
+      Sass::Engine.new(input, syntax: :scss).render
+    end
+
+    def tilt(format, body)
+      Tilt[format].new { body }
+    end
+
+    extend self
+  end
+end

data/lib/flutterby/folder.rb

@@ -22,7 +22,7 @@ module Flutterby
       if view_entity = find("_view.rb")
         case view_entity.ext
         when "rb" then
-          view.instance_eval(view_entity.contents)
+          view.instance_eval(view_entity.source)
         else
           raise "Unknown view extension #{view_entity.full_name}"
         end

data/lib/flutterby/version.rb

@@ -1,3 +1,3 @@
 module Flutterby
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutterby
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Hendrik Mans
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-06 00:00:00.000000000 Z
+date: 2017-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -241,24 +241,15 @@ files:
 - bin/setup
 - exe/flutterby
 - flutterby.gemspec
-- in/_layout.erb
-- in/about.html.md
-- in/contact.html.erb
-- in/index.html.erb
-- in/posts/_layout.slim
-- in/posts/hello-world.html.md
-- in/posts/really-old-blog-post.html.md
-- in/slim-test.html.slim
-- in/styles.css.scss
 - lib/flutterby.rb
 - lib/flutterby/cli.rb
 - lib/flutterby/entity.rb
 - lib/flutterby/file.rb
+- lib/flutterby/filters.rb
 - lib/flutterby/folder.rb
 - lib/flutterby/server.rb
 - lib/flutterby/version.rb
 - lib/flutterby/view.rb
-- out/.gitkeep
 homepage: https://github.com/hmans/flutterby
 licenses:
 - MIT
@@ -279,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: There are many static site generators. This is mine.

data/in/_layout.erb

@@ -1,19 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-    <title>The Blawg of Hendrik Mans</title>
-    <link rel="stylesheet" href="/styles.css">
-  </head>
-  <body>
-    <div class="container">
-      <nav role="main">
-        <a href="/">hmans is blogging, yo</a>
-      </nav>
-      
-      <main role="main">
-        <%= yield %>
-      </main>
-    </div>
-  </body>
-</html>

data/in/about.html.md

@@ -1,3 +0,0 @@
-# I'm Markdown
-
-And that's cool!

data/in/contact.html.erb

@@ -1,3 +0,0 @@
-<h1>Contact</h1>
-
-<p>This is really just a test for <%= "ERB" %>. \o/</p>

data/in/index.html.erb

@@ -1,11 +0,0 @@
-<h1>Hendrik Mans</h1>
-
-<h3>Latest Posts</h3>
-
-<ul>
-  <% entity.root.find('posts').pages.sort_by {|p| p.data['date'] }.reverse.each do |post| %>
-    <li>
-      <a href="<%= post.url %>"><%= post.data["title"] %></a>
-    </li>
-  <% end %>
-</ul>

data/in/posts/_layout.slim

@@ -1,7 +0,0 @@
-article.post
-  .meta
-    = date_format entity.data["date"], "%B %e, %Y"
-
-  h2 = entity.data["title"]
-
-  == entity.contents

data/in/posts/hello-world.html.md

@@ -1,6 +0,0 @@
-+++
-title = "Hello World"
-date = 2017-01-04
-+++
-
-Yay!

data/in/posts/really-old-blog-post.html.md

@@ -1,8 +0,0 @@
-+++
-title = "This is a blog post from 2016"
-date = 2016-12-08
-+++
-
-I got 40 today.
-
-Hooray!

data/in/slim-test.html.slim

@@ -1,3 +0,0 @@
-h1 hi!
-
-p this is a test to see if Slim support works.

data/in/styles.css.scss

@@ -1,160 +0,0 @@
-@import 'https://fonts.googleapis.com/css?family=Noto+Sans:400,700,900|EB+Garamond';
-
-$col1: steelblue;
-$col2: peru;
-$col3: rgb(138, 138, 138);
-$col-link: #666;
-
-$font: 16px/1.5 "Noto Sans","Helvetica Neue",Arial,sans-serif;
-
-* { box-sizing: inherit; }
-html, body { box-sizing: border-box; }
-
-body {
-  font: $font;
-  background-color: white;
-  color: #333;
-}
-
-.container {
-  margin-left: auto;
-  margin-right: auto;
-  max-width: 800px;
-  padding: 50px;
-}
-
-nav[role="main"] {
-  color: grey;
-  font-size: 0.825em;
-
-  a { color: inherit; }
-}
-
-main {
-  margin-top: 2em;
-}
-
-h1, h2, h3, h4, h5, h6 {
-  font-size: inherit;
-}
-
-a {
-  color: $col1;
-}
-
-
-
-/* action lists */
-ul.actions {
-  list-style: none;
-  padding-left: 0;
-  li {
-    display: inline-block;
-    margin-right: 0.5em;
-  }
-}
-
-
-/* buttons */
-button, a.button {
-  display: inline-block;
-  line-height: 2em;
-  padding: 0 1em;
-  border-radius: 2px;
-  background-color: $col1;
-  color: white;
-  text-decoration: none;
-  font-size: 0.825em;
-  border: none;
-  cursor: pointer;
-
-  &.button-grey {
-    background-color: lightgrey;
-    color: dimgrey;
-  }
-
-  &.button-red {
-    background-color: tomato;
-  }
-}
-
-
-
-
-
-/* forms */
-label {
-  display: block;
-  font-weight: bold;
-  abbr { color: grey; text-decoration: none !important }
-}
-
-input, textarea, select {
-  font: inherit;
-}
-
-input.string, input.password, input.email, textarea {
-  width: 100%;
-  padding: 5px;
-  border: 1px solid lightgrey;
-}
-
-input[type="submit"] {
-  @extend button;
-}
-
-.input.field_with_errors {
-  input, textarea { border-color: crimson }
-}
-
-textarea {
-  height: 7em;
-}
-
-textarea#post_body {
-  height: 18em;
-}
-
-.input {
-  margin: 1em 0;
-}
-
-.error, .help-block {
-  color: crimson;
-  font-size: 0.825em;
-}
-
-
-/* stupid non-UJS link forms */
-
-form.link {
-  display: inline;
-}
-
-/* post specific */
-
-article.post {
-  margin: 4em 0;
-
-  .meta {
-    color: lightgrey;
-    font-size: 0.825em;
-
-    a {
-      color: inherit;
-      text-decoration: none;
-      &:hover {
-        text-decoration: underline;
-      }
-    }
-  }
-
-  h1 {
-    font: 44px "EB Garamond", serif;
-    color: #555;
-  }
-
-  h2 {
-    color: $col2;
-  }
-}