rubocop-spellcheck 0.1.0 → 0.2.0

data/lib/rubocop/spellcheck/vocabulary_config.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module RuboCop
+  module Spellcheck
+    # Updates only the generated dictionary setting, preserving surrounding configuration.
+    class VocabularyConfig
+      COP = 'Spellcheck/Spelling'
+
+      def initialize(path, section:)
+        @path = path
+        @section = section
+        @source = File.read(path, encoding: 'UTF-8')
+        @root = Psych.parse(@source)&.root
+      rescue Psych::SyntaxError => e
+        raise RuboCop::ValidationError, "Cannot update spelling configuration #{@path}: #{e.message}"
+      end
+
+      def updated(dictionaries)
+        setting = YAML.dump('DictionaryFiles' => dictionaries).delete_prefix("---\n")
+        cop = value_for(@root, @section)
+        return append("#{@section}:\n#{indent(setting)}") unless cop
+
+        unless cop.is_a?(Psych::Nodes::Mapping) && cop.style == Psych::Nodes::Mapping::BLOCK
+          raise RuboCop::ValidationError, "Cannot generate spelling vocabulary for non-block #{@section} in #{@path}."
+        end
+
+        replace_setting(cop, setting)
+      end
+
+      private
+
+      def value_for(mapping, key)
+        return unless mapping.is_a?(Psych::Nodes::Mapping)
+
+        mapping.children.each_slice(2).find { |name, _value| name.value == key }&.last
+      end
+
+      def indent(text, width = 2)
+        text.lines.map { |line| "#{' ' * width}#{line}" }.join
+      end
+
+      def append(text)
+        if @root && @source.lines[@root.end_line]&.match?(/\A\.\.\.(?:\s|#|\z)/)
+          return @source.lines.insert(@root.end_line, "\n#{text}").join
+        end
+
+        "#{@source.rstrip}\n\n#{text}"
+      end
+
+      def replace_setting(cop, setting)
+        lines = @source.lines
+        pair = cop.children.each_slice(2).find { |key, _value| key.value == 'DictionaryFiles' }
+        if pair
+          replace_pair(lines, pair, setting)
+        else
+          first = cop.children.first
+          lines.insert(first.start_line, indent(setting, first.start_column))
+        end
+        lines.join
+      end
+
+      def replace_pair(lines, pair, setting)
+        key, value = pair
+        prefix = lines[value.end_line]&.slice(0, value.end_column)
+        last = value.end_line + (prefix && !prefix.strip.empty? ? 1 : 0)
+        lines[key.start_line...last] = [indent(setting, key.start_column)]
+      end
+    end
+  end
+end

data/lib/rubocop/spellcheck/vocabulary_formatter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Spellcheck
+    # Collects auto-generation results in the parent process, even when investigations are cached.
+    module VocabularyFormatter
+      def file_started(file, options)
+        @spellcheck_config_store = options.fetch(:config_store)
+        super
+      end
+
+      def file_finished(file, offenses)
+        spelling, others = offenses.partition { |offense| offense.cop_name == VocabularyConfig::COP }
+        config = @spellcheck_config_store.for_file(file)
+        if !spelling.empty? || regenerating?(file, config)
+          @spellcheck_vocabularies ||= {}
+          vocabulary = (@spellcheck_vocabularies[config.loaded_path] ||= Vocabulary.new(config))
+          spelling.each { |offense| vocabulary.add(offense) }
+        end
+        super(file, others)
+      end
+
+      def finished(inspected_files)
+        @spellcheck_vocabularies&.each_value(&:write)
+        super
+      end
+
+      private
+
+      def regenerating?(file, config)
+        return false unless spelling_selected?
+        return false unless File.exist?(File.join(config.base_dir_for_path_parameters, '.spellcheck.txt'))
+
+        @spellcheck_cops ||= {}
+        cop = (@spellcheck_cops[config.loaded_path] ||= RuboCop::Cop::Spellcheck::Spelling.new(config, @options))
+        config.for_badge(cop.class.badge)['Enabled'] && cop.relevant_file?(file)
+      end
+
+      def spelling_selected?
+        names = %w[Spellcheck Spellcheck/Spelling]
+        (!@options[:only] || @options[:only].intersect?(names)) && !@options.fetch(:except, []).intersect?(names)
+      end
+    end
+  end
+end
+
+RuboCop::Formatter::DisabledConfigFormatter.prepend(RuboCop::Spellcheck::VocabularyFormatter)

data/lib/rubocop-spellcheck.rb

@@ -4,7 +4,24 @@ require 'rubocop'
 require_relative 'rubocop/spellcheck/version'
 require_relative 'rubocop/spellcheck/plugin'
 require_relative 'rubocop/spellcheck/checker'
+require_relative 'rubocop/spellcheck/vocabulary_config'
+require_relative 'rubocop/spellcheck/vocabulary'
+require_relative 'rubocop/spellcheck/vocabulary_formatter'
+require_relative 'rubocop/spellcheck/correction'
+require_relative 'rubocop/spellcheck/span'
+require_relative 'rubocop/spellcheck/ruby_identifiers'
+require_relative 'rubocop/spellcheck/ruby_string_map'
+require_relative 'rubocop/spellcheck/ruby_strings'
+require_relative 'rubocop/spellcheck/ruby_code'
+require_relative 'rubocop/spellcheck/front_matter_paths'
 require_relative 'rubocop/spellcheck/front_matter'
 require_relative 'rubocop/spellcheck/markdown'
+require_relative 'rubocop/spellcheck/markdown_directives'
+require_relative 'rubocop/spellcheck/markdown_ruby'
+require_relative 'rubocop/spellcheck/rdoc'
+require_relative 'rubocop/spellcheck/rdoc_comments'
+require_relative 'rubocop/spellcheck/asciidoc'
+require_relative 'rubocop/spellcheck/asciidoc_inline'
+require_relative 'rubocop/spellcheck/asciidoc_table'
 require_relative 'rubocop/spellcheck/prose_source'
 require_relative 'rubocop/cop/spellcheck/spelling'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-spellcheck
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel (dB.) Doubrovkine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-20 00:00:00.000000000 Z
+date: 2026-10-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -72,8 +100,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.72.1
-description: RuboCop spelling checks for Ruby comments, Markdown, and plain text,
-  using offline dictionaries.
+description: RuboCop spelling checks for Ruby comments, strings, identifiers, and
+  documentation, using offline dictionaries.
 email:
 - dblock@dblock.org
 executables: []
@@ -90,12 +118,29 @@ files:
 - data/en/en.dic
 - lib/rubocop-spellcheck.rb
 - lib/rubocop/cop/spellcheck/spelling.rb
+- lib/rubocop/spellcheck/asciidoc.rb
+- lib/rubocop/spellcheck/asciidoc_inline.rb
+- lib/rubocop/spellcheck/asciidoc_table.rb
 - lib/rubocop/spellcheck/checker.rb
+- lib/rubocop/spellcheck/correction.rb
 - lib/rubocop/spellcheck/front_matter.rb
+- lib/rubocop/spellcheck/front_matter_paths.rb
 - lib/rubocop/spellcheck/markdown.rb
+- lib/rubocop/spellcheck/markdown_directives.rb
+- lib/rubocop/spellcheck/markdown_ruby.rb
 - lib/rubocop/spellcheck/plugin.rb
 - lib/rubocop/spellcheck/prose_source.rb
+- lib/rubocop/spellcheck/rdoc.rb
+- lib/rubocop/spellcheck/rdoc_comments.rb
+- lib/rubocop/spellcheck/ruby_code.rb
+- lib/rubocop/spellcheck/ruby_identifiers.rb
+- lib/rubocop/spellcheck/ruby_string_map.rb
+- lib/rubocop/spellcheck/ruby_strings.rb
+- lib/rubocop/spellcheck/span.rb
 - lib/rubocop/spellcheck/version.rb
+- lib/rubocop/spellcheck/vocabulary.rb
+- lib/rubocop/spellcheck/vocabulary_config.rb
+- lib/rubocop/spellcheck/vocabulary_formatter.rb
 homepage: https://github.com/dblock/rubocop-spellcheck
 licenses:
 - MIT
@@ -124,5 +169,5 @@ requirements: []
 rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: Spellcheck Ruby comments, Markdown, and plain text with RuboCop.
+summary: Spellcheck Ruby code and documentation with RuboCop.
 test_files: []