code_analyzer 0.5.1 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 792496737344902c984457c4a153f5e7e5717e7f9568f130cdc039c1779e9627
-  data.tar.gz: 8b15a24c9ede966353b1100328fe1d5dcc14937fc6d2a4401a455cfe42176d27
+  metadata.gz: 4c37841a3a698b9ce2fa6c4aa80b0a03eb204a4f6ae43e3a0c8d48e78c5f8916
+  data.tar.gz: f4e3b26a9afb7ce80266d590a98e5f838944b9a892a8748374828aa4387aa592
 SHA512:
-  metadata.gz: 2bd9cd8d09ffaab831f417207e0003082408ddb61e8a513884a0d137adb567c1c6f3aed5f68d2460d58a5799ef56a514cb49af4d1c5f2b92b017500193709e54
-  data.tar.gz: dd4bf2b587ca333c7eeabcd088586eeebc421c9e41931d1637a7dd0bb3f1b403959b95c0cc697eb81cd6d818e198f4648b1fc8e1d585c8896600f528ec2511fe
+  metadata.gz: 60042c122b97be0ece07e2898f245430f4ff8d11f61d68008de00f1a37bd8fa4022d33f98f5d3d13c04138afaa4c6ce724ead33be9ead570b8194809742b7eb7
+  data.tar.gz: e4ee8925dadae37e1a594c114a0ddff4e09e2adabdc92621284323bdd2cb9247b4ec0829a252b6e3050dac5453c250b98b61d3b44f513bbae77aa45bac5c5ac1

data/.github/workflows/main.yml

@@ -0,0 +1,31 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec spec

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/README.md

@@ -1,11 +1,6 @@
 # CodeAnalyzer
 
