trifle-docs 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6297e523736ee0f3ed2f9eb0f5df85d98e6499b05922f23d220b59b8f44e8b8b
-  data.tar.gz: b5713c0bd7dc7713d0dc8c02f7fa090e1eeff12af37f7997281cd0e3258a374a
+  metadata.gz: f67c8c3989c233312fc4ded291bbe1b0b0c0370e7fe3239e24579f7808c8ea0d
+  data.tar.gz: 37d6d3f3b9de085f32c44aff933103fb08b94b811c3512837839d716ab3a141a
 SHA512:
-  metadata.gz: 5e4e3a7e5bae382a7e765930cdfcaba26d3eb59bdbb47570403f9dae854072262e76fc40551862e503ccd7316fbdd7f92154e1e05512d7ff7b23951b8f43b934
-  data.tar.gz: 394e69ad719ecb670ab63d845bd6774dc1912f59ee7f9fb914e77b85c62bd6535967ddab6a73eabad52450fbc1ea1b2b17757b21157191e6f4a218bff5463c1b
+  metadata.gz: '058e6e525500b64e34b2e2104be4fd10a0ad7d75b4533b093b5df9e16f33c526e5110b819ae910d6d0bd5dd477d998ecf4ffa8274d2bd788c33ac2bfb3ee8a85'
+  data.tar.gz: 1afb6462f932882db707f1d0b22ea909b9ca34ffe3f9e913d38cc5f41cf3e6dd72fb08d46b3be460d346361da69c7bd7087623c0d01a40bc18d8abbd1a320536

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trifle-docs (0.1.1)
+    trifle-docs (0.2.0)
       redcarpet
       rouge
       sinatra

data/lib/trifle/docs/app.rb

@@ -7,7 +7,7 @@ module Trifle
     class App < Sinatra::Base
       configure do
         set :bind, '0.0.0.0'
-        set :views, proc { Trifle::Docs.default.templates }
+        set :views, proc { Trifle::Docs.default.views }
       end
 
       get '/*' do

data/lib/trifle/docs/configuration.rb

@@ -3,17 +3,19 @@
 module Trifle
   module Docs
     class Configuration
-      attr_accessor :path, :templates
+      attr_accessor :path, :views, :layout, :namespace
 
       def initialize
         @harvesters = []
         @path = nil
+        @namespace = nil
       end
 
       def harvester
         @harvester ||= Trifle::Docs::Harvester::Walker.new(
           path: path,
-          harvesters: @harvesters
+          harvesters: @harvesters,
+          namespace: namespace
         )
       end
 

data/lib/trifle/docs/engine.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+if Object.const_defined?('Rails')
+  module Trifle
+    module Docs
+      class Engine < ::Rails::Engine
+        isolate_namespace Trifle::Docs
+
+        def self.mount(router, namespace:)
+          configuration = Configuration.new
+          configuration.namespace = namespace
+          yield(configuration)
+
+          router.mount self => "/#{namespace}", as: namespace, configuration: configuration
+        end
+
+        def self.draw
+          Trifle::Docs::Engine.routes.draw do
+            root to: 'page#show'
+            get '*url', to: 'page#show'
+          end
+        end
+      end
+
+      class PageController < ActionController::Base
+        layout :docs_layout
+
+        def configuration
+          params[:configuration] || Trifle::Docs.default
+        end
+
+        def docs_layout
+          "layouts/trifle/docs/#{configuration.layout}"
+        end
+
+        def show
+          url = [params[:url], params[:format]].compact.join('.')
+          meta = Trifle::Docs.meta(url: url, config: configuration)
+          render_file(meta: meta) and return if meta['type'] == 'file'
+
+          render_content(url: url, meta: meta)
+        end
+
+        def render_file(meta:)
+          send_file(meta['path'])
+        end
+
+        def render_content(url:, meta:)
+          render (meta['template'] || 'page'), locals: {
+            sitemap: Trifle::Docs.sitemap(config: configuration),
+            collection: Trifle::Docs.collection(url: url, config: configuration),
+            content: Trifle::Docs.content(url: url, config: configuration),
+            meta: meta,
+            url: url
+          }
+        end
+      end
+    end
+  end
+end

data/lib/trifle/docs/harvester/markdown.rb

@@ -37,7 +37,7 @@ module Trifle
 
           def meta
             @meta ||= (YAML.safe_load(data[/^---(.*?)---(\s*)/m].to_s) || {}).merge(
-              'url' => "/#{url}",
+              'url' => "/#{[namespace, url].compact.join('/')}",
               'breadcrumbs' => url.split('/'),
               'toc' => toc
             )

data/lib/trifle/docs/harvester.rb

@@ -4,11 +4,12 @@ module Trifle
   module Docs
     module Harvester
       class Walker
-        attr_reader :path, :router
+        attr_reader :path, :router, :namespace
 
         def initialize(**keywords)
           @path = keywords.fetch(:path)
           @harvesters = keywords.fetch(:harvesters)
+          @namespace = keywords.fetch(:namespace)
           @router = {}
 
           gather
@@ -19,7 +20,7 @@ module Trifle
             @harvesters.each do |harvester|
               sieve = harvester::Sieve.new(path: path, file: file)
               if sieve.match?
-                @router[sieve.to_url] = harvester::Conveyor.new(file: file, url: sieve.to_url)
+                @router[sieve.to_url] = harvester::Conveyor.new(file: file, url: sieve.to_url, namespace: namespace)
                 break
               end
             end
@@ -70,11 +71,12 @@ module Trifle
       end
 
       class Conveyor
-        attr_reader :file, :url
+        attr_reader :file, :url, :namespace
 
-        def initialize(file:, url:)
+        def initialize(file:, url:, namespace:)
           @file = file
           @url = url
+          @namespace = namespace
         end
 
         def data

data/lib/trifle/docs/version.rb

@@ -2,6 +2,6 @@
 
 module Trifle
   module Docs
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/lib/trifle/docs.rb

@@ -10,7 +10,9 @@ require_relative 'docs/operations/collection'
 require_relative 'docs/operations/meta'
 require_relative 'docs/operations/sitemap'
 require_relative 'docs/version'
-require_relative 'docs/app' # NOTE: Load app last
+# NOTE: Load app and engine last
+require_relative 'docs/app'
+require_relative 'docs/engine'
 
 module Trifle
   module Docs

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trifle-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jozef Vaclavik
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -195,6 +195,7 @@ files:
 - lib/trifle/docs.rb
 - lib/trifle/docs/app.rb
 - lib/trifle/docs/configuration.rb
+- lib/trifle/docs/engine.rb
 - lib/trifle/docs/harvester.rb
 - lib/trifle/docs/harvester/file.rb
 - lib/trifle/docs/harvester/markdown.rb