api_doc_generation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 133aab2c0a7b1a4e619afcfad0698c1df8069131
+  data.tar.gz: d40029aa3a769a6e5ebc36229166d722e024da26
+SHA512:
+  metadata.gz: f779971b6c8e266fb07554aa75e15fa96bbfb2cfe2097e3ef8235d04baea9192b85da90ea6391456ae629c8eb841b0e5a4a15c81e613c786549dcdb0d4baad5f
+  data.tar.gz: 61b5e7ba17d7a3adc2eac35d26a49aa5459b9dec58faf37a576916546eb0fc9797a2f4ef17ad5c9cc15cfa4888854a76e214d09ce0e1a399afa15cec4e94ad3d

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_api_doc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jiangzhi.xie
+
+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,29 @@
+# RailsApiDoc
+
+rails api document generation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'api_doc_generation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_doc_generation
+
+## Usage
+
+`rake doc:api [CODES_PATH=app/controllers/api]`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/api_doc_generation.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_doc_generation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_doc_generation"
+  spec.version       = ApiDocGeneration::VERSION
+  spec.authors       = ["jiangzhi.xie"]
+  spec.email         = ["jiangzhi.xie@edoctor.cn"]
+  spec.description   = %q{generate rails api document}
+  spec.summary       = %q{generate rails api document}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/api_doc_generation/version.rb

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

data/lib/api_doc_generation.rb

