improve_your_code 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a81cdf7aa2de07a1fa7de9913869dd0d13c9d2b
+  data.tar.gz: 9e90b1d298fb90594093b3e2ed0486e99f248d15
+SHA512:
+  metadata.gz: d163763a9847ea7a6a3420a0dd7cb7ef23704fb98b0590706cc8987ae634a71d070f4715027163240b8830e34a9dec1093970c6214c93efaed949331cb462e2b
+  data.tar.gz: f9f073e2c4a4d112a45e4ae720cd8f6990d4110fab0b443d0ac45ed06d3cbd3ed282a39d95b4db019a2e570e003a7ecbca99174a15f28cfcb028f63eff32b93f

data/.gitignore

@@ -0,0 +1,17 @@
+pkg
+spec/output
+tmp
+doc
+coverage
+.yardoc
+.bundle
+.rspec
+.rbx
+Gemfile.lock
+*.swp
+tags
+.pryrc
+.tags*
+.DS_Store
+.idea/
+.rbenv-gemsets

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+ruby RUBY_VERSION
+
+group :development do
+  gem 'activesupport', '>= 4.2'
+  gem 'rake',          '~> 12.0'
+end

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/clean'

data/bin/improve_your_code

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/improve_your_code/cli/application'
+
+exit ImproveYourCode::CLI::Application.new.execute

data/improve_your_code.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require File.join(File.dirname(__FILE__), 'lib/improve_your_code/version')
+
+Gem::Specification.new do |s|
+  s.name = 'improve_your_code'
+  s.version = ImproveYourCode::Version::STRING
+
+  s.authors = ['Ilya Umanets']
+  s.default_executable = 'improve_your_code'
+  s.description =
+    'ImproveYourCode is a tool that examines Ruby classes, modules and methods and reports ' \
+    'any code smells it finds.'
+
+  s.files = `git ls-files -z`.split("\0")
+  s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
+  s.required_ruby_version = '>= 2.1.0'
+  s.summary = 'Code smell detector for Ruby'
+
+  s.add_runtime_dependency 'parser', '< 2.5', '>= 2.4.0.0'
+  s.add_runtime_dependency 'rainbow', '~> 2.0'
+end

data/lib/improve_your_code/ast/ast_node_class_map.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'node'
+require_relative 'sexp_extensions'
+
+module ImproveYourCode
+  module AST
+    class ASTNodeClassMap
+      def initialize
+        @klass_map = {}
+      end
+
+      def klass_for(type)
+        klass_map[type] ||= Class.new(Node).tap do |klass|
+          extension = extension_map[type]
+
+          klass.send :include, extension if extension
+        end
+      end
+
+      def extension_map
+        @extension_map ||=
+          begin
+            assoc = SexpExtensions.constants.map do |const|
+              [
+                const.to_s.sub(/Node$/, '').downcase.to_sym,
+                SexpExtensions.const_get(const)
+              ]
+            end
+            Hash[assoc]
+          end
+      end
+
+      private
+
+      attr_reader :klass_map
+    end
+  end
+end

data/lib/improve_your_code/ast/builder.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    class Builder < ::Parser::Builders::Default
+      def string_value(token)
+        value(token)
+      end
+    end
+  end
+end

data/lib/improve_your_code/ast/node.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative '../cli/silencer'
+
+ImproveYourCode::CLI::Silencer.silently do
+  require 'parser'
+end
+
+module ImproveYourCode
+  module AST
+    class Node < ::Parser::AST::Node
+      def initialize(type, children = [], options = {})
+        @comments = options.fetch(:comments, [])
+        super
+      end
+
+      def full_comment
+        comments.map(&:text).join("\n")
+      end
+
+      def leading_comment
+        line = location.line
+        comment_lines = comments.select do |comment|
+          comment.location.line < line
+        end
+        comment_lines.map(&:text).join("\n")
+      end
+
+      def line
+        loc&.line
+      end
+
+      def each_node(target_type, ignoring = [], &blk)
+        if block_given?
+          look_for_type(target_type, ignoring, &blk)
+        else
+          result = []
+          look_for_type(target_type, ignoring) { |exp| result << exp }
+          result
+        end
+      end
+
+      def find_nodes(target_types, ignoring = [])
+        result = []
+        look_for_types(target_types, ignoring) { |exp| result << exp }
+        result
+      end
+
+      def contains_nested_node?(target_type)
+        look_for_type(target_type) { |_elem| return true }
+        false
+      end
+
+      def format_to_ruby
+        if location
+          lines = location.expression.source.split("\n").map(&:strip)
+          case lines.length
+          when 1 then lines.first
+          when 2 then lines.join('; ')
+          else [lines.first, lines.last].join(' ... ')
+          end
+        else
+          to_s
+        end
+      end
+
+      def length
+        1
+      end
+
+      def statements
+        [self]
+      end
+
+      def source
+        loc.expression.source_buffer.name
+      end
+
+      protected
+
+      def look_for_type(target_type, ignoring = [], &blk)
+        each_sexp do |elem|
+          elem.look_for_type(target_type, ignoring, &blk) unless ignoring.include?(elem.type)
+        end
+        yield self if type == target_type
+      end
+
+      def look_for_types(target_types, ignoring = [], &blk)
+        return if ignoring.include?(type)
+        if target_types.include? type
+          yield self
+        else
+          each_sexp do |elem|
+            elem.look_for_types(target_types, ignoring, &blk)
+          end
+        end
+      end
+
+      private
+
+      attr_reader :comments
+
+      def each_sexp
+        children.each { |elem| yield elem if elem.is_a? ::Parser::AST::Node }
+      end
+    end
+  end
+end

