source2md 0.0.11 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cbcbb886c48d226f8864af1134aa3c0bdac15dcb2adf2acfd8aadb1d9b62bcc
-  data.tar.gz: bdcdb4870afc49aeb7fbb20534a54ba44fd42bd9e1e56c2bb260babe46d9cb74
+  metadata.gz: 563959d92fa1520a3e09544319ff3eb9a50ac0136cc68edb290b98dc6d005e4e
+  data.tar.gz: 895fe538bd66ae956f5892b8278a4f7936140e78e07231d2cab7e6d926834b78
 SHA512:
-  metadata.gz: 9fe4bde35b551e33b11a53a10df2941b3828eba7b5e91c470bae0001f26f95ab2ecb006183fb89384be8fe22d3f9b5c461917b1525e3f002800846f19ea2547a
-  data.tar.gz: ab48da56d8bf0b4ce3755432f9ed281dbceacf67a8cdbb4663b328f614c73bdcc1680a4e03675d8ba547ff638d054f2249644fca5f52c6812b3e17c6474b523c
+  metadata.gz: 83fc8fd71c70f95f3ccdb05b3119ea21dd6a09df913b58b254783189fefd2a370bdffd4d9becf77285ab2c7594a95b8529271f6b1587e94977ee023e4ebffbfb
+  data.tar.gz: 02d4b91d972ce7aeffb30dcd9af76001bbf2d2385e2082cc0db4e0e71d1e6e043930e404651dcff5e63606955b97c28b04d8d2f7b8b34963dd1426ca407528fe

data/examples/output.md

@@ -1,11 +1,30 @@
+## (title) ##
+
+### (name1) ###
+
+(desc1)
+
+```ruby
+"foo1".size  # => 4
+```
+
+(comment1)
+
+### (name2) ###
+
+(desc2)
+
 ```ruby
-# ```yaml:config.yml
-#   frequencies: frequencies1.rb
-# ```
+"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 |
+
+```ruby
+1 + 2  # => 3
 ```

data/examples/type_partial_code.rb

@@ -1,17 +1,38 @@
 #+hidden: true
 require "./setup"
 
+Source2MD.data_block_exclude = true
+
 puts Source2MD::Element.new(<<~EOS).to_md
   a
     b
   c
+  __END__
+  foo
 EOS
+# >> head: {}
+# >> body: "a\n  b\nc\n__END__\nfoo\n"
+# >> Source2MD::Formatter::TypeHidden => false
+# >> 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 => false
+# >> Source2MD::Formatter::TypeText => false
+# >> Source2MD::Formatter::TypePartialCode => true
 # >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypePartialCode
 # >> > {}
 # >> > ------------------------------------------------------------ in
 # >> > a
 # >> >   b
 # >> > c
+# >> > __END__
+# >> > foo
+# >> > 
 # >> > 
 # >> > ------------------------------------------------------------ out
 # >> > ```ruby
@@ -19,6 +40,7 @@ EOS
 # >> >   b
 # >> > c
 # >> > ```
+# >> > 
 # >> > ------------------------------------------------------------
 # >> ```ruby
 # >> a

data/lib/source2md/cli.rb

@@ -1,11 +1,12 @@
 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, aliases: "-r", default: true
-    class_option :default_lang,    type: :string,  aliases: "-l", default: "ruby"
-    class_option :prefix_re,       type: :string
-    class_option :comment_re,      type: :string
+    class_option :debug,              type: :boolean, aliases: "-d", default: false
+    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 :prefix_re,          type: :string
+    class_option :comment_re,         type: :string
 
     def initialize(...)
       super
@@ -15,9 +16,10 @@ module Source2MD
         Source2MD.debug = true
       end
 
-      Source2MD.xmp_out_exclude = options[:xmp_out_exclude]
-      Source2MD.readonly = options[:readonly]
-      Source2MD.default_lang = options[:default_lang]
+      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::RE.update do |e|
         if v = options[:prefix_re]
@@ -34,6 +36,7 @@ module Source2MD
     map "g" => :generate
     desc "generate [files]", "Markdown generation"
     option :output_file, type: :string, aliases: "-o", default: nil
+    option :glob,        type: :string, aliases: "-g"
     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