@@ -0,0 +1,156 @@
+require "api_doc_generation/version"
+
+if defined? Rake
+  require "rake/api_doc_generation"
+end
+
+
+module ApiDocGeneration; class Generation
+  def initialize(codes_path = nil, out_path = nil)
+    codes_path ||= File.expand_path('app/controllers/api', Rails.root)
+    out_path ||= File.expand_path('tmp/api_doc.html', Rails.root)
+    controller_documents = []
+
+    each_api_controllers_file(codes_path) do |path|
+      controller_path = path.split("app/controllers").last
+      class_name = controller_path.gsub('.rb', '').classify
+      klass = class_name.safe_constantize
+
+      controller_documents << generate_controller(path, klass)
+    end
+
+    generate_html_string(controller_documents)
+  end
+
+  def write_to_file(out_path)
+    File.open(out_path, 'w+') do |file|
+      file.write @result
+    end
+  end
+
+
+  def result
+    @result
+  end
+
+
+  private 
+
+
+  # API_CONTROLLERS_DIR = File.expand_path('app/controllers/api/**/*.rb', Rails.root)
+  def each_api_controllers_file(codes_path, &block)
+
+    Dir[codes_path + '/**/*.rb'].each do |path|
+      next if path =~ /base_controller.rb$/
+      block.call path
+    end
+  end
+
+
+
+  # {
+  #  
+  #   :path => path,
+  #   :actions => [
+  #     {
+  #       "Params" => ['xxx', 'yyy'],
+  #       "zzz" => ["zz1", "zz2"]
+  #     }
+  #   ]
+  # }
+  def generate_controller(path, klass)
+    filelines = File.readlines(path)
+    actions = klass.action_methods - klass.superclass.action_methods
+
+    actions = actions.map do |action|
+      generate_action(klass, action, filelines)
+    end
+
+    {
+      :path => path,
+      :klass => klass.to_s,
+      :actions => actions
+    }
+  end
+
+
+
+  def generate_action(klass, action, filelines)
+    document = {:name => action.to_s}
+    method = klass.instance_method action
+    filepath, line = method.source_location
+    tmp = []; last_line = ""
+
+    (line - 2).downto(0) do |i|
+      line = filelines[i]
+      
+      unless line =~ /^\s*(\#.*?\n)?$/
+        document[:desc] = last_line
+        document.delete last_line
+        break
+      end
+
+      line.gsub!(/\s*\#/, '')
+      next if line =~ /^\s*$/
+
+      m = line.match(/(?<level>\s*)(?<desc>(?<key>.*?)(\:(?<val>.*?))?)$/)
+      level = m[:level].length / 2
+      desc = m[:desc].gsub(/^\s*|\s*$/, '')
+      line.gsub!(/^\s*|\:?\s*$/, '')
+
+      if level == 0
+        if tmp.length == 0 && m[:val] && m[:val].length > 0
+          document[m[:key]] = m[:val]
+        else
+          document[m[:key] + (m[:val] || '')] = tmp.reverse
+        end
+        tmp = []
+      else
+        tmp << {:level => level, :desc => desc}
+      end
+
+      last_line = line
+    end
+
+    Hash[document.merge(get_routes(klass, action)).to_a.reverse]
+  end
+
+
+
+  def get_routes(klass, action)
+    controller = klass.to_s.gsub(/Controller$/, '').underscore
+
+    
+    Rails.application.routes.named_routes.routes.each do |name, journey|
+      defaults = journey.defaults
+
+      if defaults[:controller] == controller && defaults[:action] == action
+        return {
+          :path => journey.path.spec.to_s.gsub(/\(\.\:format\)$/, ''),
+          :method => journey.verb.to_s.match(/\^(?<req_method>\w+)\$/)[:req_method]
+        }
+      end
+    end
+
+    {
+      :path => "",
+      :method => ""
+    }
+  end
+
+
+
+
+  def generate_html_string(controller_documents)
+    template = ERB.new(
+      File.read(File.expand_path('../../templates/doc.html.erb', __FILE__))
+    )
+    doc_binding = Object.new.instance_eval do
+      @documents = controller_documents
+      binding
+    end
+
+    @result = template.result(doc_binding)
+  end
+
+end; end

data/lib/rake/api_doc_generation.rb

@@ -0,0 +1,8 @@
+
+module ApiDocGeneration
+  path = File.expand_path("../tasks", __FILE__)
+
+  Dir.open(path).each do |ext|
+    load File.expand_path(ext, path) if ext =~ /^\w+\.rake$/
+  end
+end

data/lib/rake/tasks/api_doc.rake

@@ -0,0 +1,12 @@
+
+namespace :doc do
+  task :api => :environment do
+    require 'api_doc_generation'
+
+    codes_path = ENV['CODES_PATH'] || File.expand_path('app/controllers/api', Rails.root)
+
+    File.open("./tmp/api_doc.html", "w+") do |f|
+      f.write(ApiDocGeneration::Generation.new(codes_path).result)
+    end
+  end
+end

data/templates/doc.html.erb

@@ -0,0 +1,112 @@
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html;charset=utf-8">
+    
+    <title>Uasthree Api Documents</title>
+    <style type='text/css'>
+      .title {
+        text-align: center;
+        color: blank;
+      }
+
+      .controller, .list {
+        width: 900px;
+        border: 1px solid;
+        margin: 20px auto 40 auto;
+      }
+
+      .controller-title {
+        text-align: center;
+      }
+
+      .action {
+        margin-top: 40px;
+        padding: 20px 40px 20px 0px;
+      }
+
+      .action-even {
+        background-color: #efffef;
+      }
+
+      .action-odd {
+        background-color: #fff;
+      }
+
+
+      .desc-one {
+        padding-left: 20px;
+      }
+
+      .desc-two {
+        padding-left: 40;
+      }
+
+      .desc-val {
+        color: #808;
+      }
+
+      .desc-key {
+        display: inline-block;
+        width: 100px;
+      }
+
+      .desc-many {
+        width: auto;
+      }
+    </style>
+  </head>
+
+  <body>
+    <h1 class='title'>Uasthree Api Document</h1>
+
+    <div class='list'>
+      <ul>
+        <% @documents.each do |controller| %>
+          <li>
+            <a href='#controller-<%= controller[:klass] %>'><%= controller[:klass] %></a>
+
+            <ul class='ul-controller'>
+              <% controller[:actions].each do |action| %>
+                <li><a href='#action-<%= action[:name] %>'><%= action[:desc] %></a></li>
+              <% end %>
+            </ul>
+
+          </li>
+        <% end %>
+      </ul>
+    </div>
+
+    <% @documents.each do |controller| %>
+      <div class='controller' id='controller-<%= controller[:klass] %>'>
+        <h2 class='controller-title'><%= controller[:klass] %></h2>
+        
+        <% controller[:actions].each_with_index do |action, i| %>
+          <div class='action action-<%= i % 2 == 0 ? 'even' : 'odd' %>' id='action-<%= action[:name] %>'>
+            <strong class='desc-one'><%= action[:desc] %></strong>
+
+            <% action.each do |key, val| %>
+              <% if Array === val %>
+                <p class='desc-one'>
+                  <span class='desc-key desc-many'><%= key %>:</span>
+                </p>
+
+                <% val.each do |v| %>
+                  <p class='desc-two desc-val' style='padding-left: <%= (v[:level] + 1) * 20 %>px;'>
+                    <%= v[:desc] %>
+                  </p>
+                <% end %>
+              <% elsif not key.to_s =~ /^(desc|name)$/ %>
+                <p class='desc-one'>
+                  <span class='desc-key'><%= key %><%= val.length > 0 ? ':' : '' %></span>
+                  <span class='desc-val'><%= val %></span>
+                </p>
+              <% end %>
+
+            <% end %>
+          </div>
+        <% end %>
+
+      </div>
+    <% end %>
+  </body>
+</html>

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: api_doc_generation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jiangzhi.xie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: generate rails api document
+email:
+- jiangzhi.xie@edoctor.cn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_doc_generation.gemspec
+- lib/api_doc_generation.rb
+- lib/api_doc_generation/version.rb
+- lib/rake/api_doc_generation.rb
+- lib/rake/tasks/api_doc.rake
+- templates/doc.html.erb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: generate rails api document
+test_files: []
+has_rdoc: