rubocop-definition_validator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6460fb37d146570cda2e89042dabd2e660c8279b
-  data.tar.gz: ebb16294fb3331fe3f69afe261505aa968aaa77f
+  metadata.gz: e64054dd1e26a1402b8b3066859dde92e333008a
+  data.tar.gz: e51cf35bcdc4e921b38e983dd9d0f6edf2b0681b
 SHA512:
-  metadata.gz: 8a623aaedbf5d4896a90b425f559bff02dde539d3c661db5b3273c394f7d7dbd8a8ab164d4adfef2607f1bf6e90881899b43bd8ff81c0e9087fc0f4bde832d25
-  data.tar.gz: 40301714be7c10e88d7a17da1d94b1e21a60b1ab35a8dcf0a738af829c37a6f5e78818d31d2c5aabbf0f2aca3884b37b09a964681a85dce55249b029b9405309
+  metadata.gz: b32c56023f9a88c3baf652dd3f76afdbbf3fe5bc49dce9d6177f9c5175e484728ed43d0f0b6770b40157b6dc4a7b3ae318d9c6a51274430909d77daefbb4b317
+  data.tar.gz: 3b73155495975c9cdb0b1dc13007d0960ad8664478cf1b327328acefcab6f204db0730dfbb154507a8e9c2b5fb9b8741f16feadc861e040d9e1ae9b50b2b97db

data/lib/rubocop/cop/lint/definition_validator.rb

@@ -9,17 +9,18 @@ module RuboCop
 
           msg = nil
           Rubocop::DefinitionValidator::ChangeDetector.changed_methods.each do |m|
-            old, new = m[:removed], m[:added]
+            old, new = m.removed, m.added
 
             next if old.name.size <= min
 
-            old_callable, _ = old.callable?(name, args)
+            PryTestcase.pry
+            old_callable, *_ = old.callable?(name, args)
             next unless old_callable
 
-            new_callable, reason = new.callable?(name, args)
+            new_callable, *reason = new.callable?(name, args)
             next if new_callable
 
-            msg = reason.respond_to?(:call) ? reason.(old, new) : reason
+            msg = Rubocop::DefinitionValidator::Message.new(m).of(*reason)
           end
 
           return unless msg

data/lib/rubocop/definition_validator.rb

@@ -9,7 +9,8 @@ RuboCop::DefinitionValidator::Inject.defaults!
 
 require 'rubocop/definition_validator/line'
 require 'rubocop/definition_validator/patch'
-require 'rubocop/definition_validator/reason'
+require 'rubocop/definition_validator/message'
+require 'rubocop/definition_validator/changed_method'
 require 'rubocop/definition_validator/method'
 require 'rubocop/definition_validator/change_detector'
 

data/lib/rubocop/definition_validator/change_detector.rb

@@ -15,17 +15,8 @@ module Rubocop::DefinitionValidator::ChangeDetector
       #   {added: Method, removed: Method}
       # ]
       @changed_methods = patches
-        .map{|patch| patch.changed_method_codes}
+        .map{|patch| patch.changed_methods}
         .flatten
-        .map{|code|
-        code.map{|k, v|
-          begin
-            [k, Rubocop::DefinitionValidator::Method.new(v.body)]
-          rescue Rubocop::DefinitionValidator::Method::InvalidAST
-            nil
-          end
-        }.compact.to_h
-      }
     end
   end
 end

data/lib/rubocop/definition_validator/changed_method.rb

@@ -0,0 +1,11 @@
+# This class has added method, removed method, line number and file name.
+class Rubocop::DefinitionValidator::ChangedMethod
+  attr_reader :added, :removed, :line, :file_name
+
+  def initialize(added_line, removed_line, lineno, fname)
+    @added = Rubocop::DefinitionValidator::Method.new(added_line.body)
+    @removed = Rubocop::DefinitionValidator::Method.new(removed_line.body)
+    @line = lineno
+    @file_name = fname
+  end
+end

data/lib/rubocop/definition_validator/message.rb

