Sha256: 8161efb576d626a249fdb3712ff266f97c745abc3619b2df745874e6af5d9071

Contents?: true

Size: 1.08 KB

Versions: 33

Compression:

Stored size: 1.08 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? do |line|
            line.blank? || comment_line?(line)
          end
        end
      end
    end
  end
end

Version data entries

33 entries across 33 versions & 2 rubygems

Version Path
plaid-14.13.0 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/empty_file.rb
plaid-14.12.1 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/empty_file.rb
plaid-14.12.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/empty_file.rb
plaid-14.11.1 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/empty_file.rb
plaid-14.10.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/empty_file.rb
plaid-14.7.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/empty_file.rb
rubocop-1.12.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.12.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.11.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.10.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.9.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.9.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.8.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.8.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.7.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.6.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.6.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.5.2 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.5.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.5.0 lib/rubocop/cop/lint/empty_file.rb