improve_your_code 1.0.0

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      module ConstNode
+        def simple_name
+          :Struct
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      # Utility methods for :if nodes.
+      module IfNode
+        def condition
+          children.first
+        end
+
+        def body_nodes(type, ignoring = [])
+          children[1..-1].compact.flat_map { |child| child.find_nodes(type, ignoring) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      # Base module for utility methods for :def and :defs nodes.
+      module MethodNodeBase
+        def arguments
+          parameters.reject(&:block?)
+        end
+
+        def arg_names
+          arguments.map(&:name)
+        end
+
+        def parameters
+          argslist.components
+        end
+
+        def parameter_names
+          parameters.map(&:name)
+        end
+
+        def name_without_bang
+          name.to_s.chop
+        end
+
+        def ends_with_bang?
+          name[-1] == '!'
+        end
+      end
+
+      # Utility methods for :def nodes.
+      module DefNode
+        include MethodNodeBase
+
+        def name
+          children.first
+        end
+
+        def argslist
+          children[1]
+        end
+
+        def body
+          children[2]
+        end
+
+        def full_name(outer)
+          [outer, name].reject(&:empty?).join('#')
+        end
+      end
+
+      # Utility methods for :defs nodes.
+      module DefsNode
+        include MethodNodeBase
+
+        def receiver
+          children.first
+        end
+
+        def name
+          children[1]
+        end
+
+        def argslist
+          children[2]
+        end
+
+        def body
+          children[3]
+        end
+
+        def full_name(outer)
+          prefix = outer == '' ? '' : "#{outer}#"
+          "#{prefix}#{receiver.name}.#{name}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      module ConstantDefiningNodeBase
+        def full_name(outer)
+          [outer, name].reject(&:empty?).join('::')
+        end
+
+        def simple_name
+          name.split('::').last
+        end
+      end
+
+      module ModuleNodeBase
+        include ConstantDefiningNodeBase
+
+        def name
+          children.first.format_to_ruby
+        end
+      end
+
+      module ModuleNode
+        include ModuleNodeBase
+      end
+
+      module ClassNode
+        include ModuleNodeBase
+      end
+
+      module CasgnNode
+        include ConstantDefiningNodeBase
+
+        def defines_module?
+          call = constant_definition
+          call&.module_creation_call?
+        end
+
+        def name
+          children[1].to_s
+        end
+
+        def value
+          children[2]
+        end
+
+        private
+
+        def constant_definition
+          return nil unless value
+
+          case value.type
+          when :block
+            call = value.call
+            call if call.type == :send
+          when :send
+            value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      module NestedAssignables
+        def components
+          children.flat_map(&:components)
+        end
+      end
+
+      module ArgsNode
+        include NestedAssignables
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      module SelfNode
+        def name
+          :self
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      # Utility methods for :send nodes.
+      module SendNode
+        ATTR_DEFN_METHODS = %i[attr_writer attr_accessor].freeze
+
+        def receiver
+          children.first
+        end
+
+        def name
+          children[1]
+        end
+
+        def args
+          children[2..-1]
+        end
+
+        def participants
+          ([receiver] + args).compact
+        end
+
+        def module_creation_call?
+          object_creation_call? && module_creation_receiver?
+        end
+
+        def module_creation_receiver?
+          receiver&.type == :const &&
+            %i[Class Struct].include?(receiver.simple_name)
+        end
+
+        def object_creation_call?
+          name == :new
+        end
+
+        def attribute_writer?
+          ATTR_DEFN_METHODS.include?(name) ||
+            attr_with_writable_flag?
+        end
+
+        # Handles the case where we create an attribute writer via:
+        # attr :foo, true
+        def attr_with_writable_flag?
+          name == :attr && args.any? && args.last.type == :true
+        end
+      end
+
+      Op_AsgnNode = SendNode
+      CSendNode = SendNode
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      # Utility methods for :sym nodes.
+      module SymNode
+        def name
+          children.first
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module AST
+    module SexpExtensions
+      # Base module for utility methods for nodes representing variables.
+      module VariableBase
+        def name
+          children.first
+        end
+      end
+
+      # Utility methods for :cvar nodes.
+      module CvarNode
+        include VariableBase
+      end
+
+      # Utility methods for :ivar nodes.
+      module IvarNode
+        include VariableBase
+      end
+
+      # Utility methods for :ivasgn nodes.
+      module IvasgnNode
+        include VariableBase
+      end
+
+      # Utility methods for :lvar nodes.
+      module LvarNode
+        include VariableBase
+
+        alias var_name name
+      end
+
+      # Utility methods for :gvar nodes.
+      module GvarNode
+        include VariableBase
+      end
+
+      LvasgnNode = LvarNode
+      CvasgnNode = CvarNode
+      CvdeclNode = CvarNode
+    end
+  end
+end

data/lib/improve_your_code/cli/application.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../source/source_locator'
+require_relative 'command/report_command'
+
+module ImproveYourCode
+  module CLI
+    class Application
+      def execute
+        enable_rainbow
+
+        command = Command::ReportCommand.new(sources: sources)
+
+        command.execute
+
+        true
+      end
+
+      private
+
+      attr_reader :command
+
+      def enable_rainbow
+        Rainbow.enabled = true
+      end
+
+      def sources
+        Source::SourceLocator.new(['.']).sources
+      end
+    end
+  end
+end

data/lib/improve_your_code/cli/command/report_command.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../examiner'
+require_relative '../../report/text_report'
+
+module ImproveYourCode
+  module CLI
+    module Command
+      class ReportCommand
+        def initialize(sources:)
+          @sources = sources
+        end
+
+        def execute
+          populate_reporter_with_smells
+          reporter.show
+        end
+
+        private
+
+        attr_reader :sources
+
+        def smell_names
+          @smell_names ||= []
+        end
+
+        def populate_reporter_with_smells
+          sources.each do |source|
+            reporter.add_examiner Examiner.new(source)
+          end
+        end
+
+        def reporter
+          @reporter ||= Report::TextReport.new
+        end
+      end
+    end
+  end
+end

data/lib/improve_your_code/cli/silencer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'stringio'
+
+module ImproveYourCode
+  module CLI
+    # CLI silencer
+    module Silencer
+      module_function
+
+      def silently
+        old_verbose = $VERBOSE
+        $VERBOSE = false
+        $stderr = StringIO.new
+        $stdout = StringIO.new
+        yield
+      ensure
+        $VERBOSE = old_verbose
+        $stderr = STDERR
+        $stdout = STDOUT
+      end
+    end
+  end
+end

data/lib/improve_your_code/code_comment.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require_relative 'smell_detectors/base_detector'
+
+module ImproveYourCode
+  class CodeComment
+    CONFIGURATION_REGEX = /
+                          :improve_your_code: # prefix
+                          (\w+)  # smell detector e.g.: UncommunicativeVariableName
+                          (
+                            :? # legacy separator
+                            \s*
+                            (\{.*?\}) # optional details in hash style e.g.: { max_methods: 30 }
+                          )?
+                         /x
+    SANITIZE_REGEX                 = /(#|\n|\s)+/ # Matches '#', newlines and > 1 whitespaces.
+    DISABLE_DETECTOR_CONFIGURATION = '{ enabled: false }'
+    MINIMUM_CONTENT_LENGTH         = 2
+    LEGACY_SEPARATOR               = ':'
+
+    attr_reader :config
+
+    def initialize(comment:, line: nil, source: nil)
+      @original_comment  = comment
+      @line              = line
+      @source            = source
+      @config            = Hash.new { |hash, key| hash[key] = {} }
+
+      @original_comment.scan(CONFIGURATION_REGEX) do |detector_name, _option_string, options|
+        @config.merge! detector_name => YAML.safe_load(options || DISABLE_DETECTOR_CONFIGURATION,
+          [Regexp])
+      end
+    end
+
+    def descriptive?
+      sanitized_comment.split(/\s+/).length >= MINIMUM_CONTENT_LENGTH
+    end
+
+    private
+
+    attr_reader :original_comment, :source, :line
+
+    def sanitized_comment
+      @sanitized_comment ||= original_comment
+        .gsub(CONFIGURATION_REGEX, '')
+        .gsub(SANITIZE_REGEX, ' ')
+        .strip
+    end
+  end
+end