lina 0.0.1

data/app/assets/stylesheets/lina/apidoc.css.scss

@@ -0,0 +1,81 @@
+.apidoc-page {
+  height: 100%;
+  margin-right: 0;
+  margin-left: 0;
+
+  .apidoc-title {
+    border-bottom: 1px solid #eee;
+    margin: 0;
+    padding: 16px;
+    text-align: center;
+    font-weight: 200;
+    color: #999;
+  }
+
+  .more-info {
+    white-space: pre;
+  }
+
+  .api-left-tree {
+    height: 100%;
+    overflow-y: auto;
+    background: #FAFAFA;
+    border-right: 1px solid #eee;
+    padding: 0;
+    font-size: 16px;
+    .nav-pills > li > a {
+      border-radius: 0;
+      padding: 6px;
+    }
+  }
+
+  .api-contents {
+    padding-top: 10px;
+    height: 100%;
+    overflow-y: auto;
+    font-size: 20px;
+  }
+
+  .path {
+    font-size: 32px;
+    padding: 0px 0 15px 0;
+    .path-path {
+      font-size: 28px;
+    }
+  }
+
+  .name {
+    margin-bottom: 15px;
+  }
+
+  .description {
+    white-space: pre;
+    color: #999;
+    font-size: 75%;
+  }
+
+  .parameters-title, .return-title {
+    margin-top: 28px;
+    font-size: 28px;
+  }
+
+  .table-wrapper {
+    background: #E8F4FF;
+    padding: 10px 20px 20px;
+    margin-bottom: 30px;
+  }
+
+  .table {
+    font-size: 16px;
+    padding-bottom: 0;
+    margin-bottom: 0;
+  }
+
+  .table > thead > tr > th {
+    border: none;
+  }
+
+  .table > tbody > tr > td {
+    border: none;
+  }
+}

data/app/assets/stylesheets/lina/application.css.scss

@@ -0,0 +1,8 @@
+@import 'bootstrap-sprockets';
+@import 'bootstrap';
+@import 'abn_tree';
+@import 'apidoc';
+
+html, body {
+  height: 100%;
+}

data/app/controllers/lina/apidoc_controller.rb

@@ -0,0 +1,31 @@
+require_dependency "lina/base_controller"
+
+module Lina
+  class ApidocController < BaseController
+    def index
+      all_routes = Rails.application.routes.routes
+      inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+
+      # 过滤出所有 API 相关的路由
+      api_routes = []
+      @user_api_controllers = user_api_controllers
+      @user_api_controllers.each do |controller|
+        api_routes += inspector.send(:filter_routes, controller)
+      end
+
+      @routes = inspector.send(:collect_routes, api_routes)
+      # add schema info to route
+      @routes.each do |route|
+        controller, action = route[:reqs].split('#')
+        route[:schema] = str2controller(controller).action_schema(action)
+        route[:path].gsub!('(.:format)', '')
+      end
+      @_tree = Lina::Tree.new(@routes)
+      @tree = @_tree.to_tree
+      respond_to do |format|
+        format.html
+        format.json { render json: @tree }
+      end
+    end
+  end
+end

data/app/controllers/lina/application_controller.rb

@@ -0,0 +1,65 @@
+module Lina
+  class ApplicationController < ActionController::Base
+
+    def send_action(method_name, *args)
+      block = self.class.action_block(method_name)
+      schema = self.class.action_schema(method_name)
+      if block
+        Lina::Validator.params_check(schema[:params], params)
+        ret = self.instance_exec(*args, &block)
+        default_render unless performed?
+        Lina::Validator.return_check(schema[:return], response.body)
+        ret
+      else
+        super
+      end
+    end
+
+    before_filter :default_format_json
+
+    private
+    def default_format_json
+      request.format = "json" unless params[:format]
+    end
+
+    class <<self
+      _actions = {}
+      def define_action(name, schema={}, &block)
+        Lina::Validator.api_spec_check(Lina::Schema.argument, schema)
+        _actions[name] = { schema: schema, block: block }
+      end
+
+      def action_methods
+        @@action_methods = begin
+          methods = (api_actions + public_instance_methods(true) -
+            internal_methods +
+            public_instance_methods(false)).uniq.map { |x| x.to_s } -
+            hidden_actions.to_a
+          Set.new(methods.reject { |method| method =~ /_one_time_conditions/ })
+        end
+      end
+
+      # 所有支持的 API 列表
+      def api_actions
+        _actions.keys
+      end
+
+      # 返回所有实例
+      def api_action_instances
+        _actions
+      end
+
+      def action_schema(name)
+        _actions[name.to_sym] && _actions[name.to_sym][:schema]
+      end
+
+      def action_block(name)
+        _actions[name.to_sym] && _actions[name.to_sym][:block]
+      end
+
+      def _actions
+        @actions ||= {}
+      end
+    end
+  end
+end

