decider-ref 1.22.2__tar.gz

decider_ref-1.22.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Helmut Konrad Schewe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

decider_ref-1.22.2/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: decider-ref
+Version: 1.22.2
+Author-email: Helmut Konrad Schewe <helmutus@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/anaticulae/decider-ref
+Project-URL: Repository, https://github.com/anaticulae/decider-ref
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: analp<2.0.0,>=1.0.0
+Requires-Dist: captions<2.0.0,>=1.0.1
+Requires-Dist: configos<2.0.0,>=1.0.4
+Requires-Dist: elementae<2.0.0,>=1.0.1
+Requires-Dist: iamraw<5.0.0,>=4.95.0
+Requires-Dist: konradus<2.0.0,>=1.0.1
+Requires-Dist: protoerror<4.0.0,>=3.20.4
+Requires-Dist: texes<2.0.0,>=1.0.1
+Requires-Dist: upainter<2.0.0,>=1.0.0
+Requires-Dist: utilo<3.0.0,>=2.110.2
+Requires-Dist: verbo<2.0.0,>=1.23.4
+Requires-Dist: writers<2.0.0,>=1.7.1
+Provides-Extra: dev
+Requires-Dist: callidus==1.7.1; extra == "dev"
+Requires-Dist: capita==1.25.3; extra == "dev"
+Requires-Dist: capita_ref==1.0.1; extra == "dev"
+Requires-Dist: codero==1.0.1; extra == "dev"
+Requires-Dist: decider-chapter==1.0.1; extra == "dev"
+Requires-Dist: figureo==1.0.1; extra == "dev"
+Requires-Dist: formulero==1.0.0; extra == "dev"
+Requires-Dist: gennex==1.1.0; extra == "dev"
+Requires-Dist: headnote==1.0.3; extra == "dev"
+Requires-Dist: hoverpower==1.7.0; extra == "dev"
+Requires-Dist: ibidem==1.0.2; extra == "dev"
+Requires-Dist: indagator==1.0.2; extra == "dev"
+Requires-Dist: indicibus==1.0.2; extra == "dev"
+Requires-Dist: jamer==1.0.2; extra == "dev"
+Requires-Dist: mundare==1.0.2; extra == "dev"
+Requires-Dist: pagenumber==1.0.0; extra == "dev"
+Requires-Dist: protoerror==3.20.4; extra == "dev"
+Requires-Dist: reftable==1.0.0; extra == "dev"
+Requires-Dist: tablero==1.0.1; extra == "dev"
+Requires-Dist: titulum==1.0.2; extra == "dev"
+Requires-Dist: utilotest==1.1.1; extra == "dev"
+Dynamic: license-file
+
+# reference

decider_ref-1.22.2/README

@@ -0,0 +1 @@
+# reference

decider_ref-1.22.2/decider_abb/__init__.py

@@ -0,0 +1,29 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+"""Abbreviation Analyzer
+=====================
+
+* verify order/sorted
+* check obvious abbrevation and give advice to delete abbreviation
+
+TODO: INFORM ABOUT NOT USED ABBREVIATION
+TODO: VERIFY FIRST USAGE
+"""
+
+import configos
+
+import decider_abb.path
+import decider_ref
+
+__version__ = decider_ref.__version__
+
+ROOT = decider_ref.ROOT
+PROCESS = 'decider_abbrev'
+
+configos.cloud_lookup(PROCESS)

decider_ref-1.22.2/decider_abb/cli.py

