yard-readme 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcd61abdc1876be598a2d532300f924ad55a57bfd1621c547a3af4ae58e66878
-  data.tar.gz: 86efaa1311664e611826262de6d8b0a959069033e1eee9f95f7e4b1cbd3bd4a6
+  metadata.gz: 676cae1299410a644a61764533557124b7cd287abbe81238126fd96366c76fbc
+  data.tar.gz: 173694a562cd4e73025fcc29a703d04781d29e157e7f42c675d55c171a235f14
 SHA512:
-  metadata.gz: c782d9c5accdc97a479ca316bb5c779fbaf0f48a0aa638bc9c9f732bc04b941206eb2fe7f82eab7131d463f5daafee32f43e16c8035935301fe61688a01342ad
-  data.tar.gz: f80feffe36580aca84fc820e46bf44218992199da1e6c23a38791a37a560ffc7702246ad2ed55f655b54dd368730ffb4127ac801af6cf17a912d532d56dcd60f
+  metadata.gz: b3e2c9d544b52798c72a5be125217a2a534dc71ca0b9df3d1caaf6c681114f7c385f87971ebf80514399d66c946fc07863989968af876f1cfe32680cc1d8f4de
+  data.tar.gz: b74bdd141f0d7ffdc63f7827a76a48da6e6ca4382dde61c6594534970f6d14772f00e39856642a879ea19ece7980cd56050fc783bfb04a6256dd8468ccb4f6ae

data/.yardopts

@@ -1,3 +1,2 @@
--e lib/yard-readme.rb
+--plugin readme
 --markup markdown
-lib/**/*.rb

data/CHANGELOG.md

@@ -1,4 +1,34 @@
-## [Unreleased]
+## [0.5.0] - 2025-05-04
+
+- Extracted description into separate file `lib/yard/readme/description.rb`
+- Updated documentation to use this centralized description in gemspec and README
+- Updated tag examples from `@readme object` to `@readme code` to reflect readme_yard updates
+- Updated README
+
+## [0.4.0] - 2025-05-03
+
+### Breaking Changes
+- Changed module namespace from `YARDReadme` to `YARD::Readme` for better integration with YARD's namespace
+- Moved files from `lib/yard-readme/` to `lib/yard/readme/` to match the new namespace structure
+- Increased minimum required Ruby version from 2.4.0 to 3.0.0
+
+### Features
+- Improved documentation with comprehensive explanations of how custom readme tags work
+- Added example for `YARD::Readme::DocstringParser.readme_tag_names` to demonstrate usage
+- Enhanced docstring comments with detailed API documentation
+- Updated YARD plugin to better integrate with readme_yard 0.3.0+
+
+### Documentation Updates
+- Restructured README with clear sections explaining the plugin's functionality
+- Added detailed documentation for each component of the plugin:
+  - Custom Readme Tag Support
+  - Tag Processing functionality
+  - Tag Method descriptions
+  - Readme Text Processing explanations
+
+### Dependencies
+- Updated YARD dependency from `~> 0.9.26` to `~> 0.9` to support newer versions
+- Removed specific readme_yard development dependency, now integrates with any compatible version
 
 ## [0.3.0] - 2021-08-07
 

data/Gemfile

@@ -4,3 +4,6 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in yard-readme.gemspec
 gemspec
+
+gem "debug"
+gem 'readme_yard', '>= 0.3', path: '../readme_yard'

data/Gemfile.lock

@@ -1,45 +1,71 @@
+PATH
+  remote: ../readme_yard
+  specs:
+    readme_yard (0.3.0)
+      tty-markdown (~> 0.7)
+      yard (~> 0.9)
+      yard-readme (~> 0.4)
+
 PATH
   remote: .
   specs:
