apress-documentation 0.4.0

data/app/assets/stylesheets/document/document.scss

@@ -0,0 +1,19 @@
+p.normal {
+  font-weight: normal;
+}
+
+p.italic {
+  font-style: italic;
+}
+
+p.oblique {
+  font-style: oblique;
+}
+
+p.light {
+  font-weight: lighter;
+}
+
+p.bold {
+  font-weight: bold;
+}

data/app/assets/stylesheets/document/layout.scss

@@ -0,0 +1,9 @@
+@import 'variables';
+
+.content {
+  padding: 40px 40px 60px;
+  width: auto;
+  margin-left: $sidebar-width;
+  position: relative;
+  min-height: calc(100vh - 83px);
+}

data/app/assets/stylesheets/document/sidebar.scss

@@ -0,0 +1,19 @@
+@import 'variables';
+
+.sidebar {
+  width: $sidebar-width;
+  z-index: 9;
+  left: 0;
+  position: fixed;
+  top: 0;
+  height: 100%;
+  padding: $sidebar-padding;
+  background-color: $sidebar-bg;
+  border-right: 1px solid $border-accent-color;
+  box-shadow: $box-shadow-accent;
+  overflow: scroll;
+
+  & > ul li {
+    margin-left: 6%;
+  }
+}

data/app/assets/stylesheets/document/swagger.scss

@@ -0,0 +1,3 @@
+.swagger-section .swagger-ui-wrap .info {
+  display: none;
+}

data/app/assets/stylesheets/document/switch.scss

@@ -0,0 +1,46 @@
+.switch {
+  position: relative; width: 154px;
+  user-select: none;
+}
+.switch-checkbox {
+  display: none;
+}
+.switch-label {
+  display: block; overflow: hidden; cursor: pointer;
+  border: 2px solid #999; border-radius: 26px;
+}
+.switch-inner {
+  display: block; width: 200%; margin-left: -100%;
+  transition: margin .3s ease-in 0s;
+}
+.switch-inner:before,
+.switch-inner:after {
+  display: block; float: left; width: 50%; height: 19px; padding: 0; line-height: 19px;
+  font-size: 14px; color: #fff; font-family: Trebuchet, Arial, sans-serif; font-weight: bold;
+  box-sizing: border-box;
+}
+.switch-inner:before {
+  content: 'ВСЕ';
+  padding-left: 10px;
+  background-color: #34a7c1; color: #fff;
+}
+.switch-inner:after {
+  content: 'ДРУГИЕ МОДУЛИ';
+  padding-right: 10px;
+  background-color: #eee; color: #999;
+  text-align: right;
+}
+.switch-switch {
+  display: block; width: 17px; margin: 1px;
+  background: #fff;
+  position: absolute; top: 0; bottom: 0;
+  right: 134px;
+  border: 2px solid #999; border-radius: 30px;
+  transition: all .3s ease-in 0s;
+}
+.switch-checkbox:checked + .switch-label .switch-inner {
+  margin-left: 0;
+}
+.switch-checkbox:checked + .switch-label .switch-switch {
+  right: 0;
+}

data/app/assets/stylesheets/document/variables.scss

@@ -0,0 +1,26 @@
+// Base
+$body-bg: #fff;
+$font-family: 'Lato', sans-serif;
+$font-family-glyph: fontAwesome;
+$font-family-headings: 'Lato', sans-serif;
+$font-size: 15px;
+$line-height: 1.6;
+$border-accent-color: #f1f1f1;
+$box-shadow-accent: 0 0 0 2px rgba(51, 51, 51, .02);
+
+// Grid
+$screen-sm-max: 991px !default;
+
+// Heading
+$headings-font-weight: 400;
+$heading-line-heading: 1.1;
+$heading-color: #232323;
+
+// Text Colors
+$text-color: #4a4a4a;
+$link-color: #237dac;
+
+// Sidebar
+$sidebar-width: 320px;
+$sidebar-bg: #fff;
+$sidebar-padding: 35px;

data/app/assets/stylesheets/package/documentation.css

@@ -0,0 +1,9 @@
+/*
+ *= require document/variables
+ *= require document/base
+ *= require document/layout
+ *= require document/sidebar
+ *= require document/swagger
+ *= require document/document
+ *= require document/switch
+ */

data/app/assets/stylesheets/package/swagger_print.css

@@ -0,0 +1,4 @@
+/*
+ *= require swagger-ui/dist/css/reset.css
+ *= require swagger-ui/dist/css/print.css
+ */

data/app/assets/stylesheets/package/swagger_screen.css

@@ -0,0 +1,4 @@
+/*
+ *= require swagger-ui/dist/css/reset.css
+ *= require swagger-ui/dist/css/screen.css
+ */

data/app/controllers/apress/documentation/documents_controller.rb

@@ -0,0 +1,14 @@
+module Apress
+  module Documentation
+    class DocumentsController < ActionController::Base
+      include ::Apress::Documentation::PreloadDocs
+      layout 'documentation'
+
+      def show
+        @document = Apress::Documentation.fetch_document(params[:path]) if params[:path]
+      end
+
+      ActiveSupport.run_load_hooks(:'apress/documentation/documents_controller', self)
+    end
+  end
+end

data/app/controllers/apress/documentation/swagger_controller.rb

@@ -0,0 +1,22 @@
+module Apress
+  module Documentation
+    class SwaggerController < ::ActionController::Base
+      include ::Apress::Documentation::PreloadDocs
+
+      def show
+        service = Apress::Documentation::SwaggerJsonBuilder.new(params[:slug])
+        data =
+          if Rails.application.config.action_controller.perform_caching
+            key = ActiveSupport::Cache.expand_cache_key(["swagger_schema", params[:slug]])
+            Rails.cache.fetch(key) { service.call }
+          else
+            service.call
+          end
+
+        render json: data
+      end
+
+      ActiveSupport.run_load_hooks(:'apress/documentation/swagger_controller', self)
+    end
+  end
+end

data/app/controllers/apress/documentation/swagger_ui_controller.rb

@@ -0,0 +1,11 @@
+module Apress
+  module Documentation
+    class SwaggerUiController < ::ActionController::Base
+      def show
+        render 'show', layout: false
+      end
+
+      ActiveSupport.run_load_hooks(:'apress/documentation/swagger_ui_controller', self)
+    end
+  end
+end

data/app/controllers/concerns/apress/documentation/preload_docs.rb

@@ -0,0 +1,20 @@
+module Apress
+  module Documentation
+    module PreloadDocs
+      extend ActiveSupport::Concern
+
+      included do
+        if (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR == 2) || Rails::VERSION::MAJOR > 4
+          before_action :load_docs
+        else
+          before_filter :load_docs
+        end
+      end
+
+      def load_docs
+        ActiveSupport.run_load_hooks(:documentation)
+        Apress::Documentation.validate_dependencies!
+      end
+    end
+  end
+end

data/app/helpers/apress/documentation/documents_helper.rb

@@ -0,0 +1,14 @@
+module Apress
+  module Documentation
+    module DocumentsHelper
+      def document_url_with_swagger(document)
+        if document.is_a?(Apress::Documentation::Storage::SwaggerDocument)
+          js_path = "#!/#{document.tag}/#{document.operation_id}"
+          documentation_url(path: document.document.slug.to_s) + js_path
+        else
+          documentation_url(path: document.slug.to_s)
+        end
+      end
+    end
+  end
+end

data/app/presenters/apress/documentation/dependency_presenter.rb

