mount_doc 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+!spec/mock/rails*/doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,16 @@
+source :rubygems
+
+# Specify your gem's dependencies in mount_doc.gemspec
+gemspec
+
+group :development, :test do
+  gem 'test-unit', require: 'test/unit'
+  gem 'rails'
+  gem 'rspec-rails'
+  gem 'sqlite3'
+  gem 'guard-rspec'
+  gem 'guard-spork'
+  gem 'guard-bundler'
+  gem 'growl', require: false
+  gem 'rb-readline'
+end

data/Guardfile

@@ -0,0 +1,33 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'test' }, :rspec_env => { 'RAILS_ENV' => 'test' } do
+  watch(%r{spec/mock/rails_.*?/config/application.rb})
+  watch(%r{spec/mock/rails_.*?/config/environment.rb})
+  watch(%r{^spec/mock/rails_.*?/config/environments/.+\.rb$})
+  watch(%r{^spec/mock/rails_.*?/config/initializers/.+\.rb$})
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+  watch(%r{features/support/}) { :cucumber }
+end
+
+guard 'rspec', version: 2, cli: '--color -f doc --drb --fail-fast', all_after_pass: false, all_on_start: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/mock/rails_.*?/app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/mock/rails_.*?/app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^spec/mock/rails_.*?/app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch(%r{spec/mock/rails_.*?/config/routes.rb})                           { "spec/routing" }
+  watch(%r{spec/mock/rails_.*?/app/controllers/application_controller.rb})  { "spec/controllers" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sho Kusano
+
+MIT License
+
+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/README.md

@@ -0,0 +1,49 @@
+# MountDoc
+
+Railsアプリケーション組み込み型ドキュメント生成ツール
+
+## Configure
+
+`MountDoc::Config`に書き込み
+
+- `auto_mount`: 自動でマウントするか否か(default: false)
+- `auto_mount_path`: 自動でマウントする先のパス(default: /doc)
+- `visible_components`: インデックスに表示する種類(default: [:files, :urls, :controllers])
+- `doc_file_path`: 静的ドキュメントファイルがあるパス(default: doc)
+- `markup`: コメントサマリの書式(default: rdoc)
+  - 違うものを指定する場合はそれに応じたgemの導入が必要
+    - `markdown`: gem install github-markdown
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mount_doc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mount_doc
+
+And added config/routes.rb
+
+    mount MountDoc::Engine => '/prefix'
+
+access to http://localhost:3000/prefix !
+
+## Usage
+
+1. Installation
+2. Mount
+3. Configure
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

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

@@ -0,0 +1,148 @@
+body {
+  padding-left: 400px;
+  font-size: 14px;
+}
+
+#main {
+  padding: 20px 30px;
+}
+
+#side-index {
+  position: fixed;
+  top: 0;
+  left: 0;
+  margin: 0;
+  padding: 0;
+  width: 400px;
+  height: 100%;
+  background-color: #e8ecef;
+  box-shadow: 0 0 10px rgba(0,0,0,0.4);
+  overflow-y: scroll;
+}
+
+#side-index > div {
+  padding: 0 20px;
+  margin: 20px 0;
+
+  h6 {
+    text-align: center;
+    font-size: 15px;
+  }
+}
+
+#side-index ul {
+  margin: 0;
+  padding: 0;
+  line-height: 1.5;
+}
+
+#side-index li {
+  list-style: none outside;
+}
+
+#side-index a {
+  display: block;
+  margin-left: 3.5em;
+  text-decoration: none;
+}
+
+span.method {
+  display: inline-block;
+  margin-left: -3.5em;
+  margin-right: 0.5em;
+  font-family: Ricty, Inconsolata, Menlo, Courier, monospace;
+  width: 3em;
+  text-align: right;
+}
+
+#search {
+  input {
+    display: inline-block;
+    border: none;
+    line-height: 1.5;
+    font-size: 13px;
+    margin: 0;
+    padding: 3px 5px;
+    border: 1px solid #9ea1a3;
+    border-radius: 4px;
+    width: 358px;
+  }
+}
+
+h2 {
+  font-size: 120%;
+  margin-top: 2em;
+  margin-bottom: 0;
+}
+
+h3 {
+  font-size: 100%;
+}
+
+ul.urls {
+  margin: 0;
+  padding: 0;
+  font-size: 13px;
+
+  li {
+    padding: 0;
+    list-style: none outside;
+
+    span.method {
+      margin-left: 0;
+      text-align: center;
+      background-color: #e8ecef;
+      width: 4em;
+      border: 1px solid gray;
+      border-radius: 3px;
+    }
+  }
+}
+
+p.deprecated {
+  margin: 0;
+  font-size: 80%;
+  color: #c9171e;
+  font-weight: bold;
+}
+p.deprecated + * {
+  margin-top: 0;
+}
+
+pre {
+  position: relative;
+  padding: 0.5em;
+  background-color: #e8ecef;
+  border-radius: 4px;
+  overflow: auto;
+
+  .type {
+    display: block;
+    padding: 5px 10px;
+    position: absolute;
+    top: 0;
+    right: 0;
+    font-size: 12px;
+    background-color: rgba(0, 0, 0, 0.4);
+    border-radius: 0 4px 0 4px;
+    color: white;
+  }
+}
+
+ul ul {
+  padding-left: 1em;
+}
+
+.line-numbers {
+  display: inline-block;
+  margin-right: 0.5em;
+  padding-right: 0.3em;
+  width: 2em;
+  text-align: right;
+  border-right: 3px solid #999;
+
+  a {
+    color: #666;
+    text-decoration: none;
+  }
+}

