flutterby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c89a1e82384086506d0ad586a5688fce69c4b231
-  data.tar.gz: bd637910c27f9d13559fecf13c6d36b6eac5508f
+  metadata.gz: 51679cec3fb95d5b0e6a2ee392373856eb160b3f
+  data.tar.gz: 17e5203af322a8bc0c9fbe9b435b25c7a27f9166
 SHA512:
-  metadata.gz: 045e624bfb0a5830ef2297b7cf2aad3c5717f404fc5271e6b75c825e78c204dd143fc67b58d0d26c6647ba39ca193258d350b4a71d32b60ea4bd355040b318f8
-  data.tar.gz: 4f067bd019669deaa791ff166f43c578158765b2a6ea6d709afcd4f578e3bdd2a128a7d5d49a3b22a42f18286557662dcddce7b282c4d4e4a52ec27aa5087df1
+  metadata.gz: dc7c1767f95d7a49e5fd2612a187e9e10d1976da0dfd6afad7172a79ac684d3f11e9ef8dffe078e4a4a538b9ff629fd0af45d1461dd45d7bf26d7dbaeccbbc82
+  data.tar.gz: 73b5970b058190ec21e67339d5134f00a795aa92e18d3a65fca87da627b1c9ae7dc2944045aa9e2c91cfe1de7cc243199b1c786bb55ad3481be33805f37b654d

data/CHANGES.md

