i_did_mean 1.0.0

data/i_did_mean.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "i_did_mean/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "i_did_mean"
+  spec.version       = IDidMean::VERSION
+  spec.authors       = ["Hrvoje Simic"]
+  spec.email         = ["shime@twobucks.co"]
+  spec.summary       = %(Did you mean? Yes I did! Autofix your typos!)
+  spec.description   = %(Autofix your typos, by leveraging DidYouMean suggestions.)
+  spec.homepage      = "https://github.com/shime/i_did_mean"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-focus"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-minitest"
+end

data/lib/i_did_mean.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "English"
+
+module IDidMean
+  def self.call(error)
+    processor = Processor.new(error)
+    processor.call
+  end
+end
+
+at_exit do
+  IDidMean.call($ERROR_INFO) if $ERROR_INFO
+end
+
+require "i_did_mean/error"
+require "i_did_mean/processor"
+require "i_did_mean/formatter"
+
+if defined?(::Rails)
+  require "i_did_mean/rails/middleware"
+  require "i_did_mean/railtie"
+end

data/lib/i_did_mean/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module IDidMean
+  class Error < StandardError; end
+  class UnableToReplaceLineError < Error; end
+end

data/lib/i_did_mean/formatter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module IDidMean
+  class Formatter
+    def message_for(corrections)
+      "\nYou probably meant '#{corrections.first}', autofixing that."
+    end
+  end
+end

data/lib/i_did_mean/processor.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module IDidMean
+  class Processor
+    def initialize(error)
+      @error = error
+
+      return if backtrace.empty?
+
+      @file, @number = backtrace.first.split(":").first(2)
+
+      save_original_formatter
+    end
+
+    def call
+      if should_process?
+        replace_line(number)
+        replace_formatter
+      else
+        restore_original_formatter
+      end
+    end
+
+    def should_process?
+      # Only process this error if:
+      #   * error is present (**surprise, surprise**)
+      #   * error was corrected (did_you_mean has done its magic)
+      error&.respond_to?(:corrections) &&
+        # * there is only one correction, so we can be certain to replace
+        error.corrections.length == 1 &&
+        # * this is not some internal backtrace (considering Rails here)
+        backtrace.first
+    end
+
+    private
+
+    attr_reader :error
+    attr_reader :file
+    attr_reader :number
+    attr_reader :original_formatter
+
+    # Extracts method name from error message.
+    # Example:
+    #
+    #   For this error message:
+    #
+    #     NameError: undefined local variable or method `foo' for #<Object:0x00007fab0c28a0f0>
+    #
+    #   It should return "foo".
+    #
+    def original_method_name
+      case error
+      when NameError
+        error.name
+      when KeyError
+        error.key
+      end
+    end
+
+    def corrected_method_name
+      error.corrections
+           .first
+           .to_s
+           .gsub(/\A:/, "")
+           .gsub(/"/, "")
+    end
+
+    def file_path
+      @file_path ||= File.expand_path(file)
+    end
+
+    def lines
+      @lines ||= IO.readlines(file_path)
+    end
+
+    # Used for cleaning backtrace.
+    # We're only interested in application backtrace.
+    # This is Rails related.
+    def backtrace
+      backtrace = error.backtrace
+      backtrace = ::Rails.backtrace_cleaner.clean(backtrace) if defined?(::Rails)
+      backtrace
+    end
+
+    def replace_line(number)
+      lines[number.to_i - 1][original_method_name.to_s] = corrected_method_name
+      IO.write(file_path, lines.join)
+    end
+
+    def replace_formatter
+      DidYouMean.formatter = Formatter.new
+    end
+
+    def restore_original_formatter
+      DidYouMean.formatter = original_formatter
+    end
+
+    def save_original_formatter
+      self.original_formatter = DidYouMean.formatter
+    end
+
+    def original_formatter=(formatter)
+      @original_formatter ||= formatter
+    end
+  end
+end

data/lib/i_did_mean/rails/middleware.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module IDidMean
+  module Rails
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        begin
+          response = @app.call(env)
+        rescue StandardError => e
+          processor = IDidMean::Processor.new(e)
+
+          raise unless processor.should_process?
+
+          response = handle_exception(processor, env)
+        end
+
+        response
+      end
+
+      private
+
+      def handle_exception(processor, env)
+        processor.call
+
+        ActiveSupport::DescendantsTracker.clear
+        ActiveSupport::Dependencies.clear
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/i_did_mean/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module IDidMean
+  class Railtie < ::Rails::Railtie
+    initializer("i_did_mean.middleware") do |app|
+      app.config.middleware.insert_after(
+        ActionDispatch::DebugExceptions,
+        IDidMean::Rails::Middleware
+      )
+    end
+  end
+end

data/lib/i_did_mean/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IDidMean
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: i_did_mean
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hrvoje Simic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Autofix your typos, by leveraging DidYouMean suggestions.
+email:
+- shime@twobucks.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.0.gemfile.lock
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.1.gemfile.lock
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_5.2.gemfile.lock
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.0.gemfile.lock
+- gemfiles/rails_edge.gemfile
+- gemfiles/rails_edge.gemfile.lock
+- i_did_mean.gemspec
+- lib/i_did_mean.rb
+- lib/i_did_mean/error.rb
+- lib/i_did_mean/formatter.rb
+- lib/i_did_mean/processor.rb
+- lib/i_did_mean/rails/middleware.rb
+- lib/i_did_mean/railtie.rb
+- lib/i_did_mean/version.rb
+homepage: https://github.com/shime/i_did_mean
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Did you mean? Yes I did! Autofix your typos!
+test_files: []