@@ -0,0 +1,46 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import protoerror
+import utilo
+
+import decider_abb
+
+DESCRIPTION = ''
+
+WORKPLAN = [
+    utilo.create_step(
+        'table',
+        [
+            utilo.ResultFile('reftable', 'abbrev_abbrev'),
+            utilo.ResultFile('words', 'abbreviation_detected'),
+        ],
+        output=protoerror.ResultDefault,
+    ),
+]
+
+
+def main():
+    hook = protoerror.integrate(
+        root=decider_abb.ROOT,
+        features='decider_abb.features',
+    )
+    utilo.featurepack(
+        workplan=WORKPLAN,
+        root=decider_abb.ROOT,
+        featurepackage='decider_abb.features',
+        config=utilo.FeaturePackConfig(
+            cli_hook=hook,
+            description=DESCRIPTION,
+            multiprocessed=True,
+            name=decider_abb.PROCESS,
+            pages=True,
+            version=decider_abb.__version__,
+        ),
+    )

decider_ref-1.22.2/decider_abb/features/__init__.py

@@ -0,0 +1,8 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================

decider_ref-1.22.2/decider_abb/features/table.py

@@ -0,0 +1,147 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import iamraw
+import konradus
+import protoerror
+import serializeraw
+import utilo
+
+import decider_ref.listdiff
+
+
+def work(
+    abbrev: str,
+    intext: str,
+    pages: tuple = None,
+) -> protoerror.ResultType:
+    driver = create_driver(
+        abbrev,
+        intext,
+        pages=pages,
+    )
+    result = protoerror.run(
+        __name__,
+        driver,
+    )
+    return result
+
+
+def create_driver(abbrev: str, intext: str, pages: tuple = None):
+    if utilo.exists(abbrev):
+        table = serializeraw.load_abbreviation_table(abbrev)
+    else:
+        table = iamraw.AbbreviationResult()
+    intext = serializeraw.load_text_abbreviations(intext, pages=pages)
+    driver = protoerror.driver(
+        abbrevtable=table,
+        intext=intext,
+    )
+    return driver
+
+
+SOLUTION_15010 = """\
+Abkürzungsverzeichnis nicht alphabetisch sortiert
+
+Sortieren Sie das Abkürzungsverzeichnis.
+
+{{advice}}
+
+{elemente/abkuerzungsverzeichnis#alphabetische-sortierung}
+"""
+
+
+def check_15010_not_sorted_alphabetically(linter: callable, driver):
+    abbreviations: iamraw.AbbreviationResult = driver.abbrevtable
+    current = list(abbreviations)
+    expected = sorted(
+        abbreviations,
+        key=lambda x: utilo.alphabetically(x.short),
+    )
+    if current == expected:
+        # well sorted
+        return
+    location = pagelocation(current[0])
+    # prepare viewable format
+    current = [format_abbreviation_line(item) for item in current]
+    expected = [format_abbreviation_line(item) for item in expected]
+    advice = decider_ref.listdiff.diffview(expected, current)
+    linter(
+        advice=advice,
+        location=location,
+    )
+
+
+SOLUTION_R15015 = """\
+Allgemein gültige Abkürzung
+
+Die Abkürzung {{abbreviation}} kann als allgemein gültig angenommen werden und \
+muss nicht separat aufgeführt werden. Entfernen Sie die Abkürzung um die \
+Übersichtlichkeit des Abkürzungsverzeichnisses zu erhöhen.
+
+{elemente/abkuerzungsverzeichnis#abkurzungsverzeichnis}
+"""
+
+
+def check_15015_abbreviation_not_required(linter: callable, driver):
+    """Inform user to remove common abbreviation (exists in DUDEN)."""
+    abbreviations: iamraw.AbbreviationResult = driver.abbrevtable
+    for item in abbreviations:
+        name = item.short.lower()
+        if name not in konradus.ABBREVIATION_LOWER:
+            continue
+        linter(
+            abbreviation=item.short,
+            location=pagelocation(item),
+        )
+
+
+SOLUTION_R15016 = """\
+Abkürzung nicht vorhanden
+
+Die Abkürzung **{{abbrev}}** ist nicht im Abkürzungsverzeichnis aufgeführt.
+
+{elemente/abkuerzungsverzeichnis#abkurzungsverzeichnis}
+"""
+
+
+def check_15016_abbreviation_missing(linter: callable, driver):
+    abbreviations: iamraw.AbbreviationResult = driver.abbrevtable
+    if len(abbreviations) == 0:  # pylint:disable=compare-to-zero
+        protoerror.skip_method('no abbreviation table')
+        return
+    references = utilo.flatten_content(driver.intext)
+    references = [
+        item for item in references
+        if item.short.lower() not in konradus.ABBREVIATION_LOWER
+    ]
+    single = utilo.Single()
+    collected = [
+        item for item in references if not single.contains(item.short.lower())
+    ]
+    pdfpage = abbreviations.pdfpages[0]
+    location = iamraw.Location.from_page(page=pdfpage)
+    for item in collected:
+        if abbreviations.short_inside(item.short):
+            continue
+        linter(
+            abbrev=item.short,
+            location=location,
+        )
+
+
+def format_abbreviation_line(item) -> str:
+    return f' * {item.short} {item.description}'
+
+
+def pagelocation(item) -> iamraw.Location:
+    pagenumber = protoerror.OVERVIEW
+    if item.position:
+        pagenumber = iamraw.Location.from_page(item.position.page)
+    return pagenumber

