Contents

require_relative 'code_context'
require_relative 'method_context'
require_relative '../ast/sexp_formatter'

module Reek
  module Context
    #
    # A context wrapper for any module found in a syntax tree.
    #
    # :reek:FeatureEnvy
    class ModuleContext < CodeContext
      def defined_instance_methods(visibility: :public)
        each.select do |context|
          context.is_a?(Context::MethodContext) &&
            context.visibility == visibility
        end
      end

      def instance_method_calls
        each.
          grep(SendContext).
          select { |context| context.parent.class == MethodContext }
      end

      #
      # @deprecated use `defined_instance_methods` instead
      #
      def node_instance_methods
        local_nodes(:def)
      end

      def descriptively_commented?
        CodeComment.new(exp.leading_comment).descriptive?
      end

      # A namespace module is a module (or class) that is only there for namespacing
      # purposes, and thus contains only nested constants, modules or classes.
      #
      # However, if the module is empty, it is not considered a namespace module.
      #
      # @return true if the module is a namespace module
      def namespace_module?
        return false if exp.type == :casgn
        contents = exp.children.last
        contents && contents.find_nodes([:def, :defs], [:casgn, :class, :module]).empty?
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
reek-3.8.3	lib/reek/context/module_context.rb
reek-3.8.2	lib/reek/context/module_context.rb
reek-3.8.1	lib/reek/context/module_context.rb
reek-3.8.0	lib/reek/context/module_context.rb