data/app/controllers/mount_doc/application_controller.rb

@@ -0,0 +1,6 @@
+require 'mount_doc'
+
+module MountDoc
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/mount_doc/mount_doc_controller.rb

@@ -0,0 +1,77 @@
+require 'mount_doc'
+require 'slim'
+require 'github/markup'
+
+module MountDoc
+  class MountDocController < ApplicationController
+    include MountDocHelper
+
+    layout 'mount_doc'
+    
+    def index
+      @page_title = 'Index'
+
+      readme_file = Dir[File.join(::Rails.root, '/README.*')].first
+
+      render text: GitHub::Markup.render(readme_file), layout: true
+    end
+
+    def controller_doc
+      @controller_name = params[:id]
+
+      file_name = File.join(::Rails.root, 'app/controllers', "#{@controller_name.gsub('::', '/')}_controller.rb")
+      unless File.exists?(file_name)
+        not_found
+        return
+      end
+
+      @document = MountDoc::Document.new(:controller, @controller_name).doc_object
+      @page_title = @controller_name.gsub('::', '/').camelize
+    end
+
+    def action_doc
+      @controller_name = params[:ctrl_id]
+      @action_name = params[:id]
+
+      file_name = File.join(::Rails.root, 'app/controllers', "#{@controller_name.gsub('::', '/')}_controller.rb")
+      unless File.exists?(file_name)
+        not_found
+        return
+      end
+
+      @controller_document = MountDoc::Document.new(:controller, @controller_name).doc_object
+      @document = @controller_document.meths.select{|meth| meth.name.to_s == @action_name.to_s }.first
+
+      unless @document
+        not_found
+        return
+      end
+
+      @page_title = @controller_name.gsub('::', '/').camelize + '#' + @action_name
+    end
+
+    def model_doc
+
+    end
+
+    def file_doc
+      file_name = params[:id]
+      file_name += '.' + params[:format] if params.has_key?(:format)
+      file_name = File.join(::Rails.root, MountDoc::Config.doc_file_path, file_name)
+
+      if File.exists?(file_name)
+        @page_title = File.basename(file_name)
+        render text: GitHub::Markup.render(file_name), layout: true
+      else
+        not_found
+        return
+      end
+
+    end
+
+    private
+    def not_found
+      render :not_found, status: 404
+    end
+  end
+end

data/app/helpers/mount_doc/mount_doc_helper.rb

@@ -0,0 +1,104 @@
+require 'mount_doc'
+require 'coderay'
+
+module MountDoc
+  module MountDocHelper
+    extend ::Rails.application.routes.url_helpers
+    extend ::Rails.application.routes.mounted_helpers
+
+    def mount_doc_config
+      MountDoc::Config
+    end
+
+    def doc_dir
+      @doc_dir ||= File.expand_path(mount_doc_config.doc_file_path, ::Rails.application.root)
+    end
+
+    def files
+      @files ||= Dir[File.join(doc_dir, '**/*')].reject { |fn|
+        File.directory?(fn)
+      }.map { |fn|
+        fn.sub(%r{^#{doc_dir}/},'').force_encoding('utf-8')
+      }
+    end
+
+    HTTP_Methods = [
+      :GET,
+      :POST,
+      :PUT,
+      :DELETE
+    ].join("\n")
+    def routes
+      @routes ||= ::Rails.application.routes.routes.to_a.select { |route|
+        controllers.include?(route.defaults[:controller].to_s)
+      }.map {|route|
+        method = HTTP_Methods.match(route.verb).to_s
+        method = 'ANY' if method.empty?
+        {
+          method: method,
+          path: route.path.spec
+        }.merge(route.defaults)
+      }
+    end
+
+    def routes_for(controller, action)
+      puts "#{controller}##{action}"
+      _routes = routes.dup.select{ |route|
+        route[:controller].to_s.to_sym == controller.to_s.to_sym && route[:action].to_s.to_sym == action.to_s.to_sym
+      }
+      _routes
+    end
+
+    def controllers
+      @controllers ||= begin
+        Dir[File.join(::Rails.application.root, 'app/controllers/**/*_controller.rb')].map { |cn|
+          cn.sub(%r{_controller\.rb$}, '').sub(%r{^#{::Rails.application.root}/app/controllers/}, '')
+        }
+      end
+    end
+
+    def models
+      @models ||= begin
+        Dir[File.join(::Rails.application.root, 'app/models/**/*.rb')].map { |cn|
+          cn.sub(%r{\.rb$}, '').sub(%r{^#{::Rails.application.root}/app/models/}, '')
+        }
+      end
+    end
+
+    def actions(class_doc)
+      class_doc.meths.select{ |meth|
+        meth.scope == :instance
+      }.map{ |meth|
+        { method: meth,
+          routes: routes_for(@controller_name.gsub('::', '/'), meth.name)
+        }
+      }.select { |hash|
+        hash[:routes].size > 0
+      }
+    end
+
+    def markup(text)
+      case MountDoc::Config.markup
+      when :markdown
+        markdown(text)
+      else
+        rdoc(text)
+      end
+    end
+
+    def markdown(text)
+      GitHub::Markup.render('tmp.markdown', text)
+    end
+
+    def rdoc(text)
+      RDoc::Markup::ToHtml.new.convert(text)
+    end
+
+    def syntaxhighlight(lang, text)
+      CodeRay.scan(text, lang.to_s.downcase.to_sym).html({
+        css: :style,
+        line_numbers: :inline
+      })
+    end
+  end
+end