Class: Sitespec::Artifact

Inherits:

Object

• Object
• Sitespec::Artifact

Defined in:

lib/sitespec/artifact.rb

Overview

“Artifact” is corresponding to each response body to an endpoint. This class has ActiveRecord-like interface like Sitespec::Artifact.create.

Examples:

Sitespec::Artifact.create(example: example, example_group: example_group)

Class Method Summary

• .create(**args) ⇒ Sitespec::Artifact

  Short-hand method to call ‘.new` and `#save`.

Instance Method Summary

• #initialize(example: nil, example_group: nil) ⇒ Artifact constructor

  A new instance of Artifact.

• #save ⇒ false, true

  Validate its attributes and generate a new file.

Constructor Details

#initialize(example: nil, example_group: nil) ⇒ Artifact

Returns a new instance of Artifact.

Parameters:

• example (RSpec::Core::Example) (defaults to: nil) —

  In almost cases, ‘RSpec.current_example` is passed

• example_group (RSpec::Core::ExampleGroup) (defaults to: nil) —

  In almost cases, ‘self` is passed

# File 'lib/sitespec/artifact.rb', line 22

def initialize(example: nil, example_group: nil)
  @example = example
  @example_group = example_group
end

Class Method Details

.create(**args) ⇒ Sitespec::Artifact

Short-hand method to call ‘.new` and `#save`

Returns:

• (Sitespec::Artifact)

# File 'lib/sitespec/artifact.rb', line 15

def create(**args)
  new(**args).tap(&:save)
end

Instance Method Details

#save ⇒ false, true

Validate its attributes and generate a new file

Returns:

• (false, true) —

  True for successful case, otherwise false

# File 'lib/sitespec/artifact.rb', line 29

def save
  if valid?
    write
    count_up
    true
  else
    false
  end
end