smeagol 0.5.9 → 0.6.0

data/lib/smeagol/repository.rb

@@ -0,0 +1,85 @@
+module Smeagol
+
+  # Repostiory encapsulation. This class serves two needs,
+  # as a wiki repo (for Config) and as a site repo (for Settings).
+  # Which fields are actually used depends on which of these
+  # two use cases is at play. 
+  #
+  class Repository
+
+    #
+    def initialize(opts={})
+      opts = OpenStruct.new(opts)
+      @path   = opts.path
+      @origin = opts.origin
+      @ref    = opts.ref || opts.tag || opts.branch || 'master'
+      @bare   = opts.bare
+      @secret = opts.secret
+      @cname  = opts.cname
+      @update = opts.update
+    end
+
+    #
+    attr_accessor :path
+
+    # Site's git repo uri.
+    # e.g. `git@github.com:trans/trans.github.com.git`
+    attr_accessor :origin
+
+    # For deployment site, if the repo is using detached branch approach,
+    # then specify the branch name here. This will typically be used
+    # for GitHub projects using `gh-pages`. Default is `master`.
+    attr_accessor :ref
+
+    # Alias for #ref.
+    alias tag ref
+    alias tag= ref=
+
+    # Alias for #ref.
+    alias branch ref
+    alias branch= ref=
+
+    # Passcode, if needed to interact with repo.
+    attr_accessor :secret
+
+    # Is the repository bare?
+    attr_accessor :bare
+
+    #
+    attr_accessor :cname
+
+    #
+    def auto_update?
+      @update
+    end
+
+    #
+    def repo
+      @repo ||= Grit::Repo.new(path, :is_bare=>bare)
+    end
+
+    #
+    # Pull down any changes.
+    #
+    def pull
+      repo.git.pull({}, 'origin', branch)
+    end
+
+    #
+    # The old name for #pull.
+    #
+    alias :update :pull
+
+    #
+    # Clone repo to path.
+    #
+    def clone
+      # dummy location
+      tmp = ::File.join(::Dir.tmpdir, 'smeagol', Time.to_i)
+      git = Grit::Git.new(tmp)
+      git.clone({:quiet=>false, :verbose=>true, :progress=>true, :branch=>branch}, origin, path)
+    end
+
+  end
+
+end

data/lib/smeagol/settings.rb