@@ -0,0 +1,65 @@
+class Rubocop::DefinitionValidator::Message
+  # @param [ChangedMethod] method
+  def initialize(method)
+    @method = method
+  end
+
+  # @param [Symbol] reason
+  def of(reason, *args)
+    __send__(reason, *args) + suffix
+  end
+
+
+  private
+
+  # @return [Proc]
+  def method_name
+    "#{@method.removed.name} is undefined. Did you mean? #{@method.added.name}"
+  end
+
+  # @param [Integer] given given args size.
+  # @param [Integer] expected expected args size.
+  # @return [Proc]
+  def not_enough_norml_arguments(given, expected)
+    n = expected - given
+    not_enough_arg_names = @method.added.normal_params.dup.pop(n).map{|x| x[1]}
+    "Not enough arguments. Did you forget the following arguments? [#{not_enough_arg_names.join(', ')}]"
+  end
+
+  # @param [Integer] given given args size.
+  # @param [Integer] expected expected args size.
+  # @return [Proc]
+  def not_enough_normal_after_rest_arguments(given, expected)
+    n = expected - given
+    not_enough_arg_names = @method.added.normal_params_after_rest.dup.pop(n).map{|x| x[1]}
+    "Not enough arguments. Did you forget the following arguments? [#{not_enough_arg_names.join(', ')}]"
+  end
+
+  def too_many_arguments
+    'Too many arguments'
+  end
+
+  def kwparam_required
+    "Keyword params is required."
+  end
+
+  # @param [String] got
+  def kwparam_should_be_hash(got)
+    "Keyword params should be a Hash. But got #{got}"
+  end
+
+  # @param [Array<String>] not_founds
+  def kwparam_not_found(not_founds)
+    "The following keyword parameters are required. But not received. [#{not_founds.join(', ')}]"
+  end
+
+  def unexpected_kwparam(unexpected)
+    "The following keyword parameters are not expected. But received. [#{unexpected.join(', ')}]"
+  end
+
+
+
+  def suffix
+    "\nThis method is defined at #{@method.file_name} L#{@method.line}"
+  end
+end

data/lib/rubocop/definition_validator/method.rb

@@ -1,6 +1,7 @@
 require 'ripper'
 
 module Rubocop::DefinitionValidator
+  # a method
   class Method
     class InvalidAST < ArgumentError; end
 
@@ -47,9 +48,9 @@ module Rubocop::DefinitionValidator
 
     # @param [Array<RuboCop::Node>] args
     # @return [Boolean] callable
-    # @return [Proc] cause
+    # @return [Object] cause
     def callable?(name, args)
-      return false, Reason.method_name unless name == @name
+      return false, :method_name unless name == @name
 
       args = args.dup
 
@@ -57,11 +58,8 @@ module Rubocop::DefinitionValidator
       normal_params_size = (normal_params || []).size
       received_normal_params_size = args.shift(normal_params_size).size
       unless received_normal_params_size == normal_params_size
-        return false, Reason.not_enough_arguments(
-          received_normal_params_size,
-          normal_params_size,
-          :normal_params,
-        )
+        return false, :not_enough_norml_arguments, received_normal_params_size, normal_params_size
+        
       end
 
       if has_required_keyword_params?
@@ -99,11 +97,7 @@ module Rubocop::DefinitionValidator
       normal_params_after_rest_size = (normal_params_after_rest || []).size
       given_normal_params_after_rest_size = args.pop(normal_params_after_rest_size).size
       unless given_normal_params_after_rest_size == normal_params_after_rest_size
-        return false, Reason.not_enough_arguments(
-          given_normal_params_after_rest_size,
-          normal_params_after_rest_size,
-          :normal_params_after_rest
-        )
+        return false, :not_enough_normal_after_rest_arguments, given_normal_params_after_rest_size, normal_params_after_rest_size
       end
 
       # rest引数があれば全て呑み込むためtrue
@@ -112,22 +106,22 @@ module Rubocop::DefinitionValidator
       if default_value_params
         return true if args.size <= default_value_params.size
         # XXX: optimize message.
