pry-byetypo 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19364c10e5d63e6ebc62aa9546e77897e7c82d833da814696f2f02acaf08c0e9
-  data.tar.gz: 9e2d299d10364d6bc76db71d8596b2b942ded8baa6954f90f515d3a7c73319dd
+  metadata.gz: 6625ca5eccb6c5953192b436b7c39cb907cd594aa1727c05e6bdc3a36a61ef37
+  data.tar.gz: 4e8ffb997e22b265fb238c1c7feac89668d66ee60b74a87ced1f7ba33fc6ba64
 SHA512:
-  metadata.gz: f41711a85eb37c414185c405a4dffd3325b6e172113362362e1176cfe151bfd941ebc535aa0202ce296e77f1f4871a1e161cdaa79022b1cde8797dd7db9d1c3d
-  data.tar.gz: 21373c1b2a16ac6df0f8c5545ed93f1925295056e07618093bfbefc9ac0085398894d427b302a4bb2b3b01853b6aa4b877347c47fadb51863ff5e0f7be77594d
+  metadata.gz: 1bf268550d2b31a241534c795d55ba431b841cedf546686fe0c57c695a0ef5790329e33fe60f0569290cfc26458997e9bfc30bfa7eff4d8ff41f818b66ead9cb
+  data.tar.gz: 0bb3d4377ea47c2d7beb39d15011e77000cd007fcf6e1905a9c62ceff415d31456d9ea88a8b2d7429019107bc32ff6b9e2354ade9c32b30cecc77385c74712d2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pry-byetypo (1.3.1)
+    pry-byetypo (1.3.3)
       pry (>= 0.13, < 0.15)
 
 GEM

data/README.md

@@ -4,29 +4,8 @@ Autocorrects typos in your Pry console.
 
 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)> 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
-```
-
 > [!NOTE]
-> Currently, this plugin is not truly ORM-agnostic; to fully benefit from it, ActiveRecord is required.
+> Currently, this plugin is not truly agnostic; to fully benefit from it, ActiveRecord with PostgreSQL is required.
 
 ## Installation
 
@@ -87,6 +66,28 @@ I, [2024-01-31T17:11:16.344503 #3739]  INFO -- : Running: result
 => 1
 ```
 
