serif 0.4 → 0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    serif (0.3.3)
+    serif (0.4)
       liquid (~> 2.4)
       nokogiri (~> 1.5)
       rack (~> 1.0)
@@ -15,37 +15,50 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
+    colorize (0.5.8)
+    coveralls (0.6.3)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.2)
+    json (1.7.7)
     liquid (2.5.0)
-    multi_json (1.6.1)
-    nokogiri (1.5.6)
+    mime-types (1.22)
+    multi_json (1.7.2)
+    nokogiri (1.5.9)
     rack (1.5.2)
     rack-protection (1.5.0)
       rack
     rake (0.9.6)
+    rdoc (4.0.1)
+      json (~> 1.4)
     redcarpet (2.2.2)
     redhead (0.0.8)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     reverse_markdown (0.4.4)
       nokogiri
     rouge (0.3.2)
       thor
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    sinatra (1.4.1)
+    sinatra (1.4.2)
       rack (~> 1.5, >= 1.5.2)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
-    thor (0.17.0)
+    thor (0.18.1)
     tilt (1.3.6)
     timecop (0.6.1)
     timeout_cache (0.0.2)
@@ -54,7 +67,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls
   rake (~> 0.9)
+  rdoc (~> 4.0.0)
   rspec (~> 2.5)
   serif!
   simplecov (~> 0.7)

data/README.md

@@ -1,10 +1,12 @@
 # Serif
 
