source2md 0.0.4 → 0.0.5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source2md
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Akira Ikeda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-16 00:00:00.000000000 Z
+date: 2023-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -151,37 +151,55 @@ files:
 - 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/0130_hidden.rb
+- 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_parse_include.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_partial_code.rb
-- examples/element_reject.rb
-- examples/element_source_block.rb
-- examples/element_table.rb
 - examples/element_text.rb
-- examples/element_title.rb
-- examples/element_warn.rb
 - examples/input.rb
 - examples/input.yml
 - examples/output.md
 - examples/scanner.rb
 - examples/setup.rb
+- 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
+- examples/type_table.rb
+- examples/type_text.rb
+- examples/type_title.rb
+- examples/type_warn.rb
 - lib/source2md.rb
 - lib/source2md/cli.rb
 - lib/source2md/code_block.rb
 - lib/source2md/element.rb
+- lib/source2md/formatter/base.rb
+- lib/source2md/formatter/type_alert.rb
+- 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_parse_include.rb
+- lib/source2md/formatter/type_partial_code.rb
+- lib/source2md/formatter/type_raw_include.rb
+- lib/source2md/formatter/type_source_block.rb
+- lib/source2md/formatter/type_table.rb
+- lib/source2md/formatter/type_text.rb
+- lib/source2md/formatter/type_title.rb
+- lib/source2md/formatter/type_warn.rb
 - lib/source2md/generator.rb
 - lib/source2md/logger.rb
 - lib/source2md/scanner.rb
@@ -189,40 +207,26 @@ files:
 - 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_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_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/formatter/sample.yml
+- 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
+- spec/formatter/type_raw_include_spec.rb
+- spec/formatter/type_source_block_spec.rb
+- spec/formatter/type_table_spec.rb
+- spec/formatter/type_text_spec.rb
+- spec/formatter/type_title_spec.rb
+- spec/formatter/type_warn_spec.rb
 - spec/scanner_spec.rb
 - spec/spec_helper.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_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_title_spec.rb
-- spec/type/element_warn_spec.rb
-- spec/type/sample.yml
 homepage: https://github.com/akicho8/source2md
 licenses:
 - MIT
@@ -248,19 +252,20 @@ specification_version: 4
 summary: Markdown generator from source code
 test_files:
 - spec/code_block_spec.rb
+- spec/formatter/sample.yml
+- 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
+- spec/formatter/type_raw_include_spec.rb
+- spec/formatter/type_source_block_spec.rb
+- spec/formatter/type_table_spec.rb
+- spec/formatter/type_text_spec.rb
+- spec/formatter/type_title_spec.rb
+- spec/formatter/type_warn_spec.rb
 - spec/scanner_spec.rb
 - spec/spec_helper.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_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_title_spec.rb
-- spec/type/element_warn_spec.rb
-- spec/type/sample.yml

data/doc/0180_text.rb

@@ -1,15 +0,0 @@
-require "./setup"
-
-### Text ###
-
-# If no rule applies and the text begins with `#`, remove the `#`.
-
-#+BEGIN_SRC
-puts Source2MD::Section.new(<<~EOS).to_md
-  # Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
-  # Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
-EOS
-#+END_SRC
-
-# > Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
-# > Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

data/doc/0190_raw.rb

@@ -1,19 +0,0 @@
-require "./setup"
-
-### Raw Text ###
-
-# Same rule as when writing text, simply remove the leading `#`.
-
-#+BEGIN_SRC
-puts Source2MD::Section.new(<<~EOS).to_md
-  # <hr>
-  #
-  # <hr>
-EOS
-#+END_SRC
-
-# > ```
-# > <hr>
-# >
-# > <hr>
-# > ```

data/examples/element_include.rb

@@ -1,20 +0,0 @@
-require "./setup"
-
-puts Source2MD::Element.new(<<~EOS).to_md
-
-#+include: input.yml
-#+name:
-
-EOS
-# ~> /Users/ikeda/src/source2md/lib/source2md/type/element_include.rb:27:in `read': No such file or directory @ rb_sysopen - /Users/ikeda/src/source2md/examples/input.yml diff xxx:yyy (Errno::ENOENT)
-# ~> 	from /Users/ikeda/src/source2md/lib/source2md/type/element_include.rb:27:in `read'
-# ~> 	from /Users/ikeda/src/source2md/lib/source2md/type/element_include.rb:27:in `body'
-# ~> 	from /Users/ikeda/src/source2md/lib/source2md/type/element_include.rb:17:in `to_md'
-# ~> 	from /Users/ikeda/src/source2md/lib/source2md/type/base.rb:25:in `block in initialize'
-# ~> 	from /opt/rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/activesupport-7.0.6/lib/active_support/logger_thread_safe_level.rb:58:in `add'
-# ~> 	from /opt/rbenv/versions/3.2.2/lib/ruby/3.2.0/logger.rb:689:in `debug'
-# ~> 	from /Users/ikeda/src/source2md/lib/source2md/type/base.rb:13:in `initialize'
-# ~> 	from /Users/ikeda/src/source2md/lib/source2md/type/element_include.rb:9:in `initialize'
-# ~> 	from /Users/ikeda/src/source2md/lib/source2md/element.rb:27:in `new'
-# ~> 	from /Users/ikeda/src/source2md/lib/source2md/element.rb:27:in `to_md'
-# ~> 	from -:3:in `<main>'

data/examples/element_reject.rb

@@ -1,17 +0,0 @@
-require "./setup"
-
-puts Source2MD::Element.new(<<~EOS).to_md
-require "setup"
-EOS
-# >> --------------------------------------------------------------------------------
-# >> Source2MD::Type::ElementReject
-# >> 
-# >> head:
-# >> {}
-# >> 
-# >> in:
-# >> require "setup"
-# >> 
-# >> out:
-# >> --------------------------------------------------------------------------------
-# >> 

data/lib/source2md/type/element_deep_comment.rb

@@ -1,19 +0,0 @@
-module Source2MD
-  module Type
-    class ElementDeepComment < Base
-      def self.accept?(element)
-        element.body.match?(/^##/)
-      end
-
-      def to_md
-        CodeBlock.new(body).to_md
-      end
-
-      private
-
-      def body
-        element.body.gsub(/^##/, "#")
-      end
-    end
-  end
-end

data/lib/source2md/type/element_md_header.rb

@@ -1,13 +0,0 @@
-module Source2MD
-  module Type
-    class ElementMdHeader < Base
-      def self.accept?(element)
-        element.body.to_s.start_with?("---")
-      end
-
-      def to_md
-        element.body
-      end
-    end
-  end
-end

data/lib/source2md/type/element_method.rb

@@ -1,24 +0,0 @@
-module Source2MD
-  module Type
-    class ElementMethod < Base
-      def self.accept?(element)
-        element.head[:name]
-      end
-
-      def to_md
-        [
-          "### #{element.head[:name]} ###",
-          element.head[:desc],
-          body ? CodeBlock.new(body).to_md : nil,
-          element.head[:comment],
-        ].compact * "\n\n"
-      end
-
-      private
-
-      def body
-        element.body.gsub(/^\#$/, "").presence
-      end
-    end
-  end
-end

data/lib/source2md/type/element_uncomment.rb

@@ -1,24 +0,0 @@
-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/spec/type/sample.yml

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