rails_api_documentation 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e7d3ec4c16b4519d33306c2bf303c712e9748f7
-  data.tar.gz: 6c71e6cfa1298def8301c076bb88bb111fe8c7d1
+  metadata.gz: 32d21488a0b91b4da968d909a9988b67cc7ea427
+  data.tar.gz: 72c1203f43307e203f499879d0739c0adf3fe237
 SHA512:
-  metadata.gz: c90cadfa96cd6a860dfa9b8d199deff6d8b5ea5346f63683921470e0d3efc6169e701b107d5a597eaab500c3edafc365b2ce893d7ba961cd773b11370ae86dc3
-  data.tar.gz: 24e4970f86060efca123e637831b9986535b0e3f73c2ce24d422eca0bdbf042863d0ecc0a0d123cde958f91d7f59f335c879a73cf4e68aba3fc06d19665ecea8
+  metadata.gz: ad3a4d03dbb76aa738e0a7cc16fe832967d9db8b8b28fc14932398229ab6837bb3defb2d50fdea137a216b25d2ee62abe8f200ab7a9026ba2110ec67a6e32943
+  data.tar.gz: fdc0c2b103f36ea0443c62399b0f027aa760fd4ec25dd6733708baecb7f3a75cbc236f4abc0804e07851a66db8ac4096b17e49eac46bcf6e88028b0ffd7ce261

data/README.md

@@ -28,6 +28,10 @@ Or install it yourself as:
 
 To display api documentation on route '/api_doc' you need to:
 
+0. config/application.rb ->
+```ruby
+  require 'rails_api_doc'
+```
 1. config/routes.rb ->
   ```ruby
     mount RailsApiDoc::Engine => '/api_doc'
@@ -55,6 +59,7 @@ To display api documentation on route '/api_doc' you need to:
 
     end
   ```
+3. go to localhost:3000/api_doc
 
 ## Strong params
 

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

@@ -6,7 +6,7 @@ _side_menu = null
 $ ->
   $('.next-is-nested').on 'click', (e) ->
     self = $(this)
-    self.closest('.row').next().toggle()
+    self.closest('.row').next().toggleClass('is-shown')
 
   $('.request-action-title').on 'click', (e) ->
     self = $(this)
@@ -14,11 +14,16 @@ $ ->
     return unless next.hasClass('flex-table')
     next.toggle()
 
-  $('.add-ico, .edit-ico').on 'click', (e) ->
+  $('.flex-table input, .flex-table select').on 'click', (e) ->
+    e.stopPropagation()
+
+  $('.ico').on 'click', (e) ->
     self = $(this)
+    e.preventDefault()
+    e.stopPropagation()
     self.closest('.row').toggleClass('is-active')
 
-  _header_height = $('.aside').offset().top
+  # _header_height = $('.aside').offset().top
 
   _window = $(window)
 

data/app/assets/stylesheets/rails_api_doc/application.css

@@ -25,3 +25,4 @@
  *    c) left should reduce font size if too much content
  *
  */
+

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

@@ -0,0 +1,31 @@
+@charset "UTF-8"
+@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
+
+h1.header
+  font-size: 3em
+  font-weight: 300
+  line-height: 1em
+  text-align: center
+  color: #4DC3FA
+
+.blue
+  color: #185875
+
+.yellow
+  color: #FFF842
+
+.content
+  display: flex
+
+  nav
+    flex: 1
+
+  .tables
+    flex: 5

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

@@ -1,30 +1,19 @@
-.side-menu
+ul
   list-style-type: none
   padding: 0
-  font-size: 15px
 
-  li
-    margin-bottom: 3px
+.side-menu
 
-    span
-      margin: 0 2px
+  // position: static
 
-    a
-      display: inline-block
-      padding: 0
-      font-size: 15px
-      font-weight: 500
-      color: #767676
-      text-decoration: none
+  &.fixed
+    position: fixed
+    top: 0
 
-      &:hover
-        color: #563d7c
-        text-decoration: underline
-        background-color: transparent
+  a
+    text-decoration: none
+    border-bottom: 1px solid transparent
+    transition: border-color ease-in-out 0.3s
 
-    &.is-current
-      padding-left: 18px
-      font-weight: 700
-      color: #563d7c
-      background-color: transparent
-      border-left: 2px solid #563d7c
+    &:hover
+      border-color: yellow

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

@@ -2,36 +2,65 @@
   --row-count: 5
 
 .flex-table
-  // display: inline-flex
-  // justify-content: center
-  // width: 80%
-  // margin: 0 auto
-  // display: inline-block
-  padding: 5px
-  box-sizing: border-box
-  background: lightblue
-
-  // border: 1px solid black
+  overflow: hidden
+  width: 100%
+  margin: 0
+  display: table
+  padding: 0 0 0 0
 
   & &
