apidocs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2def707f7b8578ecd5cb455e04355916deae5b7
-  data.tar.gz: a9a903e49b5261b7c1320c6cde03078ba85db5dc
+  metadata.gz: 2bfe483d12b61ff4f45099d88d9c8718f821174d
+  data.tar.gz: 582aaeb27ea6b21ddf24123401431dcb1e2f04aa
 SHA512:
-  metadata.gz: 8caf8d21c4d59b525513559037b16c43a4d4b12684f3f6d7dcb0966102c822618758d97b996a4f00c14392a2e0437876509f17794acb5fbd29155b568dc448e0
-  data.tar.gz: 095bdaff380c72191c49145cbf04fb03da95ea0564faaa13fbdbb0e8131b40c1af1f4d1554126973113cc0001a6d5438ad482d09fda3fe101edffdac756a2f2f
+  metadata.gz: f466a7b4fa9578aa603d39e1b19c833ee8f4063625bce6a03fc36d196aa208d21f6854eb729f6997fae0cd037d276064f19ef7bb1fb397ec57603986db8c7611
+  data.tar.gz: e50172ab4831f655fe508f9416241af2767968d8aaf560361832ef5353f69d4c8fbab3b498a722fc9102cb86234af52aaeaf2d359463d04b1f2bddbe8724c70f

data/README.md

@@ -0,0 +1,9 @@
+apidocs
+=======
+
+Generates and serves HTML documentation out of your routing and controllers for your Rails apps
+
+Installation
+=======
+
+Add <code>mount Apidocs::Engine => "/apidocs"</code> to your applications <code>routes.rb</code>  

data/app/assets/javascripts/apidocs/apidocs.js

@@ -0,0 +1,9 @@
+$(function () {
+    $("#nav-button").click(function () {
+        $.get(this.getAttribute("href"), function (data) {
+            $("#main-content").html(data);
+        });
+        return false;
+    });
+    $('#search-input').fastLiveFilter('#search-list');
+});

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

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/apidocs/jquery.fastLiveFilter.js

@@ -0,0 +1,63 @@
+/**
+ * fastLiveFilter jQuery plugin 1.0.3
+ * 
+ * Copyright (c) 2011, Anthony Bush
+ * License: <http://www.opensource.org/licenses/bsd-license.php>
+ * Project Website: http://anthonybush.com/projects/jquery_fast_live_filter/
+ **/
+
+jQuery.fn.fastLiveFilter = function(list, options) {
+	// Options: input, list, timeout, callback
+	options = options || {};
+	list = jQuery(list);
+	var input = this;
+	var lastFilter = '';
+	var timeout = options.timeout || 0;
+	var callback = options.callback || function() {};
+	
+	var keyTimeout;
+	
+	// NOTE: because we cache lis & len here, users would need to re-init the plugin
+	// if they modify the list in the DOM later.  This doesn't give us that much speed
+	// boost, so perhaps it's not worth putting it here.
+	var lis = list.children();
+	var len = lis.length;
+	var oldDisplay = len > 0 ? lis[0].style.display : "block";
+	callback(len); // do a one-time callback on initialization to make sure everything's in sync
+	
+	input.change(function() {
+		// var startTime = new Date().getTime();
+		var filter = input.val().toLowerCase();
+		var li, innerText;
+		var numShown = 0;
+		for (var i = 0; i < len; i++) {
+			li = lis[i];
+			innerText = !options.selector ? 
+				(li.textContent || li.innerText || "") : 
+				$(li).find(options.selector).text();
+			
+			if (innerText.toLowerCase().indexOf(filter) >= 0) {
+				if (li.style.display == "none") {
+					li.style.display = oldDisplay;
+				}
+				numShown++;
+			} else {
+				if (li.style.display != "none") {
+					li.style.display = "none";
+				}
+			}
+		}
+		callback(numShown);
+		// var endTime = new Date().getTime();
+		// console.log('Search for ' + filter + ' took: ' + (endTime - startTime) + ' (' + numShown + ' results)');
+		return false;
+	}).keydown(function() {
+		clearTimeout(keyTimeout);
+		keyTimeout = setTimeout(function() {
+			if( input.val() === lastFilter ) return;
+			lastFilter = input.val();
+			input.change();
+		}, timeout);
+	});
+	return this; // maintain jQuery chainability
+}

