booklab-sml 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb84a4a2755b03fb16c63b38f4ab28f43da86969d804ee410b7528a2583253c6
-  data.tar.gz: 8f295eb84d47b6e55cc93b63b4ce86d518b699137fc214062ecfe53fef27ada7
+  metadata.gz: f40ffbae208235a1dfafa968aa9816198027175749c37b846133c4c90d1e0579
+  data.tar.gz: e47ff7a87045859d6d78ad591651e1e0c92f2ca3d9f745c1c71cd47971910962
 SHA512:
-  metadata.gz: 13025c837e41198f0135b212d24e55728a97ca481dcc36f797d8e46e6d9bc455ac289128a7f4ead66e39d87297abd172077bc3be2e2d593d7d22b88a228f24d1
-  data.tar.gz: 290ffa8e82198cdcc2a8a35f34070b0e23d3711e993ab38a6869149b4201d02474ec30336425a5f8852eeef5afe0cacdc70b1207148c84ea91fb5e524d1ce887
+  metadata.gz: 2826b2f592c86982df5694b1fb8deaf788d0639facc2bd67a956b7028f1621d73dcc1c686df6b54676afbfa27029c53b0f220a7a224e0e898060e289d9723381
+  data.tar.gz: 50fe6bdd5bbfbb946b3c543f2359f34c82b43f68b9b091c3517b25a50cf54cbab75018087e38dbc0e53c08f37c3d888a74f9ce40e698aac9ce8f1a382170e670

data/Rakefile

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Jsonml'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Jsonml"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

data/lib/booklab/sml/base.rb

@@ -4,38 +4,9 @@ require "yaml"
 
 module BookLab
   module SML
-    def self.parse(src, out = StringIO.new)
-      ml = YAML.load(src)
-      parse_node(ml).string
+    def self.parse(src, options = {})
+      renderer = Renderer.new(src, options)
+      renderer.to_html
     end
