repubmark 0.0.0

data/exe/repubmark

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __dir__).freeze
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+
+require 'bundler/setup'
+
+require 'i18n'
+require 'repubmark'
+
+I18n.load_path = Dir[
+  Pathname.new(__dir__).join('../vendor/rails-i18n/rails/locale/**/*.yml')
+].each(&:freeze).freeze
+
+config_filename = String(ARGV[0]).freeze
+profile = String(ARGV[1]).freeze
+
+config = Repubmark::Config.load_file config_filename, profile
+$article = Repubmark::Elems::Article.new config
+
+template = $stdin.read.freeze
+context = BasicObject.new
+def context.article = $article
+context.instance_eval template, __FILE__, __LINE__
+
+def wrap(str)
+  words = str.strip.split
+  lines = [[]]
+  words.each do |word|
+    lines << [] if [*lines.last, word].join(' ').length > 70
+    lines.last << word
+  end
+  lines.map { |line| "#{line.join(' ')}\n" }.join.freeze
+end
+
+output =
+  case config.format
+  when :chapters      then JSON.pretty_generate $article.chapters
+  when :gemtext       then $article.to_gemtext
+  when :html          then $article.to_html
+  when :summary_plain then wrap $article.to_summary_plain
+  when :word_count    then $article.word_count
+  end.to_s.strip
+
+puts output unless output.empty?

data/lib/repubmark/config.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Repubmark
+  class Config
+    OPTIONAL_KEYS = %i[
+      base_url
+      chapter_anchor_prefix
+      css_class_annotation
+      css_class_blockquote_figure
+      css_class_blockquote_blockquote
+      css_class_blockquote_figcaption
+      css_class_figure_self
+      css_class_figure_wrap
+      css_class_figures_left
+      css_class_figures_right
+      css_class_figures_wrap
+      css_class_iframe_wrap
+      current_path
+      images_prefix
+      relative_urls
+    ].freeze
+
+    attr_reader :format
+
+    def self.load_file(filename, profile)
+      config_data = YAML.safe_load_file filename, aliases: true
+      profile_data = config_data[profile]
+      raise 'Unknown profile' if profile_data.nil?
+
+      new(**profile_data.transform_keys(&:to_sym))
+    end
+
+    def initialize(format:, **kwargs)
+      self.format = format
+      raise unless (kwargs.keys - OPTIONAL_KEYS).empty?
+
+      @kwargs = kwargs.freeze
+    end
+
+    def [](key)
+      OPTIONAL_KEYS.include?(key) ? @kwargs[key] : @kwargs.fetch(key)
+    end
+
+  private
+
+    def format=(format)
+      format = format.to_sym if format.instance_of? String
+      raise 'Invalid format' unless FORMATS.include? format
+
+      @format = format
+    end
+  end
+end

