serif 0.4 → 0.5

data/lib/serif/content_file.rb

@@ -23,6 +23,10 @@ class ContentFile
     end
   end
 
+  def basename
+    File.basename(@path)
+  end
+
   def slug=(str)
     @slug = str
 

data/lib/serif/draft.rb

@@ -11,6 +11,27 @@ class Draft < ContentFile
     File.rename("#{site.directory}/#{dirname}/#{original_slug}", "#{site.directory}/#{dirname}/#{new_slug}")
   end
 
+  # Returns the URL that would be used for this post if it were
+  # to be published now.
+  def url
+    permalink_style = headers[:permalink] || site.config.permalink
+
+    parts = {
+      "title" => slug.to_s,
+      "year" => Time.now.year.to_s,
+      "month" => Time.now.month.to_s.rjust(2, "0"),
+      "day" => Time.now.day.to_s.rjust(2, "0")
+    }
+
+    output = permalink_style
+
+    parts.each do |placeholder, value|
+      output = output.gsub(Regexp.quote(":" + placeholder), value)
+    end
+
+    output
+  end
+
   def delete!
     FileUtils.mkdir_p("#{site.directory}/_trash")
     File.rename(@path, File.expand_path("#{site.directory}/_trash/#{Time.now.to_i}-#{slug}"))
@@ -33,7 +54,7 @@ class Draft < ContentFile
     File.rename(path, full_published_path)
 
     # update the path since the file has now changed
-    @path = Post.from_slug(site, slug).path
+    @path = Post.new(site, full_published_path).path
   end
 
   # if the assigned value is truthy, the "publish" header
@@ -63,7 +84,8 @@ class Draft < ContentFile
       "slug" => slug,
       "type" => "draft",
       "draft" => draft?,
-      "published" => published?
+      "published" => published?,
+      "url" => url
     }
 
     headers.each do |key, value|

data/lib/serif/errors.rb

@@ -0,0 +1,10 @@
+module Serif
+  # General error class. Allows capturing general errors
+  # applicable only to Serif.
+  class Error < RuntimeError; end
+
+  # Represents a conflict between published posts and drafts.
+  # This should be used whenever two posts would occupy the same
+  # URL / file path.
+  class PostConflictError < Error; end
+end

data/lib/serif/post.rb

@@ -62,8 +62,8 @@ class Post < ContentFile
     files.map { |f| new(site, f) }
   end
 
-  def self.from_slug(site, slug)
-    all(site).find { |p| p.slug == slug }
+  def self.from_basename(site, filename)
+    all(site).find { |p| p.basename == filename }
   end
 
   def to_liquid
@@ -76,7 +76,8 @@ class Post < ContentFile
       "url" => url,
       "type" => "post",
       "draft" => draft?,
-      "published" => published?
+      "published" => published?,
+      "basename" => basename
     }
 
     headers.each do |key, value|

data/lib/serif/site.rb

@@ -1,11 +1,13 @@
 
-module Liquid::StandardFilters
+module Liquid #:nodoc:#
+module StandardFilters #:nodoc:#
   alias_method :date_orig, :date
 
   def date(input, format)
     input == "now" ? date_orig(Time.now, format) : date_orig(input, format)
   end
 end
+end
 
 module Serif
 module Filters
@@ -225,6 +227,67 @@ class Site
     h
   end
 
