source2md 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ac00b7cc8674c792566d8d08c5d2f1b8f5cf755ceca1479b2ac8248ad6dac3e
-  data.tar.gz: e7c61a968ca24419cc5a62c86437388f77cd865895ac038a5565b1a4ab4c180d
+  metadata.gz: 4cbcbb886c48d226f8864af1134aa3c0bdac15dcb2adf2acfd8aadb1d9b62bcc
+  data.tar.gz: bdcdb4870afc49aeb7fbb20534a54ba44fd42bd9e1e56c2bb260babe46d9cb74
 SHA512:
-  metadata.gz: 25222fde61442a0fceba5daa0e0ff09e7343c0fcacf7123670d85ee66f3a4df50533ec40b211b851eea0870bf64f781b9dd283dc26650a1d7a004d27a95dd513
-  data.tar.gz: c89ccfdb613ee1a8fa95eef6a1524be3fe7534a2e5c2fd18fceba4895f87711febc078292f4b974c1ae7a525d75af8e2e528c10b59a55678c7f2730814776077
+  metadata.gz: 9fe4bde35b551e33b11a53a10df2941b3828eba7b5e91c470bae0001f26f95ab2ecb006183fb89384be8fe22d3f9b5c461917b1525e3f002800846f19ea2547a
+  data.tar.gz: ab48da56d8bf0b4ce3755432f9ed281dbceacf67a8cdbb4663b328f614c73bdcc1680a4e03675d8ba547ff638d054f2249644fca5f52c6812b3e17c6474b523c

data/README.md

@@ -1,3 +1,5 @@
+
+
 # Source2MD: Markdown generator from source code #
 
 ## Logic ##
@@ -75,6 +77,14 @@ puts Source2MD::Section.new(<<~EOS).to_md
 EOS
 ```
 
+```ruby
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+BEGIN_SRC hidden!
+  p "This paragraph is not displayed"
+  #+END_SRC
+EOS
+```
+
 ### Code include ###
 
 Insert inside the code block.
@@ -135,28 +145,6 @@ EOS
 ### Title Level 3 ###
 ```
 
-### Markdown style title ###
-
-The condition is that there are the same number of sharps on the back.
-
-```ruby
-puts Source2MD::Section.new(<<~EOS).to_md
-  # Title Level 1 #
-
-  ## Title Level 2 ##
-
-  ### Title Level 3 ###
-EOS
-```
-
-```
-# Title Level 1 #
-
-## Title Level 2 ##
-
-### Title Level 3 ###
-```
-
 ### Org-mode table style ###
 
 ```ruby

data/Rakefile

@@ -11,7 +11,7 @@ namespace :doc do
   task "generate" do
     Rake::Task["doc:renum"].execute
     system "sh", "-vec", <<~EOT, exception: true
-.bin/source2md generate --no-debug --no-xmp-out-exclude -o README.md doc/0*
+.bin/source2md generate --no-debug --xmp-out-exclude --prefix_re '^' -o README.md doc/0*
 EOT
   end
 

data/doc/0100_top.rb

@@ -1,24 +1,24 @@
 #+hidden: true
 require "./setup"
 
-# Source2MD: Markdown generator from source code #
+#+title1: Source2MD: Markdown generator from source code
 
-## Logic ##
+#+title2: Logic
 
 # 1. Divide the source code into paragraphs using blank lines as separations.
 # 1. Remove comments from the comment blocks.
 # 1. Include the code within the code block.
 
-## Install ##
+#+title2: Install
 
 # ```
 # $ gem i source2md
 # ```
 
-## CLI ##
+#+title2: CLI
 
 # ```
 # $ source2md generate -o README.md README.rb
 # ```
 
-## Rules ##
+#+title2: Rules

data/doc/0110_code_small.rb

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Code snippet ###
+#+title3: Code snippet
 
 # Separated by blank lines.
 
@@ -24,3 +24,13 @@ EOS
 # > ```ruby
 # > hello.call
 # > ```
+# >> ```ruby
+# >> hello = -> {
+# >>   "Hello, world!"
+# >> }
+# >> ```
+# >> 
+# >> 
+# >> ```ruby
+# >> hello.call
+# >> ```

data/doc/0120_code_long.rb

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Source block with many lines ###
+#+title3: Source block with many lines
 
 #+BEGIN_SRC
 puts Source2MD::Section.new(<<~EOS).to_md
@@ -22,3 +22,11 @@ EOS
 # >
 # > hello.call
 # > ```
+# >> ["/Users/ikeda/src/zenn/source2md/lib/source2md/scanner.rb:14", :to_a, /(?m-ix:(?-mix:(?-mix:^)(?:(?-mix:#|\/\/)))\+BEGIN_SRC.*?(?-mix:(?-mix:^)(?:(?-mix:#|\/\/)))\+END_SRC)|(?m-ix:.*?\R{2,})/]
+# >> ```ruby
+# >> hello = -> {
+# >>   "Hello, world!"
+# >> }
+# >> 
+# >> hello.call
+# >> ```

data/doc/0130_hidden.rb

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Hide paragraph ###
+#+title3: Hide paragraph
 
 #+BEGIN_SRC
 puts Source2MD::Section.new(<<~EOS).to_md
@@ -17,3 +17,5 @@ puts Source2MD::Section.new(<<~EOS).to_md
   #+END_SRC
 EOS
 #+END_SRC
+# >>
+# >>

data/doc/0140_code_include.rb

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Code include ###
+#+title3: Code include
 
 # Insert inside the code block.
 
@@ -24,3 +24,11 @@ EOS
 # > <p>Hello</p>
 # > ```
 # > ````
+# >> ```html:hello.html
+# >> <p>Hello</p>
+# >> ```
+# >> 
+# >> 
+# >> ```xml:OUTPUT
+# >> <p>Hello</p>
+# >> ```

data/doc/0150_raw_include.rb

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Raw include ###
+#+title3: Raw include
 
 #+BEGIN_SRC
 File.write("/tmp/hello.html", "<p>Hello</p>")
@@ -14,3 +14,4 @@ EOS
 # > ```
 # > <p>Hello</p>
 # > ```
+# >> <p>Hello</p>

data/doc/0160_title.rb

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Title ###
+#+title3: Title
 
 # No number limit.
 

data/doc/{0180_table.rb → 0170_table.rb}

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Org-mode table style ###
+#+title3: Org-mode table style
 
 #+BEGIN_SRC
 puts Source2MD::Section.new(<<~EOS).to_md

data/doc/{0190_method.rb → 0180_method.rb}

@@ -1,19 +1,19 @@
 #+hidden: true
 require "./setup"
 
-### Explain method simply ###
+#+title3: Explain method simply
 
 #+BEGIN_SRC
 puts Source2MD::Section.new(<<~EOS).to_md
   #+name: String#size
   #+desc: Return the number of characters
   #+comment: Comments about size
-  "abc".size                        # => 3
+  "abc".size  # => 3
 
   #+name: String#reverse
   #+desc: reverse the sequence of characters
   #+comment: Comments about reverse
-  "abc".reverse                   # => "cba"
+  "abc".reverse  # => "cba"
 EOS
 #+END_SRC
 

data/doc/{0200_alert.rb → 0190_alert.rb}

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Warning and Alert message ###
+#+title3: Warning and Alert message
 
 # Exclusive to Zenn
 
@@ -24,3 +24,10 @@ EOS
 # > this is alert message
 # > :::
 # > ```
+# >> :::message
+# >> this is warning message
+# >> :::
+# >> 
+# >> :::message alert
+# >> this is alert message
+# >> :::

data/doc/{0210_text.rb → 0200_text.rb}

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Raw Text ###
+#+title3: Raw Text
 
 # If no rule applies and the text begins with `#`, remove the `#`.
 
@@ -16,3 +16,5 @@ EOS
 # > Lorem ipsum dolor sit amet, consectetur adipisicing elit,
 # > sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 # > ```
+# >> Lorem ipsum dolor sit amet, consectetur adipisicing elit,
+# >> sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

data/doc/{0220_text_oneline.rb → 0210_text_oneline.rb}

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Oneline Text ###
+#+title3: Oneline Text
 
 # Using this option allows you to split a line regardless of the markdown library.
 
@@ -16,3 +16,4 @@ EOS
 # > ```
 # > Lorem ipsum dolor sit amet, consectetur adipisicing elit,sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 # > ```
+# >> Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

data/doc/{0230_text_squish.rb → 0220_text_squish.rb}

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Squish Text ###
+#+title3: Squish Text
 
 # Single spaces for line breaks and consecutive spaces.
 
@@ -16,3 +16,4 @@ EOS
 # > ```
 # > Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 # > ```
+# >> Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