@@ -0,0 +1,75 @@
+module Apress
+  module Documentation
+    class DependencyPresenter
+      def initialize(view, document)
+        @view = view
+        @document = document
+      end
+
+      def render_deps(reverse: false)
+        @view.render(
+          'apress/documentation/presenters/dependency_presenter/dependencies',
+          dependencies: dependencies(reverse: reverse),
+          all_dependencies: all_dependencies(reverse: reverse),
+          current_document: @document
+        )
+      end
+
+      private
+
+      # Private: определяет зависимости из других модулей для @document и его потомков
+      #
+      # Arguments:
+      #  reverse - см - Apress::Documentation::Storage::BaseStorage::dependencies
+      #
+      # Returns Array of Pairs [[doc, depend_doc], [doc_3, depend_doc]
+      def dependencies(reverse: false)
+        all_dependencies(reverse: reverse).select do |from, to|
+          from.current_module != @document.current_module ||
+          to.current_module != @document.current_module
+        end
+      end
+
+      # Private: определяет все зависимости для @document и его потомков
+      #
+      # Arguments:
+      #  reverse - см - Apress::Documentation::Storage::BaseStorage::dependencies
+      #
+      # Returns Array of Pairs [[doc, depend_doc], [doc_3, depend_doc]
+      def all_dependencies(reverse: false)
+        @dependencies ||= Hash.new do |h, key|
+          h[key] = @document.dependencies(reverse: key)
+          h[key] = child_dependencies(@document, reverse: key) if h[key].blank?
+          h[key]
+        end
+
+        @dependencies[reverse]
+      end
+
+      # Private: рекурсивно находит все зависимости среди потомков document
+      #
+      # Arguments:
+      #  document - (Document) - документ для которого ищем зависимости
+      #  reverse - см - Apress::Documentation::Storage::BaseStorage::dependencies
+      #
+      # Returns Array of Pairs [[doc, depend_doc], [doc_3, depend_doc]
+      def child_dependencies(document, reverse: false)
+        unless document.respond_to?(:documents)
+          return document.dependencies(reverse: reverse)
+        end
+
+        child_deps = document.documents.inject([]) do |deps, (_, doc)|
+          deps.concat(child_dependencies(doc, reverse: reverse))
+        end
+
+        document.swagger_documents.inject(child_deps) do |deps, (_, doc)|
+          deps.concat(doc.dependencies(reverse: reverse))
+        end
+
+        child_deps.concat(document.dependencies(reverse: reverse))
+
+        child_deps
+      end
+    end
+  end
+end

data/app/services/apress/documentation/swagger_json_builder.rb

@@ -0,0 +1,22 @@
+module Apress
+  module Documentation
+    class SwaggerJsonBuilder
+      def initialize(module_name)
+        @module_name = module_name
+      end
+
+      def call
+        classes =
+          if @module_name
+            Apress::Documentation::Swagger::Schema.swagger_classes.select do |klass|
+              klass.document_slug.to_s == @module_name.to_s || !klass.resource
+            end
+          else
+            Apress::Documentation::Swagger::Schema.swagger_classes
+          end
+
+        ::Swagger::Blocks.build_root_json(classes)
+      end
+    end
+  end
+end

data/app/views/apress/documentation/documents/_document.html.haml

@@ -0,0 +1,32 @@
+%h1
+  = document.title.to_s.html_safe || document.slug.to_s.html_safe
+
+%h3 Описание
+%p
+  = (document.description || "Нет данных").to_s.html_safe
+
+%h3 Бизнесс описание
+%p
+  = (document.business_desc || "Нет данных").to_s.html_safe
+
+%h3 Публичность
+%p
+  = (document.publicity || "Нет данных").to_s.html_safe
+
+%h3 Тесты
+%p
+  = (document.tests || "Нет данных").to_s.html_safe
+
+%h3 Зависимости
+.js-dependencies-container
+  .switch
+    %input.switch-checkbox.js-dependency-switch{type: "checkbox", id: "doc-switch"}
+    %label.switch-label{for: "doc-switch"}
+      %span.switch-inner
+      %span.switch-switch
+
+  %h4 Зависит от
+  != Apress::Documentation::DependencyPresenter.new(self, document).render_deps
+
+  %h4 Используется в
+  != Apress::Documentation::DependencyPresenter.new(self, document).render_deps(reverse: true)

