interdasting 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ba6bc08627a70924d0a296b836229b2bd9e8956
+  data.tar.gz: 7a4b2661e3e53b9894f4d7829a7ecb7ae0d20e61
+SHA512:
+  metadata.gz: 7eedceccdd1c12f8fd99e846fc33c22b394f2e187fa7de900d8ced645f60399bcf72176440c87e5c6fa65da68891b30b8a81982a3291cfbca5f57183a2b5479d
+  data.tar.gz: 73b9763b4c8b1d2e08118af238aeeb405a37be75c3857af85a764e29caadc5824e87b94508618663826940808d8157ef5996c16f032c40c239493e03dcd4745d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 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,23 @@
+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    = 'Interdasting'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

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

@@ -0,0 +1,198 @@
+//= require jquery
+//= require jquery_ujs
+//= require bootstrap
+
+$(document).ready(function () {
+  $('#try-out-modal').on('show.bs.modal', function (event) {
+    var $modal = $(this);
+    var $triggerButton = $(event.relatedTarget);
+    var $testButton = $modal.find('.btn.try');
+    $modal.find('h4.modal-title').text('' +
+      $triggerButton.data('request-method') + ' ' + $triggerButton.data('url')
+    );
+    $modal.find('.modal-body').html(
+      contentForModal(
+        $triggerButton.data('url'),
+        $triggerButton.data('request-method'),
+        $triggerButton.data('params'),
+        $triggerButton.data('saved_params'),
+        $triggerButton.data('saved_text')
+      )
+    );
+    $testButton.click(function(){
+      saveParams($modal.find('.modal-body'), $triggerButton);
+      var $response = $modal.find('.response')
+      $modal.find('.response-body').removeClass('hidden');
+      addSpinner($response);
+      $.ajax(
+        buildRequestParams($modal.find('.modal-body'), $triggerButton.data('url'), $triggerButton.data('request-method'))
+      ).done(function(data, textStatus, jqXHR) {
+        response = jqXHR.responseText
+        $response.html('');
+        $response.text(response);
+        $(window).trigger('resize');
+      });
+    });
+  }).on('hidden.bs.modal', function (e) {
+    var $modal = $(this);
+    $modal.find('h4.modal-title').text('Try it');
+    $modal.find('.modal-body').html('');
+  })
+
+  function buildRequestParams($object, url, method) {
+    var $inputs = $object.find('input[data-key]');
+    var $requestBody = $object.find('textarea');
+    var data = null;
+    var processData = true;
+
+    if ($inputs.length !== 0) {
+      data = {}
+      $inputs.each(function(i, $input) {
+        $input = $($input);
+        if (url.indexOf('{' + $input.data('key') + '}')) {
+          url = url.replace('{' + $input.data('key') + '}', $input.val())
+        } else {
+          data[$input.data('key')] = $input.val();
+        }
+      });
+    }
+    if ($requestBody.length !== 0) {
+      processData = false;
+      data = $requestBody.val();
+    }
+
+    return {
+      url: url,
+      type: method,
+      processData: processData,
+      data: data
+    }
+  }
+
+  function saveParams($object, $saveToObject) {
+    var $inputs = $object.find('input[data-key]');
+    var $requestBody = $object.find('textarea');
+
+    if ($inputs.length !== 0) {
+      params = {};
+      $inputs.each(function(i, $input) {
+        $input = $($input);
+        params[$input.data('key')] = $input.val();
+      });
+      $saveToObject.data('saved_params', params);
+    }
+
+    if ($requestBody.length !== 0) {
+      $saveToObject.data('saved_text', $requestBody.val());
+    }
+
+    return true;
+  }
+
+  function addSpinner($object) {
+      var message = '<center>'+
+                      '<span class="glyphicon glyphicon-refresh gly-spin"></span>'+
+                      '  Waiting for response...'+
+                    '</center>';
+      $object.html(message);
+  }
+
+  function contentForModal(url, method, params, savedParams, savedText) {
+    var content = ''
+    content += '<h3>Request body</h3>'
+    if (method === 'GET' && params) {
+      content += paramsInputTable(params, savedParams)
+    } else {
+      var regex = /\{[^\s]+\}/;
+      var match = regex.exec(url);
+      if (match && match.length !== 0) {
+        tempParams = {}
+        $.each(match, function(i, m){ tempParams[m.replace(/[\{\}]/g,'')] = i });
+        content += paramsInputTable(tempParams, savedParams)
+      }
+      var saved = ''
+      if (savedText) saved = savedText;
+      content += '<textarea class="form-control" rows="6" cols="90">' + saved + '</textarea>';
+    }
+    if (method !== 'GET' && params) {
+      content += '<h4>Expected params</h4>'
+      content += paramsTable(params)
+    }
+    content += '<div class="response-body hidden">'
+    content += '<hr>';
+    content += '<h3>Response</h3>'
+    content += '<pre><code class="response"></code></pre>'
+    content += '</div>'
+
+    return content;
+  }
+
+  function paramsInputTable(params, savedParams) {
+    content  = '<table class="table table-striped">';
+    content += '<thead>';
+    content += '<tr>'+
+                 '<th>Param</th>'+
+                 '<th>Value</th>'+
+               '</tr>';
+    content += '</thead>';
+    $.each(params, function(k, v) {
+      content += paramsInputTableRow(k, v, null, savedParams);
+    });
+    content += '</table>';
+    return content
+  }
+
+  function paramsInputTableRow(k, v, wrapper, savedParams) {
+    var content = '';
+    var saved = '';
+    if (wrapper) k = wrapper + '[' + k + ']';
+    if (savedParams && savedParams[k]) saved = savedParams[k];
+    if (typeof v === 'object') {
+      $.each(v, function(kk, vv) {
+        content += paramsInputTableRow(kk, vv, k, savedParams);
+      });
+    } else {
+      content += '<tr>'+
+                   '<td>' + k + '</td>'+
+                   '<td><input type="text" class="form-control" value="' + saved + '" data-key="' + k + '"></td>'+
+                 '</tr>';
+    }
+    return content;
+  }
+
+  function paramsTable(params) {
+    content  = '<table class="table table-striped">';
+    content += '<thead>';
+    content += '<tr>'+
+                 '<th>Name</th>'+
+                 '<th>Type</th>'+
+               '</tr>';
+    content += '</thead>';
+    $.each(params, function(k, v){
+      content += paramsTableRow(k, v, null);
+    });
+    content += '</table>';
+    return content
+  }
+
+  function paramsTableRow(k, v, wrapper) {
+    var content = '';
+    if (wrapper) k = wrapper + '[' + k + ']';
+    if (typeof v === 'object') {
+      $.each(v, function(kk, vv) {
+        content += paramsTableRow(kk, vv, k);
+      });
+    } else {
+      content += '<tr>'+
+                   '<td>' + k + '</td>'+
+                   '<td>' + v + '</td>'+
+                 '</tr>';
+    }
+    return content;
+  }
+
+  function indentResponse(response) {
+    // TODO: code to indent the response depending on if it's a JSON or XML response
+    return response;
+  }
+});

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

