darkmouun 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a03a06ad91e45c525cfbd4d383a96acad54e732d814363dba4a48a9e93564075
+  data.tar.gz: 0243d803cf79fcdf316175c089705cf91509ffcbc62e336e85534054769b90cd
+SHA512:
+  metadata.gz: 3e6416a73e0adb2d82cd736b977e7de7de535e5d081e19c61d2659f384b327cb490a5bb5e0453044768e4faef1b66b367181ff5fdc59375236c9873ee6af029f
+  data.tar.gz: 7319cfbb531f7135313633c014dc0cbe28f679f22ec57b653234427c15bffabd753f056da1e48b502d72a075a1a002e38fe82f657d3e3440b3b860c223d3bc45

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at akinori.ichigo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in darkmouun.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Akinori Ichigo
+
+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,114 @@
+# Darkmouun
+
+## Overview
+
+Darkmouun is the converter from a markdown text enhanced by [kramdown](https://github.com/gettalong/kramdown) to a HTML document.
+
+Darkmouun can define: 
+  * Pre-processing (to a markdown document)
+  * Extracting templates by Mustache
+  * Converting from markdown to HTML by kramdown
+  * Post-processing (to a HTML document)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'darkmouun'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install darkmouun
+
+## Usage
+
+Darkmouun.document.new takes 3 arguments.
+
+* 1st arg: Target Markdown file name
+* 2nd arg: Kramdown's parser option (cf. [kramdown's usage](https://kramdown.gettalong.org/documentation.html#usage))
+* 3rd arg: Kramdown's converter name(ex. if converter class name is ItlHtml, converter name is to_itl_html.)
+
+2nd and 3rd argument has default value. 
+
+* 2nd arg: {}
+* 3rd arg: to_html
+
+(Darkmouun instance).convert makes a HTML document from the target markdown document.
+
+You can define pre_process and post_process as a Proc object.
+
+```
+dkmn = Darkmouun.document.new("MARKDOWN DOCUMENT", {:auto_ids => false})
+dkmn.pre_process = lambda do |i|
+  i.gsub!(/MARKDOWN/, "Markdown")
+end
+dkmn.post_process = lambda do |i|
+  i.gsub!(/DOCUMENT/, "Document")
+end
+dkmn.convert  #=> "<p>Markdown Document</p>
+```
+
+You can write the parts that Mustache extracts with templates in your markdown document.
+Template is written as Ruby script, and it is made to define as the subclass of Mustache class.
+
+The part of template extacting in the markdown document starts '<<template_name>>'.
+Parameters of the template are written below with YAML format.
+
+```
+# Template file 'template_a.rb'
+
+class Template_A < Mustache
+  Template = <<EOS
+'<p>{{fig1}} + {{fig2}}' is {{calc}}.</p>
+EOS
+
+def calc
+  (fig1.to_i + fig2.to_i).to_s
+end
+```
+
+```
+# converting code
+
+dkmn = Darkmouun.document.new(<<BODY, {:auto_ids => false, :input => 'sekd'}, :se_html)
+The calculation:
+
+<<Template_A>>
+fig1: 1
+fig2: 2
+BODY
+
+dkmn.add_templates "#{__dir__}/templates/",  # 1st arg is the directory of templates.
+                   'template_a.rb'           # 2nd or later args are the files of templates.
+
+dkmn.convert    #=> <p>The Calculation:</p>
+                    <p>1 + 2 is 3.</p>
+```
+
+## kramdown extensions
+
+Darkmouun has extended to kramdown. Extensions are below;
+
+1. **Plain Span element form.** `[[spanned phrase]]` is converted to `<span>spanned phrase</span>`.
+
+2. **Style attribute abbreviation form.** `%attritute_name:value;` in IAL is converted to `style="attribute_name:value;"`.<br/>**ex.** `{:%color:#ffffff; %font-weight:bold;}` -> `style="color:#ffffff; font-weight:bold;"`<br/>**ATTENSION:** Every attribute must be started from "`%`" and ended with "`;`".
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Darkmouun project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/darkmouun/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "darkmouun"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/darkmouun.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/darkmouun/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "darkmouun"
+  spec.version       = Darkmouun::VERSION
+  spec.authors       = ["Akinori Ichigo"]
+  spec.email         = ["akinori.ichigo@gmail.com"]
+
+  spec.summary       = %q{The Processting tool from Markdown to HTML}
+  spec.description   = %q{Darkmouun converts Markdown document to HTML by processing of pre, Mustache template, Kramdown, and post.}
+  spec.homepage      = "https://github.com/akinori-ichigo/darkmouun"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/akinori-ichigo/darkmouun"
+  spec.metadata["changelog_uri"] = "https://github.com/akinori-ichigo/darkmouun"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "mustache"
+  spec.add_runtime_dependency "kramdown"
+  spec.add_runtime_dependency "htmlbeautifier"
+end

data/lib/darkmouun.rb

@@ -0,0 +1,7 @@
+require "darkmouun/version"
+require "darkmouun/main"
+
+module Darkmouun
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/darkmouun/converter/span.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# copyright (c) 2017 akinori ichigo <akinori.ichigo@gmail.com>
+
+require 'kramdown/parser'
+require 'kramdown/converter'
+require 'kramdown/utils'
+
+module Kramdown
+  module Converter
+    class Html
+      def convert_span(el, indent)
+        format_as_span_html('span', el.attr, inner(el, indent))
+      end
+    end
+  end
+end
+

data/lib/darkmouun/main.rb

@@ -0,0 +1,117 @@
+require "mustache"
+require "Kramdown"
+require "htmlbeautifier"
+
+require "darkmouun/version"
+require "darkmouun/parser/extensions"
+require "darkmouun/parser/span"
+require "darkmouun/converter/span"
+
+module Kramdown
+  module Parser
+    class Kramdown
+      alias_method :super_initialize, :initialize
+      def initialize(source, options)
+        super_initialize(source, options)
+        @span_parsers.insert(5, :span)
+      end
+    end
+  end
+end
+
+module Darkmouun
+  class << self
+    def document
+      Darkmouun
+    end
+  end
+
+  class Darkmouun
+    attr_accessor :pre_process, :post_process
+  
+    def initialize(source, options ={}, converter = :html)
+      @source, @options = source, options
+      @templates = {}
+      begin
+        @converter = case converter
+        when String
+          ('to_' + converter).intern
+        when Symbol
+          ('to_' + (converter.to_s)).intern
+        else
+          Exception.new "Invalid converter: Neither Symbol nor String"
+        end
+      rescue => e
+        p e
+      end
+    end
+
+    def add_templates(dir, *tmpls)
+      # for Mustache
+      tmpls.each do |tmpl|
+        abs_path = dir + tmpl
+        tmpl_module = Module.new
+        tmpl_module.module_eval(File.read(abs_path), abs_path)
+        tmpl_module.constants.each do |i|
+          c = tmpl_module.const_get(i)
+          if c.is_a?(Class) && c.superclass == Mustache
+            @templates[i] = c
+          end
+        end
+      end
+    end
+
+    def convert
+      do_pre_process
+      apply_mustache
+      apply_kramdown
+      do_post_process
+      beautify
+    end
+
+    private
+
+    def do_pre_process
+      begin
+        @pre_process.call(@source) unless @pre_process.nil?
+      rescue => e
+        raise e.class.new("\n#{e.message}\n\n>>> ERROR in \"Pre-process\" <<<\n")
+      end
+    end
+
+    def apply_mustache
+      begin
+      @source = @source.gsub(/<<(.+?)>>\n((?:[# \-]*[\w_][\w\d_]*: *\n?(?: +.+\n)+)+)/) do |s|
+        obj_spot_template, data = (@templates[$1.to_sym]).new, $2
+        YAML.load_stream(data).compact.reduce(&:merge).each do |k, v|
+          obj_spot_template.define_singleton_method(k){ v }
+        end
+        obj_spot_template.render + "\n"
+      end
+      rescue => e
+        raise e.class.new("\n#{e.message}\n\n>>> ERROR in \"Mustache-process\" <<<\nMaybe, incorrect tags of the template exist.\n")
+      end
+    end
+
+    def apply_kramdown
+      begin
+        @result = Kramdown::Document.new(@source, @options).send(@converter)
+      rescue => e
+        raise e.class.new("\n#{e.message}\n\n>>> ERROR in \"kramdown-process\" <<<\n")
+      end
+    end
+
+    def do_post_process
+      begin
+        @post_process.call(@result) unless @post_process.nil?
+      rescue => e
+        raise e.class.new("\n#{e.message}\n\n>>> ERROR in \"Post-process\" <<<\n")
+      end
+    end
+
+    def beautify
+      HtmlBeautifier.beautify(@result)
+    end
+  
+  end
+end

data/lib/darkmouun/parser/extensions.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2017 Akinori Ichigo <akinori.ichigo@gmail.com>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+require 'kramdown'
+
+module Kramdown
+  module Parser
+    class Kramdown
+
+      # Parse the string +str+ and extract all attributes and add all found attributes to the hash
+      # +opts+.
+      def parse_attribute_list(str, opts)
+        return if str.strip.empty? || str.strip == ':'
+        style_attr = []
+        attrs = str.scan(ALD_TYPE_ANY)
+        attrs.each do |key, sep, val, style_key, style_val, ref, id_and_or_class, _, _|
+          if ref
+            (opts[:refs] ||= []) << ref
+          elsif id_and_or_class
+            id_and_or_class.scan(ALD_TYPE_ID_OR_CLASS).each do |id_attr, class_attr|
+              if class_attr
+                opts[IAL_CLASS_ATTR] = (opts[IAL_CLASS_ATTR] || '') << " #{class_attr}"
+                opts[IAL_CLASS_ATTR].lstrip!
+              else
+                opts['id'] = id_attr
+              end
+            end
+          elsif style_key
+            style_attr << (style_key + style_val)
+          else
+            val.gsub!(/\\(\}|#{sep})/, "\\1")
+            if /\Astyle\Z/i =~ key
+              style_attr << val
+            else
+              opts[key] = val
+            end
+          end
+        end
+        (opts['style'] = style_attr.join(' ')) unless style_attr.empty?
+        warning("No or invalid attributes found in IAL/ALD content: #{str}") if attrs.length == 0
+      end
+
+      ALD_TYPE_STYLE_ATTR = /%(#{ALD_ID_NAME}:)\s*?((?:\\\}|\\;|[^\};])*?;)/
+      remove_const(:ALD_TYPE_ANY)
+      ALD_TYPE_ANY = /(?:\A|\s)(?:#{ALD_TYPE_KEY_VALUE_PAIR}|#{ALD_TYPE_STYLE_ATTR}|#{ALD_TYPE_REF}|#{ALD_TYPE_ID_OR_CLASS_MULTI})(?=\s|\Z)/
+
+    end
+  end
+end

data/lib/darkmouun/parser/span.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2016 Akinori Ichigo <akinori.ichigo@gmail.com>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+module Kramdown
+  module Parser
+    class Kramdown
+
+      SPAN_START = /(?:\[\[\s*?)/
+
+      # Parse the span at the current location.
+      def parse_span
+        start_line_number = @src.current_line_number
+        saved_pos = @src.save_pos
+
+        result = @src.scan(SPAN_START)
+        stop_re = /(?:\s*?\]\])/
+
+         el = Element.new(:span, nil, nil, :location => start_line_number)
+         found = parse_spans(el, stop_re) do
+           el.children.size > 0
+         end
+
+        if found
+          @src.scan(stop_re)
+          @tree.children << el
+        else
+          @src.revert_pos(saved_pos)
+          @src.pos += result.length
+          add_text(result)
+        end
+      end
+      define_parser(:span, SPAN_START, '\[\[')
+
+    end
+  end
+end

data/lib/darkmouun/version.rb

@@ -0,0 +1,3 @@
+module Darkmouun
+  VERSION = "1.0.4"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: darkmouun
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- Akinori Ichigo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  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: kramdown
+  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: htmlbeautifier
+  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: Darkmouun converts Markdown document to HTML by processing of pre, Mustache
+  template, Kramdown, and post.
+email:
+- akinori.ichigo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- darkmouun.gemspec
+- lib/darkmouun.rb
+- lib/darkmouun/converter/span.rb
+- lib/darkmouun/main.rb
+- lib/darkmouun/parser/extensions.rb
+- lib/darkmouun/parser/span.rb
+- lib/darkmouun/version.rb
+homepage: https://github.com/akinori-ichigo/darkmouun
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/akinori-ichigo/darkmouun
+  source_code_uri: https://github.com/akinori-ichigo/darkmouun
+  changelog_uri: https://github.com/akinori-ichigo/darkmouun
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: The Processting tool from Markdown to HTML
+test_files: []