smeagol 0.4.2 → 0.5.0

data/lib/smeagol/app.rb

@@ -3,7 +3,9 @@ require 'rack/file'
 require 'sinatra'
 require 'mustache'
 require 'tmpdir'
+require 'smeagol/views/base'
 require 'smeagol/views/page'
+require 'smeagol/views/versions'
 
 module Smeagol
   class App < Sinatra::Base
@@ -41,9 +43,32 @@ module Smeagol
       end
     end
 
+    # Lists the tagged versions of the repo.
+    get '/versions' do
+      wiki = Smeagol::Wiki.new(repository.path)
+      Mustache.render(get_template('versions'), Smeagol::Views::Versions.new(wiki))
+    end
+
+
     # All other resources go through Gollum.
     get '/*' do
-      name = params[:splat].first
+      splat = params[:splat].first
+
+      # If the path starts with a version identifier, use it.
+      version = 'master'
+      tag_name = nil
+      if splat.index(/^v\d/)
+        repo = Grit::Repo.new(repository.path)
+        tag_name = splat.split('/').first
+        repo.tags.each do |tag|
+          if tag.name == tag_name
+            version = tag.commit.id
+            splat = splat.split('/')[1..-1].join('/')
+          end
+        end
+      end
+      
+      name = splat
       name = "Home" if name == ""
       name = name.gsub(/\/+$/, '')
       name = File.sanitize_path(name)
@@ -54,18 +79,20 @@ module Smeagol
       cache = Smeagol::Cache.new(wiki)
       
       # First check the cache
-      if settings.cache_enabled && cache.cache_hit?(name)
-        cache.get_page(name)
+      if settings.cache_enabled && cache.cache_hit?(name, version)
+        cache.get_page(name, version)
       # Then try to create the wiki page
-      elsif page = wiki.page(name)
-        content = Mustache.render(page_template, Smeagol::Views::Page.new(page))
-        cache.set_page(name, content) if settings.cache_enabled
+      elsif page = wiki.page(name, version)
+        content = Mustache.render(get_template('page'), Smeagol::Views::Page.new(page))
+        cache.set_page(name, page.version.id, content) if settings.cache_enabled
         content
       # If it is a directory, redirect to the index page
       elsif File.directory?(file_path)
-        redirect "/#{name}/index.html"
+        url = "/#{name}/index.html"
+        url = "/#{tag_name}#{url}" unless tag_name.nil?
+        redirect url
       # If it is not a wiki page then try to find the file
-      elsif file = wiki.file(name)
+      elsif file = wiki.file(name, version)
         content_type get_mime_type(name)
         file.raw_data
       # Otherwise return a 404 error
@@ -84,14 +111,16 @@ module Smeagol
     private
     # The Mustache template to use for page rendering.
     #
+    # name - The name of the template to use.
+    #
     # Returns the content of the page.mustache file in the root of the Gollum
     # repository if it exists. Otherwise, it uses the default page.mustache file
     # packaged with the Smeagol library.
-    def page_template
-      if File.exists?("#{repository.path}/page.mustache")
-        IO.read("#{repository.path}/page.mustache")
+    def get_template(name)
+      if File.exists?("#{repository.path}/#{name}.mustache")
+        IO.read("#{repository.path}/#{name}.mustache")
       else
-        IO.read(File.join(File.dirname(__FILE__), 'templates/page.mustache'))
+        IO.read(File.join(File.dirname(__FILE__), "templates/#{name}.mustache"))
       end
     end
 

data/lib/smeagol/cache.rb

@@ -26,34 +26,39 @@ module Smeagol
     
     # Checks if a cache hit is found for a given gollum page.
     #
-    # name - The name of the page to check.
+    # name    - The name of the page to check.
+    # version - The version of the page to check.
     #
     # Returns true if the page has been cached, otherwise returns false.
-    def cache_hit?(name)
-      page = wiki.page(name)
-      File.exists?(page_path(name)) unless page.nil?
+    def cache_hit?(name, version='master')
+      page = wiki.page(name, version)
+      File.exists?(page_path(name, version)) unless page.nil?
     end
     
     # Retrieves the content of the cached page.
     #
-    # name - The name of the wiki page.
+    # name    - The name of the wiki page.
+    # version - The version of the wiki page.
     #
     # Returns the contents of the HTML page if cached. Otherwise returns nil.
-    def get_page(name)
-      IO.read(page_path(name)) if cache_hit?(name)
+    def get_page(name, version='master')
+      IO.read(page_path(name, version)) if cache_hit?(name, version)
     end
 
     # Sets the cached content for a page.
     #
     # name    - The name of the wiki page.
+    # version - The version of the page.
     # content - The content to cache.
     #
     # Returns nothing.
-    def set_page(name, content)
-      page = wiki.page(name)
+    def set_page(name, version, content)
+      p "set page: #{name} : #{version.class}"
+      page = wiki.page(name, version)
       if !page.nil?
