Contents

require 'reek/smells/smell_detector'
require 'reek/smell_warning'
require 'reek/source/code_comment'

module Reek
  module Smells
    #
    # It is considered good practice to annotate every class and module
    # with a brief comment outlining its responsibilities.
    #
    class IrresponsibleModule < SmellDetector
      def self.contexts # :nodoc:
        [:class]
      end

      def self.descriptive   # :nodoc:
        @descriptive ||= {}
      end

      #
      # Checks the given class or module for a descriptive comment.
      #
      # @return [Array<SmellWarning>]
      #
      def examine_context(ctx)
        comment = Source::CodeComment.new(ctx.exp.comments)
        return [] if self.class.descriptive[ctx.full_name] ||= comment.descriptive?
        [SmellWarning.new(self,
                          context: ctx.full_name,
                          lines: [ctx.exp.line],
                          message: 'has no descriptive comment',
                          parameters: {  name: ctx.exp.text_name })]
      end
    end
  end
end

Version data entries

12 entries across 12 versions & 1 rubygems

Version	Path
reek-2.0.4	lib/reek/smells/irresponsible_module.rb
reek-2.0.3	lib/reek/smells/irresponsible_module.rb
reek-2.0.2	lib/reek/smells/irresponsible_module.rb
reek-2.0.1	lib/reek/smells/irresponsible_module.rb
reek-2.0.0	lib/reek/smells/irresponsible_module.rb
reek-1.6.6	lib/reek/smells/irresponsible_module.rb
reek-1.6.5	lib/reek/smells/irresponsible_module.rb
reek-1.6.4	lib/reek/smells/irresponsible_module.rb
reek-1.6.3	lib/reek/smells/irresponsible_module.rb
reek-1.6.2	lib/reek/smells/irresponsible_module.rb
reek-1.6.1	lib/reek/smells/irresponsible_module.rb
reek-1.6.0	lib/reek/smells/irresponsible_module.rb