docushin 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff44f887590f3c84d28dc2956398a3a647b861ce
+  data.tar.gz: 1f3bb7880b63f6989f74d89bbfc46c07ce8edbcb
+SHA512:
+  metadata.gz: cdc378fb7c22a1e920e793f51ac1e861a5414aef39446b688378b97f7cb1567fe8c9620633315d1c4ceb8cf3c3a887bf22b60271951acc9c77e9bf6201816a10
+  data.tar.gz: abe028ef7c8e8412e0733c04de4600476611205bf0311448f0390a84a2841262706f84eaa984d3007191ee34dc65577336faf41865676876488192a8bd7891ea

data/.gitignore

@@ -1,5 +1,8 @@
 *.gem
 *.rbc
+*.log
+.\#*
+\#*\#
 .bundle
 .config
 .yardoc
@@ -8,10 +11,11 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc
+spec/dummy/log/test.log
+spec/dummy/log/development.log
 spec/reports
 test/tmp
 test/version_tmp

data/app/controllers/docushin/application_controller.rb

@@ -0,0 +1,19 @@
+module Docushin
+  class ApplicationController < ActionController::Base
+    layout "docushin"
+
+    private
+    def authorize!
+      render :text => "Unauthorized" unless Rails.env.development?
+      return false
+    end
+
+    def load_route_set
+      @route_set = Docushin::RouteSet.new
+    end
+
+    def set_default_base_path
+      File.join(Rails.root, 'doc', 'docushin')
+    end
+  end
+end

data/app/controllers/docushin/collections_controller.rb

@@ -0,0 +1,42 @@
+module Docushin
+  class CollectionsController < Docushin::ApplicationController
+    before_filter :authorize!, :only => [:edit, :update, :destroy]
+    before_filter :set_default_base_path, :load_route_set
+
+    def index
+      @content = YAML.load_documents(File.open(File.join(Rails.root, "doc", "docushin", "collections.yml"))) rescue nil
+      @collections = @content.nil? ? [] : @content
+    end
+
+    def show
+    end
+
+    def new
+    end
+
+    def edit
+    end
+
+    def destroy
+      @content = YAML.load_documents(File.open(File.join(Rails.root, "doc", "docushin", "collections.yml"))) rescue nil
+      @content.reject! {|obj| obj[:id] == params[:id]}
+      File.open(File.join(set_default_base_path,"collections.yml"), "w") do |file|
+        @content.each do|item|
+          file.write item.to_yaml
+        end
+        file.close
+      end
+      redirect_to collections_path
+    end
+
+    def create
+      params[:title] =  params[:title].blank? ? "Default Title" : params[:title]
+      @data = {:id => Digest::MD5.hexdigest(DateTime.now.to_s), :title => params[:title], :route_set_ids => params[:route_set_ids] }
+      FileUtils.mkdir_p(set_default_base_path) unless File.exists?(set_default_base_path)
+      File.open(File.join(set_default_base_path,"collections.yml"), "a+") do |file|
+        file.write @data.to_yaml
+        file.close
+      end
+    end
+  end
+end

data/app/controllers/docushin/home_controller.rb

@@ -0,0 +1,12 @@
+module Docushin
+  class HomeController < Docushin::ApplicationController
+    before_filter :load_route_set
+
+    def index
+      @routes = Dir["#{File.join(Rails.root, "doc/docushin")}/*.md"].collect do |file|
+        @route_set.find(File.basename(file, ".md"))
+      end
+      @routes = @routes.compact.sort_by(&:updated_at).reverse.take(10)
+    end
+  end
+end

data/app/controllers/docushin/routes_controller.rb

@@ -1,36 +1,23 @@
-class Docushin::RoutesController < ActionController::Base
-  layout 'docushin'
-  before_filter :load_route_set
+module Docushin
+  class RoutesController < Docushin::ApplicationController
+    before_filter :load_route_set
+    before_filter :authorize!, :only => [:edit, :update]
 
-  def index
-  end
-
-  def show
-    @route = @routes_collection.find_by_filename_hash(params[:id])
-  end
-
-  def edit
-    @route = @routes_collection.find_by_filename_hash(params[:id])
-  end
+    def index
+    end
 
-  def update
-    @route = @routes_collection.find_by_filename_hash(params[:id])
-    #create the directory if it doesnt exists
-    FileUtils.mkdir_p(@path) unless File.exists?(@path)
+    def show
+      @route = @route_set.find(params[:id])
+    end
 
-    File.open(File.join(@path, @route.file_name) + ".md", "w+") do |file|
-      file.write "---\n"
-      file.write "description: " + params[:route][:description] + "\n"
-      file.write "---\n"
-      file.write params[:route][:content]
-      file.close
+    def edit
+      @route = @route_set.find(params[:id])
     end
-    redirect_to routes_path
-  end
 
