serif 0.1.2 → 0.1.3

data/Gemfile.lock

@@ -1,26 +1,21 @@
 PATH
   remote: .
   specs:
-    serif (0.1.1)
+    serif (0.1.2)
       liquid (~> 2.4)
       pygments.rb (~> 0.3)
       rack (~> 1.0)
+      rack-rewrite (~> 1.3.0)
       rake (~> 0.9)
       redcarpet (~> 2.2)
       redhead (~> 0.0.6)
       sinatra (~> 1.3)
       slop (~> 3.3)
-      yui-compressor
 
 GEM
   remote: http://rubygems.org/
   specs:
-    POpen4 (0.1.4)
-      Platform (>= 0.4.0)
-      open4
-    Platform (0.4.0)
     liquid (2.4.1)
-    open4 (1.3.0)
     posix-spawn (0.3.6)
     pygments.rb (0.3.2)
       posix-spawn (~> 0.3.6)
@@ -28,6 +23,7 @@ GEM
     rack (1.4.1)
     rack-protection (1.2.0)
       rack
+    rack-rewrite (1.3.1)
     rake (0.9.2.2)
     redcarpet (2.2.2)
     redhead (0.0.6)
@@ -38,8 +34,6 @@ GEM
     slop (3.3.3)
     tilt (1.3.3)
     yajl-ruby (1.1.0)
-    yui-compressor (0.9.6)
-      POpen4 (>= 0.1.4)
 
 PLATFORMS
   ruby

data/README.md

@@ -95,7 +95,8 @@ The structure of a Serif site is something like this:
 │   ├── 2012-02-28-another-post
 │   └── 2012-03-30-and-a-third
 ├── _templates
-│   └─── post.html
+│   ├─── post.html
+│   └─── archive_page.html
 ├── _trash
 ├── _config.yml
 ├── css
@@ -147,7 +148,12 @@ The headers are similar to Jekyll's YAML front matter, but here there are no for
 
 ## `_templates`
 
-This directory currently only has a single file in it, `post.html`, which is used to produce HTML content from Markdown files in `_posts`.
+Two templates are available:
+
+* `post.html`, which will be used to render individual post pages.
+* `archive_page.html`, which will be used to render individual archive pages.
+
+Both must be valid Liquid templates.
 
 ## `_trash`
 
@@ -207,6 +213,59 @@ 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.
 
+# 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.
+
+Within the `archive_page.html` template, you have access to the variables `month`, which is a Ruby Date instance, and `posts` for the posts within that month.
+
+To disable archive pages, or configure the URL format, see the section on configuration.
+
+## Linking to archive pages
+
+To link to archive pages, there is a `site.archives` template variable available in all pages. The structure of `site.archives` is a nested map starting at years:
+
+```
+{
+  "posts" => [...],
+  "years" => [
+    {
+      "date" => Date.new(2012),
+      "posts" => [...],
+      "months" => [
+        { "date" => Date.new(2012, 12), "archive_url" => "/archive/2012/12", "posts" => [...] },
+        { "date" => Date.new(2012, 11), "archive_url" => "/archive/2012/11", "posts" => [...] },
+        ...
+      ]
+    }
+  ]
+}
+```
+
+Using `site.archives`, you can iterate over `years`, then iterate over `months` and use `archive_url` to link to the archive page for that given month within the year.
+
+# Configuration
+
+Configuration goes in `_config.yml` and must be valid YAML. Here's a sample configuration with available options:
+
+```
+admin:
+  username: myusername
+  password: mypassword
+permalink: /posts/:title
+archive:
+  enabled: yes
+  url_format: /archive/:year/:month
+```
+
+`admin` contains the credentials used when accessing the admin interface. This information is private, of course.
+
+`permalink` is the URL format for individual post pages. The default permalink value is `/:title`. For an explanation of the format of permalinks, see above.
+
+`archive` contains configuration options concerning archive pages. `enabled` can be used to toggle whether archive pages are generated. If set to `no` or `false`, no archive pages will be generated. By default, this value is `yes`.
+
+The `archive` `url_format` configuration option is the format used for archive pages. The default value is `/archive/:year/:month`. **This must include both year and month.** Visiting, e.g., `/archive/2012/11` would render posts made in November 2012. See the section on archive pages above for more details.
+
 # Deploying
 
 To serve the site, set any web server to use `/path/to/site/directory/_site` as its root. *NOTE:* URLs generated in the site do not contain `.html` "extensions" by default, so you will need a rewrite rule. Here's an example rewrite for nginx:

data/lib/serif/config.rb

@@ -21,5 +21,19 @@ class Config
   def permalink
     yaml["permalink"] || "/:title"
   end
+
+  def archive_enabled?
+    a = yaml["archive"]
+
+    if a
+      a["enabled"]
+    else
+      false
+    end
+  end
+
+  def archive_url_format
+    (yaml["archive"] || {})["url_format"] || "/archive/:year/:month"
+  end
 end
 end

data/lib/serif/server.rb

@@ -13,7 +13,16 @@ class DevelopmentServer
 
     # it seems Rack::Rewrite doesn't like public_folder files, so here we are
     get "*" do
-      File.read(Dir[File.expand_path("_site#{params[:splat].join("/")}.*")].first)
+      # attempt the exact name + an extension
+      file = Dir[File.expand_path("_site#{params[:splat].join("/")}.*")].first
+
+      # try index.html under the directory if it failed. useful for archive directory requests.
+      file ||= Dir[File.expand_path("_site#{params[:splat].join("/")}/index.html")].first
+
+      # make a naive assumption that there's a 404 file at 404.html
+      file ||= Dir[File.expand_path("_site/404.html")].first
+
+      File.read(file)
     end
   end
 

data/lib/serif/site.rb

@@ -19,6 +19,7 @@ else
   end
 end
 
+module Serif
 module Filters
   def strip(input)
     input.strip
@@ -36,8 +37,9 @@ module Filters
     input.xmlschema
   end
 end
+end
 
-Liquid::Template.register_filter(Filters)
+Liquid::Template.register_filter(Serif::Filters)
 
 module Serif
 class Site
@@ -49,8 +51,10 @@ class Site
     @source_directory
   end
 
+  # Returns all of the site's posts, in reverse chronological order
+  # by creation time.
   def posts
-    Post.all(self)
+    Post.all(self).sort_by { |entry| entry.created }.reverse
   end
 
   def drafts
@@ -78,7 +82,97 @@ class Site
     !%w[.html .xml].include?(File.extname(filename))
   end
 
-  # TODO: fix all these File.join calls
+  # Returns the relative archive URL for the given date,
+  # using the value of config.archive_url_format
+  def archive_url_for_date(date)
+    format = config.archive_url_format
+
+    parts = {
+      "year" => date.year.to_s,
+      "month" => date.month.to_s.rjust(2, "0")
+    }
+
+    output = format
+
+    parts.each do |placeholder, value|
+      output = output.gsub(Regexp.quote(":" + placeholder), value)
+    end
+
+    output
+  end
+
+  # Returns a nested hash with the following structure:
+  #
+  # {
+  #   :posts => [],
+  #   :years => [
+  #     {
+  #       :date => Date.new(2012),
+  #       :posts => [],
+  #       :months => [
+  #         { :date => Date.new(2012, 12), :archive_url => "/archive/2012/12", :posts => [] },
+  #         { :date => Date.new(2012, 11), :archive_url => "/archive/2012/11", :posts => [] },
+  #         # ...
+  #       ]
+  #     },
+  #
+  #     # ...
+  #  ]
+  # }
+  def archives
+    h = {}
+    h[:posts] = posts
+
+    # group posts by Date instances for the first day of the year
+    year_groups = posts.group_by { |post| Date.new(post.created.year) }.to_a
+
+    # collect all elements as maps for the year start date and the posts in that year
+    year_groups.map! do |year_start_date, posts_by_year|
+      {
+        :date => year_start_date,
+        :posts => posts_by_year.sort_by { |post| post.created }
+      }
+    end
+
+    year_groups.sort_by! { |year_hash| year_hash[:date] }
+    year_groups.reverse!
+
+    year_groups.each do |year_hash|
+      year_posts = year_hash[:posts]
+
+      # group the posts in the year by month
+      month_groups = year_posts.group_by { |post| Date.new(post.created.year, post.created.month) }.to_a
+
+      # collect the elements as maps for the month start date and the posts in that month
+      month_groups.map! do |month_start_date, posts_by_month|
+        {
+          :date => month_start_date,
+          :posts => posts_by_month.sort_by { |post| post.created },
+          :archive_url => archive_url_for_date(month_start_date)
+        }
+      end
+
+      month_groups.sort_by! { |month_hash| month_hash[:date] }
+      month_groups.reverse!
+
+      # set the months for the current year
+      year_hash[:months] = month_groups
+    end
+
+    h[:years] = year_groups
+
+    # return the final hash
+    h
+  end
+
+  def to_liquid
+    {
+      "posts" => posts,
+      "latest_update_time" => latest_update_time,
+      "archive" => self.class.stringify_keys(archives)
+    }
+  end
+
   def generate
     FileUtils.cd(@source_directory)
 
@@ -88,7 +182,7 @@ class Site
     files = Dir["**/*"].select { |f| f !~ /\A_/ && File.file?(f) }
 
     layout = Liquid::Template.parse(File.read("_layouts/default.html"))