-    ARROW_MARK         = %r{(?:#{RE.comment_re}) =>}
+    ARROW_MARK = %r{(?:#{RE.comment_re}) =>}
 
     def initialize(text, options = {})
       @text = text

data/lib/source2md/formatter/type_partial_code.rb

@@ -6,7 +6,17 @@ module Source2MD
       end
 
       def to_md
-        CodeBlock.new(element.body).to_md
+        CodeBlock.new(body).to_md
+      end
+
+      private
+
+      def body
+        if Source2MD.data_block_exclude
+          element.body.sub(/^__END__\R.*/m, "")
+        else
+          element.body
+        end
       end
     end
   end

data/lib/source2md/generator.rb

@@ -12,14 +12,10 @@ module Source2MD
       end
 
       if output_file
-        if output_file.exist?
-          FileUtils.chmod("a+w", output_file)
+        temporarily_disable_write_protection do
+          output_file.write(to_md)
+          puts "write: #{output_file}"
         end
-        output_file.write(to_md)
-        if Source2MD.readonly
-          FileUtils.chmod("a-w", output_file)
-        end
-        puts "write: #{output_file}"
       end
     end
 
@@ -36,7 +32,13 @@ module Source2MD
     end
 
     def files
-      @files ||= Array(params[:files]).collect { |e| Pathname(e).expand_path }
+      @files ||= yield_self do
+        if params[:glob]
+          Pathname.glob(params[:glob])
+        else
+          Array(params[:files]).collect { |e| Pathname(e).expand_path }
+        end
+      end
     end
 
     def output_file
@@ -46,5 +48,17 @@ module Source2MD
         end
       end
     end
+
+    def temporarily_disable_write_protection
+      if output_file.exist?
+        FileUtils.chmod("a+w", output_file)
+      end
+
+      yield
+
+      if Source2MD.readonly
+        FileUtils.chmod("a-w", output_file)
+      end
+    end
   end
 end

data/lib/source2md/version.rb

@@ -1,3 +1,3 @@
 module Source2MD
-  VERSION = "0.0.11"
+  VERSION = "0.0.13"
 end

data/lib/source2md.rb

@@ -16,6 +16,7 @@ module Source2MD
   config_accessor(:xmp_out_exclude) { false }
   config_accessor(:readonly) { true }
   config_accessor(:default_lang) { "ruby" }
+  config_accessor(:data_block_exclude) { false }
 end
 
 require "zeitwerk"

data/spec/formatter/type_partial_code_spec.rb

@@ -5,6 +5,9 @@ module Source2MD
     it "works" do
       actual = Element.new(<<~EOS).to_md
 (foo)
+__END__
+1
+2
 EOS
       actual.should == <<~EOS
 ```ruby

data/spec/generator_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+module Source2MD
+  describe Generator do
+    before do
+      Pathname("_input.rb").write("# (content)")
+    end
+
+    after do
+      Pathname("_input.rb").delete
+      Pathname("_output.md").delete rescue nil
+    end
+
+    it "files option" do
+      output = capture("stdout") do
+        Generator.new(files: ["_input.rb"]).call
+      end
+      assert { output == "(content)\n" }
+    end
+
+    it "glob option" do
+      output = capture("stdout") do
+        Generator.new(glob: "_i*.rb").call
+      end
+      assert { output == "(content)\n" }
+    end
+
+    it "output file is write protected" do
+      capture("stdout") do
+        Generator.new(files: ["_input.rb"], output_file: "_output.md").call
+      end
+      assert { Pathname("_output.md").stat.writable? == false }
+    end
+  end
+end
+# >> .F
+# >>
+# >> Failures:
+# >>
+# >>   1) Source2MD::Generator glob option
+# >>      Failure/Error: Unable to find - to read failed line
+# >>      Test::Unit::AssertionFailedError:
+# >>      # -:25:in `block (2 levels) in <module:Source2MD>'
+# >>
+# >> Finished in 0.01412 seconds (files took 0.28313 seconds to load)
+# >> 2 examples, 1 failure
+# >>
+# >> Failed examples:
+# >>
+# >> rspec -:21 # Source2MD::Generator glob option
+# >>

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@ Zeitwerk::Loader.eager_load_all
 
 Source2MD.logger.level = :error
 Source2MD.xmp_out_exclude = true
+Source2MD.data_block_exclude = true
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
@@ -18,3 +19,11 @@ RSpec.configure do |config|
   config.expect_with :test_unit
   config.example_status_persistence_file_path = "#{__dir__}/.all_test_result.txt"
 end
+
+if true
+  require "tempfile"            # for capture
+  require "active_support/testing/stream"
+  RSpec.configure do |config|
+    config.include ActiveSupport::Testing::Stream
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source2md
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.13
 platform: ruby
 authors:
 - Akira Ikeda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-13 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -212,7 +212,6 @@ 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
@@ -228,6 +227,7 @@ files:
 - spec/formatter/type_text_spec.rb
 - spec/formatter/type_title_spec.rb
 - spec/formatter/type_warn_spec.rb
+- spec/generator_spec.rb
 - spec/scanner_spec.rb
 - spec/spec_helper.rb
 - spec/text_helper_spec.rb
@@ -250,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Markdown generator from source code
@@ -269,6 +269,7 @@ test_files:
 - spec/formatter/type_text_spec.rb
 - spec/formatter/type_title_spec.rb
 - spec/formatter/type_warn_spec.rb
+- spec/generator_spec.rb
 - spec/scanner_spec.rb
 - spec/spec_helper.rb
 - spec/text_helper_spec.rb

data/output.md

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