@@ -0,0 +1,51 @@
+/*
+ *= require_tree .
+ *= require_self
+ */
+ @import "bootstrap-sprockets";
+ @import "bootstrap";
+
+body {
+  padding-top: 70px;
+}
+
+.gly-spin {
+  -webkit-animation: spin 2s infinite linear;
+  -moz-animation: spin 2s infinite linear;
+  -o-animation: spin 2s infinite linear;
+  animation: spin 2s infinite linear;
+}
+@-moz-keyframes spin {
+  0% {
+    -moz-transform: rotate(0deg);
+  }
+  100% {
+    -moz-transform: rotate(359deg);
+  }
+}
+@-webkit-keyframes spin {
+  0% {
+    -webkit-transform: rotate(0deg);
+  }
+  100% {
+    -webkit-transform: rotate(359deg);
+  }
+}
+@-o-keyframes spin {
+  0% {
+    -o-transform: rotate(0deg);
+  }
+  100% {
+    -o-transform: rotate(359deg);
+  }
+}
+@keyframes spin {
+  0% {
+    -webkit-transform: rotate(0deg);
+    transform: rotate(0deg);
+  }
+  100% {
+    -webkit-transform: rotate(359deg);
+    transform: rotate(359deg);
+  }
+}

data/app/controllers/interdasting/application_controller.rb

