source2md 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 804f40a21fe77faa747a631bd93fa6592d7bf035858fd4a8ba795f776dcb512b
-  data.tar.gz: 5f6d342b20388915027fa33c6d1d1a644ac5c28c56febd4e612ba318c14df375
+  metadata.gz: e673a10ff2f099c40a723633a4b0f08a4b14e3ada5be2c68ea36172116eabb22
+  data.tar.gz: e1c0805eae0c7ff7ee57ad9af917536c163adaa3e09cc02271d20e4f8e9ad457
 SHA512:
-  metadata.gz: 7dabbca4c2adf8136803fa1c1184975e1e41484620ac1350507fa196254202fcc3b5dde0f59fe31206472782274b4785048fad1b92e6ebee0873839b12b68a46
-  data.tar.gz: e46f3cf966becc687447b2394e9a02ba26ecd8d6ea2463049cfaf3a596f99bf5de3d5de2fbfede43db2ca2ca2c5fb206025731415ac78f5eeb93532193d03132
+  metadata.gz: 663438864223b70114d4d4f1ef244dfe54684682c545d2f19fb6d2857e9542683c437d2d08d5b4f3a78b9bdafc0e2c6b211ad47108452b4669fc51d1046964a2
+  data.tar.gz: 13283d111e1b965495c3b0a7bd088a7b88136f97749bd396985f0276b199280f9b175ebe10a926f9ca7dbd2def92fd3a2776e4401ad21df7f4f6b0ec837c6a94

data/README.md

@@ -1,4 +1,4 @@
-# Source2MD: Markdown generator from source code
+# Source2MD: Markdown generator from source code #
 
 ## Install ##
 
@@ -6,64 +6,220 @@
 $ gem i source2md
 ```
 
-## Example ##
+## CLI ##
 
-input.rb:
+```
+$ source2md generate -o README.md README.rb
+```
+
+## Rules ##
+
+### Embedding Of Small Code ###
+
+```ruby
+puts Source2MD::Section.new(<<~EOS).to_md
+  hello = -> {
+    "Hello, world!"
+  }
+
+  hello.call
+EOS
+```
+
+> ```ruby
+> hello = -> {
+>   "Hello, world!"
+> }
+> ```
+
+> ```ruby
+> hello.call
+> ```
+
+### Source Block ###
 
 ```ruby
