ruby_words 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb4ef1d8330ed9b812c07698d1c085c4472a43533dbedd6032e175c324312a00
+  data.tar.gz: 0f6b3bfb2dda65a7ad94011158f8bd6310c9cb779781f7d7edaf3d2f5421beb6
+SHA512:
+  metadata.gz: da8429f9991a2ac433f74b94e588a90bd5a45d5d182018d9cf0c6609663d3eafe021ebb8dc8a8bac4ea6a031f1f03e82755cfa7b33547f98085275eb987eac4d
+  data.tar.gz: 2decb2934af4069004f0ac616376318303e09f1aca815990947a796b2bd655aeff91c183312786f92b57b41a8c6a29aaa5136119caa4b773cfd30fad83817df0

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-20
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Andy Waite
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Ruby Words
+
+This is a simple gem which emits a list of words used within the Ruby language. The intention is to use it for building programming dictionaries for tools such as [cspell](https://cspell.org).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ruby_words
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install ruby_wors
+
+## Usage
+
+Install the gem, then run `ruby_words`.
+
+## 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/andyw8/ruby_words.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/exe/ruby_words

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "ruby_words"
+
+ruby_words = RubyWords::Ruby.new
+ruby_words.run
+puts ruby_words.all

data/lib/ruby_words/version.rb

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

data/lib/ruby_words.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "ruby_words/version"
+
+require "rbs"
+
+module RubyWords
+  class Error < StandardError; end
+
+  class Ruby
+    def initialize
+      @method_names = []
+    end
+
+    def run
+      loader = RBS::EnvironmentLoader.new
+      RBS::Environment.from_loader(loader).resolve_type_names
+
+      loader.each_signature do |_source, pathname, _buffer, declarations, _directives|
+        process_signature(pathname, declarations)
+      end
+    end
+
+    def all
+      @method_names.uniq.sort
+    end
+
+    private
+
+    def process_signature(pathname, declarations)
+      declarations.each do |declaration|
+        process_declaration(declaration, pathname)
+      end
+    end
+
+    def process_declaration(declaration, pathname)
+      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)
+      declaration.members.each do |member|
+        case member
+        when RBS::AST::Members::MethodDefinition
+          handle_method(member)
+        end
+      end
+    end
+
+    def handle_method(member)
+      name = member.name.name
+      @method_names.append(*name.split("_"))
+    end
+  end
+end

data/sig/ruby_words.rbs

@@ -0,0 +1,4 @@
+module RubyWords
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: ruby_words
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Waite
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description:
+email:
+- 13400+andyw8@users.noreply.github.com
+executables:
+- ruby_words
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/ruby_words
+- lib/ruby_words.rb
+- lib/ruby_words/version.rb
+- sig/ruby_words.rbs
+homepage: https://github.com/andyw8/ruby_words
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: A list of words from the Ruby programming language
+test_files: []