source2md 0.0.1 → 0.0.3

data/examples/element_method.rb

@@ -1,13 +1,37 @@
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
-# name: (name)
-# desc: (desc)
-# comment: (comment)
+#+name: (name)
+#+desc: (desc)
+#+comment: (comment)
 code1
 #
 code2
 EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementMethod
+# >> 
+# >> head:
+# >> {:name=>"(name)", :desc=>"(desc)", :comment=>"(comment)"}
+# >> 
+# >> in:
+# >> code1
+# >> #
+# >> code2
+# >> 
+# >> out:
+# >> ### (name)
+# >> 
+# >> (desc)
+# >> 
+# >> ```ruby
+# >> code1
+# >> 
+# >> code2
+# >> ```
+# >> 
+# >> (comment)
+# >> --------------------------------------------------------------------------------
 # >> ### (name)
 # >> 
 # >> (desc)

data/examples/element_partial_code.rb

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

data/examples/element_reject.rb

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

data/examples/element_source_block.rb

@@ -0,0 +1,28 @@
+require "./setup"
+
+puts Source2MD::Element.new(<<~EOS).to_md
+#+BEGIN_SRC diff xxx:yyy
+(foo)
+#+END_SRC
+EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementSourceBlock
+# >> 
+# >> head:
+# >> {}
+# >> 
+# >> in:
+# >> #+BEGIN_SRC diff xxx:yyy
+# >> (foo)
+# >> #+END_SRC
+# >> 
+# >> out:
+# >> ```diff xxx:yyy
+# >> diff xxx:yyy
+# >> (foo)
+# >> ```
+# >> --------------------------------------------------------------------------------
+# >> ```diff xxx:yyy
+# >> diff xxx:yyy
+# >> (foo)
+# >> ```

data/examples/element_table.rb

@@ -2,13 +2,25 @@ require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
 # |---+---+---|
-# | x | x | x |
+# | 1 | 1 | 1 |
 # |---+---+---|
-# | x | x | x |
-# | x | x | x |
+# | 1 | 1 | 1 |
+# | 1 | 1 | 1 |
 # |---+---+---|
 EOS
-# >> | x | x | x |
+
+puts Source2MD::Element.new(<<~EOS).to_md
+# | 2 | 2 | 2 |
+# |---+---+---|
+# | 2 | 2 | 2 |
+# | 2 | 2 | 2 |
+EOS
+
+# >> | 1 | 1 | 1 |
+# >> |---|---|---|
+# >> | 1 | 1 | 1 |
+# >> | 1 | 1 | 1 |
+# >> | 2 | 2 | 2 |
 # >> |---|---|---|
-# >> | x | x | x |
-# >> | x | x | x |
+# >> | 2 | 2 | 2 |
+# >> | 2 | 2 | 2 |

data/examples/element_text.rb

@@ -4,5 +4,19 @@ puts Source2MD::Element.new(<<~EOS).to_md
 # - foo
 #   https://example.com/
 EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementUncomment
+# >> 
+# >> head:
+# >> {}
+# >> 
+# >> in:
+# >> # - foo
+# >> #   https://example.com/
+# >> 
+# >> out:
+# >> - foo
+# >>   https://example.com/
+# >> --------------------------------------------------------------------------------
 # >> - foo
 # >>   https://example.com/

data/examples/element_title.rb

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

data/examples/element_warn.rb

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

data/examples/input.rb

@@ -1,13 +1,13 @@
-# title2: (title)
+#+title2: (title)
 
-# name: (name1)
-# desc: (desc1)
-# comment: (comment1)
+#+name: (name1)
+#+desc: (desc1)
+#+comment: (comment1)
 "foo1".size                          # => 4
 
-# name: (name2)
-# desc: (desc2)
-# comment: (comment2)
+#+name: (name2)
+#+desc: (desc2)
+#+comment: (comment2)
 "foo2".size                          # => 4
 
 # |---+---+---|
