flutterby 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bfb4189fdcf9b5640df468a2818ae3d2f647c71
-  data.tar.gz: adb8399cc0fe5f5c8ca452f8570c8b19fd74aacb
+  metadata.gz: 83e24d1e73103a5cef7b60efcf5a21951e474c66
+  data.tar.gz: f25f5763a2a10b7190e9ea5a827ef716bba729f7
 SHA512:
-  metadata.gz: fcdb6900c5bd5aee4c1425bb226b110a151413a27af13f368aa317326521c9a0afe0be656f48413aec7f9bad327642d3ff2c0360c37267b0a271fa83a7e78272
-  data.tar.gz: 832097dcf92dd891160a04a1d164a392efe316aa6a8d79f92e660b76232fab0bf18d9934ce1f6d09c85fa8edc5b2765ee61a28cb64bb6241d197731b565ff649
+  metadata.gz: fc8ecf0efc0a1615d0149b1a94b0eb3fef7cd27db54147de26238646313f2dc679b74335cc69671364f1d04f43c96d72112ff7b596a27c883256808449622aa4
+  data.tar.gz: d7ed0d77dde3726cc718c0420f1d1f3a5732c17a9906329d945b7eb607ccce3fa183659a7b92787edcb024bb39883f04cbcf6982a43675da21be31b576ba860d

data/CHANGES.md

@@ -1,5 +1,12 @@
 # Version History
 
+### 0.4.0 (2017-01-21)
+
+- **NEW:** Flutterby views now have a `tag` helper method available that can generate HTML tags programatically.
+- **NEW:** Flutterby views now have a `link_to` helper method available that renders link tags. You can use a URL string as the link target, eg. `link_to "Home", "/"`, or any Flutterby node, eg. `link_to "Blog", blog_node`.
+- **NEW:** Flutterby views now have a `debug` helper that will dump its argument's YAML representation into a `<pre>` HTML tag (similar to Rails.)
+
+
 ### 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.

data/README.md

@@ -1,6 +1,6 @@
 # Flutterby
 
-### A very, very good static site generator.
+### A flexible, Ruby-powered 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)
 
@@ -18,6 +18,9 @@
 - [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)
