mount_doc 0.0.1

data/app/views/layouts/mount_doc.slim

@@ -0,0 +1,55 @@
+doctype 5
+html
+  head
+    meta charset="UTF-8"
+    title
+      = @page_title
+      |  - † MountDoc †
+    = stylesheet_link_tag :mount_doc
+  body
+
+    article#main
+      = yield.force_encoding('utf-8')
+
+    aside#side-index
+
+      - if mount_doc_config.visible_components.include?(:files)
+        div#files-index
+          h6 Files
+
+          ul
+            - for file in files
+              li
+                a(href="#{url_for(:controller => 'mount_doc', :action => 'file_doc', :id => file)}")
+                  = file
+
+      - if mount_doc_config.visible_components.include?(:urls)
+        div#urls-index
+          h6 URLs
+
+          ul
+            - for route in routes
+              li
+                a(href="#{url_for(:controller => 'mount_doc', :action => 'action_doc', :ctrl_id => route[:controller].gsub('/', '::'), :id => route[:action])}")
+                  span.method= route[:method]
+                  = route[:path]
+
+      - if mount_doc_config.visible_components.include?(:controllers)
+        div#controllers-index
+          h6 Controllers
+
+          ul
+            - for controller in controllers
+              li
+                a(href="#{url_for(:controller => 'mount_doc', :action => 'controller_doc', :id => controller.gsub('/', '::'))}")
+                  = controller.camelize
+
+      - if mount_doc_config.visible_components.include?(:models)
+        div#models-index
+          h6 Models
+
+          ul
+            - for model in models
+              li
+                a(href="#{url_for(:model => 'mount_doc', :action => 'model_doc', :id => model.gsub('/', '::'))}")
+                  = model.camelize

data/app/views/mount_doc/mount_doc/action_doc.slim