data/app/controllers/lina/base_controller.rb

@@ -0,0 +1,33 @@
+module Lina
+  class BaseController < ActionController::Base
+    layout 'lina/application'
+
+    private
+
+    # 取得用户使用的所有 API 控制器
+    # 避免直接使用 Class 对象, 将它们转化为
+    # 字符串形式
+    # eg: [ 'posts', 'desks' ]
+    def user_api_controllers
+      Rails.application.eager_load!
+      all_subclasses(Lina::ApplicationController, true)
+    end
+
+    def str2controller(klass_str)
+      ::Kernel.const_get(klass_str.to_s.camelize + 'Controller')
+    end
+
+    def all_subclasses(klass, convert_to_string=true)
+      ret = []
+      klass.subclasses.each do |k|
+        if convert_to_string
+          ret << k.to_s.underscore.sub(/_controller$/, '')
+        else
+          ret << k
+        end
+        ret += all_subclasses(k, convert_to_string)
+      end
+      ret
+    end
+  end
+end

data/app/controllers/lina/schema_controller.rb

@@ -0,0 +1,16 @@
+require_dependency "lina/base_controller"
+
+module Lina
+  class SchemaController < BaseController
+    def index
+      if ! controller = user_api_controllers.find { |c| c == params[:schema_controller] }
+        raise "Controller #{params[:schema_controller]} 无法找到"
+      end
+
+      action = params[:schema_action].to_sym
+      if ! @schema = str2controller(controller)._actions[action]
+        raise "Action #{action} 无法找到"
+      end
+    end
+  end
+end

data/app/helpers/lina/application_helper.rb

@@ -0,0 +1,4 @@
+module Lina
+  module ApplicationHelper
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html ng-app='app'>
+<head>
+  <title>Lina</title>
+  <%= stylesheet_link_tag    "lina/application", media: "all" %>
+  <%= javascript_include_tag "lina/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/lina/apidoc/index.html.erb

@@ -0,0 +1,68 @@
+<div class="row apidoc-page" ng-controller='ApidocController' ng-init="setData('<%= lina.data_path %>')">
+
+	<div class="col-md-3 api-left-tree">
+		<h4 class='apidoc-title'>APIDOC</h4>
+    <abn-tree tree-data="my_data" tree-control="my_tree" on-select='showApi(branch)'></abn-tree>
+	</div>
+	<div class="col-md-9 api-contents">
+    <ul class='list-unstyled'>
+      <li ng-repeat='api in currentApi'>
+      <div class='path'>
+        <span class='path-verb'> {{ api.verb }} </span>
+        <span class='path-path'> {{ api.path }} </span>
+      </div>
+        <div class="name">{{ api.schema.name }}</div>
+        <p class='description'>{{ api.schema.description }}</p>
+        <h4 class='parameters-title'>Parameter</h4>
+        <div class="table-wrapper">
+        	<table class='table'>
+        	  <thead>
+        	    <tr>
+        	      <th width='20%'>Name</th>
+        	      <th width='20%'>Type</th>
+        	      <th width='25%'>More Info</th>
+        	      <th>Description</th>
+        	    </tr>
+        	  </thead>
+        	  <tbody>
+        	    <tr ng-repeat='(key, value) in api.schema.params.properties'>
+        	      <td><span>{{ key }}
+        	        <span class="label label-primary" ng-show='isRequired(api.schema.params, key)'>must</span>
+        	        <span class="label label-default" ng-hide='isRequired(api.schema.params, key)'>optional</span>
+        	      </td>
+        	      <td>{{ value.type }}</td>
+        	      <td class='more-info'>{{ moreInfo(value) }}</td>
+        	      <td>{{ value.description }}</td>
+        	    </tr>
+        	  </tbody>
+          </table>
+        </div><!-- .table-wrapper -->
+
+        <h4 class='return-title'>Return</h4>
+        <div class="table-wrapper">
+        	<table class='table'>
+        	  <thead>
+        	    <tr>
+        	      <th width='20%'>Name</th>
+        	      <th width='20%'>Type</th>
+        	      <th width='25%'>More Info</th>
+        	      <th>Description</th>
+        	    </tr>
+        	  </thead>
+        	  <tbody>
+        	    <tr ng-repeat='(key, value) in api.schema.return.properties'>
+        	      <td><span>{{ key }}
+        	        <span class="label label-primary" ng-show='isRequired(api.schema.return, key)'>must</span>
+        	        <span class="label label-default" ng-hide='isRequired(api.schema.return, key)'>optional</span>
+        	      </td>
+        	      <td>{{ value.type }}</td>
+        	      <td class='more-info'>{{ moreInfo(value) }}</td>
+        	      <td>{{ value.description }}</td>
+        	    </tr>
+        	  </tbody>
+        	</table>
+        </div><!-- .table-wrapper -->
+      </li>
+    </ul>
+	</div>
+</div>