@@ -0,0 +1,302 @@
+module Smeagol
+
+  # Wiki settings.
+  #
+  # TODO: Would it be possible/prudent to move all this into controller?
+  class Settings
+
+    # The name of the settings file.
+    # TODO: Rename to `_smeagol.yml` ?
+    FILE = "_settings.yml"
+
+    # Default template includes directory.
+    PARTIALS = '_partials'
+
+    # Default site stage directory.
+    SITE_PATH = '_site'
+
+    # Default sync command.
+    SYNC_SCRIPT = "rsync -arv --del --exclude .git* '%s/' '%s/'"
+
+    #
+    # Load settings.
+    #
+    # wiki_dir - Local file system location of wiki repo. [String]
+    #
+    # Returns settings instance. [Settings]
+    #
+    def self.load(wiki_dir=nil)
+      wiki_dir = Dir.pwd unless wiki_dir
+      file = File.join(wiki_dir, FILE)
+      file = File.expand_path(file)
+      if File.exist?(file)
+        settings = YAML.load_file(file)
+      else
+        settings = {}
+      end
+
+      settings[:wiki_dir] = wiki_dir
+
+      new(settings)
+    end
+
+    #
+    # Initialize Settings.
+    #
+    # settings - Settings hash. [Hash]
+    #
+    def initialize(settings={})
+      @partials      = PARTIALS
+      @index         = 'Home'
+      @rss           = true
+      @exclude       = []
+      @include       = []
+      @site          = nil
+      @date_format   = "%B %d, %Y"
+      @site_stage    = nil
+      @site_sync     = SYNC_SCRIPT
+      #@static        = false
+      @mathjax       = true
+      @future        = false
+
+      # TODO: Raise error if no wiki_dir ?
+      @wiki_dir = settings[:wiki_dir]
+
+      assign(settings)
+    end
+
+    # Deprecated: Access settings like a Hash.
+    def [](key)
+      __send__(key)
+    end
+
+    # Assign settings hash via writer methods.
+    #
+    # Returns nothing.
+    def assign(settings={})
+      settings.each do |k,v|
+        __send__("#{k}=", v) if respond_to?("#{k}=")
+      end
+    end
+
+    # Deprecated: Alias for #assign.
+    alias update assign
+
+    # Internal: Do not set this settings.yml!
+    attr_accessor :wiki_dir
+
+    # Gollum wiki's repo uri.
+    # e.g. `git@github.com:trans/trans.github.com.wiki.git`
+    attr_accessor :wiki_origin
+
+    # The particular tag or reference id to serve. Default is 'master'.
+    attr_accessor :wiki_ref
+
+    # Site's URL. If someone wanted to visit your website, this
+    # is the link they would follow, e.g. `http://trans.github.com`
+    attr_accessor :url
+
+    # If a site is intended for static deployment, `static` should be set to `true`.
+    #attr_accessor :static
+
+    #
+    def site
+      {'stage'=>site_stage, 'origin'=>site_origin, 'branch'=>site_branch}
+    end
+
+    # If deployment of a site is done via git or via a staging directory,
+    # then `site` can be used to set these.
+    #
+    # Examples
+    #
+    #   site:
+    #     origin: git@github.com:trans/trans.github.com.git
+    #     branch: gh-pages
+    #     path: _site
+    #
+    def site=(entry)
+      case entry
+      when Hash
+        self.site_origin = site['origin']
+        self.site_branch = site['branch']
+        self.site_stage  = site['stage']
+        self.site_sync   = site['sync'] if site['sync']
+      else
+        raise ArgumentError, 'site must be a mapping'
+        # TODO: maybe make this smarter in future to guess if single entry is origin or stage.
+        #self.site_stage = entry
+      end
+    end
+
+    # If deployment of a site is done via git, then `site_origin` can be used to
+    # setup a Repository instance that can handle pulls and pushes automatically.
+    #
+    # Examples
+    #
+    #   site_origin: git@github.com:trans/trans.github.com.git
+    #
+    attr_accessor :site_origin
+
+    # Special branch if using silly branch style, e.g. `gh-pages`.
+    attr_accessor :site_branch
+
+    # Set `site_stage` if the site needs to be staged for deployment.
+    # In other words, if the servable files in the wiki need to be
+    # copied into a separate directory. This can be set to `true`
+    # in which case the default `_site` path will be used, otherwise
+    # set it to the path desired.
+    #
+    # Non-absolute paths are relative to the wiki's location.
+    # Be sure to add this to the wiki's .gitignore file, if it is, and
+    # if not prefixed by and underscore, be sure to add it to `exclude`
+    # setting as well.
+    attr_accessor :site_stage
+
+    # Smeagol uses `rsync` to copy files from the repository to
+    # the staging location if given by `site_path`. By default this
+    # command is:
+    #
+    #   "rsync -arv --del --exclude .git* %s/ %s/"
+    #
+    # Where the first %s is the repository location and the second is the location
+    # specified by the `site_path` setting. If this needs to be different it can
+    # be change here. Just be sure to honor the `%s` slots.
+    #
+    # If set to `~` (ie. `nil`) then the files will be copied directly
+    # to the site_path directory without using rsync.
+    attr_accessor :site_sync
+
+    # Where to find template partials. This is the location that Mustache uses
+    # when looking for partials. The default is `_partials`.
+    attr_accessor :partials
+
+    # Page to use as site index. The default is `Home`. A non-wiki
+    # page can be used as well, such as `index.html` (well, duh!).
+    attr_accessor :index
+
+    # Boolean flag to produce an rss.xml feed file for blog posts.
+    attr_accessor :rss
+
+    # Files to include that would not otherwise be included. A good example
+    # is `.htaccess` becuase dot files are excluded by default.
+    attr_accessor :include
+
+    # Files to exclude that would otherwise be included.
+    attr_accessor :exclude
+
+    # Include posts with future dates? By default all posts dated in the
+    # future are omitted.
+    attr_accessor :future
+
+    # Support the use of mathjax? Default is `true`.
+    attr_accessor :mathjax
+
+    # Do not load plugins. (TODO?)
+    #attr_accessor :safe
+
+    # TODO: I hate this. Make's me want to switch to Liquid templates.
+    #       Hurry up with Mustache 2.0 already!
+    attr_accessor :date_format
+
+    # Title of site.
+    attr_accessor :title
+
+    # Single line description of site.
+    attr_accessor :tagline
+
+    # Detailed description of site.
+    attr_accessor :description
+
+    # Primary author/maintainer of site.
+    attr_accessor :author
+
+    # Menu that can be used in site template.
+    #
+    # Note this will probably be deprecated as it is easy
+    # enough to add a menu to your site's custom page template.
+    #
+    # Examples
+    #
+    #   menu:
+    #   - title: Blog
+    #     href: /
+    #   - title: Projects
+    #     href: /Projects/
+    #   - title: Tools
+    #     href: /Tools/
+    #   - title: Reads
+    #     href: /Reads/
+    #
+    attr_accessor :menu
+
+    # Google analytics tracking id. Could be used for other such
+    # services if custom template is used.
+    #
+    # Note this will probably be deprecates because you can add
+    # the code snippet easily enough to your custom page template.
+    attr_accessor :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`.
+    #
+    # TODO: Rename this `github_forkme` or something like that.
+    #
+    # Examples
+    #
+    #   ribbon: red right
+    #
+    # Note this might be deprecated as one can add it by
+    # hand to custom page template.
+    attr_accessor :ribbon
+
+    # Project's development site, if applicable.
+    # e.g. `http://github.com/trans`
+    #
+    # TODO: Rename this field.
+    attr_accessor :source_url
+
+    # Expanded site directory.
+    #
+    # If `site_path` is an absolute path it will returned as given, 
+    # otherwise this will be relative to the location of the wiki.
+    #
+    # Returns String of site path.
+    def site_path
+      site_path = (TrueClass === site_stage ? SITE_PATH : site_stage || SITE_PATH)
+
+      path = relative?(site_path) ? ::File.join(wiki_dir, site_path) : site_path
+      path.chomp('/')  # ensure no trailing path separator
+      path
+    end
+
+    # Deprecated: Original name for #site_path.
+    alias :full_site_path :site_path
+
+    #
+    # Returns Repository object for git-based deployment site.
+    #
+    def site_repo
+      @site_repo ||= (
+        opts = (site || {}).dup
+        opts[:path] = site_path
+        Repository.new(opts)
+      )
+    end
+
+    #  P R I V A T E  M E T H O D S
+
+    private
+
+    #
+    def relative?(path)
+      return false if path =~ /^[A-Z]\:/
+      return false if path.start_with?(::File::SEPARATOR)
+      return false if path.start_with?('/')
+      #return false if path.start_with?('.')
+      return true
+    end
+
+  end
+
+end