data/lib/improve_your_code/ast/object_refs.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    class ObjectRefs
+      def initialize
+        @refs = Hash.new { |refs, name| refs[name] = [] }
+      end
+
+      def record_reference(name:, line: nil)
+        refs[name] << line
+      end
+
+      def most_popular
+        max = refs.values.map(&:size).max
+        refs.select { |_name, refs| refs.size == max }
+      end
+
+      def references_to(name)
+        refs[name]
+      end
+
+      def self_is_max?
+        refs.empty? || most_popular.keys.include?(:self)
+      end
+
+      private
+
+      attr_reader :refs
+    end
+  end
+end

data/lib/improve_your_code/ast/reference_collector.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    class ReferenceCollector
+      def initialize(ast)
+        @ast = ast
+      end
+
+      def num_refs_to_self
+        (explicit_self_calls + implicit_self_calls).size
+      end
+
+      private
+
+      attr_reader :ast
+
+      def explicit_self_calls
+        %i[self super zsuper ivar ivasgn].flat_map do |node_type|
+          ast.each_node(node_type)
+        end
+      end
+
+      def implicit_self_calls
+        ast.each_node(:send).reject(&:receiver)
+      end
+    end
+  end
+end

data/lib/improve_your_code/ast/sexp_extensions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'reference_collector'
+
+require_relative 'sexp_extensions/arguments'
+require_relative 'sexp_extensions/block'
+require_relative 'sexp_extensions/constant'
+require_relative 'sexp_extensions/if'
+require_relative 'sexp_extensions/methods'
+require_relative 'sexp_extensions/module'
+require_relative 'sexp_extensions/nested_assignables'
+require_relative 'sexp_extensions/self'
+require_relative 'sexp_extensions/send'
+require_relative 'sexp_extensions/symbols'
+require_relative 'sexp_extensions/variables'

data/lib/improve_your_code/ast/sexp_extensions/arguments.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      module ArgNodeBase
+        def name
+          children.first
+        end
+
+        def marked_unused?
+          plain_name.start_with?('_')
+        end
+
+        def plain_name
+          name.to_s
+        end
+
+        def block?
+          false
+        end
+
+        def optional_argument?
+          false
+        end
+
+        def anonymous_splat?
+          false
+        end
+
+        def components
+          [self]
+        end
+      end
+
+      module ArgNode
+        include ArgNodeBase
+      end
+
+      module KwargNode
+        include ArgNodeBase
+      end
+
+      module OptargNode
+        include ArgNodeBase
+
+        def optional_argument?
+          true
+        end
+      end
+
+      module KwoptargNode
+        include ArgNodeBase
+
+        def optional_argument?
+          true
+        end
+      end
+
+      module BlockargNode
+        include ArgNodeBase
+
+        def block?
+          true
+        end
+      end
+
+      module RestargNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          !name
+        end
+      end
+
+      module KwrestargNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          !name
+        end
+      end
+
+      module ShadowargNode
+        include ArgNodeBase
+      end
+    end
+  end
+end

data/lib/improve_your_code/ast/sexp_extensions/block.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      # Utility methods for :block nodes.
+      module BlockNode
+        def call
+          children.first
+        end
+
+        def args
+          children[1]
+        end
+
+        def block
+          children[2]
+        end
+
+        def parameters
+          children[1] || []
+        end
+
+        def parameter_names
+          parameters.children
+        end
+
+        def simple_name
+          :block
+        end
+
+        def without_block_arguments?
+          args.components.empty?
+        end
+      end
+    end
+  end
+end