@@ -0,0 +1,13 @@
+module Interdasting
+  class ApplicationController < ActionController::Base
+    def index
+      @docs = Interdasting.documentation
+      render 'docs/interdasting/index'
+    end
+
+    def show
+      @doc = Interdasting.documentation_for_version(params[:version])
+      render 'docs/interdasting/show'
+    end
+  end
+end

data/app/helpers/interdasting/application_helper.rb

@@ -0,0 +1,24 @@
+module Interdasting
+  module ApplicationHelper
+    def doc_id(doc)
+      "version_#{web_safe(doc.version)}"
+    end
+
+    def controller_id(controller)
+      "#{doc_id(controller.documentation)}_controller_"\
+      "#{web_safe(controller.name)}"
+    end
+
+    def action_id(action)
+      "#{controller_id(action.controller)}_action_#{web_safe(action.name)}"
+    end
+
+    def method_id(action, method)
+      "#{action_id(action)}_method_#{web_safe(method)}"
+    end
+
+    def web_safe(string)
+      string.to_s.humanize.sub(' ', '').underscore
+    end
+  end
+end

data/app/views/docs/interdasting/_action.markdown.erb

@@ -0,0 +1,23 @@
+### <%= action.name %>
+
+<% action.methods.each do |method| %>
+#### <%= method.upcase %>
+
+> __URL:__ <%= '' || action.url %>
+
+<% if action.description(method) %>
+>__DESCRIPTION:__ <%= action.description(method) %>
+<% end %>
+
+<% if action.params(method) %>
+>__PARAMS:__
+
+>| Name | Type |
+>| ---- | ---- |
+<% action.params(method).each do |k, v| %>
+>| <%= k %> | <%= v %> |
+<% end %>
+<% end %>
+
+
+<% end %>

data/app/views/docs/interdasting/_action.slim

@@ -0,0 +1,43 @@
+.panel.panel-default
+  .panel-heading
+    h4.panel-title
+      = link_to "#{action.name}", "##{action_id(action)}", data: { toggle: 'collapse' }
+  .panel-collapse.collapse id="#{action_id(action)}"
+    .panel-body
+      ul.nav.nav-tabs
+        - action.methods.each_with_index do |method, index|
+          li class="#{index == 0 ? 'active' : ''}"
+            = link_to method.upcase, "##{method_id(action, method)}", data: { toggle: 'tab' }
+      .tab-content
+        - action.methods.each_with_index do |method, index|
+            .tab-pane class="#{index == 0 ? 'active' : ''}" id="#{method_id(action, method)}"
+
+              .col-md-6
+                .row
+                  .col-xs-12
+                    - if action.url(method)
+                      h4 URL
+                      = action.url
+                  .col-xs-12
+                    - if action.description(method)
+                      h4 Description
+                      = simple_format(action.description(method))
+              .col-md-6
+                .row
+                  .col-xs-12
+                    - if action.params(method)
+                      h4 Params
+                      table.table.table-striped
+                        thead
+                          tr
+                            th Name
+                            th Type
+                        tbody
+                          = render 'docs/interdasting/hash_param', hash: action.params(method), wrap: nil
+
+              - if action.url(method)
+                .col-xs-12
+                  hr
+                  = link_to '#', class: 'btn btn-primary try-out', data: { request_method: method, params: action.params(method), url: action.url, toggle: 'modal', target: '#try-out-modal' } do
+                    span.glyphicon.glyphicon-new-window
+                    |  Try it out

data/app/views/docs/interdasting/_controller.markdown.erb

@@ -0,0 +1,7 @@
+## <%= controller.name %>
+
+<% controller.actions.each do |action| %>
+<%= render 'docs/interdasting/action.markdown.erb', action: action %>
+
+___
+<% end %>

data/app/views/docs/interdasting/_controller.slim

