docscribe 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fcaceb217eab132e318a9ae95022d321006d530f4b7e19ebd9ee4107bc528ad
-  data.tar.gz: bd0a32f653c96dac12f402ad9b64508fbb3d75b038074dc78153c9341f946705
+  metadata.gz: 6c6297143fe1919d600c8a423e05aa4fa8f6a092b85cc898b8b90307d0df176d
+  data.tar.gz: 735ad06a621ee1b3c872dfd58b7f99a8062b7b732f024c1a609f7d382a1a9577
 SHA512:
-  metadata.gz: 28f776a28ccfe336ce3e608cba8335b2186f350336b5c97c3f79373b210adf850c64ec80416b8af97dbd33dc88edc8b8cd3bd087692775e1722da1f2e974e891
-  data.tar.gz: 43771ce9ee8188b03b3d77aa3313227d2143a33e8fd4a08b67f441d6ea42ca338ee913e2bd46bfd1afb3fd87e5f1ebad08d9b0f282b0c91b22ab2d437b9aba68
+  metadata.gz: eccc8ca3af426075e79b5e62b86fa14e6205851542adb7013bc64103cbc8a48ceaae228cd18b2292e176bd5501192dac68efb41f998b349f791024240da365ab
+  data.tar.gz: d7eabbed3763335952d657fb68bd3aee67f62a06ebc4c94dc7c38852fae4fe1432eaaeba67ebc98fd8f21055b8d7990061058691df43f241b4bfda25ed0079d9

data/README.md