-  private
-  def load_route_set
-    @routes_collection = Docushin::RouteSet.new 
-    @path = File.join(Rails.root, 'doc', 'docushin')
+    def update
+      @route = @route_set.find(params[:id])
+      @route.update_attributes(params[:route])
+      redirect_to routes_path
+    end
   end
-end
+end

data/app/helpers/docushin/application_helper.rb

@@ -6,5 +6,8 @@ module Docushin
     def file_exists?(verb, path)
       File.exists?(File.join(Rails.root, 'doc', 'docushin', generate_name(verb, path)) + '.md')
     end
+    def is_in_dev?
+      Rails.env.development?
+    end
   end
 end

data/app/views/docushin/collections/create.html.erb

@@ -0,0 +1 @@
+Awesome

data/app/views/docushin/collections/index.html.erb

@@ -0,0 +1,23 @@
+<% if @collections.empty? %>
+  <h2> You haven't created collections yet. </h2>
+<% else %>
+  <% @collections.each do |collection| %>
+    <table>
+      <tr><th><%= collection[:title]%> <span><%= link_to("x", collection_path(collection[:id]), :method => :delete) %></span></th></tr>
+      <% collection[:route_set_ids].each do |item| %>
+  	<tr>
+  	  <p>
+	    <% route = @route_set.find(item) %>
+  	    <% if route.saved? %>
+  	      <td><%= link_to "#{route.description}", route_path(item), :title => "#{route.verb} #{route.path}" %></td>
+  	    <% else %>
+  	      <td><%= link_to "Add description to #{route.path}", route_path(item) %></td>
+  	    <% end %>
+  	  </p>
+  	</tr>
+      <% end %>
+    </table>
+  <% end %>
+<% end %>
+
+<%= link_to "Create a new Collection", new_collection_path%>

data/app/views/docushin/collections/new.html.erb

@@ -0,0 +1,52 @@
+<script type="text/javascript">
+$(document).ready(function() {
+  $("ul.droptrue").sortable({
+    connectWith: "ul"
+  });
+  $("#sortable, #sortable_container").disableSelection();
+  return $("#create_collection").submit(function(e) {
+    e.preventDefault();
+    var routeSetIds = new Array();
+    $.each($("#sortable_container li"), function(key, item) {
+      return routeSetIds.push($(item).attr("id"));
+    });
+    return $.post($(this).attr("action"), {
+      route_set_ids: routeSetIds,
+      title: $("#title").val()
+    }, function(data) {
+      return window.location.replace(window.location.href.replace("/new", ""));
+    });
+  });
+});
+</script>
+<h2>Create a new collection</h2>
+<%= form_tag collections_path, :id => "create_collection" do %>
+<table>
+  <tr>
+    <td>
+      Title:
+    </td>
+    <td>
+      <%= text_field_tag :title %>
+    </td>
+  </tr>
+  <tr>
+    <td colspan="2">
+      <ul id="sortable" class="droptrue">
+	<% @route_set.routes.each do |route| %>
+	  <li class="ui-state-highlight" id="<%= route.id %>">
+	    <span class="label"><%= route.verb %></span> <%= link_to route.path, route_path(:id => generate_name(route.verb, route.path)) %>
+	  </li>
+	<% end %>
+      </ul>
+      <ul id="sortable_container" class="droptrue container">
+      </ul>
+    </td>
+    <td>
+    </td>
+  </tr>
+</table>
+<div class="actions">
+  <%= submit_tag %>
+</div>
+<% end %>

data/app/views/docushin/home/index.html.erb

@@ -0,0 +1,25 @@
+<% unless @routes.empty? %>
+  <div>
+    <h3>Recent updates</h3>
+    <table>
+      <thead>
+	<tr>
+	  <th>Resource</th>
+	  <th>Updated at</th>
+	</tr>
+      </thead>
+      <tbody>
+	<% @routes.each do |item|%>
+	  <tr>
+	    <td>
+	      <%= link_to item.verb + " " + item.path, route_path(:id => generate_name(item.verb, item.path)) %>
+	    </td>
+	    <td>
+	      <%= time_ago_in_words(Time.at(item.updated_at))%> ago
+	    </td>
+	  </tr>
+	<% end %>
+      </tbody>
+    </table>
+  </div>
+<% end %>

data/app/views/docushin/routes/_form.html.erb

@@ -1,24 +1,90 @@
 <h3 id="title"><%= @route.verb + " " + @route.path %></h3>
 <%= form_for(@route) do |f| %>
-  <table>
-    <tr>
-      <td>
-        <%= f.label :description %>
-      </td>
-      <td>
-        <%= f.text_field :description %>
-      </td>
-    </tr>
-    <tr>
-      <td>
-        <%= f.label :content %> 
-      </td>
-      <td>
-        <%= f.text_area(:content, :cols => 50, :rows => 20) %>
-      </td>
-    </tr>
-  </table>
-  <div class="actions">
-    <%= f.submit %>
-  </div>
+<table>
+  <tr>
+    <td>
+      <%= f.label :description %>
+    </td>
+    <td>
+      <%= f.text_field :description %>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <%= f.label :content %> 
+    </td>
+    <td>
+      <%= f.text_area(:content, :cols => 50, :rows => 20) %>
+    </td>
+  </tr>
+  <tr>
+    <td>
+    </td>
+    <td>
+
+      Docushin parses documents with GitHub Flavored Markdown. Scroll down to read the documentation.
+    </td>
+  </tr>
+</table>
+<div class="actions">
+  <%= f.submit %>
+</div>
 <% end %>
