source2md 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a21ad256d10d0e8ac822542cfd3b1487ac15ce8e24e9ca7d49b79b8ebef0a29c
-  data.tar.gz: d437547f1970f22495788b9a39df4c4c953a90a567765181c8ba3fad37dbc095
+  metadata.gz: a69cc0fff709a6adfac13be6784fb107d230200b6797391dfd2c970fab4f48ca
+  data.tar.gz: 14168fb1b130a4112eb08c4408d6c4bc84b70e5db1b53889201d2c5094343d32
 SHA512:
-  metadata.gz: '0920cf0732141436270a375f378a2981b28fcbcefb58e74c4eca9d29fb83e3473ccbc161c956cef54c24ab998d62c618c38fcca6c66cb63422ea6458363448dd'
-  data.tar.gz: e25345a90c1e3d46899a762a87582b3c9c6e2ec398d38a2a1c815af4fe03094ec823ef840b97a24e7089c3636280f940c5192751213e2e7eecfdfcec8ac74e97
+  metadata.gz: c539724001175e52377e62c132ed15d622fdc854dfc02b20f6aa6018bc108044832c9bd2617f9c198ff3261c70fc2876da0004a9b862c462d0af3b5b32f39148
+  data.tar.gz: 12fc867c80e7012e8199264fd7c7c2c90d1a0c6e3ead297317deceaeca66b83176fc23389b2803bf060383341b7a5c2321cb90c2da121d73d6db6806fa36ac26

data/README.md

@@ -273,7 +273,7 @@ Using this option allows you to split a line regardless of the markdown library.
 
 ```ruby
 puts Source2MD::Section.new(<<~EOS).to_md
-  #+oneline: true
+  #+squish: true
   # Lorem ipsum dolor sit amet, consectetur adipisicing elit,
   # sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 EOS

data/doc/0220_text_oneline.rb

@@ -7,7 +7,7 @@ require "./setup"
 
 #+BEGIN_SRC
 puts Source2MD::Section.new(<<~EOS).to_md
-  #+oneline: true
+  #+squish: true
   # Lorem ipsum dolor sit amet, consectetur adipisicing elit,
   # sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 EOS

data/examples/cli-test.rs

@@ -0,0 +1,3 @@
+  a
+    b
+  c

data/examples/cli-test.sh

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

data/examples/type_alert.rb

@@ -4,20 +4,16 @@ require "./setup"
 puts Source2MD::Element.new(<<~EOS).to_md
 #+alert: (foo)
 EOS
-# >> --------------------------------------------------------------------------------
-# >> Source2MD::Part::TypeAlert
-# >>
-# >> head:
-# >> {:alert=>"(foo)"}
-# >>
-# >> in:
-# >>
-# >>
-# >> out:
-# >> :::message alert
-# >> (foo)
-# >> :::
-# >> --------------------------------------------------------------------------------
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeAlert
+# >> > {"alert"=>"(foo)"}
+# >> > ------------------------------------------------------------ in
+# >> >
+# >> >
+# >> > ------------------------------------------------------------ out
+# >> > :::message alert
+# >> > (foo)
+# >> > :::
+# >> > ------------------------------------------------------------
 # >> :::message alert
 # >> (foo)
 # >> :::

data/examples/type_partial_code.rb

@@ -2,22 +2,26 @@
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
-(foo)
+  a
+    b
+  c
 EOS
-# >> --------------------------------------------------------------------------------
-# >> Source2MD::Part::TypePartialCode
-# >> 
-# >> head:
-# >> {}
-# >> 
-# >> in:
-# >> (foo)
-# >> 
-# >> out:
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypePartialCode
+# >> > {}
+# >> > ------------------------------------------------------------ in
+# >> > a
+# >> >   b
+# >> > c
+# >> > 
+# >> > ------------------------------------------------------------ out
+# >> > ```ruby
+# >> > a
+# >> >   b
+# >> > c
+# >> > ```
+# >> > ------------------------------------------------------------
 # >> ```ruby
-# >> (foo)
-# >> ```
-# >> --------------------------------------------------------------------------------
-# >> ```ruby
-# >> (foo)
+# >> a
+# >>   b
+# >> c
 # >> ```

data/examples/type_text.rb

@@ -2,7 +2,7 @@
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
-#+oneline: true
+#+squish: true
 # a
 # b
 #
@@ -25,18 +25,18 @@ puts Source2MD::Element.new(<<~EOS).to_md
 EOS
 
 # >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeText
-# >> > {"oneline"=>"true"}
+# >> > {"squish"=>"true"}
 # >> > ------------------------------------------------------------ in
 # >> > # a
 # >> > # b
 # >> > #
 # >> > # c
 # >> > # d
-# >> > 
+# >> >
 # >> > ------------------------------------------------------------ out
-# >> > abcd
+# >> > a b c d
 # >> > ------------------------------------------------------------
-# >> abcd
+# >> a b c d
 # >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeText
 # >> > {"squish"=>"true"}
 # >> > ------------------------------------------------------------ in
@@ -45,7 +45,7 @@ EOS
 # >> > #
 # >> > # c
 # >> > # d
-# >> > 
+# >> >
 # >> > ------------------------------------------------------------ out
 # >> > a b c d
 # >> > ------------------------------------------------------------
@@ -54,7 +54,7 @@ EOS
 # >> > {"hankaku_kana"=>"true"}
 # >> > ------------------------------------------------------------ in
 # >> > # ｱア
-# >> > 
+# >> >
 # >> > ------------------------------------------------------------ out
 # >> > ｱｱ
 # >> > ------------------------------------------------------------

data/examples/type_title.rb

@@ -4,22 +4,14 @@ require "./setup"
 puts Source2MD::Element.new(<<~EOS).to_md
 #+title2: (foo)
 EOS
-# >> title2: (foo)
-# >> --------------------------------------------------------------------------------
-# >> Source2MD::Part::TypeTitle
-# >>
-# >> head:
-# >> {:title2=>"(foo)"}
-# >>
-# >> in:
-# >>
-# >>
-# >> out:
-# >>
-# >> (foo)
-# >>
-# >> --------------------------------------------------------------------------------
-# >> title2: (foo)
-# >>
-# >> (foo)
-# >>
+# >> ## (foo) ##
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeTitle
+# >> > {"title2"=>"(foo)"}
+# >> > ------------------------------------------------------------ in
+# >> >
+# >> >
+# >> > ------------------------------------------------------------ out
+# >> > ## (foo) ##
+# >> > ------------------------------------------------------------
+# >> ## (foo) ##
+# >> ## (foo) ##

data/examples/type_warn.rb

@@ -2,22 +2,18 @@
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
-#+info: (foo)
+#+warn: (foo)
 EOS
-# >> --------------------------------------------------------------------------------
-# >> Source2MD::Part::ElementInfo
-# >> 
-# >> head:
-# >> {:info=>"(foo)"}
-# >> 
-# >> in:
-# >> 
-# >> 
-# >> out:
-# >> :::message
-# >> (foo)
-# >> :::
-# >> --------------------------------------------------------------------------------
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeWarn
+# >> > {"warn"=>"(foo)"}
+# >> > ------------------------------------------------------------ in
+# >> > 
+# >> > 
+# >> > ------------------------------------------------------------ out
+# >> > :::message
+# >> > (foo)
+# >> > :::
+# >> > ------------------------------------------------------------
 # >> :::message
 # >> (foo)
 # >> :::

data/lib/source2md/cli.rb

@@ -2,6 +2,7 @@ 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
 
     def initialize(...)
       super
@@ -12,6 +13,7 @@ module Source2MD
       end
 
       Source2MD.xmp_out_exclude = options[:xmp_out_exclude]
+      Source2MD.readonly = options[:readonly]
 
       tp Source2MD.config
     end
@@ -20,7 +22,7 @@ module Source2MD
 
     map "g" => :generate
     desc "generate [files]", "Markdown generation"
-    option :output_file, type: :string, aliases: "-o", default: "output.md"
+    option :output_file, type: :string, aliases: "-o", default: nil
     def generate(*files)
       Generator.new(options.to_options.merge(files: files)).call
     end

data/lib/source2md/code_block.rb

@@ -1,7 +1,7 @@
 module Source2MD
   class CodeBlock
     PADDING_KEEP = 2
