Sha256: 6272b44306724bc22b511364055f95e951b22cb4debc91be97677298af1936f2

Contents?: true

Size: 1.06 KB

Versions: 38

Compression:

Stored size: 1.06 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # This cop enforces that Ruby source files are not empty.
      #
      # @example
      #   # bad
      #   # Empty file
      #
      #   # good
      #   # File containing non commented source lines
      #
      # @example AllowComments: true (default)
      #   # good
      #   # File consisting only of comments
      #
      # @example AllowComments: false
      #   # bad
      #   # File consisting only of comments
      #
      class EmptyFile < Base
        include RangeHelp

        MSG = 'Empty file detected.'

        def on_new_investigation
          add_global_offense(MSG) if offending?
        end

        private

        def offending?
          empty_file? || (!cop_config['AllowComments'] && contains_only_comments?)
        end

        def empty_file?
          processed_source.buffer.source.empty?
        end

        def contains_only_comments?
          processed_source.lines.all? { |line| line.blank? || comment_line?(line) }
        end
      end
    end
  end
end

Version data entries

38 entries across 38 versions & 6 rubygems

Version Path
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/lint/empty_file.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/lint/empty_file.rb
rubocop-1.29.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.29.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.28.2 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.28.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.28.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.27.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.26.1 lib/rubocop/cop/lint/empty_file.rb
op_connect-0.1.2 vendor/bundle/ruby/3.1.0/gems/rubocop-1.26.0/lib/rubocop/cop/lint/empty_file.rb
rubocop-1.26.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.25.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.25.0 lib/rubocop/cop/lint/empty_file.rb
phillipug-foodie-0.1.0 .vendor/ruby/3.0.0/gems/rubocop-1.24.0/lib/rubocop/cop/lint/empty_file.rb
rubocop-1.24.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.24.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.23.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.22.3 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.22.2 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.22.1 lib/rubocop/cop/lint/empty_file.rb