-        FileUtils.mkdir_p(File.dirname(page_path(name)))
-        File.open(page_path(name), 'w') do |f|
+        path = page_path(name, version)
+        FileUtils.mkdir_p(File.dirname(path))
+        File.open(path, 'w') do |f|
           f.write(content)
         end
       end
@@ -62,22 +67,24 @@ module Smeagol
     # Removes the cached content for a page.
     #
     # name    - The name of the wiki page.
+    # version - The version of the page.
     #
     # Returns nothing.
-    def remove_page(name)
-      page = wiki.page(name)
-      File.delete(page_path(name)) if !page.nil? && File.exists?(page_path(name))
+    def remove_page(name, version='master')
+      page = wiki.page(name, version)
+      File.delete(page_path(name, version)) if !page.nil? && File.exists?(page_path(name, version))
     end
     
     # Retrieves the path to the cache for a given page.
     #
-    # name - The name of the wiki page.
+    # name    - The name of the wiki page.
+    # version - The version of the page.
     #
     # Returns a file path to the cached wiki page.
-    def page_path(name)
-      page = wiki.page(name)
+    def page_path(name, version='master')
+      page = wiki.page(name, version)
       if !page.nil?
-        "#{path}/#{page.path}/#{page.version}"
+        "#{path}/#{page.path}/#{page.version.id}"
       end
     end
   end

data/lib/smeagol/templates/versions.mustache

@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+    <title>{{wiki_title}} - Versions</title>
+    <link rel="stylesheet" href="/smeagol/main.css" type="text/css"/> 
+
+    <!--[if lt IE 9]>
+    <script src="/smeagol/html5.js"></script>
+    <![endif]-->
+  </head>
+
+  <body>
+	{{{ribbon_html}}}
+	
+    <div id="container">
+		<header>
+			<h1>{{wiki_title}}</h1>
+		</header>
+		
+		<nav>
+			{{{menu_html}}}
+		</nav>
+		
+		<article>
+			<h1>Versions</h1>
+    		<div id="content">
+{{{content}}}
+			</div>
+		</article>
+
+		<footer>
+		</footer>
+    </div>
+  </body>
+</html>

data/lib/smeagol/version.rb

@@ -1,3 +1,3 @@
 module Smeagol
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/smeagol/views/base.rb

@@ -0,0 +1,80 @@
+module Smeagol
+  module Views
+    class Base < ::Mustache
+      # Initializes a new mustache view template data object.
+      #
+      # wiki - The wiki that this view represents.
+      #
+      # Returns a new view object.
+      def initialize(wiki)
+        @wiki = wiki
+      end
+      
+      # Public: The title of the wiki. This is set in the settings file.
+      def wiki_title
+        wiki.settings.title
+      end
+      
+      # Public: The tagline for the wiki. This is set in the settings file.
+      def tagline
+        wiki.settings.tagline
+      end
+      
+      # Public: The URL of the project source code. This is set in the settings
+      # file.
+      def source_url
+        wiki.settings.source_url
+      end
+
+      # Public: The HTML menu generated from the settings.yml file.
+      def menu_html
+        menu = wiki.settings.menu
+        if !menu.nil?
+          html = "<ul>\n"
+          menu.each do |item|
+            html << "<li><a href=\"#{item.href}\">#{item.title}</a></li>\n"
+          end
+          html << "</ul>\n"
+        end
+      end
+
+      # Public: The HTML for the GitHub ribbon, if enabled. This can be set in
+      # the settings file as `ribbon`.
+      def ribbon_html
+        if !source_url.nil? && !wiki.settings.ribbon.nil?
+          name, pos = *wiki.settings.ribbon.split(' ')
+          pos ||= 'right'
+          
+          html =  "<a href=\"#{source_url}\">"
+          html << "<img style=\"position:absolute; top:0; #{pos}:0; border:0;\" src=\"#{ribbon_url(name, pos)}\" alt=\"Fork me on GitHub\"/>"
+          html << "</a>"
+        end
+      end
+
+      
+      ##########################################################################
+      #
+      # Internal Methods
+      #
+      ##########################################################################
+      
+      protected
+      
+      # The Gollum::Page that this view represents.
+      attr_reader :wiki
+      
+
+      private
+
+      # Generates the correct ribbon url
+      def ribbon_url(name, pos)
+        hexcolors = {'red' => 'aa0000', 'green' => '007200', 'darkblue' => '121621', 'orange' => 'ff7600', 'gray' => '6d6d6d', 'white' => 'ffffff'}
+        if hexcolor = hexcolors[name]
+          "http://s3.amazonaws.com/github/ribbons/forkme_#{pos}_#{name}_#{hexcolor}.png"
+        else
+          name
+        end
+      end
+    end
+  end
+end

data/lib/smeagol/views/page.rb

@@ -1,25 +1,16 @@
 module Smeagol
   module Views
