source2md 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f98cf52536b132ac7b8a7ed2b99653c0b1c668c0d3b7bd3681e898854fa00b8a
-  data.tar.gz: e78fa6dbddfefd98ee5757ca3f41911568df9825c332e1e1453e0df3ff0d7b7f
+  metadata.gz: afa045b32f44c8f86747fe720921365b18caa5a510f35dd7b093962ade54aa8e
+  data.tar.gz: ebdd255858fb73a60ef6ff8df6a89d3a72d6310c8667a1927ca3a6808c437d91
 SHA512:
-  metadata.gz: a9844d91a277c17f86037ab84efbf5b1f0bcd627fbb00ef16188f19b0e90716b0d7402644b7b60f5975919d7b194851d762463b93a7a50461e09b1eb5459d95f
-  data.tar.gz: 8d18aeff6e37f72c9c18c8187d64a62e9078cd534e280ef4c165a99c973f6bf079a610b57d86d8fe9d2b7abc8143ce7a9acbedbce2f710dcb537467358acddf4
+  metadata.gz: 360f9e298762344eb35bc92622bdba1b434edc3ee487cdf91f3a35f8f7240c0a99fd9c35a6e44daba531520e3b06ad31e87a4558db86c0582016e196eb4e1b7c
+  data.tar.gz: cfa3e532bd2297f1493752dff9037c73fbd11e3bcc668ea206b016c550229e2fd0f5096c9c453cb31721c632d7ad0db8d2b4516f8e3540d4045d42c5f064b320

data/examples/type_code_block.rb

@@ -0,0 +1,41 @@
+#+hidden: true
+require "./setup"
+
+puts Source2MD::Element.new(<<~EOS).to_md
+# ```
+# foo
+# ```
+EOS
+
+# >> head: {}
+# >> body: "# ```\n# foo\n# ```\n"
+# >> Source2MD::Formatter::TypeHidden => false
+# >> Source2MD::Formatter::TypeEval =>
+# >> Source2MD::Formatter::TypeCodeInclude =>
+# >> Source2MD::Formatter::TypeRawInclude =>
+# >> Source2MD::Formatter::TypeParseInclude =>
+# >> Source2MD::Formatter::TypeTitle => false
+# >> Source2MD::Formatter::TypeWarn =>
+# >> Source2MD::Formatter::TypeAlert =>
+# >> Source2MD::Formatter::TypeMethod =>
+# >> Source2MD::Formatter::TypeTable => false
+# >> Source2MD::Formatter::TypeSourceBlock => false
+# >> Source2MD::Formatter::TypeMdHeader =>
+# >> Source2MD::Formatter::TypeCodeBlock => true
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeCodeBlock
+# >> > {}
+# >> > ------------------------------------------------------------ in
+# >> > # ```
+# >> > # foo
+# >> > # ```
+# >> >
+# >> >
+# >> > ------------------------------------------------------------ out
+# >> > ```
+# >> > foo
+# >> > ```
+# >> >
+# >> > ------------------------------------------------------------
+# >> ```
+# >> foo
+# >> ```

data/examples/type_code_include.rb

@@ -3,23 +3,29 @@ require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
 
-#+code_include: input.yml
+#+code_include: input.yml ruby:abc (AC)
 #+name:
 
 EOS
+# >> head: {"code_include"=>"input.yml ruby:abc (AC)", "name"=>""}
+# >> body: ""
+# >> Source2MD::Formatter::TypeHidden => false
+# >> Source2MD::Formatter::TypeEval => 
+# >> Source2MD::Formatter::TypeCodeInclude => input.yml ruby:abc (AC)
 # >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeCodeInclude
-# >> > {"code_include"=>"input.yml", "name"=>""}
+# >> > {"code_include"=>"input.yml ruby:abc (AC)", "name"=>""}
 # >> > ------------------------------------------------------------ in
 # >> > 
 # >> > 
 # >> > ------------------------------------------------------------ out
-# >> > ```yml:
+# >> > ```ruby:abc (AC)
 # >> > ---
 # >> > one:
 # >> >   foo: 1
 # >> > ```
