mentor 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d61b738e627b884222d11ae5e7e01b717a4b473
-  data.tar.gz: 30b3b83534080ed8a0da9eb9d32ba11dde4c6b01
+  metadata.gz: 5a40f1afb1c3314adb1e36dcbee0fc5c2f77a40f
+  data.tar.gz: e4e66cb1e08473200b9d56cff9dab28b2b60fe83
 SHA512:
-  metadata.gz: 974dea0e3cf08d028480c1e4925df058fee38583c7a115d7a83d39bc8b09e6467f8371d47110913f5ed9c5c8655ba8666b84561b86ecabd86625b7756f9fa2a0
-  data.tar.gz: 8b8e7aa5f94c8c3b186c05d5bcc7f5013623b16dd2d6754e059d340197e4134861501729e9b0c5a197aacbffd5342bc6e0d6afc812209488c2252ed685c5ba88
+  metadata.gz: 861f06ddef0003bc3daa96b8da8fc8736eb74a79779c03c34b5d3f31339a5220998fb288d4d951ad9599e87d10caad965278a43f0333f7d30c800e73b8e55df6
+  data.tar.gz: fcba8b0493d472f9556b6f977b24409fe5a6054da1aeff62434e8de832faeb8e6363b38f611cb9f7fe6ce00ba2bfb20a8da1d04eba9339e72bb611c50cacc699

data/lib/development.rb

@@ -0,0 +1,7 @@
+require 'warning'
+Warning.ignore(/gems\/rouge/)
+Warning.ignore(/gems\/awesome_print/)
+Warning.ignore(/instance variable @lines_from_file not initialized/)
+Warning.ignore(/previous definition of output_value was here/)
+Warning.ignore(/irb\/ext\/save-history/)
+Warning.ignore(/irb\/extend-command/)

data/lib/errors/mentor_error.rb

@@ -20,10 +20,10 @@ module Mentor
       end
     end
 
