pry-byetypo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d29897c99a83e87e7e440a1c4d70152362c59b56909271441ad8ee64cdfc0dda
+  data.tar.gz: e56b51093055e7374b10b83c4ab5694f51a46e6fa7d7bc49db4f883ee1e5238a
+SHA512:
+  metadata.gz: e0196f077acc833eb924f2d112bb88e052a2b8386ac1166d3f155b40db286a2afd99edfd2d81c5dce720d0dbb494902fb7ab0da185463b7926cd3aba0e446a0d
+  data.tar.gz: e3c93cf18c7e5af20557d60d4760d2c7305b3b986c073ec1fc643c5be991e7d54ec8cc36ee9ee9f3a393865f15207bce3292e726a4496f1972cfe71357efe077

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-17
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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 clement.morisset@potloc.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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pry-byetypo.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"
+
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,261 @@
+PATH
+  remote: .
+  specs:
+    pry-byetypo (1.0.0)
+      colorize (~> 1.1.0)
+      pry (>= 0.13, < 0.15)
+      rails (~> 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.3)
+      actionpack (= 7.1.3)
+      activesupport (= 7.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.3)
+      actionpack (= 7.1.3)
+      activejob (= 7.1.3)
+      activerecord (= 7.1.3)
+      activestorage (= 7.1.3)
+      activesupport (= 7.1.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.3)
+      actionpack (= 7.1.3)
+      actionview (= 7.1.3)
+      activejob (= 7.1.3)
+      activesupport (= 7.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.3)
+      actionview (= 7.1.3)
+      activesupport (= 7.1.3)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.3)
+      actionpack (= 7.1.3)
+      activerecord (= 7.1.3)
+      activestorage (= 7.1.3)
+      activesupport (= 7.1.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.3)
+      activesupport (= 7.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.3)
+      activesupport (= 7.1.3)
+      globalid (>= 0.3.6)
+    activemodel (7.1.3)
+      activesupport (= 7.1.3)
+    activerecord (7.1.3)
+      activemodel (= 7.1.3)
+      activesupport (= 7.1.3)
+      timeout (>= 0.4.0)
+    activestorage (7.1.3)
+      actionpack (= 7.1.3)
+      activejob (= 7.1.3)
+      activerecord (= 7.1.3)
+      activesupport (= 7.1.3)
+      marcel (~> 1.0)
+    activesupport (7.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    colorize (1.1.0)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
+    diff-lcs (1.5.0)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.11.1)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (5.21.2)
+    mutex_m (0.2.0)
+    net-imap (0.4.9.1)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0.1)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.16.0-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.0-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.3)
+      actioncable (= 7.1.3)
+      actionmailbox (= 7.1.3)
+      actionmailer (= 7.1.3)
+      actionpack (= 7.1.3)
+      actiontext (= 7.1.3)
+      actionview (= 7.1.3)
+      activejob (= 7.1.3)
+      activemodel (= 7.1.3)
+      activerecord (= 7.1.3)
+      activestorage (= 7.1.3)
+      activesupport (= 7.1.3)
+      bundler (>= 1.15.0)
+      railties (= 7.1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3)
+      actionpack (= 7.1.3)
+      activesupport (= 7.1.3)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.3)
+    reline (0.4.2)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    standard (1.32.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.57.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    stringio (3.1.0)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  pry-byetypo!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 morissetcl
+
+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,145 @@
+# PRY-BYETYPO
+
+Autocorrects typos in your Pry console.
+
+This small Pry plugin captures exceptions that could be due to typos and deduces the correct command based on your database information.
+
+> [!NOTE]
+> So far, this plugin is not framework agnostic, and it requires Rails 7 or later.
+
+
+#### Before
+
+```ruby
+[1] pry(main)> Usert.last
+NameError: uninitialized constant Usert
+from (pry):3:in `__pry__'
+```
+
+#### After
+
+```ruby
+[1] pry(main)> Usert.last
+I, [2024-01-13T20:00:16.280710 #694]  INFO -- : `Usert` not working, running:
+I, [2024-01-13T20:00:16.281237 #694]  INFO -- : User.last
+2024-01-13 20:00:16.345175 D [694:9200 log_subscriber.rb:130] ActiveRecord::Base --   User Load (1.0ms)  SELECT "users".* FROM "users" WHERE "users"."deleted_at" IS NULL ORDER BY "users"."id" DESC LIMIT $1  [["LIMIT", 1]]
+=> #<User id: 1, email: "yo@email.com">
+```
+
+## Installation
+
+
+Install the gem and add to the application's Gemfile, under the `development` group, by executing:
+
+```
+bundle add pry-byetypo
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```
+gem install pry-byetypo
+```
+
+## Usage
+
+1. Open a PRY console.
+2. Start your daily work.
+3. Let `pry-byetypo` remove frictions. 🚀
+
+## Under the hood
+
+### 1. Byetypo dictionary
+
+When you open a new Pry console, the gem will generate a `byetypo_dictionary.pstore` file containing three pieces of information:
+
+- A list of the ActiveRecord models in your application (e.g. `User`, `Account`).
+- A list of the ActiveRecord associations in your application (e.g. `user`, `users`, `account`, `accounts`).
+- A timestamp representing the last time the `byetypo_dictionary` was updated. (by default updated every week).
+
+This file is generated at the root of your application by default. If you want to update its location, you can configure the path by adding a `BYETYPO_STORE_PATH` entry in your `.env` file.
+
+### 2. Captured exceptions
+
+#### NameError
+
+This error occurs when you mispelled a model in your REPL. The gem will catch that exception and will try find the closest matches. If so, it will run the command with the (potential) corrected model.
+
+```ruby
+[1] pry(main)> Usert.last
+I, [2024-01-13T20:00:16.280710 #694]  INFO -- : `Usert` not working, running:
+I, [2024-01-13T20:00:16.281237 #694]  INFO -- : User.last
+2024-01-13 20:00:16.345175 D [694:9200 log_subscriber.rb:130] ActiveRecord::Base --   User Load (1.0ms)  SELECT "users".* FROM "users" WHERE "users"."deleted_at" IS NULL ORDER BY "users"."id" DESC LIMIT $1  [["LIMIT", 1]]
+=> #<User id: 1, email: "yo@email.com">
+```
+
+#### ActiveRecord::ConfigurationError
+
+Raised when association is being configured improperly or user tries to use offset and limit together with `ActiveRecord::Base.has_many` or `ActiveRecord::Base.has_and_belongs_to_many` associations.
+
+eg:
+
+```ruby
+[6] pry(main)> User.joins(:group).where(groups: { name: "Landlord" }).last
+ActiveRecord::ConfigurationError: Can't join 'User' to association named 'group'; perhaps you misspelled it?
+```
+
+This plugin will look into the `byetypo_dictionary` file to find the closest match and run the correct query.
+
+
+```ruby
+[1] pry(main)> User.joins(:group).where(groups: { name: "Landlord" })
+I, [2024-01-13T22:45:16.297811 #1079]  INFO -- : `group` not working, running.
+I, [2024-01-13T22:45:16.297972 #1079]  INFO -- : User.joins(:groups).where(groups: { name: "Landlord" })
+2024-01-13 22:45:16.319544 D [1079:9200 log_subscriber.rb:130] ActiveRecord::Base --   User Load (1.6ms)  SELECT "users".* FROM "users" INNER JOIN "user_groups" ON "user_groups"."user_id" = "users"."id" INNER JOIN "groups" ON "groups"."id" = "user_groups"."group_id" WHERE "users"."deleted_at" IS NULL AND "groups"."name" = $1  [["name", "Landlord"]]
+=> []
+```
+
+#### ActiveRecord::StatementInvalid
+
+The query attempts to reference columns or conditions related to a table, but the table is not properly included in the FROM clause.
+
+```ruby
+[1] pry(main)> User.joins(:groups).where(grous: { name: "Landlord" }).last
+ActiveRecord::StatementInvalid: PG::UndefinedTable: ERROR:  missing FROM-clause entry for table "grous"
+LINE 1: ..."group_id" WHERE "users"."deleted_at" IS NULL AND "grous"."n...
+```
+
+This plugin will look into the `byetypo_dictionary` file to find the closest match and run the correct query.
+
+```ruby
+1] pry(main)> User.joins(:groups).where(grous: { name: "Landlord" }).last
+I, [2024-01-14T23:50:49.273043 #1248]  INFO -- : `grous` not working, running:
+I, [2024-01-14T23:50:49.273177 #1248]  INFO -- : User.joins(:groups).where(groups: { name: "Landlord" }).last
+2024-01-14 23:50:49.281956 D [1248:9200 log_subscriber.rb:130] ActiveRecord::Base --   User Load (2.1ms)  SELECT "users".* FROM "users" INNER JOIN "user_groups" ON "user_groups"."user_id" = "users"."id" INNER JOIN "groups" ON "groups"."id" = "user_groups"."group_id" WHERE "users"."deleted_at" IS NULL AND "groups"."name" = $1 ORDER BY "users"."id" DESC LIMIT $2  [["name", "Landlord"], ["LIMIT", 1]]
+```
+
+## Troubleshooting
+
+Pry-byetypo is linked to your development database. During initialization, it will attempt to establish a connection to retrieve the tables available in your project. It will fetch the information for the development environment from the `database.yml` file.
+
+### Unreadable database URL (URI::InvalidURIError)
+
+If the database connection string is not readable, the gem will be unable to establish a connection. If you encounter such an issue, make sure to add a `DATABASE_URL` variable to your `.env` file with the easily readable URL of your database.
+
+### Unreadable connection pool (ActiveRecord::ConnectionTimeoutError)
+
+If the number of connections in your pool is not readable, you may encounter an `ActiveRecord::ConnectionTimeoutError`. If you experience this issue, make sure to add a `DATABASE_POOL` variable to your `.env` file.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/morissetcl/pry-byetypo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/morissetcl/pry-byetypo/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pry::Byetypo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/morissetcl/pry-byetypo/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/pry-byetypo/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Base
+  class << self
+    def call(...)
+      new(...).call
+    end
+  end
+end

data/lib/pry-byetypo/exceptions/active_record/base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../exceptions_base"
+
+module Exceptions
+  module ActiveRecord
+    class Base < ExceptionsBase
+      private
+
+      def corrected_word
+        @corrected_word ||= spell_checker(associations_dictionary).correct(unknown_from_exception).first
+      end
+
+      def corrected_cmd
+        @corrected_cmd ||= last_cmd.gsub(/\b#{unknown_from_exception}\b/, corrected_word)
+      end
+
+      def unknown_from_exception
+        exception.to_s.match(exception_regexp)[1]
+      end
+
+      def associations_dictionary
+        @associations_dictionary ||= store.transaction { |s| s["associations"] }
+      end
+    end
+  end
+end

data/lib/pry-byetypo/exceptions/active_record/configuration_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Exceptions
+  module ActiveRecord
+    class ConfigurationError < Base
+      private
+
+      def exception_regexp
+        /association named '(.*?)'/
+      end
+    end
+  end
+end

data/lib/pry-byetypo/exceptions/active_record/statement_invalid.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Exceptions
+  module ActiveRecord
+    class StatementInvalid < Base
+      private
+
+      def exception_regexp
+        /PG::UndefinedTable: ERROR:  missing FROM-clause entry for table "(.*?)"\nLINE/
+      end
+    end
+  end
+end

data/lib/pry-byetypo/exceptions/exceptions_base.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+require_relative "../setup/store"
+require "colorize"
+
+class ExceptionsBase < Base
+  include Setup::Store
+
+  def call
+    logger.error(exception.to_s.colorize(color: :light_red, mode: :bold))
+    logger.info("Running: #{corrected_cmd}".colorize(color: :green, mode: :bold))
+
+    pry.eval(corrected_cmd)
+  end
+
+  private
+
+  attr_reader :exception, :output, :pry
+
+  def initialize(output, exception, pry)
+    @output = output
+    @exception = exception
+    @pry = pry
+  end
+
+  def spell_checker(dictionary)
+    DidYouMean::SpellChecker.new(dictionary: dictionary)
+  end
+
+  def logger
+    @logger = Logger.new($stdout)
+  end
+
+  def last_cmd
+    @last_cmd ||= Pry.line_buffer.last.strip
+  end
+end

data/lib/pry-byetypo/exceptions/name_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "exceptions_base"
+
+module Exceptions
+  class NameError < ExceptionsBase
+    private
+
+    def unknown_from_exception
+      exception.to_s.split.last
+    end
+
+    def corrected_word
+      @corrected_word ||= spell_checker(ar_models_dictionary).correct(unknown_from_exception).first
+    end
+
+    def corrected_cmd
+      @corrected_cmd ||= last_cmd.gsub(unknown_from_exception, corrected_word)
+    end
+
+    def ar_models_dictionary
+      @ar_models_dictionary ||= store.transaction { |s| s["active_record_models"] }
+    end
+  end
+end

data/lib/pry-byetypo/exceptions_handler.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "exceptions/active_record/statement_invalid"
+require_relative "exceptions/active_record/configuration_error"
+require_relative "exceptions/name_error"
+
+class ExceptionsHandler < Base
+  attr_reader :exception, :output, :pry
+
+  UNINITIALIZED_CONSTANT = "uninitialized constant"
+  UNDEFINED_TABLE = "UndefinedTable"
+
+  def initialize(output, exception, pry)
+    @output = output
+    @exception = exception
+    @pry = pry
+  end
+
+  def call
+    case exception
+    in NameError => error
+      # eg: Usert.last
+      # NameError is a Superclass for all undefined statement.
+      # In this context We only need to one including an `uninitialized constant` error.
+      return pry_exception_handler unless error.message.include?(UNINITIALIZED_CONSTANT)
+      Exceptions::NameError.call(output, exception, pry)
+    in ActiveRecord::StatementInvalid => error
+      # eg: User.joins(:groups).where(grous: { name: "Landlord" }).last
+      # ActiveRecord::StatementInvalid is a Superclass for all database execution errors.
+      # We only need to one including an `UndefinedTable` error.
+      return pry_exception_handler unless error.message.include?(UNDEFINED_TABLE)
+      Exceptions::ActiveRecord::StatementInvalid.call(output, exception, pry)
+    in ActiveRecord::ConfigurationError
+      # eg:  User.joins(:group).where(groups: { name: "Landlord" }).last
+      Exceptions::ActiveRecord::ConfigurationError.call(output, exception, pry)
+    else
+      pry_exception_handler
+    end
+  end
+
+  private
+
+  def pry_exception_handler
+    Pry::ExceptionHandler.handle_exception(output, exception, pry)
+  end
+end

data/lib/pry-byetypo/setup/application_dictionary.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "checks/database_url"
+require_relative "checks/database_pool"
+require_relative "store"
+
+require "pstore"
+
+module Setup
+  class ApplicationDictionary
+    include Store
+
+    def initialize
+      establish_db_connection
+      populate_store
+    end
+
+    private
+
+    SEVEN_DAYS = 604800
+
+    def populate_store
+      store.transaction do
+        store.abort unless staled_store?
+
+        store["active_record_models"] = populate_active_record_models_dictionary
+        store["associations"] = populate_associations
+        store["synced_at"] = Time.now
+      end
+    end
+
+    def establish_db_connection
+      configuration_checks
+      ActiveRecord::Base.establish_connection(development_database_config)
+    end
+
+    def populate_active_record_models_dictionary
+      Zeitwerk::Loader.eager_load_all
+      ActiveRecord::Base.descendants.map { |model| model.name }
+    end
+
+    def populate_associations
+      table_names = ActiveRecord::Base.connection.tables
+      singularize_table_names = table_names.map { |a| a.chop }
+      table_names.zip(singularize_table_names).flatten
+    end
+
+    def configuration_checks
+      Setup::Checks::DatabaseUrl.check(development_database_config, logger)
+      Setup::Checks::DatabasePool.check(development_database_config, logger)
+    end
+
+    def database_config
+      YAML.safe_load(File.read("./config/database.yml"), aliases: true)
+    end
+
+    def development_database_config
+      @development_database_config ||= database_config["development"]
+    end
+
+    # By default we update the store every week.
+    # TODO: Make it configurable
+    def staled_store?
+      return true if store["synced_at"].nil?
+
+      (store["synced_at"] + SEVEN_DAYS) <= Time.now
+    end
+
+    def logger
+      @logger = Logger.new($stdout)
+    end
+  end
+end

data/lib/pry-byetypo/setup/checks/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "uri"
+
+class Base
+  class << self
+    def check(database_config, logger)
+      URI.parse(database_config[name])
+    rescue URI::InvalidURIError
+      # Try to connect using the ENV variables.
+      if ENV[variable]
+        database_config[name] = ENV[variable]
+      else
+        logger.warn(missing_variable_msg)
+      end
+    end
+  end
+end

data/lib/pry-byetypo/setup/checks/database_pool.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Setup
+  module Checks
+    class DatabasePool < Base
+      class << self
+        def name
+          "pool"
+        end
+
+        def variable
+          "DATABASE_POOL"
+        end
+
+        def missing_variable_msg
+          "[PRY-BYETYPO] ENV[\"DATABASE_POOL\"] is empty. Please assign a value to it to enable the functionality of pry-byetypo."
+        end
+      end
+    end
+  end
+end

data/lib/pry-byetypo/setup/checks/database_url.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Setup
+  module Checks
+    class DatabaseUrl < Base
+      class << self
+        def name
+          "url"
+        end
+
+        def variable
+          "DATABASE_URL"
+        end
+
+        def missing_variable_msg
+          "[PRY-BYETYPO] ENV[\"DATABASE_URL\"] is empty. Please assign a value to it to enable the functionality of pry-byetypo."
+        end
+      end
+    end
+  end
+end

data/lib/pry-byetypo/setup/store.rb

@@ -0,0 +1,13 @@
+module Setup
+  module Store
+    DEFAULT_STORE_PATH = "byetypo_dictionary.pstore"
+
+    def store
+      @store ||= PStore.new(store_path)
+    end
+
+    def store_path
+      ENV["BYETYPO_STORE_PATH"] || DEFAULT_STORE_PATH
+    end
+  end
+end

data/lib/pry-byetypo/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Pry
+  module Byetypo
+    VERSION = "1.0.0"
+  end
+end

data/lib/pry-byetypo.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "pry"
+require "zeitwerk"
+
+require_relative "pry-byetypo/version"
+require_relative "pry-byetypo/setup/application_dictionary"
+require_relative "pry-byetypo/exceptions_handler"
+
+module Pry::Byetypo
+  Pry.config.hooks.add_hook(:before_session, :eager_loading) do |output, exception, pry|
+    Setup::ApplicationDictionary.new
+  end
+
+  # TODO: Adds max_attempts
+  # TODO: If max_attempt reached clean the last entries (eg: max entry 3 has been reached, we remove the last 3 history entries)
+  Pry.config.exception_handler = proc do |output, exception, pry|
+    ExceptionsHandler.call(output, exception, pry)
+  end
+end

data/pry-byetypo.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/pry-byetypo/version"
+
+Gem::Specification.new do |gem|
+  gem.name = "pry-byetypo"
+  gem.version = Pry::Byetypo::VERSION
+  gem.authors = ["morissetcl"]
+  gem.email = ["morissetcl87@gmail.com"]
+
+  gem.summary = "Autocorrects typos in your Pry console"
+  gem.description = "This small Pry plugin captures exceptions that could be due to typos and deduces the correct command based on your database information."
+  gem.homepage = "https://github.com/morissetcl/pry-byetypo"
+  gem.license = "MIT"
+  gem.required_ruby_version = ">= 2.6.0"
+
+  gem.metadata["homepage_uri"] = gem.homepage
+  gem.metadata["source_code_uri"] = "https://github.com/morissetcl/pry-byetypo"
+  gem.metadata["changelog_uri"] = "https://github.com/morissetcl/pry-byetypo/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.
+  gem.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
+  gem.bindir = "exe"
+  gem.executables = gem.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+  gem.add_runtime_dependency "colorize", "~> 1.1.0"
+  gem.add_runtime_dependency "pry", ">= 0.13", "< 0.15"
+  gem.add_runtime_dependency "rails", "~> 7.0"
+end

data/sig/pry/byetypo.rbs

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

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: pry-byetypo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- morissetcl
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: This small Pry plugin captures exceptions that could be due to typos
+  and deduces the correct command based on your database information.
+email:
+- morissetcl87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pry-byetypo.rb
+- lib/pry-byetypo/base.rb
+- lib/pry-byetypo/exceptions/active_record/base.rb
+- lib/pry-byetypo/exceptions/active_record/configuration_error.rb
+- lib/pry-byetypo/exceptions/active_record/statement_invalid.rb
+- lib/pry-byetypo/exceptions/exceptions_base.rb
+- lib/pry-byetypo/exceptions/name_error.rb
+- lib/pry-byetypo/exceptions_handler.rb
+- lib/pry-byetypo/setup/application_dictionary.rb
+- lib/pry-byetypo/setup/checks/base.rb
+- lib/pry-byetypo/setup/checks/database_pool.rb
+- lib/pry-byetypo/setup/checks/database_url.rb
+- lib/pry-byetypo/setup/store.rb
+- lib/pry-byetypo/version.rb
+- pry-byetypo.gemspec
+- sig/pry/byetypo.rbs
+homepage: https://github.com/morissetcl/pry-byetypo
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/morissetcl/pry-byetypo
+  source_code_uri: https://github.com/morissetcl/pry-byetypo
+  changelog_uri: https://github.com/morissetcl/pry-byetypo/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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Autocorrects typos in your Pry console
+test_files: []