apress-documentation 0.4.0

data/spec/helpers/apress/documentation/documents_helper_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe Apress::Documentation::DocumentsHelper, type: :helper do
+  include Rails.application.routes.url_helpers
+
+  describe '#document_url_with_swagger' do
+    let(:document) { Apress::Documentation::Storage::Document.new('test') }
+    let(:swagger_document) { Apress::Documentation::Storage::SwaggerDocument.new(document, 'test') }
+    it 'returns url for document' do
+      expect(helper.document_url_with_swagger(document)).to match('/documentation/test')
+    end
+
+    it 'returns url for swagger document' do
+      expect(helper.document_url_with_swagger(swagger_document)).to match('/documentation/test#!/test/')
+    end
+  end
+end

data/spec/internal/app/docs/swagger/root.rb

@@ -0,0 +1,7 @@
+class StubRoot < ::Apress::Documentation::Swagger::Schema
+  swagger_root do
+    key :swagger, '2.0'
+    key :basePath, '/api/v1'
+    key :produces, ['application/json']
+  end
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,7 @@
+test:
+  adapter: sqlite3
+  encoding: utf8
+  pool: 5
+  timeout: 5000
+  database: ":memory:"
+  verbosity: quiet

data/spec/internal/config/environments/test.rb

@@ -0,0 +1 @@
+require File.expand_path('../../../config/hosts', __FILE__)

data/spec/internal/config/hosts.rb

@@ -0,0 +1 @@
+HOST = 'test.host'.freeze

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  default_url_options host: HOST
+end

data/spec/internal/lib/stub_docs/module.rb

@@ -0,0 +1,3 @@
+Apress::Documentation.build(:test_load_module) do
+  description 'Cool module'
+end

data/spec/internal/lib/stub_docs/module/document/child_document.rb

