documentarian 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODgzMmM2ZjVjNjRhMzE1MGYzYmQ4MjFmNzcxYzlmMDc0YjcyODI3OQ==
+  data.tar.gz: !binary |-
+    NGZhOTdjZTk3NzkxZGViYzIxOWM1ODU3ZDlmMGUwYmM1ZTkzZmQwZA==
+SHA512:
+  metadata.gz: !binary |-
+    NmU0MmM3YzRmNjgzYzE2MzcyZWRiMTM5MDZkMjdmOTcyNDRkYWE5NjQzMzY2
+    NmRiNTZhOGY3ZDQ3MmRiNzZlZWRhNDE3YzIxNjBhYzA0MmFkNDhiOGVmYzIy
+    NDAzYmMxNzY0NTBmNWU0ZjU5M2IzZTRlOGYzZmM2M2ZjZjAxYTk=
+  data.tar.gz: !binary |-
+    MTU2MTllZjM4MDJkN2M2MjIzYTEzMWNlOTFhY2NiNzRlOWNmYjk4YTVmMzRl
+    MTg3MzkyODZmZGZlNDhmY2E3YmVhYmZmM2MwY2Y0ODQ4MGExNjE4YzFmNTBk
+    NTk4MTI1YjA5YWNmN2U4MmM5YTVlODQ1YjA5NDRjYWUwNDIzNjc=

data/app/assets/javascripts/documentarian/application.js

@@ -0,0 +1,14 @@
+$(document).ready(function() {
+  $('pre').each(function(i, el) {
+    var lang = $(el).attr('lang')
+    if (lang) {
+      $(el).children('code').addClass($(el).attr('lang'));
+    } else {
+      $(el).children('code').addClass($(el).attr('nohighlight'));
+    }
+  })
+
+  $('pre[lang] > code').each(function(i, block) {
+    hljs.highlightBlock(block);
+  });
+});

data/app/assets/stylesheets/documentarian/application.scss

