smeagol 0.5.9 → 0.6.0

data/bin/smeagol

@@ -1,46 +1,16 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-require 'daemons'
-require 'optparse'
-require 'ostruct'
-require File.expand_path(File.dirname(__FILE__) + '/../lib/smeagol')
 
-# Catch signals
-Signal.trap('TERM') do
-  Process.kill('KILL', 0)
-end
-
-# Parse options
-options = Smeagol::OptionParser.parse(ARGV)
+cmd = []
 
-# Show repositories being served
-$stderr.puts "\n  Now serving:"
-options.repositories.each do |repository|
-  $stderr.puts "  #{repository.path} (#{repository.cname})"
+while (arg = ARGV.first)
+  break if arg.start_with?('-')
+  cmd << ARGV.shift
 end
-$stderr.puts "\n"
 
-# Run the auto update process
-if options.git && options.auto_update
-  Thread.new do
-    while true do
-      sleep 86400
-      options.repositories.each do |repository|
-        wiki = Smeagol::Wiki.new(repository.path)
-        wiki.update(options.git)
-      end
-    end
-  end
+if cmd.empty?
+  puts "smeagol: no command given"
+else
+  cmd = 'smeagol-' + cmd.join('-')
+  exec(cmd, *ARGV)
 end
 
-# Clear the caches
-options.repositories.each do |repository|
-  Smeagol::Cache.new(Gollum::Wiki.new(repository.path)).clear()
-end
-
-# Run the web server
-Smeagol::App.set(:repositories, options.repositories)
-Smeagol::App.set(:git, options.git)
-Smeagol::App.set(:cache_enabled, options.cache_enabled)
-Smeagol::App.run!(:port => options.port)
-

data/bin/smeagol-init

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'smeagol'
+Smeagol::CLI.init(ARGV)

data/bin/smeagol-preview

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'smeagol'
+Smeagol::CLI.preview(ARGV)
+

data/bin/smeagol-serve

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'smeagol'
+Smeagol::CLI.serve(ARGV)
+

data/bin/smeagol-update

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'smeagol'
+Smeagol::CLI.update(ARGV)
+

data/bin/smeagold

@@ -1,6 +1,3 @@
 #!/usr/bin/env ruby
-require 'rubygems'
 require 'daemons'
-
-filename = File.expand_path('smeagol', File.dirname(__FILE__))
-Daemons.run(filename)
+Daemons.run('smeagol-serve')

data/lib/smeagol.rb

@@ -1,9 +1,80 @@
-$:.unshift(File.dirname(__FILE__))
-require 'file'
+module Smeagol
+  LIBDIR = File.dirname(__FILE__) + '/smeagol'
 
+  # Locates the git binary in common places in the file system.
+  #
+  # TODO: Can we use shell.rb for this?
+  #
+  # TODO: This hsould not be necessary. 99% of the time it's just `git`.
+  #       For the rest if $GIT environment variable.
+  #
+  # Returns String path to git executable.
+  def self.git
+    ENV['git'] || ENV['GIT'] || 'git'
+  end
+
+=begin
+  def self.git
+    ENV['GIT'] ||= (
+      git = nil
+
+      ['/usr/bin', '/usr/sbin', '/usr/local/bin', '/opt/local/bin'].each do |path|
+        file = "#{path}/git"
+        git = file if File.executable?(file)
+        break if git
+      end
+    
+      # Alert user that updates are unavailable if git is not found
+      if git.nil? || !File.executable?(git)
+        warn "warning: git executable could not be found."
+      else
+        $stderr.puts "git found: #{git}" if $DEBUG
+      end
+
+      git
+    )
+  end
+=end
+
+end
+
+require 'gollum'
+require 'rack/file'
+require 'mustache'
+require 'tmpdir'
+require 'ostruct'
+require 'yaml'
+require 'optparse'
+require 'fileutils'
+require 'sinatra/base'
+
+require 'smeagol/version'
+require 'smeagol/core_ext'
+
+# some gollum plugins, can be removed when new version of Gollum is out.
+require 'smeagol/gollum/wiki'
+require 'smeagol/gollum/file'
+require 'smeagol/gollum/page'
+require 'smeagol/gollum/blob_entry'
+
+require 'smeagol/wiki'
 require 'smeagol/app'
 require 'smeagol/cache'
-require 'smeagol/hash'
-require 'smeagol/option_parser'
-require 'smeagol/wiki'
-require 'smeagol/version'
+require 'smeagol/config'
+require 'smeagol/repository'
+require 'smeagol/settings'
+require 'smeagol/controller'
+
+require 'smeagol/views/base'
+require 'smeagol/views/page'
+require 'smeagol/views/post'
+require 'smeagol/views/form'
+#require 'smeagol/views/file'
+require 'smeagol/views/versions'
+
+require 'smeagol/helpers/rss'
+require 'smeagol/helpers/toc'
+
+require 'smeagol/cli'
+require 'smeagol/console'
+