@@ -0,0 +1,7 @@
+Apress::Documentation.build(:test_load_module) do
+  document :document do
+    document :child do
+      description 'Cool document'
+    end
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/presenters/apress/documentation/dependency_presenter_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+RSpec.describe Apress::Documentation::DependencyPresenter, type: :presenter do
+  let(:view) { ActionView::Base.new }
+  before do
+    Apress::Documentation.build(:module) do
+      document(:document) do
+        depends_on('module/other_document')
+      end
+
+      document(:other_document)
+    end
+
+    Apress::Documentation.build(:other_module) do
+      document(:document) do
+        depends_on('module/document')
+      end
+    end
+  end
+
+  let(:document) { Apress::Documentation.fetch_document('module/document') }
+  let(:other_document) { Apress::Documentation.fetch_document('module/other_document') }
+  let(:other_module_document) { Apress::Documentation.fetch_document('other_module/document') }
+  let(:presenter) { described_class.new(view, current_document) }
+
+  describe '#render_deps' do
+    context 'when dependencies' do
+      let(:current_document) { document }
+      it 'calls proper render' do
+        expect(view).to receive(:render).with(
+          "apress/documentation/presenters/dependency_presenter/dependencies",
+          dependencies: [],
+          all_dependencies: [[document, other_document]],
+          current_document: current_document
+        )
+
+        presenter.render_deps
+      end
+    end
+
+    context 'when consumers' do
+      let(:current_document) { document }
+      it 'calls proper render' do
+        expect(view).to receive(:render).with(
+          "apress/documentation/presenters/dependency_presenter/dependencies",
+          all_dependencies: [[document, other_module_document]],
+          dependencies: [[document, other_module_document]],
+          current_document: current_document
+        )
+
+        presenter.render_deps(reverse: true)
+      end
+    end
+
+    context 'for module document' do
+      before do
+        Apress::Documentation.build(:module) do
+          document(:doc) do
+            depends_on('module/doc2')
+          end
+
+          document(:doc2)
+
+          document(:doc) do
+            document(:doc3) do
+              depends_on('module/doc4')
+            end
+          end
+
+          document(:doc4) do
+            depends_on 'module_2/form'
+          end
+        end
+
+        Apress::Documentation.build(:module_2) do
+          document(:form)
+        end
+      end
+
+      let(:current_document) { Apress::Documentation.fetch_document('module') }
+      it 'calls proper render' do
+        doc = Apress::Documentation.fetch_document('module/doc')
+        doc2 = Apress::Documentation.fetch_document('module/doc2')
+        doc3 = Apress::Documentation.fetch_document('module/doc/doc3')
+        doc4 = Apress::Documentation.fetch_document('module/doc4')
+        form = Apress::Documentation.fetch_document('module_2/form')
+        expect(view).to receive(:render).with(
+          "apress/documentation/presenters/dependency_presenter/dependencies",
+          all_dependencies: [[document, other_document], [doc3, doc4], [doc, doc2], [doc4, form]],
+          dependencies: [[doc4, form]],
+          current_document: current_document
+        )
+
+        presenter.render_deps
+      end
+    end
+
+    context 'for swagger' do
+      before do
+        Apress::Documentation.build(:module_3) do
+          document(:doc) do
+            depends_on('module_4/doc1/docs_docIndex')
+          end
+        end
+
+        Apress::Documentation.build(:module_4) do
+          document(:doc1) do
+            title 'cool document'
+
+            swagger_bind do
+              business_desc 'cool document 2'
+
+              swagger_path('api/docs') do
+                operation :get do
+                  key :operationId, 'docIndex'
+                  key :tags, ['docs']
+                end
+              end
+            end
+          end
+        end
+      end
+
+      let(:current_document) { Apress::Documentation.fetch_document('module_3') }
+      it 'calls proper render' do
+        doc = Apress::Documentation.fetch_document('module_3/doc')
+        swagger_document = Apress::Documentation.fetch_document('module_4/doc1/docs_docIndex')
+        expect(view).to receive(:render).with(
+          "apress/documentation/presenters/dependency_presenter/dependencies",
+          all_dependencies: [[doc, swagger_document]],
+          dependencies: [[doc, swagger_document]],
+          current_document: current_document
+        )
+
+        presenter.render_deps
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+
+require 'simplecov'
+SimpleCov.start 'rails' do
+  add_filter 'app/docs'
+  add_filter 'apress/documentation/version'
+  minimum_coverage 95
+end
+
+require 'apress/documentation'
+
+require 'pry'
+require 'sqlite3'
+
+require 'combustion'
+Combustion.initialize! :action_controller do
+  config.cache_store = :memory_store
+  config.eager_load = true
+end
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Apress::Documentation.reset!
+  end
+end

metadata

