yard-readme 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4458410fb0b98437c2146843c50d289a30a48198b1c9aca310a4b0a029304b3a
-  data.tar.gz: f14c8330d1c130c19b5db7ab3584949bfc5987bd0c4748126c3ce3f3504ff866
+  metadata.gz: ebf25f4d0d965036850d04c859580025a2fce1361e6bd99d73d0d3a4912ab9e0
+  data.tar.gz: c17189420b7ffb6105cf5b1439ccd0b73677b900de1dab4efaf74f70e0b07d25
 SHA512:
-  metadata.gz: 733c2915d1453899173f74d634b5d157567a11173b5e1202b95d3fb68a92ade3d5e4d7ab9e539d9ad591bab1a8303f5ab3e94b5242566ed401644ce4689fa832
-  data.tar.gz: 6d4d1d75d943e0ab629fa2035784dd9f343cf8dd54732d54cc4613e779788a686f39a7454960c9451bcb76640c89c7b414d980bd256af96e035cbc44a2c64a6d
+  metadata.gz: f49d8edda2cb446af0a24ebe9ffa164db854f8965cca06d7b8f856cb5d4d834944de98f2fbaad8ea1659adcff4e1490044a6922b63aa4864513e015670624d20
+  data.tar.gz: e48995e33ecd0175352fec3d0cf8464bff98cab4c498f26cdb9822dc5d8cfee0519d5f8c4611bed1d33a52a6f8f550c35e3893b76ea9eebee6e9acd820a50c4b

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+
+## [0.1.2] - 2021-08-07
+
+- Inherit from existing default to minimize conflict between plugins 69463cb2f580a1f5bcb734564eb51b32bf833250
+- Avoid raising error when readme tag text is blank 294c9400de41d297c71212939b410e4ce821bc15
+-  Remove special readme tag names (README_YARD args) from docs when parsing docstring 983e1485b89888d390dc4879e7019fd7785dedda
+
+
+## [0.1.1] - 2021-07-31
+
+- Use readme_yard to build README
+
 ## [0.1.0] - 2021-07-25
 
 - Initial release

data/lib/yard-readme.rb

@@ -3,6 +3,7 @@
 require 'yard'
 require_relative 'yard-readme/version'
 require_relative 'yard-readme/docstring_parser'
+require_relative 'yard-readme/tag_factory'
 
 #
 # @readme
@@ -20,5 +21,14 @@ require_relative 'yard-readme/docstring_parser'
 #
 module YARDReadme; end
 
+#
+# @see https://www.rubydoc.info/gems/yard/0.9.13/YARD/DocstringParser
+#
 YARD::Docstring.default_parser = YARDReadme::DocstringParser
-YARD::Tags::Library.define_tag('README', :readme)
+
+#
+# @see https://www.rubydoc.info/gems/yard/file/docs/TagsArch.md
+#
+YARD::Tags::Library.default_factory = YARDReadme::TagFactory
+
+YARD::Tags::Library.define_tag('README', :readme, :with_title_and_text)

data/lib/yard-readme/docstring_parser.rb

@@ -9,7 +9,7 @@ module YARDReadme
   #
   # Doing so would make this custom parser obsolete.
   #
-  class DocstringParser < YARD::DocstringParser
+  class DocstringParser < YARD::Docstring.default_parser
     def parse_content(content)
       content = content.split(/\r?\n/) if content.is_a?(String)
       return '' if !content || content.empty?
@@ -37,7 +37,8 @@ module YARDReadme
               docstring << parse_content(directive.expanded_text).chomp
             end
           else
-            docstring << parse_readme_text(buf) if tag_name == 'readme' && !buf.empty?
+            readme_text = parse_readme_text(buf) if parse_readme_text?(tag_name, buf)
+            docstring << readme_text if readme_text
             create_tag(tag_name, buf)
           end
           tag_name = nil
@@ -72,7 +73,12 @@ module YARDReadme
     end
 
     def parse_readme_text(text)
-      text << "\n\n"
+      readme_text = text.sub(/\A(source|docstring|object)/, "")
+      readme_text << "\n\n" if readme_text
+    end
+
+    def parse_readme_text?(tag_name, buf)
+      tag_name == 'readme' && !buf.empty?
     end
   end
 end

data/lib/yard-readme/tag_factory.rb

@@ -0,0 +1,16 @@
+module YARDReadme
+  class TagFactory < YARD::Tags::Library.default_factory.class
+    #
+    # @see https://github.com/lsegal/yard/blob/359006641260eef1fe6d28f5c43c7c98d40f257d/lib/yard/tags/default_factory.rb#L70
+    #
+    def parse_tag_with_title_and_text(tag_name, text)
+      return YARD::Tags::Tag.new(tag_name, text) if blank_readme_tag?(tag_name, text)
+
+      super
+    end
+
+    def blank_readme_tag?(tag_name, text)
+      tag_name == "readme" && text.nil? || text.empty?
+    end
+  end
+end

data/lib/yard-readme/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YARDReadme
-  VERSION = '0.1.1'
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-readme
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Matt Ruzicka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-31 00:00:00.000000000 Z
+date: 2021-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -45,6 +45,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -55,6 +56,7 @@ files:
 - bin/setup
 - lib/yard-readme.rb
 - lib/yard-readme/docstring_parser.rb
+- lib/yard-readme/tag_factory.rb
 - lib/yard-readme/version.rb
 - yard-readme.gemspec
 homepage: https://github.com/mattruzicka/yard-readme