+  # Returns a hash representing any conflicting URLs,
+  # in the form
+  #
+  #     { "/url_1" => [e_1, e_2, ..., e_n], ... }
+  #
+  # The elements e_i are the conflicting Post and
+  # Draft instances that share the URL "/url_1".
+  #
+  # Note that if n = 1 (that is, the array value is
+  # [e_1], containing a single element), then it is
+  # not included in the Hash, since it does not
+  # contribute to a conflict.
+  #
+  # If there are no conflicts found, returns nil.
+  #
+  # If an argument is specified, its #url value is
+  # compared against all post and draft URLs, and
+  # the value returned is either:
+  #
+  # 1. an array of post/draft instances that
+  #    conflict, _including_ the argument given; or,
+  # 2. nil if there is no conflict.
+  def conflicts(content_to_check = nil)
+    if content_to_check
+      content = drafts + posts + [content_to_check]
+
+      # In the event that the given argument is actually one of the
+      # drafts + posts, we need to de-duplicate, otherwise our return
+      # value will contain two of the same Draft/Post, which isn't
+      # actually a conflict.
+      #
+      # So to do that, we can use the path on the filesystem. However,
+      # we can't just rely on calling #path, because if content_to_check
+      # doesn't have a #path value, it'll be nil and it's possible that
+      # we might expand checking to multiple files/Drafts/Posts.
+      #
+      # Thus, if #path is nil, simply rely on object_id.
+      #
+      # FIXME: Replace this with a proper implementation of
+      # ContentFile equality/hashing.
+      content.uniq! { |e| e.path ? e.path : e.object_id }
+
+      conflicts = content.select { |e| e.url == content_to_check.url }
+
+      if conflicts.length <= 1
+        return nil
+      else
+        return conflicts
+      end
+    end
+
+    conflicts = (drafts + posts).group_by { |e| e.url }
+    conflicts.reject! { |k, v| v.length == 1 }
+
+    if conflicts.empty?
+      nil
+    else
+      conflicts
+    end
+  end
+
   def to_liquid
     @liquid_cache_store ||= TimeoutCache.new(1)
 
@@ -249,6 +312,10 @@ class Site
 
     default_layout = Liquid::Template.parse(File.read("_layouts/default.html"))
 
+    if conflicts
+      raise PostConflictError, "Generating would cause a conflict."
+    end
+
     # preprocess any drafts marked for autopublish, before grabbing the posts
     # to operate on.
     preprocess_autopublish_drafts
@@ -292,7 +359,7 @@ class Site
               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))
+            f.puts layout.render!("site" => self, "page" => { "title" => title }, "content" => Liquid::Template.parse(file.to_s).render!("site" => self))
           end
         end
       end
@@ -323,13 +390,15 @@ class Site
         # variables available in the post template
         post_template_variables = {
           "post" => post,
+          "post_page" => true,
           "prev_post" => prev_post,
           "next_post" => next_post
         }
 
         f.puts post_layout.render!(
           "site" => self,
-          "page" => { "title" => ["Posts", "#{post.title}"] },
+          "page" => { "title" => post.title },
+          "post_page" => true,
           "content" => Liquid::Template.parse(File.read("_templates/post.html")).render!(post_template_variables)
         )
       end
@@ -393,7 +462,7 @@ class Site
         f.puts layout.render!(
           "site" => self,
           "draft_preview" => true,
-          "page" => { "title" => [ "Draft Preview", draft.title ] },
+          "page" => { "title" => draft.title },
           "content" => template.render!("site" => self, "post" => draft, "draft_preview" => true)
         )
       end

data/rakefile

@@ -2,6 +2,7 @@ require "rake"
 require "time"
 require "rspec/core/rake_task"
 require "benchmark"
+require "rdoc/task"
 
 RSpec::Core::RakeTask.new(:test) do |t|
   t.rspec_opts = "-I test --color --format nested"
@@ -12,6 +13,15 @@ end
 
 task :default => :test
 
+Rake::RDocTask.new(:docs) do |rd|
+  rd.main = "README.md"
+  rd.rdoc_dir = "docs"
+  rd.rdoc_files.include("README.md", "lib/**/*.rb")
+  rd.options << "--markup=markdown"
+end
+
+task :rdoc => :docs
+
 task :stress, [:n] do |t, args|
   iterations = args[:n] || 250
   iterations = iterations.to_i

data/serif.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.name         = "serif"
-  s.version      = "0.4"
+  s.version      = "0.5"
   s.authors      = ["Adam Prescott"]
   s.email        = ["adam@aprescott.com"]
   s.homepage     = "https://github.com/aprescott/serif"
-  s.summary      = "Markdown-powered blogging with an optional admin interface with drag-and-drop image uploading."
-  s.description  = "Serif is a blogging system powered by markdown files and an optional admin interface complete with drag-and-drop image uploading."
+  s.summary      = "Static site generator and markdown-based blogging with an optional admin interface complete with drag-and-drop image uploading."
+  s.description  = "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."
   s.files        = Dir["{lib/**/*,statics/**/*,bin/*,test/**/*}"] + %w[serif.gemspec rakefile LICENSE Gemfile Gemfile.lock README.md]
   s.require_path = "lib"
   s.bindir       = "bin"
@@ -30,4 +30,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rspec", "~> 2.5")
   s.add_development_dependency("simplecov", "~> 0.7")
   s.add_development_dependency("timecop", "~> 0.6.1")