+### 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]  ERROR -- : uninitialized constant Usert
+I, [2024-01-13T20:00:16.281237 #694]  INFO -- : Running: User.last
+=> #<User id: 1, email: "yo@email.com">
+```
+
 ### NoMethodError - undefined method
 
 This error occurs when you mispelled a method 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 method.
@@ -108,26 +109,32 @@ I, [2024-01-31T17:11:16.344503 #3739]  INFO -- : Running: User.last
 => #<User id: 1, email: "yo@email.com">
 ```
 
-### NameError - uninitialized constant
+### UndefinedColumn
 
-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.
+This error occurs when you mispelled a column 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 column.
 
 ##### Before
 
 ```ruby
-[2] pry(main)> Usert.last
-NameError: uninitialized constant Usert
-from (pry):2:in `__pry__'
-[3] pry(main)>
+[2] pry(main)> User.find_by(emil: "yo@email.com")
+E, [2024-03-31T00:14:12.907708 #11761] ERROR -- : PG::UndefinedColumn: ERROR:  column users.emil does not exist
+LINE 1: ...OM "users" WHERE "users"."deleted_at" IS NULL AND "users"."e...
+                                                             ^
+HINT:  Perhaps you meant to reference the column "users.email".
 ```
 
 ##### After
 
 ```ruby
-[1] pry(main)> Usert.last
-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">
+[1] pry(main)> User.find_by(emil: "yo@email.com")
+E, [2024-03-31T00:14:12.907708 #11761] ERROR -- : PG::UndefinedColumn: ERROR:  column users.emil does not exist
+LINE 1: ...OM "users" WHERE "users"."deleted_at" IS NULL AND "users"."e...
+                                                             ^
+HINT:  Perhaps you meant to reference the column "users.email".
+
+I, [2024-03-31T00:14:12.908257 #11761]  INFO -- : Running: User.find_by(email: "yo@email.com")
+2024-03-31 00:14:12.915906 D [11761:9180 log_subscriber.rb:130] ActiveRecord::Base --   User Load (1.0ms)  SELECT "users".* FROM "users" WHERE "users"."deleted_at" IS NULL AND "users"."email" = $1 LIMIT $2  [["email", "yo@email.com"], ["LIMIT", 1]]
+=> #<User id: 1, email: "yo@email.com", ...>
 ```
 
 ### ActiveRecord::ConfigurationError

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

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

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "../../exceptions_base"
+require_relative "../../../constants/errors"
+require_relative "undefined_table"
+require_relative "undefined_column"
+
+module Exceptions
+  module ActiveRecord
+    module StatementInvalid
+      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::UNDEFINED_TABLE}/
+            UndefinedTable.call(output, exception, pry)
+          in /#{Constants::Errors::UNDEFINED_COLUMN}/
+            UndefinedColumn.call(output, exception, pry)
+          else
+            Pry::ExceptionHandler.handle_exception(output, exception, pry)
+          end
+        end
+        # rubocop:enable Performance/ConstantRegexp
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+
+module Exceptions
+  module ActiveRecord
+    module StatementInvalid
+      class UndefinedColumn < Base
+        private
+
+        def can_correct?
+          corrected_word.present?
+        end
+
+        def unknown_from_exception
+          exception.to_s.match(exception_regexp)[1]
+        end
+
+        def corrected_word
+          match = exception.to_s.match(hint_regexp)
+          return if match.nil?
+
+          match[1].split(".").last
+        end
+
+        # The not found column name
+        def exception_regexp
+          /column \w+\.(\w+)\s/
+        end
+
+        # The hint generated by PG
+        def hint_regexp
+          /"(\w+\.\w+)"/
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -8,7 +8,7 @@ class ExceptionsBase < Base
   include Setup::Store
 
   def call
-    if corrected_word
+    if can_correct?
       logger.error("\e[1;31m#{exception}\e[0m")
       logger.info("\e[1;32mRunning: #{corrected_cmd}\e[0m")
 
@@ -28,6 +28,14 @@ class ExceptionsBase < Base
     @pry = pry
   end
 
+  def can_correct?
+    error_from_typo? && dictionary && corrected_word
+  end
+
+  def error_from_typo?
+    last_cmd.include?(unknown_from_exception)
+  end
+
   def corrected_word
     @corrected_word ||= spell_checker.correct(unknown_from_exception).first
   end

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

@@ -15,7 +15,7 @@ module Exceptions
     end
 
     def dictionary
-      eval(klass).methods.map(&:to_s) # rubocop:disable Security/Eval
+      eval(infer_klass).methods.map(&:to_s) # rubocop:disable Security/Eval
     end
 
     def exception_regexp
@@ -23,7 +23,17 @@ module Exceptions
     end
 
     def klass
-      exception.to_s.match(/for\s+(.*?):\w*$/)[1]
+      exception_without_class_module = exception.to_s.gsub(":Class", "")
+      exception_without_class_module.split.last
+    end
+
+    # [].methods and Array.methods have a different output.
+    # Array class is a part of the Ruby core library while `[]` is an instance of the Array class.
+    # When calling [].methods, we inspect the methods available to instances of the Array class, including those inherited from its class and ancestors.
+    def infer_klass
+      return klass if klass != "Array"
+
+      "[]"
     end
   end
 end

data/lib/pry-byetypo/exceptions_handler.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "base"
-require_relative "exceptions/active_record/statement_invalid"
+require_relative "exceptions/active_record/statement_invalid/handler"
 require_relative "exceptions/active_record/configuration_error"
 require_relative "exceptions/name_error/handler"
 require_relative "exceptions/no_method_error"
@@ -24,10 +24,7 @@ class ExceptionsHandler < Base
       # NameError is a Superclass for all undefined statement.
       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 exception.message.include?(Constants::Errors::UNDEFINED_TABLE)
-      Exceptions::ActiveRecord::StatementInvalid.call(output, exception, pry)
+      Exceptions::ActiveRecord::StatementInvalid::Handler.call(output, exception, pry)
     in ActiveRecord::ConfigurationError
       Exceptions::ActiveRecord::ConfigurationError.call(output, exception, pry)
     else

data/lib/pry-byetypo/version.rb

@@ -2,6 +2,6 @@
 
 class Pry
   module Byetypo
-    VERSION = "1.3.1"
+    VERSION = "1.3.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-byetypo
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Clément Morisset
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-02 00:00:00.000000000 Z
+date: 2024-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,7 +66,9 @@ files:
 - 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/active_record/statement_invalid/handler.rb
+- lib/pry-byetypo/exceptions/active_record/statement_invalid/undefined_column.rb
+- lib/pry-byetypo/exceptions/active_record/statement_invalid/undefined_table.rb
 - lib/pry-byetypo/exceptions/active_record/uninitialized_constant.rb
 - lib/pry-byetypo/exceptions/exceptions_base.rb
 - lib/pry-byetypo/exceptions/name_error/handler.rb
@@ -106,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Autocorrects typos in your Pry console

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

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