Sorting in GlassBR (#899)

* Sorted Table of Aux Constants in Glass and SWHS as per #886 * Moved compareBySymbol to docLang to be reused; sorted Input Data Constraints - closes #864 * Moved sortBy in GlassBR to sortBySymbol in Misc to be used in docLang for all examples
JacquesCarette · Jul 23, 2018 · df9f936 · df9f936
1 parent f08608d
commit df9f936
Show file tree

Hide file tree

Showing 24 changed files with 417 additions and 403 deletions.
diff --git a/code/drasil-code/drasil-code.cabal b/code/drasil-code/drasil-code.cabal
@@ -37,7 +37,7 @@ library
  split >= 0.2.3.1,
  MissingH >= 1.4.0.1,
  parsec >= 3.1.9,
- drasil-lang >= 0.1.5
+ drasil-lang >= 0.1.6
  default-language: Haskell2010
  ghc-options: -Wall -O2
 

diff --git a/code/drasil-data/drasil-data.cabal b/code/drasil-data/drasil-data.cabal
@@ -45,7 +45,7 @@ library
  MissingH >= 1.4.0.1,
  parsec >= 3.1.9,
  data-fix (>= 0.0.4 && <= 1.0),
- drasil-lang >= 0.1.5
+ drasil-lang >= 0.1.6
  default-language: Haskell2010
  ghc-options: -Wall
 

diff --git a/code/drasil-docLang/Drasil/DocLang.hs b/code/drasil-docLang/Drasil/DocLang.hs
@@ -8,8 +8,8 @@ module Drasil.DocLang (
  SCSSub(..), SSDSec(..), SSDSub(..), SolChSpec(..), ExistingSolnSec(..),
  StkhldrSec(StkhldrProg2),
  StkhldrSub(Client, Cstmr), TConvention(..), TraceabilitySec(TraceabilityProg), 
- TSIntro(..), UCsSec(..), mkDoc, mkLklyChnk, mkRequirement, mkUnLklyChnk, 
- tsymb, tsymb'',
+ TSIntro(..), UCsSec(..), mkDoc, mkLklyChnk, mkRequirement, 
+ mkUnLklyChnk, tsymb, tsymb'',
  -- DocumentLanguage.Definitions
  Field(..), Fields, InclUnits(IncludeUnits), Verbosity(Verbose),
  -- DocumentLanguage.RefHelpers 
@@ -40,14 +40,14 @@ module Drasil.DocLang (
  ) where 
 
 import Drasil.DocumentLanguage (AppndxSec(..), AuxConstntSec(..), 
- DerivationDisplay(..), DocDesc, DocSection(..), Emphasis(..), GSDSec(GSDProg2), 
- GSDSub(UsrChars, SystCons, SysCntxt), IntroSec(..), IntroSub(..), LCsSec(..), LFunc(..), 
- Literature(Doc', Lit, Manual), ProblemDescription(..), RefSec(..), RefTab(..), 
- ReqrmntSec(..), ReqsSub(FReqsSub, NonFReqsSub), ScpOfProjSec(ScpOfProjProg), 
- SCSSub(..), SSDSec(..), SSDSub(..), SolChSpec(..), StkhldrSec(StkhldrProg2), 
- StkhldrSub(Client, Cstmr), TConvention(..), TraceabilitySec(TraceabilityProg), 
- TSIntro(..), UCsSec(..), mkDoc, mkLklyChnk, mkRequirement, mkUnLklyChnk, 
- tsymb, tsymb'', ExistingSolnSec(..))
+ DerivationDisplay(..), DocDesc, DocSection(..), Emphasis(..), ExistingSolnSec(..), 
+ GSDSec(GSDProg2), GSDSub(UsrChars, SystCons, SysCntxt), IntroSec(..), IntroSub(..), 
+ LCsSec(..), LFunc(..), Literature(Doc', Lit, Manual), ProblemDescription(..), 
+ RefSec(..), RefTab(..), ReqrmntSec(..), ReqsSub(FReqsSub, NonFReqsSub), 
+ ScpOfProjSec(ScpOfProjProg), SCSSub(..), SSDSec(..), SSDSub(..), SolChSpec(..), 
+ StkhldrSec(StkhldrProg2), StkhldrSub(Client, Cstmr), TConvention(..), 
+ TraceabilitySec(TraceabilityProg), TSIntro(..), UCsSec(..), mkDoc, 
+ mkLklyChnk, mkRequirement, mkUnLklyChnk, tsymb, tsymb'')
 import Drasil.DocumentLanguage.Definitions (Field(..), Fields, 
  InclUnits(IncludeUnits), Verbosity(Verbose))
 import Drasil.DocumentLanguage.RefHelpers (ModelDB, cite, ddRefDB, mdb, refA, 

diff --git a/code/drasil-docLang/Drasil/DocumentLanguage.hs b/code/drasil-docLang/Drasil/DocumentLanguage.hs
@@ -40,6 +40,7 @@ import Data.Drasil.Concepts.Documentation (refmat)
 
 import Data.Function (on)
 import Data.List (nub, sortBy)
+import Data.Ord (comparing)
 
 type System = Sentence
 type DocKind = Sentence
@@ -254,7 +255,7 @@ mkSections si l = map doit l
  doit (IntroSec is) = mkIntroSec si is
  doit (StkhldrSec sts) = mkStkhldrSec sts
  doit (SSDSec ss) = mkSSDSec si ss
- doit (AuxConstntSec acs) = mkAuxConsSec acs
+ doit (AuxConstntSec acs) = mkAuxConsSec acs 
  doit Bibliography = mkBib (citeDB si)
  doit (GSDSec gs') = mkGSDSec gs'
  doit (ScpOfProjSec sop) = mkScpOfProjSec sop
@@ -533,7 +534,7 @@ mkExistingSolnSec (ExistSolnProg cs) = SRS.offShelfSol cs []
 -- | Helper for making the 'Values of Auxiliary Constants' section
 mkAuxConsSec :: AuxConstntSec -> Section
 mkAuxConsSec (AuxConsVerb s) = s
-mkAuxConsSec (AuxConsProg key listOfCons) = AC.valsOfAuxConstantsF key listOfCons
+mkAuxConsSec (AuxConsProg key listOfCons) = AC.valsOfAuxConstantsF key $ sortBySymbol listOfCons
 
 {--}
 

diff --git a/code/drasil-docLang/Drasil/Sections/SolutionCharacterSpec.hs b/code/drasil-docLang/Drasil/Sections/SolutionCharacterSpec.hs
@@ -26,10 +26,10 @@ import Data.Drasil.SentenceStructures (ofThe, foldlSP, foldlSent, foldlList, sAn
 import qualified Data.Drasil.Concepts.Documentation as Doc
 import Data.List (find)
 import Control.Lens ((^.))
-import Drasil.Sections.SpecificSystemDescription (inDataConstTbl, outDataConstTbl,
- listofTablesToRefs)
 
 import Drasil.Sections.GeneralSystDesc(genSysIntro)
+import Drasil.Sections.SpecificSystemDescription (inDataConstTbl, outDataConstTbl,
+ listofTablesToRefs)
 
 import qualified Drasil.DocLang.SRS as SRS
 

diff --git a/code/drasil-docLang/Drasil/Sections/SpecificSystemDescription.hs b/code/drasil-docLang/Drasil/Sections/SpecificSystemDescription.hs
@@ -27,6 +27,8 @@ import Data.Drasil.Concepts.Software (program)
 import Data.Drasil.Utils (foldle, fmtU, getRVal)
 import Data.Drasil.SentenceStructures (fmtPhys, fmtSfwr, mkTableFromColumns, foldlSent, 
  foldlSP, typUncr, ofThe, foldlList)
+import Data.List (sortBy)
+
 import qualified Drasil.DocLang.SRS as SRS
 
 
@@ -208,11 +210,11 @@ dataConstraintUncertainty = foldlSent [S "The", phrase uncertainty, phrase colum
 inDataConstTbl :: (UncertainQuantity c, Constrained c, HasReasVal c) => [c] -> Contents
 inDataConstTbl qlst = Table titl cts (S "Input Data Constraints") True "InDataConstraints"
  where
- columns = [(S "Var", map ch qlst),
- (titleize' physicalConstraint, map fmtPhys qlst),
- (titleize' softwareConstraint, map fmtSfwr qlst),
- (S "Typical Value", map (\q -> fmtU (E $ getRVal q) q) qlst),
- (short typUnc, map typUncr qlst)]
+ columns = [(S "Var", map ch $ sortBySymbol qlst),
+ (titleize' physicalConstraint, map fmtPhys $ sortBySymbol qlst),
+ (titleize' softwareConstraint, map fmtSfwr $ sortBySymbol qlst),
+ (S "Typical Value", map (\q -> fmtU (E $ getRVal q) q) $ sortBySymbol qlst),
+ (short typUnc, map typUncr $ sortBySymbol qlst)] 
  tbl = mkTableFromColumns columns
  titl = fst tbl
  cts = snd tbl

diff --git a/code/drasil-docLang/drasil-docLang.cabal b/code/drasil-docLang/drasil-docLang.cabal
@@ -39,7 +39,7 @@ library
  MissingH >= 1.4.0.1,
  parsec >= 3.1.9,
  data-fix (>= 0.0.4 && <= 1.0),
- drasil-lang >= 0.1.5,
+ drasil-lang >= 0.1.6,
  drasil-data >= 0.1.1
  default-language: Haskell2010
  ghc-options: -Wall

diff --git a/code/drasil-example/Drasil/GlassBR/Body.hs b/code/drasil-example/Drasil/GlassBR/Body.hs
@@ -15,8 +15,8 @@ import Drasil.DocLang (AppndxSec(..), AuxConstntSec(..), DerivationDisplay(..),
  ReqsSub(FReqsSub, NonFReqsSub), ScpOfProjSec(ScpOfProjProg), SCSSub(..), 
  SSDSec(..), SSDSub(..), SolChSpec(..), StkhldrSec(StkhldrProg2), 
  StkhldrSub(Client, Cstmr), TraceabilitySec(TraceabilityProg), 
- TSIntro(SymbOrder, TSPurpose), UCsSec(..), Verbosity(Verbose), cite, 
- dataConstraintUncertainty, goalStmtF, inDataConstTbl, intro, mkDoc, 
+ TSIntro(SymbOrder, TSPurpose), UCsSec(..), Verbosity(Verbose), 
+ cite, dataConstraintUncertainty, goalStmtF, inDataConstTbl, intro, mkDoc, 
  mkRequirement, outDataConstTbl, physSystDesc, probDescF, termDefnF, 
  traceGIntro, tsymb)
 

diff --git a/code/drasil-example/drasil-example.cabal b/code/drasil-example/drasil-example.cabal
@@ -19,7 +19,7 @@ executable tiny
  mtl >= 2.2.1,
  directory >= 1.2.6.2,
  split >= 0.2.3.1,
- drasil-lang >= 0.1.5,
+ drasil-lang >= 0.1.6,
  drasil-data >= 0.1.1,
  drasil-code >= 0.1.1,
  drasil-printers >= 0.1.0,
@@ -58,7 +58,7 @@ executable nopcm
  mtl >= 2.2.1,
  directory >= 1.2.6.2,
  split >= 0.2.3.1,
- drasil-lang >= 0.1.5,
+ drasil-lang >= 0.1.6,
  drasil-data >= 0.1.1,
  drasil-code >= 0.1.1,
  drasil-printers >= 0.1.0,
@@ -93,7 +93,7 @@ executable ssp
  mtl >= 2.2.1,
  directory >= 1.2.6.2,
  split >= 0.2.3.1,
- drasil-lang >= 0.1.5,
+ drasil-lang >= 0.1.6,
  drasil-data >= 0.1.1,
  drasil-code >= 0.1.1,
  drasil-printers >= 0.1.0,
@@ -126,7 +126,7 @@ executable glassbr
  mtl >= 2.2.1,
  directory >= 1.2.6.2,
  split >= 0.2.3.1,
- drasil-lang >= 0.1.5,
+ drasil-lang >= 0.1.6,
  drasil-data >= 0.1.1,
  drasil-code >= 0.1.1,
  drasil-printers >= 0.1.0,
@@ -155,7 +155,7 @@ executable chipmunkdocs
  mtl >= 2.2.1,
  directory >= 1.2.6.2,
  split >= 0.2.3.1,
- drasil-lang >= 0.1.5,
+ drasil-lang >= 0.1.6,
  drasil-data >= 0.1.1,
  drasil-code >= 0.1.1,
  drasil-printers >= 0.1.0,
@@ -188,7 +188,7 @@ executable swhs
  pretty >= 1.1.1.1,
  mtl >= 2.2.1,
  directory >= 1.2.6.2,
- drasil-lang >= 0.1.5,
+ drasil-lang >= 0.1.6,
  drasil-data >= 0.1.1,
  drasil-code >= 0.1.1,
  drasil-printers >= 0.1.0,

diff --git a/code/drasil-gen/drasil-gen.cabal b/code/drasil-gen/drasil-gen.cabal
@@ -19,7 +19,7 @@ library
  split >= 0.2.3.1,
  MissingH >= 1.4.0.1,
  parsec >= 3.1.9,
- drasil-lang >= 0.1.5,
+ drasil-lang >= 0.1.6,
  drasil-code >= 0.1.3,
  drasil-printers >= 0.1.0
  default-language: Haskell2010

diff --git a/code/drasil-lang/Language/Drasil.hs b/code/drasil-lang/Language/Drasil.hs
@@ -153,7 +153,7 @@ module Language.Drasil (
  -- Misc
  , mkTable, unit_symb, introduceAbb, phrase, plural, phrase's 
  , plural's, at_start, at_start'
- , unitToSentence, unitToSentenceUnitless
+ , unitToSentence, unitToSentenceUnitless, sortBySymbol
  -- Generate
  --, gen, genCode
  -- People

diff --git a/code/drasil-lang/Language/Drasil/Misc.hs b/code/drasil-lang/Language/Drasil/Misc.hs
@@ -1,12 +1,16 @@
 module Language.Drasil.Misc where
 
-import Language.Drasil.Classes (HasUnitSymbol(usymb), NamedIdea(term), Idea)
+import Language.Drasil.Classes (HasSymbol(symbol), HasUnitSymbol(usymb), 
+ NamedIdea(term), Idea)
 import Language.Drasil.Chunk.NamedIdea (short)
 import Language.Drasil.Chunk.Quantity (Quantity, getUnit)
 import Language.Drasil.Chunk.Unitary (Unitary, unit)
 import Language.Drasil.Spec ((+:+), Sentence((:+:), S, Sy), sParen)
+import Language.Drasil.Symbol (Stage(Implementation), compsy)
 import Language.Drasil.Development.UnitLang (USymb)
 
+import Data.List (sortBy)
+
 import qualified Language.Drasil.NounPhrase as NP
 
 import Control.Lens ((^.))
@@ -85,6 +89,13 @@ noSpaces s
  | not (' ' `elem` s) = s
  | otherwise = error "String has at least one space in it."
 
+-- Sorts a list of HasSymbols by Symbol
+sortBySymbol :: (HasSymbol a) => [a] -> [a]
+sortBySymbol = sortBy compareBySymbol
+ where
+ compareBySymbol :: (HasSymbol a) => a -> a -> Ordering
+ compareBySymbol a b = compsy (symbol a Implementation) (symbol b Implementation)
+
 {-
 --------------------- WIP ---------------------
 Function used to derive the unit of an equation. Takes a Relation, sorts the

diff --git a/code/drasil-lang/drasil-lang.cabal b/code/drasil-lang/drasil-lang.cabal
@@ -1,5 +1,5 @@
 Name: drasil-lang
-Version: 0.1.5
+Version: 0.1.6
 Cabal-Version: >= 1.18
 Author: Dan Szymczak, Steven Palmer, Jacques Carette, Spencer Smith
 build-type: Simple

diff --git a/code/drasil-printers/drasil-printers.cabal b/code/drasil-printers/drasil-printers.cabal
@@ -39,7 +39,7 @@ library
  MissingH >= 1.4.0.1,
  parsec >= 3.1.9,
  data-fix (>= 0.0.4 && <= 1.0),
- drasil-lang >= 0.1.4
+ drasil-lang >= 0.1.6
  default-language: Haskell2010
  ghc-options: -Wall
 

diff --git a/code/stable/gamephys/SRS/Chipmunk_SRS.tex b/code/stable/gamephys/SRS/Chipmunk_SRS.tex
@@ -848,27 +848,27 @@ \subsubsection{Data Constraints}
 Var & Physical Constraints & Typical Value & Uncert.
 \\
 \midrule
-$L$ & $L\geq{}0$ & $44.2$ m & 10.0\%
-\\
-$m$ & $m\geq{}0$ & $56.2$ kg & 10.0\%
+${C_{R}}$ & $0\leq{}{C_{R}}\leq{}1$ & $0.8$ & 10.0\%
 \\
-$\mathbf{I}$ & $\mathbf{I}\geq{}0$ & $74.5$ kg$\text{m}^{2}$ & 10.0\%
+$\mathbf{F}$ & -- & $98.1$ N & 10.0\%
 \\
 $G$ & -- & $9.8$ $\frac{\text{m}^{3}}{(\text{kg}\text{s}^{2})}$ & 10.0\%
 \\
-$\mathbf{p}$ & -- & $0.412$ m & 10.0\%
+$\mathbf{I}$ & $\mathbf{I}\geq{}0$ & $74.5$ kg$\text{m}^{2}$ & 10.0\%
 \\
-$ϕ$ & -- & $\frac{π}{2}$ rad & 10.0\%
+$L$ & $L\geq{}0$ & $44.2$ m & 10.0\%
 \\
-$\mathbf{v}$ & -- & $2.51$ $\frac{\text{m}}{\text{s}}$ & 10.0\%
+$m$ & $m\geq{}0$ & $56.2$ kg & 10.0\%
 \\
-$ω$ & -- & $2.1$ $\frac{\text{rad}}{\text{s}}$ & 10.0\%
+$\mathbf{p}$ & -- & $0.412$ m & 10.0\%
 \\
-$\mathbf{F}$ & -- & $98.1$ N & 10.0\%
+$\mathbf{v}$ & -- & $2.51$ $\frac{\text{m}}{\text{s}}$ & 10.0\%
 \\
 $τ$ & -- & $200.0$ Nm & 10.0\%
 \\
-${C_{R}}$ & $0\leq{}{C_{R}}\leq{}1$ & $0.8$ & 10.0\%
+$ω$ & -- & $2.1$ $\frac{\text{rad}}{\text{s}}$ & 10.0\%
+\\
+$ϕ$ & -- & $\frac{π}{2}$ rad & 10.0\%
 \\
 \bottomrule
 \caption{Input Data Constraints}