pry-byetypo 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffd46e3838ed0c8d43e5aa5c3fc5a38c518d90a4dbefcbba09f1629fffe72260
-  data.tar.gz: cef94f7e070bc541cedc9f2a547a9dc2901b8bf2ca96b4cfda09f5ffef890381
+  metadata.gz: dd76efc826578597fe9cecb0ec6357a275d8cb8c37aaa1e238681f0235287027
+  data.tar.gz: 11eeb72895ab4150815e61f932a7aa8d13dc2ae6d6b3564c81d3ff9624c8ec89
 SHA512:
-  metadata.gz: 61e7d2eb327d7a3905eb882288260484d42497bfe895a98a72bbccf562d9905ede28becb9b9c2da9e71c537967f8621299d364b97f442869d98f551a4b5073a4
-  data.tar.gz: 86252b1586e787a3f3e3ac6a66c13034640eba983a2d0d8a8be95f239906fef4611f9c00fcf17c675030b03ab512605dc1e87436ef9eaea7d261675a2cc03845
+  metadata.gz: 9f55811aaaeeeb06521f50108d8fab819b00c461b2fd635519ad3559baf409ee256e241d5315a39ec2e238aaae6e330f2d84bcd0cfbc1b3b9f04e9b26d8b9d39
+  data.tar.gz: 954ecd0a20d6fb34df1592cf36f8c2dd5d893d21f0060a7ccba7a4769ead0800917d6ee08aa8c294b8937e8eaa450c77fe7ac3704f4da3e2ea4466257e306552

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    pry-byetypo (1.1.0)
+    pry-byetypo (1.2.0)
       colorize (~> 1.1.0)
       pry (>= 0.13, < 0.15)
