source2md 0.0.14 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3477e280893742563cabf28b242a48d0efdc0943294c902a0fd7085950213b6a
-  data.tar.gz: 6a0c6f3b324fe3cd6b6d6e9fd1c038fba91dcbaf3aff742cf8f80ef2129c49a7
+  metadata.gz: f98cf52536b132ac7b8a7ed2b99653c0b1c668c0d3b7bd3681e898854fa00b8a
+  data.tar.gz: e78fa6dbddfefd98ee5757ca3f41911568df9825c332e1e1453e0df3ff0d7b7f
 SHA512:
-  metadata.gz: be3fb7b9ef5f24186a2b613fd10d42d5d0bbad7781d99b9ac72251dda336b13d50737febd993f6d5ecfc0dfe83fb87930c317b3dc21475afe593e1fecea5173b
-  data.tar.gz: 0e68f783920b8abb32a1e405cecc4f0f881cf9bc71f4b3b2f13fff444b8272b8361d37389f10c4085b55be51c67a439d6ddbc5061bda776a4255797a9ecf1cd3
+  metadata.gz: a9844d91a277c17f86037ab84efbf5b1f0bcd627fbb00ef16188f19b0e90716b0d7402644b7b60f5975919d7b194851d762463b93a7a50461e09b1eb5459d95f
+  data.tar.gz: 8d18aeff6e37f72c9c18c8187d64a62e9078cd534e280ef4c165a99c973f6bf079a610b57d86d8fe9d2b7abc8143ce7a9acbedbce2f710dcb537467358acddf4

data/.gitignore