data/lib/smeagol/app.rb

@@ -1,28 +1,15 @@
-require 'gollum'
-require 'rack/file'
-require 'sinatra'
-require 'mustache'
-require 'tmpdir'
-require 'smeagol/views/base'
-require 'smeagol/views/page'
-require 'smeagol/views/versions'
-
 module Smeagol
+
+  # Sinatra based app for serving the the site directly
+  # from the Gollum wiki repo.
+  #
   class App < Sinatra::Base
-    ##############################################################################
-    #
-    # Settings
-    #
-    ##############################################################################
 
-    set :public, File.dirname(__FILE__) + '/public'
-    
+    #  S E T T I N G S
 
-    ##############################################################################
-    #
-    # Routes
-    #
-    ##############################################################################
+    set :public_folder, File.dirname(__FILE__) + '/public'
+
+    #  R O U T E S
 
     # Update the gollum repository
     get '/update/?*' do
@@ -32,11 +19,8 @@ module Smeagol
       # secret is appended to the URL.
       if repository.secret.nil? || key == repository.secret
         wiki = Smeagol::Wiki.new(repository.path)
-        if wiki.update(settings.git)
-          'ok'
-        else
-          'error'
-        end
+        repository.update
+        'ok'
       else
         # Show a forbidden response if the secret was not correct
         'forbidden'
@@ -45,53 +29,75 @@ module Smeagol
 
     # 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))
+      wiki = Smeagol::Wiki.new(repository.path, {:base_path => mount_path})
+      ctrl = Smeagol::Controller.new(wiki)
+      view = Smeagol::Views::Versions.new(ctrl)
+      Mustache.render(view.layout, view)
+    end
+
+    # Assets are alwasy served unversioned directly from the file system
+    # and not via the git repo.
+    get '/assets/*' do
+      name = params[:splat].first
+      file_path = "#{repository.path}/assets/#{name}"
+      content   = File.read(file_path)
+      content_type get_mime_type(name)
+      content
     end
 
+    # TODO: Instead of using `/^v\d/` as a match of versioned pages,
+    #       use `/v/{tag_name}` path instead.
 
     # All other resources go through Gollum.
     get '/*' do
-      splat = params[:splat].first
+      wiki  = Smeagol::Wiki.new(repository.path, {:base_path => mount_path})
+      cache = Smeagol::Cache.new(wiki)
+      ctrl  = Smeagol::Controller.new(wiki) # settings)
 
-      # 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, version, tag_name = parse_params(params)
+
+      name = (ctrl.settings.index || "Home") if name == ""
       name = name.gsub(/\/+$/, '')
-      name = File.sanitize_path(name)
+      name = sanitize_path(name)
       file_path = "#{repository.path}/#{name}"
-      
-      # Load the wiki settings
-      wiki = Smeagol::Wiki.new(repository.path)
-      cache = Smeagol::Cache.new(wiki)
-      
+
       # First check the cache
       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, version)
-        content = Mustache.render(get_template('page'), Smeagol::Views::Page.new(page, tag_name))
+        if page.post?
+          content = ctrl.render(page, version)
+        else
+          content = ctrl.render(page, version)
+        end
         cache.set_page(name, page.version.id, content) if settings.cache_enabled
         content
-      # If it is a directory, redirect to the index page
+      # If it is not a wiki page then try to find the file
+      elsif file = wiki.file(name+'.mustache', version)
+        content = ctrl.render(file, version)
+        cache.set_page(name, file.version.id, content) if settings.cache_enabled
+        content
+      # Smeagol can create an RSS feed automatically.
+      elsif name == 'rss.xml'
+        rss = RSS.new(ctrl, :version=>version)
+        content = rss.to_s
+        content_type 'application/rss+xml' 
+        content
+      # Smeagol can create a JSON-formatted table of contents.
+      elsif name == 'toc.json'
+        toc = TOC.new(ctrl, :version=>version)
+        content = toc.to_s
+        content_type 'application/json'
+        content
+      # If it is a directory, redirect to the index page.
+      # TODO: The server usually handles this automatically
+      # so do we really need this? Just in case, I guess?
       elsif File.directory?(file_path)
         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
+      # If not anything else then it must be a raw asset file.
       elsif file = wiki.file(name, version)
         content_type get_mime_type(name)
         file.raw_data
@@ -101,44 +107,60 @@ module Smeagol
       end
     end
 
+    #  P R I V A T E  M E T H O D S
+  
+    private
 
-    ##############################################################################
     #
-    # Private methods
+    # If the path starts with a version identifier, use it.
     #
-    ##############################################################################
-  
-    private
-    # The Mustache template to use for page rendering.
+    # params - The request parameters. [Hash]
     #
-    # name - The name of the template to use.
+    # Returns the version number. [String]
     #
