free_mutant/lib/mutant/cli.rb

# encoding: utf-8

require 'optparse'

module Mutant

  # Comandline parser
  class CLI
    include Adamantium::Flat, Equalizer.new(:config)

    # Error raised when CLI argv is invalid
    Error = Class.new(RuntimeError)

    EXIT_FAILURE = 1
    EXIT_SUCCESS = 0

    # Run cli with arguments
    #
    # @param [Array<String>] arguments
    #
    # @return [Fixnum]
    #   returns exit status
    #
    # @api private
    #
    def self.run(arguments)
      config = new(arguments).config
      runner = Runner::Config.run(config)
      runner.success? ? EXIT_SUCCESS : EXIT_FAILURE
    rescue Error => exception
      $stderr.puts(exception.message)
      EXIT_FAILURE
    end

    # Initialize objecct
    #
    # @param [Array<String>]
    #
    # @return [undefined]
    #
    # @api private
    #
    def initialize(arguments = [])
      @filters, @matchers = [], []

      @cache = Mutant::Cache.new

      parse(arguments)
      strategy
      matcher
    end

    # Return config
    #
    # @return [Config]
    #
    # @api private
    #
    def config
      Config.new(
        :cache     => @cache,
        :debug     => debug?,
        :matcher   => matcher,
        :filter    => filter,
        :fail_fast => !!@fail_fast,
        :strategy  => strategy,
        :reporter  => reporter
      )
    end
    memoize :config

  private

    # Test for running in debug mode
    #
    # @return [true]
    #   if debug mode is active
    #
    # @return [false]
    #   otherwise
    #
    # @api private
    #
    def debug?
      !!@debug
    end

    # Return mutation filter
    #
    # @return [Mutant::Matcher]
    #
    # @api private
    #
    def filter
      if @filters.empty?
        Mutation::Filter::ALL
      else
        Mutation::Filter::Whitelist.new(@filters)
      end
    end
    memoize :filter

    # Return stratety
    #
    # @return [Strategy]
    #
    # @api private
    #
    def strategy
      @strategy or raise(Error, 'No strategy was set!')
    end
    memoize :strategy

    # Return reporter
    #
    # @return [Mutant::Reporter::CLI]
    #
    # @api private
    #
    def reporter
      Reporter::CLI.new($stdout)
    end
    memoize :reporter

    # Return matcher
    #
    # @return [Mutant::Matcher]
    #
    # @raise [CLI::Error]
    #   raises error when matcher is not given
    #
    # @api private
    #
    def matcher
      if @matchers.empty?
        raise Error, 'No matchers given'
      end

      Matcher::Chain.build(@matchers)
    end
    memoize :matcher

    # Add mutation filter
    #
    # @param [Class<Mutant::Filter>] klass
    #
    # @param [String] filter
    #
    # @return [undefined]
    #
    # @api private
    #
    def add_filter(klass, filter)
      @filters << klass.new(filter)
    end

    # Set fail fast
    #
    # @api private
    #
    # @return [undefined]
    #
    def set_fail_fast
      @fail_fast = true
    end

    # Set debug mode
    #
    # @api private
    #
    # @return [undefined]
    #
    def set_debug
      @debug = true
    end

    # Set strategy
    #
    # @param [Strategy] strategy
    #
    # @api private
    #
    # @return [undefined]
    #
    def set_strategy(strategy)
      @strategy = strategy
    end

    # Parse the command-line options
    #
    # @param [Array<String>] arguments
    #   Command-line options and arguments to be parsed.
    #
    # @raise [Error]
    #   An error occurred while parsing the options.
    #
    # @return [undefined]
    #
    # @api private
    #
    def parse(arguments)
      opts = OptionParser.new do |builder|
        builder.banner = 'usage: mutant STRATEGY [options] MATCHERS ...'
        builder.separator ''
        builder.separator 'Strategies:'

        builder.on('--zombie', 'Run mutant zombified')

        add_strategies(builder)
        add_options(builder)
      end

      matchers =
        begin
          opts.parse!(arguments)
        rescue OptionParser::ParseError => error
          raise(Error, error.message, error.backtrace)
        end

      parse_matchers(matchers)
    end

    # Parse matchers
    #
    # @param [Enumerable<String>] patterns
    #
    # @return [undefined]
    #
    # @api private
    #
    def parse_matchers(patterns)
      patterns.each do |pattern|
        matcher = Classifier.build(@cache, pattern)
        @matchers << matcher if matcher
      end
    end

    # Add strategies
    #
    # @param [Object]
    #
    # @return [undefined]
    #
    # @api private
    #
    def add_strategies(opts)
      opts.on('--rspec-unit', 'executes all specs under ./spec/unit') do
        set_strategy Strategy::Rspec::Unit
      end.on('--rspec-full', 'executes all specs under ./spec') do
        set_strategy Strategy::Rspec::Full
      end.on('--rspec-dm2', 'executes spec/unit/$nesting/$method_spec.rb') do
        set_strategy Strategy::Rspec::DM2
      end
    end

    # Add options
    #
    # @param [Object]
    #
    # @return [undefined]
    #
    # @api private
    #
    def add_options(opts)
      opts.separator ''
      opts.separator 'Options:'

      opts.on('--code FILTER', 'Adds a code filter') do |filter|
        add_filter Mutation::Filter::Code, filter
      end.on('--fail-fast', 'Fail fast') do
        set_fail_fast
      end.on('-d', '--debug', 'Enable debugging output') do
        set_debug
      end.on_tail('-h', '--help', 'Show this message') do
        puts opts
        exit
      end
    end

  end # CLI
end # Mutant