hallucinations hallucinations - 6 months ago 14
Ruby Question

How to count RSpec examples filtered with :focus in a git hook?

I am trying to write a Git pre-commit hook that would not let the user commit if there is an example that is tagged with

:focus
.

Using RSpec's API (okay even if it is private), is there any way to find out the number of examples with the
:focus
filter?

I found the example_count-instance_method. It could be useful but I'm not sure how it can be called from an external script.

Answer

Here is an Overcommit pre_commit hook that uses RSpecs private API to find out specs with :focus filter:

require 'rspec'

module Overcommit
  module Hook
    module PreCommit
      # NOTE: This makes use of many methods from RSpecs private API.
      class EnsureFocusFreeSpecs < Base
        def configure_rspec(applicable_files)
          RSpec.configure do |config|
            config.inclusion_filter = :focus
            config.files_or_directories_to_run = applicable_files
            config.inclusion_filter.rules
            config.requires = %w(spec_helper rails_helper)
            config.load_spec_files
          end
        end

        def run
          configure_rspec(applicable_files)

          return :pass if RSpec.world.example_count.zero?

          files = RSpec.world.filtered_examples.reject {|_k, v| v.empty?}.keys.map(&:file_path).uniq
          [:fail, "Trying to commit focused spec(s) in:\n\t#{files.join("\n\t")}"]
        end
      end
    end
  end
end
Comments