smeagol 0.5.9 → 0.6.0

data/lib/smeagol/templates/settings.yml

@@ -0,0 +1,64 @@
+---
+# Gollum wiki url.
+# e.g. `git@github.com:trans/trans.github.com.wiki.git`
+
+wiki_origin: {{ wiki_origin }}
+
+# Website address.
+# e.g. `http://trans.github.com`
+
+url: {{ url }}
+
+# Source site, if applicable.
+# e.g. `http://github.com/trans`
+
+source_url: {{ source_url }}
+
+# Title of site.
+
+title: My Site
+
+# Single line description of site.
+
+tagline: Welcome to My Site
+
+# Detailed description of site.
+
+description:
+  This is my awesome site.
+
+# Webmaster of site.
+
+author: {{ author }}
+
+# Menu that can be used in site template.
+#
+# e.g.
+#
+#   menu:
+#   - title: Home
+#     href: /
+#   - title: Projects
+#     href: /Projects/
+#   - title: Tools
+#     href: /Tools/
+#   - title: Reads
+#     href: /Reads/
+
+menu:
+- title: Home
+  href: /
+
+# Google analytics tracking id. Could be used for other such
+# services if custom template is used.
+
+tracking_id: ~
+
+# Include a GitHub "Fork Me" ribbon in corner of page. Entry 
+# should give color and position separated by a space.
+# The resulting ribbon will have a link to `source_url`.
+#
+# NOTE: Will be renamed to `github_forkme` or something like that.
+
+ribbon: red right
+

data/lib/smeagol/version.rb

@@ -1,3 +1,3 @@
 module Smeagol
-  VERSION = "0.5.9"
+  VERSION = "0.6.0"
 end

data/lib/smeagol/views/base.rb

@@ -1,35 +1,80 @@
 module Smeagol
+
   module Views
+
+    # Base class for all views.
+    #
+    # FAQ: Why aren't layouts versioned, i.e. pulled from the git repo
+    #      like pages and posts? B/c we might want to look at content
+    #      history, but that doesn't mean we want to look at it via
+    #      an old layout.
+    #
     class Base < ::Mustache
       # Initializes a new mustache view template data object.
       #
-      # wiki - The wiki that this view represents.
+      # master  - Master controller, which creates all the views.
+      # page    - The individual wiki page that this view represents.
+      # version - The tagged version of the page.
       #
-      # Returns a new view object.
-      def initialize(wiki, version='master')
-        @wiki    = wiki
+      # Returns a new page object.
+      def initialize(master, file, version='master')
+        @master  = master
+        @file    = file
+        @wiki    = file.wiki
         @version = version || 'master'
+
+        setup_template_path
       end
+
+      # The Gollum::Wiki that this view represents.
+      attr_reader :wiki
       
+      # The tagged version that is being viewed.
+      attr_reader :version
+
+      #
+      def setup_template_path
+        # See FAQ for Views::Base class
+        dir = ::File.join(wiki.path, settings.partials)
+        if ::File.directory?(dir)
+          self.class.template_path = dir
+        else
+          self.class.template_path = ::File.join(LIBDIR, 'templates', 'partials')
+        end
+      end
+
+      # The Gollum::Page or Gollum::File that this view represents.
+      attr_reader :file
+
+      #
+      def filename
+        file.filename
+      end
+
+      # Page name.
+      def name
+        file.name
+      end
+
       # Public: The title of the wiki. This is set in the settings file.
       def wiki_title
-        wiki.settings.title
+        settings.title
       end
-      
+
       # Public: The tagline for the wiki. This is set in the settings file.
       def tagline
-        wiki.settings.tagline
+        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
+        settings.source_url
       end
 
       # Public: The Google Analytics tracking id from the settings file.
       def tracking_id
-        wiki.settings.tracking_id
+        settings.tracking_id
       end
 
       # Public: The HTML menu generated from the settings.yml file.
@@ -38,12 +83,13 @@ module Smeagol
         if !menu.nil?
           html = "<ul>\n"
           menu.each do |item|
-            if version != 'master' && item.href.index('/') == 0
-              prefix = "/#{version}"
+            title, href = item['title'], item['href']
+            if version != 'master' && item['href'].index('/') == 0
+              prefix = version.start_with?('v') ? "/#{version}" : "/v#{version}"
             else
               prefix = ""
             end
-            html << "<li><a href=\"#{prefix}#{item.href}\">#{item.title}</a></li>\n"
+            html << "<li class=\"minibutton\"><a href=\"#{prefix}#{href}\">#{title}</a></li>\n"
           end
           html << "</ul>\n"
         end
@@ -62,23 +108,38 @@ module Smeagol
         end
       end
 