-    class Page < Mustache
+    class Page < Base
       # Initializes a new page template data object.
       #
       # page - The individual wiki page that this view represents.
       #
       # Returns a new page object.
       def initialize(page)
+        super(page.wiki)
         @page = page
       end
       
-      # Public: The title of the wiki. This is set in the settings file.
-      def wiki_title
-        page.wiki.settings.title
-      end
-      
-      # Public: The tagline for the wiki. This is set in the settings file.
-      def tagline
-        page.wiki.settings.tagline
-      end
-      
       # Public: The title of the page.
       def page_title
         page.title
@@ -40,41 +31,10 @@ module Smeagol
         page.version.authored_date.strftime("%B %d, %Y")
       end
       
-      # Public: The URL of the project source code. This is set in the settings
-      # file.
-      def source_url
-        page.wiki.settings.source_url
-      end
-
       # Public: A flag stating that this is not the home page.
       def not_home?
         page.title != "Home"
       end
-      
-      # Public: The HTML menu generated from the settings.yml file.
-      def menu_html
-        menu = @page.wiki.settings.menu
-        if !menu.nil?
-          html = "<ul>\n"
-          menu.each do |item|
-            html << "<li><a href=\"#{item.href}\">#{item.title}</a></li>\n"
-          end
-          html << "</ul>\n"
-        end
-      end
-
-      # Public: The HTML for the GitHub ribbon, if enabled. This can be set in
-      # the settings file as `ribbon`.
-      def ribbon_html
-        if !source_url.nil? && !page.wiki.settings.ribbon.nil?
-          name, pos = *page.wiki.settings.ribbon.split(' ')
-          pos ||= 'right'
-          
-          html =  "<a href=\"#{source_url}\">"
-          html << "<img style=\"position:absolute; top:0; #{pos}:0; border:0;\" src=\"#{ribbon_url(name, pos)}\" alt=\"Fork me on GitHub\"/>"
-          html << "</a>"
-        end
-      end
 
       
       ##########################################################################
@@ -87,16 +47,6 @@ module Smeagol
       
       # The Gollum::Page that this view represents.
       attr_reader :page
-      
-      # Generates the correct ribbon url
-      def ribbon_url(name, pos)
-        hexcolors = {'red' => 'aa0000', 'green' => '007200', 'darkblue' => '121621', 'orange' => 'ff7600', 'gray' => '6d6d6d', 'white' => 'ffffff'}
-        if hexcolor = hexcolors[name]
-          "http://s3.amazonaws.com/github/ribbons/forkme_#{pos}_#{name}_#{hexcolor}.png"
-        else
-          name
-        end
-      end
     end
   end
 end

data/lib/smeagol/views/versions.rb

@@ -0,0 +1,25 @@
+module Smeagol
+  module Views
+    class Versions < Base
+      # Public: The title of the wiki. This is set in the settings file.
+      def wiki_title
+        wiki.settings.title
+      end
+      
+      # Public: The HTML formatted content of the page.
+      def content
+        html = "<a href=\"/\">Current</a><br/>"
+        wiki.repo.tags.each do |tag|
+          html << "<a href=\"/#{tag.name}\">#{tag.name}</a><br/>"
+        end
+        html
+      end
+
+      # Public: The URL of the project source code. This is set in the settings
+      # file.
+      def source_url
+        wiki.settings.source_url
+      end
+    end
+  end
+end

data/test/test_cache.rb

@@ -9,7 +9,7 @@ class CacheTestCase < MiniTest::Unit::TestCase
   end
 
   def test_should_show_cache_hit
-    @cache.set_page('Home', 'abc')
+    @cache.set_page('Home', 'master', 'abc')
     assert @cache.cache_hit?('Home')
   end
   
@@ -22,12 +22,12 @@ class CacheTestCase < MiniTest::Unit::TestCase
   end
 
   def test_should_cache_page
-    @cache.set_page('Home', 'abc')
+    @cache.set_page('Home', 'master', 'abc')
     assert_equal 'abc', @cache.get_page('Home')
   end
 
   def test_should_remove_cache
-    @cache.set_page('Home', 'abc')
+    @cache.set_page('Home', 'master', 'abc')
     @cache.remove_page('Home')
     assert !@cache.cache_hit?('Home')
   end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Ben Johnson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-11 00:00:00 -06:00
+date: 2010-10-12 00:00:00 -06:00
 default_executable: smeagol
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -229,8 +229,11 @@ files:
 - lib/smeagol/public/smeagol/main.css
 - lib/smeagol/public/smeagol/pygment.css
 - lib/smeagol/templates/page.mustache
+- lib/smeagol/templates/versions.mustache
 - lib/smeagol/version.rb
+- lib/smeagol/views/base.rb
 - lib/smeagol/views/page.rb
+- lib/smeagol/views/versions.rb
 - lib/smeagol/wiki.rb
 - lib/smeagol.rb
 - README.md