data/app/views/lina/schema/index.html.erb

@@ -0,0 +1,2 @@
+<h1>Schema#index</h1>
+<%= debug @schema %>

data/config/routes.rb

@@ -0,0 +1,6 @@
+Lina::Engine.routes.draw do
+  get 'schema', to: 'schema#index'
+  get 'data', to: 'apidoc#index', format: 'json'
+
+  root "apidoc#index"
+end

data/lib/generators/lina/api_generator.rb

@@ -0,0 +1,59 @@
+module Lina
+  module Generators
+    class ApiGenerator < Rails::Generators::NamedBase # :nodoc:
+      argument :actions, type: :array, default: [], banner: "action action"
+      check_class_collision suffix: "Controller"
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def create_controller_files
+        template 'controller.rb', File.join('app/controllers', class_path, "#{file_name}_controller.rb")
+      end
+
+      def add_routes
+        actions.reverse.each do |action|
+          route generate_routing_code(action)
+        end
+      end
+
+      hook_for :test_framework, as: :controller
+      if Lina.generate_views
+        hook_for :jbuilder, in: :rails, default: true
+      end
+
+      private
+
+        # This method creates nested route entry for namespaced resources.
+        # For eg. rails g controller foo/bar/baz index
+        # Will generate -
+        # namespace :foo do
+        #   namespace :bar do
+        #     get 'baz/index'
+        #   end
+        # end
+        def generate_routing_code(action)
+          depth = regular_class_path.length
+          # Create 'namespace' ladder
+          # namespace :foo do
+          #   namespace :bar do
+          namespace_ladder = regular_class_path.each_with_index.map do |ns, i|
+            indent("namespace :#{ns} do\n", i * 2)
+          end.join
+
+          # Create route
+          #     get 'baz/index'
+          route = indent(%{get '#{file_name}/#{action}'\n}, depth * 2)
+
+          # Create `end` ladder
+          #   end
+          # end
+          end_ladder = (1..depth).reverse_each.map do |i|
+            indent("end\n", i * 2)
+          end.join
+
+          # Combine the 3 parts to generate complete route entry
+          namespace_ladder + route + end_ladder
+        end
+    end
+  end
+end

data/lib/generators/lina/install_generator.rb

@@ -0,0 +1,15 @@
+module Lina
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Create a lina initializer"
+      def copy_initializer
+        template "lina.rb", "config/initializers/lina.rb"
+      end
+
+      def insert_router
+        route "api_for '/apidoc'"
+      end
+    end
+  end
+end

data/lib/generators/templates/controller.rb

@@ -0,0 +1,25 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= class_name %>Controller < Lina::ApplicationController
+<% actions.each do |action| -%>
+  define_action :<%= action %>, {
+    name: '<%= action %>',
+    description: '',
+    params: {
+      type: 'object',
+      required: [],
+      properties: {
+      }
+    },
+    return: {
+    }
+  } do
+    # write code here, It's the same as before
+  end
+<%= "\n" unless action == actions.last -%>
+<% end -%>
+end
+<% end -%>

data/lib/generators/templates/lina.rb

@@ -0,0 +1,18 @@
+# lina config file
+Lina.setup do |config|
+  #是否自动生成 views
+  #config.generate_views = true
+
+  #是否开启入口参数校验
+  #config.params_check = true
+
+  #入口参数校验时使用的 json schema 版本, 更多: http://tools.ietf.org/html/draft-zyp-json-schema-04
+  #config.params_json_schema_version = :v4
+
+
+  #是否开启返回值参数校验
+  #config.return_check = true
+
+  #返回值校验时使用的 json schema 版本, 更多: http://tools.ietf.org/html/draft-zyp-json-schema-04
+  #config.return_json_schema_version = :v4
+end

data/lib/lina/engine.rb

