heimdal_ai_analyze 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1de7a84ebfd8fd06367312a54270c64bf6c43923238d3b85cdff16dff2e2e25
-  data.tar.gz: 6cac8c75b7870aa5a56add62d203053ba505d4f397a8c74e67f9f60ce727e603
+  metadata.gz: fc0b28182c96cbd7d687b4e1b219a7010d1773756d5abb17855ebe855fdf5b00
+  data.tar.gz: 948d0b8a93c07c392290a6807d6e8010743bf5158e620cf2afaed25b0cb6fa30
 SHA512:
-  metadata.gz: 74670f8e9b9bc96c3a6a7f8d1a58260e0b6d8a3f74c6b4df1aa4eaec5f19733268a6491f33ddf5c3389147230d5e4237e09b610fe498f8982beb57745e0b12e4
-  data.tar.gz: 9c3b237a19785f0c44ef66e6f84afa15465d056af00b4b780d9b18c67895ef94c9923daeb2d4c0506d3a8dc22ceb89f2c985eb2fdd9a0747e764e230cf4e8bf3
+  metadata.gz: cfb229eb3a88b328ae677fb235ba09447acc5550cf9981b8245fe88567eba63846f89cf9bea1a8d6f991e5307c7c08799eccd5eca5d459fefa49f464814d0b6d
+  data.tar.gz: eafa7b0af64cbbc3d2a161497ec3d3f0a596ecdfa0d8d72600af228cf0883c4edf9703b6c950d826f4d2c78edc425c506637bc01506645c4cf7d561d44ae6e8a

data/README.md

@@ -1,19 +1,21 @@
 # Heimdal AI Analyze
 
