darkmouun 2.3.1 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18e60e63115fa16c943c12ab684572fbdadcf8087975a7be15d422fd1abab503
-  data.tar.gz: 79410c4037b034be36ccee577e96ad0a5180341ef92987d6e536f18f214cd4e5
+  metadata.gz: f1f747aca75fc9d719bba0a265cb00e2f0553ca97036911220e16034d670d6e1
+  data.tar.gz: 9b724d1ede773105c88e8743fd2e8d21f9143518a051badfbaa8d5479e1c9d92
 SHA512:
-  metadata.gz: 6c30cc898f302d5a7bc056995e4d23c971381ae42e6970248e01b09dd884d0dc5dd764c22121d7d450bbc393c9a66d07678ca96dabaa61ffd5d5a881ba83a1ac
-  data.tar.gz: 71e422c0a231683e1a129d89576dce4fddd9351b25372cb28708d05dbb80300893f201c50820637615b64222030a77eb1e0720bd68b47e75bcd540eb19613e30
+  metadata.gz: 6a4ea8e3cf385d928031a8c102830d35f32c3a05781124e7d3dfa239d6f177180f91a0f2d0f2779ff35a3a722c4f50ad18e6a4386a068b57f79c0e79f64ecdc1
+  data.tar.gz: 8a3b41bafe2be12d659a69286e33df1c2584293ffbad412f568a592a8f4e81845fe93212f6a7f468f376f745c0a8831683dfeaf05310ed5cbde5349bca0c8492

data/README.md

@@ -28,40 +28,40 @@ Or install it yourself as:
 
 ## Usage
 
-Darkmouun.document.new takes 3 arguments.
+Darkmouun instance is made by `Darkmouun.document.new` with no 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.)
+(Darkmouun instance)`.convert` makes a HTML document from the markdown text and takes 3 arguments.
 
-2nd and 3rd argument has default value. 
+* 1st arg: Markdown text (String)
+* 2nd arg: Kramdown's parser option (Hash) (cf. [kramdown's usage](https://kramdown.gettalong.org/documentation.html#usage))
+* 3rd arg: Kramdown's converter name (Symbol)
 
-* 2nd arg: {}
-* 3rd arg: to_html
+2nd and 3rd argument have default values. 
 
-(Darkmouun instance).convert makes a HTML document from the target markdown document.
+* 2nd arg: `{}`
+* 3rd arg: `:to_html`
 
-You can define pre_process and post_process as a Proc object.
+You can define pre_process and post_process as Proc object.
 
 ```
-dkmn = Darkmouun.document.new("MARKDOWN DOCUMENT", {:auto_ids => false})
+dkmn = Darkmouun.document.new
 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>
+dkmn.convert("MARKDOWN DOCUMENT")  #=> "<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>>'.
+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'
+# Template file 'templates/template_a.rb'
 
 class Template_A < Mustache
   Template = <<EOS
@@ -76,19 +76,16 @@ end
 ```
 # converting code
 
-dkmn = Darkmouun.document.new(<<BODY, {:auto_ids => false, :input => 'sekd'}, :se_html)
+dkmn = Darkmouun.document.new
+dkmn.add_template("#{__dir__}/templates/template_a.rb")
+dkmn.convert(<<BODY)
 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>
+BODY    #=> <p>The Calculation:</p>
+        #=> <p>1 + 2 is 3.</p>
 ```
 
 ## kramdown extensions

data/lib/darkmouun/main.rb

@@ -16,31 +16,27 @@ module Darkmouun
   class Darkmouun
     attr_accessor :pre_process, :post_process
   
-    def initialize(source, options ={}, converter = :html)
-      @source, @options = source, options
+    def initialize
       @templates = {}
-      @converter = ('to_' + (converter.to_s)).intern
     end
 
-    def add_templates(dir, *tmpls)
+    def add_template(tmpl)
       # 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
+      tmpl_module = Module.new
+      tmpl_module.module_eval(File.read(tmpl), tmpl)
+      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
 
-    def convert
+    def convert(source, options = {}, converter = :to_html)
+      @source = source
       do_pre_process
       apply_mustache
-      apply_kramdown
+      apply_kramdown(options, converter)
       do_post_process
       beautify
     end
@@ -69,9 +65,9 @@ module Darkmouun
       end
     end
 
-    def apply_kramdown
+    def apply_kramdown(options, converter)
       begin
-        @result = Kramdown::Document.new(@source, @options).send(@converter)
+        @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

data/lib/darkmouun/version.rb

@@ -1,3 +1,3 @@
 module Darkmouun
-  VERSION = "2.3.1"
+  VERSION = "3.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darkmouun
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 3.1.1
 platform: ruby
 authors:
 - Akinori Ichigo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-11 00:00:00.000000000 Z
+date: 2023-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler