source2md 0.0.2 → 0.0.3

data/lib/source2md/type/element_source_block.rb

@@ -0,0 +1,25 @@
+module Source2MD
+  module Type
+    class ElementSourceBlock < Base
+      def self.accept?(element)
+        element.body.start_with?("#+BEGIN_SRC")
+      end
+
+      def to_md
+        CodeBlock.new(body, desc: code_block_desc).to_md
+      end
+
+      private
+
+      def body
+        element.body.match(/#\+BEGIN_SRC.*?\R(.*)#\+END_SRC/m).captures.first.strip
+      end
+
+      def code_block_desc
+        if md = element.body.match(/#\+BEGIN_SRC(.+)/)
+          md.captures.first.strip
+        end
+      end
+    end
+  end
+end

data/lib/source2md/type/element_table.rb

@@ -2,14 +2,14 @@ module Source2MD
   module Type
     class ElementTable < Base
       def self.accept?(element)
-        element.body.lines.all? { |e| e.match?(/^# \|.*\|$/) }
+        !element.body.empty? && element.body.lines.all? { |e| e.match?(/^# \|.*\|$/) }
       end
 
       def to_md
         element.body
-          .gsub(/^# /, "")
-          .sub(/\A\|.*?\|\R?/, "")
-          .sub(/^\|.*?\|\z/, "")
+          .remove(/^# /)
+          .remove(/\A\|-.*?-\|\R?/)
+          .remove(/^\|-.*?-\|\z/)
           .gsub(/-\+-/, "-|-").strip
       end
     end

data/lib/source2md/type/element_title.rb

@@ -0,0 +1,35 @@
+module Source2MD
+  module Type
+    class ElementTitle < Base
+      REGEXP = /\Atitle(\d+)\z/
+
+      def self.accept?(element)
+        element.head.keys.any? { |e| e.match?(REGEXP) }
+      end
+
+      def to_md
+        s = [prefix, body, prefix] * " "
+        Source2MD.logger.warn { s }
+        s
+      end
+
+      private
+
+      def body
+        element.head[key]
+      end
+
+      def level
+        key.to_s.remove(/\D+/).to_i
+      end
+
+      def prefix
+        "#" * level
+      end
+
+      def key
+        @key ||= element.head.keys.find { |e| e.match?(REGEXP) }
+      end
+    end
+  end
+end

data/lib/source2md/type/element_uncomment.rb

@@ -0,0 +1,24 @@
+module Source2MD
+  module Type
+    class ElementUncomment < Base
+      REGEXP = /^#( |$)/
+
+      def self.accept?(element)
+        if element.head.empty?
+          # "# xxx\n" or "#\n"
+          element.body.lines.all? { |e| e.match?(REGEXP) }
+        end
+      end
+
+      def to_md
+        body
+      end
+
+      private
+
+      def body
+        element.body.remove(REGEXP)
+      end
+    end
+  end
+end

data/lib/source2md/type/element_warn.rb

@@ -0,0 +1,19 @@
+module Source2MD
+  module Type
+    class ElementWarn < Base
+      def self.accept?(element)
+        if element.body.empty?
+          element.head[:warn]
+        end
+      end
+
+      def to_md
+        [
+          ":::message",
+          element.head[:warn],
+          ":::",
+        ] * "\n"
+      end
+    end
+  end
+end

data/lib/source2md/version.rb

@@ -1,3 +1,3 @@
 module Source2MD
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/source2md.rb

@@ -8,10 +8,12 @@ require "active_support/configurable"
 
 require "pathname"
 require "thor"
+require "table_format"
 
 module Source2MD
   include ActiveSupport::Configurable
   config_accessor(:debug) { false }
+  config_accessor(:xmp_out_exclude) { false }
 end
 
 require "zeitwerk"

data/source2md.gemspec

@@ -1,6 +1,6 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) if !$LOAD_PATH.include?(lib)
-require 'source2md/version'
+require "source2md/version"
 
 Gem::Specification.new do |spec|
   spec.name         = "source2md"
@@ -18,10 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "zeitwerk"
   spec.add_dependency "activesupport"
   spec.add_dependency "pathname"
+  spec.add_dependency "table_format"
   spec.add_dependency "thor"
+  spec.add_dependency "zeitwerk"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/spec/code_block_spec.rb

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

data/spec/scanner_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+module Source2MD
+  describe Scanner do
+    it "works" do
+      ary = Scanner.new(<<~EOS).to_a
+      foo
+
+      #+BEGIN_SRC
+
+      foo
+
+      #+END_SRC
+
+      foo
+
+      #+BEGIN_SRC
+      foo
+      #+END_SRC
+      foo
+      EOS
+
+      assert { ary == ["foo", "#+BEGIN_SRC\n\nfoo\n\n#+END_SRC", "foo", "#+BEGIN_SRC\nfoo\n#+END_SRC", "foo"] }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ Pathname.glob("#{__dir__}/support/**/*.rb") { |e| require e.to_s }
 Zeitwerk::Loader.eager_load_all
 
 Source2MD.logger.level = :error
+Source2MD.xmp_out_exclude = true
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|

data/spec/text_helper_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+module Source2MD
+  describe TextHelper do
+    it "blank_lines_squish" do
+      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" }
+    end
+  end
+end

data/spec/type/element_alert_spec.rb

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

data/spec/type/element_include_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+module Source2MD
+  describe do
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+#+include: #{__dir__}/sample.yml
+EOS
+      actual.should == <<~EOS.strip
+```yml:sample.yml
+yaml content
+```
+      EOS
+    end
+
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+#+include: #{__dir__}/sample.yml
+#+lang: (lang)
+#+name: (name)
+EOS
+      actual.should == <<~EOS.strip
+```(lang):(name)
+yaml content
+```
+      EOS
+    end
+
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+#+include: #{__dir__}/sample.yml yaml:filename
+EOS
+      actual.should == <<~EOS.strip
+```yaml:filename
+yaml content
+```
+      EOS
+    end
+  end
+end

data/spec/type/element_md_header_spec.rb

@@ -8,7 +8,7 @@ module Source2MD
 foo: 1
 ---
 EOS
-      assert { actual == <<~EOS.strip }
+      actual.should == <<~EOS.strip
 ---
 foo: 1
 ---
@@ -16,19 +16,3 @@ foo: 1
     end
   end
 end
-# >> F
-# >>
-# >> Failures:
-# >>
-# >>   1) works
-# >>      Failure/Error: Unable to find - to read failed line
-# >>      Test::Unit::AssertionFailedError:
-# >>      # -:14:in `block (2 levels) in <module:Source2MD>'
-# >>
-# >> Finished in 0.0113 seconds (files took 0.26182 seconds to load)
-# >> 1 example, 1 failure
-# >>
-# >> Failed examples:
-# >>
-# >> rspec -:5 # works
-# >>

data/spec/type/{element_title2_spec.rb → element_md_title_spec.rb}

@@ -4,10 +4,10 @@ module Source2MD
   describe do
     it "works" do
       actual = Element.new(<<~EOS).to_md
-# title2: foo
+## foo ##
 EOS
-      assert { actual == <<~EOS.strip }
-## foo
+      actual.should == <<~EOS.strip
+## foo ##
       EOS
     end
   end

data/spec/type/element_method_spec.rb

@@ -4,15 +4,15 @@ module Source2MD
   describe do
     it "works" do
       actual = Element.new(<<~EOS).to_md
-# name: (name)
-# desc: (desc)
-# comment: (comment)
+#+name: (name)
+#+desc: (desc)
+#+comment: (comment)
 (code1)
 #
 (code2)
 EOS
-      assert { actual == <<~EOS.strip }
-### (name)
+      actual.should == <<~EOS.strip
+### (name) ###
 
 (desc)
 

data/spec/type/{element_pre_spec.rb → element_partial_code_spec.rb}

@@ -4,11 +4,11 @@ module Source2MD
   describe do
     it "works" do
       actual = Element.new(<<~EOS).to_md
-code
+(foo)
 EOS
-      assert { actual == <<~EOS.strip }
+      actual.should == <<~EOS.strip
 ```ruby
-code
+(foo)
 ```
       EOS
     end

data/spec/type/element_reject_spec.rb

@@ -6,7 +6,7 @@ module Source2MD
       actual = Element.new(<<~EOS).to_md
 require "./setup"
 EOS
-      assert { actual.blank? }
+      assert { actual.nil? }
     end
   end
 end

data/spec/type/element_source_block_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+module Source2MD
+  describe do
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+      #+BEGIN_SRC
+      (foo)
+      #+END_SRC
+      EOS
+      actual.should == <<~EOS.strip
+```ruby
+(foo)
+```
+      EOS
+    end
+
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+      #+BEGIN_SRC diff xxx:yyy
+      (foo)
+      #+END_SRC
+      EOS
+      actual.should == <<~EOS.strip
+```diff xxx:yyy
+(foo)
+```
+      EOS
+    end
+  end
+end

data/spec/type/element_table_spec.rb

@@ -11,11 +11,24 @@ module Source2MD
 # | d | d | d |
 # |---+---+---|
 EOS
-      assert { actual == <<~EOS.strip }
+      actual.should == <<~EOS.strip
 | h | h | h |
 |---|---|---|
 | d | d | d |
 | d | d | d |
+EOS
+    end
+
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+# | h | h | h |
+# |---+---+---|
+# | d | d | d |
+EOS
+      actual.should == <<~EOS.strip
+| h | h | h |
+|---|---|---|
+| d | d | d |
 EOS
     end
   end

data/spec/type/element_text_spec.rb

@@ -8,7 +8,7 @@ module Source2MD
 #   http://example.com/
 # - bar: http://example.com/
 EOS
-      assert { actual == <<~EOS.strip }
+      actual.should == <<~EOS.strip
 - foo
   http://example.com/
 - bar: http://example.com/

data/spec/type/{element_deep_comment_spec.rb → element_title_spec.rb}

@@ -4,12 +4,10 @@ module Source2MD
   describe do
     it "works" do
       actual = Element.new(<<~EOS).to_md
-## foo
+#+title2: (foo)
 EOS
-      assert { actual == <<~EOS.strip }
-```ruby
-# foo
-```
+      actual.should == <<~EOS.strip
+## (foo) ##
       EOS
     end
   end

data/spec/type/element_warn_spec.rb

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

data/spec/type/sample.yml

@@ -0,0 +1 @@
+yaml content

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: source2md
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Akira Ikeda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 2023-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: zeitwerk
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: pathname
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pathname
+  name: table_format
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -134,49 +148,81 @@ files:
 - README.md
 - Rakefile
 - bin/source2md
+- doc/0100_top.rb
+- doc/0110_code_small.rb
+- doc/0120_code_long.rb
+- doc/0130_title.rb
+- doc/0140_md_like_title.rb
+- doc/0150_table.rb
+- doc/0160_method.rb
+- doc/0170_alert.rb
+- doc/0180_text.rb
+- doc/0190_raw.rb
+- doc/setup.rb
 - examples/cli.rb
+- examples/element_alert.rb
 - examples/element_deep_comment.rb
+- examples/element_include.rb
 - examples/element_md_header.rb
+- examples/element_md_title.rb
 - examples/element_method.rb
-- examples/element_pre.rb
+- examples/element_partial_code.rb
 - examples/element_reject.rb
+- examples/element_source_block.rb
 - examples/element_table.rb
 - examples/element_text.rb
-- examples/element_title2.rb
+- examples/element_title.rb
+- examples/element_warn.rb
 - examples/input.rb
+- examples/input.yml
 - examples/output.md
+- examples/scanner.rb
 - examples/setup.rb
 - lib/source2md.rb
 - lib/source2md/cli.rb
 - lib/source2md/code_block.rb
 - lib/source2md/element.rb
-- lib/source2md/file_block.rb
 - lib/source2md/generator.rb
 - lib/source2md/logger.rb
+- lib/source2md/scanner.rb
+- lib/source2md/section.rb
 - lib/source2md/tasks/about.rake
 - lib/source2md/tasks/test.rake
 - lib/source2md/text_helper.rb
 - lib/source2md/type/base.rb
+- lib/source2md/type/element_alert.rb
 - lib/source2md/type/element_deep_comment.rb
+- lib/source2md/type/element_else.rb
+- lib/source2md/type/element_include.rb
 - lib/source2md/type/element_md_header.rb
+- lib/source2md/type/element_md_title.rb
 - lib/source2md/type/element_method.rb
-- lib/source2md/type/element_pre.rb
+- lib/source2md/type/element_partial_code.rb
 - lib/source2md/type/element_reject.rb
+- lib/source2md/type/element_source_block.rb
 - lib/source2md/type/element_table.rb
-- lib/source2md/type/element_text.rb
-- lib/source2md/type/element_title2.rb
+- lib/source2md/type/element_title.rb
+- lib/source2md/type/element_uncomment.rb
+- lib/source2md/type/element_warn.rb
 - lib/source2md/version.rb
 - source2md.gemspec
 - spec/code_block_spec.rb
+- spec/scanner_spec.rb
 - spec/spec_helper.rb
-- spec/type/element_deep_comment_spec.rb
+- spec/text_helper_spec.rb
+- spec/type/element_alert_spec.rb
+- spec/type/element_include_spec.rb
 - spec/type/element_md_header_spec.rb
+- spec/type/element_md_title_spec.rb
 - spec/type/element_method_spec.rb
-- spec/type/element_pre_spec.rb
+- spec/type/element_partial_code_spec.rb
 - spec/type/element_reject_spec.rb
+- spec/type/element_source_block_spec.rb
 - spec/type/element_table_spec.rb
 - spec/type/element_text_spec.rb
-- spec/type/element_title2_spec.rb
+- spec/type/element_title_spec.rb
+- spec/type/element_warn_spec.rb
+- spec/type/sample.yml
 homepage: https://github.com/akicho8/source2md
 licenses:
 - MIT
@@ -202,12 +248,19 @@ specification_version: 4
 summary: Markdown generator from source code
 test_files:
 - spec/code_block_spec.rb
+- spec/scanner_spec.rb
 - spec/spec_helper.rb
-- spec/type/element_deep_comment_spec.rb
+- spec/text_helper_spec.rb
+- spec/type/element_alert_spec.rb
+- spec/type/element_include_spec.rb
 - spec/type/element_md_header_spec.rb
+- spec/type/element_md_title_spec.rb
 - spec/type/element_method_spec.rb
-- spec/type/element_pre_spec.rb
+- spec/type/element_partial_code_spec.rb
 - spec/type/element_reject_spec.rb
+- spec/type/element_source_block_spec.rb
 - spec/type/element_table_spec.rb
 - spec/type/element_text_spec.rb
-- spec/type/element_title2_spec.rb
+- spec/type/element_title_spec.rb
+- spec/type/element_warn_spec.rb
+- spec/type/sample.yml