smeagol 0.5.9 → 0.6.0

data/lib/smeagol/cli.rb

@@ -0,0 +1,166 @@
+module Smeagol
+
+  # Smeagol::CLI module is a function module that provide
+  # all command line interfaces.
+  #
+  module CLI
+
+    extend self
+
+    #
+    # Initialize Gollum wiki site for use with Smeagol.
+    #
+    def init(argv)
+      parser.banner = "usage: smeagol-init [OPTIONS] [WIKI-URI]\n"
+
+      parser.on('-t', '--title [TITLE]') do |title|
+        options[:title] = title
+      end
+
+      parser.on('-i', '--index [PAGE]') do |page_name|
+        options[:index] = page_name
+      end
+
+      # TODO: support more settings options for creating setup
+
+      Console.init(*parse(argv))
+    end
+
+    #
+    # Preview current Gollum wiki.
+    #
+    def preview(argv)
+      parser.banner = "Usage: smeagol-preview [OPTIONS]\n"
+
+      parser.on('--port [PORT]', 'Bind port (default 4567).') do |port|
+        options[:port] = port.to_i
+      end
+
+      parser.on('--[no-]cache', 'Enables page caching.') do |flag|
+        options[:cache] = flag
+      end
+
+      parser.on('--mount-path', 'Serve website from this base path.') do |path|
+        options[:mount_path] = path
+      end
+
+      #parser.on('--auto-update', 'Updates the repository on a daily basis.') do |flag|
+      #  options[:auto_update] = flag
+      #end
+
+      #parser.on('--secret [KEY]', 'Specifies the secret key used to update.') do |str|
+      #  options[:secret] = str
+      #end
+
+      $stderr.puts "Starting preview..."
+
+      Console.preview(*parse(argv))
+    end
+
+    #
+    # Serve all Gollum repositories as setup in Deagol config file.
+    # This can be used to serve sites in production. It makes use
+    # of cnames to serve multiple sites via a single service.
+    #
+    def serve(argv)
+      config_file = nil
+
+      parser.banner = "usage: smeagol-serve [OPTIONS]\n"
+
+      parser.on('-c', '--config [PATH]', 'Load config file instead of default.') do |path|
+        options[:config_file] = path
+      end
+
+      parser.on('--port [PORT]', 'Bind port (default 4567).') do |port|
+        options[:port] = port.to_i
+      end
+
+      parser.on('--[no-]cache', 'Enables page caching.') do |flag|
+        options[:cache] = flag
+      end
+
+      parser.on('--mount-path', 'Serve website from this base path.') do |path|
+        options[:mount_path] = path
+      end
+
+      parser.on('--auto-update', 'Updates the repository on a daily basis.') do |flag|
+        options[:auto_update] = flag
+      end
+
+      parser.on('--secret [KEY]', 'Specifies the secret key, if needed to update.') do |str|
+        options[:secret] = str
+      end
+
+      Console.serve(*parse(argv))
+    end
+
+    #
+    # Update wiki repo and update/clone site repo, if designated
+    # in settings.
+    #
+    def update(argv)
+      parser.banner = "Usage: smeagol-update [OPTIONS] [WIKI-DIR]\n"
+
+      #parser.on('-s', '--site', 'Also update site directories, if applicable.') do
+      #  options[:site] = true
+      #end
+
+      Console.update(*parse(argv))
+    end
+
+  private
+
+    #
+    # Command line options.
+    #
+    # Returns the command line options. [Hash]
+    #
+    def options
+      @options ||= {}
+    end
+
+    #
+    # Read command line options into `options` hash.
+    #
+    # Returns arguments and options. [Array]
+    #
+    def parse(argv)
+      begin
+        parser.parse!(argv)
+      rescue ::OptionParser::InvalidOption
+        puts "smeagol: #{$!.message}"
+        puts "smeagol: try 'smeagol --help' for more information"
+        exit 1
+      end
+      return *(argv + [options])
+    end
+
+    #
+    # Create and cache option parser.
+    #
+    # Returns option parser instance. [OptionParser]
+    #
+    def parser
+      @parser ||= (
+        parser = ::OptionParser.new
+        parser.on_tail('--quiet', 'Turn on $QUIET mode.') do
+          $QUIET = true
+        end
+        parser.on_tail('--debug', 'Turn on $DEBUG mode.') do
+          $DEBUG = true
+        end
+        parser.on_tail('-v', '--version', 'Display current version.') do
+          puts "Smeagol #{Smeagol::VERSION}"
+          exit 0
+        end
+        parser.on_tail('-h', '-?', '--help', 'Display this help screen.') do
+          puts parser
+          exit 0
+        end
+        parser
+      )
+    end
+
+  end
+
+end

