trifle-docs 0.1.0

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'redcarpet'
+require 'rouge'
+require 'rouge/plugins/redcarpet'
+
+module Trifle
+  module Docs
+    module Harvester
+      module Markdown
+        class Render < Redcarpet::Render::HTML
+          include Rouge::Plugins::Redcarpet
+        end
+
+        class Sieve < Harvester::Sieve
+          def match?
+            file.end_with?('.md')
+          end
+
+          def to_url
+            file.gsub(%r{^#{path}/}, '')
+                .gsub(%r{/?index\.md}, '')
+                .gsub(/\.md/, '')
+          end
+        end
+
+        class Conveyor < Harvester::Conveyor
+          def content
+            @content ||= Redcarpet::Markdown.new(
+              Render.new(with_toc_data: true),
+              fenced_code_blocks: true,
+              disable_indented_code_blocks: true,
+              footnotes: true
+            ).render(data.gsub(/^---(.*?)---(\s*)/m, ''))
+          end
+
+          def meta
+            @meta ||= YAML.load_file(file).merge(
+              'url' => "/#{url}",
+              'breadcrumbs' => url.split('/'),
+              'toc' => toc
+            )
+          end
+
+          def toc
+            @toc ||= Redcarpet::Markdown.new(
+              Redcarpet::Render::HTML_TOC
+            ).render(data.gsub(/^---(.*?)---(\s*)/m, ''))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trifle/docs/harvester.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Docs
+    module Harvester
+      class Walker
+        attr_reader :path, :router
+
+        def initialize(**keywords)
+          @path = keywords.fetch(:path)
+          @harvesters = keywords.fetch(:harvesters)
+          @router = {}
+
+          gather
+        end
+
+        def gather
+          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
+            end
+          end
+          true
+        end
+
+        def sitemap
+          @sitemap ||= begin
+            mapping = router.keys.each_with_object({}) do |url, out|
+              out[url] = meta_for(url: url)
+            end
+
+            Trifle::Docs::Helper::Tree.new(mapping: mapping).menu
+          end
+        end
+
+        def collection_for(url:)
+          return sitemap if url.empty?
+
+          sitemap.dig(*url.split('/'))
+        end
+
+        def content_for(url:)
+          @router[url].content
+        end
+
+        def meta_for(url:)
+          @router[url].meta
+        end
+      end
+
+      class Sieve
+        attr_reader :path, :file
+
+        def initialize(path:, file:)
+          @path = path
+          @file = file
+        end
+
+        def match?
+          raise 'Not Impelemented'
+        end
+
+        def to_url
+          raise 'Not Impelemented'
+        end
+      end
+
+      class Conveyor
+        attr_reader :file, :url
+
+        def initialize(file:, url:)
+          @file = file
+          @url = url
+        end
+
+        def data
+          @data ||= ::File.read(file)
+        end
+      end
+    end
+  end
+end

data/lib/trifle/docs/helper/tree.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Docs
+    module Helper
+      class Tree
+        attr_reader :mapping
+
+        def initialize(mapping:)
+          @mapping = mapping
+        end
+
+        def menu
+          @menu ||= mapping.inject({}) do |out, (url, meta)|
+            deep_merge(
+              out, url.split('/').reverse.inject({ '_meta' => meta }) { |o, k| { k => o } }
+            )
+          end
+        end
+
+        def deep_merge(this_hash, other_hash, &block)
+          deep_merge!(this_hash.dup, other_hash, &block)
+        end
+
+        def deep_merge!(this_hash, other_hash, &block)
+          this_hash.merge!(other_hash) do |key, this_val, other_val|
+            if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+              deep_merge(this_val, other_val, &block)
+            elsif block_given?
+              block.call(key, this_val, other_val)
+            else
+              other_val
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trifle/docs/operations/collection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Docs
+    module Operations
+      class Collection
+        attr_reader :url
+
+        def initialize(**keywords)
+          @url = keywords.fetch(:url)
+          @config = keywords[:config]
+        end
+
+        def config
+          @config || Trifle::Docs.default
+        end
+
+        def perform
+          config.harvester.collection_for(url: url)
+        end
+      end
+    end
+  end
+end

data/lib/trifle/docs/operations/content.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Docs
+    module Operations
+      class Content
+        attr_reader :url
+
+        def initialize(**keywords)
+          @url = keywords.fetch(:url)
+          @config = keywords[:config]
+        end
+
+        def config
+          @config || Trifle::Docs.default
+        end
+
+        def perform
+          config.harvester.content_for(url: url)
+        end
+      end
+    end
+  end
+end

data/lib/trifle/docs/operations/meta.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Docs
+    module Operations
+      class Meta
+        attr_reader :url
+
+        def initialize(**keywords)
+          @url = keywords.fetch(:url)
+          @config = keywords[:config]
+        end
+
+        def config
+          @config || Trifle::Docs.default
+        end
+
+        def perform
+          config.harvester.meta_for(url: url)
+        end
+      end
+    end
+  end
+end

data/lib/trifle/docs/operations/sitemap.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Docs
+    module Operations
+      class Sitemap
+        def initialize(**keywords)
+          @config = keywords[:config]
+        end
+
+        def config
+          @config || Trifle::Docs.default
+        end
+
+        def perform
+          config.harvester.sitemap
+        end
+      end
+    end
+  end
+end

data/lib/trifle/docs/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Docs
+    VERSION = '0.1.0'
+  end
+end

data/lib/trifle/docs.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'docs/configuration'
+require_relative 'docs/helper/tree'
+require_relative 'docs/harvester'
+require_relative 'docs/harvester/file'
+require_relative 'docs/harvester/markdown'
+require_relative 'docs/operations/content'
+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
+
+module Trifle
+  module Docs
+    class Error < StandardError; end
+
+    def self.default
+      @default ||= Configuration.new
+    end
+
+    def self.configure
+      yield(default)
+
+      default
+    end
+
+    def self.content(url:, config: nil)
+      Trifle::Docs::Operations::Content.new(
+        url: url, config: config
+      ).perform
+    end
+
+    def self.meta(url:, config: nil)
+      Trifle::Docs::Operations::Meta.new(
+        url: url, config: config
+      ).perform
+    end
+
+    def self.collection(url:, config: nil)
+      Trifle::Docs::Operations::Collection.new(
+        url: url, config: config
+      ).perform
+    end
+
+    def self.sitemap(config: nil)
+      Trifle::Docs::Operations::Sitemap.new(
+        config: config
+      ).perform
+    end
+  end
+end

data/sig/trifle/docs.rbs

@@ -0,0 +1,6 @@
+module Trifle
+  module Docs
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/templates/simple/layout.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>Trifle::Docs</title>
+    <style>
+      <%= Rouge::Themes::Github.new.render %>
+    </style>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/templates/simple/page.erb

@@ -0,0 +1,32 @@
+<ul>
+  <% sitemap.sort_by {|(key, option)| option.dig('_meta', 'nav_order') || 0 }.each do |(key, option)| %>
+    <% next if key == '_meta' %>
+    <li>
+      <a href="<%= option.dig('_meta', 'url') %>"><%= option.dig('_meta', 'title') %></a>
+      <ul>
+        <% option.sort_by {|(key, option)| option.dig('_meta', 'nav_order') || 0 }.each do |(key, option)| %>
+          <% next if key == '_meta' %>
+          <li><a href="<%= option.dig('_meta', 'url') %>"><%= option.dig('_meta', 'title') %></a></li>
+        <% end %>
+      </ul>
+    </li>
+  <% end %>
+</ul>
+
+Breadcrumbs: <% meta['breadcrumbs'].count.times do |i| %>
+  <% page = sitemap.dig(*meta['breadcrumbs'].take(i+1)) %>
+  <a href="<%= page.dig('_meta', 'url') %>"><%= page.dig('_meta', 'title') %></a>
+  <% next if i+1 == meta['breadcrumbs'].count %>
+  /
+<% end %>
+
+<%= content %>
+
+<% if meta['type'] == 'collection' %>
+  <ul>
+    <% collection.sort_by {|(key, option)| option.dig('_meta', 'nav_order') || 0 }.each do |(key, option)| %>
+      <% next if key == '_meta' %>
+      <li><a href="<%= option.dig('_meta', 'url') %>"><%= option.dig('_meta', 'title') %></a></li>
+    <% end %>
+  </ul>
+<% end %>

data/trifle-docs.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "lib/trifle/docs/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "trifle-docs"
+  spec.version = Trifle::Docs::VERSION
+  spec.authors = ["Jozef Vaclavik"]
+  spec.email = ["jozef@hey.com"]
+
+  spec.summary = "Simple documentation for your markdown files."
+  spec.description = "Trifle::Docs is way too simple documentation app. "\
+                     'It uses your markdown files and structure to build '\
+                     'up your documentation. You can use it as a standalone '\
+                     'app or mount it in your Rails app.'
+  spec.homepage      = 'https://trifle.io'
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  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"
+
+  # 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.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_development_dependency('bundler', '~> 2.1')
+  spec.add_development_dependency('byebug', '>= 0')
+  spec.add_development_dependency('puma')
+  spec.add_development_dependency('rake', '~> 13.0')
+  spec.add_development_dependency('rspec', '~> 3.2')
+  spec.add_development_dependency('rubocop', '1.0.0')
+
+  spec.add_dependency('redcarpet')
+  spec.add_dependency('rouge')
+  spec.add_dependency('sinatra')
+  spec.add_dependency('yaml')
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: trifle-docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jozef Vaclavik
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !ruby/object:Gem::Dependency
+  name: puma
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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: rouge
+  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: sinatra
+  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: yaml
+  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'
+description: Trifle::Docs is way too simple documentation app. It uses your markdown
+  files and structure to build up your documentation. You can use it as a standalone
+  app or mount it in your Rails app.
+email:
+- jozef@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".devcontainer.json"
+- ".devops/docker/codespaces/Dockerfile"
+- ".devops/docker/codespaces/docker-compose.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- demo.gif
+- docs/asdf.txt
+- docs/blog.md
+- docs/blog/2022-06-20_getting_started_with_trifle_docs.md
+- docs/blog/2022-06-27_advanced_documentation.md
+- docs/blog/screen.png
+- docs/example.md
+- docs/example/snippet.md
+- docs/index.md
+- docs/projects.md
+- docs/projects/kindergarden.md
+- docs/projects/petite_project.md
+- docs/projects/rugby_team.md
+- docs/test/case.md
+- docs/test/index.md
+- docs/test/sample.md
+- lib/trifle/docs.rb
+- lib/trifle/docs/app.rb
+- lib/trifle/docs/configuration.rb
+- lib/trifle/docs/harvester.rb
+- lib/trifle/docs/harvester/file.rb
+- lib/trifle/docs/harvester/markdown.rb
+- lib/trifle/docs/helper/tree.rb
+- lib/trifle/docs/operations/collection.rb
+- lib/trifle/docs/operations/content.rb
+- lib/trifle/docs/operations/meta.rb
+- lib/trifle/docs/operations/sitemap.rb
+- lib/trifle/docs/version.rb
+- sig/trifle/docs.rbs
+- templates/simple/layout.erb
+- templates/simple/page.erb
+- trifle-docs.gemspec
+homepage: https://trifle.io
+licenses:
+- MIT
+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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Simple documentation for your markdown files.
+test_files: []