pry-byetypo 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d29897c99a83e87e7e440a1c4d70152362c59b56909271441ad8ee64cdfc0dda
-  data.tar.gz: e56b51093055e7374b10b83c4ab5694f51a46e6fa7d7bc49db4f883ee1e5238a
+  metadata.gz: ffd46e3838ed0c8d43e5aa5c3fc5a38c518d90a4dbefcbba09f1629fffe72260
+  data.tar.gz: cef94f7e070bc541cedc9f2a547a9dc2901b8bf2ca96b4cfda09f5ffef890381
 SHA512:
-  metadata.gz: e0196f077acc833eb924f2d112bb88e052a2b8386ac1166d3f155b40db286a2afd99edfd2d81c5dce720d0dbb494902fb7ab0da185463b7926cd3aba0e446a0d
-  data.tar.gz: e3c93cf18c7e5af20557d60d4760d2c7305b3b986c073ec1fc643c5be991e7d54ec8cc36ee9ee9f3a393865f15207bce3292e726a4496f1972cfe71357efe077
+  metadata.gz: 61e7d2eb327d7a3905eb882288260484d42497bfe895a98a72bbccf562d9905ede28becb9b9c2da9e71c537967f8621299d364b97f442869d98f551a4b5073a4
+  data.tar.gz: 86252b1586e787a3f3e3ac6a66c13034640eba983a2d0d8a8be95f239906fef4611f9c00fcf17c675030b03ab512605dc1e87436ef9eaea7d261675a2cc03845

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pry-byetypo (1.0.0)
+    pry-byetypo (1.1.0)
       colorize (~> 1.1.0)
       pry (>= 0.13, < 0.15)
       rails (~> 7.0)

data/README.md

@@ -2,30 +2,32 @@
 
 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.
-
+This small Pry plugin captures exceptions that may arise from typos and deduces the correct command based on your database information and session history.
 
 #### Before
 
 ```ruby
-[1] pry(main)> Usert.last
-NameError: uninitialized constant Usert
-from (pry):3:in `__pry__'
+[1] pry(main)> result = 1
+=> 1
+[2] pry(main)> resilt
+NameError: undefined local variable or method `resilt' for main:Object
+from (pry):2: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">
+[1] pry(main)> result = 1
+=> 1
+[2] pry(main)> resilt
+E, [2024-01-31T17:11:16.344161 #3739] ERROR -- : undefined local variable or method `resilt' for main:Object
+I, [2024-01-31T17:11:16.344503 #3739]  INFO -- : Running: result
+=> 1
 ```
 
+> [!NOTE]
+> So far, this plugin is not framework agnostic, and it requires Rails 7 or later.
+
 ## Installation
 
 
@@ -47,57 +49,94 @@ gem install pry-byetypo
 2. Start your daily work.
 3. Let `pry-byetypo` remove frictions. 🚀
 
-## Under the hood
+## Byetypo dictionary
 
-### 1. Byetypo dictionary
-
-When you open a new Pry console, the gem will generate a `byetypo_dictionary.pstore` file containing three pieces of information:
+When you open a new Pry console, the gem will generate a `byetypo_dictionary.pstore` file containing four 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`).
+- Unique identifiers for each active Pry instance, populated with the variable history of the current session. (e.g. `result = 1` will store `result`)
 - 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