data/lib/smeagol/templates/layouts/page.mustache

@@ -0,0 +1,19 @@
+{{> header}}
+
+<!-- CONTENT -->		
+<div id="wiki-content">
+<div class="wrap">
+  <div id="wiki-body" class="gollum-markdown-content">
+  <div id="template" class="markdown-body">
+{{#not_home?}}
+  <h1>{{page_title}}</h1>
+{{/not_home?}}
+{{{content}}}
+  </div>
+  </div>
+</div>
+</div>
+<!-- END CONTENT -->
+
+{{> footer}}
+

data/lib/smeagol/templates/layouts/versions.mustache

@@ -0,0 +1,16 @@
+{{> header}}
+
+<div id="wiki-content">
+<div class="wrap">
+
+  <h1>Versions</h1>
+
+  <div id="wiki-body">
+{{{content}}}
+  </div>
+
+</div>
+</div>
+
+{{> footer}}
+

data/lib/smeagol/templates/partials/footer.mustache

@@ -0,0 +1,17 @@
+<!-- FOOTER -->
+  <div id="footer">
+    {{#author}}
+    <small style="float:left;">Last edited by <b>{{author}}</b> on {{date}}.</small>
+    {{/author}}
+
+	  <small style="float:right;">
+		  This site is a <a href="https://github.com/blog/699-making-github-more-open-git-backed-wikis">GitHub Wiki</a>
+		  mirror powered by <a href="http://smeagolrb.info">Smeagol</a>.
+	  </small>
+  </div>
+
+</div>
+
+</body>
+</html>
+

data/lib/smeagol/templates/partials/header.mustache

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>{{wiki_title}} - {{page_title}}</title>
+
+  <meta http-equiv="Content-type" content="text/html;charset=utf-8">
+
+  <link rel="stylesheet" href="{{base_path}}assets/smeagol/gollum.css" type="text/css"/>
+  <link rel="stylesheet" href="{{base_path}}assets/smeagol/pygment.css" type="text/css"/>
+  <link rel="stylesheet" href="{{base_path}}assets/smeagol/template.css" type="text/css"/>
+
+  <!--[if lt IE 9]>
+  <script src="{{base_path}}assets/smeagol/html5.js"></script>
+  <![endif]-->
+
+  <script type="text/javascript" src="/javascript/editor/gollum.editor.js"></script>
+  {{#mathjax}}
+    <script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+  {{/mathjax}}
+
+{{#tracking_id}}
+  <script type="text/javascript">
+    var _gaq = _gaq || [];
+    _gaq.push(['_setAccount', '{{{tracking_id}}}']);
+    _gaq.push(['_trackPageview']);
+
+    (function() {
+      var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+      ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+      var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+    })();
+  </script>
+{{/tracking_id}}
+</head>
+
+<body>
+{{{ribbon_html}}}
+	
+<div id="wiki-wrapper" class="page">
+  <div id="head">
+	  <h1>{{wiki_title}}</h1>
+
+    <ul class="actions">
+		  {{{menu_html}}}
+    </ul>
+  </div>
+