+      # Public: The string base path to prefix internal links.
+      def base_path
+        wiki.base_path
+      end
 
-      ##########################################################################
-      #
-      # Internal Methods
-      #
-      ##########################################################################
-      
-      protected
-      
-      # The Gollum::Wiki that this view represents.
-      attr_reader :wiki
-      
-      # The tagged version that is being viewed.
-      attr_reader :version
-      
+      # List of posts.
+      def posts
+        @posts ||= @master.posts
+        #@posts ||= (
+        #  filter(@wiki.pages){ |p| p.post? }.map do |page|
+        #    Smeagol::Views::Post.new(page, @version)
+        #  end
+        #)
+      end
 
-      private
+=begin
+      #
+      def filter(paths, &selection)
+        result = []
+        paths.map do |file|
+          unless settings.include.any?{ |x| File.fnmatch?(x, file.path) }
+            next if file.path.split('/').any? do |x|
+              x.start_with?('_') or x.start_with?('.')
+            end
+            next if settings.exclude.any?{ |x| File.fnmatch?(x, file.path) }
+          end
+          result << file
+        end
+        result = result.select(&selection)
+        result
+      end
+=end
 
       # Generates the correct ribbon url
       def ribbon_url(name, pos)
@@ -89,6 +150,106 @@ module Smeagol
           name
         end
       end
+
+      # TODO: Actual slug support ?
+      #def slug(page,blob)
+      #  date = page.version.authored_date
+      #  name = blob.name[name.index(/[A-Za-z]/)..-1]
+      #
+      #  if slug = @wiki.settings.slug
+      #    slug = date.strftime(slug)
+      #    slug = slug.sub(':name', name)
+      #  else
+      #    slug = name
+      #  end
+      #  slug
+      #end
+
+      # Get the layout template for the view.
+      def layout
+        return nil if custom_layout? && !custom_layout
+        custom_layout || standard_layout || default_layout
+      end
+
+      # Does the metadata specify a custom layout?
+      def custom_layout?
+        metadata.key?('layout')
+      end
+
+      # Value of layout metadata setting.
+      def custom_layout
+        metadata['layout']
+      end
+
+      # The Mustache template to use for rendering.
+      #
+      # Returns the content of the specified template file in the
+      # wiki repository if it exists. Otherwise, it returns `nil`.
+      def standard_layout
+        name   = metadata['layout'] || 'page.mustache'
+        dir    = ::File.expand_path(::File.join(wiki.path, ::File.dirname(file.path)))
+        root   = ::File.expand_path(wiki.path)
+        home   = ::File.expand_path('~')
+        layout = nil
+        loop do
+          f = ::File.join(dir, '_layouts', name)
+          break (layout = IO.read(f)) if ::File.exist?(f)
+          break nil if dir == root
+          break nil if dir == home  # just in case
+          break nil if dir == '/'
+          dir = ::File.dirname(dir)
+        end
+        return layout
+        #names.each do |name|
+        #  file = "#{@wiki.path}/#{settings.layout_dir}/#{name}.mustache"
+        #  if ::File.exists?(file)
+        #    return IO.read(file)
+        #  end
+        #end
+        #nil
+      end
+
+      # Default template.
+      #
+      # Returns [String] The template included with the Smeagol package.
+      def default_layout
+        @default_layout ||= (
+          IO.read(LIBDIR + "/templates/layouts/page.mustache")
+        )
+      end
+
+      #
+      def post?
+        false
+      end
+
+      # Support mathjax?
+      def mathjax
+        settings.mathjax
+      end
+
+      #
+      def settings
+        @master.settings
+      end
+
+      # Embedded metadata. 
+      #
+      # TODO: Can use file.metadata in future version of Gollum.
+      #
+      # Returns [Hash] of metadata.
+      def metadata
+        @metadata ||= (
+          if md = /\<\!\-\-\-(.*?)\-{2,3}\>\s*\Z/m.match(content)
+            YAML.load(md[1])
+          else
+            {}
+          end
+        )
+      end
+
     end
+
   end
+
 end

data/lib/smeagol/views/form.rb

@@ -0,0 +1,56 @@
+module Smeagol
+
+  module Views
+
+    # The form view is used for generic files that are not
+    # Gollum wiki pages. These are typically html or xml
+    # files and they are rendered as mustache templates.
+    #
+    class Form < Base
+
+      # The Gollum::File that this view represents. This is
+      # the same as `#file`.
+      alias form file
+
+      # Public: Rendered content of the file.
+      def content
+        @content ||= Mustache.render(file.raw_data, self)
+      end
+
+      #
+      def title
+        filename  # TODO: better idea for form title?
+      end
+      alias_method :page_title, :title
+
+      #
+      #def content=(text)
+      #  @content = text
+      #end
+
+      # Public: A flag stating that this is not the home file.
+      def not_home?
+        filename != "index.html"
+      end
+
+      # Public: static href, used when generating static site.
+      def href
+        dir  = ::File.dirname(file.path)
+        ext  = ::File.extname(file.path)
+
+        if dir != '.'
+          ::File.join(dir, name.chomp(ext)) #file.path) 
+        else
+          if name == settings.index #|| 'Home'
+            'index.html'
+          else
+            name.chomp(ext) #file.path
+          end
+        end
+      end
+
+    end #Form
+
+  end
+
+end