-
-    private
-
-      # base code from: https://github.com/blambeau/jsonml-rb
-      def self.parse_node(src, out = StringIO.new)
-        has_attrs   = src[1].is_a?(Hash)
-        first_child = has_attrs ? 2 : 1
-
-        case src
-        when Array
-          out << "<#{src.first}"
-          out << " " << attrs2html(src[1]) if has_attrs
-          out << ">"
-          src[first_child..-1].each { |child| parse_node(child, out) }
-          out << "</#{src.first}>"
-        when String
-          out << src
-        else
-          raise "Unexpected node `#{src}`"
-        end
-      end
-
-      def self.attrs2html(attrs)
-        attrs.each_pair.map { |pair| attr2html(*pair) }.join(" ")
-      end
-
-      def self.attr2html(key, value)
-        %(#{key}="#{value}")
-      end
   end
 end

data/lib/booklab/sml/config.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module BookLab::SML
+  class Config
+    attr_accessor :plantuml_service_host
+    attr_accessor :mathjax_service_host
+  end
+end

data/lib/booklab/sml/renderer.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext"
+
+module BookLab::SML
+  class Renderer
+    include BookLab::SML::Utils
+
+    attr_accessor :sml, :config
+
+    def initialize(sml, options)
+      @sml = sml
+      @config = Config.new
+      @config.plantuml_service_host = options[:plantuml_service_host]
+      @config.mathjax_service_host = options[:mathjax_service_host]
+    end
+
+    def to_html
+      node_to_html(YAML.load(sml))
+    end
+
+    def node_to_html(node, opts = {})
+      opts[:renderer] = self
+
+      rule = BookLab::SML::Rules::find_by_node(node)
+      rule.to_html(node, opts)
+    end
+
+    def children_to_html(node)
+      return node if node.is_a?(String)
+
+      children = self.class.get_children(node)
+      children.each_with_index.map do |child, idx|
+        prev_node = idx > 0 ? children[idx - 1] : nil
+        next_node = idx < children.length ? children[idx + 1] : nil
+
+        node_to_html(child)
+      end.join("")
+    end
+  end
+end

data/lib/booklab/sml/rules/base.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "escape_utils"
+
+module BookLab::SML::Rules
+  class SyntaxError < Exception; end
+
+  class Base
+    include BookLab::SML::Utils
+
+    class << self
+      include EscapeUtils
+    end
+
+
+    def self.match?(node)
+      false
+    end
+
+    def self.to_html(node, opts = {})
+      children = opts[:renderer].children_to_html(node)
+      tag = tag_name(node)
+      %(<#{tag}>#{children}</#{tag}>)
+    end
+
+    protected
+
+      def self.styleize(style)
+        style.map { |k, v| "#{k}: #{v};" }.join(" ")
+      end
+  end
+end

data/lib/booklab/sml/rules/blockquote.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Blockquote < Base
+    def self.match?(node)
+      tag_name(node) == "blockquote"
+    end
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      attrs = attributes(node)
+
+      children = renderer.children_to_html(node)
+
+      %(<blockquote>#{children}</blockquote>)
+    end
+  end
+end

data/lib/booklab/sml/rules/br.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Br < Base
+    def self.match?(node)
+      tag_name(node) == "br"
+    end
+
+    def self.to_html(node, opts = {})
+      %(<br>)
+    end
+  end
+end

data/lib/booklab/sml/rules/codeblock.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rouge"
+require "rouge/plugins/redcarpet"
+
+module BookLab::SML::Rules
+  class Codeblock < Base
+    class << self
+      include Rouge::Plugins::Redcarpet
+    end
+
+    def self.match?(node)
+      tag_name(node) == "codeblock"
+    end
+
+    def self.to_html(node, opts = {})
+      attrs = attributes(node)
+
+      language = attrs[:language]
+      code = attrs[:code]
+
+      block_code(code, language)
+    end
+  end
+end

data/lib/booklab/sml/rules/file.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class File < Base
+    class << self
+      include ActiveSupport::NumberHelper
+    end
+
+    def self.match?(node)
+      tag_name(node) == "file"
+    end
+
+    def self.to_html(node, opts = {})
+      attrs = attributes(node)
+
+      return attrs[:name] if attrs[:src].blank?
+
+      humanize_size = number_to_human_size(attrs[:size] || 0)
+
+      out = <<~HTML
+      <a class="attachment-file" title="#{attrs[:name]}" target="_blank" href="#{attrs[:src]}">
+        <span class="icon-box"><i class="fas fa-file"></i></span>
+        <span class="filename">#{escape_html(attrs[:name])}</span>
+        <span class="filesize">#{escape_html(humanize_size)}</span>
+      </a>
+      HTML
+
+      out
+    end
+  end
+end

data/lib/booklab/sml/rules/heading.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Heading < Base
+    def self.match?(node)
+      %w[h1 h2 h3 h4 h5 h6].include?(tag_name(node))
+    end
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      title = renderer.children_to_html(node)
+      heading_tag = tag_name(node)
+      %(<#{heading_tag}>#{title}</#{heading_tag}>)
+    end
+  end
+end

data/lib/booklab/sml/rules/hr.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Hr < Base
+    def self.match?(node)
+      tag_name(node) == "hr"
+    end
+
+    def self.to_html(node, opts = {})
+      %(<hr>)
+    end
+  end
+end

data/lib/booklab/sml/rules/image.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Image < Base
+    def self.match?(node)
+      tag_name(node) == "image"
+    end
+
+    def self.to_html(node, opts = {})
+      attrs = attributes(node)
+
+      return attrs[:name] if attrs[:src].blank?
+
+      html_attrs = {
+        src: attrs[:src],
+        alt: attrs[:name],
+        width: attrs[:width],
+        height: attrs[:height]
+      }
+
+      attr_html = html_attrs.map { |k, v| v.present? ? %(#{k}="#{v}") : nil }.compact.join(" ")
+      %(<img #{attr_html}>)
+    end
+  end
+end

data/lib/booklab/sml/rules/link.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Link < Base
+    def self.match?(node)
+      tag_name(node) == "link"
+    end
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      attrs = attributes(node)
+      name = renderer.children_to_html(node)
+      return name if attrs[:href].blank?
+
+      %(<a href="#{attrs[:href]}" title="#{attrs[:title]}">#{name}</a>)
+    end
+  end
+end

data/lib/booklab/sml/rules/list.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class List < Base
+    def self.match?(node)
+      tag_name(node) == "list"
+    end
+
+    INDENT_PX = 8
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      attrs    = attributes(node)
+      children = renderer.children_to_html(node)
+
+      # Normal paragraph data
+      text_align  = attrs[:align] || "left"
+      indent      = attrs[:indent]
+      text_indent = indent && indent[:firstline]
+      indent_left = indent ? indent[:left] : 0
+
+      # List style
+      nid       = attrs[:nid]
+      list_type = attrs[:type] || "bulleted"
+      level     = attrs[:level] || 1
+      num       = attrs[:num] || 1
+      pstyle    = attrs[:pstyle] || "paragraph"
+
+      wrap_tag = attrs[:type] == "bulleted" ? "ul" : "ol"
+      item_tag = "li"
+
+      case pstyle
+      when "paragraph" then item_tag = "p"
+      when "heading1" then item_tag = "h1"
+      when "heading2" then item_tag = "h2"
+      else item_tag = "p"
+      end
+
+      style = {
+        "text-align": text_align,
+        "text-indent": text_indent ? "#{4 * INDENT_PX}px" : "0px",
+        "padding-left": "#{indent_left * INDENT_PX}px"
+      }.map { |k, v| "#{k}: #{v};" }.join(" ")
+
+      outs = []
+      if opts[:prev] && tag_name(opts[:prev]) != "list"
+        outs << %(<#{wrap_tag} style="#{style}">)
+      end
+
+      outs << %(<li>#{children}</li>)
+
+      if opts[:next] && tag_name(opts[:next]) != "list"
+        outs << "</#{wrap_tag}>"
+      end
+      outs.join("")
+    end
+  end
+end

data/lib/booklab/sml/rules/math.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Math < Base
+    def self.match?(node)
+      tag_name(node) == "math"
+    end
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      attrs = attributes(node)
+
+      svg_code = URI::encode(attrs[:code])
+      src = "#{renderer.config.mathjax_service_host}/svg?tex=#{svg_code}"
+
+      %(<img class="tex-image" src="#{src}">)
+    end
+  end
+end

data/lib/booklab/sml/rules/paragraph.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Paragraph < Base
+    def self.match?(node)
+      tag_name(node) == "p"
+    end
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      children = renderer.children_to_html(node)
+      %(<p>#{children}</p>)
+    end
+  end
+end

data/lib/booklab/sml/rules/plantuml.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Plantuml < Base
+    def self.match?(node)
+      tag_name(node) == "plantuml"
+    end
+
+    def self.to_html(node, opts = {})
+      attrs = attributes(node)
+      renderer = opts[:renderer]
+
+      svg_code = URI::encode((attrs[:code] || "").strip)
+      %(<img src="#{renderer.config.plantuml_service_host}/svg/#{svg_code}" class="plantuml-image" />)
+    end
+  end
+end

data/lib/booklab/sml/rules/root.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Root < Base
+    def self.match?(node)
+      tag_name(node) == "root"
+    end
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      renderer.children_to_html(node)
+    end
+  end
+end

data/lib/booklab/sml/rules/span.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Span < Base
+    def self.match?(node)
+      return false unless tag_name(node) == "span"
+      attrs = attributes(node)
+      attrs[:t] == 1
+    end
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      renderer.children_to_html(node)
+    end
+  end
+end

data/lib/booklab/sml/rules/span_with_mark.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class SpanWithMark < Base
+    MARKS = {
+      cd: ["<code>", "</code>"],
+      b: ["<strong>", "</strong>"],
+      i: ["<em>", "</em>"],
+      s: ["<del>", "</del>"],
+      u: ["<u>", "</u>"],
+      mt: ["$", "$"],
+      m: ["==", "=="],
+      sup: ["<sup>", "</sup>"],
+      sub: ["<sub>", "</sub>"],
+    }
+
+
+    def self.match?(node)
+      return false unless tag_name(node) == "span"
+      attrs = attributes(node)
+      attrs[:t] == 0
+    end
+
+    def self.to_html(node, opts = {})
+      attrs = attributes(node)
+      renderer = opts[:renderer]
+      children = renderer.children_to_html(node)
+
+      case attrs[:va]
+      when "superscript" then attrs[:sup] = 1
+      when "subscript" then attrs[:sub] = 1
+      end
+
+      MARKS.each_key do |key|
+        if attrs[key] == 1
+          mark = MARKS[key]
+          children = "#{mark.first}#{children}#{mark.last}"
+        end
+      end
+
+      children
+    end
+  end
+end

data/lib/booklab/sml/rules/table.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Table < Base
+    def self.match?(node)
+      tag_name(node) == "table"
+    end
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      children = renderer.children_to_html(node)
+
+      %(<table>#{children}</table>)
+    end
+  end
+end

data/lib/booklab/sml/rules/td.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Td < Base
+    def self.match?(node)
+      tag_name(node) == "tc"
+    end
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      attrs = attributes(node)
+      children = renderer.children_to_html(node)
+
+      style = {}
+      if attrs[:align]
+        style["text-align"] = attrs[:align]
+      end
+
+      style_attrs = ""
+      if style.any?
+        style_attrs = %( style="#{styleize(style)}")
+      end
+
+      %(<td#{style_attrs}>#{children}</td>)
+    end
+  end
+end

data/lib/booklab/sml/rules/text.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Text < Base
+    def self.match?(node)
+      node.is_a?(String)
+    end
+
+    def self.to_html(node, opts = {})
+      node
+    end
+  end
+end

data/lib/booklab/sml/rules/tr.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module BookLab::SML::Rules
+  class Tr < Base
+    def self.match?(node)
+      tag_name(node) == "tr"
+    end
+
+    def self.to_html(node, opts = {})
+      renderer = opts[:renderer]
+      attrs = attributes(node)
+      children = renderer.children_to_html(node)
+
+      %(<tr>#{children}</tr>)
+    end
+  end
+end

data/lib/booklab/sml/rules.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BookLab::SML
+  module Rules
+    def self.all
+      return @rules if defined? @rules
+      rules = []
+      Dir.glob(::File.expand_path("rules/*.rb", __dir__)).each do |path|
+        require path
+        rule_name = ::File.basename(path, ".rb")
+        next if rule_name == "base"
+        rules << "BookLab::SML::Rules::#{rule_name.classify}".constantize
+      end
+      @rules = rules
+      @rules
+    end
+
+    def self.find_by_node(node)
+      all.find { |rule| rule.match?(node) } || BookLab::SML::Rules::Base
+    end
+  end
+end

data/lib/booklab/sml/utils.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BookLab::SML
+  module Utils
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def get_children(node)
+        has_attributes?(node) ? node[2..-1] : node[1..-1]
+      end
+
+      def tag_name(node)
+        node[0] || ""
+      end
+
+      def attributes(node, add_if_mission:  false)
+        return node[1].deep_symbolize_keys if has_attributes?(node)
+        return nil unless add_if_mission
+
+        name = node.shift || ""
+        attrs = {}
+        node.unshift(attrs)
+        node.unshift(name)
+
+        attrs
+      end
+
+      def has_attributes?(node)
+        raise "Invalid SML format:\n#{node.inspect}" unless element?(node)
+        attributes?(node[1])
+      end
+
+      def attributes?(node)
+        return false if node.nil?
+        node.is_a?(Hash)
+      end
+
+      def element?(node)
+        node.is_a?(Array) && node[0].is_a?(String)
+      end
+    end
+  end
+end

data/lib/booklab/sml/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module BookLab
   module SML
-    VERSION = '0.1.0'
+    VERSION = "0.2.0"
   end
 end

data/lib/booklab-sml.rb

@@ -1,7 +1,15 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
 require "booklab/sml/version"
+require "booklab/sml/rules"
+require "booklab/sml/config"
+require "booklab/sml/utils"
+require "booklab/sml/renderer"
 require "booklab/sml/base"
 
+
 module BookLab
   module SML
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: booklab-sml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-20 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !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: escape_utils
+  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: "*SML* is a document format base on [JsonML](http://jsonml.org)."
 email:
 - huacnlee@gmail.com
@@ -36,6 +64,30 @@ files:
 - Rakefile
 - lib/booklab-sml.rb
 - lib/booklab/sml/base.rb
+- lib/booklab/sml/config.rb
+- lib/booklab/sml/renderer.rb
+- lib/booklab/sml/rules.rb
+- lib/booklab/sml/rules/base.rb
+- lib/booklab/sml/rules/blockquote.rb
+- lib/booklab/sml/rules/br.rb
+- lib/booklab/sml/rules/codeblock.rb
+- lib/booklab/sml/rules/file.rb
+- lib/booklab/sml/rules/heading.rb
+- lib/booklab/sml/rules/hr.rb
+- lib/booklab/sml/rules/image.rb
+- lib/booklab/sml/rules/link.rb
+- lib/booklab/sml/rules/list.rb
+- lib/booklab/sml/rules/math.rb
+- lib/booklab/sml/rules/paragraph.rb
+- lib/booklab/sml/rules/plantuml.rb
+- lib/booklab/sml/rules/root.rb
+- lib/booklab/sml/rules/span.rb
+- lib/booklab/sml/rules/span_with_mark.rb
+- lib/booklab/sml/rules/table.rb
+- lib/booklab/sml/rules/td.rb
+- lib/booklab/sml/rules/text.rb
+- lib/booklab/sml/rules/tr.rb
+- lib/booklab/sml/utils.rb
 - lib/booklab/sml/version.rb
 homepage: https://github.com/huacnlee/booklab-sml
 licenses:
@@ -56,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: SML is a document format base on JsonML