@@ -0,0 +1,9 @@
+.panel.panel-default
+  .panel-heading
+    h4.panel-title
+      = link_to "#{controller.name}", "##{controller_id(controller)}", data: { toggle: 'collapse' }
+  .panel-collapse.collapse id="#{controller_id(controller)}"
+    .panel-body
+      .panel-group id="#{controller_id(controller)}_accordion"
+        - controller.actions.each do |action|
+          = render 'docs/interdasting/action', action: action

data/app/views/docs/interdasting/_documentation.markdown.erb

@@ -0,0 +1,4 @@
+<% doc.controllers.each do |controller| %>
+<%= render 'docs/interdasting/controller.markdown.erb', controller: controller %>
+
+<% end %>

data/app/views/docs/interdasting/_documentation.slim

@@ -0,0 +1,3 @@
+.panel-group id="#{doc_id(doc)}_accordion"
+  - doc.controllers.each do |controller|
+      = render 'docs/interdasting/controller', controller: controller

data/app/views/docs/interdasting/_hash_param.slim

@@ -0,0 +1,7 @@
+- hash.each do |k, v|
+  - if v.is_a?(Hash)
+    = render 'docs/interdasting/hash_param', hash: v, wrap: wrap ? "#{wrap}[#{k}]" : k
+  - else
+    tr
+      td = wrap ? "#{wrap}[#{k}]" : k
+      td = v

data/app/views/docs/interdasting/_version.slim

@@ -0,0 +1,7 @@
+.panel.panel-default
+  .panel-heading
+    h4.panel-title
+      = link_to "Version #{doc.version}", "##{doc_id(doc)}", data: { toggle: 'collapse' }
+  .panel-collapse.collapse id="#{doc_id(doc)}"
+    .panel-body
+      = render 'docs/interdasting/documentation', doc: doc

data/app/views/docs/interdasting/index.slim

@@ -0,0 +1,3 @@
+.panel-group#versions_accordion
+  - @docs.each do |doc|
+    = render 'docs/interdasting/version', doc: doc

data/app/views/docs/interdasting/show.markdown.erb

@@ -0,0 +1,3 @@
+# <%= @doc.version %>
+
+<%= render 'docs/interdasting/documentation.markdown.erb', doc: @doc %>

data/app/views/docs/interdasting/show.slim

@@ -0,0 +1,4 @@
+h1= @doc.version
+hr
+.col-xs-12
+  = render 'docs/interdasting/documentation', doc: @doc

data/app/views/layouts/interdasting/_modal.slim

@@ -0,0 +1,12 @@
+.modal.fade#try-out-modal
+  .modal-dialog
+    .modal-content
+      .modal-header
+        button.close data-dismiss='modal'
+        h4.modal-title Try it
+      .modal-body
+      .modal-footer
+        button.btn.btn-default data-dismiss='modal'
+          | Close
+        button.btn.btn-primary.try
+          | Try it

data/app/views/layouts/interdasting/_navigation.slim

@@ -0,0 +1,10 @@
+- if defined?(interdasting)
+  .navbar.navbar-default.navbar-fixed-top
+    .container-fluid
+      .navbar-header
+        = link_to 'Documentation', interdasting.root_path, class: 'navbar-brand'
+      .collapse.navbar-collapse
+        ul.nav.navbar-nav
+          li = link_to 'All versions', interdasting.root_path
+          - Interdasting::Router.versions.each do |v|
+            li = link_to v.to_s, interdasting.version_path(version: v)

data/app/views/layouts/interdasting/application.slim

@@ -0,0 +1,9 @@
+head
+  title Interdasting
+  = stylesheet_link_tag    "interdasting/application", media: "all"
+  = javascript_include_tag "interdasting/application"
+body
+  = render 'layouts/interdasting/navigation'
+  .container
+    = yield
+  = render 'layouts/interdasting/modal'

data/config/routes.rb

@@ -0,0 +1,5 @@
+Interdasting::Engine.routes.draw do
+  root 'application#index'
+  get 'versions', to: 'application#index', as: 'versions'
+  get 'version/:version', to: 'application#show', as: 'version'
+end

data/lib/interdasting.rb

@@ -0,0 +1,30 @@
+require 'pry'
+require 'slim'
+require 'indentation-parser'
+require 'interdasting/engine'
+require 'interdasting/router'
+require 'interdasting/parser'
+require 'interdasting/documentation'
+
+module Interdasting
+  def self.documentation
+    Router.api_full.map do |version, controller|
+      Documentation.new(version, controller)
+    end
+  end
+
+  def self.documentation_for_version(version)
+    Documentation.new(version, Router.api_full[version])
+  end
+
+  def self.documentation_for_files(files, version_name = 'Unknown')
+    fake_controlers = files.map do |file|
+      fake_controller = {
+        path: file,
+        actions: Hash[Parser.method_comments(file).keys.map { |m, _c| [m, []] }]
+      }
+      [File.basename(file, '.rb'), fake_controller]
+    end
+    Documentation.new(version_name, Hash[fake_controlers])
+  end
+end

data/lib/interdasting/documentation.rb

@@ -0,0 +1,46 @@
+require 'interdasting/documentation/controller'
+require 'interdasting/documentation/action'
+
+module Interdasting
+  class Documentation
+    attr_reader :version
+    attr_reader :controllers
+
+    def initialize(version, controllers_hash)
+      @version = version
+      @controllers = []
+      @controllers_in = controllers_hash
+      generate
+    end
+
+    def should_update?
+      should_update = false
+      controllers.each { |c| should_update ||= c.should_update? }
+      should_update
+    end
+
+    def update
+      controllers.each(&:update)
+      self
+    end
+
+    def update!
+      controllers.each(&:update!)
+      self
+    end
+
+    private
+
+    def generate
+      build_controllers
+      update
+    end
+
+    def build_controllers
+      @controllers = []
+      @controllers_in.each do |n, v|
+        @controllers << Controller.new(n, v[:path], v[:actions], self)
+      end
+    end
+  end
+end

data/lib/interdasting/documentation/action.rb

@@ -0,0 +1,97 @@
+module Interdasting
+  class Documentation
+    class Action
+      attr_reader :name
+      attr_reader :controller
+      attr_reader :comments
+
+      def initialize(name, comments, methods, params, controller)
+        @name = name
+        @comments = comments
+        @methods = sanitize_methods(methods)
+        @params  = params
+        @params.delete(:version) if params
+        @params = @params.presence
+        @controller = controller
+        generate
+      end
+
+      def url(method = default_method)
+        (@doc[method] && @doc[method]['URL']) || @doc['URL'] ||
+          router_url(method)
+      end
+
+      def description(method = default_method)
+        (@doc[method] && @doc[method]['DOC']) || @doc['DOC']
+      end
+
+      def params(method = default_method)
+        (@doc[method] && @doc[method]['PARAMS']) || @doc['PARAMS'] ||
+          @params
+      end
+
+      def default_method
+        methods.first || 'GET'
+      end
+
+      def methods
+        @methods.presence ||
+          @doc.keys.select { |m| Parser.http_keywords.include?(m) }
+      end
+
+      private
+
+      def generate
+        return @doc = {} unless @comments.present?
+        @doc = Interdasting::Parser.parse_comments(@comments).value
+      end
+
+      def _routes
+        Interdasting::Router.app_routes
+      end
+
+      def sanitize_methods(methods)
+        return unless methods
+        methods.map do |m|
+          if m.is_a?(String)
+            m
+          else
+            m.to_s.sub('(?-mix:^', '').sub('$)', '').split('|')
+          end
+        end.flatten
+      end
+
+      def router_url(method = default_method)
+        route = _routes.url_for(url_params(method))
+        route = route.split('?').first unless method == 'GET'
+        CGI.unescape(route)
+      rescue ActionController::UrlGenerationError
+        nil
+      end
+
+      def url_params(method = default_method)
+        hash = {}
+        hash = deflated_url_params(params(method)) if @params
+        hash.merge(
+          controller: controller.full_name.downcase,
+          action: name,
+          version: controller.documentation.version,
+          only_path: true
+        )
+      end
+
+      def deflated_url_params(hash, wrapper = nil)
+        nh = {}
+        hash.each do |k, v|
+          new_v = wrapper ? "#{wrapper}[#{k}]" : k
+          if v.is_a?(Hash)
+            nh[k] = deflated_url_params(v, k)
+          else
+            nh[k] = "{#{new_v}}"
+          end
+        end
+        nh.symbolize_keys
+      end
+    end
+  end
+end