@@ -16,3 +16,7 @@
 # | x | x | x |
 # | x | x | x |
 # |---+---+---|
+
+#+BEGIN_SRC
+1 + 2                           # => 3
+#+END_SRC

data/examples/input.yml

@@ -0,0 +1,3 @@
+---
+one:
+  foo: 1

data/examples/output.md

@@ -1,26 +1,11 @@
-## (title)
-
-### (name1)
-
-(desc1)
-
 ```ruby
-"foo1".size  # => 4
+# ```yaml:config.yml
+#   frequencies: frequencies1.rb
+# ```
 ```
 
-(comment1)
-
-### (name2)
-
-(desc2)
-
-```ruby
-"foo2".size  # => 4
+```ruby:frequencies1.rb
+def frequencies(words)
+  words.tally.sort_by { -_2 }.take(25)
+end
 ```
-
-(comment2)
-
-| x | x | x |
-|---|---|---|
-| x | x | x |
-| x | x | x |

data/examples/scanner.rb

@@ -0,0 +1,24 @@
+require "./setup"
+
+Source2MD::Scanner.new(<<~EOS).to_a # => ["foo", "#+BEGIN_SRC\n\nfoo\n\n#+END_SRC", "foo"]
+foo
+
+#+BEGIN_SRC
+
+foo
+
+#+END_SRC
+
+foo
+EOS
+
+Source2MD::Scanner.new(<<~EOS).to_a # => ["foo", "# ```yaml\n#+foo:\n#   a\n# ```", "bar"]
+foo
+
+# ```yaml
+#+foo:
+#   a
+# ```
+
+bar
+EOS

data/examples/setup.rb

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

data/lib/source2md/cli.rb

@@ -1,9 +1,25 @@
 module Source2MD
   class Cli < Thor
-    class_option :debug, type: :boolean
-    class_option :quiet, type: :boolean
+    class_option :debug,           type: :boolean, aliases: "-d", default: false
+    class_option :xmp_out_exclude, type: :boolean, aliases: "-x", default: false
 
-    desc "generate [files]", "生成"
+    def initialize(...)
+      super
+
+      if options[:debug]
+        Source2MD.logger.level = :debug
+        Source2MD.debug = true
+      end
+
+      Source2MD.xmp_out_exclude = options[:xmp_out_exclude]
+
+      tp Source2MD.config
+    end
+
+    # default_command :generate
+
+    map "g" => :generate
+    desc "generate [files]", "Markdown generation"
     option :output_file, type: :string, aliases: "-o", default: "output.md"
     def generate(*files)
       Generator.new(options.to_options.merge(files: files)).call

data/lib/source2md/code_block.rb

@@ -5,13 +5,16 @@ module Source2MD
 
     attr_accessor :code
 
-    def initialize(code)
+    def initialize(code, options = {})
       @code = code
+      @options = {
+        lang: "ruby",
+      }.merge(options)
     end
 
     def to_md
       [
-        "```ruby",
+        "```#{code_block_head}",
         normalized_code,
         "```",
       ] * "\n"
@@ -19,6 +22,22 @@ module Source2MD
 
     private
 
+    def code_block_head
+      o = []
+      if s = @options[:desc]
+        o << s
+      else
+        if s = @options[:lang]
+          o << s
+        end
+        if s = @options[:name]
+          o << ":"
+          o << s
+        end
+      end
+      o.join
+    end
+
     def normalized_code
       lines.collect(&method(:normalize)) * "\n"
     end

data/lib/source2md/element.rb

@@ -1,16 +1,21 @@
 module Source2MD
   class Element
