Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Haskell.Homplexity.Assessment

Contents

Showing metric measurements
Assessments of severity for used Metrics.
Computing and assessing Metrics for all CodeFragment.

Description

Main module parsing inputs, and running analysis.

Synopsis

measureAll :: Metric m c => Assessment m -> (a -> [c]) -> Proxy m -> Proxy c -> a -> Log
measureTopOccurs :: (Data from, Metric m c) => Assessment m -> Proxy m -> Proxy c -> from -> Log
measureAllOccurs :: (Data from, Metric m c) => Assessment m -> Proxy m -> Proxy c -> from -> Log
type Assessment m = m -> (Severity, String)
warnOfMeasure :: (CodeFragment c, Metric m c) => Assessment m -> Proxy m -> Proxy c -> c -> Log
data HFlag_moduleLinesWarning = HFlagC_moduleLinesWarning
flags_moduleLinesWarning :: Int
data HFlag_moduleLinesCritical = HFlagC_moduleLinesCritical
flags_moduleLinesCritical :: Int
assessModuleLength :: Assessment LOC
data HFlag_functionLinesWarning = HFlagC_functionLinesWarning
flags_functionLinesWarning :: Int
data HFlag_functionLinesCritical = HFlagC_functionLinesCritical
flags_functionLinesCritical :: Int
assessFunctionLength :: Assessment LOC
data HFlag_functionDepthWarning = HFlagC_functionDepthWarning
flags_functionDepthWarning :: Int
data HFlag_functionDepthCritical = HFlagC_functionDepthCritical
flags_functionDepthCritical :: Int
assessFunctionDepth :: Assessment Depth
data HFlag_functionCCWarning = HFlagC_functionCCWarning
flags_functionCCWarning :: Int
data HFlag_functionCCCritical = HFlagC_functionCCCritical
flags_functionCCCritical :: Int
assessFunctionCC :: Assessment Cyclomatic
data HFlag_typeConDepthWarning = HFlagC_typeConDepthWarning
flags_typeConDepthWarning :: Int
data HFlag_typeConDepthCritical = HFlagC_typeConDepthCritical
flags_typeConDepthCritical :: Int
assessTypeConDepth :: Assessment ConDepth
data HFlag_numFunArgsWarning = HFlagC_numFunArgsWarning
flags_numFunArgsWarning :: Int
data HFlag_numFunArgsCritical = HFlagC_numFunArgsCritical
flags_numFunArgsCritical :: Int
assessNumFunArgs :: Assessment NumFunArgs
data HFlag_recordFieldsCountWarning = HFlagC_recordFieldsCountWarning
flags_recordFieldsCountWarning :: Int
data HFlag_recordFieldsCountCritical = HFlagC_recordFieldsCountCritical
flags_recordFieldsCountCritical :: Int
assessRecordFieldsCount :: Assessment RecordFieldsCount
data HFlag_typeClassNonTypeDeclWarning = HFlagC_typeClassNonTypeDeclWarning
flags_typeClassNonTypeDeclWarning :: Int
data HFlag_typeClassNonTypeDeclCritical = HFlagC_typeClassNonTypeDeclCritical
flags_typeClassNonTypeDeclCritical :: Int
assessTCNonTypeDeclCount :: Assessment NonTypeDeclCount
data HFlag_typeClassAssocTypesWarning = HFlagC_typeClassAssocTypesWarning
flags_typeClassAssocTypesWarning :: Int
data HFlag_typeClassAssocTypesCritical = HFlagC_typeClassAssocTypesCritical
flags_typeClassAssocTypesCritical :: Int
assessTCAssocTypesCount :: Assessment AssocTypeCount
metrics :: [Program -> Log]

Showing metric measurements

measureAll :: Metric m c => Assessment m -> (a -> [c]) -> Proxy m -> Proxy c -> a -> Log Source #

measureTopOccurs :: (Data from, Metric m c) => Assessment m -> Proxy m -> Proxy c -> from -> Log Source #

measureAllOccurs :: (Data from, Metric m c) => Assessment m -> Proxy m -> Proxy c -> from -> Log Source #

Measure all occurences of a given CodeFragment with a given Metric, then use Assessment on them and give a list of Log messages.

Arguments come in the following order: 1. Assessment for the value of the Metric. 2. Metric given as Proxy type. 3. CodeFragment given as Proxy type. 4. Program containing CodeFragments.

type Assessment m = m -> (Severity, String) Source #

Type of functions that convert a Metric into a log message.

warnOfMeasure :: (CodeFragment c, Metric m c) => Assessment m -> Proxy m -> Proxy c -> c -> Log Source #

Assessments of severity for used `Metric`s.

Module definition checks

data HFlag_moduleLinesWarning Source #

Constructors

HFlagC_moduleLinesWarning

Instances

Instances details

Flag HFlag_moduleLinesWarning Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_moduleLinesWarning -> FlagData

flags_moduleLinesWarning :: Int Source #

data HFlag_moduleLinesCritical Source #

Constructors

HFlagC_moduleLinesCritical

Instances

Instances details

Flag HFlag_moduleLinesCritical Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_moduleLinesCritical -> FlagData

flags_moduleLinesCritical :: Int Source #

assessModuleLength :: Assessment LOC Source #

Function definition checks

Number of lines of code within function body

data HFlag_functionLinesWarning Source #

Constructors

HFlagC_functionLinesWarning

Instances

Instances details

Flag HFlag_functionLinesWarning Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_functionLinesWarning -> FlagData

flags_functionLinesWarning :: Int Source #

data HFlag_functionLinesCritical Source #

Constructors

HFlagC_functionLinesCritical

Instances

Instances details

Flag HFlag_functionLinesCritical Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_functionLinesCritical -> FlagData