data/app/views/apress/documentation/documents/_swagger.html.haml

@@ -0,0 +1,10 @@
+.swagger-section
+  .swagger-ui-wrap{id: "swagger-ui-container"}
+
+:javascript
+  app.swagger = {
+    "docsUrl": "#{docs_path(slug: document.slug)}",
+    "docsExpansion": "list"
+  };
+
+  app.extensions = #{document.swagger_documents.to_json(view: self)};

data/app/views/apress/documentation/documents/show.html.haml

@@ -0,0 +1,13 @@
+= cache ['documentation', params[:path]] do
+  - if @document
+    - if @document.swagger?
+      = render 'swagger', document: @document
+    - else
+      = render 'document', document: @document
+
+  - else
+    %h1 Документация АБАК-ПРЕСС
+    %p
+      Данный ресурс содержит все описания модулей и контрактов разработанных в АБАК-ПРЕСС.
+      Подробную информацию о устройстве системы можно найти в геме
+      %a{href: "https://github.com/abak-press/apress-documentation"}apress-documentation.

data/app/views/apress/documentation/presenters/dependency_presenter/_dependencies.html.haml

@@ -0,0 +1,21 @@
+:ruby
+  all_dependencies = local_assigns.fetch(:all_dependencies)
+  current_document = local_assigns.fetch(:current_document)
+  dependencies = local_assigns.fetch(:dependencies)
+
+.dependencies-container
+- if dependencies.present?
+  .js-dependencies
+    - dependencies.each do |contract_def, dep|
+      = render 'apress/documentation/presenters/dependency_presenter/links',
+               dependency: dep,
+               contract_def: contract_def,
+               current_document: current_document
+
+- if all_dependencies.present?
+  .js-all-dependencies.hidden
+    - all_dependencies.each do |contract_def, dep|
+      = render 'apress/documentation/presenters/dependency_presenter/links',
+               dependency: dep,
+               contract_def: contract_def,
+               current_document: current_document

data/app/views/apress/documentation/presenters/dependency_presenter/_links.html.haml

@@ -0,0 +1,17 @@
+:ruby
+  dependency = local_assigns.fetch(:dependency)
+  contract_def = local_assigns.fetch(:contract_def)
+  current_document = local_assigns.fetch(:current_document)
+  title =
+    if dependency.title
+      dependency.current_module.title.to_s + "::" + dependency.title .to_s
+    else
+      dependency.slug
+    end
+
+.link
+  = link_to title, document_url_with_swagger(dependency)
+  - if contract_def != current_document
+    = "("
+    = link_to(contract_def.title || contract_def.slug, document_url_with_swagger(contract_def))
+    = ")"

data/app/views/apress/documentation/swagger_ui/show.html.haml

@@ -0,0 +1,26 @@
+!!!
+%html
+  %head
+    = stylesheet_link_tag 'package/swagger_screen', media: :screen
+    = stylesheet_link_tag 'package/swagger_print', media: :print
+    = javascript_include_tag 'package/documentation', defer: true
+    :javascript
+      var app = {
+        "swagger": {
+          "docsUrl": "#{docs_path}"
+        }
+      }
+
+
+  %body.swagger-section
+    .header
+      .swagger-ui-wrap
+        %form{id: 'api_selector'}
+          .input
+            %input{placeholder: "http://example.com/api", id: "input_baseUrl", name: "baseUrl", type: "text"}
+          .auth_container
+          .input
+            %a.header__btn{id: "explore", href: "#"}
+              Explore
+    .swagger-ui-wrap{id: 'message-bar'}
+    .swagger-ui-wrap{id: "swagger-ui-container"}