source2md 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a69cc0fff709a6adfac13be6784fb107d230200b6797391dfd2c970fab4f48ca
-  data.tar.gz: 14168fb1b130a4112eb08c4408d6c4bc84b70e5db1b53889201d2c5094343d32
+  metadata.gz: 2ac00b7cc8674c792566d8d08c5d2f1b8f5cf755ceca1479b2ac8248ad6dac3e
+  data.tar.gz: e7c61a968ca24419cc5a62c86437388f77cd865895ac038a5565b1a4ab4c180d
 SHA512:
-  metadata.gz: c539724001175e52377e62c132ed15d622fdc854dfc02b20f6aa6018bc108044832c9bd2617f9c198ff3261c70fc2876da0004a9b862c462d0af3b5b32f39148
-  data.tar.gz: 12fc867c80e7012e8199264fd7c7c2c90d1a0c6e3ead297317deceaeca66b83176fc23389b2803bf060383341b7a5c2321cb90c2da121d73d6db6806fa36ac26
+  metadata.gz: 25222fde61442a0fceba5daa0e0ff09e7343c0fcacf7123670d85ee66f3a4df50533ec40b211b851eea0870bf64f781b9dd283dc26650a1d7a004d27a95dd513
+  data.tar.gz: c89ccfdb613ee1a8fa95eef6a1524be3fe7534a2e5c2fd18fceba4895f87711febc078292f4b974c1ae7a525d75af8e2e528c10b59a55678c7f2730814776077

data/examples/cli-test.rs

@@ -1,3 +1,6 @@
-  a
-    b
-  c
+    //+name: (name)
+    //+desc: (desc)
+    //+comment: (comment)
+    1;                          // => 1
+    //
+    2;                          // => 2

data/examples/cli-test.sh

@@ -1,2 +1,2 @@
 #!/bin/sh
-source2md generate -d a.rs
+../.bin/source2md generate -d cli-test.rs

data/lib/source2md/cli.rb

@@ -2,7 +2,8 @@ module Source2MD
   class Cli < Thor
     class_option :debug,           type: :boolean, aliases: "-d", default: false
     class_option :xmp_out_exclude, type: :boolean, aliases: "-x", default: false
-    class_option :readonly,        type: :boolean, default: true
+    class_option :readonly,        type: :boolean, aliases: "-r", default: true
+    class_option :default_lang,    type: :string,  aliases: "-l", default: "ruby"
 
     def initialize(...)
       super
@@ -14,8 +15,7 @@ module Source2MD
 
       Source2MD.xmp_out_exclude = options[:xmp_out_exclude]
       Source2MD.readonly = options[:readonly]
-
-      tp Source2MD.config
+      Source2MD.default_lang = options[:default_lang]
     end
 
     # default_command :generate

data/lib/source2md/code_block.rb

@@ -1,24 +1,22 @@
 module Source2MD
   class CodeBlock
     PADDING_KEEP = 2
-    MARK         = /(?:#|\/\/) =>/
+    MARK         = %r{(?:#|//) =>}
 
-    attr_accessor :code
-
-    def initialize(code, options = {})
-      @code = code
+    def initialize(text, options = {})
+      @text = text
       @options = {
-        :lang => "ruby",
+        :lang => nil,
         # :single_sharp_replace_to_blank_line => false,
       }.merge(options)
     end
 
     def to_md
       [
-        "```#{code_block_head}",
+        "```#{code_block_head}\n",
         normalized_code,
-        "```",
-      ] * "\n"
+        "```\n",
+      ].join
     end
 
     private
@@ -28,7 +26,7 @@ module Source2MD
       if s = @options[:desc]
         o << s
       else
-        if s = @options[:lang]
+        if s = lang
           o << s
         end
         if s = @options[:name]
@@ -40,17 +38,14 @@ module Source2MD
     end
 
     def normalized_code
-      lines.collect(&method(:normalize)) * "\n"
+      lines.collect(&method(:normalize)).join
     end
 
     def normalize(line)
       # if @options[:single_sharp_replace_to_blank_line]
       #   line = single_sharp_replace_to_blank_line(line)
       # end
-      if @options[:lang] == "ruby"
-        line = comment_mark_justfiy(line)
-      end
-      line
+      comment_mark_justfiy(line)
     end
 
     # def single_sharp_replace_to_blank_line(line)
@@ -66,24 +61,24 @@ module Source2MD
     end
 
     def raw_lines
-      @raw_lines ||= code.lines.collect(&:rstrip)
+      @raw_lines ||= @text.lines
     end
 
     def lines
-      @lines ||= yield_self do
-        min = raw_lines.collect { |e| e.slice(/^\s*/).size }.min
-        re = /^\s{#{min}}/
-        raw_lines.collect { |e| e.remove(re) }
-      end
+      @lines ||= TextHelper.space_prefix_remove(@text).lines
     end
 
     def max
       @max ||= yield_self do
         av = lines
         av = av.find_all { |e| e.match?(MARK) }
-        av = av.collect { |e| e.gsub(/\s*#{MARK}.*/, "").size }
+        av = av.collect { |e| e.gsub(/\s*#{MARK}.*\R/, "").size }
         av.max
       end
     end
+
+    def lang
+      @options[:lang] || ENV["DEFAULT_LANG"] || Source2MD.default_lang
+    end
   end
 end

data/lib/source2md/element.rb

@@ -1,10 +1,9 @@
 module Source2MD
   class Element
-    KEY_VALUE_REGEXP = /^(?:#|\/\/)\+(\S+):\s*(.*)\R?/ # #+key: value
+    KEY_VALUE_REGEXP = /^\s*(?:#|\/\/)\+(\S+):\s*(.*)\R?/ # #+key: value
 
     PLUGINS = [
       Formatter::TypeHidden,       # #+hidden: true
-      Formatter::TypeMdTitle,      # ## foo ##
       Formatter::TypeCodeInclude,  # #+code_include: path/to/foo.html xml:SAMPLE.xml
       Formatter::TypeRawInclude,   # #+raw_include: path/to/file.txt
       Formatter::TypeParseInclude, # #+parse_include: path/to/file.txt
@@ -34,13 +33,21 @@ module Source2MD
     end
 
     def body
-      @body ||= @content.remove(KEY_VALUE_REGEXP).rstrip.freeze
+      @body ||= @content.remove(KEY_VALUE_REGEXP).freeze
     end
 
     private
 
     def support_klass
-      @support_klass ||= PLUGINS.find { |e| e.accept?(self) }
+      @support_klass ||= yield_self do
+        Source2MD.logger.debug { "head: #{head.inspect}" }
+        Source2MD.logger.debug { "body: #{body.inspect}" }
+        PLUGINS.find do |e|
+          e.accept?(self).tap do |result|
+            Source2MD.logger.debug { "#{e} => #{result}" }
+          end
+        end
+      end
     end
 
     def debug_log(object)

data/lib/source2md/formatter/type_code_include.rb

@@ -22,7 +22,7 @@ module Source2MD
       end
 
       def body
-        path.read.strip
+        TextHelper.eol_enter(path.read)
       end
 
       def code_block_options

data/lib/source2md/formatter/type_method.rb

@@ -6,18 +6,26 @@ module Source2MD
       end
 
       def to_md
-        [
-          "### #{element.head["name"]} ###",
-          element.head["desc"],
-          CodeBlock.new(body).to_md,
-          element.head["comment"],
-        ].compact * "\n\n"
+        o = []
+        o << "### #{element.head["name"]} ###\n"
+        if v = element.head["desc"]
+          o << "\n"
+          o << v + "\n"
+          o << "\n"
+        end
+        o << CodeBlock.new(body).to_md
+        if v = element.head["comment"]
+          o << "\n"
+          o << v + "\n"
+          o << "\n"
+        end
+        o.join
       end
 
       private
 
       def body
-        element.body.gsub(/^\#$/, "")
+        element.body.gsub(%r{(#|//)$}, "")
       end
     end
   end

data/lib/source2md/formatter/{type_md_title.rb → type_nop.rb}

@@ -1,12 +1,12 @@
 module Source2MD
   module Formatter
-    class TypeMdTitle < Base
+    class TypeNop < Base
       def self.accept?(element)
-        element.head.blank? && element.body.match?(/\A(#+)\s+.*\s+\1\z/)
+        element.head["nop"]
       end
 
       def to_md
-        element.body
+        ""
       end
     end
   end

data/lib/source2md/formatter/type_raw_include.rb

@@ -6,7 +6,8 @@ module Source2MD
       end
 
       def to_md
-        Pathname(element.head["raw_include"]).expand_path.read.strip
+        s = Pathname(element.head["raw_include"]).expand_path.read
+        TextHelper.eol_enter(s)
       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.start_with?("#+BEGIN_SRC")
+        element.body.match?(%r{(?:#|//)\+BEGIN_SRC})
       end
 
       def to_md
@@ -15,12 +15,12 @@ module Source2MD
       private
 
       def body
-        element.body.match(/#\+BEGIN_SRC.*?\R(.*)#\+END_SRC/m).captures.first.strip
+        element.body.match(%r{(?:#|//)\+BEGIN_SRC.*?\R(.*)(?:#|//)\+END_SRC}m).captures.first
       end
 
       def code_block_desc
-        if md = element.body.match(/#\+BEGIN_SRC(.+)/)
-          md.captures.first.strip
+        if md = element.body.match(%r{(?:#|//)\+BEGIN_SRC (.+)\R})
+          md.captures.first
         end
       end
 

data/lib/source2md/formatter/type_table.rb

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

data/lib/source2md/formatter/type_text.rb

@@ -3,10 +3,12 @@ module Source2MD
     class TypeText < Base
       # "# xxx"
       # "#"
-      REGEXP = /^#( |$)/
+      REGEXP = %r{^\s*(?:#|//)( |$)}
 
       def self.accept?(element)
-        element.body.lines.all? { |e| e.match?(REGEXP) }
+        if element.body.present?
+          element.body.lines.all? { |e| e.match?(REGEXP) }
+        end
       end
 
       def to_md
@@ -26,7 +28,7 @@ module Source2MD
         if element.head["hankaku_kana"] == "true"
           s = TextHelper.hankaku_kana(s)
         end
-        s
+        TextHelper.eol_enter(s)
       end
     end
   end

data/lib/source2md/generator.rb

@@ -26,7 +26,7 @@ module Source2MD
     def to_md
       s = sections.collect(&:to_md) * "\n\n"
       s = TextHelper.blank_lines_squish(s)
-      s = TextHelper.add_newline_at_end_of_text(s)
+      s = TextHelper.eol_enter(s)
     end
 
     private

data/lib/source2md/scanner.rb

@@ -4,7 +4,7 @@ module Source2MD
 
     SRC_BEGIN_KEY = "BEGIN_SRC"
     SRC_END_KEY   = "END_SRC"
-    SRC_BLOCK_RE  = /^#\+#{SRC_BEGIN_KEY}.*?^#\+#{SRC_END_KEY}/m
+    SRC_BLOCK_RE  = %r{^\s*(?:#|//)\+#{SRC_BEGIN_KEY}.*?^\s*(?:#|//)\+#{SRC_END_KEY}}m
 
     NORMAL_BLOCK_RE = /.*?#{SEPARATOR}/m
 
@@ -19,12 +19,12 @@ module Source2MD
 
     def to_a
       v = @content
+      v = v.rstrip + "\n\n"
       if Source2MD.xmp_out_exclude
-        v = v.remove(/^# >>.*$/)
+        v = v.remove(%r{^(?:#|//) >>.*$})
       end
-      v = v + "\n\n"
       v = v.scan(PARAGRAPH_RE)
-      v = v.collect(&:rstrip)
+      v = v.collect { |e| e.rstrip + "\n" }
       v = v.find_all(&:present?)
     end
   end

data/lib/source2md/text_helper.rb

@@ -6,10 +6,6 @@ module Source2MD
       text.gsub(/\n{3,}/, "\n\n")
     end
 
-    def add_newline_at_end_of_text(text)
-      text.strip + "\n"
-    end
-
     def oneline(text)
       text.remove(/\R+/)
     end
@@ -21,5 +17,18 @@ module Source2MD
     def hankaku_kana(text)
       NKF.nkf("-wxZ4", text)
     end
+
+    def indent(text)
+      text.gsub(/^/, "  ")
+    end
+
+    def eol_enter(text)
+      text.rstrip + "\n"
+    end
+
+    def space_prefix_remove(text)
+      min = text.lines.reject(&:blank?).collect { |e| e.slice(/^\s*/).size }.min
+      text.remove(/^ {#{min}}/)
+    end
   end
 end

data/lib/source2md/version.rb

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

data/lib/source2md.rb

@@ -15,6 +15,7 @@ module Source2MD
   config_accessor(:debug) { false }
   config_accessor(:xmp_out_exclude) { false }
   config_accessor(:readonly) { true }
+  config_accessor(:default_lang) { "ruby" }
 end
 
 require "zeitwerk"

data/spec/code_block_spec.rb

@@ -9,7 +9,8 @@ module Source2MD
         bb   # => 2
         cccc
       EOS
-      s.should == <<~EOS.strip
+
+      s.should == <<~EOS
         ```ruby
         a   # => 1
         #

data/spec/formatter/type_code_include_spec.rb

@@ -6,7 +6,7 @@ module Source2MD
       actual = Element.new(<<~EOS).to_md
 #+code_include: #{__dir__}/sample.yml
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 ```yml:sample.yml
 (yaml)
 ```
@@ -19,7 +19,7 @@ EOS
 #+lang: (lang)
 #+name: (name)
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 ```(lang):(name)
 (yaml)
 ```
@@ -30,7 +30,7 @@ EOS
       actual = Element.new(<<~EOS).to_md
 #+code_include: #{__dir__}/sample.yml yaml:filename
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 ```yaml:filename
 (yaml)
 ```

data/spec/formatter/type_method_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 module Source2MD
   describe do
     it "works" do
-      actual = Element.new(<<~EOS).to_md
+      actual = Element.new(TextHelper.indent(<<~EOS)).to_md
 #+name: (name)
 #+desc: (desc)
 #+comment: (comment)
@@ -11,7 +11,7 @@ module Source2MD
 #
 (code2)
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 ### (name) ###
 
 (desc)
@@ -23,6 +23,7 @@ EOS
 ```
 
 (comment)
+
       EOS
     end
   end

data/spec/formatter/type_partial_code_spec.rb

@@ -6,7 +6,7 @@ module Source2MD
       actual = Element.new(<<~EOS).to_md
 (foo)
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 ```ruby
 (foo)
 ```

data/spec/formatter/type_raw_include_spec.rb

@@ -6,7 +6,7 @@ module Source2MD
       actual = Element.new(<<~EOS).to_md
 #+raw_include: #{__dir__}/sample.yml
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 (yaml)
       EOS
     end

data/spec/formatter/type_source_block_spec.rb

@@ -8,7 +8,7 @@ module Source2MD
       (foo)
       #+END_SRC
       EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 ```ruby
 (foo)
 ```
@@ -21,7 +21,7 @@ module Source2MD
       (foo)
       #+END_SRC
       EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 ```diff xxx:yyy
 (foo)
 ```

data/spec/formatter/type_table_spec.rb

@@ -11,7 +11,7 @@ module Source2MD
 # | d | d | d |
 # |---+---+---|
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 | h | h | h |
 |---|---|---|
 | d | d | d |
@@ -25,7 +25,7 @@ EOS
 # |---+---+---|
 # | d | d | d |
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 | h | h | h |
 |---|---|---|
 | d | d | d |

data/spec/formatter/type_text_spec.rb

@@ -3,11 +3,12 @@ require "spec_helper"
 module Source2MD
   describe do
     it "works" do
+      # Source2MD.logger.level = :debug
       actual = Element.new(<<~EOS).to_md
 # - foo
 #   http://example.com/
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 - foo
   http://example.com/
 EOS
@@ -22,7 +23,7 @@ EOS
 # c
 # d
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 abcd
 EOS
     end
@@ -36,7 +37,7 @@ EOS
 # c
 # d
 EOS
-      actual.should == <<~EOS.strip
+      actual.should == <<~EOS
 a b c d
 EOS
     end
@@ -46,7 +47,7 @@ EOS
 #+hankaku_kana: true
 # ｱア
 EOS
-      actual.should == "ｱｱ"
+      actual.should == "ｱｱ\n"
     end
   end
 end

data/spec/scanner_spec.rb

@@ -21,13 +21,23 @@ module Source2MD
       foo
       EOS
 
-      ary                       # => ["foo", "#+BEGIN_SRC\n\nfoo\n\n#+END_SRC", "foo", "#+BEGIN_SRC\nfoo\n#+END_SRC", "foo"]
-      assert { ary == ["foo", "#+BEGIN_SRC\n\nfoo\n\n#+END_SRC", "foo", "#+BEGIN_SRC\nfoo\n#+END_SRC", "foo"] }
+      assert { ary == ["foo\n", "#+BEGIN_SRC\n\nfoo\n\n#+END_SRC\n", "foo\n", "#+BEGIN_SRC\nfoo\n#+END_SRC\n", "foo\n"] }
     end
   end
 end
-# >> .
+# >> F
 # >> 
-# >> Finished in 0.00793 seconds (files took 0.26816 seconds to load)
-# >> 1 example, 0 failures
+# >> 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
 # >> 

data/spec/text_helper_spec.rb

@@ -6,14 +6,18 @@ module Source2MD
       assert { TextHelper.blank_lines_squish("A\nB\n\nC\n\n\nD") == "A\nB\n\nC\n\nD" }
     end
 
-    it "add_newline_at_end_of_text" do
-      assert { TextHelper.add_newline_at_end_of_text("A") == "A\n"     }
-      assert { TextHelper.add_newline_at_end_of_text("A\n") == "A\n"   }
-      assert { TextHelper.add_newline_at_end_of_text("A\n\n") == "A\n" }
+    it "eol_enter" do
+      assert { TextHelper.eol_enter("A") == "A\n"     }
+      assert { TextHelper.eol_enter("A\n\n") == "A\n" }
     end
 
     it "hankaku_kana" do
       assert { TextHelper.hankaku_kana("ｱア") == "ｱｱ" }
     end
+
+    it "space_prefix_remove" do
+      assert { TextHelper.space_prefix_remove(" a\n  b\n") == "a\n b\n" }
+      assert { TextHelper.space_prefix_remove(" a\n\n  b\n") == "a\n\n b\n" }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source2md
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Akira Ikeda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-09 00:00:00.000000000 Z
+date: 2023-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -177,7 +177,6 @@ files:
 - examples/type_alert.rb
 - examples/type_code_include.rb
 - examples/type_hidden.rb
-- examples/type_md_title.rb
 - examples/type_method.rb
 - examples/type_partial_code.rb
 - examples/type_source_block.rb
@@ -194,8 +193,8 @@ files:
 - lib/source2md/formatter/type_code_include.rb
 - lib/source2md/formatter/type_else.rb
 - lib/source2md/formatter/type_hidden.rb
-- lib/source2md/formatter/type_md_title.rb
 - lib/source2md/formatter/type_method.rb
+- lib/source2md/formatter/type_nop.rb
 - lib/source2md/formatter/type_parse_include.rb
 - lib/source2md/formatter/type_partial_code.rb
 - lib/source2md/formatter/type_raw_include.rb
@@ -219,7 +218,6 @@ files:
 - spec/formatter/type_alert_spec.rb
 - spec/formatter/type_code_include_spec.rb
 - spec/formatter/type_hidden_spec.rb
-- spec/formatter/type_md_title_spec.rb
 - spec/formatter/type_method_spec.rb
 - spec/formatter/type_parse_include_spec.rb
 - spec/formatter/type_partial_code_spec.rb
@@ -261,7 +259,6 @@ test_files:
 - spec/formatter/type_alert_spec.rb
 - spec/formatter/type_code_include_spec.rb
 - spec/formatter/type_hidden_spec.rb
-- spec/formatter/type_md_title_spec.rb
 - spec/formatter/type_method_spec.rb
 - spec/formatter/type_parse_include_spec.rb
 - spec/formatter/type_partial_code_spec.rb

data/examples/type_md_title.rb

@@ -1,15 +0,0 @@
-#+hidden: true
-require "./setup"
-
-puts Source2MD::Element.new(<<~EOS).to_md
-## foo ##
-EOS
-# >> > -------------------------------------------------------------------------------- Source2MD::Part::TypeMdTitle
-# >> > {}
-# >> > ------------------------------------------------------------ in
-# >> > ## foo ##
-# >> >
-# >> > ------------------------------------------------------------ out
-# >> > ## foo ##
-# >> > ------------------------------------------------------------
-# >> ## foo ##

data/spec/formatter/type_md_title_spec.rb

@@ -1,14 +0,0 @@
-require "spec_helper"
-
-module Source2MD
-  describe do
-    it "works" do
-      actual = Element.new(<<~EOS).to_md
-## foo ##
-EOS
-      actual.should == <<~EOS.strip
-## foo ##
-      EOS
-    end
-  end
-end