serif 0.3.3 → 0.4

data/Gemfile.lock

@@ -3,12 +3,13 @@ PATH
   specs:
     serif (0.3.3)
       liquid (~> 2.4)
+      nokogiri (~> 1.5)
       rack (~> 1.0)
       redcarpet (~> 2.2)
       redhead (~> 0.0.8)
+      reverse_markdown (~> 0.4.3)
       rouge (~> 0.3.2)
       sinatra (~> 1.3)
-      slop (~> 3.3)
       timeout_cache
 
 GEM
@@ -17,12 +18,15 @@ GEM
     diff-lcs (1.1.3)
     liquid (2.5.0)
     multi_json (1.6.1)
+    nokogiri (1.5.6)
     rack (1.5.2)
     rack-protection (1.5.0)
       rack
     rake (0.9.6)
     redcarpet (2.2.2)
     redhead (0.0.8)
+    reverse_markdown (0.4.4)
+      nokogiri
     rouge (0.3.2)
       thor
     rspec (2.12.0)
@@ -37,14 +41,13 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    sinatra (1.3.5)
-      rack (~> 1.4)
-      rack-protection (~> 1.3)
-      tilt (~> 1.3, >= 1.3.3)
-    slop (3.4.4)
+    sinatra (1.4.1)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
     thor (0.17.0)
-    tilt (1.3.5)
-    timecop (0.5.9.2)
+    tilt (1.3.6)
+    timecop (0.6.1)
     timeout_cache (0.0.2)
 
 PLATFORMS
@@ -55,4 +58,4 @@ DEPENDENCIES
   rspec (~> 2.5)
   serif!
   simplecov (~> 0.7)
-  timecop (~> 0.5.5)
+  timecop (~> 0.6.1)

data/README.md

