feat: add Plinth summary

Author: bogdan-manole

src/Stan.hs

@@ -11,6 +11,7 @@ module Stan
     , runStan
     , getAnalysis
     , getStanConfig
+    , removeOffchain
 
       -- ** Internal
     , createCabalExtensionsMap
@@ -24,7 +25,7 @@ import Trial (Trial (..), prettyTaggedTrial, prettyTrial, prettyTrialWith, trial
               whenResult_)
 
 import Stan.Analysis (Analysis (..), runAnalysis)
-import Stan.Analysis.Pretty (prettyShowAnalysis)
+import Stan.Analysis.Pretty (prettyShowAnalysis, isPlinthObservation)
 import Stan.Browse (openBrowser)
 import Stan.Cabal (createCabalExtensionsMap, usedCabalFiles)
 import Stan.Cli (CliToTomlArgs (..), InspectionArgs (..), ReportArgs (..), StanArgs (..),
@@ -47,7 +48,6 @@ import Stan.Toml (configCodec, getTomlConfig, usedTomlFiles)
 import qualified Toml
 import qualified Slist as Slist
 import qualified Data.Set as Set
-import qualified Data.Text as T
 import Language.Haskell.Exts
 import Stan.FileInfo (FileInfo(..))
 
@@ -88,11 +88,6 @@ getAnalysis StanArgs{..} notJson config hieFiles = do
     -- show what observations are ignored
     pure analysis
 
-isPlutusObservations :: Observation -> Bool
-isPlutusObservations Observation{..} =
-  -- observationInspectionId includes PLU-STAN
-  "PLU-STAN" `T.isInfixOf` unId observationInspectionId
-
 isOnchainObservations :: Set FilePath -> Observation -> Bool
 isOnchainObservations files obs = Set.member (observationFile obs) files
 
@@ -114,13 +109,14 @@ onchainFiles hieFiles = do
   fromList <$> filterM isFileOnchainContract files
 
 onchainCondition :: Set FilePath -> Observation -> Bool
-onchainCondition contracts obs = not (isPlutusObservations obs) || isOnchainObservations contracts obs
+onchainCondition contracts obs = not (isPlinthObservation obs) || isOnchainObservations contracts obs
 
 filterForOnchain :: Set FilePath -> FileInfo -> FileInfo
 filterForOnchain contracts info@FileInfo{..}= info {
   fileInfoObservations = Slist.filter (onchainCondition contracts) fileInfoObservations }
 
-removeOffchain :: [HieFile] ->Analysis -> IO Analysis
+-- TODO: remove IO and everything will be fine
+removeOffchain :: [HieFile] -> Analysis -> IO Analysis
 removeOffchain hieFiles analysis = do
   contracts <- onchainFiles hieFiles
   pure analysis {

src/Stan/Analysis/Pretty.hs

@@ -15,6 +15,7 @@ module Stan.Analysis.Pretty
     , analysisToNumbers
     , prettyHealth
     , toProjectHealth
+    , isPlinthObservation
     ) where
 
 import Colourista.Short (b, i)
@@ -32,6 +33,7 @@ import qualified Data.Map.Strict as Map
 import qualified Data.Set as Set
 import qualified Data.Text as Text
 import qualified Slist as S
+import Stan.Core.Id (Id(unId))
 
 
 {- | Shows analysed output of Stan work.
@@ -51,16 +53,22 @@ prettyShowAnalysis an rs@OutputSettings{..} = case outputSettingsVerbosity of
         $ analysisFileMap an
 
 data AnalysisNumbers = AnalysisNumbers
-    { anModules    :: !Int
-    , anLoc        :: !Int
-    , anExts       :: !Int
-    , anSafeExts   :: !Int
-    , anIns        :: !Int
-    , anFoundObs   :: !Int
-    , anIgnoredObs :: !Int
-    , anHealth     :: !Double
+    { anModules     :: !Int
+    , anLoc         :: !Int
+    , anExts        :: !Int
+    , anSafeExts    :: !Int
+    , anIns         :: !Int
+    , anFoundObs    :: !Int
+    , anIgnoredObs  :: !Int
+    , anFoundPlinth :: !Int
+    , anHealth      :: !Double
     }
 
+isPlinthObservation :: Observation -> Bool
+isPlinthObservation Observation{..} =
+  -- observationInspectionId includes PLU-STAN
+  "PLU-STAN" `Text.isInfixOf` unId observationInspectionId
+
 analysisToNumbers :: Analysis -> AnalysisNumbers
 analysisToNumbers Analysis{..} = AnalysisNumbers
     { anModules    = analysisModulesNum
@@ -70,6 +78,7 @@ analysisToNumbers Analysis{..} = AnalysisNumbers
     , anIns        = HS.size analysisInspections
     , anFoundObs   = length analysisObservations
     , anIgnoredObs = length analysisIgnoredObservations
+    , anFoundPlinth = length (S.filter isPlinthObservation analysisObservations)
     , anHealth     = calculatedHealth
     }
   where
@@ -131,6 +140,8 @@ summary AnalysisNumbers{..} = unlines
     , mid
     , alignText "Total found observations" <> alignNum anFoundObs
     , mid
+    , alignText "Total Plinth observations" <> alignNum anFoundPlinth
+    , mid
     , alignText "Total ignored observations" <> alignNum anIgnoredObs
     , mid
     , alignText "Project health" <> alignVal (prettyHealth anHealth)