yard-readme 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebf25f4d0d965036850d04c859580025a2fce1361e6bd99d73d0d3a4912ab9e0
-  data.tar.gz: c17189420b7ffb6105cf5b1439ccd0b73677b900de1dab4efaf74f70e0b07d25
+  metadata.gz: f8fcf73f1ebef0ac81488b0ee0a04eba51bcc228e9ba8a6e414b444bc19a6335
+  data.tar.gz: fe947ee1fc8c5fe274234e05feec1cf99238dbf20940542684ed3287289d4167
 SHA512:
-  metadata.gz: f49d8edda2cb446af0a24ebe9ffa164db854f8965cca06d7b8f856cb5d4d834944de98f2fbaad8ea1659adcff4e1490044a6922b63aa4864513e015670624d20
-  data.tar.gz: e48995e33ecd0175352fec3d0cf8464bff98cab4c498f26cdb9822dc5d8cfee0519d5f8c4611bed1d33a52a6f8f550c35e3893b76ea9eebee6e9acd820a50c4b
+  metadata.gz: 4322e30867670192be390128fb6521de5985a70a156f9279d4419271be01e702a6e772365465bf3cf4746c7bbfbe567e410133f1ac5c4eb25c706a62ae9dbce6
+  data.tar.gz: 18eeae3284d48faf9195c54162a1468602f55daaf07dffb2f2a6593d7a1f75034800c5bdc0e82bae46ebd836b2e4c21a7bfa4d1aa9e952a7a8fc065833eef6d4

data/CHANGELOG.md

@@ -1,12 +1,14 @@
 ## [Unreleased]
 
+## [0.2.0] - 2021-08-07
+
+- Be able to supprot new readme tag args in readme_yard without updating this gem b76ad2459168e4361ab38912e6faa7e36f249cec
 
 ## [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
-
+- Remove special readme tag names (README_YARD args) from docs when parsing docstring 983e1485b89888d390dc4879e7019fd7785dedda
 
 ## [0.1.1] - 2021-07-31
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yard-readme (0.1.1)
+    yard-readme (0.2.0)
       yard (~> 0.9.26)
 
 GEM
@@ -11,7 +11,7 @@ GEM
       rexml
     pastel (0.8.0)
       tty-color (~> 0.5)
-    readme_yard (0.1.1)
+    readme_yard (0.1.2)
       tty-markdown (~> 0.7)
       yard-readme (~> 0.1)
     rexml (3.2.5)

data/lib/yard-readme/docstring_parser.rb

@@ -10,6 +10,24 @@ module YARDReadme
   # Doing so would make this custom parser obsolete.
   #
   class DocstringParser < YARD::Docstring.default_parser
+    class << self
+      attr_accessor :readme_tag_args
+
+      def readme_tag_args_regex
+        @readme_tag_args_regex ||= /\A(#{readme_tag_args.join("|")})/
+      end
+
+      def readme_tag_args_regex?
+        readme_tag_args && !readme_tag_args.empty?
+      end
+
+      def strip_readme_tag_arg(text)
+        return text unless readme_tag_args_regex?
+
+        text.sub(readme_tag_args_regex, "")
+      end
+    end
+
     def parse_content(content)
       content = content.split(/\r?\n/) if content.is_a?(String)
       return '' if !content || content.empty?
@@ -73,7 +91,7 @@ module YARDReadme
     end
 
     def parse_readme_text(text)
-      readme_text = text.sub(/\A(source|docstring|object)/, "")
+      readme_text = self.class.strip_readme_tag_arg(text)
       readme_text << "\n\n" if readme_text
     end
 

data/lib/yard-readme/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-readme
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Ruzicka