@@ -0,0 +1,24 @@
+module Lina
+  class Engine < ::Rails::Engine
+    isolate_namespace Lina
+  end
+
+  def self.setup
+    yield self
+  end
+
+  mattr_accessor :generate_views
+  @@generate_views = true
+
+  mattr_accessor :params_check
+  @@params_check = true
+
+  mattr_accessor :params_json_schema_version
+  @@params_json_schema_version = :v4
+
+  mattr_accessor :return_check
+  @@return_check = true
+
+  mattr_accessor :return_json_schema_version
+  @@return_json_schema_version = :v4
+end

data/lib/lina/error.rb

@@ -0,0 +1,13 @@
+module Lina
+  class Error < RuntimeError #:nodoc:
+  end
+
+  class ParamsCheckError < Error #:nodoc:
+  end
+
+  class ReturnCheckError < Error #:nodoc:
+  end
+
+  class ApiSpecError < Error #:nodoc:
+  end
+end

data/lib/lina/rails/router.rb

@@ -0,0 +1,7 @@
+module ActionDispatch::Routing
+  class Mapper
+    def api_for(path)
+      mount Lina::Engine => path
+    end
+  end
+end

data/lib/lina/schema.rb

@@ -0,0 +1,61 @@
+module Lina
+  class Schema
+    def self.argument
+      {
+        type: "object",
+        required: ['name', 'params', 'return'],
+        properties: {
+          name: {
+            type: "string",
+            description: "api name"
+          },
+          description: {
+            type: 'string',
+          },
+          params: {
+            type: "object",
+          },
+          return: {
+            type: "object",
+          }
+        }
+      }
+    end
+
+    def self.params_validator(params)
+      {
+        type: 'object',
+        properties: params
+      }
+    end
+  end
+
+  class Validator
+    def self.params_check(schema, data)
+      return unless Lina.params_check
+      begin
+        JSON::Validator.validate!(schema, data)
+      rescue JSON::Schema::ValidationError => e
+        raise Lina::ParamsCheckError, e.message
+      end
+    end
+
+    def self.return_check(schema, data)
+      return unless Lina.return_check
+      begin
+        JSON::Validator.validate!(schema, data)
+      rescue JSON::Schema::ValidationError => e
+        raise Lina::ReturnCheckError, e.message
+      end
+    end
+
+    def self.api_spec_check(schema, data)
+      begin
+        JSON::Validator.validate!(schema, data)
+      rescue JSON::Schema::ValidationError => e
+        raise Lina::ApiSpecError, e.message
+      end
+    end
+  end # end of class Validator
+
+end

data/lib/lina/tree.rb

@@ -0,0 +1,102 @@
+module Lina
+  class Tree
+    attr_reader :root
+    def initialize(routes)
+      @routes = routes
+      @size = 0
+      @root = paths_to_tree
+    end
+
+    def to_tree
+      ret = []
+      @root.children.each do |child|
+        ret << _to_tree(child)
+      end
+      ret
+    end
+
+    def _to_tree(root)
+      ret = {}
+      ret[:label] = root.path
+      ret[:values] = root.values
+      if ! root.children.empty?
+        ret[:children] = root.children.collect { |child| _to_tree(child) }
+      end
+      ret
+    end
+
+    def self.parse(routes)
+      self.new(routes).to_tree
+    end
+
+    def size
+      @size
+    end
+
+    def paths_to_tree
+      tree = TreeNode.new('/')
+      @routes.each do |route|
+        paths = route[:path].split("/")
+        paths.shift
+        paths_insert_tree(paths, tree, route)
+      end
+      tree
+    end
+
+    def paths_insert_tree(paths, tree, route)
+      if paths.empty?
+        @size += 1
+        tree.add_value(route)
+        return
+      end
+      paths = paths.dup
+      path = paths.shift
+      path = path.gsub('(.:format)', '')
+
+      endpoint = tree.find_child(path)
+      if endpoint
+        paths_insert_tree(paths, endpoint, route)
+      else
+        child = TreeNode.new(path, tree)
+        tree.add_child(child)
+        paths_insert_tree(paths, child, route)
+      end
+    end
+  end
+
+  class TreeNode # :nodoc:
+    attr_reader :path, :children, :parent, :values
+    def initialize(path, parent =nil)
+      @path = path
+      @children = []
+      @parent = parent
+      @values = []
+    end
+
+    def add_value(value)
+      @values << value
+    end
+
+    def real_path
+      ret_path = [ @path ]
+      node = self
+      while(node = node.parent)
+        ret_path.unshift(node.path)
+      end
+      ret_path.join('/')
+    end
+
+    def root?
+      @parent.nil?
+    end
+
+    def add_child(child)
+      @children << child
+      child
+    end
+
+    def find_child(path)
+      @children.find { |child| child.path == path }
+    end
+  end
+end

data/lib/lina/version.rb

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