+- [Roadmap](https://github.com/hmans/flutterby/projects/1)
+- [Sites built with Flutterby](https://github.com/hmans/flutterby/wiki/Sites-built-with-Flutterby) (add yours!)
+
 
 ## Installation & Basic Usage
 
@@ -41,22 +44,6 @@ Flutterby comes with a local development server that will automatically pick up
 **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
-
-Please refer to the [Sites built with Flutterby](https://github.com/hmans/flutterby/wiki/Sites-built-with-Flutterby) page on the Flutterby Wiki for some examples.
-
-
-## Roadmap
-
-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 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!
-- Write even more tests!
-
 
 ## Notes
 

data/lib/flutterby/cli.rb

@@ -60,7 +60,7 @@ module Flutterby
       root.stage!
       say color("🌲  Read #{root.tree_size} nodes.", :green, :bold)
 
-      say color("🌤  Serving your site on port #{options.port}. Enjoy!", :bold)
+      say color("🌤  Serving your Flutterby site on http://localhost:#{options.port} - enjoy! \\o/", :bold)
       server = Flutterby::Server.new(root, port: options.port)
       server.run!
     end
@@ -75,6 +75,7 @@ module Flutterby
 
       say color("🏗  Creating a new Flutterby project in #{path}...", :bold)
       directory("new_project", path)
+      chmod("bin/flutterby", 0755)
       in_root { bundle_install }
     end
 

data/lib/flutterby/node.rb

@@ -2,7 +2,8 @@ require 'benchmark'
 
 module Flutterby
   class Node
-    attr_accessor :name, :ext, :source, :body
+    attr_accessor :name, :ext, :source
+    attr_writer :body
     attr_reader :filters, :parent, :fs_path, :children, :paths
 
     def initialize(name, parent: nil, fs_path: nil, source: nil)
@@ -23,287 +24,278 @@ module Flutterby
       reload!
     end
 
-    #
-    # Children
-    #
-
-    def register_url!
-      if file? && should_publish?
-        root.paths[url] = self
+    concerning :Children do
+      def register_url!
+        if file? && should_publish?
+          root.paths[url] = self
+        end
       end
-    end
 
-    def find_child(name)
-      if name.include?(".")
-        @children.find { |c| c.full_name == name }
-      else
-        @children.find { |c| c.name == name }
-      end
-    end
-
-    def tree_size
-      children.inject(children.length) do |count, child|
-        count + child.tree_size
+      def find_child(name)
+        if name.include?(".")
+          @children.find { |c| c.full_name == name }
+        else
+          @children.find { |c| c.name == name }
+        end
       end
-    end
 
-    def parent=(new_parent)
-      if @parent
-        @parent.children.delete(self)
+      def tree_size
+        children.inject(children.length) do |count, child|
+          count + child.tree_size
+        end
       end
 
-      @parent = new_parent
-
-      @parent.children << self
-    end
-
-    # Returns all children that will compile to a HTML page.
-    #
-    def pages
-      children.select { |c| c.ext == "html" && c.should_publish? }
-    end
-
-    #
-    # Path Algebra
-    #
-
-    def path
-      parent ? ::File.join(parent.path, full_name) : full_name
-    end
-
-    def url
-      ::File.join(parent ? parent.url : "/", full_name)
-    end
-
-    def full_fs_path(base:)
-      ::File.expand_path(::File.join(base, full_name))
-    end
+      def parent=(new_parent)
+        if @parent
+          @parent.children.delete(self)
+        end
 
+        @parent = new_parent
 
-    #
-    # Tree Walking
-    #
+        @parent.children << self
+      end
 
-    def root
-      parent ? parent.root : self
+      # Returns all children that will compile to a HTML page.
+      #
+      def pages
+        children.select { |c| c.ext == "html" && c.should_publish? }
+      end
     end
 
-    def root?
-      root == self
-    end
+    concerning :Paths do
+      def path
+        parent ? ::File.join(parent.path, full_name) : full_name
+      end
 
-    def sibling(name)
-      parent && parent.find(name)
-    end
+      def url
+        ::File.join(parent ? parent.url : "/", full_name)
+      end
 
-    def siblings
-      parent && parent.children
+      def full_fs_path(base:)
+        ::File.expand_path(::File.join(base, full_name))
+      end
     end
 
-    def find(path)
-      return self if path.nil? || path.empty?
-
-      # remove duplicate slashes
-      path.gsub!(%r{/+}, "/")
 
-      case path
-      when %r{^\./?} then
-        parent ? parent.find($') : root.find($')
-      when %r{^/} then
-        root.find($')
-      when %r{^([^/]+)/?} then
-        child = find_child($1)
-        $'.empty? ? child : child.find($')
+    concerning :Tree do
+      def root
+        parent ? parent.root : self
       end
-    end
 
-    # Walk the tree up, invoking the passed block for every node
-    # found on the way, passing the node as its only argument.
-    #
-    def walk_up(val = nil, &blk)
-      val = blk.call(self, val)
-      parent ? parent.walk_up(val, &blk) : val
-    end
+      def root?
+        root == self
+      end
 
-    # Walk the graph from the root to this node. Just like walk_up,
-    # except the block will be called on higher level nodes first.
-    #
-    def walk_down(val = nil, &blk)
-      val = parent ? parent.walk_up(val, &blk) : val
-      blk.call(self, val)
-    end
+      def sibling(name)
+        parent && parent.find(name)
+      end
 
-    # Walk the entire tree, top to bottom.
-    #
-    def walk_tree(val = nil, &blk)
-      val = blk.call(self, val)
-      children.each do |child|
-        val = child.walk_tree(val, &blk)
+      def siblings
+        parent && parent.children
       end
 
-      val
-    end
+      def find(path)
+        return self if path.nil? || path.empty?
 
-    #
-    # Reading from filesystem
-    #
+        # remove duplicate slashes
+        path.gsub!(%r{/+}, "/")
 
-    def reload!
-      @body     = nil
-      @data     = nil
-      @children = []
-      @paths    = {}
+        case path
+        when %r{^\./?} then
+          parent ? parent.find($') : root.find($')
+        when %r{^/} then
+          root.find($')
+        when %r{^([^/]+)/?} then
+          child = find_child($1)
+          $'.empty? ? child : child.find($')
+        end
+      end
 
-      load_from_filesystem! if @fs_path
-    end
+      # Walk the tree up, invoking the passed block for every node
+      # found on the way, passing the node as its only argument.
+      #
+      def walk_up(val = nil, &blk)
+        val = blk.call(self, val)
+        parent ? parent.walk_up(val, &blk) : val
+      end
 
-    def stage!
-      # First of all, we want to make sure all nodes have their
-      # available extensions loaded.
+      # Walk the graph from the root to this node. Just like walk_up,
+      # except the block will be called on higher level nodes first.
       #
-      walk_tree do |node|
-        node.load_extension! unless node.name == "_node"
+      def walk_down(val = nil, &blk)
+        val = parent ? parent.walk_up(val, &blk) : val
+        blk.call(self, val)
       end
 
-      # Now do another pass, prerendering stuff where necessary,
-      # extracting data, registering URLs to be exported, etc.
+      # Walk the entire tree, top to bottom.
       #
-      walk_tree do |node|
-        node.render_body! if node.should_prerender?
-        node.register_url! if node.should_publish?
+      def walk_tree(val = nil, &blk)
+        val = blk.call(self, val)
+        children.each do |child|
+          val = child.walk_tree(val, &blk)
+        end
+
+        val
       end
     end
 
-    def should_prerender?
-      !folder? &&
-        (["json", "yml", "yaml", "rb", "toml"] & filters).any?
-    end
+    concerning :Reading do
+      def reload!
+        @body     = nil
+        @data     = nil
+        @children = []
+        @paths    = {}
 
-    def load_from_filesystem!
-      if @fs_path
-        if ::File.directory?(fs_path)
-          Dir[::File.join(fs_path, "*")].each do |entry|
-            name = ::File.basename(entry)
-            Flutterby::Node.new(name, parent: self, fs_path: entry)
+        load_from_filesystem! if @fs_path
+      end
+
+      def load_from_filesystem!
+        if @fs_path
+          if ::File.directory?(fs_path)
+            Dir[::File.join(fs_path, "*")].each do |entry|
+              name = ::File.basename(entry)
+              Flutterby::Node.new(name, parent: self, fs_path: entry)
+            end
+          else
+            @source = ::File.read(fs_path)
           end
-        else
-          @source = ::File.read(fs_path)
         end
       end
     end
 
-    def extract_data!
-      @data ||= {}
-
-      # Extract date from name
-      if name =~ %r{^(\d\d\d\d\-\d\d?\-\d\d?)\-}
-        @data['date'] = Date.parse($1)
+    concerning :Data do
+      def data
+        extract_data! if @data.nil?
+        @data
       end
 
-      # Read remaining data from frontmatter. Data in frontmatter
-      # will always have precedence!
-      parse_frontmatter!
+      def extract_data!
+        @data ||= {}
 
-      # Do some extra processing depending on extension
-      meth = "read_#{ext}!"
-      send(meth) if respond_to?(meth)
-    end
+        # Extract date from name
+        if name =~ %r{^(\d\d\d\d\-\d\d?\-\d\d?)\-}
+          @data['date'] = Date.parse($1)
+        end
 
-    def load_extension!
-      if extension = sibling("_node.rb")
-        instance_eval(extension.body)
+        # 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
-    end
 
-    #
-    # Rendering
-    #
+      def parse_frontmatter!
+        @data || {}
 
-    def view
-      @view ||= View.for(self)
-    end
+        if @source
+          # YAML Front Matter
+          if @source.sub!(/\A\-\-\-\n(.+)\n\-\-\-\n/m, "")
+            @data.merge! YAML.load($1)
+          end
 
-    def render_body!
-      time = Benchmark.realtime do
-        Filters.apply!(self)
+          # TOML Front Matter
+          if @source.sub!(/\A\+\+\+\n(.+)\n\+\+\+\n/m, "")
+            @data.merge! TOML.parse($1)
+          end
+        end
       end
 
-      logger.info "Rendered #{url} in #{sprintf "%.1f", time * 1000}ms"
-    end
+      def read_json!
+        @data.merge!(JSON.parse(body))
+      end
 
-    def body
-      if @body.nil?
-        data   # make sure data is lazy-loaded
-        render_body!
+      def read_yaml!
+        @data.merge!(YAML.load(body))
       end
 
-      @body
-    end
+      def read_yml!
+        read_yaml!
+      end
 
-    def data
-      extract_data! if @data.nil?
-      @data
+      def read_toml!
+        @data.merge!(TOML.parse(body))
+      end
     end
 
-    def render(opts = {})
-      layout = opts[:layout]
-      view.opts.merge!(opts)
-      (layout && apply_layout?) ? apply_layout(body) : body
-    end
+    concerning :Staging do
+      def stage!
+        # First of all, we want to make sure all nodes have their
+        # available extensions loaded.
+        #
+        walk_tree do |node|
+          node.load_extension! unless node.name == "_node"
+        end
 
-    def apply_layout(input)
-      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
+        # 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.register_url! if node.should_publish?
         end
       end
-    end
 
-    def apply_layout?
-      page?
-    end
+      def load_extension!
+        if extension = sibling("_node.rb")
+          instance_eval(extension.body)
+        end
+      end
 
+      def should_prerender?
+        !folder? &&
+          (["json", "yml", "yaml", "rb", "toml"] & filters).any?
+      end
+    end
 
 
+    concerning :Rendering do
+      def view
+        @view ||= View.for(self)
+      end
 
-    #
-    # Front Matter Parsing
-    #
+      def render_body!
+        time = Benchmark.realtime do
+          Filters.apply!(self)
+        end
 
-    def parse_frontmatter!
-      @data || {}
+        logger.info "Rendered #{url} in #{sprintf "%.1f", time * 1000}ms"
+      end
 
-      if @source
-        # YAML Front Matter
-        if @source.sub!(/\A\-\-\-\n(.+)\n\-\-\-\n/m, "")
-          @data.merge! YAML.load($1)
+      def body
+        if @body.nil?
+          data   # make sure data is lazy-loaded
+          render_body!
         end
 
-        # TOML Front Matter
-        if @source.sub!(/\A\+\+\+\n(.+)\n\+\+\+\n/m, "")
-          @data.merge! TOML.parse($1)
+        @body
+      end
+
+      def render(opts = {})
+        layout = opts[:layout]
+        view.opts.merge!(opts)
+        (layout && apply_layout?) ? apply_layout(body) : body
+      end
+
+      def apply_layout(input)
+        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
         end
       end
-    end
 
-    def read_json!
-      @data.merge!(JSON.parse(body))
+      def apply_layout?
+        page?
+      end
     end
 
-    def read_yaml!
-      @data.merge!(YAML.load(body))
-    end
 
-    def read_yml!
-      read_yaml!
-    end
 
-    def read_toml!
-      @data.merge!(TOML.parse(body))
-    end
 
 
     #

data/lib/flutterby/version.rb

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

data/lib/flutterby/view.rb

@@ -35,6 +35,32 @@ module Flutterby
       node.siblings(*args)
     end
 
+    def tag(name, attributes)
+      ActiveSupport::SafeBuffer.new.tap do |output|
+        attributes_str = attributes.keys.sort.map do |k|
+          %{#{h k}="#{h attributes[k]}"}
+        end.join(" ")
+
+        opening_tag = "#{h name.downcase} #{attributes_str}".strip
+        output << "<#{opening_tag}>".html_safe
+        output << yield if block_given?
+        output << "</#{h name}>".html_safe
+      end
+    end
+
+    def link_to(text, target, attrs = {})
+      href = case target
+      when Flutterby::Node then target.url
+      else target.to_s
+      end
+
+      tag(:a, attrs.merge(href: href)) { text }
+    end
+
+    def debug(obj)
+      tag(:pre, class: "debug") { h obj.to_yaml }
+    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.

data/lib/templates/new_project/{Gemfile → Gemfile.tt}

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 source "https://rubygems.org"
 
-gem "flutterby", "~> 0.3.0"
+gem "flutterby", "~> <%= Flutterby::VERSION %>"

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

@@ -17,4 +17,4 @@ html
       = yield
       
       footer role="main"
-        = config["site"]["description"]
+        == config["site"]["description"]

data/lib/templates/new_project/site/blog/_list.html.slim

@@ -2,5 +2,4 @@ ul.post-list
   - for post in blog_posts
     li
       .post-meta = date_format post.date, "%B %e, %Y"
-
-      a href=post.url = post.title
+      = link_to post.title, post

data/lib/templates/new_project/site/blog/{2017-01-01-hello-world.html.md → hello-world.html.md.tt}

@@ -1,5 +1,6 @@
 ---
 title: Welcome to Flutterby!
+date: <%= Date.today.to_s %>
 ---
 
 

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutterby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Hendrik Mans
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-15 00:00:00.000000000 Z
+date: 2017-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -364,18 +364,18 @@ files:
 - lib/flutterby/version.rb
 - lib/flutterby/view.rb
 - lib/templates/new_project/.gitignore
-- lib/templates/new_project/Gemfile
+- lib/templates/new_project/Gemfile.tt
 - 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.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
 - lib/templates/new_project/site/blog/_layout.slim
 - lib/templates/new_project/site/blog/_list.html.slim
 - lib/templates/new_project/site/blog/_node.rb
 - lib/templates/new_project/site/blog/_view.rb
+- lib/templates/new_project/site/blog/hello-world.html.md.tt
 - lib/templates/new_project/site/css/styles.css.scss
 - lib/templates/new_project/site/index.html.slim
 - lib/templates/new_project/site/js/app.js