florby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 213febbaf5b4ac4037ec69a179102882cf3aee4d5db0d1b9a1481d78af8ad46e
+  data.tar.gz: 5824623b2f65617a09a37780a7e870b47fce2454c0569d65f40f9cf96c76b027
+SHA512:
+  metadata.gz: 06712e6540eb8fa39a879a4da61b4a8b1f367240ecad537ebcac6e63327352c659df3c8a32362f1777dd01a85b9432e6a4b22a6f6df28fdc333c0d64dcfa650e
+  data.tar.gz: d88c5b4c34b3f99163a14ae6856c0544c24579b68eacfc8866e3ceda3e10305c6d7f363131855d0eccc66e5a6aa60c1007b721030e0418c385cc40ffcc878f48

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  DisabledByDefault: true

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    florby (0.1.0)
+      commonmarker
+      sitemap_generator
+      webrick
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.4)
+    commonmarker (1.0.4-arm64-darwin)
+    rake (13.1.0)
+    sitemap_generator (6.3.0)
+      builder (~> 3.0)
+    webrick (1.8.1)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+
+DEPENDENCIES
+  florby!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Yuki Akamatsu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+# Florby

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/exe/florby

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "florby"
+
+Florby::CLI.run(ARGV)

data/florby.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/florby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "florby"
+  spec.version = Florby::VERSION
+  spec.authors = ["AKAMATSU Yuki"]
+  spec.email = ["y.akamatsu@ukstudio.jp"]
+
+  spec.summary = "a static site generator for digital garden"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = 'https://github.com/ukstudio/florby'
+  spec.metadata["source_code_uri"] = 'https://github.com/ukstudio/florby'
+
+  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"]
+
+  spec.add_dependency "commonmarker"
+  spec.add_dependency "webrick"
+  spec.add_dependency "sitemap_generator"
+end

data/lib/florby/builder.rb

@@ -0,0 +1,84 @@
+require 'fileutils'
+require 'sitemap_generator'
+
+require 'florby/page'
+require 'florby/plugins'
+require 'florby/renderer'
+require 'florby/collection'
+require 'florby/config'
+
+module Florby
+  class Builder
+    def self.run
+      new.run
+    end
+
+    def run
+      remove_old_files
+
+      @config = Florby::Config.new
+      if File.exist?(File.join(Dir.pwd, 'config.rb'))
+        @config.load_file('config.rb')
+      end
+
+      copy_files
+
+      collection = Collection.new
+      Plugins::WikiLinkReplacer.new(collection: collection).replace!
+
+      collection.all_pages.each do |page|
+        html = Renderer.new(page: page, collection: collection).render
+        write_html(page.permalink, html)
+        page.aliases.each do |alias_path|
+          write_html(alias_path, alias_html(page.permalink))
+        end
+      end
+
+      SitemapGenerator::Sitemap.default_host = @config.fetch('host')
+      SitemapGenerator::Sitemap.public_path = '_build'
+      SitemapGenerator::Sitemap.compress = false
+      SitemapGenerator::Sitemap.create do
+        collection.all_pages.each do |page|
+          add page.permalink, lastmod: page.updated
+        end
+      end
+    end
+
+    private def remove_old_files
+      puts 'remove old files'
+      FileUtils.rm_rf(Dir.glob(File.join(Dir.pwd, '_build', '*')))
+    end
+
+    private def copy_files
+      @config.copy_files.each do |path|
+        puts "copy #{path}"
+        FileUtils.cp_r(File.join(Dir.pwd, 'src', path), File.join(Dir.pwd, '_build'))
+      end
+    end
+
+    private def write_html(permalink, html)
+      paths = permalink.split('/')
+
+      if paths.empty?
+        File.open(File.join(Dir.pwd, '_build', 'index.html'), 'w+') do |f|
+          f.write(html)
+        end
+      else
+        full_path = File.join('_build', File.join(paths))
+        FileUtils.mkdir_p(File.join(Dir.pwd, full_path))
+        File.open(File.join(Dir.pwd, full_path, 'index.html'), 'w+') do |f|
+          f.write(html)
+        end
+      end
+    end
+
+    private def alias_html(canonical)
+      <<~HTML
+        <html>
+          <meta http-equiv="refresh" content="0; URL='#{@config.fetch('host')}#{canonical}'">
+          <link rel="canonical" href="#{@config.fetch('host')}#{canonical}">
+        </html>
+      HTML
+    end
+  end
+end

