readme_yard 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 755f223afede15fbac8b87531730204494747aaf8b95302bf0cae4ca9a8822d3
-  data.tar.gz: b765382a63cf98480cf2e557f793272c046f18916313b8907875f0fa70e4ee30
+  metadata.gz: '0368a7e25427d9424b42730fcafc891842b799a7dbf5bace1045b5e5be5d5249'
+  data.tar.gz: 666018d5b0fa0922c60b39a6146de0becfa7ba786fe58d9806eb9afcbacb8a01
 SHA512:
-  metadata.gz: fcc797e2dd79799f06c8acfd1737b901f010b8b52300e77fa78cf0be48b249f43e3968a23a74cb5b8243072d17008e87a77ac77e91715c81724b7fc50bab5d82
-  data.tar.gz: 12bdfd98250616c6379d1563a92de7cc9ae3b436746f96057bf6f66feea3ba1dafc045a631579960ac0cc0fb829ea51dbf9df8aec5e94257cc270c07cc3fe72a
+  metadata.gz: bfdf64d212db54ad7eff6af8c862915e05aacdf66117dff16378bdaae989685dbe9342f8f9d9b5ee26b67fed6e198e34a8618548d3dbc9b175cbc5732c5b9e4e
+  data.tar.gz: 4f25eac729b4a0b843fef0902c4f13a8116e9116ba77642c99f6b7025f87e4e965fe4b40d5fc6f1e8d8ea58cd93c0e80294f8fd616bf93be1570e9c36d671bcf

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.5.0 - 2025-05-08
+
+- Enhance string tag normalization to support single quotes
+
+## 0.4.0 - 2025-05-05
+
+- Added colored diff output when readme build/yard commands finish, showing changes to README.md using the Diffy gem
+- Changed default options for `readme yard` command to display YARD doc stats
+- Added code version display in README.md showing current version from ReadmeYard::VERSION
+
 ## 0.3.0 - 2025-05-04
 
 - Update dependencies: upgraded yard-readme to 0.5.0, Ruby requirement to >= 3.0

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    readme_yard (0.3.0)
+    readme_yard (0.5.0)
+      diffy (~> 3.4)
       tty-markdown (~> 0.7)
       yard (~> 0.9)
       yard-readme (~> 0.5)