-      rails (~> 7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -146,7 +145,7 @@ GEM
     psych (5.1.2)
       stringio
     racc (1.7.3)
-    rack (3.0.8)
+    rack (3.0.9)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -253,6 +252,7 @@ PLATFORMS
 DEPENDENCIES
   byebug
   pry-byetypo!
+  rails (~> 7.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   standard (~> 1.3)

data/README.md

@@ -1,4 +1,4 @@
-# PRY-BYETYPO
+# PRY-BYETYPO 👋
 
 Autocorrects typos in your Pry console.
 
@@ -26,7 +26,7 @@ I, [2024-01-31T17:11:16.344503 #3739]  INFO -- : Running: result
 ```
 
 > [!NOTE]
-> So far, this plugin is not framework agnostic, and it requires Rails 7 or later.
+> Currently, this plugin is not truly ORM-agnostic; to fully benefit from it, ActiveRecord is required.
 
 ## Installation
 

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

@@ -7,10 +7,6 @@ module Exceptions
     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
@@ -19,8 +15,8 @@ module Exceptions
         exception.to_s.match(exception_regexp)[1]
       end
 
-      def associations_dictionary
-        @associations_dictionary ||= store.transaction { |s| s["associations"] }
+      def dictionary
+        store.transaction { |s| s["associations"] }
       end
     end
   end

data/lib/pry-byetypo/exceptions/{name_error → active_record}/uninitialized_constant.rb

@@ -1,25 +1,21 @@
 # frozen_string_literal: true
 
-require_relative "../exceptions_base"
+require_relative "base"
 
 module Exceptions
-  module NameError
-    class UninitializedConstant < ExceptionsBase
+  module ActiveRecord
+    class UninitializedConstant < Base
       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
+      def dictionary
         @ar_models_dictionary ||= store.transaction { |s| s["active_record_models"] }
       end
     end

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

@@ -29,7 +29,11 @@ class ExceptionsBase < Base
     @pry = pry
   end
 
-  def spell_checker(dictionary)
+  def corrected_word
+    @corrected_word ||= spell_checker.correct(unknown_from_exception).first
+  end
+
+  def spell_checker
     DidYouMean::SpellChecker.new(dictionary: dictionary)
   end
 

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

@@ -2,7 +2,7 @@
 
 require_relative "../exceptions_base"
 require_relative "../../constants/errors"
-require_relative "uninitialized_constant"
+require_relative "../active_record/uninitialized_constant"
 require_relative "undefined_variable"
 
 module Exceptions
@@ -21,7 +21,7 @@ module Exceptions
       def call
         case exception.message
         in /#{Constants::Errors::UNINITIALIZED_CONSTANT}/
-          UninitializedConstant.call(output, exception, pry)
+          ActiveRecord::UninitializedConstant.call(output, exception, pry)
         in /#{Constants::Errors::UNDEFINED_VARIABLE}/
           UndefinedVariable.call(output, exception, pry)
         else

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

@@ -7,10 +7,6 @@ module Exceptions
     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
@@ -19,8 +15,8 @@ module Exceptions
         exception.to_s.match(exception_regexp)[1]
       end
 
-      def session_dictionary
-        @session_dictionary ||= store.transaction { |s| s[pry_instance_uid] }
+      def dictionary
+        store.transaction { |s| s[pry_instance_uid] }
       end
 
       def exception_regexp

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

@@ -14,10 +14,12 @@ module Session
     end
 
     def call
+      return unless is_assignement_variables?
+
       store.transaction do
-        store.abort unless extract_variable_to_store
+        store.abort unless variables_to_store
 
-        store[pry_instance_uid].push(variable_to_store)
+        store[pry_instance_uid].push(*variables_to_store)
       end
     end
 
@@ -28,16 +30,28 @@ module Session
       binding.binding_stack.join
     end
 
-    def extract_variable_to_store
-      @extract_variable_to_store ||= last_cmd.match(/^(\w+)\s*=/)
+    def variables_to_store
+      @variables_to_store ||= last_cmd.split("=").first.strip.split(",")
     end
 
     def last_cmd
       binding.eval_string.strip
     end
 
-    def variable_to_store
-      extract_variable_to_store[1]
+    # Returns true if the last command seems to be an assignment of variables, false otherwise.
+    #
+    # Examples
+    #
+    #   is_assignment_variables?("user_last, user_first = User.last, User.first")
+    #   # => true
+    #
+    #   is_assignment_variables?("user_last = User.last")
+    #   # => true
+    #
+    #   is_assignment_variables?("user_last")
+    #   # => false
+    def is_assignement_variables?
+      last_cmd.include?("=")
     end
   end
 end

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

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "checks/database_url"
-require_relative "checks/database_pool"
-require_relative "store"
 require_relative "../base"
-
+require_relative "store"
+require_relative "dictionary/active_record"
 require "pstore"
 
 module Setup
@@ -16,7 +14,7 @@ module Setup
     end
 
     def call
-      establish_db_connection
+      Setup::Dictionary::ActiveRecord.initialize! if defined?(ActiveRecord)
       populate_store
     end
 
@@ -24,64 +22,14 @@ module Setup
 
     attr_reader :binding
 
-    SEVEN_DAYS = 604800
-
     def populate_store
-      store.transaction do
-        # 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
-        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
+      # Create a table with unique instance identifier information to store variables history.
+      store.transaction { store[pry_instance_uid] = [] }
     end
 
     # Use the binding identifier as pry instance uid.
     def pry_instance_uid
       binding.to_s
     end
-
-    def logger
-      @logger = Logger.new($stdout)
-    end
   end
 end

data/lib/pry-byetypo/setup/dictionary/active_record.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "../checks/database_url"
+require_relative "../checks/database_pool"
+require_relative "../store"
+
+require "pstore"
+
+module Setup
+  module Dictionary
+    class ActiveRecord
+      class << self
+        include Store
+
+        def initialize!
+          establish_db_connection
+          populate_store
+        end
+
+        private
+
+        def populate_store
+          store.transaction do
+            store.commit 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| format_active_record_model(model) }.flatten
+        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
+
+        # This method takes an ActiveRecord model as an argument and formats its name and module information.
+        # If the model is within a module namespace, it returns an array containing the model's name and an array of its modules.
+        # If the model is not within a module, it returns just the model's name as a string.
+        def format_active_record_model(model)
+          modules = model.name.split("::")
+          return model.name, modules if modules.count > 1
+
+          model.name
+        end
+
+        def development_database_config
+          @development_database_config ||= database_config["development"]
+        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(database_config_path), aliases: true)
+        end
+
+        def logger
+          @logger = Logger.new($stdout)
+        end
+
+        def database_config_path
+          ENV["DB_CONFIG_PATH"] || "./config/database.yml"
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 module Setup
   module Store
     DEFAULT_STORE_PATH = "byetypo_dictionary.pstore"
+    SEVEN_DAYS = 604800
 
     def store
       @store ||= PStore.new(store_path)
@@ -9,5 +10,13 @@ module Setup
     def store_path
       ENV["BYETYPO_STORE_PATH"] || DEFAULT_STORE_PATH
     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
   end
 end

data/lib/pry-byetypo/version.rb

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

data/pry-byetypo.gemspec

@@ -5,14 +5,14 @@ require_relative "lib/pry-byetypo/version"
 Gem::Specification.new do |gem|
   gem.name = "pry-byetypo"
   gem.version = Pry::Byetypo::VERSION
-  gem.authors = ["morissetcl"]
+  gem.authors = ["Clément Morisset"]
   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.description = "This 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.required_ruby_version = ">= 2.7.0"
 
   gem.metadata["homepage_uri"] = gem.homepage
   gem.metadata["source_code_uri"] = "https://github.com/morissetcl/pry-byetypo"
@@ -28,7 +28,7 @@ Gem::Specification.new do |gem|
   gem.bindir = "exe"
   gem.executables = gem.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   gem.require_paths = ["lib"]
+  gem.add_development_dependency "rails", "~> 7.0"
   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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pry-byetypo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
-- morissetcl
+- Clément Morisset
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -44,22 +58,8 @@ dependencies:
     - - "<"
       - !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.
+description: This 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: []
@@ -81,10 +81,10 @@ files:
 - 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/uninitialized_constant.rb
 - lib/pry-byetypo/exceptions/exceptions_base.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
@@ -92,6 +92,7 @@ files:
 - 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/dictionary/active_record.rb
 - lib/pry-byetypo/setup/store.rb
 - lib/pry-byetypo/version.rb
 - pry-byetypo.gemspec
@@ -111,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="