trifle-docs 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6297e523736ee0f3ed2f9eb0f5df85d98e6499b05922f23d220b59b8f44e8b8b
-  data.tar.gz: b5713c0bd7dc7713d0dc8c02f7fa090e1eeff12af37f7997281cd0e3258a374a
+  metadata.gz: 539c91d9c90586bfa38c2b7d89bbdf4dbbfde706c8f1ac306eb57aea550d3794
+  data.tar.gz: 784e68bf02e62481f5269bd6e6ed10f2c2bfc41857346466d6a117ee5f9a0f09
 SHA512:
-  metadata.gz: 5e4e3a7e5bae382a7e765930cdfcaba26d3eb59bdbb47570403f9dae854072262e76fc40551862e503ccd7316fbdd7f92154e1e05512d7ff7b23951b8f43b934
-  data.tar.gz: 394e69ad719ecb670ab63d845bd6774dc1912f59ee7f9fb914e77b85c62bd6535967ddab6a73eabad52450fbc1ea1b2b17757b21157191e6f4a218bff5463c1b
+  metadata.gz: e2f827a9b25d6ef96a89c6e1cb73c7e20da8e3ab7d318be7ea3c89f78a4116ac90650b3628c268957fd4042f824418d3f53f150b1c886c851afab35b538b9461
+  data.tar.gz: ad2b341f5e35061ee9c7e78775135610a3bf4067594fcfa26ca9df604c77b27d093d0eef78d02208679b41810a26083562a43e88d73cd1145364c4b3a3cc31c4

data/.rubocop.yml

@@ -10,6 +10,7 @@ AllCops:
     - 'spec/**/*'
     - 'Gemfile'
     - trifle-docs.gemspec
+    - website/**/*
 
 Style/Documentation:
   Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1.0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trifle-docs (0.1.1)
+    trifle-docs (0.3.0)
       redcarpet
       rouge
       sinatra
@@ -13,7 +13,7 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     diff-lcs (1.5.0)
-    mustermann (1.1.1)
+    mustermann (2.0.2)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.5.8)
     parallel (1.22.1)
@@ -21,15 +21,15 @@ GEM
       ast (~> 2.4.1)
     puma (5.6.4)
       nio4r (~> 2.0)
-    rack (2.2.3.1)
-    rack-protection (2.2.0)
+    rack (2.2.4)
+    rack-protection (2.2.2)
       rack
     rainbow (3.1.1)
     rake (13.0.6)
     redcarpet (3.5.1)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rouge (3.29.0)
+    rouge (4.0.0)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -56,16 +56,17 @@ GEM
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    sinatra (2.2.0)
-      mustermann (~> 1.0)
+    sinatra (2.2.2)
+      mustermann (~> 2.0)
       rack (~> 2.2)
-      rack-protection (= 2.2.0)
+      rack-protection (= 2.2.2)
       tilt (~> 2.0)