-    KEY_VALUE = /^# (\w+):\s+(.*)\R?/
+    KEY_VALUE = /^#\+(\S+):\s*(.*)\R?/
 
     PLUGINS = [
-      Type::ElementReject,
-      Type::ElementMdHeader,
-      Type::ElementTitle2,
-      Type::ElementMethod,
-      Type::ElementTable,
-      Type::ElementDeepComment,
-      Type::ElementText,
-      Type::ElementPre,
+      Type::ElementReject,      # require "setup"
+      Type::ElementMdHeader,    # ---
+      Type::ElementMdTitle,     # ## foo ##
+      Type::ElementInclude,     # #+include: foo.txt
+      Type::ElementTitle,       # #+title2: foo
+      Type::ElementWarn,        # #+warn: foo
+      Type::ElementAlert,       # #+alert: foo
+      Type::ElementMethod,      # #+name: foo
+      Type::ElementTable,       # |-
+      Type::ElementSourceBlock, # #+BEGIN_SRC
+      Type::ElementUncomment,   # foo
+      Type::ElementPartialCode, # 1 + 2 # => 3
+      Type::ElementElse,
     ]
 
     def initialize(content)
@@ -18,21 +23,39 @@ module Source2MD
     end
 
     def to_md
-      support_klass.new(self).to_md
+      object = support_klass.new(self)
+      debug_log(object)
+      object.to_md
     end
 
     def head
-      @content.scan(KEY_VALUE).to_h.symbolize_keys
+      @head ||= @content.scan(KEY_VALUE).to_h.symbolize_keys.freeze
     end
 
     def body
-      @content.remove(KEY_VALUE).strip
+      @body ||= @content.remove(KEY_VALUE).strip.freeze
     end
 
     private
 
     def support_klass
-      PLUGINS.find { |e| e.accept?(self) }
+      @support_klass ||= PLUGINS.find { |e| e.accept?(self) }
+    end
+
+    def debug_log(object)
+      Source2MD.logger.debug do
+        o = []
+        o << "-" * 80 + " " + object.class.name
+        o << head
+        o << "-" * 60 + " " + "in"
+        o << body
+        o << ""
+        o << "-" * 60 + " " + "out"
+        o << object.to_md
+        o << "-" * 60
+        s = o.compact * "\n"
+        s.gsub(/^/, "> ")
+      end
     end
   end
 end

data/lib/source2md/generator.rb

@@ -14,13 +14,13 @@ module Source2MD
     private
 
     def to_md
-      s = file_blocks.collect(&:to_md) * "\n\n"
-      s = TextHelper.text_squish(s)
+      s = sections.collect(&:to_md) * "\n\n"
+      s = TextHelper.blank_lines_squish(s)
       s = TextHelper.add_newline_at_end_of_text(s)
     end
 
-    def file_blocks
-      @file_blocks ||= files.collect { |e| FileBlock.new(e) }
+    def sections
+      @sections ||= files.collect { |e| Section.new(e.read) }
     end
 
     def files

data/lib/source2md/logger.rb

@@ -0,0 +1,3 @@
+module Source2MD
+  mattr_accessor(:logger) { ActiveSupport::Logger.new(STDOUT, level: :info) }
+end

data/lib/source2md/scanner.rb

