pry-byetypo 1.3.2 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a93b11d72346335618ba4ba38487e30b7b83c3a8460b11ad08987b903a5349
-  data.tar.gz: 3014b3bfda0207d5fecb14b0ba1dd421404e383b8ddcc3077bd5912f59063f60
+  metadata.gz: ed71926ad9667df2634d402ea3a0e38d90ceff651a9f5b2edb0347bebe838d07
+  data.tar.gz: 82307bfd3c93fac14f66cb1fc128f3a12919814ca4ef428deb90baf0a69540e8
 SHA512:
-  metadata.gz: 7b5c2b5b46aad5f54b6b7a84738eeba57f51e4e799150e9c197cb4ebb6e413ca5498635555b777b58dccad44f88195d968f0cc3d87400b2581c687cd1ccc4fc6
-  data.tar.gz: e7cbd3b2c198c11e4cdc91eb5ce057aea760e83292e116ba0bb6a50c737b84a9f811503ce4f84ee210f698008d661d7f372fb5b9302e79c02513a0e1264d8ecf
+  metadata.gz: 73f5da8a471e861ac2bb7489ae22ba43c7d1c67d757404cb1b7b422298894d6c797fb269b982c7661b1e4f3e1e2495b4f0ef2e678593d425bfdea58ea3f52573
+  data.tar.gz: 43233f889ac57d2ef94c67db75821656a76574be8d9e39b192157fae8aa993275df2ebdd69b40f275369a65f980705fa9ae0a8e917132cb91e5dfb3318a7c9ab

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pry-byetypo (1.3.2)
+    pry-byetypo (1.3.4)
       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/no_method_error.rb

@@ -15,7 +15,12 @@ module Exceptions
     end
 
     def dictionary
-      eval(infer_klass).methods.map(&:to_s) # rubocop:disable Security/Eval
+      klass_methods = eval(infer_klass).methods # rubocop:disable Security/Eval
+      # Early return because built_in class does not have access to `instance_methods`.
+      return klass_methods.map(&:to_s) if built_in_klass
+
+      instance_methods = eval(infer_klass).instance_methods(false) # rubocop:disable Security/Eval
+      instance_methods.push(klass_methods).flatten.map(&:to_s)
     end
 
     def exception_regexp
@@ -35,5 +40,9 @@ module Exceptions
 
       "[]"
     end
+
+    def built_in_klass
+      infer_klass == "[]"
+    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/setup/dictionary/active_record.rb

@@ -65,7 +65,8 @@ module Setup
         end
 
         def database_config
-          YAML.safe_load(File.read(database_config_path), aliases: true)
+          erb_content = ERB.new(File.read(database_config_path)).result
+          YAML.safe_load(erb_content, aliases: true)
         end
 
         def logger

data/lib/pry-byetypo/version.rb

@@ -2,6 +2,6 @@
 
 class Pry
   module Byetypo
-    VERSION = "1.3.2"
+    VERSION = "1.3.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-byetypo
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.4
 platform: ruby
 authors:
 - Clément Morisset
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 2024-09-06 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.19
+rubygems_version: 3.4.22
 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