data/lib/smeagol/config.rb

@@ -0,0 +1,154 @@
+module Smeagol
+
+  # Server configuration is used to store the options for the Smeagol
+  # server for serving sites.
+  #
+  # Configuration can be loaded from configuration files located
+  # at `/etc/smaegol/config.yml` and `~/.config/smaegol/config.yml`
+  # or `~/.smaegol/config.yml`. Here is an example configuration:
+  #
+  # Examples
+  #
+  #   ---
+  #   port: 3000
+  #   auto_update: true
+  #   cache_enabled: true
+  #   repositories:
+  #     - path: /path/to/wiki/repo
+  #       cname: 'domain.name'
+  #       origin: 'git@github.com:foo/foo.github.com.wiki.git'
+  #       ref: master
+  #       bare: false
+  #       secret: 'pass123'
+  #
+  class Config
+
+    # Directory which contains user configuration.
+    CONFIG_HOME = ENV['XDG_CONFIG_HOME'] || '~/.config'
+
+    # Public: Load Smeagol server configuration.
+    #
+    # Returns [Config]
+    def self.load(file=nil)
+      config = {}
+
+      if file
+        config.update(load_config(file))
+      else
+        config.update(load_config('/etc/smeagol'))
+        config.update(load_config("#{CONFIG_HOME}/smeagol", '~/.smeagol'))
+      end
+
+      new(config)
+    end
+
+    # Internal: Searches through the given directories looking for
+    # `settings.yml` file. Loads and returns the result of
+    # the first file found.
+    #
+    # dirs - List of directories to search for config file. [Array<String>]
+    #
+    # Returns configuration settings or empty Hash if none found. [Hash]
+    def self.load_config(*dirs)
+      dirs.each do |dir|
+        file = File.join(dir, 'config.yml')
+        file = File.expand_path(file)
+        if File.exist?(file)
+          return YAML.load_file(file)
+        end
+      end
+      return {}
+    end
+
+    #
+    # Initialize new Config instance.
+    #
+    def initialize(settings={})
+      @port          = 4567
+      @auto_update   = false
+      @cache_enabled = true
+      @base_path     = ''
+      @repositories  = []
+
+      assign(settings)
+    end
+
+    #
+    # Given a Hash of settings, assign via writer methods.
+    #
+    def assign(settings={})
+      settings.each do |k,v|
+        __send__("#{k}=", v)
+      end
+    end
+
+    #  A T T R I B U T E S
+
+    # Port to use for server. Default is 4567.
+    attr_accessor :port
+
+    # While running server, auto-update wiki every day.
+    attr_accessor :auto_update
+    alias :update  :auto_update
+    alias :update= :auto_update=
+
+    # Use page cache to speed up page requests.
+    attr_accessor :cache
+    alias :cache_enabled  :cache
+    alias :cache_enabled= :cache=
+
+    # Serve website via a given base path.
+    attr_accessor :base_path
+    alias :mount_path  :base_path
+    alias :mount_path= :base_path=
+
+    # Wiki repository list.
+    #
+    # Examples
+    #
+    #   repositories:
+    #     - path: ~/wikis/banana-blog
+    #     - cname: blog.bananas.org
+    #     - secret: abc123
+    #
+    attr_reader :repositories
+
+    #
+    # Set list of repositories.
+    #
+    def repositories=(repos)
+      @repositories = (
+        repos.map do |repo|
+          case repo
+          when Repository then repo
+          else Repository.new(repo) 
+          end
+        end
+      )
+    end
+
+    #
+    # Deprecated: Ability to access config like hash.
+    #
+    def [](name)
+      instance_variable_get("@#{name}")
+    end
+
+    # Lookup git executable.
+    #def git
+    #  ENV['git'] || ENV['GIT'] || 'git'
+    #end
+
+    #
+    # Set secret for all repositories.
+    #
+    def secret=(secret)
+      return if secret.nil?
+      repositories.each do |repo|
+        repo.secret = secret
+      end
+    end
+
+  end
+
+end

data/lib/smeagol/console.rb