@@ -2,3 +2,4 @@
 /*.gem
 /pkg
 /spec/.all_test_result.txt
+/*.el

data/README.md

@@ -32,7 +32,8 @@ puts Source2MD::Section.new(<<~EOS).to_md
     "Hello, world!"
   }
 
-  #+code_block_name: (name)
+  #+partial_code_name: (name)
+  #+partial_code_lang: (ruby)
   hello.call
 EOS
 ```
@@ -43,7 +44,7 @@ EOS
 > }
 > ```
 
-> ```ruby:(name)
+> ```(ruby):(name)
 > hello.call
 > ```
 
@@ -316,3 +317,13 @@ EOS
 ```
 
 > foo
+
+### Eval ###
+
+Function for changing internal variables
+
+```ruby
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+eval: Source2MD.lang_default = "shell"
+EOS
+```

data/doc/0110_code_small.rb

@@ -11,7 +11,8 @@ puts Source2MD::Section.new(<<~EOS).to_md
     "Hello, world!"
   }
 
-  #+code_block_name: (name)
+  #+partial_code_name: (name)
+  #+partial_code_lang: (ruby)
   hello.call
 EOS
 #+END_SRC
@@ -22,7 +23,7 @@ EOS
 # > }
 # > ```
 
-# > ```ruby:(name)
+# > ```(ruby):(name)
 # > hello.call
 # > ```
 
@@ -33,6 +34,6 @@ EOS
 # >> ```
 # >> 
 # >> 
-# >> ```ruby:(name)
+# >> ```(ruby):(name)
 # >> hello.call
 # >> ```

data/doc/0250_eval.rb

@@ -0,0 +1,12 @@
+#+hidden: true
+require "./setup"
+
+#+title3: Eval
+
+# Function for changing internal variables
+
+#+BEGIN_SRC
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+eval: Source2MD.lang_default = "shell"
+EOS
+#+END_SRC

data/examples/type_eval.rb

@@ -0,0 +1,18 @@
+#+hidden: true
+require "./setup"
+
+puts Source2MD::Element.new(<<~EOS).to_md
+#+eval: Source2MD.lang_default = "lisp"
+EOS
+# >> head: {"eval"=>"Source2MD.lang_default = \"lisp\""}
+# >> body: ""
+# >> Source2MD::Formatter::TypeEval => Source2MD.lang_default = "lisp"
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeEval
+# >> > {"eval"=>"Source2MD.lang_default = \"lisp\""}
+# >> > ------------------------------------------------------------ in
+# >> > 
+# >> > 
+# >> > ------------------------------------------------------------ out
+# >> > 
+# >> > ------------------------------------------------------------
+# >> 

data/examples/type_partial_code.rb

@@ -4,16 +4,18 @@ require "./setup"
 Source2MD.data_block_exclude = true
 
 puts Source2MD::Element.new(<<~EOS).to_md
-  #+code_block_name: foo
+  #+partial_code_name: foo
+  #+data_block_exclude: true
   a
     b
   c
   __END__
   foo
 EOS
-# >> head: {"code_block_name"=>"foo"}
+# >> head: {"partial_code_name"=>"foo", "data_block_exclude"=>"true"}
 # >> body: "a\n  b\nc\n__END__\nfoo\n"
 # >> Source2MD::Formatter::TypeHidden => false
+# >> Source2MD::Formatter::TypeEval => 
 # >> Source2MD::Formatter::TypeCodeInclude => 
 # >> Source2MD::Formatter::TypeRawInclude => 
 # >> Source2MD::Formatter::TypeParseInclude => 
@@ -26,7 +28,7 @@ EOS
 # >> Source2MD::Formatter::TypeText => false
 # >> Source2MD::Formatter::TypePartialCode => true
 # >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypePartialCode
-# >> > {"code_block_name"=>"foo"}
+# >> > {"partial_code_name"=>"foo", "data_block_exclude"=>"true"}
 # >> > ------------------------------------------------------------ in
 # >> > a
 # >> >   b

data/examples/type_source_block.rb

@@ -2,18 +2,41 @@
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
-#+BEGIN_SRC diff xxx:yyy hidden!
+#+BEGIN_SRC diff xxx:yyy data_block_exclude!
 (foo)
+__END__
+xxx
 #+END_SRC
 EOS
+# >> head: {}
+# >> body: "#+BEGIN_SRC diff xxx:yyy data_block_exclude!\n(foo)\n__END__\nxxx\n#+END_SRC\n"
+# >> Source2MD::Formatter::TypeHidden => false
+# >> Source2MD::Formatter::TypeEval => 
+# >> Source2MD::Formatter::TypeCodeInclude => 
+# >> Source2MD::Formatter::TypeRawInclude => 
+# >> Source2MD::Formatter::TypeParseInclude => 
+# >> Source2MD::Formatter::TypeTitle => false
+# >> Source2MD::Formatter::TypeWarn => 
+# >> Source2MD::Formatter::TypeAlert => 
+# >> Source2MD::Formatter::TypeMethod => 
+# >> Source2MD::Formatter::TypeTable => false
+# >> Source2MD::Formatter::TypeSourceBlock => true
 # >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeSourceBlock
 # >> > {}
 # >> > ------------------------------------------------------------ in
-# >> > #+BEGIN_SRC diff xxx:yyy hidden!
+# >> > #+BEGIN_SRC diff xxx:yyy data_block_exclude!
 # >> > (foo)
+# >> > __END__
+# >> > xxx
 # >> > #+END_SRC
 # >> > 
+# >> > 
 # >> > ------------------------------------------------------------ out
+# >> > ```diff xxx:yyy
+# >> > (foo)
+# >> > ```
 # >> > 
 # >> > ------------------------------------------------------------
-# >> 
+# >> ```diff xxx:yyy
+# >> (foo)
+# >> ```

data/lib/source2md/cli.rb

@@ -4,7 +4,7 @@ module Source2MD
     class_option :xmp_out_exclude,    type: :boolean, aliases: "-x", default: false
     class_option :data_block_exclude, type: :boolean,                default: false
     class_option :readonly,           type: :boolean, aliases: "-r", default: true
-    class_option :default_lang,       type: :string,  aliases: "-l", default: "ruby"
+    class_option :lang_default,       type: :string,  aliases: "-l", default: "ruby"
     class_option :prefix_re,          type: :string
     class_option :comment_re,         type: :string
 
@@ -19,7 +19,7 @@ module Source2MD
       Source2MD.xmp_out_exclude    = options[:xmp_out_exclude]
       Source2MD.data_block_exclude = options[:data_block_exclude]
       Source2MD.readonly           = options[:readonly]
-      Source2MD.default_lang       = options[:default_lang]
+      Source2MD.lang_default       = options[:lang_default]
 
       Source2MD::RE.update do |e|
         if v = options[:prefix_re]

data/lib/source2md/code_block.rb

@@ -6,7 +6,9 @@ module Source2MD
     def initialize(text, options = {})
       @text = text
       @options = {
+        :desc => nil,
         :lang => nil,
+        :name => nil,
         # :single_sharp_replace_to_blank_line => false,
       }.merge(options)
     end
@@ -21,6 +23,8 @@ module Source2MD
 
     private
 
+    # <-------------------> desc
+    # <- lang ->:<- name ->
     def code_block_head
       o = []
       if s = @options[:desc]
@@ -78,7 +82,7 @@ module Source2MD
     end
 
     def lang
-      @options[:lang] || ENV["DEFAULT_LANG"] || Source2MD.default_lang
+      @options[:lang] || ENV["DEFAULT_LANG"] || Source2MD.lang_default
     end
   end
 end

data/lib/source2md/element.rb

@@ -2,6 +2,7 @@ module Source2MD
   class Element
     PLUGINS = [
       Formatter::TypeHidden,       # #+hidden: true
+      Formatter::TypeEval,          # #+eval:
       Formatter::TypeCodeInclude,  # #+code_include: path/to/foo.html xml:SAMPLE.xml
       Formatter::TypeRawInclude,   # #+raw_include: path/to/file.txt
       Formatter::TypeParseInclude, # #+parse_include: path/to/file.txt

data/lib/source2md/formatter/type_eval.rb

@@ -0,0 +1,14 @@
+module Source2MD
+  module Formatter
+    class TypeEval < Base
+      def self.accept?(element)
+        element.head["eval"]
+      end
+
+      def to_md
+        eval(element.head["eval"])
+        ""
+      end
+    end
+  end
+end

data/lib/source2md/formatter/type_partial_code.rb

@@ -6,18 +6,26 @@ module Source2MD
       end
 
       def to_md
-        CodeBlock.new(body, name: element.head["code_block_name"]).to_md
+        CodeBlock.new(body, code_block_options).to_md
       end
 
       private
 
       def body
-        if Source2MD.data_block_exclude
-          element.body.sub(/^__END__\R.*/m, "")
+        if element.head["data_block_exclude"] || Source2MD.data_block_exclude
+          TextHelper.data_block_exclude(element.body)
         else
           element.body
         end
       end