-    tilt (2.0.10)
+    tilt (2.0.11)
     unicode-display_width (2.1.0)
     yaml (0.2.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -10,6 +10,11 @@ Integrate your documentation or blog into your existing Rails application. `Trif
 
 ![Demo App](demo.gif)
 
+
+## Documentation
+
+You can find guides and documentation at https://trifle.io/trifle-docs
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -26,9 +31,7 @@ $ gem install trifle-docs
 
 ## Usage
 
-You can use this as a build-in Sinatra app or mount it in your Rails app.
-
-Sinatra configuration requires simple integration in your ruby file.
+You can use this as a build-in Sinatra app or mount it in your Rails app. For each usecse, refere to documentation. Below is sample Sinatra integration.
 
 ```ruby
 # app.rb
@@ -44,37 +47,6 @@ end
 Trifle::Docs.App.run!
 ```
 
-Rails configuration requires initializer and routes configuration.
-
-```ruby
-# config/initializers/trifle.rb
-Trifle::Docs.configure do |config|
-  config.path = File.join(Rails.root, 'docs')
-  config.templates = File.join(Rails.root, 'app', 'views', 'trifle', 'docs')
-  config.register_harvester(Trifle::Docs::Harvester::Markdown)
-  config.register_harvester(Trifle::Docs::Harvester::File)
-end
-
-# config/routes.rb
-MyRailsApp::Application.routes.draw do
-  # ...
-  mount Trifle::Docs::App.new => '/docs'
-  # ...
-end
-```
-
-Or use individual configuration per mount.
-
-```ruby
-# config/routes.rb
-MyRailsApp::Application.routes.draw do
-  # ...
-  mount Trifle::Docs::App.new => '/docs'
-  mount Trifle::Docs::App.new => '/blog'
-  # ...
-end
-```
-
 ### Templates
 
 Please create two files in folder you provided the configuration.
@@ -96,6 +68,7 @@ Please create two files in folder you provided the configuration.
 ```
 
 ### Template variables
+
 There are several variables available in your template file (except `layout.erb`).
 - `sitemap` - complete sitemap tree of the folder.
 - `collection` - current subtree of the folder (useful for rendering child content, aka collection).

data/lib/trifle/docs/app.rb

@@ -7,12 +7,14 @@ 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
         url = params['splat'].first.chomp('/')
         meta = Trifle::Docs.meta(url: url)
+        halt(404, 'Not Found') if meta.nil?
+
         if meta['type'] == 'file'
           send_file meta['path']
         else

data/lib/trifle/docs/configuration.rb

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

data/lib/trifle/docs/engine.rb

@@ -0,0 +1,65 @@
+# 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_not_found and return if meta.nil?
+          render_file(meta: meta) and return if meta['type'] == 'file'
+
+          render_content(url: url, meta: meta)
+        end
+
+        def render_not_found
+          render text: 'Not Found', status: 404
+        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/file.rb

@@ -22,7 +22,8 @@ module Trifle
           def meta
             {
               'path' => file,
-              'type' => 'file'
+              'type' => 'file',
+              'updated_at' => ::File.stat(file).mtime
             }
           end
         end

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

@@ -27,6 +27,8 @@ module Trifle
 
         class Conveyor < Harvester::Conveyor
           def content
+            @content = nil unless cache
+
             @content ||= Redcarpet::Markdown.new(
               Render.new(with_toc_data: true),
               fenced_code_blocks: true,
@@ -36,14 +38,19 @@ module Trifle
           end
 
           def meta
+            @meta = nil unless cache
+
             @meta ||= (YAML.safe_load(data[/^---(.*?)---(\s*)/m].to_s) || {}).merge(
-              'url' => "/#{url}",
+              'url' => "/#{[namespace, url].compact.join('/')}",
               'breadcrumbs' => url.split('/'),
-              'toc' => toc
+              'toc' => toc,
+              'updated_at' => ::File.stat(file).mtime
             )
           end
 
           def toc
+            @toc = nil unless cache
+
             @toc ||= Redcarpet::Markdown.new(
               Redcarpet::Render::HTML_TOC
             ).render(data.sub(/^---(.*?)---(\s*)/m, ''))

data/lib/trifle/docs/harvester.rb

@@ -4,24 +4,28 @@ module Trifle
   module Docs
     module Harvester
       class Walker
-        attr_reader :path, :router
+        attr_reader :path, :router, :namespace, :cache
 
         def initialize(**keywords)
           @path = keywords.fetch(:path)
           @harvesters = keywords.fetch(:harvesters)
+          @namespace = keywords.fetch(:namespace)
+          @cache = keywords.fetch(:cache)
           @router = {}
 
           gather
         end
 
-        def gather
+        def gather # rubocop:disable Metrics/MethodLength
           Dir["#{path}/**/*.*"].each do |file|
             @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)
-                break
-              end
+              next unless sieve.match?
+
+              @router[sieve.to_url] = harvester::Conveyor.new(
+                file: file, url: sieve.to_url, namespace: namespace, cache: cache
+              )
+              break
             end
           end
           true
@@ -44,11 +48,19 @@ module Trifle
         end
 
         def content_for(url:)
-          @router[url].content
+          route_for(url: url)&.content
         end
 
         def meta_for(url:)
-          @router[url].meta
+          route_for(url: url)&.meta
+        end
+
+        def route_for(url:)
+          @router[url] || not_found(url: url)
+        end
+
+        def not_found(url:)
+          puts "No route found for url: #{url}"
         end
       end
 
@@ -70,14 +82,18 @@ module Trifle
       end
 
       class Conveyor
-        attr_reader :file, :url
+        attr_reader :file, :url, :namespace, :cache
 
-        def initialize(file:, url:)
+        def initialize(file:, url:, namespace:, cache:)
           @file = file
           @url = url
+          @namespace = namespace
+          @cache = cache
         end
 
         def data
+          @data = nil unless cache
+
           @data ||= ::File.read(file)
         end
       end

data/lib/trifle/docs/version.rb

@@ -2,6 +2,6 @@
 
 module Trifle
   module Docs
-    VERSION = '0.1.1'
+    VERSION = '0.3.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

data/trifle-docs.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/trifle-io/trifle-docs'
-  spec.metadata["changelog_uri"] = "https://github.com/trifle-io/trifle-docs/blob/main/CHANGELOG.md"
+  spec.metadata['changelog_uri'] = 'https://trifle.io/trifle-docs/changelog'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trifle-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jozef Vaclavik
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2022-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -165,7 +165,8 @@ files:
 - ".devops/docker/codespaces/docker-compose.yml"
 - ".rspec"
 - ".rubocop.yml"
-- CHANGELOG.md
+- ".ruby-version"
+- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -195,6 +196,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
@@ -214,7 +216,7 @@ licenses:
 metadata:
   homepage_uri: https://trifle.io
   source_code_uri: https://github.com/trifle-io/trifle-docs
-  changelog_uri: https://github.com/trifle-io/trifle-docs/blob/main/CHANGELOG.md
+  changelog_uri: https://trifle.io/trifle-docs/changelog
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -230,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Simple documentation for your markdown files.

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2022-06-20
-
-- Initial release