data/lib/smeagol/views/page.rb

@@ -1,27 +1,32 @@
 module Smeagol
+
   module Views
+
     class Page < Base
-      # Initializes a new page template data object.
-      #
-      # page    - The individual wiki page that this view represents.
-      # version - The tagged version of the page.
-      #
-      # Returns a new page object.
-      def initialize(page, version='master')
-        super(page.wiki, version)
-        @page = page
-      end
-      
+
+      # The Gollum::Page that this view represents. This is
+      # the same as `#file`.
+      alias page file
+
       # Public: The title of the page.
-      def page_title
+      def title
         page.title
       end
-      
+
+      # TODO: temporary alias
+      alias_method :page_title, :title
+
       # Public: The HTML formatted content of the page.
       def content
         page.formatted_data
       end
 
+      #
+      def summary
+        i = content.index('</p>')
+        i ? content[0..i+3] : content  # any other way if no i, 5 line limit?
+      end
+
       # Public: The last author of this page.
       def author
         page.version.author.name
@@ -29,25 +34,121 @@ module Smeagol
 
       # Public: The last edit date of this page.
       def date
-        page.version.authored_date.strftime("%B %d, %Y")
+        post_date || commit_date
+      end
+
+      # Public: The last edit date of this page.
+      def commit_date
+        page.version.authored_date.strftime(settings.date_format)
       end
-      
+
       # Public: A flag stating that this is not the home page.
       def not_home?
-        page.title != "Home"
+        page.title != "Home"  # settings.index
       end
 
-      
-      ##########################################################################
+      # Public: static href, used when generating static site.
+      def href
+        dir  = ::File.dirname(page.path)
+        name = slug(page.filename_stripped)
+        ext  = ::File.extname(page.path)
+
+        if dir != '.'
+          ::File.join(dir, name, 'index.html')
+        else
+          if name == settings.index #|| 'Home'
+            'index.html'
+          else
+            ::File.join(name, 'index.html')
+          end
+        end
+      end
+
+      # Internal: Apply slug rules to name.
       #
-      # Internal Methods
+      # TODO: Support configurable slugs.
       #
-      ##########################################################################
-      
-      private
-      
-      # The Gollum::Page that this view represents.
-      attr_reader :page
+      # Returns [String] Sluggified name.
+      def slug(name)
+        if /^\d\d+\-/ =~ name
+          dirs = [] 
+          parts = name.split('-')
+          while /^\d+$/ =~ parts.first
+            dirs << parts.shift             
+          end
+          dirs << parts.join('-')
+          dirs.join('/')
+        else
+          name
+        end
+      end
+
+      # If the name of the page begins with a date, then it is the "post date"
+      # and is taken to be a blog entry, rather then an ordinary static page.
+      def post_date
+        if md = /^(\d\d\d\d-\d\d-\d\d)/.match(filename)
+          Time.parse(md[1]).strftime(settings.date_format)
+        end
+      end
+
+      #
+      def post?
+        /^(\d\d\d\d-\d\d-\d\d)/.match(filename)
+      end
+
+      def has_header
+        @header = (@page.header || false) if @header.nil?
+        !!@header
+      end
+
+      def header_content
+        has_header && @header.formatted_data
+      end
+
+      def header_format
+        has_header && @header.format.to_s
+      end
+
+      def has_footer
+        @footer = (@page.footer || false) if @footer.nil?
+        !!@footer
+      end
+
+      def footer_content
+        has_footer && @footer.formatted_data
+      end
+
+      def footer_format
+        has_footer && @footer.format.to_s
+      end
+
+      def has_sidebar
+        @sidebar = (@page.sidebar || false) if @sidebar.nil?
+        !!@sidebar
+      end
+
+      def sidebar_content
+        has_sidebar && @sidebar.formatted_data
+      end
+
+      def sidebar_format
+        has_sidebar && @sidebar.format.to_s
+      end
+
+      def has_toc
+        !@toc_content.nil?
+      end
+
+      def toc_content
+        @toc_content
+      end
+
+      def mathjax
+        @mathjax
+      end
+
     end
+
   end
+
 end