+
+      def code_block_options
+        {
+          lang: element.head["partial_code_lang"],
+          name: element.head["partial_code_name"],
+          desc: element.head["partial_code_desc"],
+        }
+      end
     end
   end
 end

data/lib/source2md/formatter/type_source_block.rb

@@ -1,31 +1,53 @@
 module Source2MD
   module Formatter
     class TypeSourceBlock < Base
+      OPTION_KEYS = [
+        "hidden!",
+        "data_block_exclude!",
+      ]
+
       def self.accept?(element)
         element.body.match?(%r{#{RE.meta_re}\+BEGIN_SRC})
       end
 
       def to_md
-        if code_block_desc_keywords.include?("hidden!")
+        if option_list.include?("hidden!")
           return ""
         end
-        CodeBlock.new(body, desc: code_block_desc).to_md
+        CodeBlock.new(body, desc: clean_descs.join(" ").presence).to_md
       end
 
       private
 
       def body
-        element.body.match(%r{#{RE.meta_re}\+BEGIN_SRC.*?\R(.*)#{RE.meta_re}\+END_SRC}m).captures.first
+        content = element.body.match(%r{#{RE.meta_re}\+BEGIN_SRC.*?\R(.*)#{RE.meta_re}\+END_SRC}m).captures.first
+        data_block_exclude(content)
       end
 
-      def code_block_desc
+      def desc_line
         if md = element.body.match(%r{#{RE.meta_re}\+BEGIN_SRC (.+)\R})
           md.captures.first
         end
       end
 
-      def code_block_desc_keywords
-        code_block_desc.to_s.split(/\s+/).to_set
+      def option_list
+        @option_list ||= desc_line.to_s.split(/\s+/).to_set
+      end
+
+      def data_block_exclude(content)
+        if data_block_exclude?
+          TextHelper.data_block_exclude(content)
+        else
+          content
+        end
+      end
+
+      def data_block_exclude?
+        option_list.include?("data_block_exclude!") || Source2MD.data_block_exclude
+      end
+
+      def clean_descs
+        option_list - OPTION_KEYS
       end
     end
   end

data/lib/source2md/formatter/type_text.rb

@@ -1,13 +1,16 @@
 module Source2MD
   module Formatter
     class TypeText < Base
+
       # "# xxx"
       # "#"
-      REGEXP = %r{#{RE.meta_re}( |$)}
+      def self.regexp
+        %r{#{RE.meta_re}( |$)}
+      end
 
       def self.accept?(element)
         if element.body.present?
-          element.body.lines.all? { |e| e.match?(REGEXP) }
+          element.body.lines.all? { |e| e.match?(regexp) }
         end
       end
 
@@ -18,7 +21,7 @@ module Source2MD
       private
 
       def body
-        s = element.body.remove(REGEXP)
+        s = element.body.remove(self.class.regexp)
         if element.head["squish"] == "true"
           s = TextHelper.squish(s)
         end

data/lib/source2md/regexp_builder.rb

@@ -28,6 +28,7 @@ module Source2MD
     def reset
       @meta_re = nil
       @stdout_re = nil
+      @text_prefix_re = nil
     end
   end
 end

data/lib/source2md/text_helper.rb

@@ -30,5 +30,9 @@ module Source2MD
       min = text.lines.reject(&:blank?).collect { |e| e.slice(/^\s*/).size }.min
       text.remove(/^ {#{min}}/)
     end
+
+    def data_block_exclude(text)
+      text.sub(/^__END__\R.*/m, "")
+    end
   end
 end

data/lib/source2md/version.rb

@@ -1,3 +1,3 @@
 module Source2MD
-  VERSION = "0.0.14"
+  VERSION = "0.0.16"
 end

data/lib/source2md.rb

@@ -15,7 +15,7 @@ module Source2MD
   config_accessor(:debug) { false }
   config_accessor(:xmp_out_exclude) { false }
   config_accessor(:readonly) { true }
-  config_accessor(:default_lang) { "ruby" }
+  config_accessor(:lang_default) { "ruby" }
   config_accessor(:data_block_exclude) { false }
 end
 

data/spec/formatter/type_eval_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+module Source2MD
+  describe do
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+#+eval: 1 + 2
+EOS
+    end
+  end
+end
+# >> .
+# >> 
+# >> Finished in 0.00398 seconds (files took 0.34568 seconds to load)
+# >> 1 example, 0 failures
+# >> 

data/spec/formatter/type_partial_code_spec.rb

@@ -4,14 +4,16 @@ module Source2MD
   describe do
     it "works" do
       actual = Element.new(<<~EOS).to_md
-#+code_block_name: xxx
+#+partial_code_name: xxx
+#+partial_code_lang: yyy
+#+data_block_exclude: true
 (foo)
 __END__
 1
 2
 EOS
       actual.should == <<~EOS
-```ruby:xxx
+```yyy:xxx
 (foo)
 ```
       EOS

data/spec/formatter/type_source_block_spec.rb

@@ -36,5 +36,42 @@ module Source2MD
       EOS
       actual.should == ""
     end
+
+    it "works" do
+      actual = Element.new(<<~EOS).to_md
+      #+BEGIN_SRC xxx:yyy data_block_exclude!
+      (foo)
+      __END__
+      xxx
+      #+END_SRC
+      EOS
+      actual.should == <<~EOS
+```xxx:yyy
+(foo)
+```
+      EOS
+    end
   end
 end
+# >> ...F
+# >> 
+# >> Failures:
+# >> 
+# >>   1) works
+# >>      Failure/Error: Unable to find - to read failed line
+# >> 
+# >>        expected: ""
+# >>             got: "```xxx:yyy data_block_exclude\n```\n" (using ==)
+# >>        Diff:
+# >>        @@ -1,2 +1,4 @@
+# >>        +```xxx:yyy data_block_exclude
+# >>        +```
+# >>      # -:47:in `block (2 levels) in <module:Source2MD>'
+# >> 
+# >> Finished in 0.01747 seconds (files took 0.33507 seconds to load)
+# >> 4 examples, 1 failure
+# >> 
+# >> Failed examples:
+# >> 
+# >> rspec -:40 # works
+# >> 

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@ Zeitwerk::Loader.eager_load_all
 
 Source2MD.logger.level = :error
 Source2MD.xmp_out_exclude = true
-Source2MD.data_block_exclude = true
+# Source2MD.data_block_exclude = true
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|

data/spec/text_helper_spec.rb

@@ -19,5 +19,9 @@ module Source2MD
       assert { TextHelper.space_prefix_remove(" a\n  b\n") == "a\n b\n" }
       assert { TextHelper.space_prefix_remove(" a\n\n  b\n") == "a\n\n b\n" }
     end
+
+    it "data_block_exclude" do
+      assert { TextHelper.data_block_exclude("(before)\n__END__\n(after)") == "(before)\n" }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source2md
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.16
 platform: ruby
 authors:
 - Akira Ikeda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-24 00:00:00.000000000 Z
+date: 2023-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -163,6 +163,7 @@ files:
 - doc/0220_text_squish.rb
 - doc/0230_text_hankaku_kana.rb
 - doc/0240_parse_include.rb
+- doc/0250_eval.rb
 - doc/setup.rb
 - examples/cli-test.rs
 - examples/cli-test.sh
@@ -175,6 +176,7 @@ files:
 - examples/setup.rb
 - examples/type_alert.rb
 - examples/type_code_include.rb
+- examples/type_eval.rb
 - examples/type_hidden.rb
 - examples/type_method.rb
 - examples/type_partial_code.rb
@@ -191,6 +193,7 @@ files:
 - lib/source2md/formatter/type_alert.rb
 - lib/source2md/formatter/type_code_include.rb
 - lib/source2md/formatter/type_else.rb
+- lib/source2md/formatter/type_eval.rb
 - lib/source2md/formatter/type_hidden.rb
 - lib/source2md/formatter/type_method.rb
 - lib/source2md/formatter/type_nop.rb
@@ -217,6 +220,7 @@ files:
 - spec/formatter/sample.yml
 - spec/formatter/type_alert_spec.rb
 - spec/formatter/type_code_include_spec.rb
+- spec/formatter/type_eval_spec.rb
 - spec/formatter/type_hidden_spec.rb
 - spec/formatter/type_method_spec.rb
 - spec/formatter/type_parse_include_spec.rb
@@ -250,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Markdown generator from source code
@@ -259,6 +263,7 @@ test_files:
 - spec/formatter/sample.yml
 - spec/formatter/type_alert_spec.rb
 - spec/formatter/type_code_include_spec.rb
+- spec/formatter/type_eval_spec.rb
 - spec/formatter/type_hidden_spec.rb
 - spec/formatter/type_method_spec.rb
 - spec/formatter/type_parse_include_spec.rb