+# >> > 
 # >> > ------------------------------------------------------------
-# >> ```yml:
+# >> ```ruby:abc (AC)
 # >> ---
 # >> one:
 # >>   foo: 1

data/examples/type_inline_image.rb

@@ -0,0 +1,40 @@
+#+hidden: true
+require "./setup"
+
+puts Source2MD::Element.new(<<~EOS).to_md
+# ![](https://example.com/image.png)
+# **(alt)**
+EOS
+
+# >> head: {}
+# >> body: "# ![](https://example.com/image.png)\n# **(alt)**\n"
+# >> Source2MD::Formatter::TypeHidden => false
+# >> Source2MD::Formatter::TypeEval => 
+# >> Source2MD::Formatter::TypeCodeInclude => 
+# >> Source2MD::Formatter::TypeRawInclude => 
+# >> Source2MD::Formatter::TypeParseInclude => 
+# >> Source2MD::Formatter::TypeTitle => false
+# >> Source2MD::Formatter::TypeWarn => 
+# >> Source2MD::Formatter::TypeAlert => 
+# >> Source2MD::Formatter::TypeMethod => 
+# >> Source2MD::Formatter::TypeTable => false
+# >> Source2MD::Formatter::TypeSourceBlock => false
+# >> Source2MD::Formatter::TypeMdHeader => 
+# >> Source2MD::Formatter::TypeCodeBlock => false
+# >> Source2MD::Formatter::TypeQuote => 
+# >> Source2MD::Formatter::TypeList => false
+# >> Source2MD::Formatter::TypeInlineImage => # ![]
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeInlineImage
+# >> > {}
+# >> > ------------------------------------------------------------ in
+# >> > # ![](https://example.com/image.png)
+# >> > # **(alt)**
+# >> > 
+# >> > 
+# >> > ------------------------------------------------------------ out
+# >> > ![](https://example.com/image.png)
+# >> > **(alt)**
+# >> > 
+# >> > ------------------------------------------------------------
+# >> ![](https://example.com/image.png)
+# >> **(alt)**

data/examples/type_md_header.rb

@@ -0,0 +1,43 @@
+#+hidden: true
+require "./setup"
+
+puts Source2MD::Element.new(<<~EOS).to_md
+# ---
+# foo: bar
+# ---
+EOS
+
+# >> head: {}
+# >> body: "# ---\n# foo: bar\n# ---\n"
+# >> Source2MD::Formatter::TypeHidden => false
+# >> Source2MD::Formatter::TypeEval =>
+# >> Source2MD::Formatter::TypeCodeInclude =>
+# >> Source2MD::Formatter::TypeRawInclude =>
+# >> Source2MD::Formatter::TypeParseInclude =>
+# >> Source2MD::Formatter::TypeTitle => false
+# >> Source2MD::Formatter::TypeWarn =>
+# >> Source2MD::Formatter::TypeAlert =>
+# >> Source2MD::Formatter::TypeMethod =>
+# >> Source2MD::Formatter::TypeTable => false
+# >> Source2MD::Formatter::TypeSourceBlock => false
+# >> Source2MD::Formatter::TypeMdHeader => # ---
+# >> # foo: bar
+# >> # ---
+# >>
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeMdHeader
+# >> > {}
+# >> > ------------------------------------------------------------ in
+# >> > # ---
+# >> > # foo: bar
+# >> > # ---
+# >> >
+# >> >
+# >> > ------------------------------------------------------------ out
+# >> > ---
+# >> > foo: bar
+# >> > ---
+# >> >
+# >> > ------------------------------------------------------------
+# >> ---
+# >> foo: bar
+# >> ---

data/examples/type_quote.rb

