rails_api_documentation 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32d21488a0b91b4da968d909a9988b67cc7ea427
-  data.tar.gz: 72c1203f43307e203f499879d0739c0adf3fe237
+  metadata.gz: e94dad7cd2df856b0fa66bc552ba1b21719e2397
+  data.tar.gz: 00ee1ae3831826caea27f72422986ac45a49cb0a
 SHA512:
-  metadata.gz: ad3a4d03dbb76aa738e0a7cc16fe832967d9db8b8b28fc14932398229ab6837bb3defb2d50fdea137a216b25d2ee62abe8f200ab7a9026ba2110ec67a6e32943
-  data.tar.gz: fdc0c2b103f36ea0443c62399b0f027aa760fd4ec25dd6733708baecb7f3a75cbc236f4abc0804e07851a66db8ac4096b17e49eac46bcf6e88028b0ffd7ce261
+  metadata.gz: c80f87121f85a5f2757513b5612ac1baa3a2107e2d942b072450a0efa771118bab83cda7e768a13ab4be45ea84b7e4410aca0ada94ec489f91655c38c10a99c5
+  data.tar.gz: ac7a8147091a77af5f71f33ed8ba963db16ebfc69b4e153c3f5a70439827d4674304f4e2f0eac79201e0084f7384d815c95432c935599e81f9eddbafa0680be2

data/README.md

@@ -44,15 +44,16 @@ To display api documentation on route '/api_doc' you need to:
       has_scope :article_id, :name
 
       # Define parameters with type and nested options
-      parameter :age, type: Integer
-      parameter :name, type: String, required: true
-      parameter :articles, type: :model, model: Article do
-        parameter :title, type: String
-        parameter :body, type: String, required: true
+      # Article and Datum are usual ActiveRecord models
+      parameter :age, type: :integer
+      parameter :name, type: :string, required: true
+      parameter :articles_attributes, type: :ary_object, model: 'Article' do
+        parameter :title, type: :string
+        parameter :body, type: :string, required: true
         parameter :rating, type: :enum, enum: [1, 2, 3]
-        parameter :data, type: :model, model: Datum do
-          parameter :creation_date, type: DateTime
-          parameter :comment, type: String
+        parameter :data_attributes, type: :object, model: 'Datum' do
+          parameter :creation_date, type: :datetime
+          parameter :comment, type: :string
         end
       end
       parameter :test, type: String, required: true

data/app/assets/javascripts/table.js.coffee

@@ -17,12 +17,21 @@ $ ->
   $('.flex-table input, .flex-table select').on 'click', (e) ->
     e.stopPropagation()
 
-  $('.ico').on 'click', (e) ->
+  $('span.ico').on 'click', (e) ->
     self = $(this)
     e.preventDefault()
     e.stopPropagation()
     self.closest('.row').toggleClass('is-active')
 
+  $('.destroy').on 'click', (e) ->
+    self = $(this)
+
+    self.closest('.flex-line').toggleClass('destroyed')
+
+  $('form.flex-line').on 'submit', () ->
+    $(this).addClass('updated')
+    $(this).removeClass('is-active')
+
   # _header_height = $('.aside').offset().top
 
   _window = $(window)

data/app/assets/stylesheets/rails_api_doc/default.sass