-[![Build Status](https://travis-ci.org/aprescott/serif.png?branch=master)](https://travis-ci.org/aprescott/serif)
+[![Build Status](https://travis-ci.org/aprescott/serif.png?branch=master)](https://travis-ci.org/aprescott/serif) [![Code Climate](https://codeclimate.com/github/aprescott/serif.png)](https://codeclimate.com/github/aprescott/serif) [![Coverage Status](https://coveralls.io/repos/aprescott/serif/badge.png?branch=master)](https://coveralls.io/r/aprescott/serif)
 
-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.
+Serif is a static site generator and blogging system powered by markdown files and an optional admin interface complete with drag-and-drop image uploading. ([Check out the simple video demo](https://docs.google.com/open?id=0BxPQpxGSOOyKS1J4MmlnM3JIaXM).)
 
-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)
+Serif releases you from managing a file system so you can focus on writing content.
+
+Having problems with Serif? [Open an issue on GitHub](https://github.com/aprescott/serif/issues), use the [Serif Google Group](https://groups.google.com/forum/#!forum/serif-rb), or [join the Freenode#serif IRC channel](irc://irc.freenode.net/serif).
 
 ## First time use
 
@@ -177,9 +179,24 @@ Something something.
 End of the post
 ```
 
+### Headers
+
 The headers are similar to Jekyll's YAML front matter, but here there are no formatting requirements beyond `Key: value` pairs. Header names are case-insensitive (so `title` is the same as `Title`), but values are not.
 
-(The headers `created` and `updated` must be a string that Ruby's standard Time library can parse, but this will mostly be handled for you.)
+File headers like `Title: Some title` can contain any header, but certain headers have special meaning in Serif.
+
+Header name | Meaning
+----------- |:-------
+`Created`   | For a post, timestamp for when it was first published. Must be a string that Ruby's `Time` class can parse. Means nothing for drafts.
+`Updated`   | For a post, timestamp for when it was last updated. Must be a string that Ruby's `Time` class can parse. Means nothing for drafts.
+`Title`     | Title for the draft or post.
+`Update`    | For a post, When given the value of `now` (i.e., `Update: now`), the `Updated` timestamp will be updated on the next site generation. Means nothing for drafts.
+`Publish`   | For a draft, when given the value of `now` (i.e., `Publish: now`), the draft will be published on the next site generation (and the `Created` set appropriately). Means nothing for a post.
+`Permalink` | For a post, overrides the default permalink value defined in `_config.yml`. **Note that this is interpolated**, so `:title` in the permalink value will be replaced according to regular permalink rules. Means nothing for a draft.
+
+Note that while it is possible for you to manually handle timestamp values, it is recommended that you rely on using the value of `now` for `Update` and `Publish`.
+
+If you change the `permalink` value for a published post, you will break any inbound URLs as well as, e.g., any feeds that rely on the URL as a unique persistent ID.
 
 ## `_templates`
 
@@ -217,6 +234,8 @@ Placeholder | Value
 `:month`    | Month as given in the filename, e.g., "01"
 `:day`      | Day as given in the filename, e.g., "28"
 
+<b>NOTE</b>: if you change the permalink value, you will break existing URLs for published posts, in addition to, e.g., any feed ID values that depend on the post URL never changing.
+
 ### Admin drag-and-drop upload path
 
 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:
@@ -283,7 +302,7 @@ On the next site generation (`serif generate`) this draft will be automatically
 
 # 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:
+When you update a post, 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 published post after making your changes:
 
 ```
 title: My blog post
@@ -470,6 +489,7 @@ These should be available in any template:
     * `{{ site.latest_update_time }}` --- a [Ruby `Time`](http://ruby-doc.org/core/Time.html) instance for the latest time that any post was updated. Useful for RSS/Atom feeds.
     * `{{ site.archives }}` --- a nested hash structure that groups posts by month. See above for how to use it.
 * `{{ draft_preview }}` -- Set to true if this is part of generating a draft preview.
+* `{{ post_page }}` -- Set to true if this is part of generating a regular published post.
 
 ## Post variables
 
@@ -483,6 +503,7 @@ Name           | Value
 `post.created` | A [Ruby `Time`](http://ruby-doc.org/core/Time.html) instance for the time the post was first published.
 `post.updated` | A [Ruby `Time`](http://ruby-doc.org/core/Time.html) instance for the time the post was last updated.
 `post.content` | The raw post content. Example use: `{{ post.content | markdown }}`.
+`post.foo`     | The value of the `Foo` header, e.g., if `Foo: my special header` is in the source file, `post.foo` is `my special header`. All headers are merged into the `{{ post }}` variable for you to use in templates.
 
 ## Variables available within post templates
 
@@ -511,6 +532,7 @@ Variable       | Value
 * `./bin/serif {dev,admin,generate}` to run Serif commands.
 * `rake test` to run the tests.
 * Unit tests are written in RSpec.
+* `rake docs` will generate HTML documentation in `docs/`. Open `docs/index.html` in a browser to start.
 
 ## Directory structure
 
@@ -519,15 +541,7 @@ Variable       | Value
 
 # 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.
+See `CHANGELOG`.
 
 # Planned features
 

data/bin/serif

@@ -2,73 +2,6 @@
 
 $:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
 
-require "fileutils"
+require "serif/commands"
 
-def initialize_admin_server(source_dir)
-  # need to cd to the directory before requiring the admin
-  # server, because otherwise Dir.pwd won't be right when
-  # the admin server class is defined at require time.
-  FileUtils.cd(source_dir)
-  require "serif"
-  require "serif/admin_server"
-
-  server = Serif::AdminServer.new(source_dir)
-  server.start
-end
-
-def initialize_dev_server(source_dir)
-  FileUtils.cd(source_dir)
-  require "serif"
-  require "serif/server"
-
-  server = Serif::DevelopmentServer.new(source_dir)
-  server.start
-end
-
-def generate_site(source_dir)
-  require "serif"
-  
-  site = Serif::Site.new(source_dir)
-  site.generate
-end
-
-def verify_directory(dir)
-  unless Dir.exist?(dir)
-    puts "No such directory: #{dir}'"
-    exit 1
-  end
-end
-
-def produce_skeleton(dir)
-  if !Dir[File.join(dir, "*")].empty?
-    abort "Directory is not empty."
-  end
-
-  FileUtils.cd(File.join(File.dirname(__FILE__), "..", "statics", "skeleton"))
-  files = Dir["*"]
-  files.each do |f|
-    FileUtils.cp_r(f, dir, verbose: true)
-  end
-
-  generate_site(dir)
-
-  puts
-  puts "*** NOTE ***"
-  puts
-  puts "You should now edit the username and password in _config.yml"
-  puts
-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
+Serif::Commands.new(ARGV).process

data/lib/serif.rb

@@ -11,6 +11,7 @@ require "digest"
 
 require "securerandom"
 
+require "serif/errors"
 require "serif/content_file"
 require "serif/post"
 require "serif/draft"

data/lib/serif/admin_server.rb

@@ -19,6 +19,10 @@ class AdminServer
       [username, password] == [site.config.admin_username, site.config.admin_password]
     end
 
+    before do
+      @conflicts = site.conflicts
+    end
+
     # multiple public folders??
     get "/admin/js/:file" do |file|
       assets_dir = File.join(File.dirname(__FILE__), "..", "..", "statics", "assets", "js")
@@ -34,7 +38,7 @@ class AdminServer
       posts = site.posts.sort_by { |p| p.created }.reverse
       drafts = site.drafts.sort_by { |p| File.mtime(p.path) }.reverse
 
-      liquid :index, locals: { posts: posts, drafts: drafts }
+      liquid :index, locals: { conflicts: @conflicts, posts: posts, drafts: drafts }
     end
 
     get "/admin/edit/?" do
@@ -42,7 +46,7 @@ class AdminServer
     end
 
     get "/admin/bookmarks" do
-      liquid :bookmarks, locals: { base_url: request.base_url }
+      liquid :bookmarks, locals: { conflicts: @conflicts }
     end
 
     get "/admin/quick-draft" do
@@ -76,21 +80,36 @@ class AdminServer
       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}")
+      # if the draft itself has no conflict, save it,
+      # otherwise show the new draft page with an error.
+      #
+      # if, after saving the draft because of no conflict,
+      # there is actually an overall site conflict, then
+      # keep on trucking so it doesn't interrupt the user.
+      if site.conflicts(draft)
+        liquid :new_draft, locals: { conflicts: @conflicts, images_path: site.config.image_upload_path.gsub(/"/, '\"'), post: draft, error_message: "There is a conflict on this draft." }
       else
-        redirect to(url)
+        draft.save(markdown)
+
+        begin
+          site.generate
+        rescue PostConflictError => e
+          puts "Site has conflicts, skipping generation for now."
+        end
+
+        if params[:edit] == "1"
+          redirect to("/admin/edit/drafts/#{slug}")
+        else
+          redirect to(url)
+        end
       end
     end
 
     get "/admin/new/draft" do
       content = Draft.new(site)
       autofocus = "slug"
-      liquid :new_draft, locals: { images_path: site.config.image_upload_path.gsub(/"/, '\"'), post: content, autofocus: autofocus }
+      liquid :new_draft, locals: { conflicts: @conflicts, images_path: site.config.image_upload_path.gsub(/"/, '\"'), post: content, autofocus: autofocus }
     end
 
     post "/admin/new/draft" do
@@ -109,13 +128,18 @@ class AdminServer
         autofocus = "title" unless params[:title]
         autofocus = "slug" unless params[:slug]
 
-        liquid :new_draft, locals: { images_path: site.config.image_upload_path.gsub(/"/, '\"'), error_message: error_message, post: content, autofocus: autofocus }
+        liquid :new_draft, locals: { conflicts: @conflicts, images_path: site.config.image_upload_path.gsub(/"/, '\"'), error_message: error_message, post: content, autofocus: autofocus }
       else
         if Draft.exist?(site, params[:slug])
-          liquid :new_draft, locals: { images_path: site.config.image_upload_path.gsub(/"/, '\"'), error_message: error_message, post: content, autofocus: autofocus }
+          error_message = "Draft already eixsts with the given slug #{params[:slug]}."
+          liquid :new_draft, locals: { conflicts: @conflicts, images_path: site.config.image_upload_path.gsub(/"/, '\"'), error_message: error_message, post: content, autofocus: autofocus }
         else
           content.save(params[:markdown])
-          site.generate
+          begin
+            site.generate
+          rescue PostConflictError => e
+            puts "Cannot generate. Skipping for now."
+          end
           redirect to("/admin")
         end
       end
@@ -155,7 +179,10 @@ class AdminServer
           error_message = "You must pick a URL to use"
         end
 
-        liquid :edit_draft, locals: { images_path: site.config.image_upload_path.gsub(/"/, '\"'), error_message: error_message, post: content, private_url: site.private_url(content) }
+        liquid :edit_draft, locals: { conflicts: @conflicts, images_path: site.config.image_upload_path.gsub(/"/, '\"'), error_message: error_message, post: content, private_url: site.private_url(content) }
+      elsif (conflicts = site.conflicts)
+        error_message = "The site has a conflict and cannot be generated."
+        liquid :edit_draft, locals: { conflicts: @conflicts, images_path: site.config.image_upload_path.gsub(/"/, '\"'), error_message: error_message, post: content, private_url: site.private_url(content) }
       else
         content.save(params[:markdown])
 
@@ -172,7 +199,7 @@ class AdminServer
     end
 
     post "/admin/edit/posts" do
-      content = Post.from_slug(site, params[:original_slug])
+      content = Post.from_basename(site, params[:original_basename])
 
       params[:markdown] = params[:markdown].strip
       params[:title] = params[:title].strip
@@ -183,7 +210,10 @@ class AdminServer
         error_message = "Content must not be blank." if params[:markdown].empty?
         error_message = "Title must not be blank." if params[:title].empty?
 
-        liquid :edit_post, locals: { images_path: site.config.image_upload_path.gsub(/"/, '\"'), error_message: error_message, post: content }
+        liquid :edit_post, locals: { conflicts: @conflicts, images_path: site.config.image_upload_path.gsub(/"/, '\"'), error_message: error_message, post: content }
+      elsif (conflicts = site.conflicts)
+        error_message = "The site has a conflict and cannot be generated."
+        liquid :edit_post, locals: { conflicts: @conflicts, images_path: site.config.image_upload_path.gsub(/"/, '\"'), error_message: error_message, post: content }
       else
         content.save(params[:markdown])
         site.generate
@@ -192,19 +222,18 @@ class AdminServer
       end
     end
 
-    get "/admin/edit/:type/:slug" do
+    get "/admin/edit/posts/:basename" do
+      redirect to("/admin") unless params[:basename]
+
+      content = Post.from_basename(site, params[:basename])
+      liquid :edit_post, locals: { conflicts: @conflicts, images_path: site.config.image_upload_path.gsub(/"/, '\"'), post: content, autofocus: "markdown" }
+    end
+
+    get "/admin/edit/drafts/:slug" do
       redirect to("/admin") unless params[:slug]
 
-      if params[:type] == "posts"
-        content = site.posts.find { |p| p.slug == params[:slug] }
-        liquid :edit_post, locals: { images_path: site.config.image_upload_path.gsub(/"/, '\"'), post: content, autofocus: "markdown" }
-      elsif params[:type] == "drafts"
-        content = Draft.from_slug(site, params[:slug])
-        liquid :edit_draft, locals: { images_path: site.config.image_upload_path.gsub(/"/, '\"'), post: content, autofocus: "markdown", private_url: site.private_url(content) }
-      else
-        response.status = 404
-        return "Nope"
-      end
+      content = Draft.from_slug(site, params[:slug])
+      liquid :edit_draft, locals: { conflicts: @conflicts, images_path: site.config.image_upload_path.gsub(/"/, '\"'), post: content, autofocus: "markdown", private_url: site.private_url(content) }
     end
 
     post "/admin/delete/?" do

data/lib/serif/commands.rb

@@ -0,0 +1,150 @@
+require "fileutils"
+require "serif"
+require "serif/server"
+
+module Serif
+class Commands
+  def initialize(argv)
+    @argv = argv.dup
+  end
+
+  def process
+    command = @argv.shift
+    case command
+    when "-h", "--help", nil
+      print_help
+      exit 0
+    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
+  end
+
+  def initialize_admin_server(source_dir)
+    # need to cd to the directory before requiring the admin
+    # server, because otherwise Dir.pwd won't be right when
+    # the admin server class is defined at require time.
+    FileUtils.cd(source_dir)
+    require "serif/admin_server"
+
+    server = Serif::AdminServer.new(source_dir)
+    server.start
+  end
+
+  def initialize_dev_server(source_dir)
+    FileUtils.cd(source_dir)
+
+    server = Serif::DevelopmentServer.new(source_dir)
+    server.start
+  end
+
+  def generate_site(source_dir)
+    
+    site = Serif::Site.new(source_dir)
+
+    begin
+      site.generate
+    rescue Serif::PostConflictError => e
+      puts "Error! Unable to generate because there is a conflict."
+      puts
+      puts "Conflicts at:"
+      puts
+
+      site.conflicts.each do |url, ary|
+        puts url
+        ary.each do |e|
+          puts "\t#{e.path}"
+        end
+      end
+
+      exit 1
+    end
+  end
+
+  def verify_directory(dir)
+    unless Dir.exist?(dir)
+      puts "No such directory: #{dir}'"
+      exit 1
+    end
+  end
+
+  def produce_skeleton(dir)
+    if !Dir[File.join(dir, "*")].empty?
+      abort "Directory is not empty."
+    end
+
+    FileUtils.cd(File.join(File.dirname(__FILE__), "..", "..", "statics", "skeleton"))
+    files = Dir["*"]
+    files.each do |f|
+      FileUtils.cp_r(f, dir, verbose: true)
+    end
+
+    generate_site(dir)
+
+    puts
+    puts "*** NOTE ***"
+    puts
+    puts "You should now edit the username and password in _config.yml"
+    puts
+  end
+
+  def print_help
+    puts <<-END_HELP
+  USAGE
+
+    serif [-h | --help]
+    serif [COMMAND]
+
+  OPTIONS
+
+    -h, --help  Display this help message and exit immediately.
+
+  COMMANDS
+
+    serif generate    Generate the site in the current directory.
+
+    serif new         Create a site skeleton to get started. Will
+                      only run if the current directory is empty.
+
+    serif admin       Start the admin server on localhost:4567.
+
+    serif dev         Start a simple dev server on localhost:8000.
+                      Serves up the generated static files, but loads
+                      some files (like CSS) from source (instead of
+                      out of the _site/ directory).
+
+  ENVIRONMENT VARIABLES
+
+    ENV               Set to 'production' if the command is being run
+                      as part of serving up a live site.
+
+                          $ ENV=production serif generate
+
+                          $ ENV=production serif admin
+
+                      Note that this by and large doesn't change much,
+                      but in future it may provide extra features.
+
+                      The main benefit is that the `file_digest` tag
+                      will return a hex digest of the given file's
+                      contents only when ENV is set to production.
+
+  EXAMPLES
+
+    $ serif generate
+
+      Generate the site.
+
+    $ serif admin
+
+      Start the admin server on localhost:4567.
+
+  END_HELP
+  end
+end
+end