Class: FlutterRb::Check

Inherits:

Object

• Object
• FlutterRb::Check

Defined in:

lib/flutter_rb/checks/check.rb

Overview

A class representing a check to be performed on a project.

Direct Known Subclasses

PluginDirectoriesCheck, PluginGradleAndroidPackageCheck, PluginGradleVersionCheck, PluginPodspecCheck, PluginPubspecCheck, PluginPubspecFlutterLintsCheck, PluginPubspecLintsCheck

Constant Summary

UNIMPLEMENTED_ERROR =

Error message to be raised when a method is not implemented.

'Error: missing method'

Instance Method Summary

• #check(project) ⇒ CheckReport

  Performs the check on the given project and returns a report.

• #description ⇒ String

  Returns a description of the check.

• #name ⇒ String

  Returns the name of the check.

Instance Method Details

#check(project) ⇒ CheckReport

Performs the check on the given project and returns a report.

Parameters:

• project (Project, nil) —

  the project to be checked

Returns:

• (CheckReport) —

  the report of the check

Raises:

• (RuntimeError) —

  if the method is not implemented

# File 'lib/flutter_rb/checks/check.rb', line 30

def check(project)
  raise UNIMPLEMENTED_ERROR
end

#description ⇒ String

Returns a description of the check.

Returns:

• (String) —

  a description of the check

Raises:

• (RuntimeError) —

  if the method is not implemented

# File 'lib/flutter_rb/checks/check.rb', line 21

def description
  raise UNIMPLEMENTED_ERROR
end

#name ⇒ String

Returns the name of the check.

Returns:

• (String) —

  the name of the check

Raises:

• (RuntimeError) —

  if the method is not implemented

# File 'lib/flutter_rb/checks/check.rb', line 13

def name
  raise UNIMPLEMENTED_ERROR
end