cosensee 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca076a9a5e18e0bd0f5c1825e35714536bcfad2921b8d3e997a3fe86140314b4
+  data.tar.gz: e28ec42e8750b9426275e78ba6b238b358217d8c97c7d95c1134a5f54f6f341c
+SHA512:
+  metadata.gz: 72a7eb0c65b77920c3b1784db4bf58f9d984c0f660dbda56cab55ac2ac91d83ecf3e47b08ffb413d08e1601180f1258adcb141470a1dcbe5b653bd8d77232d7b
+  data.tar.gz: 1a8bef01b367b5d8f665236e0940fb4cf823134d4cbe8a3955eab932cf76e63d21c9548b813acadfd16c5da57ee17a40cf350ed093e1c23f3955ede40862954f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,56 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: '3.4'
+  NewCops: enable
+
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+Layout/LineLength:
+  Max: 300
+  Exclude:
+    - 'spec/**/*'
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 80
+
+Metrics/ParameterLists:
+  Max: 8
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Style/MinMaxComparison:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 50
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-12-11 09:34:23 UTC using RuboCop version 1.69.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/README.md

@@ -0,0 +1,40 @@
+# Cosensee
+
+Cosensee is a tool that reads JSON data from [Cosense](https://scrapbox.io) (formerly Scrapbox) and outputs it in HTML format.
+
+## Installation
+
+Install the gem:
+
+    $ gem install cosensee
+
+If you use bundler, add to the application's Gemfile by executing:
+
+    $ bundle add cosensee
+
+## Usage
+
+To output HTML, specify the JSON file from Cosense as an argument and run `bin/build` with Cosense JSON dump file.
+
+    $ bin/build <json file>
+
+The HTML files will be output to the .out directory. You can view them locally by using the bin/server command.
+
+    $ $bin/server
+
+By adding a Cosense JSON file as an argument, the build process will be executed before starting the server.
+
+    $ $bin/server <json file>
+
+The default port used by bin/server is 1212.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/takahashim/cosensee.
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: :spec

data/lib/cosensee/blank_bracket.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Cosensee
+  # for bracket only spaces
+  BlankBracket = Data.define(:content, :blank, :raw) do
+    include BracketSerializer
+  end
+end

data/lib/cosensee/bracket_parser.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Cosensee
+  # parser of Bracket
+  class BracketParser
+    include ::Cosensee::LinkEncodable
+
+    def self.parse(content)
+      new.parse(content)
+    end
+
+    attr_reader :content
+
+    def parse(content)
+      @content = content
+
+      case content
+      in [/\A\z/]
+        EmptyBracket.new(content:, raw: '[]')
+      in [/\A([ \t]+)\z/]
+        BlankBracket.new(content:, blank: Regexp.last_match(1), raw: "[#{Regexp.last_match(0)}]")
+      in [/\A\$ (.*)\z/]
+        FormulaBracket.new(content:, formula: Regexp.last_match(1), raw: "[#{Regexp.last_match(0)}]")
+      in [/\A(.*).icon\z/]
+        IconBracket.new(content:, icon_name: Regexp.last_match(1))
+      in [%r{\A(https?://[^\s]+)\s+(https?://[^\s\]]*\.(png|jpe?g|gif|svg|webp)(\?[^\s\]]+)?)\z}]
+        ImageBracket.new(content:, link: Regexp.last_match(1), src: Regexp.last_match(2), raw: "[#{Regexp.last_match(0)}]")
+      in [%r{\A(https?://[^\s\]]*\.(png|jpe?g|gif|svg|webp)(\?[^\s\]]+)?)\s+(https?://[^\s]+)\z}]
+        ImageBracket.new(content:, link: Regexp.last_match(4), src: Regexp.last_match(1), raw: "[#{Regexp.last_match(0)}]")
+      in [%r{\A(https?://[^\s\]]*\.(png|jpe?g|gif|svg|webp))\z}]
+        ImageBracket.new(content:, link: nil, src: Regexp.last_match(1), raw: "[#{Regexp.last_match(0)}]")
+      in [%r{\A(https?://[^ \t]*)(\s+(.+))?\z}]
+        # match_external_link_precede
+        anchor = Regexp.last_match(3) || Regexp.last_match(1)
+        link = Regexp.last_match(1)
+        raw = "[#{Regexp.last_match(0)}]"
+        ExternalLinkBracket.new(content:, link:, anchor:, raw:)
+      in [%r{\A((.*\S)\s+)?(https?://[^\s]+)\z}]
+        # match_external_link_succeed
+        anchor = Regexp.last_match(2) || Regexp.last_match(3)
+        link = Regexp.last_match(3)
+        raw = "[#{Regexp.last_match(0)}]"
+        ExternalLinkBracket.new(content:, link:, anchor:, raw:)
+      in [%r{\A([_\*/\-"#%&'\(\)~\|\+<>{},\.]+) (.+)\z}]
+        # match_decorate
+        deco = Regexp.last_match(1)
+        text = Regexp.last_match(2)
+        font_size = deco.count('*') > 10 ? 10 : deco.count('*')
+        underlined = deco.include?('_')
+        deleted = deco.include?('-')
+        slanted = deco.include?('/')
+        DecorateBracket.new(
+          content:,
+          font_size:,
+          underlined:,
+          slanted:,
+          deleted:,
+          text:,
+          raw:
+        )
+      else
+        line_parser = LineParser.new
+        data = ParsedBracket.new(content:)
+        parsed = data
+                   .then { |d| line_parser.parse_url(d) }
+                   .then { |d| line_parser.parse_hashtag(d) }
+        if parsed.single_text? && parsed.content == content
+          anchor = parsed.first_content
+          link = make_link(anchor)
+          raw = raw_string
+          InternalLinkBracket.new(content:, link:, anchor:, raw:)
+        else
+          TextBracket.new(content: parsed.content, raw: raw_string)
+        end
+      end
+    end
+
+    def raw_string
+      "[#{content.map(&:to_s).join}]"
+    end
+  end
+end

data/lib/cosensee/bracket_serializer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cosensee
+  # serializer for brackets
+  module BracketSerializer
+    def to_s = raw
+
+    def to_obj
+      unparsed = content.map do |elem|
+        if elem.is_a?(String)
+          elem
+        else
+          elem.to_obj
+        end
+      end
+
+      "[#{unparsed}]"
+    end
+
+    def to_json(*)
+      to_obj.to_json(*)
+    end
+  end
+end

data/lib/cosensee/code.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cosensee
+  # parse a line
+  Code = Data.define(:content, :raw) do
+    alias_method :to_s, :raw
+
+    def to_obj
+      "`#{content}`"
+    end
+
+    def to_json(*)
+      to_obj.to_json(*)
+    end
+  end
+end

data/lib/cosensee/codeblock.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cosensee
+  # for codeblock
+  Codeblock = Data.define(:content, :raw) do
+    alias_method :to_s, :raw
+
+    def to_obj
+      "code:#{content}"
+    end
+
+    def to_json(*)
+      to_obj.to_json(*)
+    end
+  end
+end

data/lib/cosensee/command_line.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cosensee
+  # for command line
+  CommandLine = Data.define(:content, :prompt, :raw) do
+    alias_method :to_s, :raw
+
+    def to_obj
+      "#{prompt} #{content}"
+    end
+
+    def to_json(*)
+      to_obj.to_json(*)
+    end
+  end
+end

data/lib/cosensee/decorate_bracket.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cosensee
+  # for Decorate
+  DecorateBracket = Data.define(
+    :content,
+    :font_size,
+    :underlined,
+    :slanted,
+    :deleted,
+    :text,
+    :raw
+  ) do
+    include BracketSerializer
+  end
+end

data/lib/cosensee/double_bracket.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cosensee
+  # for double Bracket
+  DoubleBracket = Data.define(:content, :raw) do
+    def image?
+      content.size == 1 && content[0].match?(/\.(png|jpg)$/)
+    end
+
+    alias_method :to_s, :raw
+
+    def to_obj
+      "[[#{content}]]"
+    end
+
+    def to_json(*)
+      to_obj.to_json(*)
+    end
+  end
+end

data/lib/cosensee/empty_bracket.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Cosensee
+  # for empty bracket
+  EmptyBracket = Data.define(:content, :raw) do
+    include BracketSerializer
+  end
+end

data/lib/cosensee/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cosensee
+  class Error < StandardError; end
+end

data/lib/cosensee/external_link_bracket.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Cosensee
+  # for Formula
+  ExternalLinkBracket = Data.define(:content, :link, :anchor, :raw) do
+    include BracketSerializer
+  end
+end

data/lib/cosensee/formula_bracket.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Cosensee
+  # for Formula
+  FormulaBracket = Data.define(:content, :formula, :raw) do
+    include BracketSerializer
+  end
+end

data/lib/cosensee/hash_tag.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cosensee
+  # parse a hash tag
+  HashTag = Data.define(:content, :raw) do
+    alias_method :to_s, :raw
+    alias_method :anchor, :content
+
+    def to_obj
+      "##{content}"
+    end
+
+    def to_json(*)
+      to_obj.to_json(*)
+    end
+  end
+end

data/lib/cosensee/html_builder.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'erubi'
+require 'tilt'
+require 'fileutils'
+
+module Cosensee
+  # generate HTML files
+  class HtmlBuilder
+    def initialize(project, root_dir: nil)
+      @project = project
+      @templates_dir = File.join(__dir__, '../../templates')
+      @root_dir = root_dir || File.join(Dir.pwd, '.out')
+      FileUtils.mkdir_p(@root_dir)
+    end
+
+    attr_reader :project, :root_dir, :templates_dir
+
+    def build_all
+      build_index(project)
+
+      # build all pages
+      project.pages.each do |page|
+        build_page(page)
+      end
+
+      # build all orphan (title only) pages
+      project.page_store.orphan_page_titles.each do |title|
+        build_page_only_title(title)
+      end
+    end
+
+    def build_index(project)
+      template = Tilt::ErubiTemplate.new(File.join(templates_dir, 'index.html.erb'))
+      output = template.render(nil, project:)
+      File.write(File.join(root_dir, 'index.html'), output)
+    end
+
+    def build_page(page)
+      template = Tilt::ErubiTemplate.new(File.join(templates_dir, 'page.html.erb'))
+      output = template.render(nil, project:, page:, title: page.title)
+      File.write(File.join(root_dir, page.link_path), output)
+    end
+
+    def build_page_only_title(title)
+      path = File.join(root_dir, "#{title.gsub(/ /, '_').gsub('/', '%2F')}.html")
+      return if File.exist?(path)
+
+      template = Tilt::ErubiTemplate.new(File.join(templates_dir, 'page.html.erb'))
+      output = template.render(nil, project:, page: nil, title:)
+      File.write(path, output)
+    end
+
+    def page_title(page)
+      "#{page.title} | #{project.title}"
+    end
+  end
+end

data/lib/cosensee/html_encodable.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'cgi/util'
+
+module Cosensee
+  # parser of Bracket
+  module HtmlEncodable
+    def escape_html(str)
+      CGI.escape_html(str)
+    end
+  end
+end

data/lib/cosensee/icon_bracket.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Cosensee
+  # for Icon
+  IconBracket = Data.define(:content, :icon_name) do
+    include BracketSerializer
+  end
+end

data/lib/cosensee/image_bracket.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Cosensee
+  # for Image
+  ImageBracket = Data.define(:content, :link, :src, :raw) do
+    include BracketSerializer
+  end
+end

data/lib/cosensee/indent.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cosensee
+  # for normal Text
+  Indent = Data.define(:content, :raw) do
+    def initialize(content: '', raw: '')
+      @level = content.size
+      super
+    end
+
+    attr_reader :level
+
+    alias_method :to_s, :raw
+
+    def to_obj
+      content
+    end
+
+    def to_json(*)
+      to_obj.to_json(*)
+    end
+  end
+end

data/lib/cosensee/internal_link_bracket.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Cosensee
+  # for Icon
+  InternalLinkBracket = Data.define(:content, :link, :anchor, :raw) do
+    include BracketSerializer
+  end
+end

data/lib/cosensee/line.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cosensee
+  # for Line
+  Line = Data.define(:content, :parsed) do
+    def self.from_array(lines_args)
+      lines_args.map { |arg| new(arg) }
+    end
+
+    def initialize(content:)
+      super(
+        content:,
+        parsed: LineParser.parse(content)
+      )
+    end
+
+    def brackets
+      content.scan(/\[.+?\]/)
+    end
+
+    def some_images?
+      brackets.any? { |item| item.match?(/\.(png|jpg)$/) }
+    end
+
+    def first_image
+      brackets.find { |item| item.match?(/\.(png|jpg)$/) }
+    end
+
+    def indent_level
+      content.match(/\A([\t ]*)/)[1].size
+    end
+
+    def indented?
+      content.match?(/\A[\t ]/)
+    end
+
+    def to_obj
+      content
+    end
+
+    def to_json(*)
+      to_obj.to_json(*)
+    end
+  end
+end