+  s.add_development_dependency("rdoc", "~> 4.0.0")
+  s.add_development_dependency("coveralls")
 end

data/statics/skeleton/_layouts/default.html

@@ -1,6 +1,6 @@
 <!doctype html>
 <meta charset="UTF-8">
-<title>My site: {% if page.title and page.title != empty %}{{ page.title | join:" - " }}{% endif %}</title>
+<title>My site: {{ page.title }}</title>
 <h1>mysite.com</h1>
 
 {{ content }}

data/statics/templates/admin/bookmarks.liquid

@@ -25,17 +25,17 @@ compress me!
 -->
 {% endcomment %}
 
-{% capture compressed_js %}
-
-(function(){var e,n,t,o;n=location.href,document.getSelection?(t=document.getSelection(),""==""+t?t="":(t=t.getRangeAt(0).cloneContents(),o=document.createElement("div"),o.appendChild(t),t=o.innerHTML)):t="",e=document.title,window.location.href="[BASE_URL]url="+encodeURIComponent(n)+"&content="+encodeURIComponent(t)+"&title="+encodeURIComponent(e)})();
-
-{% endcapture %}
-
-{% assign compressed_js = compressed_js | strip | replace:'"',"'" | prepend: "javascript:" %}
-{% assign non_edit_url = base_url | append:"/admin/quick-draft?" %}
-{% assign edit_now_url = non_edit_url | append:"edit=1&" %}
-{% assign js_later = compressed_js | replace:"[BASE_URL]",non_edit_url %}
-{% assign js_now   = compressed_js | replace:"[BASE_URL]",edit_now_url %}
+<script>
+var compressed_js = 'javascript:(function(){var e,n,t,o;n=location.href,document.getSelection?(t=document.getSelection(),""==""+t?t="":(t=t.getRangeAt(0).cloneContents(),o=document.createElement("div"),o.appendChild(t),t=o.innerHTML)):t="",e=document.title,window.location.href="[BASE_URL]url="+encodeURIComponent(n)+"&content="+encodeURIComponent(t)+"&title="+encodeURIComponent(e)})();';
+var base_url = window.location.protocol + "//" + window.location.host + "/admin/quick-draft?";
+var js_now = compressed_js.replace('[BASE_URL]', base_url + "edit=1&");
+var js_later = compressed_js.replace('[BASE_URL]', base_url);
+
+$(function() {
+	$("[data-bookmark-later]").attr("href", js_later);
+	$("[data-bookmark-now]").attr("href", js_now);
+});
+</script>
 
 <section id="bookmarks">
 	<h2>Bookmarks</h2>
@@ -44,13 +44,17 @@ compress me!
 
 	<p>Any selected text will go in as Markdown, ready for editing!</p>
 
+	<noscript>
+		<p><strong>You need to enable JavaScript!</strong></p>
+	</noscript>
+
 	<hr>
 
-	<p class="bookmark"><a href="{{ js_later }}">Save draft for later</a></p>
+	<p class="bookmark"><a href="#" data-bookmark-later>Save draft for later</a></p>
 
 	<p>Saves the current page as a draft. Takes you straight back to where you were so you can keep reading.</p>
 
-	<p class="bookmark"><a href="{{ js_now }}">Save draft and edit</a></p>
+	<p class="bookmark"><a href="#" data-bookmark-now>Save draft and edit</a></p>
 
 	<p>Saves the current page as a draft and lets you start editing immediately.</p>
 </section>

data/statics/templates/admin/edit_draft.liquid

@@ -15,7 +15,7 @@
 	</h2>
 
 	<h2 id="private-url">
-		<code><span>preview:</span> <a href="{{ private_url }}">{% assign parts = private_url | split:"/" %}/{{ parts[1] }}/{{ parts[2] }}/{{ parts[3] | truncate: 10, '' }}&hellip;</a></code>
+		<code><span>preview:</span> {% if private_url %}<a href="{{ private_url }}">{% assign parts = private_url | split:"/" %}/{{ parts[1] }}/{{ parts[2] }}/{{ parts[3] | truncate: 10, '' }}&hellip;</a>{% else %}(none){% endif %}</code>
 	</h2>
 
 	<div class="post{% if post.draft %} draft{% endif %}">

data/statics/templates/admin/edit_post.liquid