-    MARK         = "# =>"
+    MARK         = /(?:#|\/\/) =>/
 
     attr_accessor :code
 
@@ -58,21 +58,29 @@ module Source2MD
     # end
 
     def comment_mark_justfiy(line)
-      line.gsub(/(.*?)\s*#{MARK}(.*)/) {
-        a, b = Regexp.last_match.captures
+      line.gsub(/(.*?)\s*(#{MARK})(.*)/) {
+        a, b, c = Regexp.last_match.captures
         space = " " * (PADDING_KEEP + (max - a.size))
-        [a, space, MARK, b].join
+        [a, space, b, c].join
       }
     end
 
+    def raw_lines
+      @raw_lines ||= code.lines.collect(&:rstrip)
+    end
+
     def lines
-      @lines ||= code.strip.lines.collect(&:rstrip)
+      @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
     end
 
     def max
       @max ||= yield_self do
         av = lines
-        av = av.find_all { |e| e.include?(MARK) }
+        av = av.find_all { |e| e.match?(MARK) }
         av = av.collect { |e| e.gsub(/\s*#{MARK}.*/, "").size }
         av.max
       end

data/lib/source2md/element.rb

@@ -1,6 +1,6 @@
 module Source2MD
   class Element
-    KEY_VALUE_REGEXP = /^#\+(\S+):\s*(.*)\R?/ # #+key: value
+    KEY_VALUE_REGEXP = /^(?:#|\/\/)\+(\S+):\s*(.*)\R?/ # #+key: value
 
     PLUGINS = [
       Formatter::TypeHidden,       # #+hidden: true
@@ -34,7 +34,7 @@ module Source2MD
     end
 
     def body
-      @body ||= @content.remove(KEY_VALUE_REGEXP).strip.freeze
+      @body ||= @content.remove(KEY_VALUE_REGEXP).rstrip.freeze
     end
 
     private

data/lib/source2md/generator.rb

@@ -7,8 +7,20 @@ module Source2MD
     end
 
     def call
-      output_file.write(to_md)
-      puts "write: #{output_file}"
+      if !output_file
+        puts to_md
+      end
+
+      if output_file
+        if output_file.exist?
+          FileUtils.chmod("a+w", output_file)
+        end
+        output_file.write(to_md)
+        if Source2MD.readonly
+          FileUtils.chmod("a-w", output_file)
+        end
+        puts "write: #{output_file}"
+      end
     end
 
     def to_md
@@ -28,7 +40,11 @@ module Source2MD
     end
 
     def output_file
-      @output_file ||= Pathname(params[:output_file]).expand_path
+      @output_file ||= yield_self do
+        if v = params[:output_file]
+          Pathname(v).expand_path
+        end
+      end
     end
   end
 end

data/lib/source2md/scanner.rb

@@ -24,7 +24,7 @@ module Source2MD
       end
       v = v + "\n\n"
       v = v.scan(PARAGRAPH_RE)
-      v = v.collect(&:strip)
+      v = v.collect(&:rstrip)
       v = v.find_all(&:present?)
     end
   end

data/lib/source2md/version.rb

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

data/lib/source2md.rb

@@ -14,6 +14,7 @@ module Source2MD
   include ActiveSupport::Configurable
   config_accessor(:debug) { false }
   config_accessor(:xmp_out_exclude) { false }
+  config_accessor(:readonly) { true }
 end
 
 require "zeitwerk"

data/output.md

@@ -0,0 +1,13 @@
+```ruby
+a
+```
+
+```ruby
+r.xy();      // => Vec2(0.0, 0.0)
+    r.xy();  // => Vec2(0.0, 0.0)
+    r.xy();  // => Vec2(0.0, 0.0)
+```
+
+```ruby
+b
+```

data/spec/scanner_spec.rb

@@ -17,10 +17,17 @@ module Source2MD
       #+BEGIN_SRC
       foo
       #+END_SRC
+
       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"] }
     end
   end
 end
+# >> .
+# >> 
+# >> Finished in 0.00793 seconds (files took 0.26816 seconds to load)
+# >> 1 example, 0 failures
+# >> 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source2md
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Akira Ikeda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-28 00:00:00.000000000 Z
+date: 2023-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -165,6 +165,8 @@ files:
 - doc/0240_text_hankaku_kana.rb
 - doc/0250_parse_include.rb
 - doc/setup.rb
+- examples/cli-test.rs
+- examples/cli-test.sh
 - examples/cli.rb
 - examples/element_text.rb
 - examples/input.rb
@@ -210,6 +212,7 @@ files:
 - lib/source2md/tasks/test.rake
 - lib/source2md/text_helper.rb
 - lib/source2md/version.rb
+- output.md
 - source2md.gemspec
 - spec/code_block_spec.rb
 - spec/formatter/sample.yml
@@ -248,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: Markdown generator from source code