@@ -2,30 +2,53 @@
 @import url(http://fonts.googleapis.com/css?family=Open+Sans:300,400,700)
 
 body
-  font-family: 'Open Sans', sans-serif
-  font-weight: 300
-  line-height: 1.42em
-  color: #A7A1AE
-  background-color: #1F2739
+
+ font-family: 'Open Sans', sans-serif
+ font-weight: 300
+ line-height: 1.42em
+ color: #A7A1AE
+ background-color: #1F2739
 
 h1.header
-  font-size: 3em
-  font-weight: 300
-  line-height: 1em
-  text-align: center
+
+ font-size: 3em
+ font-weight: 300
+ line-height: 1em
+ text-align: center
+ color: #4DC3FA
+
+.request-action-title
+
+ font-weight: 300
+ line-height: 1em
+ text-align: center
+ color: #4DC3FA
+
+ span
+  font-size: 0.85em
+
+ .blue
+
   color: #4DC3FA
 
+
+
 .blue
-  color: #185875
+
+ color: #185875
 
 .yellow
-  color: #FFF842
+
+ color: #FFF842
 
 .content
-  display: flex
 
-  nav
-    flex: 1
+ display: flex
+
+ nav
+
+  flex: 1
+
+ .tables
 
-  .tables
-    flex: 5
+  flex: 5

data/app/assets/stylesheets/rails_api_doc/table.sass

@@ -52,10 +52,18 @@
     padding: 1% 2%
     position: absolute
     left: 2%
+    border-radius: 100%
+
+    &.destroy
+      left: 10%
+
+      color: #FB667A
+
+      text-decoration: none
 
     &:hover
-      background-color: #FFF842
-      color: #403E10
+      background-color: black//#FFF842
+      color: white
 
       transition-delay: 0s
       transition-duration: 0.4s
@@ -74,6 +82,15 @@
 
   background: lightgreen
 
+  &.created
+    border: 2px solid #1E90FF
+
+  &.destroyed
+    border: 2px solid #DC143C
+
+  &.updated
+    border: 2px solid #00FF00
+
   &.row
     display: flex
 
@@ -128,8 +145,8 @@
 div.flex-item
 
   &:hover
-    background-color: #FFF842
-    color: #403E10
+    background-color: #4DC3FA //#FFF842
+    color: white
 
     transition-delay: 0s
     transition-duration: 0.4s

data/app/controllers/rails_api_doc/api_docs_controller.rb

@@ -3,50 +3,47 @@
 # :nodoc:
 class RailsApiDoc::ApiDocsController < RailsApiDoc::ApplicationController
 
-  class NewRecord < ActiveRecord::Base
-  end
-
-  def index
+  def show
     # preload controllers for parameters to apply
     Dir.glob("#{Rails.root}/app/controllers/**/*.rb").each { |file| require_dependency file }
 
-    @request_repository = RailsApiDoc::Controller::Request::Repository
+    @registered_controllers = RailsApiDoc::Controller::Request::Factory.registered_controllers
 
-    @registered_controllers = @request_repository.registered_controllers
+    @request_repository = RailsApiDoc::Controller::Request::Factory.repo
 
     @response_repository = RailsApiDoc::Controller::Response::Factory.repo
   end
 
   def create
-    attributes = RailsApiDoc::Controller::AttributeParser.parse_attributes(permitted_params)
+    attributes = RailsApiDoc::Model::AttributeParser.parse_attributes(params)
 
-    RailsApiDoc::ApiDatum.create!(attributes)
+    @res = RailsApiDoc::ApiDatum.create!(attributes)
+
+    redirect_to api_doc_path
   end
 
   def destroy
-    attributes = RailsApiDoc::Controller::AttributeParser.parse_attributes(permitted_params)
-
     if params[:id]
-      RailsApiDoc::ApiDatum.find(params[:id]).update!(attributes)
+      @res = RailsApiDoc::ApiDatum.find(params[:id]).destroy!
     else
-      RailsApiDoc::ApiDatum.create!(attributes)
+      attributes = RailsApiDoc::Model::AttributeParser.parse_attributes(params)
+
+      @res = RailsApiDoc::ApiDatum.create!(attributes)
     end
+
+    redirect_to api_doc_path
   end
 
   def update
-    attributes = RailsApiDoc::Controller::AttributeParser.parse_attributes(permitted_params)
+    attributes = RailsApiDoc::Model::AttributeParser.parse_attributes(params)
 
     if params[:id]
-      RailsApiDoc::ApiDatum.find(params[:id]).update!(attributes)
+      @res = RailsApiDoc::ApiDatum.find(params[:id]).update!(attributes)
     else
-      RailsApiDoc::ApiDatum.create!(attributes)
+      @res = RailsApiDoc::ApiDatum.create!(attributes)
     end
-  end
-
-  private
 
-  def permitted_params
-    params.permit(:name, :type, :special, :desc)
+    redirect_to api_doc_path
   end
 
 end

data/app/helpers/rails_api_doc/application_helper.rb

@@ -1,4 +1,15 @@
 module RailsApiDoc
   module ApplicationHelper
+
+    def construct_destroy_param(row_values, init_params, nesting)
+      [
+        init_params,
+        row_values.store,
+        nesting: nesting,
+        id: row_values.param&.id,
+        name: row_values.name
+      ].reduce(&:merge)
+    end
+
   end
 end

data/app/models/rails_api_doc/api_datum.rb

@@ -3,6 +3,23 @@
 # :nodoc:
 class RailsApiDoc::ApiDatum < ActiveRecord::Base
 
+  #
+  # integer :api_type - request | response
+  #
+  # string :api_action - create | show | edit | ...
+  # string :action_type - destroy | update | create
+  # string :type - param data type
+  # string :name - param name
+  # string :special - special param data
+  # string :desc - description
+  #
+  # text :nesting - model nesting to display
+  #
+
+  self.inheritance_column = ''
+
   serialize :nesting, Array
 
+  enum api_type: [:request, :response]
+
 end

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

@@ -12,10 +12,7 @@ html lang="en"
   body.wrap
 
     h1.header
-      span.blue <
-      span Rails
-      span.blue >
-      span
-      a.yellow[style="text-decoration: none" href="http://github.com/vshaveyko/rails_api_doc"] Api Documentation
+
+      = render 'shared/title', locals: { link: "http://github.com/vshaveyko/rails_api_doc", blue_title: "Rails", yellow_title: "Api Documentation" }
 
     == yield

data/app/views/rails_api_doc/api_docs/_request_api_table.slim

@@ -2,4 +2,4 @@
 
 div[id="#{ctrl}.request" style="--row-count: #{request_headers.length}"]
 
-  = render 'shared/table', model: ctrl, rows: repo[ctrl], headers: request_headers, nesting: [], type: :request
+  = render 'shared/table', model: ctrl, rows: repo[ctrl], headers: request_headers, nesting: [], params: { api_type: :request }

data/app/views/rails_api_doc/api_docs/_response_api_table.slim

@@ -2,14 +2,15 @@
 
 div.response-table[id="#{ctrl}.response"  style="--row-count: #{response_headers.length}"]
 
-  - repo.map[ctrl][:actions].each do |action|
+  - repo[ctrl][:actions].each do |action|
     // TODO: Nest table in this div for easier jq toggling
     // add borders to this div
 
     - if route = repo.action_route(ctrl, action)
 
-      div.request-action-title = route
+      div.request-action-title
+        = render 'shared/title', locals: { blue_title: route[:method], yellow_title: route[:url]}
 
       - if rows = repo.load_template(ctrl, action)
 
-        = render 'shared/table', model: ctrl, rows: rows, headers: response_headers, nesting: [], type: :response
+        = render 'shared/table', model: ctrl, rows: rows, headers: response_headers, nesting: [], params: { api_action: action, api_type: :response }

data/app/views/shared/_param_inputs.slim

@@ -1,8 +1,7 @@
-- value = try(:value)
 - placeholder = settings[:placeholder] || ''
 
 - case settings[:fill_type]
 - when :input
-  = text_field_tag settings[:param], nil, placeholder: placeholder
+  = text_field_tag settings[:param], val, placeholder: placeholder
 - when :select
-  = select_tag settings[:param], options_for_select(settings[:values], value)
+  = select_tag settings[:param], options_for_select(settings[:values], val), include_blank: true

data/app/views/shared/_table.slim

@@ -3,22 +3,22 @@
 div.flex-table
 
   / header row
-  = form_tag(api_doc_url(nesting: nesting, api_type: type), method: :post, remote: true, class: 'flex-line row') do
+  = form_tag(api_doc_url(params.merge(nesting: nesting)), class: 'flex-line row') do
 
     - headers.each.with_index do |(header, settings), index|
       h1.flex-item
         - if index.zero?
-          span.add.ico ＋
+          span.ico ＋
           span.exit.ico ❌
           = submit_tag '✓'
 
-        = render 'shared/param_inputs', settings: settings
+        = render 'shared/param_inputs', settings: settings, val: ''
 
         span.title = header
 
   - rows.each do |row_name, row_values|
 
-    = form_tag(api_doc_url(nesting: nesting, api_type: type), method: :put, remote: true, class: 'flex-line row') do
+    = form_tag(api_doc_url(params.merge(nesting: nesting, id: row_values.param&.id)), method: :put,  class: "flex-line row #{'destroyed' if row_values.destroyed?} #{'updated' if row_values.updated?} #{'created' if row_values.created?}") do
 
       - headers.each_value.with_index do |(header_settings), index|
 
@@ -28,13 +28,15 @@ div.flex-table
 
           - if index.zero?
             span.ico ✏
+            / = submit_tag ,name: 'destroy', class: 'ico destroy'
+            = link_to '❌' , api_doc_url(construct_destroy_param(row_values, params, nesting)), method: :delete,  class: 'destroy ico'
             span.exit.ico ❌
             = submit_tag '✔'
 
-          = render 'shared/param_inputs', settings: header_settings, value: param_value
+          = render 'shared/param_inputs', settings: header_settings, val: param_value
 
           span.title = param_value
 
     - if row_values.nested?
 
-      = render 'shared/table', nesting: nesting, model: row_values[:model] || row_name, rows: row_values.nested, headers: headers, type: type
+      = render 'shared/table', nesting: nesting, model: row_values[:model] || row_name, rows: row_values.nested, headers: headers, params: params

data/app/views/shared/_title.slim

@@ -0,0 +1,8 @@
+span.blue <
+span = locals[:blue_title]
+span.blue > 
+
+- if locals[:link]
+  a.yellow[style="text-decoration: none" href="#{locals[:link]}"] = locals[:yellow_title]
+- else
+  span.yellow = locals[:yellow_title]

data/config/routes.rb

@@ -6,5 +6,5 @@
 RailsApiDoc::Engine.routes.draw do
   resource :api_doc
 
-  root to: 'api_docs#index'
+  root to: 'api_docs#show'
 end

data/lib/generators/rails_api_doc/templates/api_datum_migration.rb

@@ -2,7 +2,10 @@ class GenerateRailsApiDocumentationAttributesTable < ActiveRecord::Migration[5.0
 
   def change
     create_table :rails_api_doc_api_data do |t|
-      t.string :api_type
+      t.integer :api_type
+
+      t.string :action_type
+      t.string :api_action
       t.string :type
       t.string :name
       t.string :special

data/lib/rails_api_doc.rb

@@ -1,21 +1,33 @@
 # author: Vadim Shaveiko <@vshaveyko>
 # frozen_string_literal: true
-
 module RailsApiDoc
+  NESTED_TYPES = [:ary_object, :object, :model].freeze
+
+  STRAIGHT_TYPES = [:bool, :string, :integer, :array, :datetime, :enum].freeze
+
+  ACCEPTED_TYPES = (NESTED_TYPES + STRAIGHT_TYPES).freeze
 
   module Controller
+    _dir = 'rails_api_doc/controller/'
+
+    autoload :Repo, _dir + 'repo'
+    autoload :Param, _dir + 'param'
+    autoload :Headers, _dir + 'headers'
+
     module Response
       _dir = 'rails_api_doc/controller/response/'
 
       autoload :Factory, _dir + 'factory'
       autoload :Headers, _dir + 'headers'
       autoload :Param, _dir + 'param'
+      autoload :Repository, _dir + 'repository'
     end
 
     module Request
       _dir = 'rails_api_doc/controller/request/'
 
       autoload :DSL, _dir + 'dsl'
+      autoload :Factory, _dir + 'factory'
       autoload :Param, _dir + 'param'
       autoload :Headers, _dir + 'headers'
       autoload :Repository, _dir + 'repository'
@@ -32,17 +44,20 @@ module RailsApiDoc
   module Model
     _dir = 'rails_api_doc/model/'
 
+    autoload :AttributeMerger, _dir + 'attribute_merger'
     autoload :AttributeParser, _dir + 'attribute_parser'
   end
 
   require 'rails_api_doc/config'
   class Config
+
     _dir = 'rails_api_doc/config/'
 
     autoload :Validator, _dir + 'validator'
     autoload :ValidateEnum, _dir + 'validate_enum'
     autoload :ValidateType, _dir + 'validate_type'
     autoload :ValidateAryObject, _dir + 'validate_ary_object'
+
   end
 
   module Exception