@@ -0,0 +1,23 @@
+# Version History
+
+### 0.2.0 (in development)
+
+- **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.
+- **CHANGE:** Stop the [Slodown] library from picking up Coderay et al to perform server-side syntax highlighting. This will probably be made configurable at some point in the future. For the time being, it is recommended to perform syntax highlighting through client-side libraries like [highlight.js].
+- **NEW:** You can now pass options to rendered partials. For example, when you invoke `<%= render("_foo.html.erb", name: "bar") %>`, `_foo.html.erb` can use `opts[:name]`.
+- **NEW:** `flutterby serve` now properly catches and displays exceptions via the [better_errors](https://github.com/charliesome/better_errors) gem.
+- **NEW:** For filters not natively supported by Flutterby, it will now fall back to [Tilt]. This means you can just add any gem supported by Tilt to your project to use it as a template language, with no Flutterby-specific plugin required. Hooray!
+- **NEW:** the `flutterby` CLI now has a `version` command that will print the version of Flutterby you're using.
+
+
+### 0.1.0 (2017-01-11)
+
+- First release!
+
+
+
+
+[Tilt]: https://github.com/rtomayko/tilt
+[Slodown]: http://github.com/hmans/slodown
+[highlight.js]: https://highlightjs.org/

data/README.md

@@ -1,11 +1,11 @@
-[![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) ![Status](https://img.shields.io/badge/status-active-brightgreen.svg)
-
 # Flutterby
 
-#### A very good static site generator.
+### A very, very good static site generator.
+
+[![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,6 +13,10 @@
 - 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
+
+- [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)
 
 ## Installation & Basic Usage
 
@@ -20,20 +24,20 @@ Flutterby is distributed as a RubyGem, so let's install it first:
 
     gem install flutterby
 
-Now let's create a new project:
+This will install a `flutterby` executable on your system. Let's use it to create a new project:
 
     flutterby new mysite
     cd mysite
 
-Now let's generate that static site:
+The new project template serves as a simple starting point for new projects. Let's compile it into a static site:
 
     flutterby build
 
-Or run a local development server for faster development:
+Flutterby comes with a local development server that will automatically pick up changes you make to your files:
 
-    flutterby server
+    flutterby serve
 
-**Note**: by default, both the `build` and `server` commands assume `./site/` to be the source directory and `./_build/` to be the export directory. Please refer to `flutterby help` to see how you can override these.
+**Note**: by default, both the `build` and `serve` commands assume `./site/` to be the source directory and `./_build/` to be the export directory. Please refer to `flutterby help` to see how you can override these.
 
 
 ## Examples
@@ -46,7 +50,7 @@ Please refer to the [Sites built with Flutterby](https://github.com/hmans/flutte
 Flutterby is young, but already quite functional. Here's a list of changes I'm intending to make in the near future -- if you want to work on any of these, let me know!
 
 - Performance! Right now, the source file for every node is read into RAM as a whole. Not a big problem when you're building a small site, but add some larger images, and you'll have one.
-- Change `flutterby server` so it doesn't always regenerate the _entire_ site graph when a file is modified.
+- Change `flutterby serve` so it doesn't always regenerate the _entire_ site graph when a file is modified.
 - Extract filters (like Slim, Sass etc.) to separate gems, to make the core gem more light-weight.
 - Improve the template site (`flutterby new`).
 - Produce a fun screencast to explain what the heck is going on here!

data/flutterby.gemspec

@@ -14,6 +14,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/hmans/flutterby"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '~> 2.2'
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -32,13 +34,18 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json', '~> 2.0'
   spec.add_dependency 'thor', '~> 0.19'
   spec.add_dependency 'highline', '~> 1.7'
-  spec.add_dependency 'slodown', '~> 0.3'
-  spec.add_dependency 'builder', '~> 3.2'
-  spec.add_dependency 'sass', '~> 3.4'
-  spec.add_dependency 'tilt', '~> 2.0'
-  spec.add_dependency 'slim', '~> 3.0'
+  spec.add_dependency 'slodown', '~> 0.4'
   spec.add_dependency 'toml-rb', '~> 0.3'
   spec.add_dependency 'rack', '~> 2.0'
   spec.add_dependency 'listen', '~> 3.1'
   spec.add_dependency 'mime-types', '~> 3.1'
+  spec.add_dependency 'better_errors', '~> 2.1'
+
+  # We support some template engines out of the box.
+  # There's a chance these will be extracted/made optional
+  # at some point in the future.
+  spec.add_dependency 'sass', '~> 3.4'
+  spec.add_dependency 'builder', '~> 3.2'
+  spec.add_dependency 'slim', '~> 3.0'
+  spec.add_dependency 'tilt', '~> 2.0'
 end

data/lib/flutterby/cli.rb

@@ -13,6 +13,13 @@ module Flutterby
   class CLI < Thor
     include Thor::Actions
 
+    desc "version", "Displays Flutterby's version"
+    map "-v" => :version
+    map "--version" => :version
+    def version
+      say_hi
+    end
+
     desc "build", "Build your static site"
     option :in, default: "./site/", aliases: [:i]
     option :out, default: "./_build/", aliases: [:o]
@@ -23,6 +30,8 @@ module Flutterby
         " • #{msg}\n"
       end
 
+      say_hi
+
       time = Benchmark.realtime do
         # Import site
         say color("📚  Importing site...", :bold)
@@ -44,6 +53,8 @@ module Flutterby
     option :port, default: 4004, aliases: [:p], type: :numeric
 
     def serve
+      say_hi
+
       say color("📚  Importing site...", :bold)
       root = Flutterby::Node.new("/", fs_path: options.in)
       root.stage!
@@ -57,10 +68,12 @@ module Flutterby
 
     desc "new PATH", "Create a new Flutterby project"
     def new(path)
+      say_hi
+
       path = File.expand_path(path)
       self.destination_root = path
 
-      say color("🦋  Creating a new Flutterby project in #{path}...", :bold)
+      say color("🏗  Creating a new Flutterby project in #{path}...", :bold)
       directory("new_project", path)
       in_root { bundle_install }
     end
@@ -81,6 +94,10 @@ module Flutterby
       $terminal.color(*args)
     end
 
+    def say_hi
+      say color("🦋  Flutterby #{Flutterby::VERSION}", :bold, :blue)
+    end
+
     def self.source_root
       File.expand_path("../templates/", File.dirname(__FILE__))
     end

data/lib/flutterby/exporter.rb

@@ -14,7 +14,7 @@ module Flutterby
             FileUtils.mkdir_p(::File.dirname(path))
 
             # Write file
-            ::File.write(path, node.render)
+            ::File.write(path, node.render(layout: true))
             logger.info "Exported #{node.url}"
           end
         end

data/lib/flutterby/filters.rb

@@ -2,7 +2,7 @@ require 'sass'
 require 'tilt'
 require 'slim'
 require 'builder'
-require 'slodown'
+require 'flutterby/markdown_formatter'
 
 module Flutterby
   module Filters
@@ -15,6 +15,10 @@ module Flutterby
 
         if Filters.respond_to?(meth)
           Filters.send(meth, node)
+        elsif template = tilt(filter, node.body)
+          node.body = template.render(node.view)
+        else
+          Flutterby.logger.warn "Unsupported filter '#{filter}' for #{node.url}"
         end
       end
     end
@@ -26,7 +30,7 @@ module Flutterby
     end
 
     def self.tilt(format, body)
-      Tilt[format].new { body }
+      t = Tilt[format] and t.new { body }
     end
   end
 end
@@ -35,16 +39,8 @@ Flutterby::Filters.add("rb") do |node|
   node.instance_eval(node.body)
 end
 
-Flutterby::Filters.add("erb") do |node|
-  node.body = tilt("erb", node.body).render(node.view)
-end
-
-Flutterby::Filters.add("slim") do |node|
-  node.body = tilt("slim", node.body).render(node.view)
-end
-
 Flutterby::Filters.add(["md", "markdown"]) do |node|
-  node.body = Slodown::Formatter.new(node.body).complete.to_s
+  node.body = Flutterby::MarkdownFormatter.new(node.body).complete.to_s
 end
 
 Flutterby::Filters.add("scss") do |node|
@@ -59,9 +55,3 @@ Flutterby::Filters.add("scss") do |node|
 
   node.body = Sass::Engine.new(node.body, sass_options).render
 end
-
-Flutterby::Filters.add("builder") do |node|
-  xml = Builder::XmlMarkup.new
-  node.view.instance_eval(node.body)
-  node.body = xml.target!
-end

data/lib/flutterby/markdown_formatter.rb

@@ -0,0 +1,17 @@
+require 'slodown'
+
+module Flutterby
+  class MarkdownFormatter < Slodown::Formatter
+    def complete
+      markdown.autolink.sanitize
+    end
+
+    def kramdown_options
+      {
+        input: "GFM",
+        syntax_highlighter: nil,
+        syntax_highlighter_opts: { }
+      }
+    end
+  end
+end

data/lib/flutterby/node.rb

@@ -104,13 +104,11 @@ module Flutterby
       return self if path.nil? || path.empty?
 
       # remove duplicate slashes
-      path.gsub!(%r{//}, "/")
+      path.gsub!(%r{/+}, "/")
 
       case path
-      when %r{^\.\./?} then
-        parent ? parent.find($') : nil
-      when %r{^\.} then
-        self
+      when %r{^\./?} then
+        parent ? parent.find($') : root.find($')
       when %r{^/} then
         root.find($')
       when %r{^([^/]+)/?} then
@@ -247,7 +245,9 @@ module Flutterby
       @data
     end
 
-    def render(layout: true)
+    def render(opts = {})
+      layout = opts[:layout]
+      view.opts.merge!(opts)
       (layout && apply_layout?) ? apply_layout(body) : body
     end
 

data/lib/flutterby/server.rb

@@ -1,5 +1,6 @@
 require 'rack'
 require 'listen'
+require 'better_errors'
 
 module Flutterby
   class Server
@@ -20,6 +21,14 @@ module Flutterby
         @root.stage!
       end
 
+      # Set up Rack app
+      BetterErrors.application_root = __dir__
+      this = self
+      app = Rack::Builder.app do |app|
+        app.use BetterErrors::Middleware
+        app.run this
+      end
+
       # Set up server
       server = Rack::Handler::WEBrick
 
@@ -31,7 +40,7 @@ module Flutterby
 
       # Go!
       listener.start
-      server.run self, Port: @port, Logger: Flutterby.logger
+      server.run app, Port: @port, Logger: Flutterby.logger
     end
 
     def call(env)
@@ -45,7 +54,7 @@ module Flutterby
 
         # Build response
         res.headers["Content-Type"] = mime_type
-        res.body = [node.render]
+        res.body = [node.render(layout: true)]
       else
         res.status = 404
         res.headers["Content-Type"] = "text/html"

data/lib/flutterby/version.rb

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

data/lib/flutterby/view.rb

@@ -1,10 +1,11 @@
 module Flutterby
   class View
-    attr_reader :node
+    attr_reader :node, :opts
     alias_method :page, :node
 
     def initialize(node)
       @node = node
+      @opts = {}
     end
 
     def date_format(date, fmt)

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

@@ -4,6 +4,11 @@
     <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>

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

@@ -1,5 +1,22 @@
 ---
-title: Hello World!
+title: Welcome to Flutterby!
 ---
 
-This is your first blog post!
+
+**Congratulations!** You've just created a new Flutterby project through the magic of `flutterby new` -- now it's time to make it your own!
+
+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. |
+| `/css/styles.css.scss` | Your stylesheet. [Sass]-powered, of course! |
+| `/_layout.erb` | Your global site layout. |
+| `/posts/_layout.erb` | Your post-specific layout. |
+
+#### Recommended Reading
+
+- [Flutterby on Github](https://github.com/hmans/flutterby)
+
+
+
+
+[Sass]: http://sass-lang.com/

data/lib/templates/new_project/site/css/styles.css.scss

@@ -37,3 +37,27 @@ ul.post-list {
   list-style: none;
   padding-left: 0;
 }
+
+
+/* embedded code */
+code {
+  background-color: #e8e8e8;
+  font: 85% "Office Code Pro",Menlo,Consolas,Monaco,monotype;
+  padding: 2px 4px;
+  border-radius: 2px;
+}
+
+pre>code {
+  padding: 15px !important;
+}
+
+/* tables */
+table {
+}
+
+td {
+  vertical-align: top;
+}
+td+td {
+  padding-left: 10px;
+}

data/lib/templates/new_project/site/js/app.js

@@ -1 +1,3 @@
 /* insert your JavaScript here */
+
+hljs.initHighlightingOnLoad();

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutterby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hendrik Mans
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,6 +152,20 @@ dependencies:
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: slodown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: toml-rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -165,117 +179,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: sass
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: tilt
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: slim
+  name: better_errors
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: toml-rb
+  name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: slim
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.0'
 description: There are many static site generators. This is mine.
 email:
 - hendrik@mans.de
@@ -287,6 +301,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -301,6 +316,7 @@ files:
 - lib/flutterby/cli.rb
 - lib/flutterby/exporter.rb
 - lib/flutterby/filters.rb
+- lib/flutterby/markdown_formatter.rb
 - lib/flutterby/node.rb
 - lib/flutterby/server.rb
 - lib/flutterby/version.rb
@@ -330,9 +346,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="