-| Project  | code_analyzer
-|:---------|:--------------------------------------------
-| Homepage | https://github.com/flyerhzm/code_analyzer
-| Document | http://rubydoc.info/gems/code_analyzer/frames
-| CI       | [![Build Status](https://travis-ci.org/flyerhzm/code_analyzer.png)](https://travis-ci.org/flyerhzm/code_analyzer)
-| Author   | [Richard Huang][0]
+[![CI](https://github.com/flyerhzm/code_analyzer/actions/workflows/main.yml/badge.svg)](https://github.com/flyerhzm/code_analyzer/actions/workflows/main.yml)
 
 code_analyzer is extracted from [rails_best_practices][1], it helps you
 easily build your own code analyzer tool.
@@ -36,5 +31,4 @@ Or install it yourself as:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-[0]: http://huangzhimin.com
 [1]: https://github.com/railsbp/rails_best_practices

data/code_analyzer.gemspec

@@ -1,4 +1,5 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 require File.expand_path('../lib/code_analyzer/version', __FILE__)
 
 Gem::Specification.new do |gem|

data/lib/code_analyzer/analyzer_exception.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module CodeAnalyzer
   class AnalyzerException < Exception; end
 end

data/lib/code_analyzer/checker.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module CodeAnalyzer
   # A checker class that takes charge of checking the sexp.
   class Checker
@@ -28,8 +29,7 @@ module CodeAnalyzer
     # @param [Sexp] node
     def node_start(node)
       @node = node
-      self.class.get_callbacks("start_#{node.sexp_type}".to_sym)
-        .each { |block| self.instance_exec(node, &block) }
+      self.class.get_callbacks("start_#{node.sexp_type}".to_sym).each { |block| self.instance_exec(node, &block) }
     end
 
     # delegate to end_### according to the sexp_type, like
@@ -40,9 +40,7 @@ module CodeAnalyzer
     # @param [Sexp] node
     def node_end(node)
       @node = node
-      self.class.get_callbacks("end_#{node.sexp_type}".to_sym).each do |block|
-        self.instance_exec(node, &block)
-      end
+      self.class.get_callbacks("end_#{node.sexp_type}".to_sym).each { |block| self.instance_exec(node, &block) }
     end
 
     # add an warning.
@@ -50,13 +48,8 @@ module CodeAnalyzer
     # @param [String] message, is the warning message
     # @param [String] filename, is the filename of source code
     # @param [Integer] line_number, is the line number of the source code which is reviewing
-    def add_warning(
-      message, filename = @node.file, line_number = @node.line_number
-    )
-      warnings <<
-        Warning.new(
-          filename: filename, line_number: line_number, message: message
-        )
+    def add_warning(message, filename = @node.file, line_number = @node.line_number)
+      warnings << Warning.new(filename: filename, line_number: line_number, message: message)
     end
 
     # all warnings.

data/lib/code_analyzer/checking_visitor/base.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module CodeAnalyzer::CheckingVisitor
   # Base class for checking visitor.
   class Base

data/lib/code_analyzer/checking_visitor/default.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module CodeAnalyzer::CheckingVisitor
   # This is the default checking visitor to check ruby sexp nodes.
   class Default < Base
@@ -39,9 +40,7 @@ module CodeAnalyzer::CheckingVisitor
     def parse(filename, content)
       Sexp.from_array(Ripper::SexpBuilder.new(content).parse)
     rescue Exception
-      raise AnalyzerException.new(
-              "#{filename} looks like it's not a valid Ruby file.  Skipping..."
-            )
+      raise AnalyzerException.new("#{filename} looks like it's not a valid Ruby file.  Skipping...")
     end
 
     # recursively check ruby sexp node.
@@ -51,20 +50,14 @@ module CodeAnalyzer::CheckingVisitor
     # 3. it triggers the interesting checkers' end callbacks.
     def check_node(node)
       checkers = @checks[node.sexp_type]
-      if checkers
-        checkers.each do |checker|
-          checker.node_start(node) if checker.parse_file?(node.file)
-        end
-      end
+
+      checkers.each { |checker| checker.node_start(node) if checker.parse_file?(node.file) } if checkers
       node.children.each do |child_node|
         child_node.file = node.file
         check_node(child_node)
       end
-      if checkers
-        checkers.each do |checker|
-          checker.node_end(node) if checker.parse_file?(node.file)
-        end
-      end
+
+      checkers.each { |checker| checker.node_end(node) if checker.parse_file?(node.file) } if checkers
     end
   end
 end

data/lib/code_analyzer/checking_visitor/plain.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module CodeAnalyzer::CheckingVisitor
   # This is the checking visitor to check ruby plain code.
   class Plain < Base
@@ -7,9 +8,7 @@ module CodeAnalyzer::CheckingVisitor
     # @param [String] filename is the filename of ruby code.
     # @param [String] content is the content of ruby file.
     def check(filename, content)
-      @checkers.each do |checker|
-        checker.check(filename, content) if checker.parse_file?(filename)
-      end
+      @checkers.each { |checker| checker.check(filename, content) if checker.parse_file?(filename) }
     end
   end
 end

data/lib/code_analyzer/checking_visitor.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module CodeAnalyzer
   module CheckingVisitor
     autoload :Base, 'code_analyzer/checking_visitor/base'

data/lib/code_analyzer/nil.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module CodeAnalyzer
   # Fake nil.
   class Nil

data/lib/code_analyzer/sexp.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'sexp'
 
 class Sexp
@@ -13,21 +14,23 @@ class Sexp
   #
   #     s(:@ident, "test", s(2, 12)
   #       => 2
+
   def line_number
     case sexp_type
-    when :def, :defs, :command, :command_call, :call, :fcall, :method_add_arg, :method_add_block,
-         :var_ref, :vcall, :const_ref, :const_path_ref, :class, :module, :if, :unless,
-         :elsif, :ifop, :if_mod, :unless_mod, :binary, :alias, :symbol_literal, :symbol,
-         :aref, :hash, :assoc_new, :string_literal, :massign, :var_field
+    when :def, :defs, :command, :command_call, :call, :fcall, :method_add_arg, :method_add_block, :var_ref, :vcall,
+         :const_ref, :top_const_ref, :const_path_ref, :class, :module, :if, :unless, :elsif, :ifop, :if_mod, :unless_mod, :binary, :alias,
+         :symbol_literal, :symbol, :aref, :hash, :assoc_new, :string_literal, :massign, :var_field, :assign, :paren, :dot2, :dot3
       self[1].line_number
     when :assoclist_from_args, :bare_assoc_hash
       self[1][0].line_number
-    when :string_add, :opassign
+    when :string_add, :opassign, :unary, :stmts_add
       self[2].line_number
     when :array
       array_values.first.line_number
     when :mlhs_add
       self.last.line_number
+    when :params
+      self[1][0].line_number if self[1].is_a? Array
     else
       self.last.first if self.last.is_a? Array
     end
@@ -68,45 +71,16 @@ class Sexp
     to_s = options[:to_s]
     self.recursive_children do |child|
       if (
-         !sexp_type ||
-           (
-             if sexp_type.is_a?(Array)
-               sexp_type.include?(child.sexp_type)
-             else
-               sexp_type == child.sexp_type
-             end
-           )
-       ) &&
-         (
-           !receiver ||
-             (
-               if receiver.is_a?(Array)
-                 receiver.include?(child.receiver.to_s)
-               else
-                 receiver == child.receiver.to_s
-               end
-             )
-         ) &&
-         (
-           !message ||
-             (
-               if message.is_a?(Array)
-                 message.include?(child.message.to_s)
-               else
-                 message == child.message.to_s
-               end
-             )
+           !sexp_type || (sexp_type.is_a?(Array) ? sexp_type.include?(child.sexp_type) : sexp_type == child.sexp_type)
          ) &&
-         (
-           !to_s ||
-             (
-               if to_s.is_a?(Array)
-                 to_s.include?(child.to_s)
-               else
-                 to_s == child.to_s
-               end
-             )
-         )
+           (
+             !receiver ||
+               (receiver.is_a?(Array) ? receiver.include?(child.receiver.to_s) : receiver == child.receiver.to_s)
+           ) &&
+           (
+             !message || (message.is_a?(Array) ? message.include?(child.message.to_s) : message == child.message.to_s)
+           ) &&
+           (!to_s || (to_s.is_a?(Array) ? to_s.include?(child.to_s) : to_s == child.to_s))
         yield child
       end
     end
@@ -391,14 +365,12 @@ class Sexp
   def all_conditions
     nodes = []
     if :binary == sexp_type && %w[&& || and or].include?(self[2].to_s)
-      if :binary == self[1].sexp_type &&
-         %w[&& || and or].include?(self[1][2].to_s)
+      if :binary == self[1].sexp_type && %w[&& || and or].include?(self[1][2].to_s)
         nodes += self[1].all_conditions
       else
         nodes << self[1]
       end
-      if :binary == self[3].sexp_type &&
-         %w[&& || and or].include?(self[3][2].to_s)
+      if :binary == self[3].sexp_type && %w[&& || and or].include?(self[3][2].to_s)
         nodes += self[3].all_conditions
       else
         nodes << self[3]
@@ -418,6 +390,7 @@ class Sexp
   #         => s(:@ident, "show", s(1, 4)),
   #
   # @return [Sexp] method name node
+
   def method_name
     case sexp_type
     when :def
@@ -455,6 +428,7 @@ class Sexp
   #            )
   #
   # @return [Sexp] body node
+
   def body
     case sexp_type
     when :else
@@ -571,6 +545,7 @@ class Sexp
   def exception_classes
     if :rescue == sexp_type
       return [] unless self[1]
+
       if :mrhs_add == self[1].sexp_type
         exceptions = Array.new(self[1][2])
         arg_nodes = self[1][1][1]
@@ -621,11 +596,8 @@ class Sexp
       else
 
       end
-    if pair_nodes
-      pair_nodes.size.times do |i|
-        return pair_nodes[i][2] if key == pair_nodes[i][1].to_s
-      end
-    end
+
+    pair_nodes.size.times { |i| return pair_nodes[i][2] if key == pair_nodes[i][1].to_s } if pair_nodes
     CodeAnalyzer::Nil.new
   end
 
@@ -716,6 +688,31 @@ class Sexp
     end
   end
 
+  # Get the hash key
+  #
+  #     s(:assoc_new, s(:@label, "first_name:", s(1, 1)), s(:string_literal, s(:string_add, s(:string_content), s(:@tstring_content, "Richard", s(1, 14)))))
+  #     =>
+  #     s(:@label, "first_name:", s(1, 1))
+  def key
+    if :assoc_new == sexp_type
+      self[1].to_s
+    end
+  end
+
+  # Get the hash value
+  #
+  #     s(:assoc_new, s(:@label, "first_name:", s(1, 1)), s(:string_literal, s(:string_add, s(:string_content), s(:@tstring_content, "Richard", s(1, 14)))))
+  #     =>
+  #     s(:string_literal, s(:string_add, s(:string_content), s(:@tstring_content, "Richard", s(1, 14))))
+  def value
+    if :assoc_new == sexp_type
+      return nil if self[2].nil?
+      return self[2] if :array == self[2].sexp_type
+
+      self[2].to_s
+    end
+  end
+
   # Get the array size.
   #
   #     s(:array,
@@ -734,12 +731,9 @@ class Sexp
       if first_node
         while true
           array_size += 1
-          first_node =
-            s(:args_new) == first_node[1] ? first_node[2] : first_node[1]
+          first_node = s(:args_new) == first_node[1] ? first_node[2] : first_node[1]
           if :args_add != first_node.sexp_type
-            if :array == first_node.sexp_type
-              array_size += first_node.array_size
-            end
+            array_size += first_node.array_size if :array == first_node.sexp_type
             break
           end
         end
@@ -765,13 +759,9 @@ class Sexp
   def array_values
     case sexp_type
     when :array
-      if nil == self[1] ||
-         %i[words_new qwords_new symbols_new qsymbols_new].include?(
-           self[1].sexp_type
-         )
+      if nil == self[1] || %i[words_new qwords_new symbols_new qsymbols_new].include?(self[1].sexp_type)
         []
-      elsif %i[words_add qwords_add symbols_add qsymbols_add].include? self[1]
-                                                                    .sexp_type
+      elsif %i[words_add qwords_add symbols_add qsymbols_add].include? self[1].sexp_type
         self[1].array_values
       else
         arguments.all
@@ -780,12 +770,10 @@ class Sexp
       values = []
       node = self
       while true
-        if %i[words_add qwords_add symbols_add qsymbols_add].include? node
-                                                                   .sexp_type
+        if %i[words_add qwords_add symbols_add qsymbols_add].include? node.sexp_type
           values.unshift node[2]
           node = node[1]
-        elsif %i[words_new qwords_new symbols_new qsymbols_new].include? node
-                                                                      .sexp_type
+        elsif %i[words_new qwords_new symbols_new qsymbols_new].include? node.sexp_type
           break
         end
       end
@@ -842,9 +830,8 @@ class Sexp
   # @return [String] to_s
   def to_s
     case sexp_type
-    when :string_literal, :xstring_literal, :string_content, :const_ref,
-         :symbol_literal, :symbol, :args_add_block, :var_ref, :vcall, :var_field,
-         :@ident, :@tstring_content, :@const, :@ivar, :@kw, :@gvar, :@cvar, :@period
+    when :string_literal, :xstring_literal, :string_content, :const_ref, :symbol_literal, :symbol, :args_add_block, :var_ref,
+         :vcall, :var_field, :@ident, :@tstring_content, :@const, :@ivar, :@kw, :@gvar, :@cvar, :@period
       self[1].to_s
     when :string_add
       s(:string_content) == self[1] ? self[2].to_s : self[1].to_s
@@ -871,11 +858,7 @@ class Sexp
 
   # check if the self node is a const.
   def const?
-    :@const == self.sexp_type ||
-      (
-        %i[var_ref vcall].include?(self.sexp_type) &&
-          :@const == self[1].sexp_type
-      )
+    :@const == self.sexp_type || (%i[var_ref vcall].include?(self.sexp_type) && :@const == self[1].sexp_type)
   end
 
   # true
@@ -892,14 +875,10 @@ class Sexp
   def remove_line_and_column
     node = self.clone
     last_node = node.last
-    if Sexp === last_node && last_node.size == 2 &&
-       last_node.first.is_a?(Integer) &&
-       last_node.last.is_a?(Integer)
+    if Sexp === last_node && last_node.size == 2 && last_node.first.is_a?(Integer) && last_node.last.is_a?(Integer)
       node.delete_at(-1)
     end
-    node.sexp_body.each_with_index do |child, index|
-      node[index + 1] = child.remove_line_and_column if Sexp === child
-    end
+    node.sexp_body.each_with_index { |child, index| node[index + 1] = child.remove_line_and_column if Sexp === child }
     node
   end
 
@@ -922,9 +901,7 @@ class Sexp
     class_eval <<-EOS
       alias_method :origin_#{method}, :#{method}
 
-      def #{
-      method
-    }
+      def #{method}
         ret = origin_#{
       method
     }

data/lib/code_analyzer/version.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module CodeAnalyzer
-  VERSION = '0.5.1'
+  VERSION = '0.5.5'
 end

data/lib/code_analyzer/warning.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module CodeAnalyzer
   # Warning is the violation.
   #

data/lib/code_analyzer.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'ripper'
 require 'code_analyzer/version'
 require 'code_analyzer/nil'

data/spec/code_analyzer/checker_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module CodeAnalyzer
@@ -28,16 +30,12 @@ module CodeAnalyzer
 
     context '#parse_file?' do
       it 'should return true if node_file matches pattern' do
-        allow(checker).to receive(:interesting_files).and_return(
-          [%r{spec\/.*\.rb}, %r{lib\/.*\.rb}]
-        )
+        allow(checker).to receive(:interesting_files).and_return([%r{spec\/.*\.rb}, %r{lib\/.*\.rb}])
         expect(checker.parse_file?('lib/code_analyzer.rb')).to be true
       end
 
       it "should return false if node_file doesn't match pattern" do
-        allow(checker).to receive(:interesting_files).and_return(
-          [%r{spec\/.*\.rb}]
-        )
+        allow(checker).to receive(:interesting_files).and_return([%r{spec\/.*\.rb}])
         expect(checker.parse_file?('lib/code_analyzer.rb')).to be false
       end
     end

data/spec/code_analyzer/checking_visitor/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module CodeAnalyzer

data/spec/code_analyzer/checking_visitor/default_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module CodeAnalyzer::CheckingVisitor

data/spec/code_analyzer/checking_visitor/plain_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module CodeAnalyzer::CheckingVisitor

data/spec/code_analyzer/nil_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module CodeAnalyzer