-# title2: (title)
-
-# name: (name1)
-# desc: (desc1)
-# comment: (comment1)
-"foo1".size                          # => 4
-
-# name: (name2)
-# desc: (desc2)
-# comment: (comment2)
-"foo2".size                          # => 4
-
-# |---+---+---|
-# | x | x | x |
-# |---+---+---|
-# | x | x | x |
-# | x | x | x |
-# |---+---+---|
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+BEGIN_SRC
+  hello = -> {
+    "Hello, world!"
+  }
+
+  hello.call
+  #+END_SRC
+EOS
+```
+
+> ```ruby
+> hello = -> {
+>   "Hello, world!"
+> }
+>
+> hello.call
+> ```
+
+### Title ###
+
+No number limit.
+
+```ruby
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+title1: Title Level 1
+
+  #+title2: Title Level 2
+
+  #+title3: Title Level 3
+EOS
 ```
 
-↓
+> # Title Level 1 # #
+>
+> ## Title Level 2 # ##
+>
+> ### 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 #
 
-```shell
-$ source2md generate -o output.md input.rb
-read: input.rb
-write: output.md
+  ## Title Level 2 ##
+
+  ### Title Level 3 ###
+EOS
 ```
 
-↓
+> # Title Level 1 #
+>
+> ## Title Level 2 ##
+>
+> ### Title Level 3 ###
+
+### Org-mode Table Style ###
+
+```ruby
+puts Source2MD::Section.new(<<~EOS).to_md
+  # |------------+-------+--------------------------------------------|
+  # | Language   | Birth | Creator                                    |
+  # |------------+-------+--------------------------------------------|
+  # | Lisp       |  1958 | John McCarthy                              |
+  # | Fortran    |  1957 | John Backus                                |
+  # | COBOL      |  1959 | Grace Hopper and team                      |
+  # | Algol      |  1958 | International group of computer scientists |
+  # | BASIC      |  1964 | John G. Kemeny and Thomas E. Kurtz         |
+  # | Pascal     |  1970 | Niklaus Wirth                              |
+  # | C          |  1972 | Dennis Ritchie                             |
+  # | Prolog     |  1972 | Alain Colmerauer, Robert Kowalski          |
+  # | C++        |  1983 | Bjarne Stroustrup                          |
+  # | Python     |  1989 | Guido van Rossum                           |
+  # |------------+-------+--------------------------------------------|
+EOS
+```
 
-## (title)
+> | Language   | Birth | Creator                                    |
+> |------------|-------|--------------------------------------------|
+> | Lisp       |  1958 | John McCarthy                              |
+> | Fortran    |  1957 | John Backus                                |
+> | COBOL      |  1959 | Grace Hopper and team                      |
+> | Algol      |  1958 | International group of computer scientists |
+> | BASIC      |  1964 | John G. Kemeny and Thomas E. Kurtz         |
+> | Pascal     |  1970 | Niklaus Wirth                              |
+> | C          |  1972 | Dennis Ritchie                             |
+> | Prolog     |  1972 | Alain Colmerauer, Robert Kowalski          |
+> | C++        |  1983 | Bjarne Stroustrup                          |
+> | Python     |  1989 | Guido van Rossum                           |
+
+### Explain the method simply ###
 
-### (name1)
+```ruby
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+name: String#size
+  #+desc: Return the number of characters
+  #+comment: Comments about size
+  "abc".size     # => 3
+
+  #+name: String#reverse
+  #+desc: reverse the sequence of characters
+  #+comment: Comments about reverse
+  "abc".reverse  # => "cba"
+EOS
+```
 
-(desc1)
+> ### String#size ###
+>
+> Return the number of characters
+>
+> ```ruby
+> "abc".size  # => 3
+> ```
+>
+> Comments about size
+>
+> ### String#reverse ###
+>
+> reverse the sequence of characters
+>
+> ```ruby
+> "abc".reverse  # => "cba"
+> ```
+>
+> Comments about reverse
+
+### Warning, Alert Message ###
+
+Exclusive to Zenn
 
 ```ruby
-"foo1".size  # => 4
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+warn: this is warning message
+
+  #+alert: this is alert message
+EOS
 ```
 
-(comment1)
+> ```
+> :::message
+> this is warning message
+> :::
+> ```
+>
+> ```
+> :::message alert
+> this is alert message
+> :::
+> ```
 
-### (name2)
+### Text ###
 
-(desc2)
+If no rule applies and the text begins with `#`, remove the `#`.
 
 ```ruby
-"foo2".size  # => 4
+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
 ```
 
-(comment2)
+> 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.
+
+### Raw Text ###
+
+Same rule as when writing text, simply remove the leading `#`.
+
+```ruby
+puts Source2MD::Section.new(<<~EOS).to_md
+  # <hr>
+  #
+  # <hr>
+EOS
+```
 
-| x | x | x |
-|---|---|---|
-| x | x | x |
-| x | x | x |
+> ```
+> <hr>
+>
+> <hr>
+> ```

data/Rakefile

@@ -1,3 +1,29 @@
 require "bundler/gem_tasks"
 
 Pathname.glob("lib/source2md/tasks/**/*.rake").each { |file| load(file) }