data/doc/{0240_text_hankaku_kana.rb → 0230_text_hankaku_kana.rb}

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Hankaku Kana ###
+#+title3: Hankaku Kana
 
 # JISX0208 Katakana to JISX0201 Katakana.
 
@@ -13,3 +13,4 @@ EOS
 #+END_SRC
 
 # > ｱｱ
+# >> ｱｱ

data/doc/{0250_parse_include.rb → 0240_parse_include.rb}

@@ -1,7 +1,7 @@
 #+hidden: true
 require "./setup"
 
-### Parse include ###
+#+title3: Parse include
 
 # Paste the results of processing other files with the same rules.
 
@@ -16,3 +16,4 @@ EOS
 #+END_SRC
 
 # > foo
+# >> foo

data/doc/setup.rb

@@ -2,3 +2,6 @@ $LOAD_PATH.unshift("#{__dir__}/../lib")
 require "source2md"
 Source2MD.logger.level = :debug if false
 
+# Source2MD::RE.update do |e|
+#   e.prefix_re = %r{^}
+# end

data/lib/source2md/cli.rb

@@ -4,6 +4,8 @@ module Source2MD
     class_option :xmp_out_exclude, type: :boolean, aliases: "-x", default: false
     class_option :readonly,        type: :boolean, aliases: "-r", default: true
     class_option :default_lang,    type: :string,  aliases: "-l", default: "ruby"
+    class_option :prefix_re,       type: :string
+    class_option :comment_re,      type: :string
 
     def initialize(...)
       super
@@ -16,6 +18,15 @@ module Source2MD
       Source2MD.xmp_out_exclude = options[:xmp_out_exclude]
       Source2MD.readonly = options[:readonly]
       Source2MD.default_lang = options[:default_lang]
+
+      Source2MD::RE.update do |e|
+        if v = options[:prefix_re]
+          e.prefix_re = v
+        end
+        if v = options[:comment_re]
+          e.comment_re = v
+        end
+      end
     end
 
     # default_command :generate

data/lib/source2md/code_block.rb

@@ -1,7 +1,7 @@
 module Source2MD
   class CodeBlock
     PADDING_KEEP = 2
-    MARK         = %r{(?:#|//) =>}
+    ARROW_MARK         = %r{(?:#{RE.comment_re}) =>}
 
     def initialize(text, options = {})
       @text = text
@@ -45,15 +45,15 @@ module Source2MD
       # if @options[:single_sharp_replace_to_blank_line]
       #   line = single_sharp_replace_to_blank_line(line)
       # end
-      comment_mark_justfiy(line)
+      comment_re_justfiy(line)
     end
 
     # def single_sharp_replace_to_blank_line(line)
     #   line.gsub(/\A#\z/, "")
     # end
 
-    def comment_mark_justfiy(line)
-      line.gsub(/(.*?)\s*(#{MARK})(.*)/) {
+    def comment_re_justfiy(line)
+      line.gsub(/(.*?)\s*(#{ARROW_MARK})(.*)/) {
         a, b, c = Regexp.last_match.captures
         space = " " * (PADDING_KEEP + (max - a.size))
         [a, space, b, c].join
@@ -71,8 +71,8 @@ module Source2MD
     def max
       @max ||= yield_self do
         av = lines
-        av = av.find_all { |e| e.match?(MARK) }
-        av = av.collect { |e| e.gsub(/\s*#{MARK}.*\R/, "").size }
+        av = av.find_all { |e| e.match?(ARROW_MARK) }
+        av = av.collect { |e| e.gsub(/\s*#{ARROW_MARK}.*\R/, "").size }
         av.max
       end
     end

data/lib/source2md/element.rb

@@ -1,7 +1,5 @@
 module Source2MD
   class Element
-    KEY_VALUE_REGEXP = /^\s*(?:#|\/\/)\+(\S+):\s*(.*)\R?/ # #+key: value
-
     PLUGINS = [
       Formatter::TypeHidden,       # #+hidden: true
       Formatter::TypeCodeInclude,  # #+code_include: path/to/foo.html xml:SAMPLE.xml
@@ -29,11 +27,11 @@ module Source2MD
     end
 
     def head
-      @head ||= @content.scan(KEY_VALUE_REGEXP).to_h.freeze
+      @head ||= @content.scan(key_value_regexp).to_h.freeze
     end
 
     def body
-      @body ||= @content.remove(KEY_VALUE_REGEXP).freeze
+      @body ||= @content.remove(key_value_regexp).freeze
     end
 
     private
@@ -65,5 +63,10 @@ module Source2MD
         s.gsub(/^/, "> ")
       end
     end
+
+    # #+key: value
+    def key_value_regexp
+      /^#{RE.meta_re}\+(\S+):\s*(.*)\R?/
+    end
   end
 end

data/lib/source2md/formatter/type_method.rb

@@ -25,7 +25,7 @@ module Source2MD
       private
 
       def body
-        element.body.gsub(%r{(#|//)$}, "")
+        element.body.gsub(%r{(#{RE.comment_re})$}, "")
       end
     end
   end

data/lib/source2md/formatter/type_source_block.rb

@@ -2,7 +2,7 @@ module Source2MD
   module Formatter
     class TypeSourceBlock < Base
       def self.accept?(element)
-        element.body.match?(%r{(?:#|//)\+BEGIN_SRC})
+        element.body.match?(%r{#{RE.meta_re}\+BEGIN_SRC})
       end
 
       def to_md
@@ -15,11 +15,11 @@ module Source2MD
       private
 
       def body
-        element.body.match(%r{(?:#|//)\+BEGIN_SRC.*?\R(.*)(?:#|//)\+END_SRC}m).captures.first
+        element.body.match(%r{#{RE.meta_re}\+BEGIN_SRC.*?\R(.*)#{RE.meta_re}\+END_SRC}m).captures.first
       end
 
       def code_block_desc
-        if md = element.body.match(%r{(?:#|//)\+BEGIN_SRC (.+)\R})
+        if md = element.body.match(%r{#{RE.meta_re}\+BEGIN_SRC (.+)\R})
           md.captures.first
         end
       end

data/lib/source2md/formatter/type_table.rb

@@ -2,12 +2,12 @@ module Source2MD
   module Formatter
     class TypeTable < Base
       def self.accept?(element)
-        !element.body.empty? && element.body.lines.all? { |e| e.match?(%r{^\s*(#|//) \|.*\|$}) }
+        !element.body.empty? && element.body.lines.all? { |e| e.match?(%r{#{RE.meta_re} \|.*\|$}) }
       end
 
       def to_md
         element.body
-          .remove(%r{^\s*(#|//) })
+          .remove(%r{#{RE.meta_re} })
           .remove(/\A\|-.*?-\|\R/)  # top
           .remove(/^\|-.*?-\|\R\z/) # bottom
           .gsub(/-\+-/, "-|-")

data/lib/source2md/formatter/type_text.rb

@@ -3,7 +3,7 @@ module Source2MD
     class TypeText < Base
       # "# xxx"
       # "#"
-      REGEXP = %r{^\s*(?:#|//)( |$)}
+      REGEXP = %r{#{RE.meta_re}( |$)}
 
       def self.accept?(element)
         if element.body.present?

data/lib/source2md/re.rb

@@ -0,0 +1,3 @@
+module Source2MD
+  RE = RegexpBuilder.new
+end

data/lib/source2md/regexp_builder.rb

@@ -0,0 +1,33 @@
+module Source2MD
+  class RegexpBuilder
+    attr_accessor :prefix_re
+    attr_accessor :comment_re
+
+    def initialize
+      update do |e|
+        e.prefix_re  = %r{^\s*}
+        e.comment_re = %r{#|//}
+      end
+    end
+
+    def update(&block)
+      yield self
+      reset
+    end
+
+    def meta_re
+      @meta_re ||= %r{#{prefix_re}(?:#{comment_re})}
+    end
+
+    def stdout_re
+      @stdout_re ||= %r{^(?:#{comment_re}) >>.*$}
+    end
+
+    private
+
+    def reset
+      @meta_re = nil
+      @stdout_re = nil
+    end
+  end
+end

data/lib/source2md/scanner.rb

@@ -1,18 +1,5 @@
 module Source2MD
   class Scanner
-    SEPARATOR = "\\R{2,}"
-
-    SRC_BEGIN_KEY = "BEGIN_SRC"
-    SRC_END_KEY   = "END_SRC"
-    SRC_BLOCK_RE  = %r{^\s*(?:#|//)\+#{SRC_BEGIN_KEY}.*?^\s*(?:#|//)\+#{SRC_END_KEY}}m
-
-    NORMAL_BLOCK_RE = /.*?#{SEPARATOR}/m
-
-    PARAGRAPH_RE = Regexp.union [
-      SRC_BLOCK_RE,
-      NORMAL_BLOCK_RE,
-    ]
-
     def initialize(content)
       @content = content
     end
@@ -21,11 +8,29 @@ module Source2MD
       v = @content
       v = v.rstrip + "\n\n"
       if Source2MD.xmp_out_exclude
-        v = v.remove(%r{^(?:#|//) >>.*$})
+        v = v.remove(RE.stdout_re)
       end
-      v = v.scan(PARAGRAPH_RE)
+      v = v.scan(paragraph_re)
       v = v.collect { |e| e.rstrip + "\n" }
       v = v.find_all(&:present?)
     end
+
+    private
+
+    def paragraph_re
+      Regexp.union(src_block_re, normal_block_re)
+    end
+
+    def src_block_re
+      %r{#{RE.meta_re}\+BEGIN_SRC.*?#{RE.meta_re}\+END_SRC}m
+    end
+
+    def normal_block_re
+      /.*?#{separator}/m
+    end
+
+    def separator
+      "\\R{2,}"
+    end
   end
 end

data/lib/source2md/text_helper.rb

@@ -18,8 +18,8 @@ module Source2MD
       NKF.nkf("-wxZ4", text)
     end
 
-    def indent(text)
-      text.gsub(/^/, "  ")
+    def indent(text, size = 2)
+      text.gsub(/^/, " " * size)
     end
 
     def eol_enter(text)

data/lib/source2md/version.rb

@@ -1,3 +1,3 @@
 module Source2MD
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/source2md.rb

@@ -23,6 +23,7 @@ loader = Zeitwerk::Loader.for_gem
 loader.ignore("#{__dir__}/source2md/logger.rb")
 loader.ignore("#{__dir__}/source2md/**/_*.rb")
 loader.inflector.inflect("source2md" => "Source2MD")
+loader.inflector.inflect("re" => "RE")
 loader.log! if false
 loader.setup
 

data/spec/scanner_spec.rb

@@ -25,19 +25,3 @@ module Source2MD
     end
   end
 end
-# >> F
-# >> 
-# >> Failures:
-# >> 
-# >>   1) Source2MD::Scanner works
-# >>      Failure/Error: Unable to find - to read failed line
-# >>      Test::Unit::AssertionFailedError:
-# >>      # -:25:in `block (2 levels) in <module:Source2MD>'
-# >> 
-# >> Finished in 0.01112 seconds (files took 0.26074 seconds to load)
-# >> 1 example, 1 failure
-# >> 
-# >> Failed examples:
-# >> 
-# >> rspec -:5 # Source2MD::Scanner works
-# >> 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source2md
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Akira Ikeda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-12 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -155,15 +155,14 @@ files:
 - doc/0140_code_include.rb
 - doc/0150_raw_include.rb
 - doc/0160_title.rb
-- doc/0170_md_like_title.rb
-- doc/0180_table.rb
-- doc/0190_method.rb
-- doc/0200_alert.rb
-- doc/0210_text.rb
-- doc/0220_text_oneline.rb
-- doc/0230_text_squish.rb
-- doc/0240_text_hankaku_kana.rb
-- doc/0250_parse_include.rb
+- doc/0170_table.rb
+- doc/0180_method.rb
+- doc/0190_alert.rb
+- doc/0200_text.rb
+- doc/0210_text_oneline.rb
+- doc/0220_text_squish.rb
+- doc/0230_text_hankaku_kana.rb
+- doc/0240_parse_include.rb
 - doc/setup.rb
 - examples/cli-test.rs
 - examples/cli-test.sh
@@ -205,6 +204,8 @@ files:
 - lib/source2md/formatter/type_warn.rb
 - lib/source2md/generator.rb
 - lib/source2md/logger.rb
+- lib/source2md/re.rb
+- lib/source2md/regexp_builder.rb
 - lib/source2md/scanner.rb
 - lib/source2md/section.rb
 - lib/source2md/tasks/about.rake

data/doc/0170_md_like_title.rb

@@ -1,24 +0,0 @@
-#+hidden: true
-require "./setup"
-
-### Markdown style title ###
-
-# The condition is that there are the same number of sharps on the back.
-
-#+BEGIN_SRC
-puts Source2MD::Section.new(<<~EOS).to_md
-  # Title Level 1 #
-
-  ## Title Level 2 ##
-
-  ### Title Level 3 ###
-EOS
-#+END_SRC
-
-# ```
-# # Title Level 1 #
-#
-# ## Title Level 2 ##
-#
-# ### Title Level 3 ###
-# ```