setup api transition summaries. beta => v3

technoweenie · technoweenie · commit f0990cc1916f · 2012-09-05T01:58:04.000-06:00
diff --git a/Rules b/Rules
@@ -23,13 +23,15 @@ compile '/feed/' do
     :colorizers => {:javascript => :pygmentsrb}
 end
 
-compile '/changes/*/' do
-  filter :erb
-  filter :kramdown
-  filter :colorize_syntax,
-    :colorizers => {:javascript => :pygmentsrb}
-  layout 'changes'
-  layout 'default'
+%w(v3 */).each do |version|
+  compile "/changes/#{version}" do
+    filter :erb
+    filter :kramdown
+    filter :colorize_syntax,
+      :colorizers => {:javascript => :pygmentsrb}
+    layout 'changes' if version[0] == '*'
+    layout 'default'
+  end
 end
 
 compile '*' do
diff --git a/config.yaml b/config.yaml
@@ -44,4 +44,13 @@ data_sources:
     type: static
     items_root: /static
 
+# For the atom feed.
 base_url: http://developer.github.com
+
+# Array of [version, released_at] Array tuples.
+api_versions:
+  -
+    - beta
+    - 2011-4-27
+  -
+    - v3
diff --git a/content/changes/v3.html b/content/changes/v3.html
@@ -0,0 +1,21 @@
+---
+title: GitHub API v3
+new_version: v3
+old_version: beta
+---
+
+# API `<%= @item[:old_version] %>` to `<%= @item[:new_version] %>`
+
+<dl>
+<dt>Old Mime Type</dt>
+<dd><%= api_mimetype_listing @item[:old_version] %></dd>
+<dt>New Mime Type</dt>
+<dd><%= api_mimetype_listing @item[:new_version] %></dd>
+<% if no_current_api_versions?(@item[:old_version], @item[:new_version]) %>
+<dt>Current Mime Type</dt>
+<dd><%= api_mimetype_listing current_api %></dd>
+<% end %>
+</dl>
+
+<%= render '_changes', :changes => api_changes(:v3) %>
+
diff --git a/lib/changes_helper.rb b/lib/changes_helper.rb
@@ -1,4 +1,5 @@
 module ChangesHelper
+  MimeFormat = "application/vnd.github.%s+json".freeze
   # Public: Filters the change items out.  If a version is given, show only the
   # items related to that version.
   #
@@ -17,4 +18,72 @@ def api_changes(version = nil)
       attribute_to_time(y[:created_at]) <=> attribute_to_time(x[:created_at])
     end.first(30)
   end
+
+  # Public
+  def current_api
+    @current_api ||= (api_versions[-2] || api_versions.first).first
+  end
+
+  # Public
+  def upcoming_api
+    @upcoming_api ||= begin
+      version, date = api_versions.last
+      version unless date
+    end
+  end
+
+  # Public
+  def current_api?(version)
+    @api_current_checks ||= {}
+    if @api_current_checks.key?(version)
+      @api_current_checks[version]
+    end
+
+    @api_current_checks[version] = version == current_api
+  end
+
+  # Public
+  def no_current_api_versions?(*versions)
+    versions.none? { |v| current_api?(v) }
+  end
+
+  # Public
+  def api_released_at(version)
+    @api_releases ||= {}
+    if @api_releases.key?(version)
+      @api_releases[version]
+    end
+
+    @api_releases[version] = begin
+      pair = api_versions.detect do |(name, date)|
+        name == version
+      end
+      pair ? pair[1] : nil
+    end
+  end
+
+  # Public
+  def api_mimetype_listing(version)
+    version_s = version.to_s
+    mime = mimetype_for version_s
+    if time = api_released_at(version_s)
+      mime << " ("
+      mime << "Current, " if current_api?(version_s)
+      mime << strftime(time)
+      mime << ")"
+    else
+      mime
+    end
+  end
+
+  # Internal
+  def mimetype_for(version)
+    MimeFormat % version.to_s
+  end
+
+  # Internal
+  def api_versions
+    @api_versions ||= Array(@site.config[:api_versions])
+  end
 end
+
diff --git a/lib/resources.rb b/lib/resources.rb
@@ -25,9 +25,14 @@ module Helpers
         :technoweenie => '821395fe70906c8290df7f18ac4ac6cf'
       }
 
+      DefaultTimeFormat = "%B %-d, %Y".freeze
+
       def post_date(item)
-        pub = item[:created_at]
-        attribute_to_time(pub).strftime("%B %-d, %Y")
+        strftime item[:created_at]
+      end
+
+      def strftime(time, format = DefaultTimeFormat)
+        attribute_to_time(time).strftime(format)
       end
 
       def gravatar_for(login)