-    posts = self.posts.sort_by { |entry| entry.created }.reverse
+    posts = self.posts
 
     files.each do |path|
       puts "Processing file: #{path}"
@@ -119,9 +213,9 @@ class Site
           end
 
           if layout_option == "none"
-            f.puts Liquid::Template.parse(file.to_s).render!("site" => { "posts" => posts, "latest_update_time" => latest_update_time })
+            f.puts Liquid::Template.parse(file.to_s).render!("site" => self)
           else
-            f.puts layout.render!("page" => { "title" => [title].compact }, "content" => Liquid::Template.parse(file.to_s).render!("site" => { "posts" => posts, "latest_update_time" => latest_update_time }))
+            f.puts layout.render!("page" => { "title" => [title].compact }, "content" => Liquid::Template.parse(file.to_s).render!("site" => self))
           end
         end
       end
@@ -137,6 +231,8 @@ class Site
       end
     end
 
+    generate_archives(layout)
+
     if Dir.exist?("_site")
       FileUtils.mv("_site", "/tmp/_site.#{Time.now.strftime("%Y-%m-%d-%H-%M-%S")}")
     end
@@ -144,5 +240,43 @@ class Site
     FileUtils.mv("tmp/_site", ".") && FileUtils.rm_rf("tmp/_site")
     FileUtils.rmdir("tmp")
   end
+
+  private
+
+  # Uses config.archive_url_format to generate pages
+  # using the archive_page.html template.
+  def generate_archives(layout)
+    return unless config.archive_enabled?
+
+    template = Liquid::Template.parse(File.read("_templates/archive_page.html"))
+
+    months = posts.group_by { |post| Date.new(post.created.year, post.created.month) }
+
+    months.each do |month, posts|
+      archive_path = tmp_path(archive_url_for_date(month))
+      
+      FileUtils.mkdir_p(archive_path)
+
+      File.open(File.join(archive_path, "index.html"), "w") do |f|
+        f.puts layout.render!("content" => template.render!("site" => self, "month" => month, "posts" => posts))
+      end
+    end
+  end
+
+  def self.stringify_keys(obj)
+    return obj unless obj.is_a?(Hash) || obj.is_a?(Array)
+
+    if obj.is_a?(Array)
+      return obj.map do |el|
+        stringify_keys(el)
+      end
+    end
+
+    result = {}
+    obj.each do |key, value|
+      result[key.to_s] = stringify_keys(value)
+    end
+    result
+  end
 end
 end

data/serif.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name         = "serif"
-  s.version      = "0.1.2"
+  s.version      = "0.1.3"
   s.authors      = ["Adam Prescott"]
   s.email        = ["adam@aprescott.com"]
   s.homepage     = "https://github.com/aprescott/serif"
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   [
     "rake", "~> 0.9",
     "rack", "~> 1.0",
-    "yui-compressor", ">= 0",
+    "rack-rewrite", "~> 1.3.0",
     "redcarpet", "~> 2.2",
     "pygments.rb", "~> 0.3",
     "sinatra", "~> 1.3",

data/statics/skeleton/_config.yml

@@ -12,3 +12,7 @@
 admin:
   username: changethisusername
   password: changethispassword
+permalink: /:title
+archive:
+  enabled: yes
+  url_format: /archive/:year/:month

data/statics/skeleton/_drafts/sample-draft

@@ -0,0 +1,3 @@
+title: Sample draft
+
+Just a sample draft.

data/statics/skeleton/_posts/2012-01-05-sample-post

@@ -0,0 +1,4 @@
+title: Sample post
+Created: 2012-11-21T17:07:09+00:00
+
+Just a sample post.

data/statics/skeleton/_templates/archive_page.html

@@ -0,0 +1,9 @@
+<h1>{{ month | date: "%b %Y" }} ({{ posts | size }})</h1>
+
+<ul>
+	{% for post in posts %}
+		<li>
+			<a href="{{ post.url }}">{{ post.title }}</a>
+		</li>
+	{% endfor %}
+</ul>

data/statics/skeleton/archive.html

@@ -0,0 +1,7 @@
+{% for year in site.archive.years %}
+	{% for month in year.months %}
+		<h1>
+			<a href="{{ month.archive_url }}">{{ month.date | date: "%B %Y" }}</a>
+		</h1>
+	{% endfor %}
+{% endfor %}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serif
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-11 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,21 +44,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: yui-compressor
+  name: rack-rewrite
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -179,9 +179,13 @@ files:
 - statics/templates/admin/index.liquid
 - statics/templates/admin/edit_post.liquid
 - statics/skeleton/index.html
+- statics/skeleton/_templates/archive_page.html
 - 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