rails_api_documentation 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fec87b98a5de0c01bc9ffe55e6dfb8e81f194fa
-  data.tar.gz: 70d0b724c9da74bf125a2ece0b6152ffc7b31072
+  metadata.gz: bdf183cc6b6c0fda395a7562bc1d114b87bb1478
+  data.tar.gz: 6dd2a3f83b5cac67029bc216d87ab76d14db884b
 SHA512:
-  metadata.gz: 08c79edab16e29c414d3cfcaaf38390b21126ca85577b9223f07273ca9a8eb8f7f754435960fbe9f15bdca0ceee08a2c56f170c7fa74495ba414844353ec6993
-  data.tar.gz: 72a5a4f71861d300fdeea60bf4825f4278fd56846b4aae6a7d883ddfd598d337991e0da4e629d3498538647c751d84e26a384043cf6d73059dc1b9e3b1d797b6
+  metadata.gz: 1394d326673eab65074575a2de2ea16801c8c8f406302f06e7197e325131a5271b38636ca5ba3afc0816a7a56f1980d0ae52287593cef52218a44207310a11fd
+  data.tar.gz: 2a8b66d882789e7d4fd81aa40b8bed53dda409c67a375d00dc0bc6cd86401cd4df5c339bb7aa505b789b64fdf7a4b01b86b6f859d7eb517d50ac8090e3dbf01c

data/Rakefile

@@ -14,21 +14,8 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
-
-
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task default: :test
+task default: :release

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

@@ -1,3 +1,6 @@
+_header_height = 0
+_side_menu = null
+
 $ ->
   $('.next-is-nested').on 'click', (e) ->
     self = $(this)
@@ -5,4 +8,41 @@ $ ->
 
   $('.request-action-title').on 'click', (e) ->
     self = $(this)
-    self.next().toggle()
+    next = self.next()
+    return unless next.hasClass('flex-table')
+    next.toggle()
+
+  $('.add-ico, .edit-ico').on 'click', (e) ->
+    self = $(this)
+    self.closest('.row').toggleClass('is-active')
+
+  _header_height = $('.aside').offset().top
+
+  _side_menu = $('#side-menu')
+
+$(document).on 'scroll', ->
+  _window = $(window)
+  _scrollTop = _window.scrollTop()
+
+  console.log _header_height
+  if _scrollTop > _header_height
+    _side_menu.addClass('fixed')
+  else
+    _side_menu.removeClass('fixed')
+
+  $("#side-menu li").removeClass('is-current')
+
+  $("#side-menu li a").each () ->
+    self = $(this)
+
+    _attached_block_id = self.attr('href')
+    # 0 is '#'
+    _attached_block = document.getElementById(_attached_block_id.substring(1))
+    jq_block = $(_attached_block)
+
+    # 5 is magic number to get block in sight on top get selected in menu
+    offset_top =  jq_block.offset().top - 5
+    offset_height = jq_block.height()
+
+    if _scrollTop > offset_top && _scrollTop < offset_top + offset_height
+      self.closest('li').addClass('is-current')

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

@@ -13,3 +13,81 @@
  *= require_tree .
  *= require_self
  */
+
+/*
+ *
+ * TOPICS:
+ * 1. icons / svgs / sprites
+ * 2. file structure
+ * 3. side menu
+ *    a) from both left and right
+ *    b) left one always on screen
+ *    c) left should reduce font size if too much content
+ *
+ */
+
+.affix {
+  position: fixed !important;
+}
+.nav > li > a {
+  display: block;
+  padding: 4px 20px;
+  font-size: 15px;
+  font-weight: 500;
+  color: #767676;
+}
+
+.nav > li > a:hover {
+  padding-left: 19px;
+  color: #563d7c;
+  text-decoration: none;
+  background-color: transparent;
+  border-left: 1px solid #563d7c;
+}
+
+.bs-docs-sidebar.affix {
+  position: fixed;
+  top: 20px;
+  padding-left: 20px;
+  margin: 0;
+}
+.nav {
+  padding-left: 0;
+}
+
+.bs-docs-sidebar .nav>.is-current:focus>a, .bs-docs-sidebar .nav>.is-current:hover>a, .bs-docs-sidebar .nav>.is-current>a {
+  padding-left: 18px;
+  font-weight: 700;
+  color: #563d7c;
+  background-color: transparent;
+  border-left: 2px solid #563d7c;
+}
+
+.nav>li>ul>.is-current>a {
+  padding-left: 28px;
+  font-weight: 500;
+}
+
+.bs-docs-sidebar .nav .nav>li>a {
+  padding-top: 1px;
+  padding-bottom: 1px;
+  padding-left: 30px;
+  font-size: 14px;
+  font-weight: 500;
+}
+
+.blue {
+  background-color: #A0A0E5;
+}
+
+.title{
+  background-color: #f5f3f3;
+}
+.table-column {
+  border: 1px solid black;
+}
+
+.nopadding {
+   padding: 0 !important;
+   margin: 0 !important;
+}

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

@@ -51,9 +51,16 @@
   // display: -ms-flexbox
   // display: -webkit-flex
   //
-
   &.row
     display: flex
+
+    &.is-active
+
+      input
+        display: inline-block
+
+      .mod-submit
+        display: inline-block
     // flex-flow: row wrap
     // justify-content: space-between
 
@@ -84,6 +91,13 @@
   .row &
     width: calc(100%/var(--row-count))
     min-height: 20px
+
+  &.mod-submit
+    display: none
+
+  input
+    display: none
+
   // Что я сделал ?? - оно почемуто заработало было flex-grow: 1
   // В статье написано что это тоже самое, а на практике - не так ?
   // flex: 1
@@ -100,6 +114,26 @@
   .column &
     width: 100%
 
+.header
+  text-align: center
+
+.content
+  display: flex
+
+.aside
+  flex: 1
+
+.main-block
+  flex: 4
+
+#side-menu
+  position: static
+
+  &.fixed
+    position: fixed
+    top: 0
+
 .request-action-title
   text-align: center
+
   background-color: lightblue

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

@@ -1,43 +1,4 @@
 - @request_headers = { enum: 'Values(if type is enum)' }
 
-div[href=(locals[:model].to_s + '.request') style="--row-count: #{@request_headers.length}"]
+div[id="#{locals[:model]}.request" style="--row-count: #{@request_headers.length}"]
   = render 'shared/table', locals: { model: locals[:model], rows: locals[:params] }
-
-/ .row
-  / = form_tag(api_doc_path, method: 'post', remote: true, class: 'form-horizontal') do
-
-/ - ([:name] + headers).each do |field_name|
-      / div.field(class="col-md-#{col_num - 1}")
-        / / Add parameter name second argument
-        / = text_field_tag field_name, nil, placeholder: field_name, class: 'form-control'
-/
-    / div.actions(class="col-md-#{col_num - 1}")
-      / = button_tag 'Add table parameter', class: 'btn btn-primary'
-/ = render 'edit_field'
-
-/ .table
-  / div.nopadding[class="col-md-#{col_num}"]
-    / = link_to new_api_doc_path, class: 'btn btn-primary btn-xs' do
-      / span.glyphicon.glyphicon-plus
-    / | Parameter
-/
-  / - headers.each do |param_header|
-    / div.nopadding[class="col-md-#{col_num}"] = param_header
-/
-/ - locals[:params].each do |param_key, param_values|
-  / .row.blue
-    / div.nopadding[class="col-md-#{col_num}" style="white-space: nowrap;"]
-      / - unless param_values.nested?
-        / = link_to edit_api_doc_path, class: 'btn btn-primary btn-xs' do
-          / span.glyphicon.glyphicon-pencil
-        / = link_to api_doc_path(param_key: param_key, nesting: locals[:nesting]), class: 'btn btn-primary btn-xs', method: :delete do
-          / span.glyphicon.glyphicon-minus
-      / | #{param_key}#{'*' if param_values.required?}
-/
-    / - if param_values.nested?
-      / .table-column[class="col-md-#{12 - col_num}"]
-        / - nested_params = locals[:nesting].to_a.push(locals[:model])
-        / = render 'request_api_table', locals: { model: param_values[:model] || param_key, params: param_values[:nested], nesting: nested_params }
-    / - else
-      / - headers.each do |param_header|
-        / .table-column[class="col-md-#{col_num}"] = param_values[param_header]

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

