apidocs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2def707f7b8578ecd5cb455e04355916deae5b7
+  data.tar.gz: a9a903e49b5261b7c1320c6cde03078ba85db5dc
+SHA512:
+  metadata.gz: 8caf8d21c4d59b525513559037b16c43a4d4b12684f3f6d7dcb0966102c822618758d97b996a4f00c14392a2e0437876509f17794acb5fbd29155b568dc448e0
+  data.tar.gz: 095bdaff380c72191c49145cbf04fb03da95ea0564faaa13fbdbb0e8131b40c1af1f4d1554126973113cc0001a6d5438ad482d09fda3fe101edffdac756a2f2f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,29 @@
+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

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

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

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/apidocs/apidocs_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "apidocs/application_controller"
+
+module Apidocs
+  class ApidocsController < ApplicationController
+    def index
+      @routes = Apidocs::ApiDocs.new.generate_html
+    end
+  end
+end

data/app/controllers/apidocs/application_controller.rb

@@ -0,0 +1,4 @@
+module Apidocs
+  class ApplicationController < ActionController::Base
+  end
+end

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

@@ -0,0 +1,17 @@
+<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 %>
+<% end %>

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Apidocs</title>
+  <%= stylesheet_link_tag    "apidocs/application", media: "all" %>
+  <%= javascript_include_tag "apidocs/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Apidocs::Engine.routes.draw do
+  root "apidocs#index"
+end

data/lib/apidocs.rb

@@ -0,0 +1,80 @@
+require "apidocs/engine"
+
+module Apidocs
+  require 'rdoc'
+  require 'action_dispatch/routing/inspector'
+  require 'fileutils'
+  # This is class comment
+  class ApiDocs < RDoc::RDoc
+    # generate_html  entry point for on fly document generation
+    def generate_html
+      FileUtils.rm_rf(Rails.root.join('tmp/apidocs'))
+      options = ["app/controllers", "--op=#{Rails.root.join('tmp/apidocs')}"]
+
+      self.store = RDoc::Store.new
+
+      @options = load_options
+      @options.parse options
+      @exclude = @options.exclude
+
+      @last_modified = setup_output_dir @options.op_dir, @options.force_update
+
+      @store.encoding = @options.encoding if @options.respond_to? :encoding
+      @store.dry_run  = @options.dry_run
+      @store.main     = @options.main_page
+      @store.title    = @options.title
+      @store.path     = @options.op_dir
+
+      @start_time = Time.now
+      @store.load_cache
+      @options.default_title = "RDoc Documentation"
+
+      parse_files @options.files
+      @store.complete @options.visibility
+
+      all_routes = Rails.application.routes.routes
+      inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+      routes = inspector.send(:collect_routes, inspector.send(:filter_routes, nil)).select {|r| r[:reqs] =~ /#/}
+
+      routes = routes.map do |r|
+        { verb: r[:verb],
+          path: r[:path],
+          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) : ""
+      end
+
+      routes.select {|r| r[:class_name] != "ApidocsController" }
+    end
+
+    private
+
+    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
+
+    def gen_class_name(r)
+      "#{r[:reqs].split("#").first}_controller".classify
+    end
+
+    def gen_action_name(r)
+      "#{r[:reqs].split("#").last}"
+    end
+  end
+
+
+
+end

data/lib/apidocs/engine.rb

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

data/lib/apidocs/version.rb

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

data/lib/tasks/apidocs_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :apidocs do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: apidocs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vladimir Motsak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: On Fly RDoc generation
+email:
+- vmotsak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/stylesheets/apidocs/apidocs.css
+- app/assets/stylesheets/apidocs/application.css
+- 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/routes.rb
+- lib/apidocs.rb
+- lib/apidocs/engine.rb
+- lib/apidocs/version.rb
+- lib/tasks/apidocs_tasks.rake
+homepage: http://github.com
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: On Fly RDoc generation
+test_files: []