serif 0.2.3 → 0.3

data/Gemfile.lock

@@ -10,6 +10,7 @@ PATH
       redhead (~> 0.0.8)
       sinatra (~> 1.3)
       slop (~> 3.3)
+      timeout_cache
 
 GEM
   remote: http://rubygems.org/
@@ -47,6 +48,7 @@ GEM
     slop (3.4.3)
     tilt (1.3.3)
     timecop (0.5.9.2)
+    timeout_cache (0.0.2)
     yajl-ruby (1.1.0)
 
 PLATFORMS

data/README.md

@@ -6,7 +6,16 @@ Serif is a file-based blogging engine intended for simple sites. It compiles Mar
 
 # Changes and what's new
 
-## Latest release
+## Latest release (v0.3)
+
+* Add some caching to improve performance of post generation. (#29)
+* Remove super-linear performance cost of file_digest, reducing site generation time by > 85% for 50+ posts. (#30 -- charts available in the issue)
+* Make `site` available to both preview templates and archive templates. (c3e2f28)
+* Intelligently add blank lines before the markdown image text strings. (#27)
+* Add a `smarty` filter to do smarty processing without full Markdown. (#28)
+* Fix broken URL renames for drafts in the admin interface. (#31)
+
+## v0.2.3
 
 * Support drag-and-drop image uploading in the admin interface, with customisable paths. (#18)
 * Generate private preview files for drafts, and generate the site on every draft change. (#19, #24)
@@ -29,6 +38,7 @@ See `CHANGELOG` for more.
 * [Customising the admin interface](#customising-the-admin-interface)
 * [Custom tags](#custom-tags)
 * [Template variables](#template-variables)
+* [Developing Serif](#developing-serif)
 
 # Intro
 
@@ -61,6 +71,8 @@ The quickest way to get changes contributed:
 3. Check out a branch on the latest master for your change: `git checkout -b master new-feature` --- do not make changes on `master`! Make sure that anything added or changed has a test in the `test/` directory. Use the existing files as examples. All tests for new/changed behaviour should pass.
 4. [Send a pull request on GitHub](https://help.github.com/articles/fork-a-repo), including a description of what you've changed. (Note: your contribution will be assumed to be under the same terms of the project by default.)
 
+For more info on development, see the section at the bottom of this README.
+
 # Basics
 
 ## First time use
@@ -218,7 +230,7 @@ admin:
   username: username
   password: password
 permalink: /blog/:year/:month/:title
-images_upload_path: /images/:timestamp_:name
+image_upload_path: /images/:timestamp_:name
 ```
 
 If a permalink setting is not given in the configuration, the default is `/:title`. There are the following options available for permalinks:
@@ -232,7 +244,7 @@ Placeholder | Value
 
 ### Admin drag-and-drop upload path
 
-The `images_upload_path` configuration setting is an _absolute path_ and will be relative to the base directory of your site, used in the admin interface to control where files are sent. The default value is `/images/:timestamp_:name`. Similar to permalinks, the following placeholders are available:
+The `image_upload_path` configuration setting is an _absolute path_ and will be relative to the base directory of your site, used in the admin interface to control where files are sent. The default value is `/images/:timestamp_:name`. Similar to permalinks, the following placeholders are available:
 
 Placeholder | Value
 ----------- |:-----
@@ -243,13 +255,13 @@ Placeholder | Value
 `:name`     | Original filename string of the image being uploaded
 `:timestamp`| Unix timestamp, e.g., "1361057832685"
 
-Any slashes in `images_upload_path` are converted to directories.
+Any slashes in `image_upload_path` are converted to directories.
 
 ## Other files
 
 Any other file in the directory's root will be copied over exactly as-is, with two caveats.
 
-First, `images/` is used for the drag-and-drop file uploads from the admin interface. Files are named with `<unix_timestamp>.<extension>`.
+First, `images/` (by default) is used for the drag-and-drop file uploads from the admin interface. Files are named with `<timestamp>_ <name>.<extension>`. This is configurable, see the section on configuration.
 
 Second, for any file ending in `.html` or `.xml`:
 
@@ -386,14 +398,54 @@ The admin interface is intended to be a minimal place to focus on writing conten
 /* more customisation below */
 ```
 
-# Custom tags
+# Custom tags and filters
 
-These tags can be used in templates. For example:
+These tags can be used in templates, in addition to the [standard Liquid filters and tags](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). For example:
 
 ```
+{{ post.title | smarty }}
+
+{{ post.content | markdown }}
+
 {% file_digest foo.css prefix:- %}
 ```
 
+## List of filters
+
+* `date` with `'now'`
+  
+  This is a standard filter, but there is a [workaround](https://github.com/Shopify/liquid/pull/117) for
+  `{{ 'now' | date: "%Y" }}` to work, so you can use this in templates.
+
+* `markdown`
+  
+  e.g., `{{ post.content | markdown }}`.
+
+  This runs the given input through a Markdown + SmartyPants renderer, with fenced codeblocks enabled.
+
+* `strip`
+  
+  Strips trailing and leading whitespace.
+
+  e.g., `{{ " hello " | strip }}` will render as `hello`.
+
+* `xmlschema`
+  
+  e.g., `{{ post.created | xmlschema }}`.
+
+  Takes a Time value and returns an ISO8601-format string, as per Ruby's `Time#xmlschema` definition.
+
+  Example output: 2013-02-16T23:55:22+01:00
+
+  If the time value is in UTC: 2013-02-16T22:55:22Z
+
+* `encode_uri_component`
+  
+  e.g., `example.com/foo?url=http://mysite.com{{ post.url | encode_uri_component }}`
+
+  Intended to provide the functionality of JavaScript's `encode_uri_component()` function. Essentially:
+  encodes the entire input so it is usable as a query string parameter.
+
 ## List of tags
 
 * `file_digest <path> [prefix:<prefix>]`
@@ -415,3 +467,16 @@ These are available on individual post pages, in `_template/post.html`.
 * `{{ post }}` --- the post being processed. Allows access to variables like `post.url`, `post.title`, `post.slug`, `post.created` and `post.content`.
 * `{{ prev_post }}` --- the post published chronologically before `post`.
 * `{{ next_post }}` --- the post published chronologically after `post`.
+
+# Developing Serif
+
+## Broad outline
+
+* `./bin/serif {dev,admin,generate}` to run Serif commands.
+* `rake test` to run the tests.
+* Unit tests are written in RSpec.
+
+## Directory structure
+
+* `lib/serif/` is generally where files go.
+* `test/` contains the test files. Any new files should have `require "test_helper"` at the top of the, which pulls in `test/test_helper.rb`.

data/lib/serif/admin_server.rb

@@ -87,7 +87,7 @@ class AdminServer
           # not the new one that was attempted to be saved.
           content = Draft.from_slug(site, params[:original_slug])
         else
-          Draft.rename(params[:original_slug], params[:slug])
+          Draft.rename(site, params[:original_slug], params[:slug])
 
           # re-load after the rename
           content = Draft.from_slug(site, params[:slug])

data/lib/serif/config.rb

@@ -39,7 +39,7 @@ class Config
   private
 
   def yaml
-    YAML.load_file(@config_file)
+    @yaml ||= YAML.load_file(@config_file)
   end
 end
 end

data/lib/serif/content_file.rb

@@ -49,6 +49,8 @@ class ContentFile
     else
       @source.headers[:title] = new_title
     end
+
+    @cached_headers = nil
   end
   
   def draft?
@@ -82,7 +84,9 @@ class ContentFile
   end
   
   def headers
-    return {} unless @source
+    return @cached_headers if @cached_headers
+
+    return (@cached_headers = {}) unless @source
 
     headers = @source.headers
     converted_headers = {}
@@ -97,7 +101,7 @@ class ContentFile
       converted_headers[key] = value
     end
 
-    converted_headers
+    @cached_headers = converted_headers
   end
 
   def save(markdown = nil)
@@ -131,10 +135,12 @@ class ContentFile
 
   def set_publish_time(time)
     @source.headers[:created] = time.xmlschema
+    @cached_headers = nil
   end
 
   def set_updated_time(time)
     @source.headers[:updated] = time.xmlschema
+    @cached_headers = nil
   end
 
   private
@@ -143,6 +149,7 @@ class ContentFile
     source = File.read(path).gsub(/\r?\n/, "\n")
     source.force_encoding("UTF-8")
     @source = Redhead::String[source]
+    @cached_headers = nil
   end
 end
 end

data/lib/serif/draft.rb

@@ -6,6 +6,11 @@ class Draft < ContentFile
     "_drafts"
   end
 
+  def self.rename(site, original_slug, new_slug)
+    raise if File.exist?("#{site.directory}/#{dirname}/#{new_slug}")
+    File.rename("#{site.directory}/#{dirname}/#{original_slug}", "#{site.directory}/#{dirname}/#{new_slug}")
+  end
+
   def delete!
     FileUtils.mkdir_p("#{site.directory}/_trash")
     File.rename(@path, File.expand_path("#{site.directory}/_trash/#{Time.now.to_i}-#{slug}"))

data/lib/serif/site.rb

@@ -30,6 +30,11 @@ module Filters
     CGI.escape(string)
   end
 
+  def smarty(text)
+    text.gsub!('`', '\\\\`')
+    Redcarpet::Render::SmartyPants.render(text)
+  end
+
   def markdown(body)
     Redcarpet::Markdown.new(Serif::MarkupRenderer, fenced_code_blocks: true).render(body).strip
   end
@@ -105,7 +110,7 @@ class Site
   end
 
   def config
-    Serif::Config.new(File.join(@source_directory, "_config.yml"))
+    @config ||= Serif::Config.new(File.join(@source_directory, "_config.yml"))
   end
 
   def site_path(path)
@@ -221,7 +226,12 @@ class Site
   end
 
   def to_liquid
-    {
+    @liquid_cache_store ||= TimeoutCache.new
+
+    cached_value = @liquid_cache_store[:liquid]
+    return cached_value if cached_value
+
+    @liquid_cache_store[:liquid] = {
       "posts" => posts,
       "latest_update_time" => latest_update_time,
       "archive" => self.class.stringify_keys(archives),
@@ -273,8 +283,12 @@ class Site
           if layout_option == "none"
             f.puts Liquid::Template.parse(file.to_s).render!("site" => self)
           else
-            layout_file = File.join(self.directory, "_layouts", "#{layout_option}.html")
-            layout = Liquid::Template.parse(File.read(layout_file))
+            if layout_option == :default
+              layout = default_layout
+            else
+              layout_file = File.join(self.directory, "_layouts", "#{layout_option}.html")
+              layout = Liquid::Template.parse(File.read(layout_file))
+            end
             f.puts layout.render!("site" => self, "page" => { "title" => [title].compact }, "content" => Liquid::Template.parse(file.to_s).render!("site" => self))
           end
         end
@@ -356,6 +370,7 @@ class Site
 
       File.open(live_preview_file + ".html", "w") do |f|
         f.puts layout.render!(
+          "site" => self,
           "draft_preview" => true,
           "page" => { "title" => [ "Draft Preview", draft.title ] },
           "content" => template.render!("site" => self, "post" => draft)
@@ -391,7 +406,7 @@ class Site
       FileUtils.mkdir_p(archive_path)
 
       File.open(File.join(archive_path, "index.html"), "w") do |f|
-        f.puts layout.render!("content" => template.render!("site" => self, "month" => month, "posts" => posts))
+        f.puts layout.render!("site" => self, "content" => template.render!("site" => self, "month" => month, "posts" => posts))
       end
     end
   end

data/lib/serif.rb

@@ -4,6 +4,7 @@ require "liquid"
 require "redcarpet"
 require "pygments.rb"
 require "redhead"
+require "timeout_cache"
 
 require "cgi"
 require "digest"

data/rakefile

@@ -1,5 +1,7 @@
 require "rake"
+require "time"
 require "rspec/core/rake_task"
+require "benchmark"
 
 RSpec::Core::RakeTask.new(:test) do |t|
   t.rspec_opts = "-I test --color --format nested"
@@ -9,3 +11,29 @@ RSpec::Core::RakeTask.new(:test) do |t|
 end
 
 task :default => :test
+
+task :stress, [:n] do |t, args|
+  iterations = args[:n] || 250
+  iterations = iterations.to_i
+
+  d = Dir.pwd
+  cd "/tmp"
+  rm_rf ".test-site"
+  mkdir ".test-site"
+  cd ".test-site"
+  `#{d}/bin/serif new`
+
+  File.open("_layouts/default.html", "a") { |f| f.puts "\n\ndigest: {% file_digest style.css prefix:- %}" }
+  File.open("style.css", "w") { |f| f.puts("body {}") }
+
+  iterations.times do |n|
+    File.open("_posts/#{Date.today + n}-sample-post-#{n}", "w") do |f|
+      f.puts %Q{title: sample-post
+created: #{(Time.now + 60*n).xmlschema}
+
+Dummy content #{n}}
+    end
+  end
+
+  puts Benchmark.realtime { system({ "ENV" => ENV["ENV"] }, "#{d}/bin/serif generate") }
+end

data/serif.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name         = "serif"
-  s.version      = "0.2.3"
+  s.version      = "0.3"
   s.authors      = ["Adam Prescott"]
   s.email        = ["adam@aprescott.com"]
   s.homepage     = "https://github.com/aprescott/serif"
@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
     "sinatra", "~> 1.3",
     "redhead", "~> 0.0.8",
     "liquid", "~> 2.4",
-    "slop", "~> 3.3"
+    "slop", "~> 3.3",
+    "timeout_cache"
   ].each_slice(2) do |name, version|
     s.add_runtime_dependency(name, version)
   end

data/statics/assets/js/attachment.js

@@ -67,6 +67,39 @@ var createAttachment = function(file, element) {
 	});
 
 	var absText = '![' + file.name + '](' + finalName + ')';
+
+	// for some reason this is necessary to avoid the following
+	// giving an undefined result:
+	//
+	//   1. load a new draft page with an empty textarea
+	//   2. at this point element.value is undefined.
+	//   3. drag an image, calling insertAtCaret
+	//   4. element.value (3) in this method is still undefined (confusing!)
+	//   5. in the browser console, $("[data-attachify]").get(0).value
+	//      is correct. (confusing!)
+	//   6. on a _second drag_, element.value is undefined (very confusing)
+	//   7. in the same second drag event, $(element).get(0).value is
+	//      correct, hence this "reloading" to allow element.value
+	//      below to not be undefined.
+	element = $(element).get(0);
+
+	if (typeof element.value != "undefined") {
+		var pos    = element.selectionStart;
+		var text   = element.value;
+		var before = text.slice(0, pos);
+		var after  = text.slice(pos);
+		
+		// if there is only a single newline, add one more for a blank
+		// line.
+		if (/[^\n]\n$/.test(before)) {
+			absText = "\n" + absText;
+		// if there aren't two new lines, add a full two
+		} else if (! /\n\n$/.test(before)) {
+			absText = "\n\n" + absText;
+		}
+
+	}
+	
 	$(element).insertAtCaret(absText);
 };
 

data/test/draft_spec.rb

@@ -7,6 +7,39 @@ describe Serif::Draft do
     FileUtils.rm_rf(testing_dir("_trash"))
   end
 
+  describe ".rename" do
+    it "moves the draft to a new file" do
+      draft = D.new(@site)
+      draft.slug = "test-draft"
+      draft.title = "Some draft title"
+      draft.save("some content")
+
+      D.rename(@site, "test-draft", "foo-bar")
+      d = D.from_slug(@site, "foo-bar")
+      d.should_not be_nil
+      File.exist?(testing_dir("_drafts/foo-bar")).should be_true
+
+      d.delete!
+    end
+
+    it "raises if there is an existing draft" do
+      draft = D.new(@site)
+      draft.slug = "test-draft"
+      draft.title = "Some draft title"
+      draft.save("some content")
+
+      draft2 = D.new(@site)
+      draft2.slug = "test-draft-2"
+      draft2.title = "Some draft title"
+      draft2.save("some content")
+
+      expect { D.rename(@site, draft2.slug, draft.slug) }.to raise_error
+
+      draft.delete!
+      draft2.delete!
+    end
+  end
+
   describe "#delete!" do
     it "moves the file to _trash" do
       draft = D.new(@site)

data/test/filters_spec.rb

@@ -18,6 +18,23 @@ describe Serif::Filters do
     end
   end
 
+  describe "#smarty" do
+    it "runs the input through a SmartyPants processor" do
+      subject.smarty("Testing").should == "Testing"
+      subject.smarty("Testing's").should == "Testing’s"
+      subject.smarty("\"Testing\" some \"text's\" input...").should == "“Testing” some “text’s” input…"
+    end
+
+    it "does not do any markdown processing" do
+      subject.smarty("# Heading").should == "# Heading"
+      subject.smarty("Testing `code blocks` input").should == "Testing `code blocks` input"
+    end
+
+    it "deals with HTML appropriately" do
+      subject.smarty("<p>Testing's <span>span</span> testing</p>").should == "<p>Testing&rsquo;s <span>span</span> testing</p>"
+    end
+  end
+
   describe "#encode_uri_component" do
     it "percent-encodes various characters for use in a URI" do
       {

data/test/site_dir/_site/index.html

@@ -9,10 +9,10 @@
 
 <ul>
 	
-		<li><a href="/test-blog/second-post">Second post</a> (posted 2013-01-01T00:00:00+00:00)</li>
+		<li><a href="/test-blog/second-post">Second post</a> (posted 2013-01-01T00:00:00Z)</li>
 	
-		<li><a href="/test-blog/post-to-be-published-on-generate">Some draft title</a> (posted 2012-12-21T15:30:00+00:00)</li>
+		<li><a href="/test-blog/post-to-be-published-on-generate">Some draft title</a> (posted 2012-12-21T15:30:00Z)</li>
 	
-		<li><a href="/test-blog/sample-post">Sample post</a> (posted 2012-11-21T17:07:09+00:00)</li>
+		<li><a href="/test-blog/sample-post">Sample post</a> (posted 2012-11-21T17:07:09Z)</li>
 	
 </ul>

data/test/site_dir/_site/test-smarty-filter.html

@@ -0,0 +1,8 @@
+<!doctype html>
+<meta charset="UTF-8">
+<title>My site: </title>
+<h1>mysite.com</h1>
+
+Some content
+
+testing&rsquo;s for a &ldquo;heading&rsquo;s&rdquo; `with code` in it&hellip;

data/test/site_dir/_trash/1361224983-autopublish-draft

@@ -0,0 +1,5 @@
+title: Some draft title
+Updated: 2013-02-18T22:03:03+00:00
+Created: 2013-02-18T22:03:03+00:00
+
+some content

data/test/site_dir/_trash/{1361047797-test-draft → 1361224983-test-draft}

@@ -1,4 +1,4 @@
 title: Some draft title
-Updated: 2013-02-16T20:49:57+00:00
+Updated: 2013-02-18T22:03:03+00:00
 
 some content

data/test/site_dir/test-smarty-filter.html

@@ -0,0 +1,3 @@
+Some content
+
+{{ "testing's for a " | append: '"' | append: "heading's" | append: '"' | append: " `with code` in it..." | smarty }}

data/test/site_generation_spec.rb

@@ -23,6 +23,11 @@ describe Serif::Site do
       File.read("_site/page-alt-layout.html").lines.first.should =~ /<h1.+?>Alternate layout<\/h1>/
     end
 
+    it "supports a smarty filter" do
+      subject.generate
+      File.read("_site/test-smarty-filter.html").should =~ /testing&rsquo;s for a &ldquo;heading&rsquo;s&rdquo; `with code` in it&hellip;/
+    end
+
     it "correctly handles file_digest calls" do
       subject.generate
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serif
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-17 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -139,6 +139,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: timeout_cache
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -261,8 +277,8 @@ files:
 - test/site_dir/_site/test-archive/2013/01/index.html
 - test/site_dir/_site/test-archive/2012/12/index.html
 - test/site_dir/_site/test-archive/2012/11/index.html
-- test/site_dir/_site/drafts/another-sample-draft/cdc8037ed098e34a19fc6671ab652f908dd94009ff642d4e5ee80fa566fa.html
-- test/site_dir/_site/drafts/sample-draft/f828e5f22d76b04c586e90680ac814e6b233d3d380f6be6975beba75081b.html
+- test/site_dir/_site/drafts/another-sample-draft/f340ff2dd6aa78f819d547ee908fe7410e6153559b47265dcbc58598bb4a.html
+- test/site_dir/_site/drafts/sample-draft/ed883ce827f757888e2900ce0e155a960cb45f832fcc24791c054013b71c.html
 - test/site_dir/_site/index.html
 - test/site_dir/_site/file-digest-test.html
 - test/site_dir/_site/page-alt-layout.html
@@ -271,11 +287,13 @@ files:
 - test/site_dir/_site/test-blog/post-to-be-published-on-generate.html
 - test/site_dir/_site/test-blog/second-post.html
 - test/site_dir/_site/test-blog/sample-post.html
+- test/site_dir/_site/test-smarty-filter.html
 - test/site_dir/_site/archive.html
-- test/site_dir/_trash/1361047797-test-draft
-- test/site_dir/_trash/1361047797-autopublish-draft
+- test/site_dir/_trash/1361224983-test-draft
+- test/site_dir/_trash/1361224983-autopublish-draft
 - test/site_dir/_posts/2012-01-05-sample-post
 - test/site_dir/_posts/2013-01-01-second-post
+- test/site_dir/test-smarty-filter.html
 - test/site_dir/_layouts/alt-layout.html
 - test/site_dir/_layouts/default.html
 - test/site_dir/archive.html

data/test/site_dir/_trash/1361047797-autopublish-draft

@@ -1,5 +0,0 @@
-title: Some draft title
-Updated: 2013-02-16T20:49:57+00:00
-Created: 2013-02-16T20:49:57+00:00
-
-some content