smeagol 0.2.3 → 0.2.4

data/bin/smeagol

@@ -6,78 +6,23 @@ require 'ostruct'
 require File.expand_path(File.dirname(__FILE__) + '/../lib/smeagol')
 
 # Parse options
-options = OpenStruct.new
-options.port = 4567
-options.auto_update = false
-options.cache_enabled = true
-opts = OptionParser.new do |opts|
-  opts.banner = 'usage: smeagol [OPTIONS] [PATH]\n\n'
-
-  opts.on('--port [PORT]', 'Bind port (default 4567).') do |port|
-    options.port = port.to_i
-  end
-
-  opts.on('--git [GIT]', 'Path to Git binary.') do |path|
-    options.git = path
-  end
-
-  opts.on('--autoupdate', 'Updates the repository on a daily basis.') do |flag|
-    options.auto_update = flag
-  end
-
-  opts.on('--[no-]cache', 'Enables page caching.') do |flag|
-    options.cache_enabled = flag
-  end
-
-  opts.on('-v', '--version', 'Display current version.') do
-    puts "Smeagol #{Smeagol::VERSION}"
-    exit 0
-  end
-end
-
-# Read command line options into `options` hash
-begin
-  opts.parse!
-rescue OptionParser::InvalidOption
-  puts "smeagol: #{$!.message}"
-  puts "smeagol: try 'smeagol --help' for more information"
-  exit
-end
-
-# Attempt to find the git binary
-if options.git.nil?
-  ['/usr/bin', '/usr/sbin', '/usr/local/bin', '/opt/local/bin'].each do |path|
-    file = "#{path}/git"
-    options.git = file if File.executable?(file)
-    break if options.git
-  end
-end
-
-# Alert user that updates are unavailable if git is not found
-if options.git.nil? || !File.executable?(options.git)
-  puts "warning: git executable could not be found."
-else
-  puts "git found: #{options.git}"
-end
-
-# Set the path to the Gollum repository
-gollum_path = ARGV[0] || Dir.pwd
+options = Smeagol::OptionParser.parse(ARGV)
 
 # Run the auto update process
 if options.git && options.auto_update
   Thread.new do
     while true do
       sleep 86400
-      Smeagol::Updater.update(options.git, gollum_path)
+      Smeagol::Updater.update(options.git, options.gollum_path)
     end
   end
 end
 
 # Clear the cache
-Smeagol::Cache.new(Gollum::Wiki.new(gollum_path)).clear()
+Smeagol::Cache.new(Gollum::Wiki.new(options.gollum_path)).clear()
 
 # Run the web server
-Smeagol::App.set(:gollum_path, gollum_path)
+Smeagol::App.set(:gollum_path, options.gollum_path)
 Smeagol::App.set(:git, options.git)
 Smeagol::App.set(:cache_enabled, options.cache_enabled)
 Smeagol::App.run!(:port => options.port)

data/lib/smeagol.rb

@@ -4,6 +4,7 @@ require 'file'
 require 'smeagol/app'
 require 'smeagol/cache'
 require 'smeagol/hash'
+require 'smeagol/option_parser'
 require 'smeagol/updater'
 require 'smeagol/wiki'
 require 'smeagol/version'

data/lib/smeagol/app.rb

@@ -1,4 +1,5 @@
 require 'gollum'
+require 'rack/file'
 require 'sinatra'
 require 'mustache'
 require 'tmpdir'
@@ -34,7 +35,9 @@ module Smeagol
     get '/*' do
       name = params[:splat].first
       name = "Home" if name == ""
+      name = name.gsub(/\/+$/, '')
       name = File.sanitize_path(name)
+      file_path = "#{settings.gollum_path}/#{name}"
       
       # Load the wiki settings
       wiki = Smeagol::Wiki.new(settings.gollum_path)
