yard-readme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4ec34f12f41177c0652dcf498e833a03b2492e0faf1c487ee40b149bf41b2eb
+  data.tar.gz: 362213c9dd24df82f3396dd81218fe623050d91eb7c59adaed04fbe3587d44b9
+SHA512:
+  metadata.gz: ecda196fad92caf901bbe43c0661dc961fc8abc39ee6aff954144167b6741e6ac5f6d4f6679fbf48a3cb849f64840ff7841039860225da57bc9e6f42a9e0a98c
+  data.tar.gz: 854dbe3d3d9ae01097edc0681d4f267248bb9db5107c01f49a8238131316ceab9f622e11253e1addce0c6d60d67d81c5ddcb659ad4129165a25a7199565d9cca

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.yardopts

@@ -0,0 +1,2 @@
+--plugin readme
+lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-07-25
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in yard-readme.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    yard-readme (0.1.0)
+      yard
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    yard (0.9.26)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  yard-readme!
+
+BUNDLED WITH
+   2.2.24

data/README.md

@@ -0,0 +1,35 @@
+# Yard::Readme
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yard/readme`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yard-readme'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yard-readme
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yard-readme.

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "yard-readme"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yard-readme.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'yard'
+require_relative 'yard-readme/version'
+require_relative 'yard-readme/docstring_parser'
+
+YARD::Docstring.default_parser = YARDReadme::DocstringParser
+YARD::Tags::Library.define_tag('README', :readme)

data/lib/yard-readme/docstring_parser.rb

@@ -0,0 +1,74 @@
+module YARDReadme
+  class DocstringParser < YARD::DocstringParser
+    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
+            push_readme_text(docstring, buf) if tag_name == 'readme'
+            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 push_readme_text(docstring, buf)
+      return if buf.empty?
+
+      buf.split("\n").each do |buf_line|
+        docstring << buf_line
+        docstring << "\n"
+      end
+      docstring << "\n"
+    end
+  end
+end

data/lib/yard-readme/version.rb

@@ -0,0 +1,3 @@
+module YARDReadme
+  VERSION = '0.1.0'
+end

data/yard-readme.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/yard-readme/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yard-readme"
+  spec.version       = YARDReadme::VERSION
+  spec.authors       = ["Matt Ruzicka"]
+
+  spec.summary       = "Enhance your README with YARD"
+  spec.description   = "Generate your README using comments in your code"
+  spec.homepage      = 'https://github.com/mattruzicka/yard-readme'
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/mattruzicka/yard-readme'
+  spec.metadata["changelog_uri"] = 'https://github.com/mattruzicka/yard-readme' \
+                                   '/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "yard"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: yard-readme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Ruzicka
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate your README using comments in your code
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/console
+- bin/setup
+- lib/yard-readme.rb
+- lib/yard-readme/docstring_parser.rb
+- lib/yard-readme/version.rb
+- yard-readme.gemspec
+homepage: https://github.com/mattruzicka/yard-readme
+licenses: []
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Enhance your README with YARD
+test_files: []