Class: CleoQualityReview::Options::ParseResult

Inherits:
Struct
  • Object
show all
Defined in:
lib/cleo_quality_review/options.rb

Overview

Value object containing parsed command-line options

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#base ⇒ Object

Returns the value of attribute base

Returns:

  • (Object) —

    the current value of base



30
31
32
 
# File 'lib/cleo_quality_review/options.rb', line 30

def base
  @base
end

#changed ⇒ Boolean (readonly)

Returns whether to filter to changed files only.

Returns:

  • (Boolean) —

    whether to filter to changed files only



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/cleo_quality_review/options.rb', line 30

ParseResult = Struct.new(:format, :checks, :files, :exclude, :changed, :base, :log, :review_id, :review_file, :jobs, keyword_init: true) do
  ##
  # @return [String] validated review_id
  # @raise [OptionParser::MissingArgument] if review_id is blank
  def validated_review_id
    raise OptionParser::MissingArgument, "--review-id is required" if review_id.to_s.strip == ""

    review_id
  end

  ##
  # @return [Hash] run loading attributes
  def run_loading_params
    { format: format, log: log }
  end
end

#checks ⇒ Array<String> (readonly)

Returns checks to run.

Returns:

  • (Array<String>) —

    checks to run



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/cleo_quality_review/options.rb', line 30

ParseResult = Struct.new(:format, :checks, :files, :exclude, :changed, :base, :log, :review_id, :review_file, :jobs, keyword_init: true) do
  ##
  # @return [String] validated review_id
  # @raise [OptionParser::MissingArgument] if review_id is blank
  def validated_review_id
    raise OptionParser::MissingArgument, "--review-id is required" if review_id.to_s.strip == ""

    review_id
  end

  ##
  # @return [Hash] run loading attributes
  def run_loading_params
    { format: format, log: log }
  end
end

#exclude ⇒ Array<String> (readonly)

Returns checks to exclude.

Returns:

  • (Array<String>) —

    checks to exclude



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/cleo_quality_review/options.rb', line 30

ParseResult = Struct.new(:format, :checks, :files, :exclude, :changed, :base, :log, :review_id, :review_file, :jobs, keyword_init: true) do
  ##
  # @return [String] validated review_id
  # @raise [OptionParser::MissingArgument] if review_id is blank
  def validated_review_id
    raise OptionParser::MissingArgument, "--review-id is required" if review_id.to_s.strip == ""

    review_id
  end

  ##
  # @return [Hash] run loading attributes
  def run_loading_params
    { format: format, log: log }
  end
end

#files ⇒ Array<String> (readonly)

Returns explicit file paths.

Returns:

  • (Array<String>) —

    explicit file paths



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/cleo_quality_review/options.rb', line 30

ParseResult = Struct.new(:format, :checks, :files, :exclude, :changed, :base, :log, :review_id, :review_file, :jobs, keyword_init: true) do
  ##
  # @return [String] validated review_id
  # @raise [OptionParser::MissingArgument] if review_id is blank
  def validated_review_id
    raise OptionParser::MissingArgument, "--review-id is required" if review_id.to_s.strip == ""

    review_id
  end

  ##
  # @return [Hash] run loading attributes
  def run_loading_params
    { format: format, log: log }
  end
end

#format ⇒ String (readonly)

Returns output format.

Returns:

  • (String) —

    output format



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/cleo_quality_review/options.rb', line 30

ParseResult = Struct.new(:format, :checks, :files, :exclude, :changed, :base, :log, :review_id, :review_file, :jobs, keyword_init: true) do
  ##
  # @return [String] validated review_id
  # @raise [OptionParser::MissingArgument] if review_id is blank
  def validated_review_id
    raise OptionParser::MissingArgument, "--review-id is required" if review_id.to_s.strip == ""

    review_id
  end

  ##
  # @return [Hash] run loading attributes
  def run_loading_params
    { format: format, log: log }
  end
end

#jobs ⇒ Integer? (readonly)

Returns max checks to run in parallel, or nil to auto-size.

Returns:

  • (Integer, nil) —

    max checks to run in parallel, or nil to auto-size



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/cleo_quality_review/options.rb', line 30

ParseResult = Struct.new(:format, :checks, :files, :exclude, :changed, :base, :log, :review_id, :review_file, :jobs, keyword_init: true) do
  ##
  # @return [String] validated review_id
  # @raise [OptionParser::MissingArgument] if review_id is blank
  def validated_review_id
    raise OptionParser::MissingArgument, "--review-id is required" if review_id.to_s.strip == ""

    review_id
  end

  ##
  # @return [Hash] run loading attributes
  def run_loading_params
    { format: format, log: log }
  end
end

#log ⇒ Object

Returns the value of attribute log

Returns:

  • (Object) —

    the current value of log



30
31
32
 
# File 'lib/cleo_quality_review/options.rb', line 30

def log
  @log
end

#review_file ⇒ Object

Returns the value of attribute review_file

Returns:

  • (Object) —

    the current value of review_file



30
31
32
 
# File 'lib/cleo_quality_review/options.rb', line 30

def review_file
  @review_file
end

#review_id ⇒ Object

Returns the value of attribute review_id

Returns:

  • (Object) —

    the current value of review_id



30
31
32
 
# File 'lib/cleo_quality_review/options.rb', line 30

def review_id
  @review_id
end

Instance Method Details

#run_loading_params ⇒ Hash

Returns run loading attributes.

Returns:

  • (Hash) —

    run loading attributes



42
43
44
 
# File 'lib/cleo_quality_review/options.rb', line 42

def run_loading_params
  { format: format, log: log }
end

#validated_review_id ⇒ String

Returns validated review_id.

Returns:

  • (String) —

    validated review_id

Raises:

  • (OptionParser::MissingArgument) —

    if review_id is blank



34
35
36
37
38
 
# File 'lib/cleo_quality_review/options.rb', line 34

def validated_review_id
  raise OptionParser::MissingArgument, "--review-id is required" if review_id.to_s.strip == ""

  review_id
end