-    private_class_method
-
     def self.error_classes
       [
+        NoMethodDidYouMeanStringLiteralError,
+        NoMethodDidYouMeanNumericLiteralError,
         NoMethodDidYouMeanSuggestionError,
         NoMethodForNilClassForCommonClassError,
         NoMethodForNilClassError,

data/lib/errors/no_method_did_you_mean_numeric_literal.rb

@@ -0,0 +1,38 @@
+module Mentor
+
+  class NoMethodDidYouMeanNumericLiteralError < MentorNoMethodError
+
+    def self.can_handle?
+      super &&
+        Mentor.tp.raised_exception.respond_to?(:corrections) &&
+        Mentor.tp.raised_exception.corrections.any? &&
+        var_for_method.empty? &&
+        [Integer, Float].include?(Mentor.tp.raised_exception.receiver.class)
+    end
+
+    def sections
+      [
+        Header.new,
+        RubyErrorComplete.new,
+        RelativePath.new,
+        LinesOfCode.new,
+        ErrorClassSpecificHelp.new(error_class_specific_help),
+        Suggestion.new("Try changing the method #{method_name} to #{did_you_mean_word} on your #{literal_class}.")
+      ]
+    end
+
+    private
+
+    def error_class_specific_help
+      [
+        "#{literal_for_method} is #{a_an(literal_class)} #{literal_class}.",
+        '',
+        "#{pluralize(literal_class)} do not have the method #{method_name}.",
+        '',
+        'You may have made a typo.'
+      ]
+    end
+
+  end
+
+end

data/lib/errors/no_method_did_you_mean_string_literal.rb

@@ -0,0 +1,38 @@
+module Mentor
+
+  class NoMethodDidYouMeanStringLiteralError < MentorNoMethodError
+
+    def self.can_handle?
+      super &&
+        Mentor.tp.raised_exception.respond_to?(:corrections) &&
+        Mentor.tp.raised_exception.corrections.any? &&
+        var_for_method.empty? &&
+        Mentor.tp.raised_exception.receiver.is_a?(String)
+    end
+
+    def sections
+      [
+        Header.new,
+        RubyErrorComplete.new,
+        RelativePath.new,
+        LinesOfCode.new,
+        ErrorClassSpecificHelp.new(error_class_specific_help),
+        Suggestion.new("Try changing the method #{method_name} to #{did_you_mean_word} on your #{literal_class}.")
+      ]
+    end
+
+    private
+
+    def error_class_specific_help
+      [
+        "#{quoted_literal_for_method} is #{a_an(literal_class)} #{literal_class}.",
+        '',
+        "#{pluralize(literal_class)} do not have the method #{method_name}.",
+        '',
+        'You may have made a typo.'
+      ]
+    end
+
+  end
+
+end

data/lib/errors/no_method_for_nil_class_for_common_class_error.rb

@@ -47,7 +47,6 @@ module Mentor
       end
     end
 
-    private_class_method
 
     @@string_methods  = String.new.methods
     @@integer_methods = 1.methods
@@ -69,6 +68,8 @@ module Mentor
       common_classes.map { |klass, attrs| attrs[:methods] }.flatten - Object.methods
     end
 
+    private_class_method :common_methods
+
   end
 
 end

data/lib/helpers/colorize.rb

@@ -31,24 +31,32 @@ module Mentor
 
     def output_types
       %i[
-        did_you_mean_text  did_you_mean_word
-        message            horizontal_line    ruby_error_text
-        calling_method     method_name        var_for_method
-        absolute_base_dir  relative_base_dir  app_dir        file_name
+        did_you_mean_text   did_you_mean_word
+        message             horizontal_line            ruby_error_text
+        calling_method      method_name                var_for_method
+        absolute_base_dir   relative_base_dir          app_dir  file_name
       ]
     end
 
     def apply_colors(line)
+      line = apply_literal_for_method(line) if did_you_mean_with_literal_error?
       line = apply_pattern_colors(line)
       line = apply_output_colors(line)
       line = apply_nil_colors(line)
       line = apply_common_classes_colors(line)
     end
 
+    def apply_literal_for_method(line)
+      line = TextToColor.new(line, literal_for_method, :literal_for_method, "#{literal_for_method} is a").color_pattern
+      line = TextToColor.new(line, literal_for_method, :literal_for_method, "for #{literal_for_method}:").color_pattern
+      line = TextToColor.new(line, literal_for_method, :literal_for_method, %Q{"#{literal_for_method}"}).color_pattern
+      line = TextToColor.new(line, literal_for_method, :literal_for_method, "'#{literal_for_method}'").color_pattern
+    end
+
     def apply_pattern_colors(line)
-      line = TextToColor.new(line, error_lineno,     :error_lineno,     "#{file_name}:#{error_lineno}").color_pattern
-      line = TextToColor.new(line, ruby_error_class, :ruby_error_class, "(#{ruby_error_class})").color_pattern
-      line = TextToColor.new(line, ruby_error_class, :ruby_error_class, " #{ruby_error_class} ").color_pattern
+      line = TextToColor.new(line, error_lineno,       :error_lineno,       "#{file_name}:#{error_lineno}").color_pattern
+      line = TextToColor.new(line, ruby_error_class,   :ruby_error_class,   "(#{ruby_error_class})").color_pattern
+      line = TextToColor.new(line, ruby_error_class,   :ruby_error_class,   " #{ruby_error_class} ").color_pattern
     end
 
     def apply_output_colors(line)
@@ -76,9 +84,13 @@ module Mentor
     end
 
     def color_code(code)
-      formatter = Rouge::Formatters::Terminal256.new
-      lexer     = Rouge::Lexers::Ruby.new
-      formatter.format(lexer.lex(code))
+      if did_you_mean_with_literal_error?
+        TextToColor.new(code, literal_for_method, :literal_for_method).colored
+      else
+        formatter = Rouge::Formatters::Terminal256.new
+        lexer     = Rouge::Lexers::Ruby.new
+        formatter.format(lexer.lex(code))
+      end
     end
 
     def color_padded_lineno(padded_lineno)
@@ -99,6 +111,12 @@ module Mentor
       Rainbow(str).color(colors[output_type])
     end
 
+    def did_you_mean_with_literal_error?
+      Mentor.tp.raised_exception.respond_to?(:corrections) &&
+      Mentor.tp.raised_exception.corrections.any? &&
+      [String, Integer, Float].include?(Mentor.tp.raised_exception.receiver.class)
+    end
+
     def colors
       error        = :tomato
       error_lineno = :gold
@@ -106,32 +124,35 @@ module Mentor
       subtle       = :olive
       very_subtle  = :dimgray
       nil_text     = :orange
+      literal      = :mediumpurple
 
       {
-        app_dir:               subtle,
-        backtrace_line:        very_subtle,
-        absolute_base_dir:     subtle,
-        relative_base_dir:     subtle,
-        calling_method:        :green,
-        common_class:          :wheat,
-        did_you_mean_text:     :royalblue,
-        did_you_mean_word:     method_name,
-        error_lineno:          error_lineno,
-        error_lineno_padded:   error_lineno,
-        file_name:             :greenyellow,
-        horizontal_line:       :red,
-        lineno_subtle_padded:  subtle,
-        message:               error,
-        method_class:          :mediumpurple,
-        method_name:           method_name,
-        nil_text:              nil_text,
-        other_class_or_module: :darksalmon,
-        prominent:             :ivory,
-        ruby_error_class:      :orangered,
-        ruby_error_text:       error,
-        subtle:                subtle,
-        suggestion:            :lightgreen,
-        var_for_method:        :palevioletred
+        app_dir:                   subtle,
+        backtrace_line:            very_subtle,
+        absolute_base_dir:         subtle,
+        relative_base_dir:         subtle,
+        calling_method:            :green,
+        common_class:              :cornflower,
+        did_you_mean_text:         :royalblue,
+        did_you_mean_word:         method_name,
+        error_lineno:              error_lineno,
+        error_lineno_padded:       error_lineno,
+        file_name:                 :greenyellow,
+        horizontal_line:           :red,
+        lineno_subtle_padded:      subtle,
+        message:                   error,
+        method_class:              :mediumpurple,
+        method_name:               method_name,
+        nil_text:                  nil_text,
+        other_class_or_module:     :darksalmon,
+        prominent:                 :ivory,
+        ruby_error_class:          :orangered,
+        literal_for_method:        literal,
+        quoted_literal_for_method: literal,
+        ruby_error_text:           error,
+        subtle:                    subtle,
+        suggestion:                :lightgreen,
+        var_for_method:            :palevioletred
       }
     end
 

data/lib/helpers/output_helper.rb

@@ -6,8 +6,12 @@ module Mentor
       %w(A E I O U).include?(word[0]) ? 'an' : 'a'
     end
 
+    def culprit_line
+      lines_from_file[tp.lineno]
+    end
+
     def pluralize(word)
-      word.to_s + (word.to_s == 'Hash' ? 'es' :'s')
+      word.to_s + (word.to_s == 'Hash' ? 'es' : 's')
     end
 
     def pluralize_words(words)

data/lib/helpers/outputs.rb

@@ -83,6 +83,19 @@ module Mentor
       @lineno.to_s.rjust(width)
     end
 
+    def literal_class
+      tp.raised_exception.receiver.class.to_s
+    end
+
+    def literal_for_method
+      tp.raised_exception.receiver.to_s
+    end
+
+    def quoted_literal_for_method
+      quote = culprit_line[culprit_line.index(tp.raised_exception.receiver) - 1]
+      quote + tp.raised_exception.receiver + quote
+    end
+
     def message
       if raised_exception.respond_to? :original_message
         raised_exception.original_message
@@ -112,7 +125,6 @@ module Mentor
     end
 
     def var_for_method
-      culprit_line = lines_from_file[tp.lineno]
       var = culprit_line[/#{valid_var_name}\.#{method_name}/].to_s.chomp(".#{method_name}")
       if var.empty?
         culprit_line[/#{valid_var_name} method_name/].to_s.chomp(".#{method_name}")

data/lib/helpers/requires.rb

@@ -1,5 +1,7 @@
 module Mentor
 
+  require_relative '../development' if ENV['MENTOR'] == 'development'
+
   dir = __dir__ + '/../..'
 
   gems = %w[pry rainbow rouge]

data/lib/mentor/version.rb

@@ -1,3 +1,3 @@
 module Mentor
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/mentor.rb

@@ -9,8 +9,6 @@ module Mentor
       Mentor.enable
     end
 
-    private_class_method
-
     def self.setup_trace_point
 
       TracePoint.trace(:raise) do |tp|
@@ -28,6 +26,8 @@ module Mentor
 
     end
 
+    private_class_method :setup_trace_point
+
   end
 
 end

data/mentor.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.executables << 'mentor'
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'pry',           '~> 0.10'
-  spec.add_dependency 'rainbow',       '~> 2.2'
-  spec.add_dependency 'rouge',         '~> 2.0'
+  spec.add_dependency 'pry',     '~> 0.10'
+  spec.add_dependency 'rainbow', '~> 2.2'
+  spec.add_dependency 'rouge',   '~> 2.0'
 
   spec.add_development_dependency 'bundler',        '~> 1.13'
   spec.add_development_dependency 'did_you_mean',   '~> 1.1'
@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-minitest', '~> 2.4'
   spec.add_development_dependency 'minitest',       '~> 5.0'
   spec.add_development_dependency 'rake',           '~> 10.0'
+  spec.add_development_dependency 'warning',        '~> 0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mentor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sean Lerner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-26 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: warning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: 
 email:
 - sean@smallcity.ca
@@ -151,8 +165,11 @@ files:
 - README.md
 - Rakefile
 - bin/mentor
+- lib/development.rb
 - lib/errors/mentor_error.rb
 - lib/errors/mentor_no_method_error.rb
+- lib/errors/no_method_did_you_mean_numeric_literal.rb
+- lib/errors/no_method_did_you_mean_string_literal.rb
 - lib/errors/no_method_did_you_mean_suggestion_error.rb
 - lib/errors/no_method_for_nil_class_error.rb
 - lib/errors/no_method_for_nil_class_for_common_class_error.rb