@@ -0,0 +1,506 @@
+html, body {
+  padding: 0;
+  margin: 0;
+  height: 100%;
+  width: 100%;
+}
+.clear {
+  clear: both;
+}
+
+#document-content {
+  clear: left;
+  float: left;
+  width: 100%;
+  overflow: hidden;
+}
+#navigation-content {
+  float: left;
+  width: 100%;
+  position: relative;
+  right: 80%;
+  background-color: #efefef;
+}
+#navigation {
+  float: left;
+  width: 20%;
+  position: relative;
+  left: 80%;
+  overflow: hidden;
+}
+#document {
+  float: left;
+  width: 80%;
+  position: relative;
+  left: 80%;
+  overflow: hidden;
+}
+
+
+#content {
+  width:100%;
+}
+#navigation {
+  width:20%;
+  float: left;
+  ul {
+    list-style: none;
+    width:100%;    
+    margin: 0;
+    padding: 0;
+    li {
+      span {
+        display: block;
+        padding: 10px 15px;
+        a {
+          text-decoration: none;
+          color: #43B4DD;    
+        }
+        &.active {
+          border-left: 5px solid #43B4DD;
+          a {
+            font-weight: bold; 
+          }
+        }
+      }
+      > ul {
+        display: none;
+      }
+      &.show {
+        > ul {
+        display: block;
+        }
+      }
+    }
+  }
+}
+
+#document {
+  padding: 20px;
+  float: left;
+  border-radius: 5px;
+  width: 75%;
+  overflow:hidden;
+  font-family:"Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif;
+  font-size:16px;
+  line-height:1.6;
+  word-wrap:break-word
+}
+#document>*:first-child {
+  margin-top:0 !important
+}
+#document>*:last-child {
+  margin-bottom:0 !important
+}
+#document a {
+  color: #43B4DD;
+}
+#document a:visited {
+  color: #43B4DD;
+}
+#document a:not([href]) {
+  color:inherit;
+  text-decoration:none
+}
+#document a[name] {
+  color:inherit;
+  text-decoration:none
+}
+#document h1,
+#document h2,
+#document h3,
+#document h4,
+#document h5,
+#document h6 {
+  position:relative;
+  margin-top:1em;
+  margin-bottom:16px;
+  font-weight:bold;
+  line-height:1.4
+}
+
+#document h1 tt,
+#document h1 code,
+#document h2 tt,
+#document h2 code,
+#document h3 tt,
+#document h3 code,
+#document h4 tt,
+#document h4 code,
+#document h5 tt,
+#document h5 code,
+#document h6 tt,
+#document h6 code {
+  font-size:inherit
+}
+#document h1 {
+  padding-bottom:0.3em;
+  font-size:2.25em;
+  line-height:1.2;
+  border-bottom:1px solid #eee
+}
+#document h2 {
+  padding-bottom:0.3em;
+  font-size:1.75em;
+  line-height:1.225;
+  border-bottom:1px solid #eee
+}
+#document h3 {
+  font-size:1.5em;
+  line-height:1.43
+}
+#document h4 {
+  font-size:1.25em
+}
+#document h5 {
+  font-size:1em
+}
+#document h6 {
+  font-size:1em;
+  color:#777
+}
+#document p,
+#document blockquote,
+#document ul,
+#document ol,
+#document dl,
+#document table,
+#document pre {
+  margin-top:0;
+  margin-bottom:15px
+}
+#document hr {
+  height:4px;
+  padding:0;
+  margin:16px 0;
+  background-color:#e7e7e7;
+  border:0 none
+}
+#document ul,
+#document ol {
+  padding-left:2em
+}
+#document ul.no-list,
+#document ol.no-list {
+  padding:0;
+  list-style-type:none
+}
+#document ul ul,
+#document ul ol,
+#document ol ol,
+#document ol ul {
+  margin-top:0;
+  margin-bottom:0
+}
+#document li>p {
+  margin-top:16px
+}
+#document dl {
+  padding:0
+}
+#document dl dt {
+  padding:0;
+  margin-top:16px;
+  font-size:1em;
+  font-style:italic;
+  font-weight:bold
+}
+#document dl dd {
+  padding:0 16px;
+  margin-bottom:16px
+}
+#document blockquote {
+  padding:0 15px;
+  color:#777;
+  border-left:4px solid #ddd
+}
+#document blockquote>:first-child {
+  margin-top:0
+}
+#document blockquote>:last-child {
+  margin-bottom:0
+}
+#document table {
+  display:block;
+  width:100%;
+  overflow:auto;
+  word-break:normal;
+  word-break:keep-all
+}
+#document table th {
+  font-weight:bold
+}
+#document table th,
+#document table td {
+  padding:6px 13px;
+  border:1px solid #ddd
+}
+#document table tr {
+  background-color:#fff;
+  border-top:1px solid #ccc
+}
+#document table tr:nth-child(2n) {
+  background-color:#f8f8f8
+}
+#document img {
+  max-width:100%;
+  box-sizing:border-box
+}
+#document .emoji {
+  max-width:none
+}
+#document span.frame {
+  display:block;
+  overflow:hidden
+}
+#document span.frame>span {
+  display:block;
+  float:left;
+  width:auto;
+  padding:7px;
+  margin:13px 0 0;
+  overflow:hidden;
+  border:1px solid #ddd
+}
+#document span.frame span img {
+  display:block;
+  float:left
+}
+#document span.frame span span {
+  display:block;
+  padding:5px 0 0;
+  clear:both;
+  color:#333
+}
+#document span.align-center {
+  display:block;
+  overflow:hidden;
+  clear:both
+}
+#document span.align-center>span {
+  display:block;
+  margin:13px auto 0;
+  overflow:hidden;
+  text-align:center
+}
+#document span.align-center span img {
+  margin:0 auto;
+  text-align:center
+}
+#document span.align-right {
+  display:block;
+  overflow:hidden;
+  clear:both
+}
+#document span.align-right>span {
+  display:block;
+  margin:13px 0 0;
+  overflow:hidden;
+  text-align:right
+}
+#document span.align-right span img {
+  margin:0;
+  text-align:right
+}
+#document span.float-left {
+  display:block;
+  float:left;
+  margin-right:13px;
+  overflow:hidden
+}
+#document span.float-left span {
+  margin:13px 0 0
+}
+#document span.float-right {
+  display:block;
+  float:right;
+  margin-left:13px;
+  overflow:hidden
+}
+#document span.float-right>span {
+  display:block;
+  margin:13px auto 0;
+  overflow:hidden;
+  text-align:right
+}
+#document code,
+#document tt {
+  padding:0;
+  padding-top:2px;
+  padding-bottom:2px;
+  margin:0;
+  color: #c5c8c6;
+  font-size:85%;
+  background-color:#000000;
+  border-radius:3px
+}
+#document code:before,
+#document code:after,
+#document tt:before,
+#document tt:after {
+  letter-spacing:-0.2em;
+  content:"\00a0"
+}
+#document code br,
+#document tt br {
+  display:none
+}
+#document del code {
+  text-decoration:inherit
+}
+#document pre>code {
+  padding:0;
+  margin:0;
+  font-size:100%;
+  word-break:normal;
+  white-space:pre;
+  background:transparent;
+  border:0
+}
+#document .highlight {
+  margin-bottom:16px
+}
+#document .highlight pre,
+#document pre {
+  overflow:auto;
+  font-size: 12px;
+  line-height: normal;
+  background-color:#000000;
+  border-radius:5px;
+  padding: 0px 0px 15px 25px;
+}
+#document .highlight pre {
+  margin-bottom:0;
+  word-break:normal
+}
+#document pre {
+  word-wrap:normal
+}
+#document pre code,
+#document pre tt {
+  max-width:initial;
+  padding:0;
+  margin:0;
+  overflow:initial;
+  line-height:inherit;
+  word-wrap:normal;
+  background-color:transparent;
+  border:0
+}
+#document pre code:before,
+#document pre code:after,
+#document pre tt:before,
+#document pre tt:after {
+  content:normal
+}
+#document kbd {
+  display:inline-block;
+  padding:3px 5px;
+  font-size:11px;
+  line-height:10px;
+  color:#555;
+  vertical-align:middle;
+  background-color:#fcfcfc;
+  border:solid 1px #ccc;
+  border-bottom-color:#bbb;
+  border-radius:3px;
+  box-shadow:inset 0 -1px 0 #bbb
+}
+
+
+/* Tomorrow Night Theme */
+/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
+
+/* Tomorrow Comment */
+.hljs-comment {
+  color: #969896;
+}
+
+/* Tomorrow Red */
+.hljs-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-regexp,
+.ruby .hljs-constant,
+.xml .hljs-tag .hljs-title,
+.xml .hljs-pi,
+.xml .hljs-doctype,
+.html .hljs-doctype,
+.css .hljs-id,
+.css .hljs-class,
+.css .hljs-pseudo {
+  color: #cc6666;
+}
+
+/* Tomorrow Orange */
+.hljs-number,
+.hljs-preprocessor,
+.hljs-pragma,
+.hljs-built_in,
+.hljs-literal,
+.hljs-params,
+.hljs-constant {
+  color: #de935f;
+}
+
+/* Tomorrow Yellow */
+.ruby .hljs-class .hljs-title,
+.css .hljs-rule .hljs-attribute {
+  color: #f0c674;
+}
+
+/* Tomorrow Green */
+.hljs-string,
+.hljs-value,
+.hljs-inheritance,
+.hljs-header,
+.hljs-name,
+.ruby .hljs-symbol,
+.xml .hljs-cdata {
+  color: #b5bd68;
+}
+
+/* Tomorrow Aqua */
+.hljs-title,
+.css .hljs-hexcolor {
+  color: #8abeb7;
+}
+
+/* Tomorrow Blue */
+.hljs-function,
+.python .hljs-decorator,
+.python .hljs-title,
+.ruby .hljs-function .hljs-title,
+.ruby .hljs-title .hljs-keyword,
+.perl .hljs-sub,
+.javascript .hljs-title,
+.coffeescript .hljs-title {
+  color: #81a2be;
+}
+
+/* Tomorrow Purple */
+.hljs-keyword,
+.javascript .hljs-function {
+  color: #b294bb;
+}
+
+.hljs {
+  display: block;
+  overflow-x: auto;
+  background: #1d1f21;
+  color: #c5c8c6;
+  padding: 0.5em;
+  -webkit-text-size-adjust: none;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+  opacity: 0.5;
+}