flags_functionLinesCritical :: Int Source #

assessFunctionLength :: Assessment LOC Source #

Decision depth of function definition

data HFlag_functionDepthWarning Source #

Constructors

HFlagC_functionDepthWarning

Instances

Instances details

Flag HFlag_functionDepthWarning Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_functionDepthWarning -> FlagData

flags_functionDepthWarning :: Int Source #

data HFlag_functionDepthCritical Source #

Constructors

HFlagC_functionDepthCritical

Instances

Instances details

Flag HFlag_functionDepthCritical Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_functionDepthCritical -> FlagData

flags_functionDepthCritical :: Int Source #

assessFunctionDepth :: Assessment Depth Source #

Cyclomatic complexity of function definition

data HFlag_functionCCWarning Source #

Constructors

HFlagC_functionCCWarning

Instances

Instances details

Flag HFlag_functionCCWarning Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_functionCCWarning -> FlagData

flags_functionCCWarning :: Int Source #

data HFlag_functionCCCritical Source #

Constructors

HFlagC_functionCCCritical

Instances

Instances details

Flag HFlag_functionCCCritical Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_functionCCCritical -> FlagData

flags_functionCCCritical :: Int Source #

assessFunctionCC :: Assessment Cyclomatic Source #

Type signature complexity

Type constructor depth in each type signature

data HFlag_typeConDepthWarning Source #

Constructors

HFlagC_typeConDepthWarning

Instances

Instances details

Flag HFlag_typeConDepthWarning Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_typeConDepthWarning -> FlagData

flags_typeConDepthWarning :: Int Source #

data HFlag_typeConDepthCritical Source #

Constructors

HFlagC_typeConDepthCritical

Instances

Instances details

Flag HFlag_typeConDepthCritical Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_typeConDepthCritical -> FlagData

flags_typeConDepthCritical :: Int Source #

assessTypeConDepth :: Assessment ConDepth Source #

Number of function arguments mentioned in each type signature

data HFlag_numFunArgsWarning Source #

Constructors

HFlagC_numFunArgsWarning

Instances

Instances details

Flag HFlag_numFunArgsWarning Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_numFunArgsWarning -> FlagData

flags_numFunArgsWarning :: Int Source #

data HFlag_numFunArgsCritical Source #

Constructors

HFlagC_numFunArgsCritical

Instances

Instances details

Flag HFlag_numFunArgsCritical Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_numFunArgsCritical -> FlagData

flags_numFunArgsCritical :: Int Source #

assessNumFunArgs :: Assessment NumFunArgs Source #

Data type complexity

Record fields count

data HFlag_recordFieldsCountWarning Source #

Constructors

HFlagC_recordFieldsCountWarning

Instances

Instances details

Flag HFlag_recordFieldsCountWarning Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_recordFieldsCountWarning -> FlagData

flags_recordFieldsCountWarning :: Int Source #

data HFlag_recordFieldsCountCritical Source #

Constructors

HFlagC_recordFieldsCountCritical

Instances

Instances details

Flag HFlag_recordFieldsCountCritical Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_recordFieldsCountCritical -> FlagData

flags_recordFieldsCountCritical :: Int Source #

assessRecordFieldsCount :: Assessment RecordFieldsCount Source #

Type class complexity

Method count of type class

data HFlag_typeClassNonTypeDeclWarning Source #

Constructors

HFlagC_typeClassNonTypeDeclWarning

Instances

Instances details

Flag HFlag_typeClassNonTypeDeclWarning Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_typeClassNonTypeDeclWarning -> FlagData

flags_typeClassNonTypeDeclWarning :: Int Source #

data HFlag_typeClassNonTypeDeclCritical Source #

Constructors

HFlagC_typeClassNonTypeDeclCritical

Instances

Instances details

Flag HFlag_typeClassNonTypeDeclCritical Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_typeClassNonTypeDeclCritical -> FlagData

flags_typeClassNonTypeDeclCritical :: Int Source #

assessTCNonTypeDeclCount :: Assessment NonTypeDeclCount Source #

Associated type count of type class

data HFlag_typeClassAssocTypesWarning Source #

Constructors

HFlagC_typeClassAssocTypesWarning

Instances

Instances details

Flag HFlag_typeClassAssocTypesWarning Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_typeClassAssocTypesWarning -> FlagData

flags_typeClassAssocTypesWarning :: Int Source #

data HFlag_typeClassAssocTypesCritical Source #

Constructors

HFlagC_typeClassAssocTypesCritical

Instances

Instances details

Flag HFlag_typeClassAssocTypesCritical Source #
Instance details Defined in Language.Haskell.Homplexity.Assessment Methods getFlagData :: HFlag_typeClassAssocTypesCritical -> FlagData

flags_typeClassAssocTypesCritical :: Int Source #

assessTCAssocTypesCount :: Assessment AssocTypeCount Source #

Computing and assessing `Metric`s for all `CodeFragment`.

metrics :: [Program -> Log] Source #

Compute all metrics, and assign severity depending on configured thresholds.

Showing metric measurements

Assessments of severity for used Metrics.

Module definition checks

Instances

Instances

Function definition checks

Number of lines of code within function body

Instances

Instances

Decision depth of function definition

Instances

Instances

Cyclomatic complexity of function definition

Instances

Instances

Type signature complexity

Type constructor depth in each type signature

Instances

Instances

Number of function arguments mentioned in each type signature

Instances

Instances

Data type complexity

Record fields count

Instances

Instances

Type class complexity

Method count of type class

Instances

Instances

Associated type count of type class

Instances

Instances

Computing and assessing Metrics for all CodeFragment.

Assessments of severity for used `Metric`s.

Computing and assessing `Metric`s for all `CodeFragment`.