rails_api_documentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a03ef70ed0477183acaaa7ba574df74783258e7f
+  data.tar.gz: fb710dfc8b09f833424d6f67e4991392306ad4f7
+SHA512:
+  metadata.gz: 2339ff9ff62a7b9afbc2ae4456f76ef672e20bea3a6cdb8fb65ab2757f03ea7de9d186f41c3faa16a80dc2688ea20f7365eafcc7d234639152aab50dc3414389
+  data.tar.gz: dcc0448c98eabb01d15b10b0213895af983a3f23b2efb84a1488a0f0692e7ea6571b8d2675aaa7cb9f65f426efe9b9349a838dc32066c58706a7dcbc7f9a5da9

data/README.md

@@ -0,0 +1,41 @@
+# RailsApiDoc
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_api_doc`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_api_doc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_api_doc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_api_doc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/app/assets/config/rails_api_doc_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/rails_api_doc .js
+//= link_directory ../stylesheets/rails_api_doc .css

data/app/assets/javascripts/api_doc.js

@@ -0,0 +1,5 @@
+//= require jquery
+//= require jquery_ujs
+//= require table
+//
+//

data/app/assets/javascripts/components.js

@@ -0,0 +1 @@
+//= require_tree ./components

data/app/assets/javascripts/rails_api_doc/application.js

@@ -0,0 +1,3 @@
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

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

@@ -0,0 +1,8 @@
+$ ->
+  $('.next-is-nested').on 'click', (e) ->
+    self = $(this)
+    self.closest('.row').next().toggle()
+
+  $('.request-action-title').on 'click', (e) ->
+    self = $(this)
+    self.next().toggle()

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

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,105 @@
+\:root
+  --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
+
+  & &
+    display: none
+    width: 100%
+    background: gray
+    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
+
+.flex-line
+
+  padding: 0
+  margin: auto
+  list-style: none // ??
+  border-bottom: 1px solid black
+
+  &:first-child
+    border-top: 1px solid black
+
+  background: lightgreen
+
+  // Зачем это ?
+  // display: -webkit-box
+  // display: -moz-box
+  // display: -ms-flexbox
+  // display: -webkit-flex
+  //
+
+  &.row
+    display: flex
+    // flex-flow: row wrap
+    // justify-content: space-between
+
+    // ничего не сделало
+    // flex-direction: row
+    // ничего не сделало
+    // flex-wrap: nowrap
+
+  // -webkit-flex-flow: row wrap
+
+   &.column
+     flex: 1
+     flex-flow: column wrap
+     align-content: flex-start
+     // align-items: stretch
+
+.flex-item
+  border-right: 1px solid black
+  &:first-child
+    border-left: 1px solid black
+  // border-bottom: 1px solid black
+  background: tomato
+  padding: 5px
+
+  // margin: auto
+  text-align: center
+
+  .row &
+    width: calc(100%/var(--row-count))
+    min-height: 20px
+  // Что я сделал ?? - оно почемуто заработало было 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%
+
+.request-action-title
+  text-align: center
+  background-color: lightblue

data/app/controllers/rails_api_doc/api_docs_controller.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+# :nodoc:
+class RailsApiDoc::ApiDocsController < RailsApiDoc::ApplicationController
+
+  class NewRecord < ActiveRecord::Base
+  end
+
+  def index
+    # 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::Parameter::Repository
+
+    @response_repository = RailsApiDoc::Controller::Response.repo
+  end
+
+  def create
+    attributes = RailsApiDoc::Controller::AttributeParser.parse_attributes(permitted_params)
+  end
+
+  def destroy
+    pry binding
+  end
+
+  def edit
+    @api_record = NewRecord.new
+
+    pry binding
+  end
+
+  def new
+    @api_record = NewRecord.new
+    pry binding
+  end
+
+  def update
+    pry binding
+  end
+
+  private
+
+  def permitted_params
+    params.permit!(:name, :type, :enum)
+  end
+
+end

data/app/controllers/rails_api_doc/application_controller.rb

@@ -0,0 +1,5 @@
+module RailsApiDoc
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/rails_api_doc/application_helper.rb

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

data/app/models/rails_api_doc/application_record.rb

@@ -0,0 +1,5 @@
+module RailsApiDoc
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

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

@@ -0,0 +1,20 @@
+doctype html
+html lang="en"
+  head
+    meta charset="utf-8" /
+    meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible" /
+    meta content="" name="description" /
+    meta content="width=device-width" name="viewport" /
+    title RailsApidDoc
+    == 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

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

@@ -0,0 +1,9 @@
+.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'

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

@@ -0,0 +1,43 @@
+- @request_headers = { enum: 'Values(if type is enum)' }
+
+div[href=(locals[:model].to_s + '.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

@@ -0,0 +1,7 @@
+div[href=(model.to_s + '.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
+    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 }

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

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

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

@@ -0,0 +1,4 @@
+.bs-docs-section
+  h1#grid.page-header
+    a.anchorjs-link[href="#grid" aria-label="Anchor link for: grid" data-anchorjs-icon="" style="font-family: anchorjs-icons; font-style: normal; font-variant: normal; font-weight: normal; line-height: inherit; position: absolute; margin-left: -1em; padding-right: 0.5em;"]
+    | Api documentation

data/app/views/rails_api_doc/api_docs/example.html.erb

@@ -0,0 +1,32 @@
+<table class="table table-condensed">
+  <thead class="thead-default">
+    <tr>
+      <th>#</th>
+      <th>First Name</th>
+      <th>Last Name</th>
+      <th>Username</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class="success">
+      <th scope="row">1</th>
+      <td>Mark</td>
+      <td>Otto</td>
+      <td>@mdo</td>
+    </tr>
+    <tr class="active">
+      <th scope="row">2</th>
+      <td>Jacob</td>
+      <td>Thornton</td>
+      <td>@fat</td>
+    </tr>
+    <tr>
+      <th scope="row" class="warning">3</th>
+      <td>Larry</td>
+      <td>the Bird</td>
+      <td>@twitter</td>
+    </tr>
+  </tbody>
+</table>
+
+

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

@@ -0,0 +1,23 @@
+.container.bs-docs-container
+  .row
+    = render 'title'
+  .row
+    .col-md-9[role="main"]
+
+      - @request_repository.each do |model, params|
+        .bs-docs-section
+          h2[id=(model.to_s)] = model.to_s
+          p
+            | Scopes
+            |  #{model.scopes_configuration.keys.map { |key| ":#{key}"}.join(', ')}
+
+          p
+            | Request
+            = render 'request_api_table', locals: { model: model, params: params }
+
+          p
+            | Response
+            = render 'response_api_table', model: model, repo: @response_repository
+
+    .col-md-3[role="complementary"]
+      = render 'side_menu', locals: { models: @request_repository.keys }