@@ -0,0 +1,34 @@
+#+hidden: true
+require "./setup"
+
+puts Source2MD::Element.new(<<~EOS).to_md
+# > foo
+EOS
+
+# >> head: {}
+# >> body: "# > foo\n"
+# >> Source2MD::Formatter::TypeHidden => false
+# >> Source2MD::Formatter::TypeEval =>
+# >> Source2MD::Formatter::TypeCodeInclude =>
+# >> Source2MD::Formatter::TypeRawInclude =>
+# >> Source2MD::Formatter::TypeParseInclude =>
+# >> Source2MD::Formatter::TypeTitle => false
+# >> Source2MD::Formatter::TypeWarn =>
+# >> Source2MD::Formatter::TypeAlert =>
+# >> Source2MD::Formatter::TypeMethod =>
+# >> Source2MD::Formatter::TypeTable => false
+# >> Source2MD::Formatter::TypeSourceBlock => false
+# >> Source2MD::Formatter::TypeMdHeader =>
+# >> Source2MD::Formatter::TypeCodeBlock => false
+# >> Source2MD::Formatter::TypeQuote => # > foo
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeQuote
+# >> > {}
+# >> > ------------------------------------------------------------ in
+# >> > # > foo
+# >> >
+# >> >
+# >> > ------------------------------------------------------------ out
+# >> > > foo
+# >> >
+# >> > ------------------------------------------------------------
+# >> > foo

data/lib/source2md/cli.rb

@@ -4,6 +4,7 @@ module Source2MD
     class_option :xmp_out_exclude,    type: :boolean, aliases: "-x", default: false
     class_option :data_block_exclude, type: :boolean,                default: false
     class_option :readonly,           type: :boolean, aliases: "-r", default: true
+    class_option :oneline,            type: :boolean, aliases: "-1", default: false
     class_option :lang_default,       type: :string,  aliases: "-l", default: "ruby"
     class_option :prefix_re,          type: :string
     class_option :comment_re,         type: :string
@@ -19,6 +20,7 @@ module Source2MD
       Source2MD.xmp_out_exclude    = options[:xmp_out_exclude]
       Source2MD.data_block_exclude = options[:data_block_exclude]
       Source2MD.readonly           = options[:readonly]
+      Source2MD.oneline            = options[:oneline]
       Source2MD.lang_default       = options[:lang_default]
 
       Source2MD::RE.update do |e|

data/lib/source2md/element.rb

@@ -2,7 +2,7 @@ module Source2MD
   class Element
     PLUGINS = [
       Formatter::TypeHidden,       # #+hidden: true
-      Formatter::TypeEval,          # #+eval:
+      Formatter::TypeEval,         # #+eval:
       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
@@ -12,8 +12,21 @@ module Source2MD
       Formatter::TypeMethod,       # #+name: foo
       Formatter::TypeTable,        # # |-
       Formatter::TypeSourceBlock,  # #+BEGIN_SRC
+
+      # Type that just removes the comment and does not wrap it
+      Formatter::TypeMdHeader,     # # ---
+      Formatter::TypeCodeBlock,    # # ```
+      Formatter::TypeQuote,        # # > xxx
+      Formatter::TypeList,         # # - xxx or 1. xxx
+      Formatter::TypeInlineImage,  # # ![]
+
+      # Sentence (automatic wrap)
       Formatter::TypeText,         # # foo
+
+      # Code block without wrapping
       Formatter::TypePartialCode,  # 1 + 2 # => 3
+
+      # If not all match
       Formatter::TypeElse,
     ]
 

data/lib/source2md/formatter/type_code_block.rb