-    display: none
+    visibility: hidden
+    position: absolute
+    opacity: 0
+
     width: 100%
-    background: gray
+    background: #185875
     padding: 20px
     box-sizing: border-box
 
     & .flex-table
       padding-right: 0
 
-//
-  // &.flex-table
-    // width: 100%
-    // background: gray
-    // padding: 20px
-    // box-sizing: border-box
-//
-    // &.flex-table
-      // padding-right: 0
+    &.is-shown
+      opacity: 1
+      position: relative
+      visibility: visible
+      transition: visibility 0s, opacity 0.5s linear
+
+  .row
+    font-weight: normal
+    font-size: 0.9em
+    -webkit-box-shadow: 0 2px 2px -2px #0E1119
+    -moz-box-shadow: 0 2px 2px -2px #0E1119
+    box-shadow: 0 2px 2px -2px #0E1119
+
+  input, select, [type="submit"], .exit
+    display: none
+
+  // input, select
+    font-weight: 600
+    color: #fff
+    background-color: black
+    border: 1px solid rgba(0,0,0,0.3)
+    border-radius: 4px
+    box-shadow: inset 0 -5px 45px
+
+
+  .ico
+    cursor: pointer
+    font-size: 20px
+    padding: 1% 2%
+    position: absolute
+    left: 2%
+
+    &:hover
+      background-color: #FFF842
+      color: #403E10
+
+      transition-delay: 0s
+      transition-duration: 0.4s
+      transition-property: all
+      transition-timing-function: line
 
 .flex-line
 
@@ -41,51 +70,49 @@
   border-bottom: 1px solid black
 
   &:first-child
-    border-top: 1px solid black
+    color: #FB667A
 
   background: lightgreen
 
-  // Зачем это ?
-  // display: -webkit-box
-  // display: -moz-box
-  // display: -ms-flexbox
-  // display: -webkit-flex
-  //
   &.row
     display: flex
 
-    &.is-active
+    &:hover
+      background-color: #464A52
 
-      input
-        display: inline-block
+    h1
+      margin: 0
+      text-align: center
+      font-weight: bold
+      background-color: #1F2739
+      font-size: 1em
 
-      .mod-submit
-        display: inline-block
-    // flex-flow: row wrap
-    // justify-content: space-between
+    &:nth-child(odd)
+      background-color: #323C50
 
-    // ничего не сделало
-    // flex-direction: row
-    // ничего не сделало
-    // flex-wrap: nowrap
+    &:nth-child(even)
+      background-color: #2C3446
 
-  // -webkit-flex-flow: row wrap
+    &.is-active
+
+      input, select, [type="submit"], .exit
+        display: inline-block
+
+      .title, .ico:not(.exit)
+        display: none
 
-   &.column
-     flex: 1
-     flex-flow: column wrap
-     align-content: flex-start
-     // align-items: stretch
+    &.column
+      flex: 1
+      flex-flow: column wrap
+      align-content: flex-start
 
 .flex-item
-  border-right: 1px solid black
-  &:first-child
-    border-left: 1px solid black
-  // border-bottom: 1px solid black
-  background: tomato
-  padding: 5px
+  padding-bottom: 1%
+  padding-top: 1%
+  position: relative
+  padding-left: 2%
 
-  // margin: auto
+  border-right: 2px solid #1F2739
   text-align: center
 
   .row &
@@ -95,45 +122,38 @@
   &.mod-submit
     display: none
 
-  input
-    display: none
-
-  // Что я сделал ?? - оно почемуто заработало было flex-grow: 1
-  // В статье написано что это тоже самое, а на практике - не так ?
-  // flex: 1
-  // TODO: need function that will count % from num childs?
-  // магические отступы ))
-  // width: 23%
-
-  // line-height: 150px
-  // color: white
-  // font-weight: bold
-  // font-size: 3em
-  // text-align: center
-
   .column &
     width: 100%
 
-.header
-  text-align: center
+div.flex-item
 
-.content
-  display: flex
+  &:hover
+    background-color: #FFF842
+    color: #403E10
 
-.aside
-  flex: 1
+    transition-delay: 0s
+    transition-duration: 0.4s
+    transition-property: all
+    transition-timing-function: line
 
-.main-block
-  flex: 4
+  &.next-is-nested
+    cursor: pointer
+    &:hover
+      box-shadow: #7F7C21 -1px 1px, #7F7C21 -2px 2px, #7F7C21 -3px 3px, #7F7C21 -4px 4px, #7F7C21 -5px 5px, #7F7C21 -6px 6px
+      transform: translate3d(6px, -6px, 0)
 