@@ -4,16 +4,19 @@
 [![RubyGems Downloads](https://img.shields.io/gem/dt/docscribe.svg)](https://rubygems.org/gems/docscribe)
 [![CI](https://github.com/unurgunite/docscribe/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/unurgunite/docscribe/actions/workflows/ci.yml)
 [![License](https://img.shields.io/github/license/unurgunite/docscribe.svg)](https://github.com/unurgunite/docscribe/blob/master/LICENSE.txt)
-[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.0-blue.svg)](#installation)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%202.7-blue.svg)](#installation)
 
-Generate inline, YARD-style documentation comments for Ruby methods by analyzing your code's AST. Docscribe inserts doc
-headers before method definitions, infers parameter and return types (including rescue-aware returns), and respects Ruby
-visibility semantics — without using YARD to parse.
+Generate inline, YARD-style documentation comments for Ruby methods by analyzing your code's AST.
 
-- No AST reprinting. Your original code, formatting, and constructs (like `class << self`, `heredocs`, `%i[]`) are preserved.
-- Inline-first. Comments are inserted surgically at the start of each `def`/`defs` line.
+Docscribe inserts doc headers before method definitions, infers parameter and return types (including rescue-aware
+returns), and respects Ruby visibility semantics — without using YARD to parse.
+
+- No AST reprinting. Your original code, formatting, and constructs (like `class << self`, `heredocs`, `%i[]`) are
+  preserved.
+- Inline-first. Comments are inserted at the start of each `def`/`defs` line.
 - Heuristic type inference for params and return values, including conditional returns in rescue branches.
 - Optional rewrite mode for regenerating existing method docs.
+- Ruby 3.4+ syntax supported using Prism translation (see "Parser backend" below).
 
 Why not YARD? We started with YARD's parser, but switched to an AST-based in-place rewriter for maximum preservation of
 source structure and exact control over Ruby semantics.
@@ -57,7 +60,7 @@ Or install globally:
 gem install docscribe
 ```
 
-Requires Ruby 3.0+.
+Requires Ruby 2.7+.
 
 ## Quick start
 
@@ -184,6 +187,10 @@ Examples:
   ```shell
   docscribe --rewrite --write lib/**/*.rb
   ```
+- Check a directory (Docscribe expands directories to `**/*.rb`):
+  ```bash
+  docscribe --check lib
+  ```
 
 ## Inline behavior
 
@@ -200,6 +207,36 @@ Examples:
 - This is useful to refresh docs across a codebase after improving inference or rules.
 - Use with caution (prefer a clean working tree and review diffs).
 
+### Output markers in CI
+
+When using `--check`, Docscribe prints one character per file:
+
+- `.` = file is up-to-date
+- `F` = file would change (missing/stale docs)
+
+When using `--write`:
+
+- `.` = file already OK
+- `C` = file was corrected and rewritten
+
+Docscribe prints a summary at the end and exits non-zero in `--check` mode if any file would change.
+
+## Parser backend (Parser gem vs Prism)
+
+Docscribe internally works with `parser`-gem-compatible AST nodes and `Parser::Source::*` objects (so it can use
+`Parser::Source::TreeRewriter` without changing your formatting).
+
+- On Ruby **<= 3.3**, Docscribe parses using the `parser` gem.
+- On Ruby **>= 3.4**, Docscribe parses using **Prism** and translates the tree into the `parser` gem’s AST (so tooling
+  stays compatible).
+
+You can force a backend with an environment variable:
+
+```bash
+DOCSCRIBE_PARSER_BACKEND=parser bundle exec docscribe --check lib
+DOCSCRIBE_PARSER_BACKEND=prism  bundle exec docscribe --check lib
+```
+
 ## Type inference
 
 Heuristics (best-effort):
@@ -297,8 +334,8 @@ We match Ruby's behavior:
 
 - A bare `private`/`protected`/`public` in a class/module body affects instance methods only.
 - Inside `class << self`, a bare visibility keyword affects class methods only.
-- `def self.x` in a class body remains `public` unless `private_class_method` is used or it's inside `class << self` under
-  `private`.
+- `def self.x` in a class body remains `public` unless `private_class_method` is used, or it's inside `class << self`
+  under `private`.
 
 Inline tags:
 
@@ -425,7 +462,7 @@ Docscribe and YARD solve different parts of the documentation problem:
 - Does not merge into existing comments; in normal mode, a method with a comment directly above it is skipped. Use
   `--rewrite` to regenerate.
 - Type inference is heuristic. Complex flows and meta-programming will fall back to Object or best-effort types.
-- Only Ruby 3.0+ is officially supported.
+- Ruby 2.7+ supported.
 - Inline rewrite is textual; ensure a clean working tree before using `--write` or `--rewrite`.
 
 ## Roadmap

data/exe/docscribe

@@ -43,6 +43,22 @@ def rewrite(code, replace:)
   Docscribe::InlineRewriter.insert_comments(code, rewrite: replace)
 end
 
+def expand_paths(args)
+  files = []
+
+  args.each do |path|
+    if File.directory?(path)
+      files.concat(Dir.glob(File.join(path, '**', '*.rb')))
+    elsif File.file?(path)
+      files << path
+    else
+      warn "Skipping missing path: #{path}"
+    end
+  end
+
+  files.uniq.sort
+end
+
 if options[:stdin]
   code = $stdin.read
   puts rewrite(code, replace: options[:rewrite])
@@ -54,24 +70,60 @@ if ARGV.empty?
   exit 1
 end
 
+$stdout.sync = true
+
+paths = expand_paths(ARGV)
+if paths.empty?
+  warn 'No files found. Pass files or directories (e.g. `docscribe --check lib`).'
+  exit 1
+end
+
 changed = false
+checked_ok = 0
+checked_fail = 0
+corrected = 0
+fail_paths = []
 
-ARGV.each do |path|
+paths.each do |path|
   src = File.read(path)
   out = transform(src, replace: options[:rewrite], config: conf)
+
   if options[:check]
-    if out != src
-      warn "Would change: #{path}"
+    if out == src
+      print '.'
+      checked_ok += 1
+    else
+      print 'F'
+      checked_fail += 1
       changed = true
+      fail_paths << path
     end
+
   elsif options[:write]
-    if out != src
+    if out == src
+      print '.'
+    else
       File.write(path, out)
-      puts "Updated: #{path}"
+      print 'C'
+      corrected += 1
     end
+
   else
     puts out
   end
 end
 
+if options[:check]
+  puts
+  if checked_fail.zero?
+    puts "Docscribe: OK (#{checked_ok} files checked)"
+  else
+    puts "Docscribe: FAILED (#{checked_fail} failing, #{checked_ok} ok)"
+    fail_paths.each { |p| warn "Missing docs: #{p}" }
+  end
+elsif options[:write]
+  puts
+  puts "Docscribe: updated #{corrected} file(s)" if corrected.positive?
+end
+
 exit(options[:check] && changed ? 1 : 0)

data/lib/docscribe/infer.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
-require 'parser/current'
+require 'racc/parser'
+require 'ast'
+require 'parser/ast/node'
+require 'parser/source/buffer'
+require 'parser/base'
+require 'docscribe/parsing'
 
 module Docscribe
   module Infer
@@ -91,7 +96,7 @@ module Docscribe
 
         buffer = Parser::Source::Buffer.new('(param)')
         buffer.source = src
-        Parser::CurrentRuby.new.parse(buffer)
+        Docscribe::Parsing.parse_buffer(buffer)
       rescue Parser::SyntaxError
         nil
       end
@@ -109,7 +114,7 @@ module Docscribe
 
         buffer = Parser::Source::Buffer.new('(method)')
         buffer.source = method_source
-        root = Parser::CurrentRuby.new.parse(buffer)
+        root = Docscribe::Parsing.parse_buffer(buffer)
         return 'Object' unless root && %i[def defs].include?(root.type)
 
         body = root.children.last # method body node

data/lib/docscribe/inline_rewriter.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 
-require 'parser/current'
+require 'racc/parser'
+require 'ast'
+require 'parser/deprecation'
+require 'parser/source/buffer'
+require 'parser/source/range'
+require 'parser/source/tree_rewriter'
+require 'parser/ast/processor'
+
+require 'docscribe/config'
 require 'docscribe/infer'
+require 'docscribe/parsing'
 
 module Docscribe
   module InlineRewriter
@@ -16,8 +25,7 @@ module Docscribe
     def self.insert_comments(code, rewrite: false, config: nil)
       buffer = Parser::Source::Buffer.new('(inline)')
       buffer.source = code
-      parser = Parser::CurrentRuby.new
-      ast = parser.parse(buffer)
+      ast = Docscribe::Parsing.parse_buffer(buffer)
       return code unless ast
 
       config ||= Docscribe::Config.load
@@ -30,22 +38,22 @@ module Docscribe
       collector.insertions
                .sort_by { |ins| ins.node.loc.expression.begin_pos }
                .reverse_each do |ins|
-        bol_range = line_start_range(buffer, ins.node)
-
-        if rewrite
-          # If there is a comment block immediately above, remove it (and its trailing blank lines)
-          if (range = comment_block_removal_range(buffer, bol_range.begin_pos))
-            rewriter.remove(range)
-          end
-        elsif already_has_doc_immediately_above?(buffer, bol_range.begin_pos)
-          # Skip if a doc already exists immediately above
-          next
-        end
-
-        doc = build_doc_for_node(buffer, ins, config)
-        next unless doc && !doc.empty?
-
-        rewriter.insert_before(bol_range, doc)
+                 bol_range = line_start_range(buffer, ins.node)
+
+                 if rewrite
+                   # If there is a comment block immediately above, remove it (and its trailing blank lines)
+                   if (range = comment_block_removal_range(buffer, bol_range.begin_pos))
+                     rewriter.remove(range)
+                   end
+                 elsif already_has_doc_immediately_above?(buffer, bol_range.begin_pos)
+                   # Skip if a doc already exists immediately above
+                   next
+                 end
+
+                 doc = build_doc_for_node(buffer, ins, config)
+                 next unless doc && !doc.empty?
+
+                 rewriter.insert_before(bol_range, doc)
       end
 
       rewriter.process

data/lib/docscribe/parsing.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'parser/source/buffer'
+
+module Docscribe
+  # Picks the correct Ruby parser backend and returns a `parser`-gem-compatible AST.
+  #
+  # Docscribe internally works with `parser` AST nodes (e.g. `Parser::AST::Node`) and
+  # `Parser::Source::*` location objects so it can use `Parser::Source::TreeRewriter`
+  # without reformatting the source.
+  #
+  # Ruby 3.4+ syntax can outpace the `parser` gem. To keep parsing working on Ruby 3.4+
+  # (and Ruby 4.0), Docscribe can parse with Prism and translate Prism’s AST into the
+  # `parser` AST via `Prism::Translation`.
+  #
+  # You can force a backend via the `DOCSCRIBE_PARSER_BACKEND` environment variable
+  # (`parser` or `prism`).
+  module Parsing
+    class << self
+      # Parse a Ruby source string into an AST.
+      #
+      # @param code [String] Ruby source code.
+      # @param file [String] A virtual filename used in locations (e.g. for errors and ranges).
+      # @param backend [Symbol] :auto (default), :parser, or :prism.
+      # @return [Parser::AST::Node, nil] Root node (or nil for empty/whitespace-only source).
+      def parse(code, file: '(docscribe)', backend: :auto)
+        buffer = Parser::Source::Buffer.new(file, source: code)
+        parse_buffer(buffer, backend: backend)
+      end
+
+      # Parse using an already-created {Parser::Source::Buffer}.
+      #
+      # This is important when callers later use {Parser::Source::TreeRewriter} with the
+      # same buffer instance (to keep ranges/offsets consistent).
+      #
+      # @param buffer [Parser::Source::Buffer] Source buffer (must have `.source` set).
+      # @param backend [Symbol] :auto (default), :parser, or :prism.
+      # @return [Parser::AST::Node, nil] Root node (or nil for empty/whitespace-only source).
+      def parse_buffer(buffer, backend: :auto)
+        parser = parser_for(backend: backend)
+        parser.parse(buffer)
+      end
+
+      # Parse a Ruby source string into AST + comments.
+      #
+      # @param code [String] Ruby source code.
+      # @param file [String] A virtual filename used in locations (e.g. for errors and ranges).
+      # @param backend [Symbol] :auto (default), :parser, or :prism.
+      # @return [Array<(Parser::AST::Node, Array<Parser::Source::Comment>)>]
+      #   The AST root node (or nil) and an array of comments.
+      def parse_with_comments(code, file: '(docscribe)', backend: :auto)
+        buffer = Parser::Source::Buffer.new(file, source: code)
+        parse_with_comments_buffer(buffer, backend: backend)
+      end
+
+      # Parse AST + comments using an existing {Parser::Source::Buffer}.
+      #
+      # @param buffer [Parser::Source::Buffer] Source buffer (must have `.source` set).
+      # @param backend [Symbol] :auto (default), :parser, or :prism.
+      # @return [Array<(Parser::AST::Node, Array<Parser::Source::Comment>)>]
+      #   The AST root node (or nil) and an array of comments.
+      def parse_with_comments_buffer(buffer, backend: :auto)
+        parser = parser_for(backend: backend)
+        parser.parse_with_comments(buffer)
+      end
+
+      # @api private
+      # Build the underlying parser instance for the selected backend.
+      #
+      # @param backend [Symbol] :auto, :parser, or :prism.
+      # @return [Object] An object responding to `parse` and `parse_with_comments`.
+      def parser_for(backend: :auto)
+        case self.backend(backend)
+        when :parser
+          require 'parser/current'
+          Parser::CurrentRuby.new
+        when :prism
+          require 'prism'
+          Prism::Translation::ParserCurrent.new
+        end
+      end
+
+      # Select the backend (:parser or :prism).
+      #
+      # @param backend [Symbol] :auto (default), :parser, or :prism.
+      # @return [Symbol] :parser or :prism.
+      # @raise [ArgumentError] if an unknown backend is requested.
+      def backend(backend = :auto)
+        env = ENV.fetch('DOCSCRIBE_PARSER_BACKEND', nil)
+        backend = env.to_sym if env && !env.empty?
+
+        case backend
+        when :auto
+          ruby_gte_34? ? :prism : :parser
+        when :parser, :prism
+          backend
+        else
+          raise ArgumentError, "Unknown backend: #{backend.inspect}"
+        end
+      end
+
+      # @api private
+      # @return [Boolean] true if running on Ruby 3.4+.
+      def ruby_gte_34?
+        Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.4')
+      end
+    end
+  end
+end

data/lib/docscribe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docscribe
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/docscribe.rb

@@ -4,6 +4,7 @@ module Docscribe
   class Error < StandardError; end
 end
 
+require 'docscribe/parsing'
 require_relative 'docscribe/version'
 require_relative 'docscribe/config'
 require_relative 'docscribe/infer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docscribe
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - unurgunite
@@ -15,14 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +79,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-sorted_methods_by_call
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +127,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 0.9.38
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 0.9.38
 email:
 - senpaiguru1488@gmail.com
 executables:
@@ -100,23 +142,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
 - exe/docscribe
 - lib/docscribe.rb
 - lib/docscribe/config.rb
 - lib/docscribe/infer.rb
 - lib/docscribe/inline_rewriter.rb
+- lib/docscribe/parsing.rb
 - lib/docscribe/version.rb
-- rakelib/docs.rake
-- stingray_docs_internal.gemspec
 homepage: https://github.com/unurgunite/docscribe
 licenses: []
 metadata:
@@ -131,14 +165,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.2
 specification_version: 4
 summary: Autogenerate documentation for Ruby code with YARD syntax.
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,11 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-plugins:
-  - rubocop-sorted_methods_by_call
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.0
-
-Layout/LineLength:
-  Max: 120

data/.rubocop_todo.yml

@@ -1,73 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2025-11-12 20:29:05 UTC using RuboCop version 1.81.7.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 5
-# Configuration parameters: EnforcedStyle, AllowedGems.
-# SupportedStyles: Gemfile, gems.rb, gemspec
-Gemspec/DevelopmentDependencies:
-  Exclude:
-    - 'stingray_docs_internal.gemspec'
-
-# Offense count: 10
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 62
-
-# Offense count: 7
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 49
-
-# Offense count: 3
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 187
-
-# Offense count: 11
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/CyclomaticComplexity:
-  Max: 23
-
-# Offense count: 13
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-Metrics/MethodLength:
-  Max: 47
-
-# Offense count: 2
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ModuleLength:
-  Max: 189
-
-# Offense count: 10
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/PerceivedComplexity:
-  Max: 22
-
-# Offense count: 3
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
-Naming/MethodParameterName:
-  Exclude:
-    - 'lib/docscribe/infer.rb'
-
-# Offense count: 4
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/docscribe/config.rb'
-    - 'lib/docscribe/infer.rb'
-    - 'lib/docscribe/inline_rewriter.rb'
-
-# Offense count: 2
-# Configuration parameters: Max.
-Style/SafeNavigationChainLength:
-  Exclude:
-    - 'lib/docscribe/inline_rewriter.rb'

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at senpaiguru1488@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

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

data/Gemfile.lock

@@ -1,73 +0,0 @@
-PATH
-  remote: .
-  specs:
-    docscribe (1.0.0)
-      parser (>= 3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.3)
-    diff-lcs (1.6.2)
-    json (2.16.0)
-    language_server-protocol (3.17.0.5)
-    lint_roller (1.1.0)
-    parallel (1.27.0)
-    parser (3.3.10.0)
-      ast (~> 2.4.1)
-      racc
-    prism (1.6.0)
-    racc (1.8.1)
-    rainbow (3.1.1)
-    rake (13.3.1)
-    regexp_parser (2.11.3)
-    rspec (3.13.2)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.6)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.7)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.6)
-    rubocop (1.81.7)
-      json (~> 2.3)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.47.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.48.0)
-      parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    rubocop-sorted_methods_by_call (1.1.2)
-      lint_roller
-      rubocop (>= 1.72.0)
-    ruby-progressbar (1.13.0)
-    unicode-display_width (3.2.0)
-      unicode-emoji (~> 4.1)
-    unicode-emoji (4.1.0)
-    yard (0.9.37)
-
-PLATFORMS
-  ruby
-  x86_64-linux
-
-DEPENDENCIES
-  docscribe!
-  rake
-  rspec (~> 3.0)
-  rubocop
-  rubocop-sorted_methods_by_call
-  yard (>= 0.9.34)
-
-BUNDLED WITH
-   2.5.9

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/rakelib/docs.rake

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require 'English'
-require 'yard'
-require 'fileutils'
-
-GEM_NAME = Bundler.load_gemspec(Dir.glob('*.gemspec').first).name
-DOCS_REPO_NAME = "#{GEM_NAME}_docs".freeze
-DOCS_REPO_PATH = "../#{DOCS_REPO_NAME}".freeze
-
-namespace :docs do # rubocop:disable Metrics/BlockLength
-  desc 'Generate new docs and push them to repo'
-  task generate: :clean do
-    puts 'Generating docs...'
-    YARD::CLI::Yardoc.run
-    puts 'OK!'
-  end
-
-  desc 'Clean existing docs'
-  task :clean do
-    if File.directory?('doc')
-      FileUtils.rm_rf('doc')
-      puts 'Cleaned existing docs directory'
-    end
-  end
-
-  desc 'Pushes docs to github'
-  task push: :generate do
-    unless File.directory?(DOCS_REPO_PATH)
-      puts "Error: Docs repo not found at #{DOCS_REPO_PATH}"
-      puts 'Please clone the docs repo first:'
-      puts "  git clone git@github.com:unurgunite/#{DOCS_REPO_NAME}.git #{DOCS_REPO_PATH}"
-      exit 1
-    end
-
-    puts "Copying docs to #{DOCS_REPO_PATH}..."
-    FileUtils.mkdir_p('doc') unless File.directory?('doc')
-    FileUtils.cp_r('doc/.', DOCS_REPO_PATH)
-
-    puts 'Changing dir...'
-    Dir.chdir(DOCS_REPO_PATH) do
-      puts 'Checking git status...'
-      status_output = `git status --porcelain`
-
-      if status_output.strip.empty?
-        puts 'No changes to commit'
-      else
-        puts 'Committing git changes...'
-        puts `git add .`
-        commit_result = `git commit -m "Update docs for #{GEM_NAME} #{Time.now.utc.strftime('%Y-%m-%d %H:%M:%S UTC')}"`
-        puts commit_result
-
-        if $CHILD_STATUS.success?
-          puts 'Pushing to GitHub...'
-          push_result = `git push origin master 2>&1`
-          puts push_result
-          if $CHILD_STATUS.success?
-            puts 'Docs successfully pushed!'
-          else
-            puts 'Push failed!'
-            exit 1
-          end
-        else
-          puts 'Commit failed!'
-          exit 1
-        end
-      end
-    end
-  end
-
-  desc 'Generate and push docs in one command'
-  task deploy: :push
-end

data/stingray_docs_internal.gemspec

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/docscribe/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'docscribe'
-  spec.version = Docscribe::VERSION
-  spec.authors = ['unurgunite']
-  spec.email = ['senpaiguru1488@gmail.com']
-
-  spec.summary = 'Autogenerate documentation for Ruby code with YARD syntax.'
-  spec.homepage = 'https://github.com/unurgunite/docscribe'
-  spec.required_ruby_version = '>= 3.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/unurgunite/docscribe'
-  spec.metadata['changelog_uri'] = 'https://github.com/unurgunite/docscribe/blob/master/CHANGELOG.md'
-  spec.metadata['rubygems_mfa_required'] = 'true'
-
-  # 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(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
-    end
-  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 'parser', '>= 3.0'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-sorted_methods_by_call'
-  spec.add_development_dependency 'yard', '>= 0.9.34'
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end