data/lib/repubmark/elems/abbrev.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Repubmark
+  module Elems
+    class Abbrev < Base
+      parents :Joint
+
+      attr_reader :abbrev, :transcript
+
+      def initialize(parent, abbrev, transcript)
+        super parent
+
+        self.abbrev = abbrev
+        self.transcript = transcript
+      end
+
+      #################
+      # Basic methods #
+      #################
+
+      def word_count = 1
+
+      def to_summary_plain = abbrev
+
+      def to_html
+        %(<abbr title="#{escape_transcript}">#{escape_abbrev}</abbr>).freeze
+      end
+
+      def to_gemtext = abbrev
+
+    private
+
+      def abbrev=(abbrev)
+        @abbrev =
+          String(abbrev).split.join(' ').freeze.tap do |new_abbrev|
+            raise 'Empty string' if new_abbrev.empty?
+          end
+      end
+
+      def transcript=(transcript)
+        @transcript =
+          String(transcript).split.join(' ').freeze.tap do |new_transcript|
+            raise 'Empty string' if new_transcript.empty?
+          end
+      end
+
+      def escape_abbrev = CGI.escape_html(abbrev).freeze
+
+      def escape_transcript = CGI.escape_html(transcript).freeze
+    end
+  end
+end

data/lib/repubmark/elems/annotation.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Repubmark
+  module Elems
+    class Annotation < Base
+      parents :Article
+
+      def initialize(parent)
+        super parent
+        @canvas = Canvas.new self
+      end
+
+      #################
+      # Basic methods #
+      #################
+
+      def word_count = @canvas.word_count
+
+      def to_summary_plain = @canvas.to_summary_plain
+
+      def to_html
+        [
+          %(<div#{html_class(:annotation)}>\n),
+          @canvas.to_html,
+          "</div>\n",
+        ].join.freeze
+      end
+
+      def to_gemtext = @canvas.to_gemtext
+
+      ###################
+      # Builder methods #
+      ###################
+
+      def respond_to_missing?(method_name, _include_private)
+        @canvas.respond_to?(method_name) || super
+      end
+
+      def method_missing(method_name, ...)
+        if @canvas.respond_to? method_name
+          @canvas.public_send(method_name, ...)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/repubmark/elems/article.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Repubmark
+  module Elems
+    class Article < Base
+      attr_reader :config
+
+      def initialize(config) # rubocop:disable Lint/MissingSuper
+        @parent = nil
+        self.config = config
+        @footnotes_categories = []
+      end
+
+      #################
+      # Basic methods #
+      #################
+
+      def word_count
+        (@annotation&.word_count || 0) +
+          (@chapter&.word_count || 0)
+      end
+
+      def to_summary_plain
+        [
+          @annotation&.to_summary_plain,
+          @chapter&.to_summary_plain,
+        ].compact.join(' ').freeze
+      end
+
+      def to_html
+        [
+          @annotation&.to_html,
+          @chapter&.to_html,
+          @footnotes_categories.any? ? "<div>\n<hr/>\n" : nil,
+          *@footnotes_categories.map(&:to_html),
+          @footnotes_categories.any? ? "</div>\n" : nil,
+        ].compact.join.freeze
+      end
+
+      def to_gemtext
+        [
+          @annotation&.to_gemtext,
+          @chapter&.to_gemtext,
+          *@footnotes_categories.map(&:to_gemtext),
+        ].compact.join("\n\n\n").freeze
+      end
+
+      def chapters = @chapter&.chapters[:chapters] || [].freeze
+
+      ###################
+      # Builder methods #
+      ###################
+
+      def annotation
+        raise 'Annotation already exists' if @annotation
+        raise 'Annotation after chapters' if @chapter
+
+        @annotation = Annotation.new self
+        yield @annotation
+        nil
+      end
+
+      def respond_to_missing?(method_name, _include_private)
+        chapter = @chapter || Chapter.new(self)
+        chapter.respond_to?(method_name) || super
+      end
+
+      def method_missing(method_name, ...)
+        chapter = @chapter || Chapter.new(self)
+        if chapter.respond_to? method_name
+          @chapter = chapter
+          @chapter.public_send(method_name, ...)
+        else
+          super
+        end
+      end
+
+      def footnotes_category(name)
+        footnotes_category = FootnotesCategory.new self, name
+        @footnotes_categories << footnotes_category
+        yield footnotes_category
+        nil
+      end
+
+    private
+
+      def config=(config)
+        unless config.instance_of? Config
+          raise TypeError, "Expected #{Config}, got #{config.class}"
+        end
+
+        @config = config
+      end
+    end
+  end
+end

data/lib/repubmark/elems/base.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Repubmark
+  module Elems
+    class Base
+      attr_reader :parent
+
+      def initialize(parent)
+        self.parent = parent
+      end
+
+      #################
+      # Basic methods #
+      #################
+
+      def word_count = 0
+
+      def to_summary_plain = nil
+
+      def to_html
+        raise NotImplementedError, "#{self.class}#to_html"
+      end
+
+      def to_gemtext
+        raise NotImplementedError, "#{self.class}#to_gemtext"
+      end
+
+      ##################
+      # Helper methods #
+      ##################
+
+      def config = parent.config
+
+      class << self
+        def parents(*args)
+          if @parents
+            raise ArgumentError, 'Invalid args' unless args.empty?
+
+            return @parents
+          end
+
+          @parents = args.map { |arg| "#{Elems}::#{arg}".freeze }.to_a.freeze
+          nil
+        end
+
+        def parent?(klass)
+          unless klass.instance_of? Class
+            raise TypeError, "Expected #{Class}, got #{klass.class}"
+          end
+
+          parents.include? klass.name
+        end
+      end
+
+    private
+
+      def parent=(parent)
+        unless parent.is_a? Base
+          raise TypeError, "Expected #{Base}, got #{parent.class}"
+        end
+
+        unless self.class.parent? parent.class
+          raise TypeError,
+                "Expected #{self.class.parents.join(', ')}, got #{parent.class}"
+        end
+
+        @parent = parent
+      end
+
+      def own_url(path)
+        config[:relative_urls] ? relative_url(path) : absolute_url(path)
+      end
+
+      def absolute_url(path)
+        base_url = String(config[:base_url]).strip.freeze
+        raise 'Invalid base URL' if base_url.empty?
+
+        path = "/#{path}" unless path.start_with? '/'
+        "#{base_url}#{path}"
+      end
+
+      def relative_url(path)
+        current_path = String(config[:current_path]).strip.freeze
+        raise 'Invalid current path URL' if current_path.empty?
+
+        Pathname
+          .new(path)
+          .relative_path_from("/#{current_path}/..")
+          .to_s
+          .freeze
+      end
+
+      def html_class(key)
+        if (value = config[:"css_class_#{key}"])
+          %( class="#{value}").freeze
+        else
+          ''
+        end
+      end
+
+      def count_words(str) = str.split.count
+    end
+  end
+end

data/lib/repubmark/elems/blockquote.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Repubmark
+  module Elems
+    class Blockquote < Base
+      parents :Canvas
+
+      def initialize(parent)
+        super parent
+
+        @canvas = Canvas.new self
+        @caption = nil
+      end
+
+      #################
+      # Basic methods #
+      #################
+
+      def word_count = @canvas.word_count + (@caption&.word_count || 0)
+
+      def to_html
+        [
+          "<figure#{html_class(:blockquote_figure)}>\n",
+          "<blockquote#{html_class(:blockquote_blockquote)}>\n",
+          @canvas.to_html,
+          "</blockquote>\n",
+          caption_html,
+          "</figure>\n",
+        ].join.freeze
+      end
+
+      def to_gemtext
+        [
+          @canvas.to_gemtext.split("\n").map { |s| "> #{s}\n" }.join,
+          caption_gemtext,
+        ].join.freeze
+      end
+
+      ###################
+      # Builder methods #
+      ###################
+
+      def caption
+        @caption = Caption.new self
+        yield @caption
+        nil
+      end
+
+      def respond_to_missing?(method_name, _include_private)
+        @canvas.respond_to?(method_name) || super
+      end
+
+      def method_missing(method_name, ...)
+        if @canvas.respond_to? method_name
+          raise 'Paragraph after caption' unless @caption.nil?
+
+          @canvas.public_send(method_name, ...)
+        else
+          super
+        end
+      end
+
+    private
+
+      def caption_html
+        return if @caption.nil?
+
+        [
+          "<figcaption#{html_class(:blockquote_figcaption)}>\n",
+          @caption.to_html,
+          "</figcaption>\n",
+        ].join.freeze
+      end
+
+      def caption_gemtext
+        "#{@caption.to_gemtext}\n".freeze unless @caption.nil?
+      end
+    end
+  end
+end

data/lib/repubmark/elems/canvas.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Repubmark
+  module Elems
+    class Canvas < Base
+      parents :Annotation, :Blockquote, :Chapter
+
+      def initialize(parent)
+        super parent
+        @items = []
+      end
+
+      #################
+      # Basic methods #
+      #################
+
+      def word_count = @items.sum(&:word_count)
+
+      def to_summary_plain
+        return if @items.empty?
+
+        @items.filter_map(&:to_summary_plain).join(' ').freeze
+      end
+
+      def to_html
+        @items.map(&:to_html).join.freeze unless @items.empty?
+      end
+
+      def to_gemtext
+        @items.map(&:to_gemtext).join("\n").freeze unless @items.empty?
+      end
+
+      ###################
+      # Builder methods #
+      ###################
+
+      def blockquote
+        blockquote = Blockquote.new self
+        @items << blockquote
+        yield blockquote
+        nil
+      end
+
+      def code_block(*args, **kwargs)
+        code_block = CodeBlock.new self, *args, **kwargs
+        @items << code_block
+        nil
+      end
+
+      def iframe(*args, **kwargs)
+        iframe = Iframe.new self, *args, **kwargs
+        @items << iframe
+        nil
+      end
+
+      def links_list
+        list = List.new self, links: true, ordered: false
+        @items << list
+        yield list
+        nil
+      end
+
+      def nice_figure(name, alt)
+        figure = Figure.new self, name, alt
+        @items << figure
+        yield figure if block_given?
+        nil
+      end
+
+      def nice_figures
+        figures = Figures.new self
+        @items << figures
+        yield figures
+        nil
+      end
+
+      def olist
+        list = List.new self, links: false, ordered: true
+        @items << list
+        yield list
+        nil
+      end
+
+      def paragraph
+        paragraph = Paragraph.new self
+        @items << paragraph
+        yield paragraph
+        nil
+      end
+
+      def separator
+        @items << Separator.new(self)
+        nil
+      end
+
+      def ulist
+        list = List.new self, links: false, ordered: false
+        @items << list
+        yield list
+        nil
+      end
+    end
+  end
+end

data/lib/repubmark/elems/caption.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Repubmark
+  module Elems
+    class Caption < Base
+      include Joint::ForwardingBuilders
+
+      parents :Blockquote, :Figure, :Footnote, :ListItem, :Paragraph
+
+      def initialize(parent)
+        super parent
+        @items = []
+      end
+
+      #################
+      # Basic methods #
+      #################
+
+      def word_count = @items.sum(&:word_count)
+
+      def to_summary_plain
+        @items.map(&:to_summary_plain).join(' ').freeze unless @items.empty?
+      end
+
+      def to_html
+        return if @items.empty?
+
+        [
+          '<span>',
+          *@items.map(&:to_html),
+          '</span>',
+        ].map { |s| "#{s}\n" }.join.freeze
+      end
+
+      def to_gemtext
+        @items.map(&:to_gemtext).join(' ').strip.freeze unless @items.empty?
+      end
+
+      ##################
+      # Helper methods #
+      ##################
+
+      def empty? = @items.empty?
+
+      ###################
+      # Builder methods #
+      ###################
+
+      def joint
+        joint = Joint.new self
+        yield joint
+        @items << joint
+        nil
+      end
+
+      def quote(str = nil)
+        quote = Quote.new self
+        case [!!str, block_given?]
+        when [true, false] then quote.text str
+        when [false, true] then yield quote
+        else
+          raise 'Invalid args'
+        end
+        @items << quote
+        nil
+      end
+    end
+  end
+end