@@ -0,0 +1,369 @@
+module Smeagol
+
+  # Console encapsulates all the public methods
+  # smeagol is likely to need, generally it maps
+  # to all the CLI commands.
+  #
+  module Console
+    extend self
+
+    #
+    def report(msg)
+      $stderr.puts msg unless $QUIET
+    end
+
+    #
+    # Initialize Gollum wiki for use with Smeagol.
+    # This will clone the wiki repo, if given and it
+    # doesn't already exist and create `_settings.yml`,
+    # `_layouts/` and `assets/smeagol/`.
+    #
+    # TODO: Perhaps use a supporting "managed copy" gem in future?
+    #
+    # TODO: Add --force option to override skips?
+    #
+    # Returns nothing.
+    #
+    def init(*args)
+      options = (Hash === args.last ? args.pop : {})
+
+      abort "Too many arguments." if args.size > 2
+
+      @wiki_url = args.shift
+      @wiki_dir = args.shift
+
+      if @wiki_url
+        unless @wiki_dir
+          @wiki_dir = File.basename(@wiki_url).chomp('.git')
+        end
+        @clone = true
+      else
+        @wiki_dir = Dir.pwd
+        if File.exist?(File.join(@wiki_dir, '.git'))
+          @wiki_url = wiki.repo.config['remote.origin.url'].to_s
+        else
+          abort "smeagol: not a git repo."
+        end
+        @clone = false
+      end
+
+      clone_wiki if @clone
+
+      save_settings(options)
+      save_gitignore
+
+      copy_layouts unless options[:no_layouts]
+      copy_assets  unless options[:no_assets]
+    end
+
+    # The wiki git url.
+    attr_accessor :wiki_url
+
+    # Local directory to house wiki repo.
+    attr_accessor :wiki_dir
+
+    #
+    # If a wiki git URI is given, the clone the wiki.
+    #
+    # @todo Use grit instead of shelling out.
+    #
+    def clone_wiki
+      system "git clone #{wiki_url} #{wiki_dir}"
+    end
+
+    #
+    # Copy layout templates to `_layouts` directory and 
+    # partial templates to `_partials`.
+    #
+    def copy_layouts
+      dst_dir = File.join(wiki_dir, '_layouts')
+      src_dir = LIBDIR + '/templates/layouts'
+      copy_dir(src_dir, dst_dir)
+
+      dst_dir = File.join(wiki_dir, '_partials')
+      src_dir = LIBDIR + '/templates/partials'
+      copy_dir(src_dir, dst_dir)
+    end
+
+    #
+    # Copy assets to `assets` directory. 
+    #
+    def copy_assets
+      dst_dir = File.join(wiki_dir, 'assets')
+      src_dir = LIBDIR + '/public/assets'
+      copy_dir(src_dir, dst_dir)
+    end
+
+    #
+    def copy_dir(src_dir, dst_dir)
+      FileUtils.mkdir_p(dst_dir)
+
+      Dir[File.join(src_dir, '**/*')].each do |src|
+        next if File.directory?(src)
+        dst = File.join(dst_dir, src.sub(src_dir, ''))
+        copy_file(src, dst)
+      end
+    end
+
+    #
+    def copy_file(src, dst)
+      if File.exist?(dst)
+        report " skip: #{dst.sub(Dir.pwd,'')}"
+      else
+        FileUtils.mkdir_p(File.dirname(dst))
+        FileUtils.cp(src, dst)
+        report " copy: #{dst.sub(Dir.pwd,'')}"
+      end
+    end
+
+    #
+    # Create or append `_site` to .gitignore file.
+    #
+    def save_gitignore
+      file = File.join(wiki_dir, '.gitignore')
+      if File.exist?(file)
+        File.open(file, 'a') do |f|
+          f.write("_site")
+        end
+      else
+        File.open(file, 'w') do |f|
+          f.write("_site")
+        end
+      end
+    end
+
+    #
+    # Save settings.
+    #
+    def save_settings(options)
+      file = File.join(wiki_dir, "_settings.yml")
+      if File.exist?(file)
+        $stderr.puts " skip: #{file}"
+      else
+        text = Mustache.render(settings_template, initial_settings(options)) 
+        File.open(file, 'w') do |f|
+          f.write(text)
+        end
+      end
+    end
+
+    #
+    # When using #init, this provided the initial settings.
+    #
+    # @returns [Settings]
+    #
+    def initial_settings(options={})
+      options[:wiki_origin] = wiki_url
+      options[:site_origin] = wiki_url.sub('.wiki', '')
+
+      @settings = Settings.new(options)
+    end
+
+    #
+    # Read in the settings mustache template.
+    #
+    def settings_template
+      file = LIBDIR + '/templates/settings.yml'
+      IO.read(file)
+    end
+
+    #
+    # Preview current wiki (from working directory).
+    #
+    def preview(options)
+      repository = {}
+      repository[:path]   = Dir.pwd
+      #repository[:cname] = options[:cname]  if options[:cname]
+      repository[:secret] = options.delete(:secret) if options.key?(:secret)
+
+      options[:repositories] = [repository]
+
+      config = Smeagol::Config.new(options)
+
+      catch_signals
+      show_repository(config)
+
+      run_server(config)
+    end
+
+    #
+    # Serve up sites defined in smeagol config file.
+    #
+    def serve(options)
+      config_file = options[:config_file]
+      config = Config.load(config_file)
+      config.assign(options)
+      abort "No repositories configured." if config.repositories.empty?
+
+      # Set secret on all repositories if passed in by command line option
+      # We can only assume they are all the same, in this case.
+      #
+      # TODO: Maybe only apply if no secret is given in config file?
+      if options[:secret]
+        config.repositories.each{ |r| r['secret'] = options['secret'] }
+      end
+
+      catch_signals
+
+      show_repository(config)
+      auto_update(config)
+      clear_caches(config)
+
+      run_server(config)
+    end
+
+    #
+    # Setup trap signals.
+    #
+    def catch_signals
+      Signal.trap('TERM') do
+        Process.kill('KILL', 0)
+      end
+    end
+
+    #
+    # Show repositories being served
+    #
+    def show_repository(server_config)
+      $stderr.puts "\n  Now serving on port #{server_config.port} at /#{server_config.base_path}:"
+      server_config.repositories.each do |repository|
+        $stderr.puts "  * #{repository.path} (#{repository.cname})"
+      end
+      $stderr.puts "\n"
+    end
+
+    #
+    # Run the auto update process.
+    #
+    def auto_update(server_config)
+      return unless server_config.auto_update
+      Thread.new do
+        while true do
+          sleep 86400
+          server_config.repositories.each do |repository|
+            next unless repository.auto_update?
+            out = repository.update
+            out = out[1] if Array === out
+            if out.index('Already up-to-date').nil? 
+              $stderr.puts "== Repository updated at #{Time.new()} : #{repository.path} =="
+            end
+          end
+        end
+      end
+    end
+
+    #
+    # Clear the caches.
+    #
+    def clear_caches(server_config)
+      server_config.repositories.each do |repository|
+        Smeagol::Cache.new(Gollum::Wiki.new(repository.path)).clear()
+      end
+    end
+
+    #
+    # Run the web server.
+    #
+    def run_server(server_config)
+      #Smeagol::App.set(:git, server_config.git)
+      Smeagol::App.set(:repositories, server_config.repositories)
+      Smeagol::App.set(:cache_enabled, server_config.cache_enabled)
+      Smeagol::App.set(:mount_path, server_config.mount_path)
+      Smeagol::App.run!(:port => server_config.port)
+    end
+
+    #
+    # Update wiki repo(s).
+    #
+    def update(*args)
+      options  = (Hash === args.last ? args.pop : {})
+      wiki_dir = args.first
+
+      if wiki_dir
+        dir  = File.expand_path(wiki_dir)
+        repo = Repository.new(:path=>dir)
+        out  = repo.update
+        out  = out[1] if Array === out
+        report out
+      else
+        file   = options[:config_file]
+        config = Config.load(file)
+        abort "No repositories configured." if config.repositories.empty?
+
+        config.secret = options[:secret]
+        config.repositories.each do |repository|
+          report "Updating: #{repository.path}"
+          out = repository.update
+          out = out[1] if Array === out
+          report out
+        end
+      end
+    end
+
+    #if settings.site
+    #  if Dir.exist?(site_path)
+    #    $stderr.puts "Pulling `#{repo.branch}' from `origin' in `#{repo.path}'..."
+    #    repo.pull
+    #  else
+    #    $stderr.puts "Cloning `#{repo.origin}' in `#{repo.path}'..."
+    #    repo.clone
+    #  end
+    #end
+
+    #
+    # Site directory path.
+    #
+    # Returns expanded site path. [String]
+    #
+    def site_path
+      settings.site_path
+    end
+
+    #
+    # Site repository.
+    #
+    # Returns repository. [Repository]
+    #
+    def site_repo
+      settings.site_repo 
+    end
+
+    #
+    # Current wiki directory.
+    #
+    # Returns wiki directory. [String]
+    #
+    def wiki_dir
+      @wiki_dir || Dir.pwd
+    end
+
+    #
+    # Get and cache Wiki object.
+    #
+    # Returns wiki. [Wiki]
+    #
+    def wiki
+      @wiki ||= Smeagol::Wiki.new(wiki_dir)
+    end
+
+    #
+    # Local wiki settings.
+    #
+    # Returns wiki settings. [Settings]
+    #
+    def settings
+      @settings ||= Settings.load(wiki_dir)
+    end
+
+    #
+    # Git executable.
+    #
+    # Returns git command path. [String]
+    #
+    def git
+      Smeagol.git
+    end
+
+  end
+
+end