serif 0.1.5 → 0.1.6

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    serif (0.1.4)
+    serif (0.1.5)
       liquid (~> 2.4)
       pygments.rb (~> 0.3)
       rack (~> 1.0)
       rack-rewrite (~> 1.3.0)
       redcarpet (~> 2.2)
-      redhead (~> 0.0.6)
+      redhead (~> 0.0.8)
       sinatra (~> 1.3)
       slop (~> 3.3)
 
@@ -22,12 +22,12 @@ GEM
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.1.0)
     rack (1.4.1)
-    rack-protection (1.2.0)
+    rack-protection (1.3.2)
       rack
-    rack-rewrite (1.3.1)
+    rack-rewrite (1.3.2)
     rake (0.9.2.2)
     redcarpet (2.2.2)
-    redhead (0.0.6)
+    redhead (0.0.8)
     rspec (2.5.0)
       rspec-core (~> 2.5.0)
       rspec-expectations (~> 2.5.0)

data/README.md

@@ -4,8 +4,6 @@
 
 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.
 
-_It should be considered alpha._ I make no promises it won't all change underneath you. **It is all subject to change, and is in a rough state.**
-
 # 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:
@@ -54,8 +52,6 @@ $ cd path/to/site/directory
 $ serif generate
 ```
 
-(You may get warnings about "undefined method `gsub' for nil:NilClass" after a warning about trying to get headers out of a file. You should be able to ignore those.)
-
 ## Starting the admin server
 
 ```bash
@@ -126,7 +122,7 @@ This is where generated content gets saved. You should serve files out of here,
 
 ## `_layouts`
 
-This is where layouts for the site go. At the moment, there is only one supported: `default.html`.
+This is where layouts for the site go. The file `default.html` is used by default, and any file outside of `_posts` can override this by setting a `Layout: foo` header, which will use `_layouts/foo.html` instead.
 
 ## `_drafts` and `_posts`
 

data/lib/serif/draft.rb

@@ -13,7 +13,7 @@ class Draft < ContentFile
     publish_time = Time.now
     date = Time.now.strftime("%Y-%m-%d")
     filename = "#{date}-#{slug}"
-    full_published_path = File.expand_path("#{Post.dirname}/#{filename}")
+    full_published_path = File.expand_path("#{site.directory}/#{Post.dirname}/#{filename}")
 
     raise "conflict, post exists already" if File.exist?(full_published_path)
 

data/lib/serif/site.rb

@@ -181,7 +181,7 @@ class Site
 
     files = Dir["**/*"].select { |f| f !~ /\A_/ && File.file?(f) }
 
-    layout = Liquid::Template.parse(File.read("_layouts/default.html"))
+    default_layout = Liquid::Template.parse(File.read("_layouts/default.html"))
     posts = self.posts
 
     files.each do |path|
@@ -199,22 +199,21 @@ class Site
           title = nil
           layout_option = :default
 
-          begin
-            file_with_headers = Redhead::String[File.read(path)]
+          if Redhead::String.has_headers?(file)
+            file_with_headers = Redhead::String[file]
             title = file_with_headers.headers[:title] && file_with_headers.headers[:title].value
             layout_option = file_with_headers.headers[:layout] && file_with_headers.headers[:layout].value
+            layout_option ||= :default
 
             # all good? use the headered string
             file = file_with_headers
-          rescue => e
-            puts "Warning! Problem trying to get headers out of #{path}"
-            puts e
-            # stick with what we've got!
           end
 
           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))
             f.puts layout.render!("page" => { "title" => [title].compact }, "content" => Liquid::Template.parse(file.to_s).render!("site" => self))
           end
         end
@@ -227,11 +226,11 @@ class Site
       FileUtils.mkdir_p(tmp_path(File.dirname(post.url)))
 
       File.open(tmp_path(post.url + ".html"), "w") do |f|
-        f.puts layout.render!("page" => { "title" => ["Posts", "#{post.title}"] }, "content" => Liquid::Template.parse(File.read("_templates/post.html")).render!("post" => post))
+        f.puts default_layout.render!("page" => { "title" => ["Posts", "#{post.title}"] }, "content" => Liquid::Template.parse(File.read("_templates/post.html")).render!("post" => post))
       end
     end
 
-    generate_archives(layout)
+    generate_archives(default_layout)
 
     if Dir.exist?("_site")
       FileUtils.mv("_site", "/tmp/_site.#{Time.now.strftime("%Y-%m-%d-%H-%M-%S")}")

data/serif.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name         = "serif"
-  s.version      = "0.1.5"
+  s.version      = "0.1.6"
   s.authors      = ["Adam Prescott"]
   s.email        = ["adam@aprescott.com"]
   s.homepage     = "https://github.com/aprescott/serif"
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
     "redcarpet", "~> 2.2",
     "pygments.rb", "~> 0.3",
     "sinatra", "~> 1.3",
-    "redhead", "~> 0.0.6",
+    "redhead", "~> 0.0.8",
     "liquid", "~> 2.4",
     "slop", "~> 3.3"
   ].each_slice(2) do |name, version|

data/test/draft_spec.rb

@@ -30,6 +30,22 @@ describe Serif::Draft do
     end
   end
 
+  describe "publish!" do
+    it "moves the file to the _posts directory" do
+      draft = D.new(@site)
+      draft.slug = "test-draft"
+      draft.title = "Some draft title"
+      draft.save("some content")
+      draft.publish!
+
+      published_path = testing_dir("_posts/#{Date.today.to_s}-#{draft.slug}")
+      File.exist?(published_path).should be_true
+
+      # clean up
+      FileUtils.rm_f(published_path)
+    end
+  end
+
   describe "#save" do
     it "saves the file to _drafts" do
       draft = D.new(@site)

data/test/site_dir/_layouts/alt-layout.html

@@ -0,0 +1,3 @@
+<h1 id="layout" data-name="alternate-layout">Alternate layout</h1>
+
+{{ content }}

data/test/site_dir/_site/page-alt-layout.html

@@ -0,0 +1,3 @@
+<h1 id="layout" data-name="alternate-layout">Alternate layout</h1>
+
+page alt layout

data/test/site_dir/_site/page-header-but-no-layout.html

@@ -0,0 +1,6 @@
+<!doctype html>
+<meta charset="UTF-8">
+<title>My site: </title>
+<h1>mysite.com</h1>
+
+file containing headers but no layout option, to test that it still uses the default

data/test/site_dir/page-alt-layout.html

@@ -0,0 +1,3 @@
+layout: alt-layout
+
+page alt layout

data/test/site_dir/page-header-but-no-layout.html

@@ -0,0 +1,3 @@
+foo: bar
+
+file containing headers but no layout option, to test that it still uses the default

data/test/site_generation_spec.rb

@@ -13,4 +13,12 @@ describe Serif::Site do
     subject.generate
     File.exist?(testing_dir("_site/test-blog/sample-post.html")).should be_true
   end
+
+  it "reads the layout header for a non-post file and uses the appropriate layout file" do
+    subject.generate
+
+    # check it actually got generated
+    File.exist?(testing_dir("_site/page-alt-layout.html")).should be_true
+    File.read("_site/page-alt-layout.html").lines.first.should =~ /<h1.+?>Alternate layout<\/h1>/
+  end
 end

data/test/test_helper.rb

@@ -1,5 +1,7 @@
 require "simplecov"
-SimpleCov.start
+SimpleCov.start do
+  add_filter "/test/"
+end
 
 require "serif"
 require "fileutils"

metadata

@@ -1,247 +1,254 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: serif
-version: !ruby/object:Gem::Version 
-  hash: 4045805919941635790
+version: !ruby/object:Gem::Version
+  version: 0.1.6
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 5
-  version: 0.1.5
 platform: ruby
-authors: 
+authors:
 - Adam Prescott
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-12-16 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 4428665182548103036
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rack-rewrite
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1414572536435516772
-        segments: 
-        - 1
-        - 3
-        - 0
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack-rewrite
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 1.3.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: redcarpet
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 2242578857099950856
-        segments: 
-        - 2
-        - 2
-        version: "2.2"
+      - !ruby/object:Gem::Version
+        version: '2.2'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: pygments.rb
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3827694748118640887
-        segments: 
-        - 0
-        - 3
-        version: "0.3"
+      - !ruby/object:Gem::Version
+        version: '0.3'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: sinatra
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 2609263317959306961
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: redhead
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3599632081231604877
-        segments: 
-        - 0
-        - 0
-        - 6
-        version: 0.0.6
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: redhead
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.8
   type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: liquid
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3455750172089947295
-        segments: 
-        - 2
-        - 4
-        version: "2.4"
+      - !ruby/object:Gem::Version
+        version: '2.4'
   type: :runtime
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: slop
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 549110733678160813
-        segments: 
-        - 3
-        - 3
-        version: "3.3"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
   type: :runtime
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 2854635824043747355
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 2619393337634056284
-        segments: 
-        - 2
-        - 5
-        version: "2.5"
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :development
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1678417636739112038
-        segments: 
-        - 0
-        - 7
-        version: "0.7"
+      - !ruby/object:Gem::Version
+        version: '0.7'
   type: :development
-  version_requirements: *id011
-description: Serif is a simple file-based blogging system which generates static content and allows dynamic editing through an interface.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Serif is a simple file-based blogging system which generates static content
+  and allows dynamic editing through an interface.
+email:
 - adam@aprescott.com
-executables: 
+executables:
 - serif
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/serif.rb
-- lib/serif/post.rb
-- lib/serif/admin_server.rb
+files:
+- 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
-- statics/skeleton/index.html
-- statics/skeleton/_config.yml
-- statics/skeleton/archive.html
-- statics/assets/js/mousetrap.min.js
-- statics/assets/js/jquery.autosize.js
+- lib/serif.rb
 - 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/skeleton/_templates/post.html
+- statics/templates/admin/edit_post.liquid
+- statics/skeleton/index.html
 - statics/skeleton/_templates/archive_page.html
-- statics/skeleton/_layouts/default.html
-- statics/skeleton/_posts/2012-01-05-sample-post
+- statics/skeleton/_templates/post.html
 - statics/skeleton/_drafts/sample-draft
+- statics/skeleton/_config.yml
+- statics/skeleton/_posts/2012-01-05-sample-post
+- statics/skeleton/_layouts/default.html
+- statics/skeleton/archive.html
+- 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/liquid_filter_date_extension_spec.rb
-- test/site_generation_spec.rb
-- test/filters_spec.rb
 - test/site_dir/index.html
-- test/site_dir/_config.yml
-- test/site_dir/archive.html
-- test/site_dir/_templates/post.html
 - test/site_dir/_templates/archive_page.html
-- test/site_dir/_layouts/default.html
-- test/site_dir/_posts/2012-01-05-sample-post
+- test/site_dir/_templates/post.html
 - test/site_dir/_drafts/another-sample-draft
 - test/site_dir/_drafts/sample-draft
+- test/site_dir/page-alt-layout.html
+- test/site_dir/page-header-but-no-layout.html
+- test/site_dir/_config.yml
+- test/site_dir/_site/test-archive/2012/11/index.html
 - test/site_dir/_site/index.html
-- test/site_dir/_site/archive.html
-- test/site_dir/_trash/1355618409-test-draft
+- test/site_dir/_site/page-alt-layout.html
+- test/site_dir/_site/page-header-but-no-layout.html
 - test/site_dir/_site/test-blog/sample-post.html
-- test/site_dir/_site/test-archive/2012/11/index.html
+- test/site_dir/_site/archive.html
+- test/site_dir/_trash/1355714650-test-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/site_generation_spec.rb
+- test/post_spec.rb
 - serif.gemspec
 - rakefile
 - LICENSE
@@ -250,44 +257,35 @@ files:
 - README.md
 homepage: https://github.com/aprescott/serif
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2002549777813010636
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2002549777813010636
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Simple file-based blogging system.
-test_files: 
+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/site_generation_spec.rb
-- test/filters_spec.rb
+- test/post_spec.rb