+## Captured exceptions
+
+### NameError - undefined local variable or method
+
+This error occurs when you mispelled a variable 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 variable.
+
+##### Before
+
+```ruby
+[1] pry(main)> result = 1
+=> 1
+[2] pry(main)> resilt
+NameError: undefined local variable or method `resilt' for main:Object
+from (pry):2:in `__pry__'
+```
+
+##### After
+
+```ruby
+[1] pry(main)> result = 1
+=> 1
+[2] pry(main)> resilt
+E, [2024-01-31T17:11:16.344161 #3739] ERROR -- : undefined local variable or method `resilt' for main:Object
+I, [2024-01-31T17:11:16.344503 #3739]  INFO -- : Running: result
+=> 1
+```
 
-#### NameError
+### NameError - uninitialized constant
 
 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.
 
+##### Before
+
+```ruby
+[2] pry(main)> Usert.last
+NameError: uninitialized constant Usert
+from (pry):2:in `__pry__'
+[3] pry(main)>
+```
+
+##### 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]]
+I, [2024-01-13T20:00:16.280710 #694]  ERROR -- : uninitialized constant Usert
+I, [2024-01-13T20:00:16.281237 #694]  INFO -- : Running: User.last
 => #<User id: 1, email: "yo@email.com">
 ```
 
-#### ActiveRecord::ConfigurationError
+### 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.
+This plugin will look into the `byetypo_dictionary` file to find the closest match and run the correct query.
 
-eg:
+##### Before
 
 ```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.
-
+##### After
 
 ```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" })
+I, [2024-01-13T22:45:16.297811 #1079]  ERROR -- : ActiveRecord::ConfigurationError: Can't join 'User' to association named 'group'; perhaps you misspelled it?
+I, [2024-01-13T22:45:16.297972 #1079]  INFO -- : Running: 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
+### 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.
+This plugin will look into the `byetypo_dictionary` file to find the closest match and run the correct query.
+
+##### Before
 
 ```ruby
 [1] pry(main)> User.joins(:groups).where(grous: { name: "Landlord" }).last
@@ -105,12 +144,12 @@ ActiveRecord::StatementInvalid: PG::UndefinedTable: ERROR:  missing FROM-clause
 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.
+##### After
 
 ```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
+I, [2024-01-14T23:50:49.273043 #1248]  ERROR -- : ActiveRecord::StatementInvalid: PG::UndefinedTable: ERROR:  missing FROM-clause entry for table "grous"
+I, [2024-01-14T23:50:49.273177 #1248]  INFO -- : Running: 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]]
 ```
 
@@ -118,11 +157,11 @@ I, [2024-01-14T23:50:49.273177 #1248]  INFO -- : User.joins(:groups).where(group
 
 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)
+#### 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)
+#### 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.
 

data/lib/pry-byetypo/constants/errors.rb

@@ -0,0 +1,7 @@
+module Constants
+  module Errors
+    UNINITIALIZED_CONSTANT = "uninitialized constant".freeze
+    UNDEFINED_VARIABLE = "undefined local variable".freeze
+    UNDEFINED_TABLE = "UndefinedTable".freeze
+  end
+end

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

@@ -1,17 +1,22 @@
 # frozen_string_literal: true
 
+require "logger"
+require "colorize"
 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)
+    if corrected_word
+      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)
+    else
+      Pry::ExceptionHandler.handle_exception(output, exception, pry)
+    end
   end
 
   private

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../exceptions_base"
+require_relative "../../constants/errors"
+require_relative "uninitialized_constant"
+require_relative "undefined_variable"
+
+module Exceptions
+  module NameError
+    class Handler < ExceptionsBase
+      attr_reader :exception, :output, :pry
+
+      def initialize(output, exception, pry)
+        @output = output
+        @exception = exception
+        @pry = pry
+      end
+
+      # FIXME: https://github.com/rubocop/rubocop-performance/issues/438
+      # rubocop:disable Performance/ConstantRegexp
+      def call
+        case exception.message
+        in /#{Constants::Errors::UNINITIALIZED_CONSTANT}/
+          UninitializedConstant.call(output, exception, pry)
+        in /#{Constants::Errors::UNDEFINED_VARIABLE}/
+          UndefinedVariable.call(output, exception, pry)
+        else
+          Pry::ExceptionHandler.handle_exception(output, exception, pry)
+        end
+      end
+      # rubocop:enable Performance/ConstantRegexp
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "../exceptions_base"
+
+module Exceptions
+  module NameError
+    class UndefinedVariable < ExceptionsBase
+      private
+
+      def corrected_word
+        @corrected_word ||= spell_checker(session_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 session_dictionary
+        @session_dictionary ||= store.transaction { |s| s[pry_instance_uid] }
+      end
+
+      def exception_regexp
+        /`(\w+)'/
+      end
+
+      # Use the current binding identifier as pry instance uid.
+      def pry_instance_uid
+        pry.current_binding.to_s
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../exceptions_base"
+
+module Exceptions
+  module NameError
+    class UninitializedConstant < 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
+end

data/lib/pry-byetypo/exceptions_handler.rb

@@ -3,14 +3,12 @@
 require_relative "base"
 require_relative "exceptions/active_record/statement_invalid"
 require_relative "exceptions/active_record/configuration_error"
-require_relative "exceptions/name_error"
+require_relative "exceptions/name_error/handler"
+require_relative "constants/errors"
 
 class ExceptionsHandler < Base
   attr_reader :exception, :output, :pry
 
-  UNINITIALIZED_CONSTANT = "uninitialized constant"
-  UNDEFINED_TABLE = "UndefinedTable"
-
   def initialize(output, exception, pry)
     @output = output
     @exception = exception
@@ -19,20 +17,15 @@ class ExceptionsHandler < Base
 
   def call
     case exception
-    in NameError => error
-      # eg: Usert.last
+    in NameError
       # 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
+      Exceptions::NameError::Handler.call(output, exception, pry)
+    in ActiveRecord::StatementInvalid
       # 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)
+      return pry_exception_handler unless exception.message.include?(Constants::Errors::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

data/lib/pry-byetypo/session/clear_history.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+require_relative "../setup/store"
+
+module Session
+  class ClearHistory < Base
+    include Setup::Store
+
+    attr_reader :pry
+
+    def initialize(pry)
+      @pry = pry
+    end
+
+    def call
+      pry_instance_to_remove = pry.push_initial_binding.join
+      store.transaction { store.delete(pry_instance_to_remove) }
+    end
+  end
+end

data/lib/pry-byetypo/session/populate_history.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+require_relative "../setup/store"
+
+module Session
+  class PopulateHistory < Base
+    include Setup::Store
+
+    attr_reader :binding
+
+    def initialize(binding)
+      @binding = binding
+    end
+
+    def call
+      store.transaction do
+        store.abort unless extract_variable_to_store
+
+        store[pry_instance_uid].push(variable_to_store)
+      end
+    end
+
+    private
+
+    # Unique instance identifier (e.g., a Pry opened tab)
+    def pry_instance_uid
+      binding.binding_stack.join
+    end
+
+    def extract_variable_to_store
+      @extract_variable_to_store ||= last_cmd.match(/^(\w+)\s*=/)
+    end
+
+    def last_cmd
+      binding.eval_string.strip
+    end
+
+    def variable_to_store
+      extract_variable_to_store[1]
+    end
+  end
+end

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

@@ -3,25 +3,34 @@
 require_relative "checks/database_url"
 require_relative "checks/database_pool"
 require_relative "store"
+require_relative "../base"
 
 require "pstore"
 
 module Setup
-  class ApplicationDictionary
+  class ApplicationDictionary < Base
     include Store
 
-    def initialize
+    def initialize(binding)
+      @binding = binding
+    end
+
+    def call
       establish_db_connection
       populate_store
     end
 
     private
 
+    attr_reader :binding
+
     SEVEN_DAYS = 604800
 
     def populate_store
       store.transaction do
-        store.abort unless staled_store?
+        # Create a table with unique instance identifier information to store variables history.
+        store[pry_instance_uid] = []
+        store.commit unless staled_store?
 
         store["active_record_models"] = populate_active_record_models_dictionary
         store["associations"] = populate_associations
@@ -66,6 +75,11 @@ module Setup
       (store["synced_at"] + SEVEN_DAYS) <= Time.now
     end
 
+    # Use the binding identifier as pry instance uid.
+    def pry_instance_uid
+      binding.to_s
+    end
+
     def logger
       @logger = Logger.new($stdout)
     end

data/lib/pry-byetypo/version.rb

@@ -2,6 +2,6 @@
 
 class Pry
   module Byetypo
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/pry-byetypo.rb

@@ -1,15 +1,24 @@
 # frozen_string_literal: true
 
 require "pry"
-require "zeitwerk"
 
-require_relative "pry-byetypo/version"
 require_relative "pry-byetypo/setup/application_dictionary"
+require_relative "pry-byetypo/session/clear_history"
 require_relative "pry-byetypo/exceptions_handler"
+require_relative "pry-byetypo/session/populate_history"
+require_relative "pry-byetypo/version"
 
 module Pry::Byetypo
-  Pry.config.hooks.add_hook(:before_session, :eager_loading) do |output, exception, pry|
-    Setup::ApplicationDictionary.new
+  Pry.config.hooks.add_hook(:before_session, :create_dictionary) do |_output, binding, _pry|
+    Setup::ApplicationDictionary.call(binding)
+  end
+
+  Pry.config.hooks.add_hook(:after_read, :populate_session_history) do |_output, binding, _pry|
+    Session::PopulateHistory.call(binding)
+  end
+
+  Pry.config.hooks.add_hook(:after_session, :clear_session_history) do |_output, _binding, pry|
+    Session::ClearHistory.call(pry)
   end
 
   # TODO: Adds max_attempts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-byetypo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - morissetcl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -77,12 +77,17 @@ files:
 - Rakefile
 - lib/pry-byetypo.rb
 - lib/pry-byetypo/base.rb
+- lib/pry-byetypo/constants/errors.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/name_error/handler.rb
+- lib/pry-byetypo/exceptions/name_error/undefined_variable.rb
+- lib/pry-byetypo/exceptions/name_error/uninitialized_constant.rb
 - lib/pry-byetypo/exceptions_handler.rb
+- lib/pry-byetypo/session/clear_history.rb
+- lib/pry-byetypo/session/populate_history.rb
 - lib/pry-byetypo/setup/application_dictionary.rb
 - lib/pry-byetypo/setup/checks/base.rb
 - lib/pry-byetypo/setup/checks/database_pool.rb

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

@@ -1,25 +0,0 @@
-# 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