-#side-menu
-  position: static
+.response-table
 
-  &.fixed
-    position: fixed
-    top: 0
+  .request-action-title
+    text-align: center
 
-.request-action-title
-  text-align: center
+    &:nth-child(odd)
+      background-color: #323C50
+
+    &:nth-child(even)
+      background-color: #2C3446
 
-  background-color: lightblue
+p.title
+  text-align: center
+  color: #4DC3FA
+  font-weight: 500

data/app/controllers/rails_api_doc/api_docs_controller.rb

@@ -10,42 +10,43 @@ class RailsApiDoc::ApiDocsController < RailsApiDoc::ApplicationController
     # preload controllers for parameters to apply
     Dir.glob("#{Rails.root}/app/controllers/**/*.rb").each { |file| require_dependency file }
 
-    @static_data = {
-      types: RailsApiDoc::Controller::Parameter::Repository::Param::ACCEPTED_TYPES.map(&:to_s)
-    }
+    @request_repository = RailsApiDoc::Controller::Request::Repository
 
-    @request_repository = RailsApiDoc::Controller::Parameter::Repository
+    @registered_controllers = @request_repository.registered_controllers
 
-    @response_repository = RailsApiDoc::Controller::Response.repo
+    @response_repository = RailsApiDoc::Controller::Response::Factory.repo
   end
 
   def create
     attributes = RailsApiDoc::Controller::AttributeParser.parse_attributes(permitted_params)
-  end
 
-  def destroy
-    pry binding
+    RailsApiDoc::ApiDatum.create!(attributes)
   end
 
-  def edit
-    @api_record = NewRecord.new
-
-    pry binding
-  end
+  def destroy
+    attributes = RailsApiDoc::Controller::AttributeParser.parse_attributes(permitted_params)
 
-  def new
-    @api_record = NewRecord.new
-    pry binding
+    if params[:id]
+      RailsApiDoc::ApiDatum.find(params[:id]).update!(attributes)
+    else
+      RailsApiDoc::ApiDatum.create!(attributes)
+    end
   end
 
   def update
-    pry binding
+    attributes = RailsApiDoc::Controller::AttributeParser.parse_attributes(permitted_params)
+
+    if params[:id]
+      RailsApiDoc::ApiDatum.find(params[:id]).update!(attributes)
+    else
+      RailsApiDoc::ApiDatum.create!(attributes)
+    end
   end
 
   private
 
   def permitted_params
-    params.permit!(:name, :type, :enum)
+    params.permit(:name, :type, :special, :desc)
   end
 
 end

data/app/models/rails_api_doc/api_datum.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+# :nodoc:
+class RailsApiDoc::ApiDatum < ActiveRecord::Base
+
+  serialize :nesting, Array
+
+end

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

@@ -9,12 +9,13 @@ html lang="en"
     == stylesheet_link_tag "rails_api_doc/application", :media => "all"
     == javascript_include_tag "api_doc"
     == csrf_meta_tags
-  body
-    #main.container
-      == yield
-    footer#footer
-      .container
-        p
-          | Powered by
-          a href="http://github.com/vshaveyko/rails_api_doc" RailsApiDoc
-          == RailsApiDoc::VERSION
+  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
+
+    == yield

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

@@ -1,4 +1,5 @@
-- @request_headers = { enum: 'Values(if type is enum)' }
+- request_headers = repo.headers
 
-div[id="#{locals[:model]}.request" style="--row-count: #{@request_headers.length}"]
-  = render 'shared/table', locals: { model: locals[:model], rows: locals[:params] }
+div[id="#{ctrl}.request" style="--row-count: #{request_headers.length}"]
+
+  = render 'shared/table', model: ctrl, rows: repo[ctrl], headers: request_headers, nesting: [], type: :request

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