data/lib/interdasting/documentation/controller.rb

@@ -0,0 +1,57 @@
+module Interdasting
+  class Documentation
+    class Controller
+      attr_accessor :name
+      attr_accessor :file
+      attr_reader :documentation
+      attr_reader :actions
+
+      def initialize(name, file, actions_hash, documentation)
+        @file_md5  = ''
+        @actions = []
+        @actions_in = actions_hash
+        self.name = name
+        self.file = file
+        @documentation = documentation
+        update!
+      end
+
+      def update
+        should_update? && update!
+      end
+
+      def update!
+        @file_md5 = generate_hash
+        generate
+      end
+
+      def should_update?
+        return false if generate_hash == @file_md5
+        true
+      end
+
+      def name
+        return unless @name
+        @name.split('/').last.sub('_controller', '').humanize
+      end
+
+      def full_name
+        @name
+      end
+
+      private
+
+      def generate
+        @actions = []
+        comments = Interdasting::Parser.method_comments(file)
+        @actions_in.each do |name, action|
+          @actions << Action.new(name, comments[name], action[:methods], action[:params], self)
+        end
+      end
+
+      def generate_hash
+        Digest::MD5.file(file).hexdigest
+      end
+    end
+  end
+end

data/lib/interdasting/engine.rb

@@ -0,0 +1,12 @@
+module Interdasting
+  class Engine < ::Rails::Engine
+    isolate_namespace Interdasting
+    require 'jquery-rails'
+    require 'bootstrap-sass'
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+    end
+  end
+end

data/lib/interdasting/parser.rb