@@ -0,0 +1,57 @@
+
+- if @document.tags('deprecated').size > 0
+  p.deprecated DEPRECATED: #{@document.tags('deprecated').first.text}
+
+h1
+  = @controller_name.gsub('::', '/').camelize + '#' +@action_name
+  - if @document.tags('version').size > 0
+    |  (v#{@document.tags('version').first.text})
+
+ul.urls
+  - for route in routes_for(@controller_name.gsub('::', '/'), @action_name)
+    li
+      span.method= route[:method]
+      = route[:path]
+
+== markup @document.docstring.to_s
+
+- if @document.tags('param').size > 0
+  h2 Params
+
+  ul.params
+    - for param in @document.tags('param')
+      li
+        | ( #{param.types.map(&:downcase).join(', ')} ) <code><b>#{param.name}</b></code> &mdash; <small>#{param.text}</small>
+        - if (options = @document.tags('option').select{|opt| opt.name == param.name }).size > 0
+          ul
+            - for option in options
+              li ( #{option.pair.types.map(&:downcase).join(', ')} ) <code><b>#{option.pair.name}</b></code> &mdash; <small>#{option.pair.text}</small>
+
+- if @document.tags('example').size > 0
+  h2 Example
+
+  - for example in @document.tags('example')
+    h3= example.name
+    pre
+      code= example.text
+
+- if @document.tags('response').size > 0
+  h2 Response
+
+  - for response in @document.tags('response')
+    pre
+      span.type= response.name.to_s.upcase
+      code== syntaxhighlight response.name, response.text
+
+- if @document.tags('todo').size > 0
+  h2 ToDo
+
+  - for todo in @document.tags('todo')
+    == markup todo.text
+
+h2 Code
+
+p
+  code= @document.file.sub(Rails.root.to_s, '')
+pre
+  code== syntaxhighlight :ruby, @document.source

data/app/views/mount_doc/mount_doc/controller_doc.slim

@@ -0,0 +1,14 @@
+h1= @controller_name.gsub('::', '/').camelize
+
+== markup @document.docstring.to_s
+
+- for action in actions(@document)
+  h2
+    a href="#{url_for(controller: 'mount_doc', action: 'action_doc', ctrl_id: @controller_name, id: action[:method].name)}"
+      = action[:method].name
+  ul.urls
+    - for route in action[:routes]
+      li
+        span.method= route[:method]
+        = route[:path]
+  == markup action[:method].docstring.summary.sub(/\.\Z/, '')

data/app/views/mount_doc/mount_doc/index.slim

@@ -0,0 +1 @@
+p paragraph

data/app/views/mount_doc/mount_doc/not_found.slim

@@ -0,0 +1,3 @@
+h1 Not Found
+
+p ご指定のファイルは見つかりません

data/config/routes.rb

@@ -0,0 +1,7 @@
+MountDoc::Engine.routes.draw do
+  match 'controllers/:id' => 'mount_doc#controller_doc'
+  match 'controllers/:ctrl_id/actions/:id' => 'mount_doc#action_doc'
+  match 'models/:id' => 'mount_doc#model_doc'
+  match 'files/*id' => 'mount_doc#file_doc'
+  match '/' => 'mount_doc#index', :as => 'mount_doc_root'
+end

data/lib/mount_doc.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module MountDoc
+  autoload :VERSION, "mount_doc/version"
+  autoload :Config, "mount_doc/config"
+  autoload :Document, "mount_doc/document"
+end
+
+require 'mount_doc/string_patch'
+require 'mount_doc/rails'
+require 'mount_doc/rails/generators'

data/lib/mount_doc/config.rb

@@ -0,0 +1,74 @@
+require 'mount_doc'
+
+module MountDoc::Config
+  mattr_reader :auto_mount
+  def auto_mount=(bool)
+    @@auto_mount = !!bool
+  end
+  module_function :auto_mount=
+  def auto_mount?; @@auto_mount; end
+  module_function :auto_mount?
+  mattr_reader :auto_mount_path
+  def auto_mount_path=(path)
+    @@auto_mount_path = path.to_s
+  end
+  module_function :auto_mount_path=
+
+  mattr_reader :visible_private_methods
+  def visible_private_methods=(visible)
+    @@visible_private_methods = !!visible
+  end
+  module_function :visible_private_methods=
+  def visible_private_methods?; @@visible_private_methods; end
+  module_function :visible_private_methods?
+
+  mattr_reader :visible_protected_methods
+  def visible_protected_methods=(visible)
+    @@visible_protected_methods = !!visible
+  end
+  module_function :visible_protected_methods=
+  def visible_protected_methods?; @@visible_protected_methods; end
+  module_function :visible_protected_methods?
+
+  Components = [
+    :files,
+    :urls,
+    :controllers
+  ]
+  mattr_reader :visible_components
+  def visible_components=(components)
+    components.select!{|component| Components.include?(component) }
+    @@visible_components = components
+  end
+  module_function :visible_components=
+
+  mattr_reader :doc_file_path
+  def doc_file_path=(path)
+    @@doc_file_path = path.to_s
+  end
+  module_function :doc_file_path=
+
+  mattr_reader :markup
+  def markup=(path)
+    @@markup = path.to_s
+  end
+  module_function :markup=
+
+  DefaultSettings = {
+    auto_mount: false,
+    auto_mount_path: '/doc',
+    visible_private_methods: false,
+    visible_protected_methods: false,
+    visible_components: Components,
+    doc_file_path: 'doc',
+    markup: :rdoc
+  }
+  def defaults!
+    DefaultSettings.each_pair do | name, val |
+      self.send("#{name}=", val)
+    end
+  end
+  module_function :defaults!
+
+  self.defaults!
+end

data/lib/mount_doc/document.rb

@@ -0,0 +1,38 @@
+require 'mount_doc'
+require 'yard'
+
+YARD::Tags::Library.define_tag "Response", :response, :with_title_and_text
+
+class MountDoc::Document
+  attr_reader :type, :name, :doc_object
+
+  def initialize(type, name)
+    @type = type
+    @name = name
+
+    load_file
+  end
+
+  def load_file(type = @type, name = @name)
+    case type
+    when :controller
+      load_controller(name)
+    when :model
+      load_model(name)
+    end
+  end
+
+  def load_controller(name)
+    controller_name = name.gsub('::', '/').camelize + 'Controller'
+    file_path = File.join(::Rails.root, 'app/controllers', "#{controller_name.underscore}.rb")
+    YARD.parse(file_path)
+    @doc_object = P(controller_name)
+  end
+
+  def load_model(name)
+    model_name = name.gsub('::', '/').camelize
+    file_path = File.join(::Rails.root, 'app/models', "#{model_name.underscore}.rb")
+    YARD.parse(file_path)
+    @doc_object = P(model_name)
+  end
+end

data/lib/mount_doc/rails.rb

@@ -0,0 +1,6 @@
+require 'mount_doc'
+
+module MountDoc::Rails
+end
+require 'mount_doc/rails/route_set'
+require 'mount_doc/rails/engine'

data/lib/mount_doc/rails/engine.rb

@@ -0,0 +1,10 @@
+require 'mount_doc'
+
+class MountDoc::Engine < ::Rails::Engine
+  isolate_namespace MountDoc
+
+  config.mount_doc = MountDoc::Config
+
+  initializer "config.mount" do
+  end
+end

data/lib/mount_doc/rails/generators.rb

@@ -0,0 +1,5 @@
+require 'mount_doc'
+
+module MountDoc::Generators
+end
+require 'mount_doc/rails/generators/initialize_generator'

data/lib/mount_doc/rails/generators/initialize_generator.rb

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+require 'mount_doc/rails/generators'
+
+class MountDoc::Generators::InitializeGenerator < Rails::Generators::Base
+end if Rails.const_defined?(:Generators)

data/lib/mount_doc/rails/route_set.rb

@@ -0,0 +1,19 @@
+require 'mount_doc'
+require 'action_dispatch/routing/route_set'
+
+class ActionDispatch::Routing::RouteSet
+  def finalize_with_mount_doc!
+    result = finalize_without_mount_doc!
+
+    begin
+      self.eval_block(lambda{
+        mount MountDoc::Engine => MountDoc::Config.auto_mount_path
+      }) if MountDoc::Config.auto_mount? && self.named_routes.get(:mount_doc_rails_engine).nil?
+
+      true
+    end
+
+    result
+  end
+  alias_method_chain :finalize!, :mount_doc
+end

data/lib/mount_doc/string_patch.rb

@@ -0,0 +1 @@
+require 'mount_doc'

data/lib/mount_doc/version.rb

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

data/mount_doc.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mount_doc/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sho Kusano"]
+  gem.email         = ["rosylilly@aduca.org"]
+  gem.description   = %q{Supporting Build APIs on Rails}
+  gem.summary       = %q{Railsで書かれたアクションにコメントを書くと、動的にドキュメントを生成し、その結果をRailsアプリにマウントする}
+  gem.homepage      = "https://github.com/rosylilly/mount_doc"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mount_doc"
+  gem.require_paths = ["lib"]
+  gem.version       = MountDoc::VERSION
+
+  gem.add_dependency('rails', '~> 3.2')
+  gem.add_dependency('github-markup', '~> 0.7')
+  gem.add_dependency('slim', '~> 1.2')
+  gem.add_dependency('yard', '~> 0.8')
+  gem.add_dependency('coderay', '~> 1.0')
+end

data/spec/lib/mount_doc/config_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe MountDoc::Config do
+  describe :auto_mount do
+    subject{ MountDoc::Config.auto_mount? }
+    it("default: false"){ should be_false }
+
+    it("writable boolean"){
+      MountDoc::Config.auto_mount = 1
+      should be_true
+    }
+  end
+
+  describe :auto_mount_path do
+    subject { MountDoc::Config.auto_mount_path }
+
+    it("default: /doc"){ should == '/doc' }
+
+    it('writable string'){
+      MountDoc::Config.auto_mount_path = 1
+      should == '1'
+    }
+  end
+
+  describe :visible_private_methods do
+    subject{ MountDoc::Config.visible_private_methods? }
+
+    it("default: false"){ should be_false }
+
+    it("writable boolean"){
+      MountDoc::Config.visible_private_methods = 1
+      should be_true
+    }
+  end
+
+  describe :visible_protected_methods do
+    subject{ MountDoc::Config.visible_protected_methods? }
+
+    it("default: false"){ should be_false }
+
+    it("writable boolean"){
+      MountDoc::Config.visible_protected_methods = 1
+      should be_true
+    }
+  end
+
+  describe :visible_components do
+    subject{ MountDoc::Config.visible_components }
+
+    it("default: MountDoc::Config::Components"){ should == MountDoc::Config::Components }
+
+    it("writable MountDoc::Config::Components"){
+      MountDoc::Config.visible_components = [:urls, :invalid, :controllers]
+      should == [:urls, :controllers]
+    }
+  end
+
+  describe :doc_file_path do
+    subject{ MountDoc::Config.doc_file_path }
+    
+    it("default: 'doc'"){ should == 'doc' }
+  end
+
+  describe :defaults! do
+    subject{ MountDoc::Config }
+
+    it("set default"){ 
+      subject.visible_protected_methods = true
+      subject.defaults!
+      subject.visible_protected_methods.should be_false
+    }
+  end
+end

data/spec/lib/mount_doc/document_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe MountDoc::Document do
+  describe "initialize from file" do
+    it "controller" do
+      doc = MountDoc::Document.new(:controller, "api::documents")
+
+      doc.doc_object.name.should == :DocumentsController
+    end
+
+    it "model" do
+      doc = MountDoc::Document.new(:model, "api::document")
+
+      doc.doc_object.name.should == :Document
+    end
+  end
+end