@@ -1,8 +1,15 @@
-div[id="#{model}.response"  style="--row-count: 3"]
-  - repo.map[model][:actions].each do |action|
+- response_headers = repo.headers
+
+div.response-table[id="#{ctrl}.response"  style="--row-count: #{response_headers.length}"]
+
+  - repo.map[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(model, action)
-      div.request-action-title #{repo.action_route(model, action)}
-      - if data = repo.load_template(model, action)
-        = render 'shared/response_table', locals: { model: model, rows: data }
+
+    - if route = repo.action_route(ctrl, action)
+
+      div.request-action-title = route
+
+      - if rows = repo.load_template(ctrl, action)
+
+        = render 'shared/table', model: ctrl, rows: rows, headers: response_headers, nesting: [], type: :response

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

@@ -1,27 +1,22 @@
-.layout
-  .header
-    = render 'title'
-  .content
-    div.aside
-      div#side-menu
-        = render 'side_menu', locals: { models: @request_repository.keys }
+div.content
+  = render 'shared/side_menu', ctrls: @registered_controllers
 
-    div.main-block
+  div.tables
 
-      - @request_repository.each do |model, params|
+    - @registered_controllers.each do |ctrl|
 
-        div[id=(model.to_s)]
+      div[id=(ctrl.to_s)]
 
-          h2 = model.to_s
+        h2 = ctrl.to_s
 
-          p
-            | Scopes
-            |  #{model.scopes_configuration.keys.map { |key| ":#{key}"}.join(', ')}
+        p.title
+          | Scopes
+          |  #{ctrl.scopes_configuration.keys.map { |key| ":#{key}"}.join(', ')}
 
-          p
-            | Request
-            = render 'request_api_table', locals: { model: model, params: params }
+        p.title
+          | Request
+          = render 'request_api_table', ctrl: ctrl, repo: @request_repository
 
-          p
-            | Response
-            = render 'response_api_table', model: model, repo: @response_repository
+        p.title
+          | Response
+          = render 'response_api_table', ctrl: ctrl, repo: @response_repository

data/app/views/shared/_param_inputs.slim

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

data/app/views/shared/_side_menu.slim

@@ -0,0 +1,9 @@
+nav.bs-docs-sidebar.hidden-print.hidden-sm.hidden-xs
+ ul.side-menu.nav.bs-docs-sidenav
+   - ctrls.each do |ctrl|
+    li.yellow
+      a.yellow[href=('#' + ctrl.to_s)] = ctrl.to_s
+      span = '('
+      a.yellow[href=('#' + ctrl.to_s + '.request')] req,
+      a.yellow[href=('#' + ctrl.to_s + '.response')] resp
+      span = ')'

data/app/views/shared/_table.slim

@@ -1,20 +1,40 @@
-- nesting = locals[:nesting].to_a.push(locals[:model])
+- nesting = nesting + [model] # do not mutate nesting value
 
 div.flex-table
-  div.flex-line.row
-    / Угловой елемент
-    div.flex-item Parameter
-    div.flex-item Type
-    - @request_headers.each_value do |header|
-      div.flex-item = header
-  - locals[:rows].each do |row_name, row_values|
-    div.flex-line.row
-      div.flex-item  #{row_name} #{'*' if row_values.required?}
-      - if row_values.nested?
-        div.flex-item.next-is-nested #{row_values[:model]}(Nested)
-      - else
-        div.flex-item #{row_values[:type]}
-      - @request_headers.each_key do |header_alias|
-        div.flex-item = row_values[header_alias]
+
+  / header row
+  = form_tag(api_doc_url(nesting: nesting, api_type: type), method: :post, remote: true, class: 'flex-line row') do
+
+    - headers.each.with_index do |(header, settings), index|
+      h1.flex-item
+        - if index.zero?
+          span.add.ico ＋
+          span.exit.ico ❌
+          = submit_tag '✓'
+
+        = render 'shared/param_inputs', settings: settings
+
+        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
+
+      - headers.each_value.with_index do |(header_settings), index|
+
+        - param_value = header_settings[:value].call(row_name, row_values)
+
+        div.flex-item[class="#{'next-is-nested' if row_values.nested?}"]
+
+          - if index.zero?
+            span.ico ✏
+            span.exit.ico ❌
+            = submit_tag '✔'
+
+          = render 'shared/param_inputs', settings: header_settings, value: param_value
+
+          span.title = param_value
+
     - if row_values.nested?
-      = render 'shared/table', locals: { nesting: nesting, model: row_values[:model] || row_name, rows: row_values[:nested] }
+
+      = render 'shared/table', nesting: nesting, model: row_values[:model] || row_name, rows: row_values.nested, headers: headers, type: type

data/lib/generators/rails_api_doc/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module RailsApiDoc
+  class InstallGenerator < ::Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc "add the migrations"
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def copy_migrations
+      filename = 'generate_rails_api_documentation_attributes_table'
+      if self.class.migration_exists?('db/migrate', "#{filename}")
+        say_status('skipped', "Migration #{filename}.rb already exists")
+      else
+        migration_template "api_datum_migration.rb", "db/migrate/#{filename}.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+class GenerateRailsApiDocumentationAttributesTable < ActiveRecord::Migration[5.0]
+
+  def change
+    create_table :rails_api_doc_api_data do |t|
+      t.string :api_type
+      t.string :type
+      t.string :name
+      t.string :special
+      t.string :desc
+
+      t.text :nesting
+    end
+  end
+
+end