@@ -0,0 +1,105 @@
+module Interdasting
+  module Parser
+    class << self
+      def comments_for_method(method_name, file_path)
+        method_comments(file_path)[method_name.to_s]
+      end
+
+      def method_comments(file_path)
+        comments = {}
+        temp_comment = []
+        File.read(file_path).each_line do |line|
+          if extract_method_comment(line, comments, temp_comment)
+            temp_comment = []
+          end
+        end
+        clean_comments(comments)
+      end
+
+      def parse_comments(comments)
+        indentation_parser.read(comments, {})
+      end
+
+      def keywords
+        http_keywords + parser_keywords
+      end
+
+      def http_keywords
+        %w(GET POST PUT PATCH DELETE)
+      end
+
+      def parser_keywords
+        string_keywords + hash_keywords
+      end
+
+      private
+
+      def string_keywords
+        %w(DOC URL)
+      end
+
+      def hash_keywords
+        %w(PARAMS)
+      end
+
+      def indentation_parser
+        IndentationParser.new do |p|
+          indentation_parser_default(p)
+          indentation_parser_leafs(p)
+        end
+      end
+
+      def indentation_parser_default(p)
+        p.default do |parent, source|
+          parent ||= {}
+          words = source.split
+          keyword, key = words.first.upcase, words.first
+          if words.count == 1 && keywords.include?(keyword)
+            parent[keyword] = string_keywords.include?(keyword) ? '' : {}
+          elsif words.count == 1 && parent.is_a?(Hash)
+            parent[key] = {}
+          end
+        end
+      end
+
+      def indentation_parser_leafs(p)
+        p.on_leaf do |parent, source|
+          case parent
+          when String
+            parent << ' ' if parent.length != 0
+            parent << source.try(:strip) || ''
+          when Hash
+            k, v = source.split(':', 2)
+            parent[k] = v ? v.try(:strip) : {}
+          end
+        end
+      end
+
+      def extract_method_comment(line, comments = {}, temp_comment = [])
+        return true unless valid_line?(line)
+        if line =~ /^\s*def\s+\w+$/
+          comments[method_name(line)] = temp_comment.join("\n")
+          true
+        else
+          temp_comment << line
+          false
+        end
+      end
+
+      def valid_line?(line)
+        line =~ /^\s*#.*$/ || line =~ /^\s*def\s+\w+$/ || line =~ /^\s+$/
+      end
+
+      def method_name(line)
+        line.match(/^\s*def\s+\w+$/).to_s.split(' ').last
+      end
+
+      def clean_comments(comments)
+        comments.each do |k, v|
+          comments[k] = v.gsub(/^\s*#\s?/, '').gsub(/\n+/, "\n")
+        end
+        comments
+      end
+    end
+  end
+end

data/lib/interdasting/router.rb

@@ -0,0 +1,86 @@
+module Interdasting
+  module Router
+    class << self
+      def api_full
+        result = {}
+        versions.each { |v| result[v] = {} }
+        result.each { |k, v| fill_controllers_hash_for_version(k, v) }
+        result
+      end
+
+      def api_controller_paths(controllers = api_controllers)
+        cp = controllers.map do |c|
+          c.instance_methods(false).map do |m|
+            c.instance_method(m).source_location.first
+          end
+        end
+        cp.flatten.uniq.compact
+      end
+
+      def api_controllers(names = api_controller_names)
+        names.map do |cn|
+          cn += '_controller'
+          cn.classify.constantize
+        end
+      end
+
+      def api_controller_names
+        ar = routes.named_routes.select { |_k, v| v.defaults[:rp_prefix] }
+        ar.values.map { |r| r.defaults[:controller] }.uniq
+      end
+
+      def routes_for_version(version)
+        routes.to_a.select { |v| v && v.defaults[:version] == version }
+      end
+
+      def versions
+        routes.to_a.map { |r| r && r.defaults[:version] }.uniq.compact
+      end
+
+      def routes
+        app_routes.routes
+      end
+
+      def app_routes
+        Rails.application.class.routes
+      end
+
+      private
+
+      def fill_controllers_hash_for_version(version, hash)
+        routes = routes_for_version(version)
+        routes.each do |r|
+          route_controller(hash, r)
+        end
+      end
+
+      def route_controller(ch, r)
+        cn = r.defaults[:controller]
+        ch[cn] ||= {}
+        ch[cn][:path] ||= api_controller_paths(api_controllers([cn])).first
+        ch[cn][:actions] ||= {}
+        route_action(ch[cn][:actions], r)
+      end
+
+      def route_action(hash, r)
+        ah = hash[r.defaults[:action]] ||= {}
+        ah[:params] = route_params(r)
+        route_methods(ah, r)
+      end
+
+      def route_params(r)
+        Hash[
+          r.required_parts.map do |name|
+            type = r.constraints[name.to_sym] || '???'
+            [name, type]
+          end
+        ]
+      end
+
+      def route_methods(hash, r)
+        hash[:methods] ||= []
+        hash[:methods] << r.constraints[:request_method]
+      end
+    end
+  end
+end

data/lib/interdasting/version.rb

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

data/lib/tasks/interdasting_tasks.rake

@@ -0,0 +1,85 @@
+namespace :interdasting do
+  desc 'Generates static HTML documentation files'
+  generator_args = [:version_name, :input_files, :output_folder]
+  task :generate, generator_args => :environment  do |_task, args|
+    version, input, output = sanitize_generator_input(args)
+    fail('A version name has to be provided') unless version
+    fail('At leas one input file has to be provided') unless input
+
+    doc = Interdasting.documentation_for_files(input, version)
+
+    template_folder = generator_template_folder
+    layout_path = template_folder + '/layouts/interdasting/application.slim'
+    template_path = template_folder + '/docs/interdasting/show.slim'
+
+    prepare_generator_output(output, version, 'html')
+
+    view_builder = generator_view_builder(template_folder)
+    view_builder.instance_variable_set(:@doc, doc)
+    layout = Slim::Template.new { File.open(layout_path, 'r').read }
+    view = Slim::Template.new { File.open(template_path, 'r').read }
+    html = layout.render(view_builder) do
+      view.render(view_builder).html_safe
+    end
+    File.open(output, 'w+') do |file|
+      file.puts(html)
+    end
+  end
+  task :gen, generator_args => :generate
+
+  desc 'Generates static MARKDOWN documentation files'
+  md_generator_args = generator_args
+  task :generate_markdown, md_generator_args => :environment  do |_task, args|
+    version, input, output = sanitize_generator_input(args)
+
+    doc = Interdasting.documentation_for_files(input, version)
+
+    template_folder = generator_template_folder
+    template_path = template_folder + '/docs/interdasting/show.markdown.erb'
+
+    prepare_generator_output(output, version, 'markdown')
+
+    view_builder = generator_view_builder(template_folder)
+    view_builder.instance_variable_set(:@doc, doc)
+    view = ERB.new(File.open(template_path, 'r').read)
+    html = view.result(view_builder.instance_eval { binding })
+    File.open(output, 'w+') do |file|
+      file.puts(html)
+    end
+  end
+  task :generate_md, md_generator_args => :generate_markdown
+  task :gen_md, md_generator_args => :generate_markdown
+
+  ###############
+  ### HELPERS ###
+  ###############
+
+  def sanitize_generator_input(args)
+    version = args[:version_name].presence
+    # TODO: Potential bug with pathnames containing spaces
+    input = args[:input_files] && args[:input_files].split.presence
+    output = args[:output_folder].presence ||
+             Rails.root.join('public', 'system', 'documentation').to_s
+    fail('A version name has to be provided') unless version
+    fail('At leas one input file has to be provided') unless input
+    [version, input, output]
+  end
+
+  def generator_template_folder
+    File.expand_path('../../../app/views', __FILE__)
+  end
+
+  def prepare_generator_output(output, name, ext)
+    FileUtils.mkdir_p(output)
+    output = output[-1] == '/' ? output : output << '/'
+    output << "#{name}.#{ext}"
+  end
+
+  def generator_view_builder(template_folder)
+    lookup_context = ActionView::LookupContext.new(template_folder)
+    view_builder = ActionView::Base.new(lookup_context)
+    view_builder.extend ActionView::Helpers
+    view_builder.extend Interdasting::ApplicationHelper
+    view_builder
+  end
+end

metadata

@@ -0,0 +1,270 @@
+--- !ruby/object:Gem::Specification
+name: interdasting
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stanko Krtalić Rusendić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-26 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: slim-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  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: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: indentation-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rocket_pants
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: better_errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Unintrusive interactive API documentation generator for rails apps
+email:
+- stanko.krtalic@gmial.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/interdasting/application.js
+- app/assets/stylesheets/interdasting/application.scss
+- app/controllers/interdasting/application_controller.rb
+- app/helpers/interdasting/application_helper.rb
+- app/views/docs/interdasting/_action.markdown.erb
+- app/views/docs/interdasting/_action.slim
+- app/views/docs/interdasting/_controller.markdown.erb
+- app/views/docs/interdasting/_controller.slim
+- app/views/docs/interdasting/_documentation.markdown.erb
+- app/views/docs/interdasting/_documentation.slim
+- app/views/docs/interdasting/_hash_param.slim
+- app/views/docs/interdasting/_version.slim
+- app/views/docs/interdasting/index.slim
+- app/views/docs/interdasting/show.markdown.erb
+- app/views/docs/interdasting/show.slim
+- app/views/layouts/interdasting/_modal.slim
+- app/views/layouts/interdasting/_navigation.slim
+- app/views/layouts/interdasting/application.slim
+- config/routes.rb
+- lib/interdasting.rb
+- lib/interdasting/documentation.rb
+- lib/interdasting/documentation/action.rb
+- lib/interdasting/documentation/controller.rb
+- lib/interdasting/engine.rb
+- lib/interdasting/parser.rb
+- lib/interdasting/router.rb
+- lib/interdasting/version.rb
+- lib/tasks/interdasting_tasks.rake
+homepage: http://github.com/stankec
+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: Interactive API documentation for rails apps
+test_files: []