@@ -48,8 +51,12 @@ module Smeagol
         content = Mustache.render(page_template, Smeagol::Views::Page.new(page))
         cache.set_page(name, 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"
       # If it is not a wiki page then try to find the file
       elsif file = wiki.file(name)
+        content_type get_mime_type(name)
         file.raw_data
       # Otherwise return a 404 error
       else
@@ -77,5 +84,19 @@ module Smeagol
         IO.read(File.join(File.dirname(__FILE__), 'templates/page.mustache'))
       end
     end
+
+    # Retrieves the mime type for a filename based on its extension.
+    #
+    # file - The filename.
+    #
+    # Returns the mime type for a file.
+    def get_mime_type(file)
+      if !file.nil?
+        extension = file.slice(file.rindex('.')..-1) if file.rindex('.')
+        return Rack::Mime::MIME_TYPES[extension] || 'text/plain'
+      end
+      
+      return 'text/plain'
+    end
   end
 end

data/lib/smeagol/option_parser.rb

@@ -0,0 +1,123 @@
+module Smeagol
+  class OptionParser
+    # Parses the command line options.
+    #
+    # args - The arguments to parse. Typically use `ARGV`.
+    #
+    # Returns an OpenStruct of the options.
+    def self.parse(args)
+      # Set parse options
+      options = {}
+      parser = ::OptionParser.new do |parser|
+        parser.banner = 'usage: smeagol [OPTIONS] [PATH]\n\n'
+
+        parser.on('--port [PORT]', 'Bind port (default 4567).') do |port|
+          options['port'] = port.to_i
+        end
+
+        parser.on('--git [GIT]', 'Path to Git binary.') do |path|
+          options['git'] = path
+        end
+
+        parser.on('-c', '--config [PATH]', 'Loads the config file. (default /etc/smeagol/config.yml)') do |path|
+          puts "Cannot find configuration file: #{path}" unless File.exists?(path)
+          puts "Cannot read configuration file: #{path}" unless File.readable?(path)
+          options['config_path'] = path
+        end
+        
+        parser.on('--autoupdate', 'Updates the repository on a daily basis.') do |flag|
+          options['auto_update'] = flag
+        end
+
+        parser.on('--[no-]cache', 'Enables page caching.') do |flag|
+          options['cache_enabled'] = flag
+        end
+
+        parser.on('-v', '--version', 'Display current version.') do
+          puts "Smeagol #{Smeagol::VERSION}"
+          exit 0
+        end
+      end
+
+      # Read command line options into `options` hash
+      begin
+        parser.parse!
+      rescue ::OptionParser::InvalidOption
+        puts "smeagol: #{$!.message}"
+        puts "smeagol: try 'smeagol --help' for more information"
+        exit
+      end
+
+      # Load config
+      config_path = options['config_path'] || '/etc/smeagol/config.yml'
+      config = load_config(config_path)
+      opts = default_options.merge(config).merge(options)
+      opts = opts.to_ostruct()
+
+      # Attempt to find the git binary
+      update_git_path(opts)
+
+      # Set the path to the Gollum repository if not already set
+      opts.gollum_path ||= args[0] || Dir.pwd
+      
+      # Merge all options
+      return opts
+    end
+
+
+    ###########################################################################
+    #
+    # Private Methods
+    #
+    ###########################################################################
+    
+    private
+
+    # The default options for Smeagol.
+    def self.default_options
+      options = Hash.new
+      options['port'] = 4567
+      options['auto_update'] = false
+      options['cache_enabled'] = true
+      options
+    end
+    
+    # Loads a configuration file.
+    #
+    # Returns a hash of options from the config file.
+    def self.load_config(path)
+      config = {}
+      
+      if File.exists?(path)
+        # Notify the user if the config file exists but is not readable.
+        if !File.readable?(path)
+          puts "Config file not readable: #{path}"
+          exit
+        end
+        
+        config = YAML.load(IO.read(path))
+        p config
+      end
+
+      return config
+    end
+
+    # Locates the git binary in common places in the file system.
+    def self.update_git_path(options)
+      if options.git.nil?
+        ['/usr/bin', '/usr/sbin', '/usr/local/bin', '/opt/local/bin'].each do |path|
+          file = "#{path}/git"
+          options.git = file if File.executable?(file)
+          break if options.git
+        end
+      end
+
+      # Alert user that updates are unavailable if git is not found
+      if options.git.nil? || !File.executable?(options.git)
+        puts "warning: git executable could not be found."
+      else
+        puts "git found: #{options.git}"
+      end
+    end
+  end
+end

data/lib/smeagol/version.rb

@@ -1,3 +1,3 @@
 module Smeagol
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: smeagol
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Ben Johnson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 -06:00
+date: 2010-09-30 00:00:00 -06:00
 default_executable: smeagol
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -251,6 +251,7 @@ files:
 - lib/smeagol/app.rb
 - lib/smeagol/cache.rb
 - lib/smeagol/hash.rb
+- lib/smeagol/option_parser.rb
 - lib/smeagol/public/smeagol/main.css
 - lib/smeagol/public/smeagol/pygment.css
 - lib/smeagol/templates/page.mustache