data/lib/florby/cli.rb

@@ -0,0 +1,19 @@
+module Florby
+  require 'florby/builder'
+  require 'florby/server'
+
+  class CLI
+    def self.run(args)
+      subcommand = args.shift
+
+      case subcommand
+      when "build"
+        Florby::Builder.run
+      when "server"
+        Florby::Server.run
+      else
+        puts "unknown command"
+      end
+    end
+  end
+end

data/lib/florby/collection.rb

@@ -0,0 +1,24 @@
+module Florby
+  class Collection
+    def initialize
+      files = Dir.glob(File.join(Dir.pwd, 'src', '*.md'))
+      @hash = files.map { |file| [File.basename(file).gsub(/\.md$/, ''), Page.new(file: file)] }.to_h
+    end
+
+    def titles
+      @hash.keys
+    end
+
+    def all_pages
+      @hash.values.sort_by(&:created).reverse
+    end
+
+    def pages
+      all_pages.reject(&:exclude_from_collections?)
+    end
+
+    def find(title)
+      @hash[title]
+    end
+  end
+end

data/lib/florby/config.rb

@@ -0,0 +1,28 @@
+module Florby
+  class Config
+    def initialize
+      @options = {}
+    end
+
+    def load_file(path)
+      instance_eval(File.read(File.join(Dir.pwd, path)))
+    end
+
+    def fetch(key)
+      @options.fetch(key)
+    end
+
+    def copy_from(path)
+      @options['copy_from'] ||= []
+      @options['copy_from'] << path
+    end
+
+    def copy_files
+      @options['copy_from'] ||= []
+    end
+
+    def host(url)
+      @options['host'] = url
+    end
+  end
+end

data/lib/florby/page.rb

@@ -0,0 +1,68 @@
+require 'commonmarker'
+require 'yaml'
+require 'fileutils'
+
+module Florby
+  class Page
+    attr_reader :meta
+
+    def initialize(file:)
+      @file = file
+      @meta = {}
+      @markdown = File.read(@file)
+      frontmatter, @body = @markdown.split("---\n", 3).last(2)
+      @frontmatter = YAML.unsafe_load(frontmatter)
+    end
+
+    def filename
+      @filename ||= File.basename(@file)
+    end
+
+    def title
+      @frontmatter['title'] ||filename.gsub(/\.md$/, '')
+    end
+
+    def permalink
+      link = @frontmatter['permalink'] || title
+      link = "/#{link}" unless link =~ /^\//
+      link = "#{link}/" unless link =~ /\/$/
+      link
+    end
+
+    def created
+      if @frontmatter['created'].is_a?(String)
+        Date.parse(@frontmatter['created'])
+      else
+        @frontmatter['created'] || File::Stat.new(@file).birthtime.to_date
+      end
+    end
+
+    def updated
+      if @frontmatter['updated'].is_a?(String)
+        Date.parse(@frontmatter['updated'])
+      else
+        @frontmatter['updated'] || File::Stat.new(@file).mtime.to_date
+      end
+    end
+
+    def exclude_from_collections?
+      @frontmatter['exclude_from_collections'] == 'true'
+    end
+
+    def layout
+      @frontmatter['layout'] || 'default'
+    end
+
+    def aliases
+      @frontmatter['aliases'] || []
+    end
+
+    def content
+      @content ||= Commonmarker.to_html(@body, options: { extension: { tagfilter: false, autolink: true }, render: { unsafe: true } })
+    end
+
+    def content=(html)
+      @content = html
+    end
+  end
+end

