documentation 0.0.1 → 1.0.0

data/app/assets/stylesheets/documentation/markdown.scss

@@ -0,0 +1,168 @@
+div.documentationMarkdown {
+	a { color:#35A4D4; text-decoration:none; border-bottom:1px solid #35A4D4; font-weight:600;}
+  
+	h1, h2 { font-size:1.6em; font-weight:300; margin:20px 0; border-bottom:1px solid #aecdda; padding-bottom:2px; color:#35A4D4;}
+	h3 { font-size:1.3em; font-weight:500; margin:20px 0; }
+	h4 { font-size:1.1em; font-weight:500; margin:20px 0;}
+	h5 { font-size:1.1em; font-weight:500; margin:20px 0;}
+
+	p { margin:20px 0; line-height:1.8;}
+
+	ul, ol { line-height:1.8em; margin:20px 0; margin-left:40px; }
+	ul li { background:image-url('documentation/pin.svg') no-repeat 0 5px; background-size:13px; padding-left:25px;}
+	ol { margin-left:65px;}
+	ol li { margin-bottom:20px;padding-left:15px;}
+	ol li:last-child { margin-bottom:0; }
+	ul.pages {
+		overflow:hidden;
+		li { background:image-url('documentation/page.svg') no-repeat 0 5px; background-size:13px; padding-left:25px; width:45%; float:left; margin-bottom:5px;}
+	}
+	
+	h2, h3, h4, h5 {
+		&:hover a.anchor { display:inline-block;}
+	}
+	
+	a.anchor { display:none; float:right; border:0; color:#999; width:16px; height:16px; background:image-url('documentation/link.svg'); opacity:0.6; background-size:16px; text-indent:-40000px;}
+	
+	p.recommendation {
+		background:image-url('documentation/recommendation.svg') #F5F7FB no-repeat 20px 16px;
+		background-size:20px;
+		border:1px solid #E4E7ED;
+		padding:15px;
+		margin-left:0;
+		margin-right:0;
+		padding-left:55px;
+	}
+	
+	p.warning {
+		background:image-url('documentation/warning.svg') #fffbec no-repeat 20px 18px;
+		background-size:20px;
+		border:1px solid #edda8c;
+		padding:15px;
+		color:#97894f;
+		margin-left:0;
+		margin-right:0;
+		padding-left:55px;
+	}
+
+	p.codeTitle {
+		background:#f7f7f7;
+		margin-bottom:0;
+		line-height:1;
+		border-top-left-radius:6px;
+		border-top-right-radius:6px;
+		padding:15px 20px;
+		font-size:0.9em;
+		font-weight:500;
+		color:#666;
+		border:1px solid #ddd;
+		border-bottom:0;
+	}
+	
+	p.codeTitle + div.highlight pre {
+		margin-top:0 !important;
+		border-top-left-radius:0;
+		border-top-right-radius:0;
+	}
+	
+	pre {
+		margin:25px 0;
+		line-height:1.4;
+		padding:20px;
+		border-radius:6px;
+		overflow-x:auto;
+		word-wrap: normal;
+	  white-space: pre;
+	}
+	
+	code { background:#F8F8F8; border:1px solid #ddd; border-radius:4px; padding:0px 5px; margin:0 2px; font-size:0.85em; white-space:pre; word-wrap:none;}
+	
+	.imgcontainer.center {
+		display:block;
+		margin:0 35px;
+		text-align:center;
+		img {
+			max-width:90%;
+		}
+	}
+	
+	table {
+		margin:25px 0;
+		min-width:100%;
+		td, th { border:1px solid #E4E7ED; padding:10px;}
+		th { background:#F5F7FB; color:#8E9BB4; font-weight:300; text-align:left;}
+	}
+	
+	.highlight {
+  	pre {
+  		font-family:Consolas, "Liberation Mono", Courier, monospace;
+  		font-size:15px;
+      background: #1d1f21; color: #c5c8c6;
+      .hll { background-color: #373b41 }
+      .c { color: #969896 } /* Comment */
+      .err { color: #cc6666 } /* Error */
+      .k { color: #b294bb } /* Keyword */
+      .l { color: #de935f } /* Literal */
+      .n { color: #c5c8c6 } /* Name */
+      .o { color: #8abeb7 } /* Operator */
+      .p { color: #c5c8c6 } /* Punctuation */
+      .cm { color: #969896 } /* Comment.Multiline */
+      .cp { color: #969896 } /* Comment.Preproc */
+      .c1 { color: #969896 } /* Comment.Single */
+      .cs { color: #969896 } /* Comment.Special */
+      .gd { color: #cc6666 } /* Generic.Deleted */
+      .ge { font-style: italic } /* Generic.Emph */
+      .gh { color: #c5c8c6; font-weight: bold } /* Generic.Heading */
+      .gi { color: #b5bd68 } /* Generic.Inserted */
+      .gp { color: #969896; font-weight: bold } /* Generic.Prompt */
+      .gs { font-weight: bold } /* Generic.Strong */
+      .gu { color: #8abeb7; font-weight: bold } /* Generic.Subheading */
+      .kc { color: #b294bb } /* Keyword.Constant */
+      .kd { color: #b294bb } /* Keyword.Declaration */
+      .kn { color: #8abeb7 } /* Keyword.Namespace */
+      .kp { color: #b294bb } /* Keyword.Pseudo */
+      .kr { color: #b294bb } /* Keyword.Reserved */
+      .kt { color: #f0c674 } /* Keyword.Type */
+      .ld { color: #b5bd68 } /* Literal.Date */
+      .m { color: #de935f } /* Literal.Number */
+      .s { color: #b5bd68 } /* Literal.String */
+      .na { color: #81a2be } /* Name.Attribute */
+      .nb { color: #c5c8c6 } /* Name.Builtin */
+      .nc { color: #f0c674 } /* Name.Class */
+      .no { color: #cc6666 } /* Name.Constant */
+      .nd { color: #8abeb7 } /* Name.Decorator */
+      .ni { color: #c5c8c6 } /* Name.Entity */
+      .ne { color: #cc6666 } /* Name.Exception */
+      .nf { color: #81a2be } /* Name.Function */
+      .nl { color: #c5c8c6 } /* Name.Label */
+      .nn { color: #f0c674 } /* Name.Namespace */
+      .nx { color: #81a2be } /* Name.Other */
+      .py { color: #c5c8c6 } /* Name.Property */
+      .nt { color: #8abeb7 } /* Name.Tag */
+      .nv { color: #cc6666 } /* Name.Variable */
+      .ow { color: #8abeb7 } /* Operator.Word */
+      .w { color: #c5c8c6 } /* Text.Whitespace */
+      .mf { color: #de935f } /* Literal.Number.Float */
+      .mh { color: #de935f } /* Literal.Number.Hex */
+      .mi { color: #de935f } /* Literal.Number.Integer */
+      .mo { color: #de935f } /* Literal.Number.Oct */
+      .sb { color: #b5bd68 } /* Literal.String.Backtick */
+      .sc { color: #c5c8c6 } /* Literal.String.Char */
+      .sd { color: #969896 } /* Literal.String.Doc */
+      .s2 { color: #b5bd68 } /* Literal.String.Double */
+      .se { color: #de935f } /* Literal.String.Escape */
+      .sh { color: #b5bd68 } /* Literal.String.Heredoc */
+      .si { color: #de935f } /* Literal.String.Interpol */
+      .sx { color: #b5bd68 } /* Literal.String.Other */
+      .sr { color: #b5bd68 } /* Literal.String.Regex */
+      .s1 { color: #b5bd68 } /* Literal.String.Single */
+      .ss { color: #b5bd68 } /* Literal.String.Symbol */
+      .bp { color: #c5c8c6 } /* Name.Builtin.Pseudo */
+      .vc { color: #cc6666 } /* Name.Variable.Class */
+      .vg { color: #cc6666 } /* Name.Variable.Global */
+      .vi { color: #cc6666 } /* Name.Variable.Instance */
+      .il { color: #de935f } /* Literal.Number.Integer.Long */
+  	}
+  }
+	
+}

data/app/assets/stylesheets/documentation/page_form.scss

@@ -0,0 +1,38 @@
+form.pageForm {
+	padding:15px 35px 25px 35px;
+	margin-top:10px;
+	input[type=text], textarea {
+	  width:100%;
+	  border:1px solid #c7cfde;
+	  padding:6px;
+	  background:#F5F7FB;
+	}
+	
+	p.title {
+		margin-bottom:15px;
+		input { font-size:1.3em; font-weight:normal; padding:10px;}
+	}
+	
+	p.content {
+		textarea {
+			width:100%;
+			min-height:300px;
+			font-size:0.9em;
+			line-height:1.4;
+			padding:10px;
+			font-family:'Consolas', Monaco, 'Courier New', Courier, fixed;
+			resize:none;
+		}
+	}
+	
+	dl {
+		margin:15px 0;
+		dt { width:120px; float:left; color:#999;padding-top:6px;}
+		dd { margin-left:160px; }
+		dd input { width:100%; font-size:1.1em;}
+	}
+	
+	p.submit {
+		text-align:right;
+	}
+}

data/app/assets/stylesheets/documentation/reset.scss

@@ -0,0 +1,101 @@
+html, body, body div, span, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, abbr, address, cite, code, del, dfn, em, img, ins, kbd, q, samp, small, strong, sub, sup, var, b, i, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, figure, footer, header, hgroup, menu, nav, section, time, mark, audio, video {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	outline: 0;
+	font-size: 100%;
+	letter-spacing:0;
+	vertical-align: baseline;
+	background: transparent;
+	font-weight:normal;
+}
+
+article, aside, figure, footer, header, hgroup, nav, section {display: block;}
+
+img,object,embed {max-width: 100%;}
+ul {list-style: none;}
+blockquote, q {quotes: none;}
+b,strong { font-weight: bold;}
+blockquote:before, blockquote:after, q:before, q:after {content: ''; content: none;}
+
+a {margin: 0; padding: 0; font-size: 100%; vertical-align: baseline; background: transparent;}
+
+del {text-decoration: line-through;}
+
+abbr[title], dfn[title] {border-bottom: 1px dotted #000; cursor: help;}
+
+/* tables still need cellspacing="0" in the markup */
+table {border-collapse: collapse; border-spacing: 0;}
+th {font-weight: bold; vertical-align: bottom;}
+td {font-weight: normal; vertical-align: top;}
+
+hr {display: block; height: 1px; border: 0; border-top: 1px solid #ccc; margin: 1em 0; padding: 0;}
+
+input, select {vertical-align: middle;}
+
+pre {
+	white-space: pre; /* CSS2 */
+	white-space: pre-wrap; /* CSS 2.1 */
+	white-space: pre-line; /* CSS 3 (and 2.1 as well, actually) */
+	word-wrap: break-word; /* IE */
+}
+
+input[type="radio"] {vertical-align: text-bottom;}
+input[type="checkbox"] {vertical-align: bottom; *vertical-align: baseline;}
+.ie6 input {vertical-align: text-bottom;}
+
+select, input, textarea {font: 99% sans-serif;}
+
+table {font-size: inherit; font: 100%;}
+ 
+/* Accessible focus treatment
+	people.opera.com/patrickl/experiments/keyboard/test */
+a:hover, a:active {outline: none;}
+
+small {font-size: 85%;}
+
+strong, th {font-weight: bold;}
+
+td, td img {vertical-align: top;} 
+
+/* Make sure sup and sub don't screw with your line-heights
+	gist.github.com/413930 */
+sub, sup {font-size: 75%; line-height: 0; position: relative;}
+sup {top: -0.5em;}
+sub {bottom: -0.25em;}
+
+/* standardize any monospaced elements */
+pre, code, kbd, samp {font-family: monospace, sans-serif;}
+
+/* hand cursor on clickable elements */
+.clickable,
+label, 
+input[type=button], 
+input[type=submit], 
+button {cursor: pointer;}
+
+/* Webkit browsers add a 2px margin outside the chrome of form elements */
+button, input, select, textarea {margin: 0;}
+
+/* make buttons play nice in IE */
+button {width: auto; overflow: visible;}
+ 
+/* scale images in IE7 more attractively */
+.ie7 img {-ms-interpolation-mode: bicubic;}
+
+/* prevent BG image flicker upon hover */
+.ie6 html {filter: expression(document.execCommand("BackgroundImageCache", false, true));}
+
+/* let's clear some floats */
+.clearfix:before, .clearfix:after { content: "\0020"; display: block; height: 0; overflow: hidden; }  
+.clearfix:after { clear: both; }  
+.clearfix { zoom: 1; }  
+
+select, input, textarea, a { outline: none;}
+
+
+input, textarea {
+	-webkit-box-sizing: border-box; /* Safari/Chrome, other WebKit */
+	-moz-box-sizing: border-box;    /* Firefox, other Gecko */
+	box-sizing: border-box;         /* Opera/IE 8+ */
+}

data/app/controllers/documentation/application_controller.rb

@@ -0,0 +1,21 @@
+module Documentation
+  class ApplicationController < ActionController::Base
+    
+    rescue_from Documentation::AccessDeniedError do |e|
+      render :template => 'documentation/shared/access_denied', :layout => false
+    end
+    
+    rescue_from ActiveRecord::RecordNotFound do |e|
+      render :template => 'documentation/shared/not_found', :layout => false
+    end
+    
+    private
+    
+    def authorizer
+      @authorizer ||= Documentation.config.authorizer.new(self)
+    end
+    
+    helper_method :authorizer
+    
+  end
+end

data/app/controllers/documentation/pages_controller.rb

@@ -0,0 +1,74 @@
+module Documentation
+  class PagesController < Documentation::ApplicationController
+
+    before_filter :find_page, :only => [:show, :edit, :new, :destroy, :positioning]
+    
+    def show
+      authorizer.check! :view_page, @page
+    end
+    
+    def edit
+      authorizer.check! :edit_page, @page
+      
+      if request.patch?
+        if @page.update_attributes(safe_params)
+          redirect_to page_path(@page.full_permalink), :notice => "Page has been saved successfully."
+          return
+        end
+      end
+      render :action => "form"
+    end
+
+    def new
+      authorizer.check! :add_page, @page
+      
+      parent = @page
+      @page = Page.new(:title => "Untitled Page")
+      if @page.parent = parent
+        @page.parents = parent.breadcrumb
+      end
+
+      if request.post?
+        @page.attributes = safe_params
+        if @page.save
+          redirect_to page_path(@page.full_permalink), :notice => "Page created successfully"
+          return
+        end
+      end
+      render :action => "form"
+    end
+
+    def destroy
+      authorizer.check! :delete_page, @page
+      @page.destroy
+      redirect_to @page.parent ? page_path(@page.parent.full_permalink) : root_path, :notice => "Page has been removed successfully."
+    end
+
+    def positioning
+      authorizer.check! :reposition_page, @page
+      @pages = @page ? @page.children : Page.roots
+      if request.post?
+        Page.reorder(@page, params[:order])
+        render :json => {:status => 'ok'}
+      end
+    end
+    
+    def search
+      authorizer.check! :search
+      @result = Documentation::Page.search(params[:query], :page => params[:page].blank? ? 1 : params[:page].to_i)
+    end
+
+    private
+
+    def find_page
+      if params[:path]
+        @page = Page.find_from_path(params[:path])
+      end
+    end
+
+    def safe_params
+      params.require(:page).permit(:title, :permalink, :content, :favourite)
+    end
+
+  end
+end

data/app/helpers/documentation/application_helper.rb

@@ -0,0 +1,13 @@
+module Documentation
+  module ApplicationHelper
+    
+    include Documentation::ViewHelpers
+    
+    def flash_messages
+      flashes = flash.collect do |key,msg|
+        content_tag :div, content_tag(:p, h(msg)), :id => "flash-#{key}"
+      end.join.html_safe
+    end
+    
+  end
+end

data/app/models/documentation/page.rb

@@ -0,0 +1,213 @@
+module Documentation
+  class Page < ActiveRecord::Base
+    
+    validates :title, :presence => true
+    validates :position, :presence => true
+    validates :permalink, :presence => true, :uniqueness => {:scope => :parent_id}
+    
+    default_scope -> { order(:position) }
+    scope :roots, -> { where(:parent_id => nil) }
+    
+    belongs_to :parent, :class_name => 'Documentation::Page', :foreign_key => 'parent_id'
+    
+    before_validation do
+      if self.position.blank?
+        last_position = self.class.unscoped.where(:parent_id => self.parent_id).order(:position => :desc).first
+        self.position = last_position ? last_position.position + 1 : 1
+      end
+    end
+    
+    before_validation :set_permalink
+    before_save :compile_content
+    
+    #
+    # Ensure the page is updated in the index after saving/destruction
+    #
+    after_commit :index, :on => [:create, :update]
+    after_commit :delete_from_index, :on => :destroy
+
+    #
+    # Store all the parents of this object. THis is automatically populated when it is loaded
+    # from a path
+    #
+    attr_accessor :parents
+    
+    #
+    # Set the permalink for this page
+    #
+    def set_permalink
+      proposed_permalink = self.title.parameterize
+      index = 1
+      while self.permalink.blank?
+        if self.class.where(:permalink => proposed_permalink, :parent_id => self.parent_id).exists?
+          index += 1
+          proposed_permalink = self.title.parameterize + "-#{index}"
+        else
+          self.permalink = proposed_permalink
+        end
+      end
+    end
+    
+    #
+    # Return a default empty array for parents
+    #
+    def parents
+      @parents ||= self.parent ? [self.parent.parents, self.parent].flatten : []
+    end
+
+    #
+    # Return a full breadcrumb to this page (as it has been loaded)
+    #
+    def breadcrumb
+      @breadcrumb ||= [parents, new_record? ? nil : self].flatten.compact
+    end
+    
+    #
+    # Return the path where this page can be viewed in the site
+    #
+    def preview_path
+      if path = Documentation.config.preview_path_prefix
+        "#{path}#{full_permalink}"
+      else
+        nil
+      end
+    end
+    
+    #
+    # Return a full permalink tot his page
+    #
+    def full_permalink
+      @full_permalink ||= begin
+        if parents.empty?
+          self.permalink
+        else
+          previous = breadcrumb.compact.map(&:permalink).compact
+          previous.empty? ? self.permalink : previous.join('/')
+        end
+      end
+    end
+
+    #
+    # Return all child pages
+    #
+    def children
+      @children ||= begin
+        if self.new_record?
+          []
+        else
+          children = self.class.where(:parent_id => self.id)
+          children.each { |c| c.parents = [parents, self].flatten }
+          children
+        end
+      end
+    end
+
+    #
+    # Does this page have children?
+    #
+    def has_children?
+      !children.empty?
+    end
+
+    #
+    # Return pages which should be included in the navigation
+    #
+    def navigation
+      if has_children?
+        root_parent = parents[-1]
+        if root_parent.nil?
+          pages = self.class.roots
+        else
+          pages = (root_parent || self).children
+        end
+      else
+        root_parent = parents[-2] || parents[-1]
+        if root_parent.nil? || (root_parent.parent.nil? && parents.size <= 1)
+          pages = self.class.roots
+        else
+          pages = (root_parent || self).children
+        end
+      end
+      
+      
+      pages.map do |c|
+        child_pages = []
+        child_pages = c.children if breadcrumb.include?(c)
+        [c, child_pages]
+      end
+    end
+
+    #
+    # Create the compiled content
+    #
+    def compile_content
+      mr = Documentation::MarkdownRenderer.new
+      mr.page = self
+      rc = Redcarpet::Markdown.new(mr, :space_after_headers => true, :fenced_code_blocks => true, :no_intra_emphasis => true, :highlight => true)
+      self.compiled_content = rc.render(self.content.to_s).html_safe
+    end
+    
+    #
+    # Index this page
+    #
+    def index
+      if searcher = Documentation.config.searcher
+        searcher.index(self)
+      end
+    end
+    
+    #
+    # Delete this page from the index
+    #
+    def delete_from_index
+      if searcher = Documentation.config.searcher
+        searcher.delete(self)
+      end
+    end
+    
+    #
+    # Find a page using the searcher if one exists otherwise just fall back to AR
+    # searching. Returns a Documentation::SearchResult object.
+    #
+    def self.search(query, options = {})
+      if searcher = Documentation.config.searcher
+        searcher.search(query, options)
+      end
+    end
+
+    #
+    # Find a page by passing a path to the page from the root of the 
+    # site
+    #
+    def self.find_from_path(path_string)
+      raise ActiveRecord::RecordNotFound, "Couldn't find page without a path" if path_string.blank?
+      path_parts = path_string.split('/')
+      path = []
+      path_parts.each_with_index do |p, i|
+        page = self.where(:parent_id => (path.last ? path.last.id : nil)).find_by_permalink(p)
+        if page
+          page.parents = path.dup
+          page.parent = path.last
+          path << page
+        else
+          raise ActiveRecord::RecordNotFound, "Couldn't find page at #{path_string}"
+        end
+      end
+      path.last
+    end
+
+    #
+    # Reorder pgaes
+    #
+    def self.reorder(parent, order = [])
+      order = order.map(&:to_i)
+      order = self.where(:parent_id => parent.id).map(&:id) if order.empty?
+      order.each_with_index do |id, index|
+        command = self.find_by_id!(id)
+        command.position = index + 1
+        command.save
+      end
+    end
+    
+  end
+end