data/app/controllers/documentarian/application_controller.rb

@@ -0,0 +1,9 @@
+module Documentarian
+  class ApplicationController < ActionController::Base
+    def build
+      Documentarian.load
+      Rails.cache.clear
+      redirect_to root_path
+    end
+  end
+end

data/app/controllers/documentarian/documentation_controller.rb

@@ -0,0 +1,18 @@
+module Documentarian
+  class DocumentationController < ApplicationController
+
+    caches_action :show, :cache_path => Proc.new { |c| c.params }
+    
+    def index  
+    end
+
+    def show
+      @resource = Documentarian::Resource.get(params[:slug]) or redirect_to root_path
+    end
+
+    def asset
+      send_file Documentarian::AssetProxy.link(params[:path]), disposition: 'inline'
+    end
+
+  end
+end

data/app/helpers/documentarian/application_helper.rb

@@ -0,0 +1,4 @@
+module Documentarian
+  module ApplicationHelper
+  end
+end

data/app/views/documentarian/application/_navigation.html.haml

@@ -0,0 +1,4 @@
+%ul.top
+  - Documentarian::Resource.roots.each do |resource|
+    - next if resource.directory_overview?
+    = render :partial => 'navigation_item', :locals => {:resource => resource}

data/app/views/documentarian/application/_navigation_item.html.haml

