improve_your_code 1.0.0

data/lib/improve_your_code/context/attribute_context.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'code_context'
+
+module ImproveYourCode
+  module Context
+    class AttributeContext < CodeContext
+      attr_accessor :visibility
+
+      def initialize(exp, send_expression)
+        @visibility = :public
+        @send_expression = send_expression
+        super exp
+      end
+
+      def full_comment
+        send_expression.full_comment || ''
+      end
+
+      def instance_method?
+        true
+      end
+
+      def apply_current_visibility(current_visibility)
+        self.visibility = current_visibility
+      end
+
+      private
+
+      attr_reader :send_expression
+    end
+  end
+end

data/lib/improve_your_code/context/code_context.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative '../code_comment'
+require_relative '../ast/object_refs'
+require_relative 'statement_counter'
+
+require 'forwardable'
+
+module ImproveYourCode
+  module Context
+    class CodeContext
+      include Enumerable
+      extend Forwardable
+      delegate each_node: :exp
+      delegate %i[name type] => :exp
+
+      attr_reader :children, :parent, :exp, :statement_counter
+
+      def initialize(exp)
+        @exp                = exp
+        @children           = []
+        @statement_counter  = StatementCounter.new
+        @refs               = AST::ObjectRefs.new
+      end
+
+      def local_nodes(type, ignored = [], &blk)
+        ignored += %i[casgn class module]
+        each_node(type, ignored, &blk)
+      end
+
+      def each(&block)
+        return enum_for(:each) unless block_given?
+
+        yield self
+        children.each do |child|
+          child.each(&block)
+        end
+      end
+
+      def register_with_parent(parent)
+        @parent = parent.append_child_context(self) if parent
+      end
+
+      def append_child_context(child)
+        children << child
+        self
+      end
+
+      def record_call_to(exp)
+        receiver = exp.receiver
+        type = receiver ? receiver.type : :self
+        line = exp.line
+        case type
+        when :lvar, :lvasgn
+          unless exp.object_creation_call?
+            refs.record_reference(name: receiver.name, line: line)
+          end
+        when :self
+          refs.record_reference(name: :self, line: line)
+        end
+      end
+
+      def record_use_of_self
+        refs.record_reference(name: :self)
+      end
+
+      def matches?(candidates)
+        my_fq_name = full_name
+        candidates.any? do |candidate|
+          candidate = Regexp.quote(candidate) if candidate.is_a?(String)
+          /#{candidate}/ =~ my_fq_name
+        end
+      end
+
+      def full_name
+        exp.full_name('')
+      end
+
+      def config_for(detector_class)
+        parent_config_for(detector_class).merge(
+          configuration_via_code_commment[detector_class.smell_type] || {}
+        )
+      end
+
+      def number_of_statements
+        statement_counter.value
+      end
+
+      def singleton_method?
+        false
+      end
+
+      def instance_method?
+        false
+      end
+
+      def apply_current_visibility(_current_visibility); end
+
+      private
+
+      attr_reader :refs
+
+      def configuration_via_code_commment
+        @configuration_via_code_commment ||=
+          CodeComment.new(
+            comment: full_comment,
+            line: exp.line,
+            source: exp.source
+          ).config
+      end
+
+      def full_comment
+        exp.full_comment || ''
+      end
+
+      def parent_config_for(detector_class)
+        parent ? parent.config_for(detector_class) : {}
+      end
+    end
+  end
+end

data/lib/improve_your_code/context/method_context.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative 'code_context'
+
+module ImproveYourCode
+  module Context
+    class MethodContext < CodeContext
+      attr_accessor :visibility
+      attr_reader :refs
+
+      def initialize(exp, parent_exp)
+        @parent_exp = parent_exp
+        @visibility = :public
+        super exp
+      end
+
+      def references_self?
+        exp.depends_on_instance?
+      end
+
+      def uses_param?(param)
+        (local_nodes(:lvar) + local_nodes(:lvasgn))
+          .find { |node| node.var_name == param.name }
+      end
+
+      def unused_params
+        exp.arguments.reject do |param|
+          param.anonymous_splat? ||
+            param.marked_unused? ||
+            uses_param?(param)
+        end
+      end
+
+      def uses_super_with_implicit_arguments?
+        (body = exp.body) && body.contains_nested_node?(:zsuper)
+      end
+
+      def default_assignments
+        @default_assignments ||=
+          exp.parameters.select(&:optional_argument?).map(&:children)
+      end
+
+      def method_context_class
+        self.class
+      end
+
+      def singleton_method?
+        false
+      end
+
+      def instance_method?
+        true
+      end
+
+      def apply_current_visibility(current_visibility)
+        self.visibility = current_visibility
+      end
+
+      def module_function?
+        visibility == :module_function
+      end
+
+      def non_public_visibility?
+        visibility != :public
+      end
+
+      def full_comment
+        own = super
+        return own unless own.empty?
+        return parent_exp.full_comment if parent_exp
+        ''
+      end
+
+      private
+
+      attr_reader :parent_exp
+    end
+  end
+end