data/lib/florby/plugins/wiki_link_replacer.rb

@@ -0,0 +1,35 @@
+require 'cgi'
+
+module Florby
+  module Plugins
+    class WikiLinkReplacer
+      WIKI_LINK_REGEXP = /\[\[\s?([^\[\]\|\n\r]+)(\|[^\[\]\|\n\r]+)?\s?\]\]/
+
+      def initialize(collection:)
+        @collection = collection
+      end
+
+      def replace!
+        @collection.all_pages.each do |page|
+          page.meta['backlinks'] ||= []
+
+          page.content =
+            page.content.gsub(WIKI_LINK_REGEXP) do |match|
+
+              title = CGI.unescapeHTML(Regexp.last_match(1))
+              destination = @collection.find(title)
+
+              unless page.exclude_from_collections?
+                destination.meta['backlinks'] ||= []
+                destination.meta['backlinks'] << page
+              end
+
+              raise "Page not found: #{title}. #{@collection.titles}" unless destination
+
+              "<a href='#{destination.permalink}'>#{destination.title}</a>"
+            end
+        end
+      end
+    end
+  end
+end

data/lib/florby/plugins.rb

@@ -0,0 +1,6 @@
+require 'florby/plugins/wiki_link_replacer'
+
+module Florby
+  module Plugins
+  end
+end

data/lib/florby/renderer.rb

@@ -0,0 +1,29 @@
+require 'erb'
+
+module Florby
+  class Renderer
+    DEFAULT_TEMPLATE = <<~ERB
+      <html>
+        <meta charset="utf-8">
+        <body>
+          <%= page.content %>
+        </body>
+      </html>
+    ERB
+    attr_reader :page, :collection
+
+    def initialize(page:, collection:)
+      @page = page
+      @collection = collection
+
+      if File.exist?(File.join(Dir.pwd, 'layouts', "#{page.layout}.erb"))
+        @layout = File.read(File.join(Dir.pwd, 'layouts', "#{page.layout}.erb"))
+      end
+    end
+
+    def render
+      erb = ERB.new(@layout || DEFAULT_TEMPLATE)
+      erb.result(binding)
+    end
+  end
+end

data/lib/florby/server.rb

@@ -0,0 +1,22 @@
+require 'webrick'
+
+module Florby
+  class Server
+    def self.run
+      new.run
+    end
+
+    def run
+      server = WEBrick::HTTPServer.new(
+        DocumentRoot: File.join(Dir.pwd, '_build'),
+        Port: 8081,
+      )
+
+      trap(:INT) do
+        server.shutdown
+      end
+
+      server.start
+    end
+  end
+end

data/lib/florby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Florby
+  VERSION = "0.1.0"
+end

data/lib/florby.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "florby/version"
+require_relative "florby/cli"
+
+module Florby
+end

data/sig/tororo.rbs

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

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: florby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AKAMATSU Yuki
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  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: webrick
+  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: sitemap_generator
+  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:
+email:
+- y.akamatsu@ukstudio.jp
+executables:
+- florby
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- exe/florby
+- florby.gemspec
+- lib/florby.rb
+- lib/florby/builder.rb
+- lib/florby/cli.rb
+- lib/florby/collection.rb
+- lib/florby/config.rb
+- lib/florby/page.rb
+- lib/florby/plugins.rb
+- lib/florby/plugins/wiki_link_replacer.rb
+- lib/florby/renderer.rb
+- lib/florby/server.rb
+- lib/florby/version.rb
+- sig/tororo.rbs
+homepage:
+licenses: []
+metadata:
+  homepage_uri: https://github.com/ukstudio/florby
+  source_code_uri: https://github.com/ukstudio/florby
+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.3.26
+signing_key:
+specification_version: 4
+summary: a static site generator for digital garden
+test_files: []