-Ruby gem that installs a **git pre-commit** hook for **AI-assisted review** of your **staged diff** via the [Cursor Agent CLI](https://cursor.com/docs/cli/overview). The hook runs only when you commit with analysis enabled (e.g. `git analyze -m "message"`), not on normal commits.
+[![Gem Version](https://badge.fury.io/rb/heimdal_ai_analyze.svg)](https://rubygems.org/gems/heimdal_ai_analyze)
 
-## Requirements
+**Heimdal AI Analyze** is a Ruby gem that adds a **git pre-commit** hook for **AI-assisted review** of your **staged diff**. Use `git analyze` to run the review before your commit; a normal `git commit` does not trigger analysis unless you opt in.
 
-1. **Cursor Agent CLI** — install from [cursor.com/install](https://cursor.com/install) and ensure `agent` or `cursor-agent` is on your `PATH` (or set `CURSOR_AGENT_BIN`).
-2. **`CURSOR_API_KEY`** — export in your environment, or use a repo-local `scripts/.env.hook`, or `~/.config/heimdal_ai_analyze/env` (see below).
+_Sees every line. Judges every commit. No bad code crosses the Bifrost._
 
-## Install the gem
+- **RubyGems:** [rubygems.org/gems/heimdal_ai_analyze](https://rubygems.org/gems/heimdal_ai_analyze)
+- **Source:** [github.com/ffarhhan/heimdal_ai_analyze](https://github.com/ffarhhan/heimdal_ai_analyze)
+
+## Installation
 
 ```bash
 gem install heimdal_ai_analyze
 ```
 
-Or with Bundler:
+With Bundler:
 
 ```ruby
 # Gemfile
@@ -24,59 +26,45 @@ gem "heimdal_ai_analyze", group: :development
 bundle install
 ```
 
-## One-time setup per repository
+Requires **Ruby ≥ 3.1**.
 
-From the git repository root:
+## How it works
 
-```bash
-bundle exec heimdal-ai-analyze-install
-# or, if the gem executable is on PATH:
-heimdal-ai-analyze-install
-```
+1. **You run `git analyze -m "message"`** — A `git commit` alias that runs Heimdal’s review **before** your changes are committed.
 
-This symlinks `.git/hooks/pre-commit` to the gem’s hook, sets `git analyze` alias (`ANALYZE=true git commit …`), records `heimdalAiAnalyze.gemPath`, and tries to save `cursorHook.agentPath` for the Cursor Agent binary.
+2. **Staged changes only** — Only files in the commit are analyzed; the rest of the tree is untouched.
 
-## Credentials
+3. **Five dimensions** — **Security**, **duplication**, **complexity**, **style**, and **tests**.
 
-**Minimum:** set an API key for the Cursor Agent:
+4. **Severity** — Issues are reported with location, explanation, and a suggested fix (**critical**, **warning**, **info**).
 
-```bash
-export CURSOR_API_KEY="your-key"
-```
+**Result:** **Critical** findings **block** the commit until addressed. With no critical issues, the commit can proceed; lower severities are advisory.
 
-Optional locations (loaded in order; later sources override earlier ones):
+## One-time setup (per repository)
 
-1. `~/.config/heimdal_ai_analyze/env` or `$XDG_CONFIG_HOME/heimdal_ai_analyze/env` — `export CURSOR_API_KEY=...`
-2. `scripts/.env.hook` in the project (gitignored) — copy from `templates/env.hook.example` in this gem if you open the installed path under `$(gem env gemdir)`.
-
-## Usage
+Run from the repository root:
 
 ```bash
-git analyze -m "Your commit message"   # runs AI review on staged changes, then commits if allowed
-git commit -m "message"                   # normal commit (hook skips AI unless ANALYZE=true)
-git commit --no-verify                    # bypass hooks when needed
+bundle exec heimdal-ai-analyze-install
+# or, if the executable is on your PATH:
+heimdal-ai-analyze-install
 ```
 
-## Development
+This links the gem’s pre-commit hook, registers the `git analyze` alias (`ANALYZE=true git commit …`), and stores the gem path in local git config. If an analysis binary is found, its path may be saved locally as well.
 
-Clone [github.com/ffarhhan/heimdal_ai_analyze](https://github.com/ffarhhan/heimdal_ai_analyze):
+## API key
 
-```bash
-git clone -o personal git@github.com:ffarhhan/heimdal_ai_analyze.git
-cd heimdal_ai_analyze
-gem build heimdal_ai_analyze.gemspec
-gem install ./heimdal_ai_analyze-*.gem --local
-```
+The hook needs **`CURSOR_API_KEY`** whenever you run `git analyze`.
+
+- **This shell only:** `export CURSOR_API_KEY="…"` lasts for the current terminal session.
+- **Every session:** add that `export` to your shell profile (for example `~/.zshrc` or `~/.bashrc`), **or** keep the key in a **repository-root `.env`** file and add `.env` to `.gitignore` so it is never committed. The hook loads supported env files when it runs.
 
-## Publish to RubyGems.org (maintainers)
+For additional options and examples, see **`templates/env.hook.example`** inside the installed gem (`gem contents heimdal_ai_analyze` or `$(gem env gemdir)/gems/heimdal_ai_analyze-*`).
 
-1. [Create an account](https://rubygems.org/sign_up) and enable MFA as required.
-2. `gem signin` with a [RubyGems API key](https://rubygems.org/profile/edit) (push scope).
-3. Bump `lib/heimdal_ai_analyze/version.rb`, then:
+## Usage
 
 ```bash
-gem build heimdal_ai_analyze.gemspec
-gem push heimdal_ai_analyze-VERSION.gem
+git analyze -m "Your commit message"   # review staged changes, then commit if allowed
 ```
 
 ## License

data/heimdal_ai_analyze.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["ffarhhan"]
   spec.email = ["ffarhhan@users.noreply.github.com"]
 
-  spec.summary = "Heimdal AI Analyze — Cursor Agent pre-commit gate for staged diffs"
-  spec.description = "Installs a git pre-commit hook that runs Cursor Agent on ANALYZE=true commits (e.g. git analyze). Requires CURSOR_API_KEY and the Cursor Agent CLI."
+  spec.summary = "Heimdal AI Analyze — git pre-commit hook for AI-assisted review of staged diffs (git analyze)"
+  spec.description = "Heimdal AI Analyze installs a git pre-commit hook that runs an AI-assisted code review of your staged diff when you commit with analysis enabled (e.g. `git analyze -m \"message\"`). Reviews security, duplication, complexity, style, and tests; critical issues can block the commit. Requires CURSOR_API_KEY in the environment or a repo-local `.env` (gitignored)."
   spec.homepage = "https://github.com/ffarhhan/heimdal_ai_analyze"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.1.0"

data/lib/heimdal_ai_analyze/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HeimdalAiAnalyze
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/templates/env.hook.example

@@ -1,5 +1,6 @@
 # Copy to scripts/.env.hook (gitignored). Never commit this file.
-# Or use ~/.config/heimdal_ai_analyze/env for all repos on your machine (loaded first; this file overrides).
+# Alternatively use a repo-root .env file (gitignored); the hook loads ~/.config/.../env, then .env, then this file.
+# Or use ~/.config/heimdal_ai_analyze/env for all repos on your machine (loaded first; repo .env and this file override).
 #
 #   Copy this file to scripts/.env.hook in your app repo (see gem README).
 #

data/templates/pre-commit

@@ -11,9 +11,9 @@
 #
 # Requirements:
 #   • Cursor Agent CLI — https://cursor.com/install
-#   • CURSOR_API_KEY   — export in env, or ~/.config/heimdal_ai_analyze/env, or scripts/.env.hook (gitignored)
+#   • CURSOR_API_KEY   — export in env, or ~/.config/heimdal_ai_analyze/env, or repo .env / scripts/.env.hook (gitignored)
 #
-# Env file load order (later overrides earlier): user config → repo scripts/.env.hook
+# Env file load order (later overrides earlier): user config → repo .env → scripts/.env.hook
 #
 # Agent binary lookup (first match):
 #   1. $CURSOR_AGENT_BIN  2. scripts/.env.hook exports  3. git config cursorHook.agentPath
@@ -32,11 +32,13 @@ set -euo pipefail
 # │ Bootstrap                                                           │
 # └─────────────────────────────────────────────────────────────────────┘
 REPO_ROOT=$(git rev-parse --show-toplevel 2>/dev/null) || REPO_ROOT=""
-# User-level config first (Heimdal gem); repo scripts/.env.hook overrides.
+# User-level config first (Heimdal gem); repo .env then scripts/.env.hook override.
 for f in "${XDG_CONFIG_HOME:+$XDG_CONFIG_HOME/heimdal_ai_analyze/env}" \
          "${HOME}/.config/heimdal_ai_analyze/env"; do
   [[ -n "$f" && -f "$f" ]] && { set -a; . "$f"; set +a; }
 done
+REPO_DOTENV="${REPO_ROOT:+$REPO_ROOT/.env}"
+[[ -n "$REPO_DOTENV" && -f "$REPO_DOTENV" ]] && { set -a; . "$REPO_DOTENV"; set +a; }
 ENV_HOOK="${REPO_ROOT:+$REPO_ROOT/scripts/.env.hook}"
 [[ -n "$ENV_HOOK" && -f "$ENV_HOOK" ]] && { set -a; . "$ENV_HOOK"; set +a; }
 
@@ -139,7 +141,7 @@ if [[ -z "${CURSOR_API_KEY:-}" ]]; then
   cat >&2 <<'MSG'
 pre-commit (analyze): CURSOR_API_KEY is required.
   → export CURSOR_API_KEY="…"
-  → Or ~/.config/heimdal_ai_analyze/env or scripts/.env.hook (see gem README / env.hook.example)
+  → Or ~/.config/heimdal_ai_analyze/env, .env, or scripts/.env.hook (see gem README / env.hook.example)
 MSG
   exit 1
 fi

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heimdal_ai_analyze
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - ffarhhan
@@ -10,8 +10,11 @@ bindir: exe
 cert_chain: []
 date: 2026-04-14 00:00:00.000000000 Z
 dependencies: []
-description: Installs a git pre-commit hook that runs Cursor Agent on ANALYZE=true
-  commits (e.g. git analyze). Requires CURSOR_API_KEY and the Cursor Agent CLI.
+description: Heimdal AI Analyze installs a git pre-commit hook that runs an AI-assisted
+  code review of your staged diff when you commit with analysis enabled (e.g. `git
+  analyze -m "message"`). Reviews security, duplication, complexity, style, and tests;
+  critical issues can block the commit. Requires CURSOR_API_KEY in the environment
+  or a repo-local `.env` (gitignored).
 email:
 - ffarhhan@users.noreply.github.com
 executables:
@@ -53,5 +56,6 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Heimdal AI Analyze — Cursor Agent pre-commit gate for staged diffs
+summary: Heimdal AI Analyze — git pre-commit hook for AI-assisted review of staged
+  diffs (git analyze)
 test_files: []