data/lib/improve_your_code/context/module_context.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative 'code_context'
+require_relative 'attribute_context'
+require_relative 'method_context'
+require_relative 'visibility_tracker'
+
+module ImproveYourCode
+  module Context
+    class ModuleContext < CodeContext
+      attr_reader :visibility_tracker
+
+      def initialize(exp)
+        super
+        @visibility_tracker = VisibilityTracker.new
+      end
+
+      def append_child_context(child)
+        visibility_tracker.set_child_visibility(child)
+        super
+      end
+
+      def method_context_class
+        MethodContext
+      end
+
+      def attribute_context_class
+        AttributeContext
+      end
+
+      def defined_instance_methods(visibility: :public)
+        instance_method_children.select do |context|
+          context.visibility == visibility
+        end
+      end
+
+      def instance_method_calls
+        instance_method_children.flat_map do |context|
+          context.children.grep(SendContext)
+        end
+      end
+
+      def node_instance_methods
+        local_nodes(:def)
+      end
+
+      def descriptively_commented?
+        CodeComment.new(comment: exp.leading_comment).descriptive?
+      end
+
+      def namespace_module?
+        return false if exp.type == :casgn
+        children = exp.direct_children
+        children.any? && children.all? { |child| %i[casgn class module].include? child.type }
+      end
+
+      def track_visibility(visibility, names)
+        visibility_tracker.track_visibility children: instance_method_children,
+                                            visibility: visibility,
+                                            names: names
+        visibility_tracker.track_singleton_visibility children: singleton_method_children,
+                                                      visibility: visibility,
+                                                      names: names
+      end
+
+      private
+
+      def instance_method_children
+        children.select(&:instance_method?)
+      end
+
+      def singleton_method_children
+        children.select(&:singleton_method?)
+      end
+    end
+  end
+end

data/lib/improve_your_code/context/root_context.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'code_context'
+require_relative 'method_context'
+
+module ImproveYourCode
+  module Context
+    class RootContext < CodeContext
+      def type
+        :root
+      end
+
+      def full_name
+        ''
+      end
+
+      def method_context_class
+        MethodContext
+      end
+    end
+  end
+end

data/lib/improve_your_code/context/send_context.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'code_context'
+
+module ImproveYourCode
+  module Context
+    class SendContext < CodeContext
+      attr_reader :name
+
+      def initialize(exp, name)
+        @name = name
+        super exp
+      end
+    end
+  end
+end

data/lib/improve_your_code/context/singleton_attribute_context.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'attribute_context'
+
+module ImproveYourCode
+  module Context
+    class SingletonAttributeContext < AttributeContext
+      def instance_method?
+        false
+      end
+    end
+  end
+end

data/lib/improve_your_code/context/singleton_method_context.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'method_context'
+
+module ImproveYourCode
+  module Context
+    class SingletonMethodContext < MethodContext
+      def singleton_method?
+        true
+      end
+
+      def instance_method?
+        false
+      end
+
+      def module_function?
+        false
+      end
+
+      def defined_as_instance_method?
+        type == :def
+      end
+
+      def apply_current_visibility(current_visibility)
+        super if defined_as_instance_method?
+      end
+    end
+  end
+end

data/lib/improve_your_code/context/statement_counter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../ast/node'
+
+module ImproveYourCode
+  module Context
+    class StatementCounter
+      attr_reader :value
+
+      def initialize
+        @value = 0
+      end
+
+      def increase_by(sexp)
+        self.value = value + sexp.length if sexp
+      end
+
+      def decrease_by(number)
+        self.value = value - number
+      end
+
+      private
+
+      attr_writer :value
+    end
+  end
+end

data/lib/improve_your_code/context/visibility_tracker.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ImproveYourCode
+  module Context
+    class VisibilityTracker
+      VISIBILITY_MODIFIERS = %i[
+        private public protected
+        module_function
+      ].freeze
+      VISIBILITY_MAP = {
+        public_class_method: :public,
+        private_class_method: :private
+      }.freeze
+
+      def initialize
+        @tracked_visibility = :public
+      end
+
+      def track_visibility(children:, visibility:, names:)
+        return unless VISIBILITY_MODIFIERS.include? visibility
+
+        if names.any?
+          children.each do |child|
+            child.visibility = visibility if names.include?(child.name)
+          end
+        else
+          self.tracked_visibility = visibility
+        end
+      end
+
+      def track_singleton_visibility(children:, visibility:, names:)
+        return if names.empty?
+
+        visibility = VISIBILITY_MAP[visibility]
+
+        return unless visibility
+
+        track_visibility(
+          children: children, visibility: visibility, names: names
+        )
+      end
+
+      def set_child_visibility(child)
+        child.apply_current_visibility tracked_visibility
+      end
+
+      private
+
+      attr_accessor :tracked_visibility
+    end
+  end
+end