-    yard-readme (0.2.0)
-      yard (~> 0.9.26)
+    yard-readme (0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    kramdown (2.3.1)
-      rexml
+    date (3.4.1)
+    debug (1.10.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
     pastel (0.8.0)
       tty-color (~> 0.5)
-    readme_yard (0.1.2)
-      tty-markdown (~> 0.7)
-      yard-readme (~> 0.1)
-    rexml (3.2.5)
-    rouge (3.26.0)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.4)
+      date
+      stringio
+    rdoc (6.13.1)
+      psych (>= 4.0.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
+    rexml (3.4.1)
+    rouge (4.5.2)
+    stringio (3.1.7)
     strings (0.2.1)
       strings-ansi (~> 0.2)
       unicode-display_width (>= 1.5, < 3.0)
       unicode_utils (~> 1.4)
     strings-ansi (0.2.0)
     tty-color (0.6.0)
-    tty-markdown (0.7.0)
+    tty-markdown (0.7.2)
       kramdown (>= 1.16.2, < 3.0)
       pastel (~> 0.8)
-      rouge (~> 3.14)
+      rouge (>= 3.14, < 5.0)
       strings (~> 0.2.0)
       tty-color (~> 0.5)
       tty-screen (~> 0.8)
-    tty-screen (0.8.1)
-    unicode-display_width (2.0.0)
+    tty-screen (0.8.2)
+    unicode-display_width (2.6.0)
     unicode_utils (1.4.0)
-    yard (0.9.26)
+    yard (0.9.37)
 
 PLATFORMS
-  arm64-darwin-20
+  arm64-darwin-24
 
 DEPENDENCIES
-  readme_yard (~> 0.1)
+  debug
+  irb
+  readme_yard (>= 0.3)!
   yard-readme!
 
 BUNDLED WITH
-   2.2.24
+   2.6.8

data/README.md

@@ -1,22 +1,65 @@
 # yard-readme
 
-A [YARD](https://yardoc.org) plugin used by
-[readme_yard](https://github.com/mattruzicka/readme_yard).
-It adds a `@readme` tag to YARD.
-
-It also replaces the default docstring parser so that only
-`@readme` tags and not their text values are stripped from
-the generated documentation. I prefer this over the default
-YARD behavior for the `@readme` tag because it allows the
-comments in the source code to signal the README dependency
-without pushing the generated YARD documentation into a
-separate "readme" section.
-
-That said, I welcome a PR that adds the default behavior as an option, as I think it could be preferable for some use cases. Ideally, I or someone would open a YARD PR to make leaving
-the tag text an option when registering a tag. Especially
-since this plugin's current behavior of replacing the
-`YARD::DocstringParser` could potentially conflict with
-other YARD plugins and is also more vulnerable to change.
+Built for the [readme_yard](https://github.com/mattruzicka/readme_yard) gem as:
+
+A YARD plugin that introduces the @readme tag and powers the readme_yard gem, enabling developers to embed code comments directly into README sections. This eliminates redundancy and keeps documentation consistent across code and project READMEs.
+
+This plugin replaces YARD's default docstring parser with a custom one that handles @readme tags differently. This custom DocstringParser extends YARD's default parser to provide
+special handling for @readme tags. The main functionality includes:
+
+1. Preserving the text content of @readme tags in the docstring
+   (instead of moving it to a separate "readme" section)
+2. Supporting nested @readme tags with custom names (like @readme comment)
+3. Properly handling empty/blank @readme tags
+
+
+## Custom Readme Tag Support
+
+The yard-readme plugin includes support for custom readme tags as used by readme_yard. Custom readme tag names that should be stripped from the docstring
+but preserved in the tag's text. This is used to support the nested tag
+feature of readme_yard, where tags like `@readme comment`, `@readme code`,
+and `@readme source` control what content gets embedded in the README.
+
+By setting this attribute with an array of tag names (without the "@readme" prefix),
+the parser will recognize these as special readme tags and handle them appropriately.
+
+
+```ruby
+YARD::Readme::DocstringParser.readme_tag_names = ["comment", "code", "source"]
+```
+
+
+## Tag Processing
+
+The plugin provides custom handling for @readme tags: Custom tag factory that overrides the default YARD tag factory
+to provide special handling for @readme tags. Specifically,
+it ensures that blank or empty @readme tags are properly processed.
+
+
+### Tag Methods
+
+The TagFactory includes specialized methods for handling readme tags:
+
+- This method ensures that @readme tags without any text are properly
+handled, rather than being processed by the default YARD parser
+which expects title and text for tags defined with :with_title_and_text.
+
+- Checks if a tag is a blank @readme tag (no content).
+This helper method is used to determine whether special
+handling is needed for a given tag.
+
+
+## Readme Text Processing
+
+The DocstringParser includes specialized methods for processing readme text:
+
+- Determines whether a tag's text should be processed as readme text.
+Only non-empty @readme tags are processed.
+
+- Strips the @readme text of any readme-specific tag names
+(as defined in readme_tag_names) and adds appropriate spacing.
+
+
 
 ## Contributing
 

data/README_YARD.md

@@ -1,8 +1,35 @@
 # yard-readme
 
-{@readme YARDReadme}
+Built for the [readme_yard](https://github.com/mattruzicka/readme_yard) gem as:
+
+{@readme YARD::Readme::DESCRIPTION}
+
+This plugin replaces YARD's default docstring parser with a custom one that handles @readme tags differently. {@readme YARD::Readme::DocstringParser}
+
+## Custom Readme Tag Support
+
+The yard-readme plugin includes support for custom readme tags as used by readme_yard. {@readme YARD::Readme::DocstringParser.readme_tag_names}
+
+{@example YARD::Readme::DocstringParser.readme_tag_names}
+
+## Tag Processing
+
+The plugin provides custom handling for @readme tags: {@readme YARD::Readme::TagFactory}
+
+### Tag Methods
+
+The TagFactory includes specialized methods for handling readme tags:
+
+- {@readme YARD::Readme::TagFactory#parse_tag_with_title_and_text}
+- {@readme YARD::Readme::TagFactory#blank_readme_tag?}
+
+## Readme Text Processing
+
+The DocstringParser includes specialized methods for processing readme text:
+
+- {@readme YARD::Readme::DocstringParser#parse_readme_text?}
+- {@readme YARD::Readme::DocstringParser#parse_readme_text}
 
-That said, I welcome a PR that adds the default behavior as an option, as I think it could be preferable for some use cases. {@readme YARDReadme::DocstringParser}
 
 ## Contributing
 

data/lib/yard/readme/description.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module YARD
+  module Readme
+    #
+    # @readme String
+    #
+    DESCRIPTION = "A YARD plugin that introduces the @readme tag and powers the readme_yard gem, enabling developers to embed code comments directly into README sections. This eliminates redundancy and keeps documentation consistent across code and project READMEs."
+  end
+end
+
+

data/lib/yard/readme/docstring_parser.rb

@@ -0,0 +1,134 @@
+module YARD
+  module Readme
+    #
+    # @readme
+    #   This custom DocstringParser extends YARD's default parser to provide
+    #   special handling for @readme tags. The main functionality includes:
+    #
+    #   1. Preserving the text content of @readme tags in the docstring
+    #      (instead of moving it to a separate "readme" section)
+    #   2. Supporting nested @readme tags with custom names (like @readme comment)
+    #   3. Properly handling empty/blank @readme tags
+    #
+    # This implementation allows source code comments to signal README dependencies
+    # without altering how the YARD documentation is organized and displayed.
+    #
+    class DocstringParser < YARD::Docstring.default_parser
+      class << self
+        # @readme
+        #   Custom readme tag names that should be stripped from the docstring
+        #   but preserved in the tag's text. This is used to support the nested tag
+        #   feature of readme_yard, where tags like `@readme comment`, `@readme code`,
+        #   and `@readme source` control what content gets embedded in the README.
+        #
+        #   By setting this attribute with an array of tag names (without the "@readme" prefix),
+        #   the parser will recognize these as special readme tags and handle them appropriately.
+        #
+        # @example
+        #   YARD::Readme::DocstringParser.readme_tag_names = ["comment", "code", "source"]
+        #
+        attr_accessor :readme_tag_names
+
+        def readme_tag_names_regex
+          @readme_tag_names_regex ||= /\A(#{readme_tag_names.join("|")})/
+        end
+
+        def readme_tag_names_regex?
+          readme_tag_names && !readme_tag_names.empty?
+        end
+
+        def strip_readme_tag_arg(text)
+          return text unless readme_tag_names_regex?
+
+          text.sub(readme_tag_names_regex, "")
+        end
+      end
+
+      def parse_content(content)
+        content = content.split(/\r?\n/) if content.is_a?(String)
+        return '' if !content || content.empty?
+        docstring = String.new("")
+
+        indent = content.first[/^\s*/].length
+        last_indent = 0
+        orig_indent = 0
+        directive = false
+        last_line = ""
+        tag_name = nil
+        tag_buf = []
+
+        (content + ['']).each_with_index do |line, index|
+          indent = line[/^\s*/].length
+          empty = (line =~ /^\s*$/ ? true : false)
+          done = content.size == index
+
+          if tag_name && (((indent < orig_indent && !empty) || done ||
+              (indent == 0 && !empty)) || (indent <= last_indent && line =~ META_MATCH))
+            buf = tag_buf.join("\n")
+            if directive || tag_is_directive?(tag_name)
+              directive = create_directive(tag_name, buf)
+              if directive
+                docstring << parse_content(directive.expanded_text).chomp
+              end
+            else
+              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
+            tag_buf = []
+            directive = false
+            orig_indent = 0
+          end
+
+          # Found a meta tag
+          if line =~ META_MATCH
+            directive = $1
+            tag_name = $2
+            tag_buf = [($3 || '')]
+          elsif tag_name && indent >= orig_indent && !empty
+            orig_indent = indent if orig_indent == 0
+            # Extra data added to the tag on the next line
+            last_empty = last_line =~ /^[ \t]*$/ ? true : false
+
+            tag_buf << '' if last_empty
+            tag_buf << line.gsub(/^[ \t]{#{orig_indent}}/, '')
+          elsif !tag_name
+            # Regular docstring text
+            docstring << line
+            docstring << "\n"
+          end
+
+          last_indent = indent
+          last_line = line
+        end
+
+        docstring
+      end
+
+      # @readme
+      #   Strips the @readme text of any readme-specific tag names
+      #   (as defined in readme_tag_names) and adds appropriate spacing.
+      #
+      # @param [String] text the raw text from the @readme tag
+      # @return [String, nil] the processed text or nil if no processing was done
+      #
+      def parse_readme_text(text)
+        readme_text = self.class.strip_readme_tag_arg(text)
+        readme_text << "\n\n" if readme_text
+      end
+
+      # @readme
+      #   Determines whether a tag's text should be processed as readme text.
+      #   Only non-empty @readme tags are processed.
+      #
+      # @param [String] tag_name the name of the tag
+      # @param [String] buf the tag's text buffer
+      # @return [Boolean] true if the tag should be processed as readme text
+      #
+      def parse_readme_text?(tag_name, buf)
+        tag_name == 'readme' && !buf.empty?
+      end
+    end
+  end
+end

data/lib/yard/readme/tag_factory.rb

@@ -0,0 +1,42 @@
+module YARD
+  module Readme
+    # @readme
+    #   Custom tag factory that overrides the default YARD tag factory
+    #   to provide special handling for @readme tags. Specifically,
+    #   it ensures that blank or empty @readme tags are properly processed.
+    #
+    class TagFactory < YARD::Tags::Library.default_factory.class
+      #
+      # Overrides the default tag parsing behavior to handle blank @readme tags.
+      #
+      # @param [String] tag_name the name of the tag
+      # @param [String] text the tag text
+      # @return [YARD::Tags::Tag] the parsed tag
+      # @see https://github.com/lsegal/yard/blob/359006641260eef1fe6d28f5c43c7c98d40f257d/lib/yard/tags/default_factory.rb#L70
+      #
+      # @readme
+      #   This method ensures that @readme tags without any text are properly
+      #   handled, rather than being processed by the default YARD parser
+      #   which expects title and text for tags defined with :with_title_and_text.
+      #
+      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
+
+      # @readme
+      #   Checks if a tag is a blank @readme tag (no content).
+      #   This helper method is used to determine whether special
+      #   handling is needed for a given tag.
+      #
+      # @param [String] tag_name the name of the tag
+      # @param [String] text the tag text
+      # @return [Boolean] true if the tag is a blank readme tag
+      #
+      def blank_readme_tag?(tag_name, text)
+        tag_name == "readme" && text.nil? || text.empty?
+      end
+    end
+  end
+end

data/lib/yard/readme/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module YARD
+  module Readme
+    VERSION = "0.5.0"
+  end
+end

data/lib/yard/readme.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "readme/version"
+require_relative "readme/description"
+require_relative "readme/docstring_parser"
+require_relative "readme/tag_factory"
+
+module YARD
+  module Readme
+    #
+    # @see https://www.rubydoc.info/gems/yard/0.9.13/YARD/DocstringParser
+    #
+    YARD::Docstring.default_parser = YARD::Readme::DocstringParser
+
+    #
+    # @see https://www.rubydoc.info/gems/yard/file/docs/TagsArch.md
+    #
+    YARD::Tags::Library.default_factory = YARD::Readme::TagFactory
+
+    YARD::Tags::Library.define_tag('README', :readme, :with_title_and_text)
+  end
+end

data/lib/yard-readme.rb

@@ -1,34 +1,3 @@
 # frozen_string_literal: true
 
-require 'yard'
-require_relative 'yard-readme/version'
-require_relative 'yard-readme/docstring_parser'
-require_relative 'yard-readme/tag_factory'
-
-#
-# @readme
-#   A [YARD](https://yardoc.org) plugin used by
-#   [readme_yard](https://github.com/mattruzicka/readme_yard).
-#   It adds a `@readme` tag to YARD.
-#
-#   It also replaces the default docstring parser so that only
-#   `@readme` tags and not their text values are stripped from
-#   the generated documentation. I prefer this over the default
-#   YARD behavior for the `@readme` tag because it allows the
-#   comments in the source code to signal the README dependency
-#   without pushing the generated YARD documentation into a
-#   separate "readme" section.
-#
-module YARDReadme; end
-
-#
-# @see https://www.rubydoc.info/gems/yard/0.9.13/YARD/DocstringParser
-#
-YARD::Docstring.default_parser = YARDReadme::DocstringParser
-
-#
-# @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)
+require_relative 'yard/readme'

data/yard-readme.gemspec

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
-require_relative "lib/yard-readme/version"
+require_relative 'lib/yard/readme/version'
+require_relative 'lib/yard/readme/description'
 
 Gem::Specification.new do |spec|
   spec.name = "yard-readme"
-  spec.version = YARDReadme::VERSION
+  spec.version = YARD::Readme::VERSION
   spec.authors = ["Matt Ruzicka"]
   spec.license = "MIT"
 
-  spec.summary = "Enhance your README with YARD"
-  spec.description = "Generate your README using comments in your code"
+  spec.summary = "YARD plugin for the readme_yard gem"
+  spec.description = YARD::Readme::DESCRIPTION
   spec.homepage = 'https://github.com/mattruzicka/yard-readme'
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -27,9 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "yard", "~> 0.9.26"
-
-  spec.add_development_dependency 'readme_yard', "~> 0.1"
+  spec.add_development_dependency 'irb'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,45 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: yard-readme
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Ruzicka
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: irb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.26
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.26
-- !ruby/object:Gem::Dependency
-  name: readme_yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
-description: Generate your README using comments in your code
-email:
+        version: '0'
+description: A YARD plugin that introduces the @readme tag and powers the readme_yard
+  gem, enabling developers to embed code comments directly into README sections. This
+  eliminates redundancy and keeps documentation consistent across code and project
+  READMEs.
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -55,9 +42,11 @@ files:
 - bin/console
 - bin/setup
 - lib/yard-readme.rb
-- lib/yard-readme/docstring_parser.rb
-- lib/yard-readme/tag_factory.rb
-- lib/yard-readme/version.rb
+- lib/yard/readme.rb
+- lib/yard/readme/description.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
 licenses:
@@ -66,7 +55,6 @@ metadata:
   homepage_uri: https://github.com/mattruzicka/yard-readme
   source_code_uri: https://github.com/mattruzicka/yard-readme
   changelog_uri: https://github.com/mattruzicka/yard-readme/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,15 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
-summary: Enhance your README with YARD
+summary: YARD plugin for the readme_yard gem
 test_files: []

data/lib/yard-readme/docstring_parser.rb

@@ -1,102 +0,0 @@
-module YARDReadme
-  #
-  # @readme
-  #   Ideally, I or someone would open a YARD PR to make leaving
-  #   the tag text an option when registering a tag. Especially
-  #   since this plugin's current behavior of replacing the
-  #   `YARD::DocstringParser` could potentially conflict with
-  #   other YARD plugins and is also more vulnerable to change.
-  #
-  # Doing so would make this custom parser obsolete.
-  #
-  class DocstringParser < YARD::Docstring.default_parser
-    class << self
-      attr_accessor :readme_tag_names
-
-      def readme_tag_names_regex
-        @readme_tag_names_regex ||= /\A(#{readme_tag_names.join("|")})/
-      end
-
-      def readme_tag_names_regex?
-        readme_tag_names && !readme_tag_names.empty?
-      end
-
-      def strip_readme_tag_arg(text)
-        return text unless readme_tag_names_regex?
-
-        text.sub(readme_tag_names_regex, "")
-      end
-    end
-
-    def parse_content(content)
-      content = content.split(/\r?\n/) if content.is_a?(String)
-      return '' if !content || content.empty?
-      docstring = String.new("")
-
-      indent = content.first[/^\s*/].length
-      last_indent = 0
-      orig_indent = 0
-      directive = false
-      last_line = ""
-      tag_name = nil
-      tag_buf = []
-
-      (content + ['']).each_with_index do |line, index|
-        indent = line[/^\s*/].length
-        empty = (line =~ /^\s*$/ ? true : false)
-        done = content.size == index
-
-        if tag_name && (((indent < orig_indent && !empty) || done ||
-            (indent == 0 && !empty)) || (indent <= last_indent && line =~ META_MATCH))
-          buf = tag_buf.join("\n")
-          if directive || tag_is_directive?(tag_name)
-            directive = create_directive(tag_name, buf)
-            if directive
-              docstring << parse_content(directive.expanded_text).chomp
-            end
-          else
-            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
-          tag_buf = []
-          directive = false
-          orig_indent = 0
-        end
-
-        # Found a meta tag
-        if line =~ META_MATCH
-          directive = $1
-          tag_name = $2
-          tag_buf = [($3 || '')]
-        elsif tag_name && indent >= orig_indent && !empty
-          orig_indent = indent if orig_indent == 0
-          # Extra data added to the tag on the next line
-          last_empty = last_line =~ /^[ \t]*$/ ? true : false
-
-          tag_buf << '' if last_empty
-          tag_buf << line.gsub(/^[ \t]{#{orig_indent}}/, '')
-        elsif !tag_name
-          # Regular docstring text
-          docstring << line
-          docstring << "\n"
-        end
-
-        last_indent = indent
-        last_line = line
-      end
-
-      docstring
-    end
-
-    def parse_readme_text(text)
-      readme_text = self.class.strip_readme_tag_arg(text)
-      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

@@ -1,16 +0,0 @@
-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 +0,0 @@
-# frozen_string_literal: true
-
-module YARDReadme
-  VERSION = "0.3.0"
-end