readme_yard 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 755f223afede15fbac8b87531730204494747aaf8b95302bf0cae4ca9a8822d3
-  data.tar.gz: b765382a63cf98480cf2e557f793272c046f18916313b8907875f0fa70e4ee30
+  metadata.gz: 75f0e416616f2e2e893d7a64da99c4fd364d4624309d60cf5fb1cee1f7f8d824
+  data.tar.gz: 2a7230288228a5a8fdf2d9198ed1a571d6275529c739b24ef8617765e38757dc
 SHA512:
-  metadata.gz: fcc797e2dd79799f06c8acfd1737b901f010b8b52300e77fa78cf0be48b249f43e3968a23a74cb5b8243072d17008e87a77ac77e91715c81724b7fc50bab5d82
-  data.tar.gz: 12bdfd98250616c6379d1563a92de7cc9ae3b436746f96057bf6f66feea3ba1dafc045a631579960ac0cc0fb829ea51dbf9df8aec5e94257cc270c07cc3fe72a
+  metadata.gz: 9982537f18b8205ca25ea49f95d3affcee71d4d228c5c3b93612d7cb7fdbb26e2f4224b64b20adcad438d727392eeb24d1ffe801b296970cdbb336f41ed6b215
+  data.tar.gz: 2502d485c42940b1e25e8b8fe2ed8076d0f913c4e69bcdc8534c676031f73f790d67efa074bfb54a45ddf50d76c71dba6cf138feb28e48cece33de2f5139a7e1

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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.4.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.
 
@@ -68,6 +70,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 +97,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
 #
@@ -291,8 +295,4 @@ ReadmeYard::ExampleTag.hello_world #=> "Hello 🌎 🌍 🌏"
 
 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.
-
-🌿 🥏 🌱 ⚽
+Thanks for reading me, the README that documents how to document the README with code that documents itself 🤯

data/README_YARD.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: {@string ReadmeYard::VERSION}**
+
 {@readme ReadmeYard}
 
 ---
@@ -69,7 +71,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}
 
@@ -189,8 +191,4 @@ The below example code is generated from `{@example ReadmeYard::ExampleTag.hello
 
 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.
-
-🌿 🥏 🌱 ⚽
+Thanks for reading me, the README that documents how to document the README with code that documents itself 🤯

data/lib/readme_yard/logger.rb

@@ -11,6 +11,10 @@ class ReadmeYard
       def puts_md(msg)
         puts TTY::Markdown.parse(msg)
       end
+
+      def puts_text(msg)
+        puts msg
+      end
     end
   end
 end

data/lib/readme_yard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ReadmeYard
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/readme_yard.rb

@@ -15,6 +15,7 @@ require_relative "readme_yard/value_tag"
 require_relative "readme_yard/string_tag"
 require_relative "readme_yard/tag_registry"
 require_relative "readme_yard/yard_opts_manager"
+require "diffy"
 
 YARD::Readme::DocstringParser.readme_tag_names = ReadmeYard::TagRegistry.tag_names
 
@@ -50,6 +51,8 @@ class ReadmeYard
       readme_yard.build(options: options)
     when "yard"
       readme_yard.yard(options: options)
+    when "version"
+      Logger.puts_md(VERSION)
     else
       Logger.puts_md(readme_yard.command_line_usage)
     end
@@ -65,7 +68,9 @@ class ReadmeYard
   attr_accessor :readme_path, :readme_yard_path
 
   #
-  # This method returns the following `@readme` text
+  # This unnecessarily meta method returns the `@readme` text you see
+  # below (if you're reading this in the source code). It was implemented
+  # just for fun as a demonstration of @readme tags.
   #
   # @readme
   #   ## Command Line Usage
@@ -76,6 +81,8 @@ class ReadmeYard
   #
   #   `readme yard` - Same as `readme build` + generates yard docs.
   #
+  #   `readme version` - Prints the current version of ReadmeYard.
+  #
   def command_line_usage
     yard_parse_this_file
     yard_object = YARD::Registry.at("#{self.class.name}##{__method__}")
@@ -95,15 +102,18 @@ class ReadmeYard
   #
   def build(options: "-nq")
     YARD::CLI::Yardoc.run(options || "-nq")
-    File.write(readme_path, gsub_tags!(readme_yard_md))
+    old_readme = File.exist?(readme_path) ? File.read(readme_path) : ""
+    new_readme = gsub_tags!(readme_yard_md)
+    File.write(readme_path, new_readme)
+    show_readme_diff(old_readme, new_readme)
   end
 
   #
-  # @readme Same as "build" + generates yard docs.
+  # @readme Same as "build" + generates yard `docs.
   #
-  def yard(options: "-q")
+  def yard(options: "")
     YardOptsManager.upsert_yardopts
-    build(options: options || "-q")
+    build(options: options || "")
   end
 
   private
@@ -176,4 +186,15 @@ class ReadmeYard
     current_file_path = File.join(gem_spec.full_gem_path, "lib", "readme_yard.rb")
     YARD.parse(current_file_path)
   end
+
+  def show_readme_diff(old_content, new_content)
+    if old_content == new_content
+      Logger.puts_md("\n**No changes** to README.md\n\n")
+      return
+    end
+
+    diff = Diffy::Diff.new(old_content, new_content, context: 0).to_s(:color)
+    Logger.puts_md("\n**Changes to README.md:**\n\n")
+    Logger.puts_text "#{diff}\n"
+  end
 end

data/readme_yard.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
+  spec.add_dependency "diffy", "~> 3.4"
   spec.add_dependency "tty-markdown", "~> 0.7"
   spec.add_dependency "yard", "~> 0.9"
   spec.add_dependency "yard-readme", "~> 0.5"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: readme_yard
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Ruzicka
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: tty-markdown
   requirement: !ruby/object:Gem::Requirement