@@ -0,0 +1,9 @@
+- children = resource.children
+%li.collapsible{:class => Regexp.new(resource.slug) =~ params[:slug] && :show}
+  %span.part{:class => resource.slug == params[:slug] && :active}
+    %a{:href => documentation_path(resource)}= resource.title
+  - if !children.empty?
+    %ul
+      - resource.children.each do |resource|
+        - next if resource.directory_overview?
+        = render :partial => 'navigation_item', :locals => {:resource => resource}

data/app/views/documentarian/documentation/show.html.haml

@@ -0,0 +1,5 @@
+- if @resource.directory?
+  - if preview = @resource.directory_overview
+    != preview.to_html
+- else
+  != @resource.to_html

data/app/views/layouts/documentarian/application.html.haml

@@ -0,0 +1,20 @@
+!!!
+%html
+  %head
+    %title Documentarian
+
+    = stylesheet_link_tag 'documentarian/application', media: 'all'
+    = javascript_include_tag '//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js'
+    = javascript_include_tag 'documentarian/application'
+    = javascript_include_tag '//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.7/highlight.min.js'
+
+    = csrf_meta_tags
+
+  %body
+    #document-content
+      #navigation-content
+        #navigation
+          = render :partial => 'navigation'
+        #document
+          = yield
+        .clear

data/config/routes.rb

@@ -0,0 +1,5 @@
+Documentarian::Engine.routes.draw do
+  root                    :to => "documentation#index"
+  get '/assets/*path',    :to => "documentation#asset", :as => :asset,         :format => false
+  get '/*slug',           :to => "documentation#show",  :as => :documentation, :format => false
+end

data/lib/documentarian/asset_proxy.rb

@@ -0,0 +1,7 @@
+module Documentarian
+  module AssetProxy
+    def self.link(path)
+      File.join(Configuration.asset_path, path)
+    end
+  end
+end

data/lib/documentarian/engine.rb

@@ -0,0 +1,5 @@
+module Documentarian
+  class Engine < ::Rails::Engine
+    isolate_namespace Documentarian
+  end
+end

data/lib/documentarian/navigation.rb

@@ -0,0 +1,5 @@
+module Documentarian
+  module Navigation
+    
+  end
+end

data/lib/documentarian/resource.rb