@@ -14,6 +15,7 @@ GEM
     debug (1.10.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
+    diffy (3.4.3)
     io-console (0.8.0)
     irb (1.15.2)
       pp (>= 0.6.0)
@@ -46,7 +48,7 @@ GEM
       io-console (~> 0.5)
     rexml (3.4.1)
     rouge (4.5.2)
-    rubocop (1.75.4)
+    rubocop (1.75.5)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -79,7 +81,7 @@ GEM
     unicode-display_width (2.6.0)
     unicode_utils (1.4.0)
     yard (0.9.37)
-    yard-readme (0.5.0)
+    yard-readme (0.6.0)
 
 PLATFORMS
   arm64-darwin-24

data/README.md

@@ -1,6 +1,8 @@
 # Readme Yard 🌿
 [![Gem Version](https://badge.fury.io/rb/readme_yard.svg)](https://badge.fury.io/rb/readme_yard)
 
+**Code Version: 0.4.0**
+
 Build a better README with [YARD](https://yardoc.org)
 by generating it straight from the source.
 
@@ -17,14 +19,12 @@ If you're reading the README, that means this text is here
 because the custom `{@readme ReadmeYard}` markdown tag is in
 README_YARD.md and `readme build` was run at the command line.
 
-Here's the [full documentation](https://rubydoc.info/github/mattruzicka/readme_yard).
-
 
 ---
 
 ⚠️ **Generated file warning** – Edit README_YARD.md, not README.md. Changes to README.md will be lost when running `readme build`.
 
-### Future Work
+**Future Work**
 - Implement safeguards to prevent accidental edits to README.md
 - Support bidirectional editing through git integration
 
@@ -41,6 +41,7 @@ Here's the [full documentation](https://rubydoc.info/github/mattruzicka/readme_y
 - [Standalone Tag Usage](#standalone-tag-usage)
 - [Example Tag](#example-tag)
 - [Contributing](#contributing)
+- [Documentation](https://mattruzicka.github.io/readme_yard/)
 
 ---
 
@@ -68,6 +69,8 @@ See [Tag Usage](#tag-usage).
 
 `readme yard` - Same as `readme build` + generates yard docs.
 
+`readme version` - Prints the current version of ReadmeYard.
+
 
 ---
 
@@ -93,7 +96,7 @@ When the Readme Yard build process encounters a tag in README_YARD.md, it search
 
 ### Examples
 
-The next line is a code snippet if you're looking at [README.md](https://github.com/mattruzicka/README/blob/main/README_YARD.md) and `{@readme ReadmeYard::ExampleTag.hello_world}` if you're looking at [README_YARD.md](https://github.com/mattruzicka/readme_yard/blob/main/README_YARD.md).
+The next line is a code snippet if you're looking at the [README](https://github.com/mattruzicka/readme_yard/blob/main/README.md) and `{@readme ReadmeYard::ExampleTag.hello_world}` if you're looking at [README_YARD.md](https://github.com/mattruzicka/readme_yard/blob/main/README_YARD.md).
 
 ```ruby
 #
@@ -289,10 +292,6 @@ ReadmeYard::ExampleTag.hello_world #=> "Hello 🌎 🌍 🌏"
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/mattruzicka/yard-readme.
-
-If you're interested in contributing, but don't know where to get started, feel free to message me on twitter at [@mattruzicka](https://twitter.com/mattruzicka). I have a lot of ideas!
-
-Thanks for taking the time to think about me, the README.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mattruzicka/readme_yard.
 
-🌿 🥏 🌱 ⚽
+Thanks for reading me, the README that documents how to document the README with code that documents itself 🤯

data/README_YARD.md

@@ -1,13 +1,15 @@
 # Readme Yard 🌿
 [![Gem Version](https://badge.fury.io/rb/readme_yard.svg)](https://badge.fury.io/rb/readme_yard)
 
+**Code Version: {@string ReadmeYard::VERSION}**
+
 {@readme ReadmeYard}
 
 ---
 
 ⚠️ **Generated file warning** – Edit README_YARD.md, not README.md. Changes to README.md will be lost when running `readme build`.
 
-### Future Work
+**Future Work**
 - Implement safeguards to prevent accidental edits to README.md
 - Support bidirectional editing through git integration
 
@@ -24,6 +26,7 @@
 - [Standalone Tag Usage](#standalone-tag-usage)
 - [Example Tag](#example-tag)
 - [Contributing](#contributing)
+- [Documentation]({@string ReadmeYard::DOCS_URL})
 
 ---
 
@@ -69,7 +72,7 @@ When the Readme Yard build process encounters a tag in README_YARD.md, it search
 
 ### Examples
 
-The next line is a code snippet if you're looking at [README.md](https://github.com/mattruzicka/README/blob/main/README_YARD.md) and `{@readme ReadmeYard::ExampleTag.hello_world}` if you're looking at [README_YARD.md](https://github.com/mattruzicka/readme_yard/blob/main/README_YARD.md).
+The next line is a code snippet if you're looking at the [README](https://github.com/mattruzicka/readme_yard/blob/main/README.md) and `{@readme ReadmeYard::ExampleTag.hello_world}` if you're looking at [README_YARD.md](https://github.com/mattruzicka/readme_yard/blob/main/README_YARD.md).
 
 {@readme ReadmeYard::ExampleTag.hello_world}
 
@@ -187,10 +190,6 @@ The below example code is generated from `{@example ReadmeYard::ExampleTag.hello
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/mattruzicka/yard-readme.
-
-If you're interested in contributing, but don't know where to get started, feel free to message me on twitter at [@mattruzicka](https://twitter.com/mattruzicka). I have a lot of ideas!
-
-Thanks for taking the time to think about me, the README.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mattruzicka/readme_yard.
 
-🌿 🥏 🌱 ⚽
+Thanks for reading me, the README that documents how to document the README with code that documents itself 🤯

data/docs/ReadmeYard/CodeTag.html

@@ -0,0 +1,273 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: ReadmeYard::CodeTag
+  
+    &mdash; Documentation by YARD 0.9.37
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "ReadmeYard::CodeTag";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../ReadmeYard.html" title="ReadmeYard (class)">ReadmeYard</a></span></span>
+     &raquo; 
+    <span class="title">CodeTag</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Class: ReadmeYard::CodeTag
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">ReadmeYard::CodeTag</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/readme_yard/code_tag.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Embed Ruby code</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <h4 class="tag_title">Examples:</h4>
+    
+      
+      <pre class="example code"><code><span class='comment'># @readme code</span></code></pre>
+    
+  </div>
+
+
+</div>
+
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#format_tag-class_method" title="format_tag (class method)">.<strong>format_tag</strong>(yard_object, _tag)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>The code for this method is in the README because <code>@readme code</code> is below (in the source code).</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#format_yard_object-class_method" title="format_yard_object (class method)">.<strong>format_yard_object</strong>(yard_object)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="format_tag-class_method">
+  
+    .<strong>format_tag</strong>(yard_object, _tag)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>The code for this method is in the README because
+<code>@readme code</code> is below (in the source code).</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/readme_yard/code_tag.rb', line 19</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_format_tag'>format_tag</span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='comma'>,</span> <span class='id identifier rubyid__tag'>_tag</span><span class='rparen'>)</span>
+  <span class='const'><span class='object_link'><a href="ExampleTag.html" title="ReadmeYard::ExampleTag (class)">ExampleTag</a></span></span><span class='period'>.</span><span class='id identifier rubyid_format_ruby'><span class='object_link'><a href="ExampleTag.html#format_ruby-class_method" title="ReadmeYard::ExampleTag.format_ruby (method)">format_ruby</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='period'>.</span><span class='id identifier rubyid_source'>source</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="format_yard_object-class_method">
+  
+    .<strong>format_yard_object</strong>(yard_object)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/readme_yard/code_tag.rb', line 23</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_format_yard_object'>format_yard_object</span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_format_tag'>format_tag</span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Mon May  5 09:48:52 2025 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.4.2).
+</div>
+
+    </div>
+  </body>
+</html>