@@ -1,4 +1,4 @@
-div[href=(model.to_s + '.response') style="--row-count: 3"]
+div[id="#{model}.response"  style="--row-count: 3"]
   - repo.map[model][:actions].each do |action|
     // TODO: Nest table in this div for easier jq toggling
     // add borders to this div

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

@@ -1,5 +1,5 @@
-nav.bs-docs-sidebar.hidden-print.hidden-sm.hidden-xs(data-spy="affix" data-offset-top="60")
- ul.nav.bs-docs-sidenav
+nav.bs-docs-sidebar.hidden-print.hidden-sm.hidden-xs
+ ul.side-menu.nav.bs-docs-sidenav
    - locals[:models].each do |model|
     li
       a[href=('#' + model.to_s)] = model.to_s

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

@@ -1,12 +1,19 @@
-.container.bs-docs-container
-  .row
+.layout
+  .header
     = render 'title'
-  .row
-    .col-md-9[role="main"]
+  .content
+    div.aside
+      div#side-menu
+        = render 'side_menu', locals: { models: @request_repository.keys }
+
+    div.main-block
 
       - @request_repository.each do |model, params|
-        .bs-docs-section
-          h2[id=(model.to_s)] = model.to_s
+
+        div[id=(model.to_s)]
+
+          h2 = model.to_s
+
           p
             | Scopes
             |  #{model.scopes_configuration.keys.map { |key| ":#{key}"}.join(', ')}
@@ -18,6 +25,3 @@
           p
             | Response
             = render 'response_api_table', model: model, repo: @response_repository
-
-    .col-md-3[role="complementary"]
-      = render 'side_menu', locals: { models: @request_repository.keys }

data/app/views/shared/_response_table.slim

@@ -1,14 +1,30 @@
+- nesting = locals[:nesting] || []
+
 div.flex-table
-  div.flex-line.row
+
+  = form_tag(api_doc_url(nesting: nesting), method: :put, remote: true, class: 'flex-line row') do
     / Угловой елемент
-    div.flex-item Parameter
+    div.flex-item
+      // TODO: use icon with + to indicate adding
+      span.add-ico = '( + )'
+      = text_field_tag 'name', nil, placeholder: 'Enter param name'
+      span Parameter
+
     div.flex-item Value
+
+    = submit_tag 'Save', class: 'flex-item mod-submit'
+
   - locals[:rows].each do |row_name, node|
-    div.flex-line.row
-      div.flex-item  #{row_name}
+    = form_tag(api_doc_url(nesting: nesting), method: :put, remote: true, class: 'flex-line row') do
+      div.flex-item
+        span.edit-ico = '(edit)'
+        = text_field_tag 'name', row_name, placeholder: 'Enter param name'
+        span #{row_name}
       - if node.nested?
         div.flex-item.next-is-nested #{node.attr}(Nested)
       - else
         div.flex-item #{node.attr}
+      = submit_tag 'Save', class: 'flex-item mod-submit'
+
     - if node.nested?
-      = render 'shared/response_table', locals: { rows: node.nested }
+      = render 'shared/response_table', locals: { rows: node.nested, nesting: nesting + [row_name] }

data/lib/rails_api_doc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # author: Vadim Shaveiko <@vshaveyko>
 module RailsApiDoc
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_documentation
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - vs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-20 00:00:00.000000000 Z
+date: 2016-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler