impact-gate 0.1.0__tar.gz

impact_gate-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

impact_gate-0.1.0/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: impact-gate
+Version: 0.1.0
+Summary: Measure and gate structural decay from a change (standalone + CI plugin).
+Author: Daniel Sagenschneider
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/officefloor/ImpactGate
+Project-URL: Repository, https://github.com/officefloor/ImpactGate
+Project-URL: Issues, https://github.com/officefloor/ImpactGate/issues
+Keywords: code-quality,complexity,static-analysis,ci,pre-commit,technical-debt,maintainability,code-review
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lizard!=1.24.0,>=1.17
+Requires-Dist: PyYAML>=6
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Dynamic: license-file
+
+# impact-gate
+
+Measure and gate the structural decay a change introduces. Run it as a standalone CLI,
+a git pre-commit hook, or a plugin in GitHub, GitLab, and Jenkins CI.
+
+Structural decay is complexity accreting into existing structures. A god-method grows
+another branch. A god-class gains another method. The gate scores a change against a
+base (`main` by default) with the change-impact measure:
+
+```
+impact = files_changed * Σ max(WMC_other, 1) * CC * Δlines      (over changed functions)
+```
+
+`WMC_other` is the complexity already in the container you are editing. It is measured
+on the pre-change state. So importing a brand-new file or class is cheap. Nothing was
+there before. Piling onto an already-heavy class is expensive. That is the decay signal.
+
+When impact is too high, the gate asks you to simplify the change or refactor the code
+it touches. It can warn (report only) or block (fail the build).
+
+This tool is the instrument for an experiment. The experiment studies how to control
+structural decay under AI-augmented development. The gate sits in front of every change,
+human or AI, so complexity cannot silently concentrate.
+
+> Fully standalone. The measure is vendored in `impact_gate/core/`. Only `lizard` is
+> required at runtime.
+
+## Install
+
+```bash
+pip install impact-gate         # installs the `impact-gate` command
+```
+
+Or run it without installing anything, via the published image (git is bundled;
+mount the repo to score at `/repo`):
+
+```bash
+docker run --rm -v "$PWD:/repo" ghcr.io/officefloor/impact-gate \
+  score --mode range --base origin/main
+```
+
+To hack on it locally, install from a checkout instead:
+
+```bash
+python -m venv .venv && . .venv/bin/activate
+pip install -e '.[dev]'         # editable install plus the test deps
+```
+
+## Use
+
+```bash
+# The commit you are about to make (pre-commit): staged vs HEAD. This is the default.
+impact-gate score
+
+# Uncommitted local edits: working tree vs HEAD.
+impact-gate score --mode worktree
+
+# CI or PR review: the committed branch vs main (merge-base..HEAD).
+impact-gate score --mode range --base origin/main --format json
+
+# Set thresholds and enforcement. You can also put these in .impact-gate.yml.
+impact-gate score --warn-at 50000 --block-at 200000 --enforcement block
+```
+
+Exit codes. `0` means ok or warn (the change is allowed). `2` means blocked (impact too
+high under `--enforcement block`). `1` means a usage or environment error.
+
+Every report also lists the **files to consider for refactoring**, ranked by their share
+of the impact. The change-level number gates; the per-file ranking points at where the
+decay is concentrating, so a file quietly growing into a god-class surfaces as a
+candidate before it blocks anything.
+
+## Grade against a distribution (the curve)
+
+A raw threshold is hard to set: a typical change's impact varies by orders of magnitude
+across languages and projects. Instead of guessing a number, grade a change by its
+**percentile** against a distribution, and gate on the percentile.
+
+```bash
+# Build (or refresh) the project's own impact distribution from the merged history.
+# Writes .impact-gate-baseline.json. Re-run it as the branch moves.
+impact-gate baseline --base-ref main
+
+# Gate on the grade instead of an absolute number.
+impact-gate score --curve --warn-percentile 90 --block-percentile 98
+```
+
+The grade blends two distributions:
+
+- a **seed prior** shipped with the tool — per-language percentile tables built from a
+  20-repo open-source corpus, with a pooled fallback for languages not in the table;
+- the **project baseline** — the repo's own per-change distribution, walked from the
+  merged mainline (only landed work; in-flight branches are never reached).
+
+The blend weights the project by `w = n / (n + K)`, where `n` is the number of landed
+changes behind the baseline and `K` (`curve_prior_weight`, default 200) is how much
+history it takes to trust the project over the seed. A fresh repo with no baseline file
+grades on the seed alone; a deep history leans on itself. The grade shows in every
+format next to the raw number.
+
+## Configure with `.impact-gate.yml` (repo root)
+
+```yaml
+warn_at: 50000          # impact above which to warn
+block_at: 200000        # impact above which to block
+enforcement: warn       # off, warn, or block. Start on warn. Flip to block when ready.
+tolerance: 1.0          # CI-adjustable multiplier on both thresholds. Above 1 is more lenient.
+# measure_config: .impact-measure.yml   # optional: ignore globs and language overrides
+
+# Grading curve (percentile gate). When enabled, warn_at/block_at are ignored and the
+# gate uses the percentiles below instead.
+curve_enabled: false           # gate on the percentile grade instead of absolute numbers
+warn_percentile: 90            # grade at or above this warns
+block_percentile: 98           # grade at or above this blocks
+curve_prior_weight: 200        # K in w = n/(n+K): history needed to trust the project over the seed
+baseline_file: .impact-gate-baseline.json   # where `impact-gate baseline` caches the distribution
+```
+
+CLI flags override the file. A CI job can pass `--tolerance` or `--warn-at`. So a team
+can dial tolerance without editing the repo. The curve knobs have flags too: `--curve`,
+`--warn-percentile`, `--block-percentile`, `--baseline-file`.
+
+## Use in GitHub Actions
+
+Add a workflow to your repo. The action scores the PR branch against its base and writes
+a summary. `fetch-depth: 0` is required so the base branch and merge-base are present.
+
+```yaml
+name: Change impact
+on: pull_request
+permissions:
+  contents: read
+  pull-requests: write         # so the action can post the score as a PR comment
+jobs:
+  impact:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: officefloor/ImpactGate@v1
+        with:
+          enforcement: warn        # switch to block when ready
+          # warn-at: 50000
+          # block-at: 200000
+          # tolerance: 1.0
+```
+
+The score appears in the job summary and as a sticky comment on the PR (one comment,
+updated each run). In `block` mode the job fails when impact exceeds the block threshold.
+Make the check required in branch protection to gate merges. The comment needs
+`pull-requests: write`. Without it the run still passes and just skips the comment.
+
+## Roadmap
+
+- Core CLI. Score staged, worktree, or range. Warn or block. Text, JSON, markdown. Done.
+- GitHub Action. Composite action, job-summary report, and a sticky PR comment. Done.
+- Baseline and grading curve. `impact-gate baseline` profiles the project history; the
+  gate blends a seed-corpus prior with the project's own distribution and grades a change
+  by its percentile (`score --curve`). Done.
+- Distribution. `pip install impact-gate`, a `ghcr.io/officefloor/impact-gate` Docker
+  image for any CI, and a version-tagged Action (`@v0`). Done.
+- More CI plugins. A GitLab CI template and a Jenkins shared library.
+- Hooks and IDE. An `impact-gate install-hook` for pre-commit. Editor integration over LSP.