-        return false, "Too many argument"
+        return false, :too_many_arguments
       end
       return true if args.empty?
-      return false, "Too many argument"
+      return false, :too_many_arguments
     end
 
     def decide_with_required_keyword_params(args)
       kwparam = args.pop(1)
-      usable, reason = usable_as_keyword_param?(kwparam[0])
-      return false, reason unless usable
+      usable, *reason = usable_as_keyword_param?(kwparam[0])
+      return false, *reason unless usable
 
       return decide_rest_args(args)
     end
 
     def decide_with_keyword_params(args)
-      ok, _ = decide_rest_args(args.dup)
+      ok, *_ = decide_rest_args(args.dup)
       return true if ok
 
       return decide_with_required_keyword_params(args)
@@ -148,8 +142,8 @@ module Rubocop::DefinitionValidator
     # @param [RuboCop::Node] arg
     def usable_as_keyword_param?(arg)
       # should be hash
-      return false, "Keyword params is required." unless arg
-      return false, "Keyword params should be hash. But got #{arg.loc.expression.source}" unless arg.hash_type? || !arg.literal?
+      return false, :kwparam_required unless arg
+      return false, :kwparam_should_be_hash, arg.loc.expression.source unless arg.hash_type? || !arg.literal?
 
       # should have specified keyword
       return true unless arg.hash_type?
@@ -170,7 +164,7 @@ module Rubocop::DefinitionValidator
         not received_keyword_names.include?(name)
       end
       unless not_fould_requireds.empty?
-        return false, "The following keyword parameters are required. But not received. #{not_fould_requireds.join(', ')}"
+        return false, :kwparam_not_found, not_fould_requireds.join(', ')
       end
 
       return true if keyword_rest_params
@@ -183,7 +177,7 @@ module Rubocop::DefinitionValidator
         not allowed_keyword_names.include?(name)
       end
       unless unexpected_keywords.empty?
-        return false, "The following keyword parameters are not expected. But received. #{unexpected_keywords}"
+        return false, :unexpected_kwparam, unexpected_keywords
       end
       return true
     end

data/lib/rubocop/definition_validator/patch.rb

@@ -3,61 +3,64 @@
 # The original method retuns only added lines.
 # However we want added and removed lines.
 #
-class Rubocop::DefinitionValidator::Patch < GitDiffParser::Patch
-  ADDED_LINE   = -> (line) { line.start_with?('+') && line !~ /^\+\+\+/ }
-  REMOVED_LINE = -> (line) { line.start_with?('-') && line !~ /^\-\-\-/ }
+module Rubocop::DefinitionValidator
+  class Patch < GitDiffParser::Patch
+    ADDED_LINE   = -> (line) { line.start_with?('+') && line !~ /^\+\+\+/ }
+    REMOVED_LINE = -> (line) { line.start_with?('-') && line !~ /^\-\-\-/ }
 
-  def initialize(original_patch)
-    @body = original_patch.body
-    @file = original_patch.file
-    @secure_hash = original_patch.secure_hash
-  end
+    def initialize(original_patch)
+      @body = original_patch.body
+      @file = original_patch.file
+      @secure_hash = original_patch.secure_hash
+    end
+
+    # @return [Array<Line>] changed lines
+    def changed_lines
+      line_number = 0
+      removed_line_offset = 0
 
-  # @return [Array<Line>] changed lines
-  def changed_lines
-    line_number = 0
-    removed_line_offset = 0
+      lines.each_with_index.inject([]) do |lines, (content, patch_position)|
+        case content
+        when RANGE_INFORMATION_LINE
+          line_number = Regexp.last_match[:line_number].to_i
+          removed_line_offset = 0
+        when ADDED_LINE
+          line = Rubocop::DefinitionValidator::Line.new(
+            content: content,
+            number: line_number,
+            patch_position: patch_position
+          )
+          lines << line
+          line_number += 1
+          removed_line_offset = 0
+        when REMOVED_LINE
+          line = Rubocop::DefinitionValidator::Line.new(
+            content: content,
+            number: line_number + removed_line_offset,
+            patch_position: patch_position
+          )
+          lines << line
+          removed_line_offset +=1
+        when NOT_REMOVED_LINE
+          line_number += 1
+          removed_line_offset = 0
+        end
 