-    # 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 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/#{name}.mustache"))
+    def parse_params(params)
+      name     = params[:splat].first
+      version  = 'master'
+      tag_name = nil
+
+      if name.index(/^v\d/)
+        repo = Grit::Repo.new(repository.path)
+        tag_name = name.split('/').first
+        repo_tag = repo.tags.find do |tag|
+          tag_name == tag.name or tag_name == "v#{tag.name}"
+        end
+        if repo_tag
+          version = repo_tag.name #repo_tag.commit.id
+          name = name.split('/')[1..-1].join('/')
+        else
+          # TODO: page not found
+        end
       end
+
+      return name, version, tag_name
     end
 
+    #
     # Retrieves the mime type for a filename based on its extension.
     #
-    # file - The filename.
+    # file - The filename. [String]
+    #
+    # Returns the mime type for a file. [String]
     #
-    # Returns the mime type for a file.
     def get_mime_type(file)
-      if !file.nil?
-        extension = file.slice(file.rindex('.')..-1) if file.rindex('.')
+      unless file.nil?
+        extension = ::File.extname(file)
         return Rack::Mime::MIME_TYPES[extension] || 'text/plain'
       end
       
       return 'text/plain'
     end
 
+    #
     # Determines the repository to use based on the hostname.
+    #
+    # Returns the matching repository. [Repository]
+    #
     def repository
       # Match on hostname
       settings.repositories.each do |repository|
@@ -147,9 +169,33 @@ module Smeagol
           return repository
         end
       end
-      
-      # If no match, use the first repository as the default
+
+      # If no match, use the first repository as the default.
       settings.repositories.first
     end
+
+    #
+    # Determines the mounted path to prefix to internal links.
+    #
+    # Returns the mount path. [String]
+    #
+    def mount_path
+      path = settings.mount_path
+      path += '/' unless path.end_with?('/')
+      path
+    end
+
+    #
+    # Removes all references to parent directories (../) in a path.
+    #
+    # path - The path to sanitize. [String]
+    #
+    # Returns a clean, pristine path. [String]
+    #
+    def sanitize_path(path)
+      path.gsub(/\.\.(?=$|\/)/, '') unless path.nil?
+    end
+
   end
+
 end

data/lib/smeagol/cache.rb

@@ -1,59 +1,72 @@
-require 'fileutils'
-
 module Smeagol
+
   class Cache
+
+    #
     # Creates a cache object for a Gollum wiki.
     #
-    # wiki - The wiki to cache.
+    # wiki - The wiki to cache. [Wiki]
+    #
+    # Returns cache. [Cache]
     #
-    # Returns a Smeagol::Cache object.
     def initialize(wiki)
       @wiki = wiki
       @path = "#{Dir.tmpdir}/smeagol/#{File.expand_path(@wiki.path)}"
     end
-    
+
+    #
     # The cached wiki.
+    #
     attr_reader :wiki
     
+    #
     # The path to the smeagol cache for this wiki.
+    #
     attr_accessor :path
 
-
+    #
     # Clears the entire cache.
+    #
     def clear
       FileUtils.rm_rf(path)
     end
-    
+
+    #
     # Checks if a cache hit is found for a given gollum page.
     #
-    # name    - The name of the page to check.
-    # version - The version of the page to check.
+    # name    - The name of the page to check.    [String]
+    # version - The version of the page to check. [String]
+    #
+    # Returns true if the page has been cached, otherwise false. [Boolean]
     #
-    # Returns true if the page has been cached, otherwise returns false.
     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.
-    # version - The version of the wiki page.
+    # name    - The name of the wiki page. [String]
+    # version - The version of the page.   [String]
+    #
+    # Returns the contents of the HTML page if cached, otherwise nil. [String,nil]
     #
-    # Returns the contents of the HTML page if cached. Otherwise returns nil.
     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.
+    # name    - The name of the wiki page. [String]
+    # version - The version of the page.   [String]
+    # content - The content to cache.      [String]
     #
     # Returns nothing.
+    #
     def set_page(name, version, content)
-      p "set page: #{name} : #{version.class}"
+      $stderr.puts "set page: #{name} : #{version.class}" unless $QUIET
       page = wiki.page(name, version)
       if !page.nil?
         path = page_path(name, version)
@@ -64,28 +77,34 @@ module Smeagol
       end
     end
 
+    #
     # Removes the cached content for a page.
     #
-    # name    - The name of the wiki page.
-    # version - The version of the page.
+    # name    - The name of the wiki page. [String]
+    # version - The version of the page.   [String] 
     #
     # Returns nothing.
+    #
     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.
-    # version - The version of the page.
+    # name    - The name of the wiki page. [String]
+    # version - The version of the page.   [String] 
+    #
+    # Returns the file path to the cached wiki page. [String]
     #
-    # Returns a file path to the cached wiki page.
     def page_path(name, version='master')
       page = wiki.page(name, version)
       if !page.nil?
         "#{path}/#{page.path}/#{page.version.id}"
       end
     end
+
   end
+
 end