@@ -0,0 +1,335 @@
+--- !ruby/object:Gem::Specification
+name: apress-documentation
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Korobicyn Denis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: haml-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: swagger-blocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rgl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: apress-documentation
+email:
+- deniskorobitcin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".drone.yml"
+- ".gitignore"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- app/assets/javascripts/package/documentation.js
+- app/assets/javascripts/shared/dependency_switcher.js
+- app/assets/javascripts/swagger_binder.js
+- app/assets/javascripts/swagger_ui.js
+- app/assets/javascripts/templates/document.hamlbars
+- app/assets/stylesheets/document/base.scss
+- app/assets/stylesheets/document/document.scss
+- app/assets/stylesheets/document/layout.scss
+- app/assets/stylesheets/document/sidebar.scss
+- app/assets/stylesheets/document/swagger.scss
+- app/assets/stylesheets/document/switch.scss
+- app/assets/stylesheets/document/variables.scss
+- app/assets/stylesheets/package/documentation.css
+- app/assets/stylesheets/package/swagger_print.css
+- app/assets/stylesheets/package/swagger_screen.css
+- app/controllers/apress/documentation/documents_controller.rb
+- app/controllers/apress/documentation/swagger_controller.rb
+- app/controllers/apress/documentation/swagger_ui_controller.rb
+- app/controllers/concerns/apress/documentation/preload_docs.rb
+- app/helpers/apress/documentation/documents_helper.rb
+- app/presenters/apress/documentation/dependency_presenter.rb
+- app/services/apress/documentation/swagger_json_builder.rb
+- app/views/apress/documentation/documents/_document.html.haml
+- app/views/apress/documentation/documents/_swagger.html.haml
+- app/views/apress/documentation/documents/show.html.haml
+- app/views/apress/documentation/presenters/dependency_presenter/_dependencies.html.haml
+- app/views/apress/documentation/presenters/dependency_presenter/_links.html.haml
+- app/views/apress/documentation/swagger_ui/show.html.haml
+- app/views/layouts/apress/documentation/_menu.html.haml
+- app/views/layouts/apress/documentation/_menu_item.html.haml
+- app/views/layouts/apress/documentation/_sidebar.html.haml
+- app/views/layouts/documentation.html.haml
+- apress-documentation.gemspec
+- config/routes.rb
+- dip.yml
+- docker-compose.development.yml
+- docker-compose.drone.yml
+- docker-compose.yml
+- lib/apress/documentation.rb
+- lib/apress/documentation/dsl/compilers/base_compiler.rb
+- lib/apress/documentation/dsl/compilers/document_compiler.rb
+- lib/apress/documentation/dsl/compilers/mixins/dependable.rb
+- lib/apress/documentation/dsl/compilers/mixins/publicity.rb
+- lib/apress/documentation/dsl/compilers/swagger_compiler.rb
+- lib/apress/documentation/dsl/document.rb
+- lib/apress/documentation/dsl/modules.rb
+- lib/apress/documentation/dsl/swagger_document.rb
+- lib/apress/documentation/dsl/utils/swagger_bind_point_extractor.rb
+- lib/apress/documentation/engine.rb
+- lib/apress/documentation/extensions/rgl/adjacency.rb
+- lib/apress/documentation/storage/base_storage.rb
+- lib/apress/documentation/storage/dependency_graph.rb
+- lib/apress/documentation/storage/document.rb
+- lib/apress/documentation/storage/modules.rb
+- lib/apress/documentation/storage/swagger_document.rb
+- lib/apress/documentation/swagger/schema.rb
+- lib/apress/documentation/version.rb
+- spec/app/controllers/documents_controller_spec.rb
+- spec/app/controllers/swagger_controller_spec.rb
+- spec/app/controllers/swagger_ui_controller_spec.rb
+- spec/app/services/swagger_json_builder_spec.rb
+- spec/apress/documentation_spec.rb
+- spec/helpers/apress/documentation/documents_helper_spec.rb
+- spec/internal/app/docs/swagger/root.rb
+- spec/internal/config/database.yml
+- spec/internal/config/environments/test.rb
+- spec/internal/config/hosts.rb
+- spec/internal/config/routes.rb
+- spec/internal/lib/stub_docs/module.rb
+- spec/internal/lib/stub_docs/module/document/child_document.rb
+- spec/internal/log/.gitignore
+- spec/presenters/apress/documentation/dependency_presenter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/abak-press/apress-documentation
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: apress-documentation
+test_files:
+- spec/app/controllers/documents_controller_spec.rb
+- spec/app/controllers/swagger_controller_spec.rb
+- spec/app/controllers/swagger_ui_controller_spec.rb
+- spec/app/services/swagger_json_builder_spec.rb
+- spec/apress/documentation_spec.rb
+- spec/helpers/apress/documentation/documents_helper_spec.rb
+- spec/internal/app/docs/swagger/root.rb
+- spec/internal/config/database.yml
+- spec/internal/config/environments/test.rb
+- spec/internal/config/hosts.rb
+- spec/internal/config/routes.rb
+- spec/internal/lib/stub_docs/module.rb
+- spec/internal/lib/stub_docs/module/document/child_document.rb
+- spec/internal/log/.gitignore
+- spec/presenters/apress/documentation/dependency_presenter_spec.rb
+- spec/spec_helper.rb