+
+task :g => "doc:generate"
+task :r => "doc:renum"
+task :o => "open"
+
+namespace :doc do
+  desc "[g] generate README.md"
+  task "generate" do
+    system "sh", "-vec", <<~EOT, exception: true
+.bin/source2md generate --no-debug --no-xmp-out-exclude -o README.md doc/0*
+EOT
+  end
+
+  desc "renumber"
+  task :renum do
+    system "sh", "-vec", <<~EOT, exception: true
+saferenum -x doc
+EOT
+  end
+end
+
+task :open do
+  system "sh", "-vec", <<~EOT, exception: true
+open https://github.com/akicho8/source2md
+EOT
+end

data/doc/0100_top.rb

@@ -0,0 +1,17 @@
+require "./setup"
+
+# Source2MD: Markdown generator from source code #
+
+## Install ##
+
+# ```
+# $ gem i source2md
+# ```
+
+## CLI ##
+
+# ```
+# $ source2md generate -o README.md README.rb
+# ```
+
+## Rules ##

data/doc/0110_code_small.rb

@@ -0,0 +1,23 @@
+require "./setup"
+
+### Embedding Of Small Code ###
+
+#+BEGIN_SRC
+puts Source2MD::Section.new(<<~EOS).to_md
+  hello = -> {
+    "Hello, world!"
+  }
+
+  hello.call
+EOS
+#+END_SRC
+
+# > ```ruby
+# > hello = -> {
+# >   "Hello, world!"
+# > }
+# > ```
+
+# > ```ruby
+# > hello.call
+# > ```

data/doc/0120_code_long.rb

@@ -0,0 +1,23 @@
+require "./setup"
+
+### Source Block ###
+
+#+BEGIN_SRC
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+BEGIN_SRC
+  hello = -> {
+    "Hello, world!"
+  }
+
+  hello.call
+  #+END_SRC
+EOS
+#+END_SRC
+
+# > ```ruby
+# > hello = -> {
+# >   "Hello, world!"
+# > }
+# >
+# > hello.call
+# > ```

data/doc/0130_title.rb

@@ -0,0 +1,21 @@
+require "./setup"
+
+### Title ###
+
+# No number limit.
+
+#+BEGIN_SRC
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+title1: Title Level 1
+
+  #+title2: Title Level 2
+
+  #+title3: Title Level 3
+EOS
+#+END_SRC
+
+# > # Title Level 1 # #
+# >
+# > ## Title Level 2 # ##
+# >
+# > ### Title Level 3 # ###

data/doc/0140_md_like_title.rb

@@ -0,0 +1,21 @@
+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 ###

data/doc/0150_table.rb

@@ -0,0 +1,35 @@
+require "./setup"
+
+### Org-mode Table Style ###
+
+#+BEGIN_SRC
+puts Source2MD::Section.new(<<~EOS).to_md
+  # |------------+-------+--------------------------------------------|
+  # | Language   | Birth | Creator                                    |
+  # |------------+-------+--------------------------------------------|
+  # | Lisp       |  1958 | John McCarthy                              |
+  # | Fortran    |  1957 | John Backus                                |
+  # | COBOL      |  1959 | Grace Hopper and team                      |
+  # | Algol      |  1958 | International group of computer scientists |
+  # | BASIC      |  1964 | John G. Kemeny and Thomas E. Kurtz         |
+  # | Pascal     |  1970 | Niklaus Wirth                              |
+  # | C          |  1972 | Dennis Ritchie                             |
+  # | Prolog     |  1972 | Alain Colmerauer, Robert Kowalski          |
+  # | C++        |  1983 | Bjarne Stroustrup                          |
+  # | Python     |  1989 | Guido van Rossum                           |
+  # |------------+-------+--------------------------------------------|
+EOS
+#+END_SRC
+
+# > | Language   | Birth | Creator                                    |
+# > |------------|-------|--------------------------------------------|
+# > | Lisp       |  1958 | John McCarthy                              |
+# > | Fortran    |  1957 | John Backus                                |
+# > | COBOL      |  1959 | Grace Hopper and team                      |
+# > | Algol      |  1958 | International group of computer scientists |
+# > | BASIC      |  1964 | John G. Kemeny and Thomas E. Kurtz         |
+# > | Pascal     |  1970 | Niklaus Wirth                              |
+# > | C          |  1972 | Dennis Ritchie                             |
+# > | Prolog     |  1972 | Alain Colmerauer, Robert Kowalski          |
+# > | C++        |  1983 | Bjarne Stroustrup                          |
+# > | Python     |  1989 | Guido van Rossum                           |

data/doc/0160_method.rb

@@ -0,0 +1,37 @@
+require "./setup"
+
+### Explain the 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
+
+  #+name: String#reverse
+  #+desc: reverse the sequence of characters
+  #+comment: Comments about reverse
+  "abc".reverse                   # => "cba"
+EOS
+#+END_SRC
+
+# > ### String#size ###
+# >
+# > Return the number of characters
+# >
+# > ```ruby
+# > "abc".size  # => 3
+# > ```
+# >
+# > Comments about size
+# >
+# > ### String#reverse ###
+# >
+# > reverse the sequence of characters
+# >
+# > ```ruby
+# > "abc".reverse  # => "cba"
+# > ```
+# >
+# > Comments about reverse

data/doc/0170_alert.rb

@@ -0,0 +1,25 @@
+require "./setup"
+
+### Warning, Alert Message ###
+
+# Exclusive to Zenn
+
+#+BEGIN_SRC
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+warn: this is warning message
+
+  #+alert: this is alert message
+EOS
+#+END_SRC
+
+# > ```
+# > :::message
+# > this is warning message
+# > :::
+# > ```
+# >
+# > ```
+# > :::message alert
+# > this is alert message
+# > :::
+# > ```

data/doc/0180_text.rb

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,19 @@
+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/doc/setup.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+require "source2md"
+Source2MD.logger.level = :debug if false
+

data/examples/element_alert.rb

@@ -0,0 +1,22 @@
+require "./setup"
+
+puts Source2MD::Element.new(<<~EOS).to_md
+#+alert: (foo)
+EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementAlert
+# >> 
+# >> head:
+# >> {:alert=>"(foo)"}
+# >> 
+# >> in:
+# >> 
+# >> 
+# >> out:
+# >> :::message alert
+# >> (foo)
+# >> :::
+# >> --------------------------------------------------------------------------------
+# >> :::message alert
+# >> (foo)
+# >> :::

data/examples/element_deep_comment.rb

@@ -1,22 +1,18 @@
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
-## foo
+## (foo)
 EOS
-# >> --------------------------------------------------------------------------------
-# >> Source2MD::Type::ElementDeepComment
-# >> 
-# >> head:
-# >> {}
-# >> 
-# >> in:
-# >> ## foo
-# >> 
-# >> out:
+# >> > -------------------------------------------------------------------------------- Source2MD::Type::ElementPartialCode
+# >> > {}
+# >> > ------------------------------------------------------------ in
+# >> > ## (foo)
+# >> > 
+# >> > ------------------------------------------------------------ out
+# >> > ```ruby
+# >> > ## (foo)
+# >> > ```
+# >> > ------------------------------------------------------------
 # >> ```ruby
-# >> # foo
-# >> ```
-# >> --------------------------------------------------------------------------------
-# >> ```ruby
-# >> # foo
+# >> ## (foo)
 # >> ```

data/examples/element_include.rb

@@ -0,0 +1,20 @@
+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_md_header.rb

@@ -2,7 +2,7 @@ require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
 ---
-foo
+(foo)
 ---
 EOS
 # >> --------------------------------------------------------------------------------
@@ -13,14 +13,14 @@ EOS
 # >> 
 # >> in:
 # >> ---
-# >> foo
+# >> (foo)
 # >> ---
 # >> 
 # >> out:
 # >> ---
-# >> foo
+# >> (foo)
 # >> ---
 # >> --------------------------------------------------------------------------------
 # >> ---
-# >> foo
+# >> (foo)
 # >> ---

data/examples/element_md_title.rb

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