impact_gate-0.1.0/README.md

@@ -0,0 +1,164 @@
+# impact-gate
+
+Measure and gate the structural decay a change introduces. Run it as a standalone CLI,
+a git pre-commit hook, or a plugin in GitHub, GitLab, and Jenkins CI.
+
+Structural decay is complexity accreting into existing structures. A god-method grows
+another branch. A god-class gains another method. The gate scores a change against a
+base (`main` by default) with the change-impact measure:
+
+```
+impact = files_changed * Σ max(WMC_other, 1) * CC * Δlines      (over changed functions)
+```
+
+`WMC_other` is the complexity already in the container you are editing. It is measured
+on the pre-change state. So importing a brand-new file or class is cheap. Nothing was
+there before. Piling onto an already-heavy class is expensive. That is the decay signal.
+
+When impact is too high, the gate asks you to simplify the change or refactor the code
+it touches. It can warn (report only) or block (fail the build).
+
+This tool is the instrument for an experiment. The experiment studies how to control
+structural decay under AI-augmented development. The gate sits in front of every change,
+human or AI, so complexity cannot silently concentrate.
+
+> Fully standalone. The measure is vendored in `impact_gate/core/`. Only `lizard` is
+> required at runtime.
+
+## Install
+
+```bash
+pip install impact-gate         # installs the `impact-gate` command
+```
+
+Or run it without installing anything, via the published image (git is bundled;
+mount the repo to score at `/repo`):
+
+```bash
+docker run --rm -v "$PWD:/repo" ghcr.io/officefloor/impact-gate \
+  score --mode range --base origin/main
+```
+
+To hack on it locally, install from a checkout instead:
+
+```bash
+python -m venv .venv && . .venv/bin/activate
+pip install -e '.[dev]'         # editable install plus the test deps
+```
+
+## Use
+
+```bash
+# The commit you are about to make (pre-commit): staged vs HEAD. This is the default.
+impact-gate score
+
+# Uncommitted local edits: working tree vs HEAD.
+impact-gate score --mode worktree
+
+# CI or PR review: the committed branch vs main (merge-base..HEAD).
+impact-gate score --mode range --base origin/main --format json
+
+# Set thresholds and enforcement. You can also put these in .impact-gate.yml.
+impact-gate score --warn-at 50000 --block-at 200000 --enforcement block
+```
+
+Exit codes. `0` means ok or warn (the change is allowed). `2` means blocked (impact too
+high under `--enforcement block`). `1` means a usage or environment error.
+
+Every report also lists the **files to consider for refactoring**, ranked by their share
+of the impact. The change-level number gates; the per-file ranking points at where the
+decay is concentrating, so a file quietly growing into a god-class surfaces as a
+candidate before it blocks anything.
+
+## Grade against a distribution (the curve)
+
+A raw threshold is hard to set: a typical change's impact varies by orders of magnitude
+across languages and projects. Instead of guessing a number, grade a change by its
+**percentile** against a distribution, and gate on the percentile.
+
+```bash
+# Build (or refresh) the project's own impact distribution from the merged history.
+# Writes .impact-gate-baseline.json. Re-run it as the branch moves.
+impact-gate baseline --base-ref main
+
+# Gate on the grade instead of an absolute number.
+impact-gate score --curve --warn-percentile 90 --block-percentile 98
+```
+
+The grade blends two distributions:
+
+- a **seed prior** shipped with the tool — per-language percentile tables built from a
+  20-repo open-source corpus, with a pooled fallback for languages not in the table;
+- the **project baseline** — the repo's own per-change distribution, walked from the
+  merged mainline (only landed work; in-flight branches are never reached).
+
+The blend weights the project by `w = n / (n + K)`, where `n` is the number of landed
+changes behind the baseline and `K` (`curve_prior_weight`, default 200) is how much
+history it takes to trust the project over the seed. A fresh repo with no baseline file
+grades on the seed alone; a deep history leans on itself. The grade shows in every
+format next to the raw number.
+
+## Configure with `.impact-gate.yml` (repo root)
+
+```yaml
+warn_at: 50000          # impact above which to warn
+block_at: 200000        # impact above which to block
+enforcement: warn       # off, warn, or block. Start on warn. Flip to block when ready.
+tolerance: 1.0          # CI-adjustable multiplier on both thresholds. Above 1 is more lenient.
+# measure_config: .impact-measure.yml   # optional: ignore globs and language overrides
+
+# Grading curve (percentile gate). When enabled, warn_at/block_at are ignored and the
+# gate uses the percentiles below instead.
+curve_enabled: false           # gate on the percentile grade instead of absolute numbers
+warn_percentile: 90            # grade at or above this warns
+block_percentile: 98           # grade at or above this blocks
+curve_prior_weight: 200        # K in w = n/(n+K): history needed to trust the project over the seed
+baseline_file: .impact-gate-baseline.json   # where `impact-gate baseline` caches the distribution
+```
+
+CLI flags override the file. A CI job can pass `--tolerance` or `--warn-at`. So a team
+can dial tolerance without editing the repo. The curve knobs have flags too: `--curve`,
+`--warn-percentile`, `--block-percentile`, `--baseline-file`.
+
+## Use in GitHub Actions
+
+Add a workflow to your repo. The action scores the PR branch against its base and writes
+a summary. `fetch-depth: 0` is required so the base branch and merge-base are present.
+
+```yaml
+name: Change impact
+on: pull_request
+permissions:
+  contents: read
+  pull-requests: write         # so the action can post the score as a PR comment
+jobs:
+  impact:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: officefloor/ImpactGate@v1
+        with:
+          enforcement: warn        # switch to block when ready
+          # warn-at: 50000
+          # block-at: 200000
+          # tolerance: 1.0
+```
+
+The score appears in the job summary and as a sticky comment on the PR (one comment,
+updated each run). In `block` mode the job fails when impact exceeds the block threshold.
+Make the check required in branch protection to gate merges. The comment needs
+`pull-requests: write`. Without it the run still passes and just skips the comment.
+
+## Roadmap
+
+- Core CLI. Score staged, worktree, or range. Warn or block. Text, JSON, markdown. Done.
+- GitHub Action. Composite action, job-summary report, and a sticky PR comment. Done.
+- Baseline and grading curve. `impact-gate baseline` profiles the project history; the
+  gate blends a seed-corpus prior with the project's own distribution and grades a change
+  by its percentile (`score --curve`). Done.
+- Distribution. `pip install impact-gate`, a `ghcr.io/officefloor/impact-gate` Docker
+  image for any CI, and a version-tagged Action (`@v0`). Done.
+- More CI plugins. A GitLab CI template and a Jenkins shared library.
+- Hooks and IDE. An `impact-gate install-hook` for pre-commit. Editor integration over LSP.

impact_gate-0.1.0/impact_gate/__init__.py

@@ -0,0 +1,8 @@
+"""impact-gate — report the change-impact of a change and gate on it.
+
+A lightweight front-end over the change-impact measure (shared, single-sourced with
+Surveyor / the PetClinic-Evolve harness). It scores a change against a base — a
+committed range vs `main`, staged changes, or the working tree — reports the number,
+and warns or blocks when the impact is too high.
+"""
+__version__ = "0.1.0"