@@ -0,0 +1,76 @@
+module Documentarian  
+  class Resource < Pathname
+
+    alias_method :body, :read
+
+    def self.roots
+      Documentarian.resources.select { |resource|
+        String(resource.relative_path).split('/').length == 1
+      }.sort_by { |resource|
+        [resource.directory? ? 0 : 1, resource.title]
+      }
+    end
+
+    def self.get(slug)
+      Documentarian.resources.find { |resource| resource.slug == slug }
+    end
+
+    def children
+      return [] if !directory?
+      items = (super).map {|item| String(item)}
+      Documentarian.resources.select { |resource|
+        items.include?(String(resource))
+      }.sort
+    end
+
+    def directory_overview
+      return nil unless directory?
+      siblings.find { |sibling| sibling.title == self.title }
+    end
+
+    def directory_overview?
+      return false if directory?
+      siblings.find { |sibling| sibling.directory? && sibling.title == self.title }
+    end
+
+    def siblings
+      Documentarian.resources.find { |resource| 
+        resource.to_s == parent.to_s 
+      }.try(:children).try(:select, &Proc.new{ |child| child != self }) || []
+    end
+
+    def relative_path
+      relative_path_from(Configuration.documentation_path)
+    end
+
+    def slug
+      @slug ||= String(relative_path)
+        .gsub(/[^\w\/\.]/, '_')
+        .downcase
+    end
+
+    def title
+      String(basename).gsub(Regexp.new("(%s)$" % Configuration.extensions.join('|')), '')
+    end
+
+    def to_param
+      slug
+    end
+
+    def to_html
+      Documentarian::Resource::Renderer.render(self)
+    end
+
+    module Renderer
+      
+      class << self
+        include Documentarian::Engine.routes.url_helpers
+        def render(resource)
+          GitHub::Markdown.render(ERB.new(resource.body).result(binding))
+        end
+      end
+      
+    end
+
+  end
+end

data/lib/documentarian.rb

@@ -0,0 +1,46 @@
+require 'pathname'
+require 'github/markdown'
+require 'documentarian/engine'
+require 'documentarian/asset_proxy'
+require 'documentarian/resource'
+
+module Documentarian
+  mattr_accessor :resources
+
+  module Configuration
+    mattr_accessor :root
+    mattr_accessor :extensions
+
+    def self.root=(value)
+      @@root ||= Pathname.new(value)
+    end
+
+    def self.documentation_path
+      Pathname.new(File.join(self.root, 'documentation'))
+    end
+
+    def self.asset_path
+      Pathname.new(File.join(self.root, 'assets'))
+    end
+
+  end
+  
+  def self.install
+    yield Configuration
+    self.load
+  end
+
+  def self.resources
+    @@resources ||= []
+  end
+  
+  def self.load
+    Dir[File.join(Configuration.documentation_path, '**/*{%s}' % Configuration.extensions.join(','))].each do |path|
+      Pathname.new(path).relative_path_from(Configuration.documentation_path).descend do |relative_path|
+        relative_resource = Resource.new(File.join(Configuration.documentation_path, relative_path))
+        self.resources    << relative_resource unless self.resources.include?(relative_resource)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: documentarian
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christopher Jaeger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: jaeger.ca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/documentarian/application.js
+- app/assets/stylesheets/documentarian/application.scss
+- app/controllers/documentarian/application_controller.rb
+- app/controllers/documentarian/documentation_controller.rb
+- app/helpers/documentarian/application_helper.rb
+- app/views/documentarian/application/_navigation.html.haml
+- app/views/documentarian/application/_navigation_item.html.haml
+- app/views/documentarian/documentation/index.html.haml
+- app/views/documentarian/documentation/show.html.haml
+- app/views/layouts/documentarian/application.html.haml
+- config/routes.rb
+- lib/documentarian.rb
+- lib/documentarian/asset_proxy.rb
+- lib/documentarian/engine.rb
+- lib/documentarian/navigation.rb
+- lib/documentarian/resource.rb
+- lib/tasks/documentarian.rake
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Documentation
+test_files: []