[#100] Add docs for luck (and other menu items at the same time)

Alex-At-Home · Jul 17, 2020 · 972eba8 · 972eba8 · vercel · Jul 17, 2020
1 parent e71e020
commit 972eba8
Show file tree

Hide file tree

Showing 16 changed files with 81 additions and 7 deletions.
diff --git a/src/components/LineupStatsTable.tsx b/src/components/LineupStatsTable.tsx
@@ -55,6 +55,12 @@ type Props = {
 
 const LineupStatsTable: React.FunctionComponent<Props> = ({lineupStats, teamStats, rosterStats, startingState, onChangeState}) => {
 
+  const server = (typeof window === `undefined`) ? //(ensures SSR code still compiles)
+    "server" : window.location.hostname
+
+  /** Only show help for diagnstic on/off on main page */
+  const showHelp = !_.startsWith(server, "cbb-on-off-analyzer");
+
   // 1] Data Model
 
   // 2] State
@@ -270,6 +276,7 @@ const LineupStatsTable: React.FunctionComponent<Props> = ({lineupStats, teamStat
             offLuck={luckAdj[0]}
             defLuck={luckAdj[1]}
             baseline={luckConfig.base}
+            showHelp={showHelp}
           />, "small pt-2"
         ) ] : [] ,
         [ GenericTableOps.buildRowSeparator() ]
@@ -382,6 +389,7 @@ const LineupStatsTable: React.FunctionComponent<Props> = ({lineupStats, teamStat
         onHide={() => setShowLuckConfig(false)}
         onSave={(l: LuckParams) => setLuckConfig(l)}
         luck={luckConfig}
+        showHelp={showHelp}
       />
       <Form.Row>
         <Form.Group as={Col} sm="8">
@@ -414,6 +422,7 @@ const LineupStatsTable: React.FunctionComponent<Props> = ({lineupStats, teamStat
               text="Adjust for Luck"
               truthVal={adjustForLuck}
               onSelect={() => setAdjustForLuck(!adjustForLuck)}
+              helpLink={showHelp ? "https://hoop-explorer.blogspot.com/2020/07/luck-adjustment-details.html" : undefined}
             />
             <Dropdown.Divider />
             <GenericTogglingMenuItem

diff --git a/src/components/RosterStatsTable.tsx b/src/components/RosterStatsTable.tsx
@@ -500,6 +500,7 @@ const RosterStatsTable: React.FunctionComponent<Props> = ({gameFilterParams, tea
               text="Show Positional diagnostics"
               truthVal={showPositionDiags}
               onSelect={() => setShowPositionDiags(!showPositionDiags)}
+              helpLink={showHelp ? "https://hoop-explorer.blogspot.com/2020/05/classifying-college-basketball.html" : undefined}
             />
           </GenericTogglingMenu>
         </Form.Group>

diff --git a/src/components/TeamReportStatsTable.tsx b/src/components/TeamReportStatsTable.tsx
@@ -560,11 +560,13 @@ const TeamReportStatsTable: React.FunctionComponent<Props> = ({lineupReport, sta
               text={<span>Show replacement On-Off <span className="badge badge-pill badge-info">alpha!</span></span>}
               truthVal={incReplacementOnOff}
               onSelect={() => setIncReplacementOnOff(!incReplacementOnOff)}
+              helpLink={showHelp ? "https://hoop-explorer.blogspot.com/2020/04/replacement-on-off-heres-elevator-pitch.html" : undefined}
             />
             <GenericTogglingMenuItem
               text={<span>Show RAPM <span className="badge badge-pill badge-info">experimental!</span></span>}
               truthVal={incRapm}
               onSelect={() => setIncRapm(!incRapm)}
+              helpLink={showHelp ? "https://hoop-explorer.blogspot.com/2020/03/understanding-team-report-onoff-page.html#RAPM" : undefined}
             />
             <Dropdown.Divider />
             <GenericTogglingMenuItem

diff --git a/src/components/TeamStatsTable.tsx b/src/components/TeamStatsTable.tsx
@@ -51,6 +51,12 @@ type Props = {
 
 const TeamStatsTable: React.FunctionComponent<Props> = ({gameFilterParams, teamStats, rosterStats, onChangeState}) => {
 
+  const server = (typeof window === `undefined`) ? //(ensures SSR code still compiles)
+    "server" : window.location.hostname
+
+  /** Only show help for diagnstic on/off on main page */
+  const showHelp = !_.startsWith(server, "cbb-on-off-analyzer");
+
   // 1] Data Model
 
   const [ adjustForLuck, setAdjustForLuck ] = useState(_.isNil(gameFilterParams.onOffLuck) ?
@@ -145,6 +151,7 @@ const TeamStatsTable: React.FunctionComponent<Props> = ({gameFilterParams, teamS
           offLuck={luckAdjustment.on[0]}
           defLuck={luckAdjustment.on[1]}
           baseline={luckConfig.base}
+          showHelp={showHelp}
         />, "small pt-2"
       ) ] : [] ,
       [ GenericTableOps.buildRowSeparator() ]
@@ -158,6 +165,7 @@ const TeamStatsTable: React.FunctionComponent<Props> = ({gameFilterParams, teamS
           offLuck={luckAdjustment.off[0]}
           defLuck={luckAdjustment.off[1]}
           baseline={luckConfig.base}
+          showHelp={showHelp}
         />, "small pt-2"
       ) ] : [] ,
       [ GenericTableOps.buildRowSeparator() ]
@@ -171,6 +179,7 @@ const TeamStatsTable: React.FunctionComponent<Props> = ({gameFilterParams, teamS
           offLuck={luckAdjustment.baseline[0]}
           defLuck={luckAdjustment.baseline[1]}
           baseline={luckConfig.base}
+          showHelp={showHelp}
         />, "small pt-2"
       ) ] : [] ,
       [ GenericTableOps.buildRowSeparator() ]
@@ -200,6 +209,7 @@ const TeamStatsTable: React.FunctionComponent<Props> = ({gameFilterParams, teamS
         onHide={() => setShowLuckConfig(false)}
         onSave={(l: LuckParams) => setLuckConfig(l)}
         luck={luckConfig}
+        showHelp={showHelp}
       />
       <Form.Row>
         <Col sm="11"/>
@@ -209,6 +219,7 @@ const TeamStatsTable: React.FunctionComponent<Props> = ({gameFilterParams, teamS
               text="Adjust for Luck"
               truthVal={adjustForLuck}
               onSelect={() => setAdjustForLuck(!adjustForLuck)}
+              helpLink={showHelp ? "https://hoop-explorer.blogspot.com/2020/07/luck-adjustment-details.html" : undefined}
             />
             <Dropdown.Divider />
             <GenericTogglingMenuItem

diff --git a/src/components/__tests__/__snapshots__/LineupStatsTable.test.tsx.snap b/src/components/__tests__/__snapshots__/LineupStatsTable.test.tsx.snap
@@ -17,6 +17,7 @@ exports[`LineupStatsTable LineupStatsTable - should create snapshot (no individu
       onHide={[Function]}
       onSave={[Function]}
       show={false}
+      showHelp={true}
     />
     <FormRow>
       <FormGroup
@@ -70,6 +71,7 @@ exports[`LineupStatsTable LineupStatsTable - should create snapshot (no individu
             truthVal={false}
           />
           <GenericTogglingMenuItem
+            helpLink="https://hoop-explorer.blogspot.com/2020/07/luck-adjustment-details.html"
             onSelect={[Function]}
             text="Adjust for Luck"
             truthVal={false}
@@ -5578,6 +5580,7 @@ exports[`LineupStatsTable LineupStatsTable - should create snapshot (with indivi
       onHide={[Function]}
       onSave={[Function]}
       show={false}
+      showHelp={true}
     />
     <FormRow>
       <FormGroup
@@ -5631,6 +5634,7 @@ exports[`LineupStatsTable LineupStatsTable - should create snapshot (with indivi
             truthVal={false}
           />
           <GenericTogglingMenuItem
+            helpLink="https://hoop-explorer.blogspot.com/2020/07/luck-adjustment-details.html"
             onSelect={[Function]}
             text="Adjust for Luck"
             truthVal={true}
@@ -6850,6 +6854,7 @@ exports[`LineupStatsTable LineupStatsTable - should create snapshot (with indivi
                       "samplePoss": 196,
                     }
                   }
+                  showHelp={true}
                 />,
               },
               GenericTableSeparator {
@@ -7562,6 +7567,7 @@ exports[`LineupStatsTable LineupStatsTable - should create snapshot (with indivi
                       "samplePoss": 111,
                     }
                   }
+                  showHelp={true}
                 />,
               },
               GenericTableSeparator {
@@ -8274,6 +8280,7 @@ exports[`LineupStatsTable LineupStatsTable - should create snapshot (with indivi
                       "samplePoss": 102,
                     }
                   }
+                  showHelp={true}
                 />,
               },
               GenericTableSeparator {
@@ -8562,6 +8569,7 @@ exports[`LineupStatsTable LineupStatsTable - should create snapshot (with indivi
       onHide={[Function]}
       onSave={[Function]}
       show={false}
+      showHelp={true}
     />
     <FormRow>
       <FormGroup
@@ -8615,6 +8623,7 @@ exports[`LineupStatsTable LineupStatsTable - should create snapshot (with indivi
             truthVal={false}
           />
           <GenericTogglingMenuItem
+            helpLink="https://hoop-explorer.blogspot.com/2020/07/luck-adjustment-details.html"
             onSelect={[Function]}
             text="Adjust for Luck"
             truthVal={false}

diff --git a/src/components/__tests__/__snapshots__/RosterStatsTable.test.tsx.snap b/src/components/__tests__/__snapshots__/RosterStatsTable.test.tsx.snap
@@ -578,6 +578,7 @@ exports[`RosterStatsTable RosterStatsTable (!expanded) - should create snapshot
             truthVal={false}
           />
           <GenericTogglingMenuItem
+            helpLink="https://hoop-explorer.blogspot.com/2020/05/classifying-college-basketball.html"
             onSelect={[Function]}
             text="Show Positional diagnostics"
             truthVal={false}
@@ -2654,6 +2655,7 @@ exports[`RosterStatsTable RosterStatsTable (baseline only, !expanded) - should c
             truthVal={false}
           />
           <GenericTogglingMenuItem
+            helpLink="https://hoop-explorer.blogspot.com/2020/05/classifying-college-basketball.html"
             onSelect={[Function]}
             text="Show Positional diagnostics"
             truthVal={false}
@@ -4109,6 +4111,7 @@ exports[`RosterStatsTable RosterStatsTable (baseline only, expanded) - should cr
             truthVal={false}
           />
           <GenericTogglingMenuItem
+            helpLink="https://hoop-explorer.blogspot.com/2020/05/classifying-college-basketball.html"
             onSelect={[Function]}
             text="Show Positional diagnostics"
             truthVal={false}
@@ -6074,6 +6077,7 @@ exports[`RosterStatsTable RosterStatsTable (expanded) - should create snapshot 1
             truthVal={false}
           />
           <GenericTogglingMenuItem
+            helpLink="https://hoop-explorer.blogspot.com/2020/05/classifying-college-basketball.html"
             onSelect={[Function]}
             text="Show Positional diagnostics"
             truthVal={false}

diff --git a/src/components/__tests__/__snapshots__/TeamReportStatsTable.test.tsx.snap b/src/components/__tests__/__snapshots__/TeamReportStatsTable.test.tsx.snap
@@ -1637,6 +1637,7 @@ exports[`TeamReportStatsTable TeamReportStatsTable - should create snapshot (all
               truthVal={true}
             />
             <GenericTogglingMenuItem
+              helpLink="https://hoop-explorer.blogspot.com/2020/04/replacement-on-off-heres-elevator-pitch.html"
               onSelect={[Function]}
               text={
                 <span>
@@ -1651,6 +1652,7 @@ exports[`TeamReportStatsTable TeamReportStatsTable - should create snapshot (all
               truthVal={true}
             />
             <GenericTogglingMenuItem
+              helpLink="https://hoop-explorer.blogspot.com/2020/03/understanding-team-report-onoff-page.html#RAPM"
               onSelect={[Function]}
               text={
                 <span>
@@ -16148,6 +16150,7 @@ exports[`TeamReportStatsTable TeamReportStatsTable - should create snapshot (rep
               truthVal={true}
             />
             <GenericTogglingMenuItem
+              helpLink="https://hoop-explorer.blogspot.com/2020/04/replacement-on-off-heres-elevator-pitch.html"
               onSelect={[Function]}
               text={
                 <span>
@@ -16162,6 +16165,7 @@ exports[`TeamReportStatsTable TeamReportStatsTable - should create snapshot (rep
               truthVal={true}
             />
             <GenericTogglingMenuItem
+              helpLink="https://hoop-explorer.blogspot.com/2020/03/understanding-team-report-onoff-page.html#RAPM"
               onSelect={[Function]}
               text={
                 <span>
@@ -53453,6 +53457,7 @@ exports[`TeamReportStatsTable TeamReportStatsTable - should create snapshot (rep
               truthVal={true}
             />
             <GenericTogglingMenuItem
+              helpLink="https://hoop-explorer.blogspot.com/2020/04/replacement-on-off-heres-elevator-pitch.html"
               onSelect={[Function]}
               text={
                 <span>
@@ -53467,6 +53472,7 @@ exports[`TeamReportStatsTable TeamReportStatsTable - should create snapshot (rep
               truthVal={true}
             />
             <GenericTogglingMenuItem
+              helpLink="https://hoop-explorer.blogspot.com/2020/03/understanding-team-report-onoff-page.html#RAPM"
               onSelect={[Function]}
               text={
                 <span>
@@ -57508,6 +57514,7 @@ exports[`TeamReportStatsTable TeamReportStatsTable - should create snapshot 1`]
               truthVal={true}
             />
             <GenericTogglingMenuItem
+              helpLink="https://hoop-explorer.blogspot.com/2020/04/replacement-on-off-heres-elevator-pitch.html"
               onSelect={[Function]}
               text={
                 <span>
@@ -57522,6 +57529,7 @@ exports[`TeamReportStatsTable TeamReportStatsTable - should create snapshot 1`]
               truthVal={false}
             />
             <GenericTogglingMenuItem
+              helpLink="https://hoop-explorer.blogspot.com/2020/03/understanding-team-report-onoff-page.html#RAPM"
               onSelect={[Function]}
               text={
                 <span>

diff --git a/src/components/diags/LuckAdjDiagView.tsx b/src/components/diags/LuckAdjDiagView.tsx
@@ -29,9 +29,10 @@ type Props = {
   offLuck: OffLuckAdjustmentDiags,
   defLuck: DefLuckAdjustmentDiags,
   baseline: LuckAdjustmentBaseline,
+  showHelp: boolean,
   showDetailsOverride?: boolean
 };
-const LuckAdjDiagView: React.FunctionComponent<Props> = ({name, offLuck, defLuck, baseline, showDetailsOverride}) => {
+const LuckAdjDiagView: React.FunctionComponent<Props> = ({name, offLuck, defLuck, baseline, showHelp, showDetailsOverride}) => {
 
   const topRef = React.createRef<HTMLDivElement>();
 
@@ -45,6 +46,7 @@ const LuckAdjDiagView: React.FunctionComponent<Props> = ({name, offLuck, defLuck
   return <span ref={topRef}>
       <span>
         <b>Luck Adjustment diagnostics [{name}]</b>
+        {showHelp ? <span> <a target="_blank" href="https://hoop-explorer.blogspot.com/2020/07/luck-adjustment-details.html">(?)</a></span> : null}
         &nbsp;off=[<b>{o.deltaOffAdjEff.toFixed(1)}</b>], def=[<b>{d.deltaDefAdjEff.toFixed(1)}</b>], margin=[<b>{(o.deltaOffAdjEff - d.deltaDefAdjEff).toFixed(1)}</b>] pts/100
         &nbsp;(<a href="#" onClick={(event) => { event.preventDefault(); setShowDetails(!showDetails) }}>show {showDetails ? "less" : "more"}</a>)
       </span>

diff --git a/src/components/diags/__tests__/LuckAdjDiagView.test.tsx b/src/components/diags/__tests__/LuckAdjDiagView.test.tsx
@@ -14,6 +14,7 @@ describe("LuckAdjDiagView", () => {
         offLuck={sampleOffOnOffLuckDiagnostics}
         defLuck={sampleDefOnOffLuckDiagnostics}
         baseline="season"
+        showHelp={false}
       />
     );
     expect(toJson(wrapper)).toMatchSnapshot();
@@ -26,6 +27,7 @@ describe("LuckAdjDiagView", () => {
         offLuck={sampleOffOnOffLuckDiagnostics}
         defLuck={sampleDefOnOffLuckDiagnostics}
         baseline="baseline"
+        showHelp={true}
         showDetailsOverride={true}
       />
     );

diff --git a/src/components/diags/__tests__/__snapshots__/LuckAdjDiagView.test.tsx.snap b/src/components/diags/__tests__/__snapshots__/LuckAdjDiagView.test.tsx.snap
@@ -8,6 +8,15 @@ exports[`LuckAdjDiagView LuckAdjDiagView - should create snapshot (baseline, ove
       Test2
       ]
     </b>
+    <span>
+       
+      <a
+        href="https://hoop-explorer.blogspot.com/2020/07/luck-adjustment-details.html"
+        target="_blank"
+      >
+        (?)
+      </a>
+    </span>
      off=[
     <b>
       -1.8

diff --git a/src/components/shared/GenericTogglingMenuItem.tsx b/src/components/shared/GenericTogglingMenuItem.tsx
@@ -19,14 +19,16 @@ import { faCheck } from '@fortawesome/free-solid-svg-icons'
 type Props = {
   readonly text: string | React.ReactNode,
   readonly truthVal: boolean,
-  readonly onSelect: () => void
+  readonly onSelect: () => void,
+  readonly helpLink?: string
 };
 
-const GenericTogglingMenuItem: React.FunctionComponent<Props> = ({text, truthVal, onSelect}) => {
+const GenericTogglingMenuItem: React.FunctionComponent<Props> = ({text, truthVal, onSelect, helpLink}) => {
 
   return <Dropdown.Item as={Button}>
-      <div onClick={() => onSelect()}>
+      <div onClick={(e: any) => { if (!e.target.href) onSelect() }}>
         {_.isString(text) ? <span>{text}</span> : text}
+        {helpLink ? <span>&nbsp;<a  target="_blank" href={helpLink}>(?)</a></span> : null}
         <span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
         {truthVal ? <FontAwesomeIcon icon={faCheck}/> : null}
       </div>

diff --git a/src/components/shared/LuckConfigModal.tsx b/src/components/shared/LuckConfigModal.tsx
@@ -23,15 +23,18 @@ type Props = {
   show: boolean,
   onHide: () => void,
   onSave: (luck: LuckParams) => void,
-  luck: LuckParams
+  luck: LuckParams,
+  showHelp: boolean
 };
-const LuckConfigModal: React.FunctionComponent<Props> = ({onSave, luck, ...props}) => {
+const LuckConfigModal: React.FunctionComponent<Props> = ({onSave, luck, showHelp, ...props}) => {
 
   // State decomposition:
   const [ generalLuckBase, setGeneralLuckBase ] = useState(luck.base as "baseline" | "season");
   return <Modal {...props}>
     <Modal.Header closeButton>
-      <Modal.Title>Luck Adjustment Config</Modal.Title>
+      <Modal.Title>Luck Adjustment Config</Modal.Title>&nbsp;{showHelp ?
+        <a target="_blank" href="https://hoop-explorer.blogspot.com/2020/07/luck-adjustment-details.html">(?)</a> : null
+      }
     </Modal.Header>
     <Modal.Body>
       <Card className="w-100">

diff --git a/src/components/shared/__tests__/GenericTogglingMenu.test.tsx b/src/components/shared/__tests__/GenericTogglingMenu.test.tsx
@@ -32,6 +32,7 @@ describe("GenericTogglingMenu", () => {
           text="Test2"
           truthVal={true}
           onSelect={() => ""}
+          helpLink="https://test.com"
         />
         <GenericTogglingMenuItem
           text={<span>Test3</span>}

diff --git a/src/components/shared/__tests__/LuckConfigModal.test.tsx b/src/components/shared/__tests__/LuckConfigModal.test.tsx
@@ -15,6 +15,7 @@ describe("LuckConfigModal", () => {
           onHide={() => {}}
           onSave={(l: LuckParams) => {}}
           luck={{base: "baseline"}}
+          showHelp={true}
         />
       </div>
     );