ruby_words 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb4ef1d8330ed9b812c07698d1c085c4472a43533dbedd6032e175c324312a00
-  data.tar.gz: 0f6b3bfb2dda65a7ad94011158f8bd6310c9cb779781f7d7edaf3d2f5421beb6
+  metadata.gz: 39b9665049405ab0b4282ca6b3834735d06baac156c0ea0054480cc10023842e
+  data.tar.gz: 8bf024f3ac49c260c6e4c7d88b15b9cc9a7a221526ab189022a215b59d984e21
 SHA512:
-  metadata.gz: da8429f9991a2ac433f74b94e588a90bd5a45d5d182018d9cf0c6609663d3eafe021ebb8dc8a8bac4ea6a031f1f03e82755cfa7b33547f98085275eb987eac4d
-  data.tar.gz: 2decb2934af4069004f0ac616376318303e09f1aca815990947a796b2bd655aeff91c183312786f92b57b41a8c6a29aaa5136119caa4b773cfd30fad83817df0
+  metadata.gz: 1ac3d4c5548139c0cb8671cd68d76cb3a00e1ce8d6b1dc8b9fef86dfdc7a20ca5801bc91f0c24d1a3a8ed648b55244ed33a88f406b440b8035c291f1ef2b902f
+  data.tar.gz: eacea667fa08297976e96692c0d0b29966410745a42d51cf6752f8f8e728be117b1fb2d3b7963eed079a656f61c9076801daca049caf32dc547b91b6ca7b33f6

data/CLAUDE.md

@@ -0,0 +1,63 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+This is a Ruby gem that extracts words from the Ruby language by parsing RBS type signatures. It uses the `rbs` gem to load Ruby's standard library type definitions and extracts method names, splitting them by underscores to create a word list suitable for programming dictionaries (e.g., cspell).
+
+## Key Commands
+
+### Setup
+- `bin/setup` - Install dependencies and prepare the development environment
+
+### Testing
+- `rake test` - Run the test suite (using Minitest)
+- `rake` - Run default task (tests + linting)
+
+### Linting
+- `rake standard` - Run Standard Ruby linter (auto-formatter based on RuboCop)
+- `bundle exec standardrb --fix` - Auto-fix linting issues
+
+### Running the Tool
+- `bundle exec exe/ruby_words` - Run the CLI locally (outputs a sorted list of words to stdout)
+- `bin/console` - Start an interactive console for experimentation
+
+### Gem Management
+- `bundle exec rake install` - Install gem locally for testing
+- `bundle exec rake release` - Release a new version (tags, pushes to RubyGems)
+
+## Architecture
+
+### Core Implementation (`lib/ruby_words.rb`)
+
+The main logic is in the `RubyWords::Ruby` class:
+
+1. **RBS Loading**: Uses `RBS::EnvironmentLoader` to load all RBS type signatures from Ruby's standard library
+2. **AST Traversal**: Walks through RBS declarations, focusing on class/module declarations
+3. **Method Extraction**: Extracts method names from method definitions
+4. **Word Splitting**: Splits method names by underscores to create individual words (e.g., `to_s` becomes `["to", "s"]`)
+5. **Deduplication**: Returns unique, sorted word list
+
+### Executable (`exe/ruby_words`)
+
+Simple CLI that instantiates `RubyWords::Ruby`, calls `run` to process all signatures, and outputs the word list.
+
+## Code Style
+
+- Uses **Standard Ruby** for code formatting and linting (extends RuboCop)
+- Enforces **double quotes** for string literals (see `.rubocop.yml`)
+- Requires Ruby >= 3.0
+- Uses `frozen_string_literal: true` in all Ruby files
+
+## Testing
+
+- Uses **Minitest** as the testing framework
+- Test files located in `test/`
+- Currently minimal test coverage (only version check)
+
+## Type Signatures
+
+- RBS type signatures are in `sig/` directory
+- Main signature file: `sig/ruby_words.rbs`
+- The gem itself depends on the `rbs` gem (~> 3.6)

data/README.md

@@ -10,7 +10,7 @@ Install the gem and add to the application's Gemfile by executing:
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install ruby_wors
+    $ gem install ruby_words
 
 ## Usage
 

data/lib/ruby_words/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyWords
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/ruby_words.rb

@@ -22,7 +22,11 @@ module RubyWords
     end
 
     def all
-      @method_names.uniq.sort
+      @method_names
+        .map { |word| word.delete_suffix("?").delete_suffix("!").delete_suffix("=") }
+        .select { |word| word.match?(/[a-zA-Z0-9]/) && word.length > 1 }
+        .uniq
+        .sort
     end
 
     private
@@ -37,12 +41,15 @@ module RubyWords
       case declaration
       when RBS::AST::Declarations::Class, RBS::AST::Declarations::Module
         handle_class_or_module_declaration(declaration, pathname)
-      else
-        # Other kinds not yet handled
       end
     end
 
     def handle_class_or_module_declaration(declaration, pathname)
+      # Add the class/module name itself, split by :: and CamelCase
+      declaration.name.to_s.split("::").each do |part|
+        @method_names.append(*split_camel_case(part))
+      end
+
       declaration.members.each do |member|
         case member
         when RBS::AST::Members::MethodDefinition
@@ -55,5 +62,14 @@ module RubyWords
       name = member.name.name
       @method_names.append(*name.split("_"))
     end
+
+    def split_camel_case(word)
+      # Split CamelCase, handling acronyms like EOF in EOFError
+      # Since Ruby class names always start uppercase, we can use a simpler pattern
+      # EOFError -> EOF, Error
+      # FileTest -> File, Test
+      # HTTPSConnection -> HTTPS, Connection
+      word.scan(/[A-Z]+(?=[A-Z][a-z]|\b)|[A-Z][a-z]+/)
+    end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby_words
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Waite
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -24,7 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-description:
 email:
 - 13400+andyw8@users.noreply.github.com
 executables:
@@ -34,6 +32,7 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - CHANGELOG.md
+- CLAUDE.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -49,7 +48,6 @@ metadata:
   homepage_uri: https://github.com/andyw8/ruby_words
   source_code_uri: https://github.com/andyw8/ruby_words
   changelog_uri: https://github.com/andyw8/ruby-lsp/releases
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A list of words from the Ruby programming language
 test_files: []