+<div class="content">
+  <h2>Markdown Cheat Sheet</h2>
+
+  <div class="cheatsheet-content">
+
+  <div class="mod">
+    <div class="col">
+      <h3>Format Text</h3>
+      <p>Headers</p>
+      <pre># This is an &lt;h1&gt; tag
+## This is an &lt;h2&gt; tag
+###### This is an &lt;h6&gt; tag</pre>
+     <p>Text styles</p>
+     <pre>*This text will be italic*
+_This will also be italic_
+**This text will be bold**
+__This will also be bold__
+
+*You **can** combine them*
+</pre>
+    </div>
+    <div class="col">
+      <h3>Lists</h3>
+      <p>Unordered</p>
+      <pre>* Item 1
+* Item 2
+  * Item 2a
+  * Item 2b</pre>
+     <p>Ordered</p>
+     <pre>1. Item 1
+2. Item 2
+3. Item 3
+   * Item 3a
+   * Item 3b</pre>
+    </div>
+    <div class="col">
+      <h3>Miscellaneous</h3>
+      <p>Images</p>
+      <pre>![GitHub Logo](/images/logo.png)
+Format: ![Alt Text](url)
+</pre>
+     <p>Links</p>
+     <pre>http://github.com - automatic!
+[GitHub](http://github.com)</pre>
+<p>Blockquotes</p>
+     <pre>As Kanye West said:
+
+&gt; We're living the future so
+&gt; the present is our past.
+</pre>
+    </div>
+  </div>
+  <div class="rule"></div>
+
+  </div>
+
+  </div><p>
+  <a href="http://github.github.com/github-flavored-markdown/" class="gfm-help" target="_blank">GitHub Flavored Markdown</a></p>

data/app/views/docushin/routes/index.html.erb

@@ -1,24 +1,24 @@
-<% @routes_collection.routes.group_by{ |r| r.controller }.each do |controller, routes| %>
-<h2><%= controller.titleize %></h2>
+<h3>Application Routes</h3>
+<% @route_set.routes.group_by{ |r| r.controller }.each do |controller, routes| %>
 <table>
   <thead>
     <tr>
-      <th>Resource</th>
+      <th><%= controller.titleize.gsub("/", "::") %></th>
       <th>Description</th>
     </tr>
   </thead>
-  <tbody>       
-    <% routes.each do |route|%>     
+  <tbody>
+    <% routes.each do |route|%>
        <tr>
           <td class="resource">
-            <%= link_to route.verb + " " + route.path, route_path(:id => generate_name(route.verb, route.path)) %>
+            <%= link_to "#{route.verb} #{route.path}", route_path(:id => generate_name(route.verb, route.path)) %>
           </td>
           <td>
             <% if file_exists?(route.verb, route.path) %>
               <%= route.description %>
-              <%= link_to 'Update', edit_route_path(generate_name(route.verb, route.path))%>
+              <%= link_to 'Update', edit_route_path(generate_name(route.verb, route.path)) if is_in_dev?%>
             <% else %>
-              <%= link_to 'Create a description', edit_route_path(generate_name(route.verb, route.path))%>
+              <%= link_to 'Create a description', edit_route_path(generate_name(route.verb, route.path))  if is_in_dev?%>
             <% end %>
           </td>
        </tr>

data/app/views/docushin/routes/show.html.erb

@@ -1,7 +1,8 @@
 <h1 id="title"><%= @route.verb + " " + @route.path %></h1>
-<h3>Route url</h3>
-<%= File.join(request.protocol, request.host, @route.path) %>
-<h3>Description</h3>
+<p><pre class="route-url"><%= File.join(request.protocol, request.host_with_port, @route.path) %></pre></p>
 <%= @route.description %>
-<h3>Content</h3>
-<%= @route.content %>
+<div class="markdown"><%= @route.content %></div>
+<%= button_to  "Update", edit_route_path(generate_name(@route.verb, @route.path)), :method => :get %>
+<% if @route.updated_at %>
+<h4>This document has been updated at: <%= Time.at(@route.updated_at).strftime('%H:%M:%S, %A %d, %B') %></h4>
+<% end %>

data/app/views/layouts/docushin.html.erb

@@ -3,98 +3,129 @@
 <head>
   <meta charset="utf-8" />
   <title>Routes</title>
+
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.9.2/jquery-ui.js"></script>
+  <script src="https://raw.github.com/rails/jquery-ujs/master/src/rails.js"></script>
+
+  <script src="https://raw.github.com/coreyti/showdown/v0.3.1/src/showdown.js"></script>
+  <script src="https://raw.github.com/coreyti/showdown/v0.3.1/src/extensions/github.js"></script>
+  <script src="https://raw.github.com/coreyti/showdown/v0.3.1/src/extensions/table.js"></script>
+
+  <script src="https://raw.github.com/ccampbell/rainbow/1.1.8/js/rainbow.js"></script>
+  <script src="https://raw.github.com/ccampbell/rainbow/1.1.8/js/language/generic.js"></script>
+  <script src="https://raw.github.com/ccampbell/rainbow/1.1.8/js/language/javascript.js"></script>
+
+  <script>
+  $(document).ready(function() {
+    var converter = new Showdown.converter({extensions: ["github"] });
+    $(".markdown").each(function() {
+      console.log(this)
+      $(this).html(converter.makeHtml($(this).text()));
+    });
+  });
+  </script>
+
   <style>
-    body { background-color: #fff; color: #333; margin: 0px; }
+    body{background-color:#fff;color:#333;margin:0;}
+    body,p,ol,ul,td{font-family:helvetica, verdana, arial, sans-serif;font-size:13px;line-height:18px;}
+    ul.droptrue{list-style-type:none;float:left;}
+    ul.droptrue.container{min-height:250px;min-width:350px;background:#FFF;border:1px solid gray;}
+
+    #container{width:960px;padding-top:50px;margin:0 auto;}
+    #header-outer{position:fixed;width:100%;top:0;height:40px;z-index:999;-moz-box-shadow:0 1px 3px rgba(0,0,0,0.25),0 -1px 0 rgba(0,0,0,0.1) inset;-webkit-box-shadow:0 1px 3px rgba(0,0,0,0.25),0 -1px 0 rgba(0,0,0,0.1) inset;box-shadow:0 1px 3px rgba(0,0,0,0.25),0 -1px 0 rgba(0,0,0,0.1) inset;background:#00A0D1 repeat-x 0 0;}
+    #header{width:960px;margin:0 auto;}
+    #logo{float:left;padding-left:32px;display:block;height:40px;color:#FFF;font-size:150%;font-weight:200;line-height:38px;}
+    .label{display:inline-block;font-size:11.844px;font-weight:700;line-height:14px;color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.25);white-space:nowrap;vertical-align:baseline;background-color:#999;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px;padding:2px 4px;}
+    .route-url{background:#EAF2F5;display:inline-block;margin-right:8px;font-size:12px;line-height:24px;border-radius:3px;padding:0 5px;}
+
+    h1{font-size:28px;font-weight:300;line-height:1.1;margin-bottom:.75em;}
+    table{width:100%;margin:0 0 3em;}
+    tr:hover td,tr:hover td.active{background:#F8F8F8;}
+    td{vertical-align:top;background:#FFF;padding:8px 0;}
+    th{text-align:left;border-bottom:1px solid #EEE;}
+    td.resource{width:60%;}
+    pre{background-color:#eee;font-size:11px;white-space:pre-wrap;padding:10px;}
+    a{text-decoration:none;color:#0080A6;}
+    a:visited{color:#0080A6;}
+    a:hover{text-decoration:underline;color:#0080A6;}
+    a.logo{color:#FFF;text-decoration:none;}
+    li a:hover{background:#0089B3;color:#FFF;text-decoration:none;}
+
+    #title-nav{margin-bottom:0;margin-top:0;}
+    #title-nav li{position:relative;float:left;display:block;line-height:40px;margin-left:20px;padding:0;}
+    #title-nav a{display:block;-webkit-font-smoothing:subpixel-antialiased;text-shadow:0 -1px 0 rgba(0,0,0,0.3);outline:none;color:#BFE4EF;padding:0 10px;}
 
-    body, p, ol, ul, td {
-      font-family: helvetica, verdana, arial, sans-serif;
-      font-size:   13px;
-      line-height: 18px;
-    }
-    #container {
-      width: 960px;
-      margin: 0 auto;
-      padding-top: 50px;
-    }
-    #header-outer {
-      position: fixed;
-      width: 100%;
-      top: 0;
-      height: 40px;
-      z-index: 999;
-      -moz-box-shadow: 0 1px 3px rgba(0,0,0,0.25),0 -1px 0 rgba(0,0,0,0.1) inset;
-      -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.25),0 -1px 0 rgba(0, 0, 0, 0.1) inset;
-      box-shadow: 0 1px 3px rgba(0, 0, 0, 0.25),0 -1px 0 rgba(0, 0, 0, 0.1) inset;
-      background: #00A0D1 repeat-x 0 0;
-    }
-    #header {
-      width: 960px;
-      margin: 0 auto;
-    }
-    #logo {
-      float: left;
-      padding-left: 32px;
-      display: block;
-      height: 40px;
-      color: white;
-      font-size: 150%;
-      font-weight: 200;
-      line-height: 38px;
-    }
-    h1 {
-      font-size: 3em;
-      font-weight: 300;
-      line-height: 1.1;
-      margin-bottom: 0.75em;
-    }
-    table {
-      margin: 0 0 3em 0;
-      width: 100%;
-    }
-    tr:hover td, tr:hover td.active {
-      background: #F8F8F8;
-    }
-    td {
-      padding: 8px 0 8px 0;
-      vertical-align: top;
-      background: white;
-    }
-    th {
-      text-align: left;
-      border-bottom: 1px solid #EEE;
-    }
-    td.resource {
-      width: 320px;
-    }
-    pre {
-      background-color: #eee;
-      padding: 10px;
-      font-size: 11px;
-      white-space: pre-wrap;
-    }
+    .right{float:right;}
+    .markdown{padding-top:10px;padding-bottom:10px;font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:13px;line-height:1.6;}
+    .markdown>:first-child{margin-top:0!important;}
+    .markdown>:last-child{margin-bottom:0!important;}
+    .markdown a{color:#4183C4;text-decoration:none;}
+    .markdown a:hover{text-decoration:underline;}
+    .markdown h1,.markdown h2,.markdown h3,.markdown h4,.markdown h5,.markdown h6{font-weight:700;-webkit-font-smoothing:antialiased;margin:20px 0 10px;padding:0;}
+    .markdown h1 tt,.markdown h1 code,.markdown h2 tt,.markdown h2 code,.markdown h3 tt,.markdown h3 code,.markdown h4 tt,.markdown h4 code,.markdown h5 tt,.markdown h5 code,.markdown h6 tt,.markdown h6 code{font-size:inherit;}
+    .markdown h1{font-size:28px;color:#000;}
+    .markdown h2{font-size:24px;border-bottom:1px solid #ccc;color:#000;}
+    .markdown h3{font-size:18px;}
+    .markdown h4{font-size:16px;}
+    .markdown h5{font-size:14px;}
+    .markdown h6{color:#777;font-size:14px;}
+    .markdown p,.markdown blockquote,.markdown ul,.markdown ol,.markdown dl,.markdown li,.markdown table,.markdown pre{margin:15px 0;}
+    .markdown hr{border:0 none;color:#ccc;height:4px;padding:0;}
+    .markdown>h2:first-child,.markdown>h1:first-child,.markdown>h1:first-child+h2,.markdown>h3:first-child,.markdown>h4:first-child,.markdown>h5:first-child,.markdown>h6:first-child{margin-top:0;padding-top:0;}
+    .markdown li p.first{display:inline-block;}
+    .markdown ul,.markdown ol{padding-left:30px;}
+    .markdown dl dt{font-size:14px;font-weight:700;font-style:italic;margin:15px 0 5px;padding:0;}
+    .markdown dl dd{margin:0 0 15px;padding:0 15px;}
+    .markdown blockquote{border-left:4px solid #DDD;color:#777;padding:0 15px;}
+    .markdown table{border-collapse:collapse;border-spacing:0;font-size:100%;font:inherit;padding:0;}
+    .markdown table tr{border-top:1px solid #ccc;background-color:#fff;margin:0;padding:0;}
+    .markdown table tr:nth-child(2n){background-color:#f8f8f8;}
+    .markdown table tr th{font-weight:700;}
+    .markdown table tr th,.markdown table tr td{border:1px solid #ccc;text-align:left;margin:0;padding:6px 13px;}
+    .markdown img{max-width:100%;}
+    .markdown span.frame{display:block;overflow:hidden;}
+    .markdown span.frame>span{border:1px solid #ddd;display:block;float:left;overflow:hidden;width:auto;margin:13px 0 0;padding:7px;}
+    .markdown span.frame span img{display:block;float:left;}
+    .markdown span.frame span span{clear:both;color:#333;display:block;padding:5px 0 0;}
+    .markdown span.align-center>span{display:block;overflow:hidden;text-align:center;margin:13px auto 0;}
+    .markdown span.align-center span img{text-align:center;margin:0 auto;}
+    .markdown span.align-right>span{display:block;overflow:hidden;text-align:right;margin:13px 0 0;}
+    .markdown span.align-right span img{text-align:right;margin:0;}
+    .markdown span.float-left{display:block;margin-right:13px;overflow:hidden;float:left;}
+    .markdown span.float-left span{margin:13px 0 0;}
+    .markdown span.float-right{display:block;margin-left:13px;overflow:hidden;float:right;}
+    .markdown span.float-right>span{display:block;overflow:hidden;text-align:right;margin:13px auto 0;}
+    .markdown code,.markdown tt{white-space:nowrap;border:1px solid #eaeaea;background-color:#f8f8f8;border-radius:3px;margin:0 2px;padding:0 5px;}
+    .markdown pre>code{white-space:pre;border:none;background:transparent;margin:0;padding:0;}
+    .markdown .highlight pre,.markdown pre{background-color:#f8f8f8;border:1px solid #ccc;font-size:13px;line-height:19px;overflow:auto;border-radius:3px;padding:6px 10px;}
+    .markdown pre code,.markdown pre tt{background-color:transparent;border:none;}
+    .markdown h1+p,.markdown h2+p,.markdown h3+p,.markdown h4+p,.markdown h5+p,.markdown h6+p,.markdown ul li>:first-child,.markdown ol li>:first-child,.markdown dl dt>:first-child,.markdown dl dd>:first-child,.markdown blockquote>:first-child,.markdown table tr th>:first-child,.markdown table tr td>:first-child{margin-top:0;}
+    .markdown ul li>:last-child,.markdown ol li>:last-child,.markdown dl dt>:last-child,.markdown dl dd>:last-child,.markdown blockquote>:last-child,.markdown table tr th>:last-child,.markdown table tr td>:last-child{margin-bottom:0;}
+    .markdown dl,.markdown dl dt:first-child{padding:0;}
+    .markdown span.align-center,.markdown span.align-right{display:block;overflow:hidden;clear:both;}
 
-    a {
-      text-decoration: none; 
-      color: #0080A6; }
-    a:visited { color: #0080A6; }
-    a:hover {
-      text-decoration: underline;
-      color: #0080A6;
-    }
-    a.logo{
-      color: white;
-      text-decoration: none;
-    }
+    .rainbow{word-wrap:break-word;background:transparent;}
+    .rainbow .comment{color:#999;}
+    .rainbow .constant{color:#f26521;}
+    .rainbow .string,.rainbow .comment.docstring{color:#854a6f;}
+    .rainbow .entity{color:#4da943;}
+    .rainbow .support,.rainbow .function.call{color:#b6a500;}
+    .rainbow .variable{color:#1e4c66;}
   </style>
 </head>
 <body>
   <div id="header-outer">
     <div id="header">
-      <div id="logo"><%= link_to "Docushin", routes_path, :class => "logo" %></div>
-    </div>    
+      <div id="logo"><%= link_to "Docushin", root_path, :class => "logo" %></div>
+      <ul id="title-nav">
+	<li class="leaf"><%= link_to "Routes", routes_path %></li>
+        <li class="leaf last"><%= link_to "Collections", collections_path %></li>
+      </ul>
+    </div>
   </div>
   <div id="container">
     <%= yield %>
   </div>
 </body>
-</html>
+</html>

data/config/routes.rb

@@ -1,3 +1,5 @@
 Docushin::Engine.routes.draw do
+  root :to => "home#index"
   resources :routes, :except => :destroy
-end
+  resources :collections
+end

data/docushin.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["tagrudev@gmail.com", "aganov@gmail.com"]
   gem.description   = %q{Builds documentation based on your Ruby on Rails application routes.}
   gem.summary       = %q{Useful for generating docs on your routes.}
-  gem.homepage    = "http://github.com/appsbakery/docushin"
+  gem.homepage    = "http://appsbakery.github.com/docushin/"
 
 
   gem.files         = `git ls-files`.split($\)
@@ -20,4 +20,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "pry"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec", "~> 2.0"
+  gem.add_development_dependency "capybara"
+  gem.add_development_dependency "capybara-webkit"
 end

data/lib/docushin.rb

@@ -4,4 +4,13 @@ require "docushin/version"
 require "docushin/route_set"
 
 module Docushin
+  mattr_accessor :path_regexp
+  @@path_regexp = nil
+
+  mattr_accessor :data_fields
+  @@data_fields = [:description]
+
+  def self.setup
+    yield self
+  end
 end

data/lib/docushin/route.rb

@@ -1,4 +1,5 @@
 require 'digest/md5'
+require 'active_support/core_ext/hash/indifferent_access'
 
 module Docushin
   class Route
@@ -15,8 +16,9 @@ module Docushin
     attr_accessor :data
     attr_accessor :file_name
     attr_accessor :content
-    attr_accessor :description
-    
+
+    alias :id :file_name
+
     def initialize(route)
       @controller = route.defaults[:controller]
       @base = File.join(Rails.root, 'doc', 'docushin')
@@ -25,28 +27,67 @@ module Docushin
       @path = route.path.spec.to_s.sub('(.:format)', '')
       @requirements = route.requirements
       @file_name = Digest::MD5.hexdigest(@verb.to_s + @path)
-      rtfm(@base, @file_name) if File.exists?(File.join(@base, @file_name)  + '.md')
+      self.load
     end
 
-    def persisted?
-      true
+    def description
+      @data["description"]
     end
 
-    alias :id :file_name
+    def updated_at
+      @data["updated_at"] || File.mtime(File.join(@base,"#{@file_name}.md")).to_i rescue nil
+    end
 
-    def rtfm(base, name)
-      @content = File.read(File.join(base, name) + '.md')
+    # Updates the attributes of the model from the passed-in hash
+    # and saves the route
+    def update_attributes(attributes)
+      attributes.to_hash
+      self.attributes = attributes
+      self.save
+    end
+
+    def attributes=(attributes)
+      attributes = attributes.with_indifferent_access.to_hash
+      @content = attributes.delete("content")
+      @data = attributes
+    end
+
+    # Saves the route
+    #
+    # If the route is new, a document gets created in the doc folder, otherwise
+    # the existing document gets updated.
+    def save
+      @data["updated_at"] = DateTime.now.to_i
+      FileUtils.mkdir_p(@base) unless File.exists?(@base)
+      File.open(File.join(@base,"#{@file_name}.md"), "w+") do |file|
+        file.write @data.to_yaml
+        file.write "---\n"
+        file.write @content
+        file.close
+      end
+    end
+
+    # Return true if file/route is saved
+    def saved?
+      File.exists?(File.join(@base, "#{@file_name}.md")) ? true : false
+    end
+
+    def persisted?
+      true
+    end
 
+    # Read route's documentation
+    def load
       begin
+        @content = File.read(File.join(@base, "#{@file_name}.md"))
         if @content =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
           @content = $'
           @data = YAML.load($1)
-          @description = @data['description']
         end
       rescue => e
-        # puts "Exception reading #{name}: #{e.message}"
+        # Do nothing
       end
       @data ||= {}
     end
   end
-end
+end

data/lib/docushin/route_set.rb

@@ -1,20 +1,29 @@
 module Docushin
   class RouteSet
     attr_accessor :routes
-    
+
     def initialize
       @routes = []
       Rails.application.routes.routes.each do |route|
-        next if route.app.is_a?(ActionDispatch::Routing::Mapper::Constraints)
+        # next if route.app.is_a?(ActionDispatch::Routing::Mapper::Constraints)
         next if route.app.is_a?(Sprockets::Environment)
         next if route.app == Docushin::Engine
 
         if (rack_app = discover_rack_app(route.app)) && rack_app.respond_to?(:routes)
           rack_app.routes.routes.each do |rack_route|
-            @routes << Route.new(rack_route)
-          end
+            add_route Route.new(rack_route)
+          end if rack_app.routes.respond_to?(:routes)
         end
-        @routes << Route.new(route)
+
+        add_route Route.new(route)
+      end
+    end
+
+    def add_route(route)
+      if Docushin.path_regexp.nil?
+        @routes << route
+      else
+        @routes << route if route.path.match(Docushin.path_regexp)
       end
     end
 
@@ -27,10 +36,11 @@ module Docushin
       end
     end
 
-    def find_by_filename_hash(hash)
+    def find(hash)
       @routes.each do |route|
-        return route if route.file_name == "#{hash}"
+        return route if route.id == hash
       end
+      nil
     end
   end
-end
+end

data/lib/docushin/version.rb

@@ -1,3 +1,3 @@
 module Docushin
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/docushin/route_set_spec.rb

@@ -3,8 +3,8 @@ require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 describe Docushin::RouteSet do
   describe 'Build route set from routes' do
     let(:routes_collection) { Docushin::RouteSet.new }
-    it 'should have attr_accessor routes that is an array' do 
+    it 'should have attr_accessor routes that is an array' do
       routes_collection.routes.class.should == Array
     end
   end
-end
+end

data/spec/docushin/route_spec.rb

@@ -5,35 +5,48 @@ describe Docushin::Route do
   let(:route) { route_set.routes.first }
 
   describe 'create a new Route' do
-    it 'should have name, verb, path, requirements, data, content as attr' do 
+    it 'should have name, verb, path, requirements, data, content as attr' do
       route.should respond_to(:name)
       route.should respond_to(:verb)
       route.should respond_to(:path)
       route.should respond_to(:requirements)
+      route.should respond_to(:updated_at)
       route.should respond_to(:base)
       route.should respond_to(:data)
       route.should respond_to(:file_name)
       route.should respond_to(:content)
       route.should respond_to(:description)
+      route.should respond_to(:updated_at)
     end
   end
 
-  describe 'inspect the new Route' do 
-    it 'should have attr defined' do 
+  describe 'inspect the new Route' do
+    it 'should have attr defined' do
       route.base.should == File.join(Rails.root, 'doc', 'docushin')
-      route.file_name.should == Digest::MD5.hexdigest(route.verb.to_s + route.path) 
+      route.file_name.should == Digest::MD5.hexdigest(route.verb.to_s + route.path)
       route.name.should == "foo_index"
       route.path.should == "/foo"
       route.requirements.should == {:action=>"index", :controller=>"foo"}
       route.verb.should == "GET"
-    end    
+    end
   end
 
   describe 'read markdown file' do
-    it 'should generate data and content' do 
-      route.data.should == {"description"=>"I am so awesome"}
+    it 'should generate data and content' do
       route.description.should == "I am so awesome"
-      route.content.should == "{\"id\":\"4f3a296ac8de6732fe000003\",\"first_name\":\"Todor\",\"last_name\":\"Grudev\",\"username\":null,\"bio\":null,\"gender\":\"male\",\"email\":\"tagrudev@gmail.com\"}"
+      route.content.should == "{\"id\":\"4f3a296ac8de6732fe000003\",\"first_name\":\"Todor\",\"last_name\":\"Grudev\",\"gender\":\"male\",\"email\":\"tagrudev@gmail.com\"}\n"
+    end
+  end
+  describe 'update markdown file' do
+    it 'should update specified attributes' do
+      route.save
+      route.updated_at.should == File.mtime(File.join(route.base, "#{route.file_name}.md")).to_i
+    end
+  end
+
+  describe 'check if route is saved' do
+    it 'should return true if the file/route exists' do
+      route.saved?.should == true
     end
   end
-end
+end

data/spec/dummy/config/routes.rb

@@ -1,5 +1,5 @@
 Rails.application.routes.draw do
+  mount Docushin::Engine, :at =>"docushin"
   resources :foo
   resources :bar
 end
-

data/spec/dummy/doc/docushin/collections.yml

@@ -0,0 +1,7 @@
+---
+:id: !binary |-
+  YTljYTNiN2VmMmE1MjBlZDllYWYzZjMzMmI4NDUyMWQ=
+:title: A
+:route_set_ids:
+- fff1454d69c4340014bef52217525fed
+

data/spec/dummy/doc/docushin/fff1454d69c4340014bef52217525fed.md

@@ -0,0 +1,5 @@
+---
+description: I am so awesome
+updated_at: 1355303015
+---
+{"id":"4f3a296ac8de6732fe000003","first_name":"Todor","last_name":"Grudev","gender":"male","email":"tagrudev@gmail.com"}

data/spec/requests/collections_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/requests_helper')
+
+feature 'Visit Collections of Docushin', 'I am so awesome I want to be able to make some collections' do
+  let(:route_set) { Docushin::RouteSet.new }
+  let(:route) { route_set.routes.first }
+
+  scenario 'I click on the collections page' do
+    visit "/docushin/collections"
+    page.should have_content("Create a new Collection")
+  end
+end

data/spec/requests/home_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/requests_helper')
+
+feature 'Visit Home of Docushin', 'I am so awesome I want to be able to go to my docushin home path' do
+  scenario 'I click on the home page' do
+    visit "/docushin"
+    page.should have_content("Recent updates")
+  end
+end

data/spec/requests/requests_helper.rb

@@ -0,0 +1 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")

data/spec/requests/routes_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/requests_helper')
+
+feature 'Visit Routes of Docushin', 'Visiting #mount_path/routes should display/group all my routes' do
+  scenario 'I visit the routes path' do
+    visit "/docushin/routes"
+  end
+end

data/spec/spec_helper.rb

@@ -4,7 +4,9 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 ENV["RAILS_ENV"] ||= 'test'
 require File.expand_path("../../spec/dummy/config/environment", __FILE__)
 
-require 'rubygems'
+
+require 'capybara/rails'
+require 'capybara/rspec'
 require 'bundler/setup'
 require 'docushin'
 require 'pry'

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docushin
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Todor Grudev
@@ -10,60 +9,53 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2013-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -71,11 +63,38 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-webkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Builds documentation based on your Ruby on Rails application routes.
 email:
 - tagrudev@gmail.com
@@ -90,8 +109,15 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/controllers/docushin/application_controller.rb
+- app/controllers/docushin/collections_controller.rb
+- app/controllers/docushin/home_controller.rb
 - app/controllers/docushin/routes_controller.rb
 - app/helpers/docushin/application_helper.rb
+- app/views/docushin/collections/create.html.erb
+- app/views/docushin/collections/index.html.erb
+- app/views/docushin/collections/new.html.erb
+- app/views/docushin/home/index.html.erb
 - app/views/docushin/routes/_form.html.erb
 - app/views/docushin/routes/edit.html.erb
 - app/views/docushin/routes/index.html.erb
@@ -122,12 +148,17 @@ files:
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/routes.rb
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
+- spec/dummy/doc/docushin/collections.yml
+- spec/dummy/doc/docushin/fff1454d69c4340014bef52217525fed.md
 - spec/dummy/script/rails
+- spec/requests/collections_spec.rb
+- spec/requests/home_spec.rb
+- spec/requests/requests_helper.rb
+- spec/requests/routes_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/appsbakery/docushin
+homepage: http://appsbakery.github.com/docushin/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -135,28 +166,20 @@ require_paths:
 - app
 - config
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 363757421
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 363757421
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Useful for generating docs on your routes.
 test_files:
 - spec/docushin/route_set_spec.rb
@@ -177,7 +200,11 @@ test_files:
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/routes.rb
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
+- spec/dummy/doc/docushin/collections.yml
+- spec/dummy/doc/docushin/fff1454d69c4340014bef52217525fed.md
 - spec/dummy/script/rails
+- spec/requests/collections_spec.rb
+- spec/requests/home_spec.rb
+- spec/requests/requests_helper.rb
+- spec/requests/routes_spec.rb
 - spec/spec_helper.rb