serif 0.2 → 0.2.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    serif (0.1.6)
+    serif (0.2.1)
       liquid (~> 2.4)
       pygments.rb (~> 0.3)
       rack (~> 1.0)
@@ -18,13 +18,13 @@ GEM
     liquid (2.4.1)
     multi_json (1.5.0)
     posix-spawn (0.3.6)
-    pygments.rb (0.3.3)
+    pygments.rb (0.3.7)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.1.0)
-    rack (1.4.1)
+    rack (1.4.4)
     rack-protection (1.3.2)
       rack
-    rack-rewrite (1.3.2)
+    rack-rewrite (1.3.3)
     rake (0.9.2.2)
     redcarpet (2.2.2)
     redhead (0.0.8)
@@ -44,7 +44,7 @@ GEM
       rack (~> 1.3, >= 1.3.6)
       rack-protection (~> 1.2)
       tilt (~> 1.3, >= 1.3.3)
-    slop (3.3.3)
+    slop (3.4.3)
     tilt (1.3.3)
     timecop (0.5.5)
     yajl-ruby (1.1.0)

data/README.md

@@ -4,6 +4,23 @@
 
 Serif is a file-based blogging engine intended for simple sites. It compiles Markdown content to static files, and there is a web interface for editing and publishing ([simple video demo](https://docs.google.com/open?id=0BxPQpxGSOOyKS1J4MmlnM3JIaXM)), because managing everything with `ssh` and `git` can be a pain, compared to having a more universally accessible editing interface.
 
+# Changes and what's new
+
+See `CHANGELOG` for what's new.
+
+# Contents of this README
+
+* [Intro](#intro)
+* [License and contributing](#license-and-contributing)
+* [Basic usage](#basics)
+* [Content and site structure](#content-and-site-structure)
+* [Publishing drafts](#publishing-drafts)
+* [Archive pages](#archive-pages)
+* [Configuration](#configuration)
+* [Deploying](#deploying)
+* [Customising the admin interface](#customising-the-admin-interface)
+* [Custom tags](#custom-tags)
+
 # Intro
 
 Serif is a lot like Jekyll with a few extra moving parts, although it didn't start that way. It went through two reworkings before being converted into something based on generated Markdown files. The aim for Serif is to provide two things:
@@ -11,7 +28,7 @@ Serif is a lot like Jekyll with a few extra moving parts, although it didn't sta
 1. Simplicity: the source and generated content are just files that can be served by any web server.
 2. Ease of publishing, wherever you are: having everything based on files that you edit in a text editor is a nice idea, but what if you're on a machine that doesn't give you ssh access to your server? What if you need to edit creation timestamps? What about editing drafts without having to make commits and push to git repos?
 
-With this in mind, you might think of Serif's aim as to merge Jekyll, [Second Crack](https://github.com/marcoarment/secondcrack) and ideas from [Svbtle](http://dcurt.is/codename-svbtle). There should be many ways of editing and publishing, such as using the web interface, `rsync`ing from a remote machine, or editing a draft file on the remote server and having everything happen for you. (This last feature doesn't quite exist as planned yet.)
+With this in mind, you might think of Serif's aim as to merge Jekyll, [Second Crack](https://github.com/marcoarment/secondcrack) and ideas from [Svbtle](http://dcurt.is/codename-svbtle). There should be many ways of editing and publishing, such as using the web interface, `rsync`ing from a remote machine, or editing a draft file on the remote server and having everything happen for you.
 
 ## Planned features
 
@@ -37,6 +54,23 @@ The quickest way to get changes contributed:
 
 # Basics
 
+## First time use
+
+To get started with Serif based on a site skeleton:
+
+```bash
+gem install serif     # install serif
+cd path/to/some/place # go to where you'll be creating your site directory
+serif new             # create an initial site skeleton
+
+# ... edit your files how you want them ...
+
+serif generate        # generate the site based on the source files
+serif dev             # serve up the site for local testing purposes
+```
+
+Now visit <http://localhost:8000/> to view the site.
+
 ## Installing
 
 Installation is via [RubyGems](https://rubygems.org/). If you don't have Ruby installed, I recommend using [RVM](https://rvm.io/).
@@ -302,6 +336,10 @@ location @not_found_page {
 }
 ```
 
+## Generating the site
+
+Use `ENV=production serif generate` to regenerate the site for production.
+
 ## Admin interface
 
 The admin server can be started on the live server the same way it's started locally (with `ENV=production`). To access it from anywhere on the web, you will need to proxy/forward `/admin` HTTP requests to port 4567 to let the admin web server handle it. As an alternative, you could forward a local port with SSH --- you might use this if you didn't want to rely on just HTTP basic auth, which isn't very secure over non-HTTPS connections.
@@ -318,3 +356,21 @@ The admin interface is intended to be a minimal place to focus on writing conten
 
 /* more customisation below */
 ```
+
+# Custom tags
+
+These tags can be used in templates. For example:
+
+```
+{% file_digest foo.css prefix:- %}
+```
+
+## List of tags
+
+* `file_digest <path> [prefix:<prefix>]`
+  
+  (Note: For this tag to return anything, `ENV=production` must be set as an environment variable.)
+  
+  Computes a hex digest of the contents of `<path>`, optionally prefixed with `<prefix>`. `<path>` is delimited by whitespace.
+
+  Useful for URL fingerprinting for long-lived caching.

data/lib/serif/site.rb

@@ -37,9 +37,51 @@ module Filters
     input.xmlschema
   end
 end
+
+class FileDigest < Liquid::Tag
+  DIGEST_CACHE = {}
+
+  # file_digest "file.css" [prefix:.]
+  Syntax = /^\s*(\S+)\s*(?:(prefix\s*:\s*\S+)\s*)?/
+
+  def initialize(tag_name, markup, tokens)
+    super
+
+    if markup =~ Syntax
+      @path = $1
+
+      if $2
+        @prefix = $2.gsub(/\s*prefix\s*:\s*/, "")
+      else
+        @prefix = ""
+      end
+    else
+      raise SyntaxError.new("Syntax error for file_digest")
+    end
+  end
+
+  # Takes the given path and returns the MD5
+  # hex digest of the file's contents.
+  #
+  # The path argument is first stripped, and any leading
+  # "/" has no effect.
+  def render(context)
+    return "" unless ENV["ENV"] == "production"
+
+    full_path = File.join(context["site"]["directory"], @path.strip)
+    
+    return @prefix + DIGEST_CACHE[full_path] if DIGEST_CACHE[full_path]
+
+    digest = Digest::MD5.hexdigest(File.read(full_path))
+    DIGEST_CACHE[full_path] = digest
+
+    @prefix + digest
+  end
+end
 end
 
 Liquid::Template.register_filter(Serif::Filters)
+Liquid::Template.register_tag("file_digest", Serif::FileDigest)
 
 module Serif
 class Site
@@ -169,7 +211,8 @@ class Site
     {
       "posts" => posts,
       "latest_update_time" => latest_update_time,
-      "archive" => self.class.stringify_keys(archives)
+      "archive" => self.class.stringify_keys(archives),
+      "directory" => directory
     }
   end
 
@@ -219,7 +262,7 @@ class Site
           else
             layout_file = File.join(self.directory, "_layouts", "#{layout_option}.html")
             layout = Liquid::Template.parse(File.read(layout_file))
-            f.puts layout.render!("page" => { "title" => [title].compact }, "content" => Liquid::Template.parse(file.to_s).render!("site" => self))
+            f.puts layout.render!("site" => self, "page" => { "title" => [title].compact }, "content" => Liquid::Template.parse(file.to_s).render!("site" => self))
           end
         end
       end
@@ -231,7 +274,7 @@ class Site
       FileUtils.mkdir_p(tmp_path(File.dirname(post.url)))
 
       File.open(tmp_path(post.url + ".html"), "w") do |f|
-        f.puts default_layout.render!("page" => { "title" => ["Posts", "#{post.title}"] }, "content" => Liquid::Template.parse(File.read("_templates/post.html")).render!("post" => post))
+        f.puts default_layout.render!("site" => self, "page" => { "title" => ["Posts", "#{post.title}"] }, "content" => Liquid::Template.parse(File.read("_templates/post.html")).render!("post" => post))
       end
     end
 

data/serif.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name         = "serif"
-  s.version      = "0.2"
+  s.version      = "0.2.1"
   s.authors      = ["Adam Prescott"]
   s.email        = ["adam@aprescott.com"]
   s.homepage     = "https://github.com/aprescott/serif"

data/test/file_digest_tag_spec.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+
+describe Serif::FileDigest do
+  def file_digest(markup)
+    Serif::FileDigest.new("file_digest", markup, "no tokens needed")
+  end
+
+  before :each do
+    site = Serif::Site.new(testing_dir)
+    @context = { "site" => { "directory" => site.directory }}
+  end
+
+  describe "#render" do
+    it "returns the md5 hex digest of the finally deployed site path" do
+      file_digest("test-stylesheet.css").render(@context).should == "f8390232f0c354a871f9ba0ed306163c"
+    end
+
+    it "ignores leading slashes" do
+      file_digest("/test-stylesheet.css").render(@context).should == "f8390232f0c354a871f9ba0ed306163c"
+    end
+
+    it "ignores surrounding whitespace" do
+      file_digest("             test-stylesheet.css      ").render(@context).should == "f8390232f0c354a871f9ba0ed306163c"
+    end
+
+    it "includes a prefix if one is specified" do
+      file_digest("test-stylesheet.css prefix:.").render(@context).should == ".f8390232f0c354a871f9ba0ed306163c"
+    end
+
+    it "ignores trailing whitespace on the prefix" do
+      file_digest("test-stylesheet.css prefix:. ").render(@context).should == ".f8390232f0c354a871f9ba0ed306163c"
+    end
+  end
+end

data/test/filters_spec.rb

@@ -44,7 +44,7 @@ describe Serif::Filters do
       end
     end
   end
-
+  
   describe "#xmlschema" do
     it "calls xmlschema on its input" do
       d = double("")

data/test/site_dir/_trash/{1357137277-autopublish-draft → 1359583798-autopublish-draft}

@@ -1,4 +1,4 @@
 title: Some draft title
-Created: 2013-01-02T14:34:37+00:00
+Created: 2013-01-30T22:09:58+00:00
 
 some content

data/test/site_dir/file-digest-test.html

@@ -0,0 +1,4 @@
+layout: none
+
+{% file_digest test-stylesheet.css %}
+{% file_digest test-stylesheet.css prefix:. %}

data/test/site_dir/test-stylesheet.css

@@ -0,0 +1,3 @@
+#foo {
+	bar: baz;
+}

data/test/site_generation_spec.rb

@@ -23,6 +23,12 @@ describe Serif::Site do
       File.read("_site/page-alt-layout.html").lines.first.should =~ /<h1.+?>Alternate layout<\/h1>/
     end
 
+    it "correctly handles file_digest calls" do
+      subject.generate
+
+      File.read("_site/file-digest-test.html").strip.should == "f8390232f0c354a871f9ba0ed306163c\n.f8390232f0c354a871f9ba0ed306163c"
+    end
+
     context "for drafts with a publish: now header" do
       before :all do
         @time = Time.utc(2012, 12, 21, 15, 30, 00)

data/test/test_helper.rb

@@ -3,6 +3,9 @@ SimpleCov.start do
   add_filter "/test/"
 end
 
+# run tests in production mode so that file digests are enabled
+ENV["ENV"] = "production"
+
 require "serif"
 require "fileutils"
 require "pathname"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serif
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -212,62 +212,65 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/serif.rb
-- lib/serif/post.rb
-- lib/serif/admin_server.rb
+- lib/serif/content_file.rb
 - lib/serif/server.rb
+- lib/serif/markup_renderer.rb
+- lib/serif/post.rb
 - lib/serif/config.rb
+- lib/serif/admin_server.rb
 - lib/serif/draft.rb
-- lib/serif/markup_renderer.rb
 - lib/serif/site.rb
-- lib/serif/content_file.rb
+- lib/serif.rb
+- statics/templates/admin/new_draft.liquid
+- statics/templates/admin/edit_draft.liquid
+- statics/templates/admin/layout.liquid
+- statics/templates/admin/index.liquid
+- statics/templates/admin/edit_post.liquid
 - statics/skeleton/index.html
-- statics/skeleton/_templates/post.html
 - statics/skeleton/_templates/archive_page.html
+- statics/skeleton/_templates/post.html
+- statics/skeleton/_drafts/sample-draft
 - statics/skeleton/_config.yml
-- statics/skeleton/_layouts/default.html
 - statics/skeleton/_posts/2012-01-05-sample-post
-- statics/skeleton/_drafts/sample-draft
+- statics/skeleton/_layouts/default.html
 - statics/skeleton/archive.html
-- statics/templates/admin/new_draft.liquid
-- statics/templates/admin/edit_draft.liquid
-- statics/templates/admin/layout.liquid
-- statics/templates/admin/edit_post.liquid
-- statics/templates/admin/index.liquid
 - statics/assets/js/mousetrap.min.js
 - statics/assets/js/jquery.autosize.js
 - bin/serif
 - test/test_helper.rb
-- test/post_spec.rb
+- test/filters_spec.rb
+- test/config_spec.rb
+- test/liquid_filter_date_extension_spec.rb
 - test/site_spec.rb
 - test/draft_spec.rb
-- test/config_spec.rb
+- test/markup_renderer_spec.rb
 - test/site_dir/index.html
-- test/site_dir/_templates/post.html
 - test/site_dir/_templates/archive_page.html
-- test/site_dir/_config.yml
-- test/site_dir/_layouts/default.html
-- test/site_dir/_layouts/alt-layout.html
-- test/site_dir/_posts/2012-01-05-sample-post
-- test/site_dir/page-alt-layout.html
+- test/site_dir/_templates/post.html
 - test/site_dir/_drafts/another-sample-draft
 - test/site_dir/_drafts/sample-draft
-- test/site_dir/_site/test-blog/sample-post.html
-- test/site_dir/_site/test-blog/post-to-be-published-on-generate.html
+- test/site_dir/file-digest-test.html
+- test/site_dir/page-alt-layout.html
+- test/site_dir/page-header-but-no-layout.html
+- test/site_dir/test-stylesheet.css
+- test/site_dir/_config.yml
+- test/site_dir/_site/test-archive/2012/12/index.html
+- test/site_dir/_site/test-archive/2012/11/index.html
 - test/site_dir/_site/index.html
 - test/site_dir/_site/page-alt-layout.html
-- test/site_dir/_site/test-archive/2012/11/index.html
-- test/site_dir/_site/test-archive/2012/12/index.html
 - test/site_dir/_site/page-header-but-no-layout.html
+- test/site_dir/_site/test-blog/post-to-be-published-on-generate.html
+- test/site_dir/_site/test-blog/sample-post.html
 - test/site_dir/_site/archive.html
-- test/site_dir/_trash/1357137277-autopublish-draft
-- test/site_dir/_trash/1357137277-test-draft
-- test/site_dir/page-header-but-no-layout.html
+- test/site_dir/_trash/1359583798-test-draft
+- test/site_dir/_trash/1359583798-autopublish-draft
+- test/site_dir/_posts/2012-01-05-sample-post
+- test/site_dir/_layouts/alt-layout.html
+- test/site_dir/_layouts/default.html
 - test/site_dir/archive.html
-- test/markup_renderer_spec.rb
-- test/liquid_filter_date_extension_spec.rb
+- test/file_digest_tag_spec.rb
 - test/site_generation_spec.rb
-- test/filters_spec.rb
+- test/post_spec.rb
 - serif.gemspec
 - rakefile
 - LICENSE
@@ -300,11 +303,12 @@ specification_version: 3
 summary: Simple file-based blogging system.
 test_files:
 - test/test_helper.rb
-- test/post_spec.rb
+- test/filters_spec.rb
+- test/config_spec.rb
+- test/liquid_filter_date_extension_spec.rb
 - test/site_spec.rb
 - test/draft_spec.rb
-- test/config_spec.rb
 - test/markup_renderer_spec.rb
-- test/liquid_filter_date_extension_spec.rb
+- test/file_digest_tag_spec.rb
 - test/site_generation_spec.rb
-- test/filters_spec.rb
+- test/post_spec.rb