flutterby 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51679cec3fb95d5b0e6a2ee392373856eb160b3f
-  data.tar.gz: 17e5203af322a8bc0c9fbe9b435b25c7a27f9166
+  metadata.gz: 0bfb4189fdcf9b5640df468a2818ae3d2f647c71
+  data.tar.gz: adb8399cc0fe5f5c8ca452f8570c8b19fd74aacb
 SHA512:
-  metadata.gz: dc7c1767f95d7a49e5fd2612a187e9e10d1976da0dfd6afad7172a79ac684d3f11e9ef8dffe078e4a4a538b9ff629fd0af45d1461dd45d7bf26d7dbaeccbbc82
-  data.tar.gz: 73b5970b058190ec21e67339d5134f00a795aa92e18d3a65fca87da627b1c9ae7dc2944045aa9e2c91cfe1de7cc243199b1c786bb55ad3481be33805f37b654d
+  metadata.gz: fcdb6900c5bd5aee4c1425bb226b110a151413a27af13f368aa317326521c9a0afe0be656f48413aec7f9bad327642d3ff2c0360c37267b0a271fa83a7e78272
+  data.tar.gz: 832097dcf92dd891160a04a1d164a392efe316aa6a8d79f92e660b76232fab0bf18d9934ce1f6d09c85fa8edc5b2765ee61a28cb64bb6241d197731b565ff649

data/CHANGES.md

@@ -1,6 +1,12 @@
 # Version History
 
-### 0.2.0 (in development)
+### 0.3.1 (2017-01-15)
+
+- **NEW:** Flutterby now uses ActiveSupport. It's a big dependency, but there's just so much useful goodness in there -- let's ride on the shoulders of that giant! This allows you to use all the neat little ActiveSupport toys you may know from Rails in your Flutterby project.
+- **CHANGE:** Thanks to the new inclusion of ActiveSupport, Flutterby now properly deals with HTML escaping (by way of `ActiveSupport::SafeBuffer`). This may not be critically important to static sites, but since Flutterby aspires to also power live sites, better make this change now than later. To sum things up, Flutterby now deals with HTML escaping pretty much like Rails does. Hooray!
+
+
+### 0.2.0 (2017-01-13)
 
 - **BREAKING CHANGE:** The default for `Node#render` is now to _not_ render a layout. Pass `layout: true` if you do want the node to be rendered within a layout.
 - **BREAKING CHANGE:** The behavior of `find` has now changed with regard to relative paths. `find(".")` will now return _the node's parent_ (ie. it's folder); before, a single dot would return the node itself. This change was made to make `find` behave more like what you would expect from a file system.

data/README.md