-    lines.each_with_index.inject([]) do |lines, (content, patch_position)|
-      case content
-      when RANGE_INFORMATION_LINE
-        line_number = Regexp.last_match[:line_number].to_i
-        removed_line_offset = 0
-      when ADDED_LINE
-        line = Rubocop::DefinitionValidator::Line.new(
-          content: content,
-          number: line_number,
-          patch_position: patch_position
-        )
-        lines << line
-        line_number += 1
-        removed_line_offset = 0
-      when REMOVED_LINE
-        line = Rubocop::DefinitionValidator::Line.new(
-          content: content,
-          number: line_number + removed_line_offset,
-          patch_position: patch_position
-        )
-        lines << line
-        removed_line_offset +=1
-      when NOT_REMOVED_LINE
-        line_number += 1
-        removed_line_offset = 0
+        lines
       end
+    end
 
+    def changed_methods
+      lines = changed_lines
       lines
+        .group_by{|l| l.number}
+        .select{|_, v| v.size == 2}
+        .select{|_, v| t = v.map(&:type); t.include?('-') && t.include?('+')}
+        .select{|_, v| v.all?{|x| x.content =~ /def\s+\w+/}}
+        .map{|line, v|
+          sorted = v.sort_by(&:type)
+          ChangedMethod.new(sorted.first, sorted.last, line, @file)
+        }
     end
   end
-
-  def changed_method_codes
-    lines = changed_lines
-    lines
-      .group_by{|l| l.number}
-      .values
-      .select{|l| l.size == 2}
-      .select{|l| t = l.map(&:type); t.include?('-') && t.include?('+')}
-      .select{|l| l.all?{|x| x.content =~ /def\s+\w+/}}
-      .map{|l| l.sort_by(&:type)}
-      .map{|l| {added: l.first, removed: l.last}}
-  end
 end

data/lib/rubocop/definition_validator/version.rb

@@ -1,5 +1,5 @@
 module Rubocop
   module DefinitionValidator
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-definition_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Masataka Kuwabara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-03 00:00:00.000000000 Z
+date: 2016-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -186,11 +186,12 @@ files:
 - lib/rubocop/cop/lint/definition_validator.rb
 - lib/rubocop/definition_validator.rb
 - lib/rubocop/definition_validator/change_detector.rb
+- lib/rubocop/definition_validator/changed_method.rb
 - lib/rubocop/definition_validator/inject.rb
 - lib/rubocop/definition_validator/line.rb
+- lib/rubocop/definition_validator/message.rb
 - lib/rubocop/definition_validator/method.rb
 - lib/rubocop/definition_validator/patch.rb
-- lib/rubocop/definition_validator/reason.rb
 - lib/rubocop/definition_validator/version.rb
 - rubocop-definition_validator.gemspec
 homepage: https://github.com/actcat/rubocop-definition_validator

data/lib/rubocop/definition_validator/reason.rb

@@ -1,20 +0,0 @@
-module Rubocop::DefinitionValidator::Reason
-  class << self
-    # @return [Proc]
-    def method_name
-      -> (old, new) { "#{old.name} is undefined. Did you mean? #{new.name}" }
-    end
-
-    # @param [Integer] given given args size.
-    # @param [Integer] expected expected args size.
-    # @param [Symbol] kind normal_params or normal_params_after_rest
-    # @return [Proc]
-    def not_enough_arguments(given, expected, kind)
-      n = expected - given
-      -> (_old, new) {
-        not_enough_arg_names = new.__send__(kind).dup.pop(n).map{|x| x[1]}
-        "Not enough arguments. Did you forget the following arguments? [#{not_enough_arg_names.join(', ')}]"
-      }
-    end
-  end
-end