yard-readme 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c94f2e542f87b5beedce3e89f2d4797cdbcd3e3d80c84189da416e6ba54acbc
-  data.tar.gz: f6957e18616ccda27a169b201e6e4283c606440e01a805952f093ff02ffbaf57
+  metadata.gz: d8cb1187f1856ae8da1bfe214c052fbfd3849d1b1b64dfab0ed27b1b73d9d62d
+  data.tar.gz: 1aae21fdb20a7dc6545112bcc6b2e472f76a6f1ded805f7130b4767a4ce3e88f
 SHA512:
-  metadata.gz: a7fa39d5a01d4cda411559832f607a20e0760bcc36279716c57b3af1c909c6b0a013d8ee6f41529a5f1acfca9cc34e0eea8ac7abfe2c3f6cabf1e0498dfb3c0a
-  data.tar.gz: f17ced1a3ccbc7b6106b7031cb9b9c6ed5f5ee6b5dc652482b65747f5d36462b924ad55bab922bcfdbf4d737ba7bb017841127b54e820a1ec3ae5841cfa01efb
+  metadata.gz: 6154ed0d82740a1dad4e75d22d5ac8bbeee4172ce4bd5910d059eb214c3233ead01ae660446113866dc84621d326026e1c436154e81d2bed483e407e7e54a6c2
+  data.tar.gz: 220b8a4fed185eab411c8758d2202480b7f9942d947d40171db7662984f136086e265cc9f691daa8790402d3446aa3113dde7c12ba683b194d0a08c223a219f7

data/.yardopts

@@ -0,0 +1,2 @@
+--plugin readme
+--markup markdown

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.6.0] - 2025-05-04
+
+- Update Gemfile with published readme_yard gem
+
+## [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
@@ -23,10 +34,6 @@
 - 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
 
-### Internal Changes
-- Removed custom .yardopts file as it's now using the default configuration from readme_yard gem
-- Added comprehensive RDoc-style documentation to all classes and methods
-
 ## [0.3.0] - 2021-08-07
 
 - Rename newly added methods be373f150e865b933a58a950e6a5c654395e17c4

data/Gemfile

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

data/Gemfile.lock

@@ -1,22 +1,15 @@
-PATH
-  remote: ../readme_yard
-  specs:
-    readme_yard (0.3.0)
-      irb
-      tty-markdown (~> 0.7)
-      yard (~> 0.9)
-      yard-readme (~> 0.4)
-
 PATH
   remote: .
   specs:
-    yard-readme (0.4.0)
-      yard (~> 0.9)
+    yard-readme (0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     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)
@@ -34,6 +27,10 @@ GEM
       stringio
     rdoc (6.13.1)
       psych (>= 4.0.0)
+    readme_yard (0.3.0)
+      tty-markdown (~> 0.7)
+      yard (~> 0.9)
+      yard-readme (~> 0.5)
     reline (0.6.1)
       io-console (~> 0.5)
     rexml (3.4.1)
@@ -61,8 +58,9 @@ PLATFORMS
   arm64-darwin-24
 
 DEPENDENCIES
+  debug
   irb
-  readme_yard (>= 0.3)!
+  readme_yard (>= 0.3)
   yard-readme!
 
 BUNDLED WITH

data/README.md

@@ -1,17 +1,8 @@
 # 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.
+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:
@@ -26,15 +17,15 @@ special handling for @readme tags. The main functionality includes:
 
 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 source`,
-and `@readme object` control what content gets embedded in the README.
+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", "source", "object"]
+YARD::Readme::DocstringParser.readme_tag_names = ["comment", "code", "source"]
 ```
 
 

data/README_YARD.md

@@ -1,6 +1,8 @@
 # yard-readme
 
-{@readme YARD::Readme}
+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}
 

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

@@ -18,14 +18,14 @@ module YARD
         # @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 source`,
-        #   and `@readme object` control what content gets embedded in the README.
+        #   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", "source", "object"]
+        #   YARD::Readme::DocstringParser.readme_tag_names = ["comment", "code", "source"]
         #
         attr_accessor :readme_tag_names
 

data/lib/yard/readme/version.rb

@@ -2,6 +2,6 @@
 
 module YARD
   module Readme
-    VERSION = "0.4.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/yard/readme.rb

@@ -1,25 +1,11 @@
 # frozen_string_literal: true
 
-require 'yard'
 require_relative "readme/version"
+require_relative "readme/description"
 require_relative "readme/docstring_parser"
 require_relative "readme/tag_factory"
 
 module 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.
-  #
   module Readme
     #
     # @see https://www.rubydoc.info/gems/yard/0.9.13/YARD/DocstringParser

data/lib/yard-readme.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
-require 'yard'
 require_relative 'yard/readme'

data/yard-readme.gemspec

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'lib/yard/readme/version'
+require_relative 'lib/yard/readme/description'
 
 Gem::Specification.new do |spec|
   spec.name = "yard-readme"
@@ -8,8 +9,8 @@ Gem::Specification.new do |spec|
   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 = ">= 3.0.0"
 
@@ -27,8 +28,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "yard", "~> 0.9"
-
   spec.add_development_dependency 'irb'
 
   # For more information and examples about making a new gem, checkout our

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-readme
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Ruzicka
@@ -9,20 +9,6 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: irb
   requirement: !ruby/object:Gem::Requirement
@@ -37,13 +23,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generate your README using comments in your code
+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: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -53,6 +43,7 @@ files:
 - bin/setup
 - lib/yard-readme.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
@@ -80,5 +71,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.8
 specification_version: 4
-summary: Enhance your README with YARD
+summary: YARD plugin for the readme_yard gem
 test_files: []