@@ -5,7 +5,7 @@
 [![Gem Version](https://badge.fury.io/rb/flutterby.svg)](https://badge.fury.io/rb/flutterby) [![Build Status](https://travis-ci.org/hmans/flutterby.svg?branch=master)](https://travis-ci.org/hmans/flutterby) [![license](https://img.shields.io/github/license/hmans/flutterby.svg)](https://github.com/hmans/flutterby/blob/master/LICENSE.txt) ![Status](https://img.shields.io/badge/status-active-brightgreen.svg)
 
 
-#### Key Features
+#### Key Features:
 
 - Generate a static website from a source directory!
 - Apply any number of transformations on files!
@@ -13,10 +13,11 @@
 - Extremely easy to extend with new transformation filters!
 - Sprinkle your site with Ruby code that can interact with your site's pages and data!
 
-#### Recommended Reading
+#### Recommended Reading:
 
 - [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)
+- [Version History](https://github.com/hmans/flutterby/blob/master/CHANGES.md)
 
 ## Installation & Basic Usage
 

data/flutterby.gemspec

@@ -31,6 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'gem-release', '~> 0'
   spec.add_development_dependency 'pry', '~> 0.10'
 
+  spec.add_dependency 'erubis', '~> 2.7'
+  spec.add_dependency 'erubis-auto', '~> 1.0'
   spec.add_dependency 'json', '~> 2.0'
   spec.add_dependency 'thor', '~> 0.19'
   spec.add_dependency 'highline', '~> 1.7'
@@ -40,6 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'listen', '~> 3.1'
   spec.add_dependency 'mime-types', '~> 3.1'
   spec.add_dependency 'better_errors', '~> 2.1'
+  spec.add_dependency 'activesupport', '~> 5.0'
 
   # We support some template engines out of the box.
   # There's a chance these will be extracted/made optional

data/lib/flutterby.rb

@@ -1,3 +1,4 @@
+require 'active_support/all'
 require 'toml'
 require 'mime-types'
 require 'json'

data/lib/flutterby/filters.rb

@@ -1,3 +1,5 @@
+require 'erubis'
+require 'erubis/auto'
 require 'sass'
 require 'tilt'
 require 'slim'
@@ -7,7 +9,7 @@ require 'flutterby/markdown_formatter'
 module Flutterby
   module Filters
     def self.apply!(node)
-      node.body = node.source
+      node.body = node.source.try(:html_safe)
 
       # Apply all filters
       node.filters.each do |filter|
@@ -16,7 +18,7 @@ module Flutterby
         if Filters.respond_to?(meth)
           Filters.send(meth, node)
         elsif template = tilt(filter, node.body)
-          node.body = template.render(node.view)
+          node.body = template.render(node.view).html_safe
         else
           Flutterby.logger.warn "Unsupported filter '#{filter}' for #{node.url}"
         end
@@ -29,8 +31,14 @@ module Flutterby
       end
     end
 
-    def self.tilt(format, body)
-      t = Tilt[format] and t.new { body }
+    def self.tilt(format, body, options = {})
+      default_options = {
+        "erb" => { engine_class: Erubis::Auto::EscapedEruby }
+      }
+
+      options = default_options.fetch(format, {}).merge(options)
+
+      t = Tilt[format] and t.new(options) { body }
     end
   end
 end
@@ -40,7 +48,7 @@ Flutterby::Filters.add("rb") do |node|
 end
 
 Flutterby::Filters.add(["md", "markdown"]) do |node|
-  node.body = Flutterby::MarkdownFormatter.new(node.body).complete.to_s
+  node.body = Flutterby::MarkdownFormatter.new(node.body).complete.to_s.html_safe
 end
 
 Flutterby::Filters.add("scss") do |node|

data/lib/flutterby/node.rb

@@ -252,10 +252,10 @@ module Flutterby
     end
 
     def apply_layout(input)
-      walk_up(input) do |e, current|
-        if layout = e.sibling("_layout")
-          tilt = Tilt[layout.ext].new { layout.source }
-          tilt.render(view) { current }
+      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

data/lib/flutterby/version.rb

@@ -1,3 +1,3 @@
 module Flutterby
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/lib/flutterby/view.rb

@@ -3,6 +3,13 @@ module Flutterby
     attr_reader :node, :opts
     alias_method :page, :node
 
+    # Include ERB::Util from ActiveSupport. This will provide
+    # html_escape, h, and json_escape helpers.
+    #
+    # http://api.rubyonrails.org/classes/ERB/Util.html
+    #
+    include ERB::Util
+
     def initialize(node)
       @node = node
       @opts = {}
@@ -12,6 +19,10 @@ module Flutterby
       date.strftime(fmt)
     end
 
+    def raw(str)
+      str.html_safe
+    end
+
     def render(expr, *args)
       find(expr).render(*args)
     end
@@ -25,6 +36,9 @@ module Flutterby
     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)
         # create a new view instance
         view = new(file)

data/lib/templates/new_project/Gemfile

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 source "https://rubygems.org"
 
-gem "flutterby"
-# gem "flutterby-coffeescript"
+gem "flutterby", "~> 0.3.0"

data/lib/templates/new_project/bin/flutterby

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'flutterby' 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("flutterby", "flutterby")

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

@@ -0,0 +1,20 @@
+doctype html
+html 
+  head
+    meta charset="utf-8"
+    title = config["site"]["title"]
+
+    // highlight.js for syntax highlighting 
+    link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.9.0/styles/default.min.css"
+    script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.9.0/highlight.min.js"
+
+    // Our own assets
+    link rel="stylesheet" href="/css/styles.css"
+    script src="/js/app.js"
+  
+  body
+    .container
+      = yield
+      
+      footer role="main"
+        = config["site"]["description"]

data/lib/templates/new_project/site/_view.rb

@@ -1,3 +1,11 @@
+# When you add a _view.rb file to a folder, all pages in this folder
+# and all folders below it will have the methods defined in it available
+# as view helper methods.
+
+
+# Define a `config` view helper that provides quick access to the
+# site configuration object's data.
+#
 def config
   find("/_config").data
 end

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

@@ -9,8 +9,8 @@ This sample project is set up as a simple blog, but of course you can do so much
 
 | `/_config.toml` | Your site configuration. |
 | `/css/styles.css.scss` | Your stylesheet. [Sass]-powered, of course! |
-| `/_layout.erb` | Your global site layout. |
-| `/posts/_layout.erb` | Your post-specific layout. |
+| `/_layout.slim` | Your global site layout. |
+| `/posts/_layout.slim` | Your post-specific layout. |
 
 #### Recommended Reading
 

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

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

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

@@ -1,3 +1,10 @@
+# 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

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

@@ -1,6 +1,15 @@
+# Returns all blog posts contained in this directory. We assume
+# that a blog post is any page object that has a date set.
+#
 def blog_posts
   siblings
-    .select { |p| p.data["date"] }
-    .sort_by { |p| p.data["date"] }
+    .select { |p| blog_post?(p) }
+    .sort_by(&:date)
     .reverse
 end
+
+# Checks if a specific node is a blog post.
+#
+def blog_post?(node)
+  node.page? && !node.date.nil?
+end

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

@@ -0,0 +1,6 @@
+h1 = config["site"]["title"]
+
+p This is my new website! <a href="/about.html">Find out more</a>.
+
+h3 Latest Posts:
+== render("/blog/_list")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutterby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Hendrik Mans
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-13 00:00:00.000000000 Z
+date: 2017-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: erubis-auto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +262,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -324,8 +366,9 @@ files:
 - lib/templates/new_project/.gitignore
 - lib/templates/new_project/Gemfile
 - lib/templates/new_project/README.md
+- lib/templates/new_project/bin/flutterby
 - lib/templates/new_project/site/_config.toml
-- lib/templates/new_project/site/_layout.erb
+- 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/2017-01-01-hello-world.html.md
@@ -334,7 +377,7 @@ files:
 - lib/templates/new_project/site/blog/_node.rb
 - lib/templates/new_project/site/blog/_view.rb
 - lib/templates/new_project/site/css/styles.css.scss
-- lib/templates/new_project/site/index.html.erb
+- lib/templates/new_project/site/index.html.slim
 - lib/templates/new_project/site/js/app.js
 homepage: https://github.com/hmans/flutterby
 licenses:
@@ -356,7 +399,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: There are many static site generators. This is mine.

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

@@ -1,23 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-    <title><%= config["site"]["title"] %></title>
-    <link rel="stylesheet" href="/css/styles.css">
-
-    <!-- highlight.js for syntax highlighting -->
-    <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.9.0/styles/default.min.css">
-    <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.9.0/highlight.min.js"></script>
-
-    <script src="/js/app.js"></script>
-  </head>
-  <body>
-    <div class="container">
-      <%= yield %>
-
-      <footer role="main">
-        <%= config["site"]["description"] %>
-      </footer>
-    </div>
-  </body>
-</html>

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

@@ -1,7 +0,0 @@
-<h1><%= config["site"]["title"] %></h1>
-
-<p>This is my new website! <a href="/about.html">Find out more</a>.</p>
-
-
-<h3>Latest Posts:</h3>
-<%= find("/blog/_list").render(layout: false) %>