data/app/assets/stylesheets/apidocs/apidocs.css.scss

@@ -0,0 +1,22 @@
+pre {
+    background-color: black;
+    color: #999;
+    font-family: "Lucida Console", Monaco, monospace;
+    padding: 10px;
+    max-width: 100%;
+    overflow: auto;
+}
+
+#reload {
+    float: right;
+    font-size: 120%;
+}
+
+.action-name {
+    border-bottom: 1px black dotted;
+}
+
+#main-content h2 a,
+#main-content h1 a {
+    display: none;
+}

data/app/assets/stylesheets/apidocs/custom.css.scss

@@ -0,0 +1 @@
+@import "bootstrap";

data/app/controllers/apidocs/apidocs_controller.rb

@@ -3,7 +3,30 @@ require_dependency "apidocs/application_controller"
 module Apidocs
   class ApidocsController < ApplicationController
     def index
-      @routes = Apidocs::ApiDocs.new.generate_html
+      @routes = routes_rdoc
+      if params[:path]
+        @route = routes_rdoc[params[:path]]
+      else
+        begin
+          h = RDoc::Markup::ToHtml.new(RDoc::Options.new)
+          @intro = h.convert(Rails.root.join('API.rdoc').read)
+        rescue
+          @intro = "Please put API.rdoc into "+Rails.root.to_s
+        end
+      end
+    end
+
+    def flush
+      Rails.cache.delete("routes_rdoc_html")
+      redirect_to :back
+    end
+
+    private
+    def routes_rdoc
+      Rails.cache.fetch("routes_rdoc_html") do
+        routes = Apidocs::ApiDocs.new.generate_html
+        routes.group_by { |r| r[:path] }
+      end
     end
   end
 end

data/app/views/apidocs/apidocs/index.html.erb

@@ -1,17 +1,18 @@
-<h2>Table of Contents</h2>
-<ul>
-  <% @routes.each do |route| %>
-    <li>
-    <a href="#<%= Digest::SHA1.hexdigest "#{route[:verb]} #{route[:path]}" %>"><%= route[:verb] %> <%= route[:path] %></a>
-    </li>
-  <% end %>
-</ul>
-
-<h2>Documentation</h2>
-
-<% @routes.each do |route| %>
-  <h3 id="<%= Digest::SHA1.hexdigest "#{route[:verb]} #{route[:path]}" %>">
-    <%= route[:verb] %> <%= route[:path] %>
-  </h3>
-  <%= route[:html_comment].html_safe %>
+<% content_for :nav do %>
+    <ul id="search-list" class="list-unstyled">
+        <% @routes.each do |path, route| %>
+            <li><%= link_to path, root_path(path: path), class: 'nav-button' %></li>
+        <% end %>
+    </ul>
 <% end %>
+<% if @intro %>
+    <%= @intro.html_safe %>
+<% end %>
+<% if @route %>
+    <% @route.each do |r| %>
+        <h3 class="action-name">
+            <%= r[:verb] %> <%= r[:path] %>
+        </h3>
+        <%= r[:html_comment].html_safe %>
+    <% end %>
+<% end%>

data/app/views/layouts/apidocs/application.html.erb

@@ -1,14 +1,33 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Apidocs</title>
-  <%= stylesheet_link_tag    "apidocs/application", media: "all" %>
-  <%= javascript_include_tag "apidocs/application" %>
-  <%= csrf_meta_tags %>
+    <title>Apidocs</title>
+    <%= stylesheet_link_tag "apidocs/application", media: "all" %>
+    <%= javascript_include_tag "apidocs/application" %>
+    <%= csrf_meta_tags %>
 </head>
 <body>
 