@@ -6,7 +6,7 @@
 
 <div id="edit">
 <form action="/admin/edit/posts" method="post">
-	<input type="hidden" name="original_slug" value="{{ post.slug | escape }}">
+	<input type="hidden" name="original_basename" value="{{ post.basename | escape }}">
 
 	<h2 id="slug">
 		<code>

data/statics/templates/admin/index.liquid

@@ -4,7 +4,7 @@
 
 <ul>
 {% for draft in drafts %}
-	<li><a href="/admin/edit/drafts/{{ draft.slug }}">{% if draft.slug != empty %}{{ draft.slug }}{% else %}<em>(untitled)</em>{% endif %}</a></li>
+	<li><a href="/admin/edit/drafts/{{ draft.slug }}">{{ draft.slug }}</a></li>
 {% endfor %}
 </ul>
 
@@ -14,6 +14,6 @@
 
 <ul>
 {% for post in posts %}
-	<li><a href="/admin/edit/posts/{{ post.slug }}">{% if post.title != empty %}{{ post.title }}{% else %}<em>(untitled)</em>{% endif %}</a></li>
+	<li><a href="/admin/edit/posts/{{ post.basename }}">{{ post.title | smarty }}</a></li>
 {% endfor %}
 </ul>

data/statics/templates/admin/layout.liquid

@@ -547,6 +547,22 @@ body > nav ul li:last-child {
 		</ul>
 	</nav>
 
+	{% if conflicts %}
+		<p>The following URLs have conflicts and must be resolved:</p>
+		<ul>
+		{% for conflict in conflicts %}
+			<li>
+				{{ conflict[0] | escape }}
+				<ul>
+					{% for conflicting_content in conflict[1] %}
+						<li>{% if conflicting_content.draft %}Draft{% else %}Post{% endif %}: {{ conflicting_content.title | escape }}</li>
+					{% endfor %}
+				</ul>
+			</li>
+		{% endfor %}
+		</ul>
+	{% endif %}
+
 	{{ content }}
 
 	<div id="shortcuts">

data/test/commands_spec.rb

@@ -0,0 +1,77 @@
+require "test_helper"
+
+class Serif::Commands
+  def exit(code)
+    "Fake exit with code #{code}"
+  end
+end
+
+describe Serif::Commands do
+  def expect_method_call(arg, method)
+    c = Serif::Commands.new([arg])
+    c.should_receive(method)
+    capture_stdout { c.process }
+  end
+
+  describe "#process" do
+    it "takes -h and --help and calls print usage" do
+      %w[-h --help].each do |cmd|
+        expect_method_call(cmd, :print_help)
+      end
+    end
+
+    {
+      "admin"    => :initialize_admin_server,
+      "dev"      => :initialize_dev_server,
+      "new"      => :produce_skeleton,
+      "generate" => :generate_site
+    }.each do |command, meth|
+      it "takes the command '#{command}' and runs #{meth}" do
+        expect_method_call(command, meth)
+      end
+    end
+
+    it "exits on help" do
+      expect_method_call("-h", :exit)
+    end
+  end
+
+  describe "#generate_site" do
+    it "calls Site#generate" do
+      Serif::Site.stub(:generation_called)
+      Serif::Site.any_instance.stub(:generate) { Serif::Site.generation_called }
+
+      # if this is called, it means any instance of Site had #generate called.
+      Serif::Site.should_receive(:generation_called)
+
+      Serif::Commands.new([]).generate_site("anything")
+    end
+
+    context "with a conflict" do
+      def conflicting_generate_command
+        a = b = double("")
+        a.stub(:url) { "/foo" }
+        b.stub(:url) { "/foo" }
+        a.stub(:path) { "/anything" }
+        b.stub(:path) { "/anything" }
+
+        # any non-nil value will do
+        Serif::Site.any_instance.stub(:conflicts) { { "/foo" => [a, b] } }
+
+        command = Serif::Commands.new([])
+        command.generate_site(testing_dir)
+        command.should_receive(:exit)
+        command
+      end
+
+      it "exits" do
+        capture_stdout { conflicting_generate_command.process }
+      end
+
+      it "prints the urls that conflict" do
+        output = capture_stdout { conflicting_generate_command.process }
+        output.should match(/Conflicts at:\n\n\/foo\n\t\/anything\n\t\/anything/)
+      end
+    end
+  end
+end