@@ -0,0 +1,19 @@
+module Source2MD
+  module Formatter
+    class TypeCodeBlock < Base
+
+      # "# ```"
+      def self.regexp
+        %r{#{RE.meta_re}\s+```}
+      end
+
+      def self.accept?(element)
+        element.body.match?(regexp)
+      end
+
+      def to_md
+        element.body.remove(TypeText.regexp)
+      end
+    end
+  end
+end

data/lib/source2md/formatter/type_inline_image.rb

@@ -0,0 +1,17 @@
+module Source2MD
+  module Formatter
+    class TypeInlineImage < Base
+      def self.regexp
+        /#{RE.meta_re}\s+!\[.*?\]/
+      end
+
+      def self.accept?(element)
+        element.body.match(regexp)
+      end
+
+      def to_md
+        element.body.remove(TypeText.regexp)
+      end
+    end
+  end
+end

data/lib/source2md/formatter/type_list.rb

@@ -0,0 +1,20 @@
+module Source2MD
+  module Formatter
+    class TypeList < Base
+
+      # "# 1. foo"
+      # "# - foo"
+      def self.regexp
+        %r{#{RE.meta_re}\s+(?:\d\.|-)\s+\S+}
+      end
+
+      def self.accept?(element)
+        element.body.match?(regexp)
+      end
+
+      def to_md
+        element.body.remove(TypeText.regexp)
+      end
+    end
+  end
+end

data/lib/source2md/formatter/type_md_header.rb

@@ -0,0 +1,17 @@
+module Source2MD
+  module Formatter
+    class TypeMdHeader < Base
+      def self.regexp
+        /#{RE.meta_re} ---\n.* ---\n/m
+      end
+
+      def self.accept?(element)
+        element.body.match(regexp)
+      end
+
+      def to_md
+        element.body.remove(TypeText.regexp)
+      end
+    end
+  end
+end

data/lib/source2md/formatter/type_quote.rb

@@ -0,0 +1,17 @@
+module Source2MD
+  module Formatter
+    class TypeQuote < Base
+      def self.regexp
+        /#{RE.meta_re}\s+\>\s+\S+/
+      end
+
+      def self.accept?(element)
+        element.body.match(regexp)
+      end
+
+      def to_md
+        element.body.remove(TypeText.regexp)
+      end
+    end
+  end
+end

data/lib/source2md/formatter/type_text.rb

@@ -25,9 +25,13 @@ module Source2MD
         if element.head["squish"] == "true"
           s = TextHelper.squish(s)
         end
-        if element.head["oneline"] == "true"
+
+        case
+        when element.head["oneline"] == "false"
+        when element.head["oneline"] == "true" || Source2MD.oneline
           s = TextHelper.oneline(s)
         end
+
         if element.head["hankaku_kana"] == "true"
           s = TextHelper.hankaku_kana(s)
         end

data/lib/source2md/text_helper.rb

@@ -7,7 +7,8 @@ module Source2MD
     end
 
     def oneline(text)
-      text.remove(/\R+/)
+      text = text.gsub(/？\R/, "？ ")
+      text = text.remove(/\R+/)
     end
 
     def squish(text)

data/lib/source2md/version.rb

@@ -1,3 +1,3 @@
 module Source2MD
-  VERSION = "0.0.16"
+  VERSION = "0.0.18"
 end

data/lib/source2md.rb

@@ -17,6 +17,7 @@ module Source2MD
   config_accessor(:readonly) { true }
   config_accessor(:lang_default) { "ruby" }
   config_accessor(:data_block_exclude) { false }
+  config_accessor(:oneline) { false }
 end
 
 require "zeitwerk"

data/spec/formatter/type_code_block_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+module Source2MD
+  describe do
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+# ```
+# foo
+# ```
+EOS
+      actual.should == <<~EOS
+```
+foo
+```
+EOS
+    end
+  end
+end
+# >> .
+# >> 
+# >> Finished in 0.00614 seconds (files took 0.36666 seconds to load)
+# >> 1 example, 0 failures
+# >> 

data/spec/formatter/type_inline_image_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+module Source2MD
+  describe do
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+# ![](https://example.com/image.png)
+# **(alt)**
+EOS
+      actual.should == <<~EOS
+![](https://example.com/image.png)
+**(alt)**
+EOS
+    end
+  end
+end
+# >> .
+# >> 
+# >> Finished in 0.00592 seconds (files took 0.33715 seconds to load)
+# >> 1 example, 0 failures
+# >> 

data/spec/formatter/type_md_header_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+module Source2MD
+  describe do
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+# ---
+# foo: bar
+# ---
+EOS
+      actual.should == <<~EOS
+---
+foo: bar
+---
+EOS
+    end
+  end
+end
+# >> .
+# >> 
+# >> Finished in 0.00648 seconds (files took 0.35849 seconds to load)
+# >> 1 example, 0 failures
+# >> 

data/spec/formatter/type_quote_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+module Source2MD
+  describe do
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+# > foo
+EOS
+      actual.should == <<~EOS
+> foo
+EOS
+    end
+  end
+end
+# >> .
+# >> 
+# >> Finished in 0.00637 seconds (files took 0.3615 seconds to load)
+# >> 1 example, 0 failures
+# >> 

data/spec/text_helper_spec.rb

@@ -6,6 +6,10 @@ module Source2MD
       assert { TextHelper.blank_lines_squish("A\nB\n\nC\n\n\nD") == "A\nB\n\nC\n\nD" }
     end
 
+    it "oneline" do
+      assert { TextHelper.oneline("？\nA") == "？ A" }
+    end
+
     it "eol_enter" do
       assert { TextHelper.eol_enter("A") == "A\n"     }
       assert { TextHelper.eol_enter("A\n\n") == "A\n" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source2md
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - Akira Ikeda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-31 00:00:00.000000000 Z
+date: 2024-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -175,11 +175,15 @@ files:
 - examples/scanner.rb
 - examples/setup.rb
 - examples/type_alert.rb
+- examples/type_code_block.rb
 - examples/type_code_include.rb
 - examples/type_eval.rb
 - examples/type_hidden.rb
+- examples/type_inline_image.rb
+- examples/type_md_header.rb
 - examples/type_method.rb
 - examples/type_partial_code.rb
+- examples/type_quote.rb
 - examples/type_source_block.rb
 - examples/type_table.rb
 - examples/type_text.rb
@@ -191,14 +195,19 @@ files:
 - lib/source2md/element.rb
 - lib/source2md/formatter/base.rb
 - lib/source2md/formatter/type_alert.rb
+- lib/source2md/formatter/type_code_block.rb
 - lib/source2md/formatter/type_code_include.rb
 - lib/source2md/formatter/type_else.rb
 - lib/source2md/formatter/type_eval.rb
 - lib/source2md/formatter/type_hidden.rb
+- lib/source2md/formatter/type_inline_image.rb
+- lib/source2md/formatter/type_list.rb
+- lib/source2md/formatter/type_md_header.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_quote.rb
 - lib/source2md/formatter/type_raw_include.rb
 - lib/source2md/formatter/type_source_block.rb
 - lib/source2md/formatter/type_table.rb
@@ -219,12 +228,16 @@ files:
 - spec/code_block_spec.rb
 - spec/formatter/sample.yml
 - spec/formatter/type_alert_spec.rb
+- spec/formatter/type_code_block_spec.rb
 - spec/formatter/type_code_include_spec.rb
 - spec/formatter/type_eval_spec.rb
 - spec/formatter/type_hidden_spec.rb
+- spec/formatter/type_inline_image_spec.rb
+- spec/formatter/type_md_header_spec.rb
 - spec/formatter/type_method_spec.rb
 - spec/formatter/type_parse_include_spec.rb
 - spec/formatter/type_partial_code_spec.rb
+- spec/formatter/type_quote_spec.rb
 - spec/formatter/type_raw_include_spec.rb
 - spec/formatter/type_source_block_spec.rb
 - spec/formatter/type_table_spec.rb
@@ -254,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Markdown generator from source code
@@ -262,12 +275,16 @@ test_files:
 - spec/code_block_spec.rb
 - spec/formatter/sample.yml
 - spec/formatter/type_alert_spec.rb
+- spec/formatter/type_code_block_spec.rb
 - spec/formatter/type_code_include_spec.rb
 - spec/formatter/type_eval_spec.rb
 - spec/formatter/type_hidden_spec.rb
+- spec/formatter/type_inline_image_spec.rb
+- spec/formatter/type_md_header_spec.rb
 - spec/formatter/type_method_spec.rb
 - spec/formatter/type_parse_include_spec.rb
 - spec/formatter/type_partial_code_spec.rb
+- spec/formatter/type_quote_spec.rb
 - spec/formatter/type_raw_include_spec.rb
 - spec/formatter/type_source_block_spec.rb
 - spec/formatter/type_table_spec.rb