-<%= yield %>
-
+<div class="container-fluid">
+    <nav class="navbar navbar-default" role="navigation">
+        <div class="container-fluid">
+            <%= link_to 'APIDOC', root_path, class: 'navbar-brand' %>
+            <form class="navbar-form navbar-left" role="search">
+                <div class="form-group">
+                    <input type="text" class="search-query" id="search-input" placeholder="Search">
+                </div>
+            </form>
+        </div>
+    </nav>
+    <div class="row">
+        <div class="col-md-2">
+            <nav><%= yield(:nav) %></nav>
+        </div>
+        <div class="col-md-10">
+            <article id="main-content"><%= yield %></article>
+        </div>
+    </div>
+    <%= link_to "&#8634;".html_safe, flush_path, id: 'reload' %>
+</div>
 </body>
 </html>

data/config/initializers/clean_up_rdoc_cache.rb

@@ -0,0 +1 @@
+Rails.cache.delete("routes_rdoc_html")

data/config/routes.rb

@@ -1,3 +1,4 @@
 Apidocs::Engine.routes.draw do
   root "apidocs#index"
+  get '/flush' => 'apidocs#flush' ,as: :flush
 end

data/lib/apidocs.rb

@@ -36,22 +36,19 @@ module Apidocs
       inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
       routes = inspector.send(:collect_routes, inspector.send(:filter_routes, nil)).select {|r| r[:reqs] =~ /#/}
 
+      formatter = RDoc::Markup::ToHtml.new(RDoc::Options.new)
+
       routes = routes.map do |r|
         { verb: r[:verb],
-          path: r[:path],
+          path: r[:path].sub('(.:format)',''),
           class_name: gen_class_name(r),
           action_name: gen_action_name(r)
         }
       end
 
       routes.each do |r|
-        r[:doc] = document_route(r)
-      end
-
-      formatter = RDoc::Markup::ToHtml.new(RDoc::Options.new)
-
-      routes.each do |r|
-        r[:html_comment] = r[:doc] ? r[:doc].accept(formatter) : ""
+        doc = document_route(r)
+        r[:html_comment] = doc ? doc.accept(formatter) : ""
       end
 
       routes.select {|r| r[:class_name] != "ApidocsController" }
@@ -62,7 +59,6 @@ module Apidocs
     def document_route(r)
       klas = @store.instance_variable_get("@classes_hash")[r[:class_name]]
       return nil if klas.nil?
-      puts klas.methods_hash["##{r[:action_name]}"].try(:comment)
       klas.methods_hash["##{r[:action_name]}"].try(:comment).try(:parse)
     end
 

data/lib/apidocs/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apidocs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Vladimir Motsak
@@ -14,16 +14,58 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -46,19 +88,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- Rakefile
-- app/assets/stylesheets/apidocs/apidocs.css
-- app/assets/stylesheets/apidocs/application.css
+- README.md
+- app/assets/javascripts/apidocs/apidocs.js
+- app/assets/javascripts/apidocs/application.js
+- app/assets/javascripts/apidocs/jquery.fastLiveFilter.js
+- app/assets/stylesheets/apidocs/apidocs.css.scss
+- app/assets/stylesheets/apidocs/application.css.scss
+- app/assets/stylesheets/apidocs/custom.css.scss
 - app/controllers/apidocs/apidocs_controller.rb
 - app/controllers/apidocs/application_controller.rb
 - app/views/apidocs/apidocs/index.html.erb
 - app/views/layouts/apidocs/application.html.erb
+- config/initializers/clean_up_rdoc_cache.rb
 - config/routes.rb
 - lib/apidocs.rb
 - lib/apidocs/engine.rb
 - lib/apidocs/version.rb
 - lib/tasks/apidocs_tasks.rake
-homepage: http://github.com
+homepage: http://github.com/vmotsak/apidocs
 licenses:
 - MIT
 metadata: {}

data/Rakefile

@@ -1,29 +0,0 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Apidocs'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task default: :test

data/app/assets/stylesheets/apidocs/apidocs.css

@@ -1 +0,0 @@
-pre {  background-color: black;  color: #999;  font-family: "Lucida Console", Monaco, monospace;  padding: 10px;  max-width: 100%;  overflow: auto;}