@@ -0,0 +1,34 @@
+module Source2MD
+  class Scanner
+    SEPARATOR           = "\\R{2,}"
+
+    MD_CODE_BLOCK_REGEXP = /^# ```.*?^# ```/m
+
+    BEGIN_KEY           = "BEGIN_SRC"
+    END_KEY             = "END_SRC"
+    SOURCE_BLOCK_REGEXP = /^#\+#{BEGIN_KEY}.*?^#\+#{END_KEY}/m
+
+    NORMAL_BLOCK_REGEXP = /.*?#{SEPARATOR}/m
+
+    PARAGRAPH_REGEXP = Regexp.union [
+      MD_CODE_BLOCK_REGEXP,
+      SOURCE_BLOCK_REGEXP,
+      NORMAL_BLOCK_REGEXP,
+    ]
+
+    def initialize(content)
+      @content = content
+    end
+
+    def to_a
+      v = @content
+      if Source2MD.xmp_out_exclude
+        v = v.remove(/^# >>.*$/)
+      end
+      v = v + "\n\n"
+      v = v.scan(PARAGRAPH_REGEXP)
+      v = v.collect(&:strip)
+      v = v.find_all(&:present?)
+    end
+  end
+end

data/lib/source2md/{file_block.rb → section.rb}

@@ -1,8 +1,7 @@
 module Source2MD
-  class FileBlock
-    def initialize(file)
-      @file = file
-      puts "read: #{file}"
+  class Section
+    def initialize(content)
+      @content = content
     end
 
     def to_md
@@ -12,7 +11,7 @@ module Source2MD
     private
 
     def elements
-      @elements ||= @file.read.strip.split(/\n{2,}/).collect do |e|
+      @elements ||= Scanner.new(@content).to_a.collect do |e|
         Element.new(e)
       end
     end

data/lib/source2md/tasks/about.rake

@@ -1,5 +1,5 @@
 desc "About"
 task :about do
   require "source2md"
-  tp Source2MD::VERSION
+  puts Source2MD::VERSION
 end

data/lib/source2md/text_helper.rb

@@ -2,7 +2,7 @@ module Source2MD
   module TextHelper
     extend self
 
-    def text_squish(text)
+    def blank_lines_squish(text)
       text.gsub(/\n{2,}/, "\n\n")
     end
 

data/lib/source2md/type/base.rb

@@ -11,8 +11,10 @@ module Source2MD
         @element = element
       end
 
-      def to_md
-      end
+      # def to_md
+      # 
+      #   to_md
+      # end
     end
   end
 end

data/lib/source2md/type/element_alert.rb

@@ -0,0 +1,17 @@
+module Source2MD
+  module Type
+    class ElementAlert < Base
+      def self.accept?(element)
+        element.head[:alert]
+      end
+
+      def to_md
+        [
+          ":::message alert",
+          element.head[:alert],
+          ":::",
+        ] * "\n"
+      end
+    end
+  end
+end

data/lib/source2md/type/element_else.rb

@@ -0,0 +1,18 @@
+module Source2MD
+  module Type
+    class ElementElse < Base
+      def self.accept?(element)
+        true
+      end
+
+      def to_md
+        p "-" * 80
+        p element.head
+        p element.body
+        p element
+        p "-" * 80
+        abort
+      end
+    end
+  end
+end

data/lib/source2md/type/element_include.rb

@@ -0,0 +1,45 @@
+module Source2MD
+  module Type
+    class ElementInclude < Base
+      def self.accept?(element)
+        element.head[:include]
+      end
+
+      def initialize(...)
+        super
+
+        @user_define_path, @desc = element.head[:include].split(/\s+/, 2)
+      end
+
+      def to_md
+        CodeBlock.new(body, code_block_options).to_md
+      end
+
+      private
+
+      def path
+        Pathname(@user_define_path).expand_path
+      end
+
+      def body
+        path.read.strip
+      end
+
+      def code_block_options
+        options = element.head.dup
+        options[:desc] ||= @desc
+        options[:lang] ||= auto_lang
+        options[:name] ||= path.basename
+        options
+      end
+
+      def auto_lang
+        {
+          # ".foo" => "bar",
+        }.fetch(path.extname) {
+          path.extname.scan(/\w+/).first
+        }
+      end
+    end
+  end
+end

data/lib/source2md/type/element_md_title.rb

@@ -0,0 +1,13 @@
+module Source2MD
+  module Type
+    class ElementMdTitle < Base
+      def self.accept?(element)
+        element.head.blank? && element.body.match?(/\A(#+)\s+.*\s+\1\z/)
+      end
+
+      def to_md
+        element.body
+      end
+    end
+  end
+end

data/lib/source2md/type/element_method.rb

@@ -7,7 +7,7 @@ module Source2MD
 
       def to_md
         [
-          "### #{element.head[:name]}",
+          "### #{element.head[:name]} ###",
           element.head[:desc],
           body ? CodeBlock.new(body).to_md : nil,
           element.head[:comment],