serif 0.1.6 → 0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    serif (0.1.5)
+    serif (0.1.6)
       liquid (~> 2.4)
       pygments.rb (~> 0.3)
       rack (~> 1.0)
@@ -18,7 +18,7 @@ GEM
     liquid (2.4.1)
     multi_json (1.5.0)
     posix-spawn (0.3.6)
-    pygments.rb (0.3.2)
+    pygments.rb (0.3.3)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.1.0)
     rack (1.4.1)
@@ -46,6 +46,7 @@ GEM
       tilt (~> 1.3, >= 1.3.3)
     slop (3.3.3)
     tilt (1.3.3)
+    timecop (0.5.5)
     yajl-ruby (1.1.0)
 
 PLATFORMS
@@ -56,3 +57,4 @@ DEPENDENCIES
   rspec (~> 2.5)
   serif!
   simplecov (~> 0.7)
+  timecop (~> 0.5.5)

data/README.md

@@ -218,6 +218,19 @@ In both cases, the output is, of course:
 
 If you have a file like `feed.xml` that you wish to _not_ be contained within a layout, specify `layout: none` in the header for the file.
 
+# Publishing drafts
+
+To publish a draft, either do so through the admin interface available with `serif admin`, or add a `publish: now` header to the draft:
+
+```
+title: A draft that will be published
+publish: now
+
+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.
+
 # 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.

data/lib/serif/draft.rb

@@ -1,5 +1,7 @@
 module Serif
 class Draft < ContentFile
+  attr_reader :autopublish
+
   def self.dirname
     "_drafts"
   end
@@ -18,9 +20,37 @@ class Draft < ContentFile
     raise "conflict, post exists already" if File.exist?(full_published_path)
 
     set_publish_time(publish_time)
+
+    @source.headers.delete(:publish) if autopublish?
+
     save
 
     File.rename(path, full_published_path)
+
+    # update the path since the file has now changed
+    @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
+  end
+
+  # Checks the value of the "publish" header, and returns
+  # true if the value is "now", ignoring trailing and leading
+  # whitespace. Returns false, otherwise.
+  def autopublish?
+    publish_header = headers[:publish]
+    publish_header && publish_header.strip == "now"
   end
 
   def to_liquid

data/lib/serif/site.rb

@@ -182,6 +182,11 @@ class Site
     files = Dir["**/*"].select { |f| f !~ /\A_/ && File.file?(f) }
 
     default_layout = Liquid::Template.parse(File.read("_layouts/default.html"))
+
+    # preprocess any drafts marked for autopublish, before grabbing the posts
+    # to operate on.
+    preprocess_autopublish_drafts
+
     posts = self.posts
 
     files.each do |path|
@@ -242,6 +247,18 @@ class Site
 
   private
 
+  # goes through all draft posts that have "publish: now" headers and
+  # calls #publish! on each one
+  def preprocess_autopublish_drafts
+    puts "Beginning pre-process step for drafts."
+    drafts.each do |d|
+      if d.autopublish?
+        puts "Autopublishing draft: #{d.title} / #{d.slug}"
+        d.publish!
+      end
+    end
+  end
+
   # Uses config.archive_url_format to generate pages
   # using the archive_page.html template.
   def generate_archives(layout)

data/serif.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name         = "serif"
-  s.version      = "0.1.6"
+  s.version      = "0.2"
   s.authors      = ["Adam Prescott"]
   s.email        = ["adam@aprescott.com"]
   s.homepage     = "https://github.com/aprescott/serif"
@@ -28,4 +28,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rake", "~> 0.9")
   s.add_development_dependency("rspec", "~> 2.5")
   s.add_development_dependency("simplecov", "~> 0.7")
+  s.add_development_dependency("timecop", "~> 0.5.5")
 end

data/test/draft_spec.rb

@@ -44,6 +44,78 @@ describe Serif::Draft do
       # clean up
       FileUtils.rm_f(published_path)
     end
+
+    it "changes the #path to be _posts not _drafts" do
+      draft = D.new(@site)
+      draft.slug = "test-draft"
+      draft.title = "Some draft title"
+      draft.save("some content")
+      draft.publish!
+
+      draft.path.should == testing_dir("_posts/#{Date.today.to_s}-#{draft.slug}")
+      draft.delete! # still deleteable, even though it's been moved
+    end
+
+    it "does not write out an autopublish header if autopublish? is true" do
+      draft = D.new(@site)
+      draft.slug = "autopublish-draft"
+      draft.title = "Some draft title"
+      draft.autopublish = true
+      draft.save("some content")
+      draft.publish!
+
+      # check the header on the object has been removed
+      draft.autopublish?.should be_false
+
+      # check the actual file doesn't have the header
+      Serif::Post.from_slug(@site, draft.slug).headers[:publish].should be_nil
+
+      draft.delete!
+    end
+  end
+
+  describe "#autopublish=" do
+    it "sets the 'publish' header to 'now' if truthy assigned value" do
+      draft = D.new(@site)
+      draft.slug = "test-draft"
+      draft.title = "Some draft title"
+      draft.save("some content")
+      draft.autopublish = true
+
+      draft.headers[:publish].should == "now"
+
+      draft.delete!
+    end
+
+    it "removes the 'publish' header entirely if falsey assigned value" do
+      draft = D.new(@site)
+      draft.slug = "test-draft"
+      draft.title = "Some draft title"
+      draft.save("some content")
+      draft.autopublish = false
+
+      draft.headers.key?(:publish).should be_false
+
+      draft.delete!
+    end
+  end
+
+  describe "#autopublish?" do
+    it "returns true if there is a 'publish: now' header, otherwise false" do
+      draft = D.new(@site)
+      draft.autopublish?.should be_false
+      headers = draft.headers
+      draft.stub(:headers) { headers.merge(:publish => "now") }
+      draft.autopublish?.should be_true
+    end
+
+    it "ignores leading and trailing whitespace around the value of the 'publish' header" do
+      draft = D.new(@site)
+      draft.autopublish?.should be_false
+      headers = draft.headers
+      draft.stub(:headers) { headers.merge(:publish => " now  ") }
+      draft.autopublish?.should be_true
+    end
   end
 
   describe "#save" do

data/test/site_dir/_site/archive.html

@@ -5,6 +5,10 @@
 
 
 	
+		<h1>
+			<a href="/test-archive/2012/12">December 2012</a>
+		</h1>
+	
 		<h1>
 			<a href="/test-archive/2012/11">November 2012</a>
 		</h1>

data/test/site_dir/_site/index.html

@@ -5,10 +5,12 @@
 
 <h2>Posts</h2>
 
-<p>There are 1 posts:</p>
+<p>There are 2 posts:</p>
 
 <ul>
 	
+		<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/sample-post">Sample post</a> (posted 2012-11-21T17:07:09+00:00)</li>
 	
 </ul>

data/test/site_dir/_site/test-archive/2012/12/index.html

@@ -0,0 +1,14 @@
+<!doctype html>
+<meta charset="UTF-8">
+<title>My site: </title>
+<h1>mysite.com</h1>
+
+<h1>Dec 2012 (1)</h1>
+
+<ul>
+	
+		<li>
+			<a href="/test-blog/post-to-be-published-on-generate">Some draft title</a>
+		</li>
+	
+</ul>

data/test/site_dir/_site/test-blog/post-to-be-published-on-generate.html

@@ -0,0 +1,10 @@
+<!doctype html>
+<meta charset="UTF-8">
+<title>My site: Posts - Some draft title</title>
+<h1>mysite.com</h1>
+
+<h2>Some draft title</h2>
+
+<p>some content</p>
+
+<p><a href="http://twitter.com/share?text=Some+draft+title&amp;url=http%3A%2F%2Fwww.mysite.com%2Ftest-blog%2Fpost-to-be-published-on-generate">Submit this to Twitter.</p>

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

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

data/test/site_generation_spec.rb

@@ -9,16 +9,62 @@ describe Serif::Site do
     FileUtils.rm_rf(testing_dir("_site"))
   end
 
-  it "uses the permalinks in the config file for site generation" do
-    subject.generate
-    File.exist?(testing_dir("_site/test-blog/sample-post.html")).should be_true
-  end
+  describe "site generation" do
+    it "uses the permalinks in the config file for site generation" 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
+
+    context "for drafts with a publish: now header" do
+      before :all do
+        @time = Time.utc(2012, 12, 21, 15, 30, 00)
+
+        draft = D.new(subject)
+        draft.slug = "post-to-be-published-on-generate"
+        draft.title = "Some draft title"
+        draft.autopublish = true
+        draft.save("some content")
+
+        @post = Serif::Draft.from_slug(subject, draft.slug)
+        @post.should_not be_nil
+
+        # verifies that the header has actually been written to the file, since
+        # we round-trip the save and load.
+        @post.autopublish?.should be_true
+
+        # Site#generate creates a backup of the site directory in /tmp
+        # and uses a timestamp, which is now fixed across all tests,
+        # so we have to remove it first.
+        FileUtils.rm_rf("/tmp/_site.2012-12-21-15-30-00")
+
+        Timecop.freeze(@time)
+      end
+
+      after :all do
+        Timecop.return
+
+        # the generate processes creates its own set of instances, so the
+        # value of #path here would be stale if we were to call @post.path
+        FileUtils.rm(Serif::Post.from_slug(subject, @post.slug).path)
+      end
 
-  it "reads the layout header for a non-post file and uses the appropriate layout file" do
-    subject.generate
+      it "places the file in the published posts folder" do
+        subject.generate
+        File.exist?(testing_dir("_site/test-blog/#{@post.slug}.html")).should be_true
+      end
 
-    # 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>/
+      it "marks the creation time as the current time" do
+        subject.generate
+        Serif::Post.from_slug(subject, @post.slug).created.should == @time
+      end
+    end
   end
 end

data/test/test_helper.rb

@@ -8,6 +8,7 @@ require "fileutils"
 require "pathname"
 require "time"
 require "date"
+require "timecop"
 
 def testing_dir(path = nil)
   full_path = File.join(File.dirname(__FILE__), "site_dir")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serif
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2013-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -187,6 +187,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.5
 description: Serif is a simple file-based blogging system which generates static content
   and allows dynamic editing through an interface.
 email:
@@ -196,59 +212,62 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/serif/content_file.rb
-- lib/serif/server.rb
-- lib/serif/markup_renderer.rb
+- lib/serif.rb
 - lib/serif/post.rb
-- lib/serif/config.rb
 - lib/serif/admin_server.rb
+- lib/serif/server.rb
+- lib/serif/config.rb
 - lib/serif/draft.rb
+- lib/serif/markup_renderer.rb
 - lib/serif/site.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
+- lib/serif/content_file.rb
 - statics/skeleton/index.html
-- statics/skeleton/_templates/archive_page.html
 - statics/skeleton/_templates/post.html
-- statics/skeleton/_drafts/sample-draft
+- statics/skeleton/_templates/archive_page.html
 - statics/skeleton/_config.yml
-- statics/skeleton/_posts/2012-01-05-sample-post
 - statics/skeleton/_layouts/default.html
+- statics/skeleton/_posts/2012-01-05-sample-post
+- statics/skeleton/_drafts/sample-draft
 - 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/filters_spec.rb
-- test/config_spec.rb
-- test/liquid_filter_date_extension_spec.rb
+- test/post_spec.rb
 - test/site_spec.rb
 - test/draft_spec.rb
-- test/markup_renderer_spec.rb
+- test/config_spec.rb
 - test/site_dir/index.html
-- test/site_dir/_templates/archive_page.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/_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/test-blog/sample-post.html
+- test/site_dir/_site/test-blog/post-to-be-published-on-generate.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/sample-post.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/_trash/1357137277-autopublish-draft
+- test/site_dir/_trash/1357137277-test-draft
+- test/site_dir/page-header-but-no-layout.html
 - test/site_dir/archive.html
+- test/markup_renderer_spec.rb
+- test/liquid_filter_date_extension_spec.rb
 - test/site_generation_spec.rb
-- test/post_spec.rb
+- test/filters_spec.rb
 - serif.gemspec
 - rakefile
 - LICENSE
@@ -281,11 +300,11 @@ specification_version: 3
 summary: Simple file-based blogging system.
 test_files:
 - test/test_helper.rb
-- test/filters_spec.rb
-- test/config_spec.rb
-- test/liquid_filter_date_extension_spec.rb
+- test/post_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/post_spec.rb
+- test/filters_spec.rb