decider_ref-1.22.2/decider_abb/path.py

@@ -0,0 +1,16 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import utilo
+
+import decider_abb
+
+
+def decider_abb_table_user(path: str, prefix: str = '') -> str:
+    return utilo.pathconnector(path, decider_abb.PROCESS, 'table_user', prefix)

decider_ref-1.22.2/decider_bib/__init__.py

@@ -0,0 +1,19 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import configos
+
+# ease importing path module when using decider_bib
+import decider_bib.path
+import decider_ref
+
+ROOT = decider_ref.ROOT
+PROCESS = 'decider_bibliography'
+
+configos.cloud_lookup(PROCESS)

decider_ref-1.22.2/decider_bib/cli.py

@@ -0,0 +1,75 @@
+#==============================================================================
+# C O P Y R I G H T
+#------------------------------------------------------------------------------
+# Copyright (c) 2019-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+#==============================================================================
+
+import protoerror
+import utilo
+
+import decider_bib
+import decider_ref
+
+DESCRIPTION = ''
+
+USER = 'user'
+DEVELOPER = 'developer'
+
+WORKPLAN = [
+    utilo.create_step(
+        'label',
+        [
+            utilo.ResultFile('detector', 'bibliography_detected'),
+            utilo.ResultFile('docref', 'bibliography_parsed'),
+            utilo.ResultFile('words', 'headlines_headlines'),
+            utilo.ResultFile('words', 'sentences_sentences'),
+            utilo.ResultFile('sections', 'section_result'),
+        ],
+        (USER, DEVELOPER),
+    ),
+    utilo.create_step(
+        'table',
+        [
+            utilo.ResultFile('detector', 'bibliography_detected'),
+            utilo.ResultFile('detector', 'titlepage_detected'),
+            utilo.File('pdflog'),
+        ],
+        (USER, DEVELOPER),
+    ),
+    utilo.create_step(
+        name='plot',
+        inputs=[
+            utilo.ResultFile('detector', 'bibliography_detected'),
+        ],
+        output=[
+            ('year_histogram', 'png'),
+        ],
+    ),
+]
+
+
+def main():
+    hook = protoerror.integrate(
+        root=decider_ref.ROOT,
+        features='decider_bib.features',
+    )
+    docinfo = protoerror.integrate_docinfo()
+    utilo.featurepack(
+        workplan=WORKPLAN,
+        root=decider_ref.ROOT,
+        featurepackage='decider_bib.features',
+        config=utilo.FeaturePackConfig(
+            cli_hook=[
+                docinfo,
+                hook,
+            ],
+            description=DESCRIPTION,
+            multiprocessed=True,
+            name=decider_bib.PROCESS,
+            pages=True,
+            version=decider_ref.__version__,
+        ),
+    )

decider_ref-1.22.2/decider_bib/features/__init__.py

@@ -0,0 +1,8 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================