@@ -6,24 +6,22 @@ Serif is a file-based blogging engine intended for simple sites. It compiles Mar
 
 Having problems with Serif? [Open an issue on GitHub](https://github.com/aprescott/serif/issues), or use the [Serif Google Group](https://groups.google.com/forum/#!forum/serif-rb)
 
-# Changes and what's new
+## First time use
 
-# Latest release (v0.3.3)
+To get started with Serif based on a site skeleton:
 
-* Allow drag-and-drop to work on posts as well as drafts. (9ea3bebf)
-* `serif new` no longer creates a sample published post (#37) and generates immediately. (#39)
-* Pygments.rb is replaced with Rouge for code highlighting. (#34)
+```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
 
-## v0.3.1 and v0.3.2
+# ... edit your files how you want them ...
 
-* Be kinder about the space used by the private URL characters. (#32)
-* The keyup event on any input or textarea now marks the page as having changed. Previously only on blur events. (e0df1375dd)
-* Order the list of drafts by most-recently-modified first, clarify draft and post ordering above each list. (#33)
-* Support custom layouts for posts as well as non-post files. (#35)
-* Drag-and-drop image uploads no longer use exclusively `rw-------` permissions, now rely on umask. (605487d98)
-* (v0.3.2) Fix caching problems caused by #30, allowing the most recently published to appear in files that use `site.posts`. (#36)
+serif generate        # generate the site based on the source files
+serif dev             # serve up the site for local testing purposes
+```
 
-See `CHANGELOG` for more.
+Now visit <http://localhost:8000/> to view the site.
 
 # Contents of this README
 
@@ -32,13 +30,15 @@ See `CHANGELOG` for more.
 * [Basic usage](#basics)
 * [Content and site structure](#content-and-site-structure)
 * [Publishing drafts](#publishing-drafts)
+* [Updating posts](#updating-posts)
 * [Archive pages](#archive-pages)
 * [Configuration](#configuration)
 * [Deploying](#deploying)
 * [Customising the admin interface](#customising-the-admin-interface)
-* [Custom tags](#custom-tags)
+* [Custom tags and filters](#custom-tags-and-filters)
 * [Template variables](#template-variables)
 * [Developing Serif](#developing-serif)
+* [Changes and what's new](#changes-and-whats-new)
 * [Planned features](#planned-features)
 
 # Intro
@@ -67,23 +67,6 @@ For more info on development, see the section at the bottom of this README.
 
 # 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/).
@@ -298,6 +281,26 @@ This is a draft that will be published now.
 
 On the next site generation (`serif generate`) this draft will be automatically published, using the current time as the creation timestamp.
 
+# Updating posts
+
+When you update a draft, you need to remember to change the updated time. As luck would have it, Serif takes care of timestamps for you! Just use a header of `update: now` at the top of your post:
+
+```
+title: My blog post
+Created: 2013-01-01T12:01:30+00:00
+update: now
+```
+
+Now the next time the site is generated, the timestamp will be updated:
+
+```
+title: My blog post
+Created: 2013-01-01T12:01:30+00:00
+Updated: 2013-03-18T19:03:30+00:00
+```
+
+Admin users: this is all done for you.
+
 # Archive pages
 
 By default, archive pages are made available at `/archive/:year/month`, e.g., `/archive/2012/11`. Individual archive pages can be customised by editing the `_templates/archive_page.html` file, which is used for each month.
@@ -491,6 +494,16 @@ Variable    | Value
 `prev_post` | The post published chronologically before `post`.
 `next_post` | The post published chronologically after `post`.
 
+## Archive page variables
+
+These are set when processing archive pages.
+
+Variable       | Value
+-------------- |:-----
+`month`        | The month for the archive page being rendered. This is a Ruby `Date` instance.
+`posts`        | The list of posts for the month. Ordered by most-recently-published-first.
+`archive_page` | A flag set to `true`.
+
 # Developing Serif
 
 ## Broad outline
@@ -504,6 +517,18 @@ Variable    | Value
 * `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`.
 
+# Changes and what's new
+
+## Latest release (v0.4)
+
+## v0.3.3
+
+* Allow drag-and-drop to work on posts as well as drafts. (9ea3bebf)
+* `serif new` no longer creates a sample published post (#37) and generates immediately. (#39)
+* Pygments.rb is replaced with Rouge for code highlighting. (#34)
+
+See `CHANGELOG` for more.
+
 # Planned features
 
 Some things I'm hoping to implement one day:
@@ -511,4 +536,4 @@ Some things I'm hoping to implement one day:
 1. Custom hooks to fire after particular events, such as minifying CSS after publish, or committing changes and pushing to a git repository.
 2. Simple Markdown pages instead of plain HTML for non-post content.
 3. Automatically detecting file changes and regenerating the site.
-4. Adding custom Liquid filters and tags.
+4. Adding custom Liquid filters and tags.

data/bin/serif

@@ -3,7 +3,6 @@
 $:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
 
 require "fileutils"
-require "slop"
 
 def initialize_admin_server(source_dir)
   # need to cd to the directory before requiring the admin
@@ -60,30 +59,16 @@ def produce_skeleton(dir)
   puts
 end
 
-commands = Slop::Commands.new do
-  on :admin do
-    add_callback :empty do
-      initialize_admin_server(Dir.pwd)
-    end
-  end
-
-  on :generate do
-    add_callback :empty do
-      generate_site(Dir.pwd)
-    end
-  end
-
-  on :dev do
-    add_callback :empty do
-      initialize_dev_server(Dir.pwd)
-    end
-  end
-
-  on :new do
-    add_callback :empty do
-      produce_skeleton(Dir.pwd)
-    end
-  end
+command = ARGV.shift
+args = ARGV
+
+case command
+when "admin"
+  initialize_admin_server(Dir.pwd)
+when "generate"
+  generate_site(Dir.pwd)
+when "dev"
+  initialize_dev_server(Dir.pwd)
+when "new"
+  produce_skeleton(Dir.pwd)
 end
-
-commands.parse

data/lib/serif/admin_server.rb

@@ -1,5 +1,7 @@
 require "sinatra/base"
 require "fileutils"
+require "nokogiri"
+require "reverse_markdown"
 
 module Serif
 class AdminServer
@@ -39,6 +41,52 @@ class AdminServer
       redirect to("/admin"), 301
     end
 
+    get "/admin/bookmarks" do
+      liquid :bookmarks, locals: { base_url: request.base_url }
+    end
+
+    get "/admin/quick-draft" do
+      url = params[:url]
+      html_content = params[:content].strip
+
+      title = params[:title]
+
+      # delete anything nonprintable
+      title = title.gsub(/[^\x20-\x7E]/, "")
+
+      # sanitise the HTML title into something we can use as a temporary slug
+      slug = title.split(" ").first(5).join(" ").gsub(/[^\w-]/, "-").gsub(/--+/, '-').gsub(/^-|-$/, '')
+      slug.downcase!
+
+      if html_content.empty?
+        markdown = "[#{title}](#{url.gsub(")", "\\)")})"
+      else
+        # parse the document fragment and remove any empty nodes.
+        document = Nokogiri::HTML::DocumentFragment.parse(html_content)
+        document.traverse { |p| p.remove if p.text && p.text.strip.empty? }
+        html_content = document.to_html
+
+        html_content = "<blockquote>#{html_content}</blockquote>"
+        markdown = ReverseMarkdown.parse(html_content, github_style_code_blocks: true)
+
+        # markdown URLs need to have any )s escaped
+        markdown = "[#{title}](#{url.gsub(")", "\\)")}):\n\n#{markdown}"
+      end
+
+      draft = Draft.new(site)
+      draft.title = title
+      draft.slug = slug
+      draft.save(markdown)
+
+      site.generate
+
+      if params[:edit] == "1"
+        redirect to("/admin/edit/drafts/#{slug}")
+      else
+        redirect to(url)
+      end
+    end
+
     get "/admin/new/draft" do
       content = Draft.new(site)
       autofocus = "slug"

data/lib/serif/content_file.rb

@@ -3,10 +3,6 @@
 # which contains the contents of a post, be it in
 # draft form or otherwise.
 #
-# A ContentFile can determine its type based on
-# the presence or absence of a "published"
-# timestamp value.
-#
 
 module Serif
 class ContentFile
@@ -33,18 +29,16 @@ class ContentFile
     # if we're adding a slug and there's no path yet, then create the path.
     # this will run for new drafts
 
-    if !@path
-      @path = File.expand_path("#{site.directory}/#{self.class.dirname}/#{@slug}")
-    end
+    @path ||= File.expand_path("#{site.directory}/#{self.class.dirname}/#{@slug}")
   end
 
   def title
-    return nil if new?
+    return nil if !@source
     headers[:title]
   end
 
   def title=(new_title)
-    if new?
+    if !@source
       @source = Redhead::String["title: #{new_title}\n\n"]
     else
       @source.headers[:title] = new_title
@@ -62,24 +56,16 @@ class ContentFile
   end
   
   def content(include_headers = false)
-    include_headers ? "#{raw_headers}\n\n#{@source.to_s}" : @source.to_s
-  end
-  
-  def new?
-    !@source
-  end
-
-  def raw_headers
-    @source.headers.to_s
+    include_headers ? "#{@source.headers.to_s}\n\n#{@source.to_s}" : @source.to_s
   end
 
   def created
-    return nil if new?
+    return nil if !@source
     headers[:created].utc
   end
 
   def updated
-    return nil if new?
+    return nil if !@source
     (headers[:updated] || created).utc
   end
   
@@ -105,18 +91,19 @@ class ContentFile
   end
 
   def save(markdown = nil)
-    markdown ||= content if !new?
+    markdown ||= content if @source
     
     save_path = path || "#{self.class.dirname}/#{@slug}"
 
-    if new?
-      set_publish_time(Time.now)
-    else
-      set_updated_time(Time.now)
-    end
-
+    # TODO: when a draft is being saved, it will call set_publish_time
+    # and then the #save call will execute this line, which will mean
+    # there is a very, very slight difference (fraction of a second)
+    # between the update time of a brand new published post and the
+    # creation time.
+    set_updated_time(Time.now)
+    
     File.open(save_path, "w") do |f|
-      f.puts %Q{#{raw_headers}
+      f.puts %Q{#{@source.headers.to_s}
 
 #{markdown}}.strip
     end
@@ -135,11 +122,18 @@ class ContentFile
 
   def set_publish_time(time)
     @source.headers[:created] = time.xmlschema
-    @cached_headers = nil
+    headers_changed!
   end
 
   def set_updated_time(time)
     @source.headers[:updated] = time.xmlschema
+    headers_changed!
+  end
+
+  # Invalidates the cached headers entirely.
+  #
+  # Any methods which alter headers should call this.
+  def headers_changed!
     @cached_headers = nil
   end
 

data/lib/serif/draft.rb

@@ -36,18 +36,16 @@ class Draft < ContentFile
     @path = Post.from_slug(site, slug).path
   end
 
-  # sets the autopublish flag to the given value.
-  #
   # if the assigned value is truthy, the "publish" header
   # is set to "now", otherwise the header is removed.
   def autopublish=(value)
-    @autopublish = value
-
     if value
       @source.headers[:publish] = "now"
     else
       @source.headers.delete(:publish)
     end
+
+    headers_changed!
   end
 
   # Checks the value of the "publish" header, and returns

data/lib/serif/post.rb

@@ -27,6 +27,36 @@ class Post < ContentFile
     output
   end
 
+  # if the assigned value is truthy, the "update" header
+  # is set to "now", otherwise the header is removed.
+  def autoupdate=(value)
+    if value
+      @source.headers[:update] = "now"
+    else
+      @source.headers.delete(:update)
+    end
+
+    headers_changed!
+  end
+
+  # returns true if the post has been marked as needing a
+  # new updated timestamp header.
+  #
+  # this is based on the presence of an "update: now" header.
+  def autoupdate?
+    update_header = headers[:update]
+    update_header && update_header.strip == "now"
+  end
+
+  # Updates the updated timestamp and saves the contents.
+  #
+  # If there is an "update" header (see autoupdate?), it is deleted.
+  def update!
+    @source.headers.delete(:update)
+    set_updated_time(Time.now)
+    save
+  end
+
   def self.all(site)
     files = Dir[File.join(site.directory, dirname, "*")].select { |f| File.file?(f) }.map { |f| File.expand_path(f) }
     files.map { |f| new(site, f) }