diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0d02c73..a7b8502 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -52,25 +52,30 @@ jobs: - name: Run tests run: crystal spec - - name: Build binary (Linux) + - name: Build binaries (Linux) if: matrix.target == 'linux-x86_64' run: | crystal build src/amber_cli.cr -o amber --release --static - - - name: Build binary (macOS) + crystal build src/amber_lsp.cr -o amber-lsp --release --static + + - name: Build binaries (macOS) if: matrix.target == 'darwin-arm64' run: | crystal build src/amber_cli.cr -o amber --release - - - name: Test binary + crystal build src/amber_lsp.cr -o amber-lsp --release + + - name: Test binaries run: | ./amber --version ./amber --help - - - name: Upload build artifact + ./amber-lsp --help + + - name: Upload build artifacts uses: actions/upload-artifact@v4 if: github.event_name == 'workflow_dispatch' with: name: amber-cli-${{ matrix.target }}-build - path: amber + path: | + amber + amber-lsp retention-days: 7 \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 705e7d2..99fb08e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -63,22 +63,29 @@ jobs: run: ./bin/ameba continue-on-error: true - - name: Compile project - run: crystal build src/amber_cli.cr --no-debug + - name: Compile CLI + run: crystal build src/amber_cli.cr --no-debug -o amber + + - name: Compile LSP + run: crystal build src/amber_lsp.cr --no-debug -o amber-lsp - name: Run tests run: crystal spec - - name: Build release binary - run: crystal build src/amber_cli.cr --release --no-debug -o amber_cli + - name: Build release binaries if: matrix.os == 'ubuntu-latest' + run: | + crystal build src/amber_cli.cr --release --no-debug -o amber_cli + crystal build src/amber_lsp.cr --release --no-debug -o amber_lsp - - name: Upload binary artifact (Linux) + - name: Upload binary artifacts (Linux) uses: actions/upload-artifact@v4 if: matrix.os == 'ubuntu-latest' with: - name: amber_cli-linux - path: amber_cli + name: amber-cli-linux + path: | + amber_cli + amber_lsp # Separate job for additional platform-specific tests platform-specific: @@ -113,6 +120,11 @@ jobs: ./amber_cli --help || true ./amber_cli --version || true + - name: Test LSP functionality + run: | + crystal build src/amber_lsp.cr -o amber_lsp + ./amber_lsp --help || true + # Job to run integration tests integration: runs-on: ubuntu-latest diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e8f2aca..b5978e0 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -46,25 +46,29 @@ jobs: - name: Install dependencies run: shards install --production - - name: Build binary (Linux x86_64) + - name: Build binaries (Linux x86_64) if: matrix.target == 'linux-x86_64' run: | crystal build src/amber_cli.cr -o amber --release --static - - - name: Build binary (macOS ARM64) + crystal build src/amber_lsp.cr -o amber-lsp --release --static + + - name: Build binaries (macOS ARM64) if: matrix.target == 'darwin-arm64' run: | crystal build src/amber_cli.cr -o amber --release - - - name: Verify binary + crystal build src/amber_lsp.cr -o amber-lsp --release + + - name: Verify binaries run: | file amber ./amber --version || echo "Version command may not work in cross-compiled binary" - + file amber-lsp + ./amber-lsp --help || echo "Help command may not work in cross-compiled binary" + - name: Create archive run: | mkdir -p dist - tar -czf dist/amber-cli-${{ matrix.target }}.tar.gz amber + tar -czf dist/amber-cli-${{ matrix.target }}.tar.gz amber amber-lsp - name: Calculate checksum id: checksum @@ -116,6 +120,6 @@ jobs: uses: peter-evans/repository-dispatch@v2 with: token: ${{ secrets.HOMEBREW_TAP_TOKEN }} - repository: crimsonknight/homebrew-amber-cli + repository: crimson-knight/homebrew-amber-cli event-type: release-published client-payload: '{"version": "${{ github.event.release.tag_name }}"}' \ No newline at end of file diff --git a/README.md b/README.md index c0ffb9f..fbc6ae6 100644 --- a/README.md +++ b/README.md @@ -18,16 +18,18 @@ The comprehensive documentation includes detailed guides, examples, and API refe **macOS & Linux via Homebrew:** ```bash -brew install amber +brew tap crimson-knight/amber-cli +brew install amber-cli ``` **From Source:** ```bash -git clone https://github.com/amberframework/amber_cli.git +git clone https://github.com/crimson-knight/amber_cli.git cd amber_cli shards install -crystal build src/amber_cli.cr -o amber -sudo mv amber /usr/local/bin/ +crystal build src/amber_cli.cr -o amber --release +crystal build src/amber_lsp.cr -o amber-lsp --release +sudo mv amber amber-lsp /usr/local/bin/ ``` **Windows:** @@ -64,6 +66,7 @@ Your application will be available at `http://localhost:3000` | `exec` | Execute Crystal code in app context | `amber exec 'puts User.count'` | | `encrypt` | Manage encrypted environment files | `amber encrypt production` | | `pipelines` | Show pipeline configuration | `amber pipelines` | +| `setup:lsp` | Configure the Amber LSP for Claude Code | `amber setup:lsp` | Run `amber --help` or `amber [command] --help` for detailed usage information. @@ -87,6 +90,12 @@ Run `amber --help` or `amber [command] --help` for detailed usage information. - Route analysis and pipeline inspection - Environment file encryption for security +### **Amber LSP — AI-Assisted Development** +- Built-in Language Server Protocol (LSP) server for Claude Code integration +- 15 convention rules that catch framework mistakes as you type +- Custom YAML-based rules for project-specific conventions +- One command to set up: `amber setup:lsp` + ### **Extensible Architecture** - Plugin system for extending functionality - Command registration system for custom commands @@ -112,6 +121,58 @@ Run `amber --help` or `amber [command] --help` for detailed usage information. - Conditional file generation - Post-generation command execution +## 🤖 Amber LSP — The Default Development Workflow + +Amber ships with a diagnostics-only Language Server that integrates with [Claude Code](https://claude.ai/claude-code). When you develop with Claude Code, the LSP runs in the background and automatically catches framework convention violations — wrong controller names, missing methods, bad inheritance, file naming issues, and more. Claude sees these diagnostics and self-corrects without you having to notice or intervene. + +**This is the recommended way to develop with Amber.** The LSP turns Claude Code from a general-purpose coding assistant into one that understands Amber's conventions natively. + +### Quick Setup + +```bash +# From your Amber project directory: +amber setup:lsp +``` + +This creates three files: + +| File | Purpose | +|------|---------| +| `.lsp.json` | Tells Claude Code where the LSP binary is and what files it handles | +| `.claude-plugin/plugin.json` | Plugin manifest so Claude Code discovers the LSP | +| `.amber-lsp.yml` | Rule configuration — customize severity, disable rules, add custom rules | + +Then open Claude Code in your project. The LSP activates automatically. + +### What It Checks + +The LSP ships with 15 built-in rules covering controllers, jobs, channels, pipes, mailers, schemas, routing, file naming, directory structure, and more. Every rule maps to an Amber convention — if Claude generates a controller that doesn't end with `Controller`, or a job without a `perform` method, the LSP flags it immediately. + +### Custom Rules + +You can define project-specific rules in `.amber-lsp.yml` using regex patterns. No recompilation needed: + +```yaml +custom_rules: + - id: "project/no-puts" + description: "Do not use puts in production code" + severity: warning + applies_to: ["src/**"] + pattern: "^\\s*puts\\b" + message: "Avoid 'puts' in production code. Use Log.info instead." +``` + +### Building the LSP Binary + +If `amber-lsp` is not on your PATH, the `setup:lsp` command will offer to build it: + +```bash +cd ~/open_source_coding_projects/amber_cli +crystal build src/amber_lsp.cr -o bin/amber-lsp --release +``` + +For full documentation on all 15 rules, configuration options, and custom rule syntax, see the [LSP Setup Guide](https://github.com/crimson-knight/amber/blob/master/docs/guides/lsp-setup.md). + ## 📚 Examples ### Generate a Blog Post Resource diff --git a/TASKS.md b/TASKS.md new file mode 100644 index 0000000..59bc50c --- /dev/null +++ b/TASKS.md @@ -0,0 +1,24 @@ +# Amber CLI Tasks + +## Completed (2025-12-26) +- [x] Changed default template from slang to ECR +- [x] Removed recipes feature (deprecated liquid.cr) +- [x] Verified CLI builds successfully +- [x] Tested --version flag +- [x] Tested new command (generates ECR templates) +- [x] Tested generate model command +- [x] Tested generate controller command +- [x] Tested generate scaffold command (generates ECR views) +- [x] GitHub Actions CI/CD already configured for Ubuntu + macOS + +## Remaining Work +- [ ] Run full test suite: `crystal spec` +- [ ] Update homebrew-amber formula after publishing +- [ ] Create GitHub release for v2.0.0 +- [ ] Add integration tests that validate generated app compiles +- [ ] Consider Docker testing for Linux validation + +## Notes +- CI workflow exists at `.github/workflows/ci.yml` +- Runs on ubuntu-latest and macos-latest +- Integration test job will skip if no spec/integration folder exists diff --git a/scripts/build_release.sh b/scripts/build_release.sh index 81104e6..2f39325 100755 --- a/scripts/build_release.sh +++ b/scripts/build_release.sh @@ -21,7 +21,9 @@ ARCH=$(uname -m) case "${OS}" in "darwin") TARGET="darwin-arm64" - BUILD_CMD="crystal build src/amber_cli.cr -o amber --release" + BUILD_CLI="crystal build src/amber_cli.cr -o amber --release" + BUILD_LSP="crystal build src/amber_lsp.cr -o amber-lsp --release" + CHECKSUM_CMD="shasum -a 256" if [ "${ARCH}" != "arm64" ]; then echo "⚠️ Warning: Building for ARM64 on ${ARCH} architecture" echo " This will create a native build for your current architecture" @@ -29,7 +31,9 @@ case "${OS}" in ;; "linux") TARGET="linux-x86_64" - BUILD_CMD="crystal build src/amber_cli.cr -o amber --release --static" + BUILD_CLI="crystal build src/amber_cli.cr -o amber --release --static" + BUILD_LSP="crystal build src/amber_lsp.cr -o amber-lsp --release --static" + CHECKSUM_CMD="sha256sum" ;; *) echo "❌ Unsupported OS: ${OS}" @@ -43,24 +47,29 @@ echo "🎯 Building for target: ${TARGET}" echo "📦 Installing dependencies..." shards install --production -# Build binary -echo "🔨 Compiling binary..." -eval "${BUILD_CMD}" +# Build binaries +echo "🔨 Compiling amber CLI..." +eval "${BUILD_CLI}" -# Verify binary -echo "✅ Verifying binary..." +echo "🔨 Compiling amber-lsp..." +eval "${BUILD_LSP}" + +# Verify binaries +echo "✅ Verifying binaries..." file amber ./amber +file amber-lsp +./amber-lsp --help # Create archive echo "📦 Creating archive..." -tar -czf "${OUTPUT_DIR}/amber-cli-${TARGET}.tar.gz" amber +tar -czf "${OUTPUT_DIR}/amber-cli-${TARGET}.tar.gz" amber amber-lsp # Calculate checksum echo "🔢 Calculating checksum..." cd "${OUTPUT_DIR}" -sha256sum "amber-cli-${TARGET}.tar.gz" > "amber-cli-${TARGET}.tar.gz.sha256" -SHA256=$(cat "amber-cli-${TARGET}.tar.gz.sha256" | cut -d' ' -f1) +${CHECKSUM_CMD} "amber-cli-${TARGET}.tar.gz" > "amber-cli-${TARGET}.tar.gz.sha256" +SHA256=$(cut -d' ' -f1 < "amber-cli-${TARGET}.tar.gz.sha256") echo "" echo "🎉 Build complete!" @@ -69,4 +78,5 @@ echo "🔑 SHA256: ${SHA256}" echo "" echo "To test the archive:" echo " tar -xzf ${OUTPUT_DIR}/amber-cli-${TARGET}.tar.gz" -echo " ./amber --version" \ No newline at end of file +echo " ./amber --version" +echo " ./amber-lsp --help" \ No newline at end of file diff --git a/shard.yml b/shard.yml index 2e4cef1..29c8bff 100644 --- a/shard.yml +++ b/shard.yml @@ -4,13 +4,15 @@ version: 2.0.0 authors: - crimson-knight -crystal: ">= 1.0.0, < 2.0" +crystal: ">= 1.10.0, < 2.0" license: MIT targets: amber: main: src/amber_cli.cr + amber-lsp: + main: src/amber_lsp.cr dependencies: diff --git a/spec/amber_cli_spec.cr b/spec/amber_cli_spec.cr index dd09c25..516c263 100644 --- a/spec/amber_cli_spec.cr +++ b/spec/amber_cli_spec.cr @@ -4,6 +4,7 @@ require "json" require "yaml" # Only require our new core modules directly, avoiding the main amber_cli.cr which has dependencies +require "../src/version" require "../src/amber_cli/exceptions" require "../src/amber_cli/core/word_transformer" require "../src/amber_cli/core/generator_config" @@ -56,6 +57,8 @@ require "./core/word_transformer_spec" require "./core/generator_config_spec" require "./core/template_engine_spec" require "./commands/base_command_spec" +require "./commands/new_command_spec" +require "./generators/native_app_spec" require "./integration/generator_manager_spec" describe "Amber CLI New Architecture" do diff --git a/spec/amber_lsp/analyzer_spec.cr b/spec/amber_lsp/analyzer_spec.cr new file mode 100644 index 0000000..e0b8479 --- /dev/null +++ b/spec/amber_lsp/analyzer_spec.cr @@ -0,0 +1,153 @@ +require "./spec_helper" + +# A mock rule for testing the analyzer +class MockTestRule < AmberLSP::Rules::BaseRule + def id : String + "mock/test-rule" + end + + def description : String + "A mock rule for testing" + end + + def default_severity : AmberLSP::Rules::Severity + AmberLSP::Rules::Severity::Warning + end + + def applies_to : Array(String) + ["*.cr"] + end + + def check(file_path : String, content : String) : Array(AmberLSP::Rules::Diagnostic) + diagnostics = [] of AmberLSP::Rules::Diagnostic + + if content.includes?("bad_pattern") + diagnostics << AmberLSP::Rules::Diagnostic.new( + range: AmberLSP::Rules::TextRange.new( + AmberLSP::Rules::Position.new(0, 0), + AmberLSP::Rules::Position.new(0, 11) + ), + severity: default_severity, + code: id, + message: "Found bad_pattern" + ) + end + + diagnostics + end +end + +# A mock rule that only applies to controller files +class MockControllerRule < AmberLSP::Rules::BaseRule + def id : String + "mock/controller-rule" + end + + def description : String + "A mock controller rule" + end + + def default_severity : AmberLSP::Rules::Severity + AmberLSP::Rules::Severity::Error + end + + def applies_to : Array(String) + ["*_controller.cr"] + end + + def check(file_path : String, content : String) : Array(AmberLSP::Rules::Diagnostic) + [] of AmberLSP::Rules::Diagnostic + end +end + +describe AmberLSP::Analyzer do + before_each do + AmberLSP::Rules::RuleRegistry.clear + end + + describe "#analyze" do + it "returns diagnostics from registered rules" do + AmberLSP::Rules::RuleRegistry.register(MockTestRule.new) + + analyzer = AmberLSP::Analyzer.new + diagnostics = analyzer.analyze("src/app.cr", "bad_pattern here") + + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("mock/test-rule") + diagnostics[0].message.should eq("Found bad_pattern") + end + + it "returns empty array when no rules match" do + AmberLSP::Rules::RuleRegistry.register(MockTestRule.new) + + analyzer = AmberLSP::Analyzer.new + diagnostics = analyzer.analyze("src/app.cr", "clean code") + + diagnostics.should be_empty + end + + it "skips excluded files" do + AmberLSP::Rules::RuleRegistry.register(MockTestRule.new) + + analyzer = AmberLSP::Analyzer.new + diagnostics = analyzer.analyze("lib/some_shard/bad_pattern.cr", "bad_pattern") + + diagnostics.should be_empty + end + + it "only runs rules that apply to the file" do + AmberLSP::Rules::RuleRegistry.register(MockControllerRule.new) + + analyzer = AmberLSP::Analyzer.new + # Should not trigger controller rule on a model file + rules = AmberLSP::Rules::RuleRegistry.rules_for_file("src/models/user.cr") + rules.should be_empty + end + + it "applies severity overrides from configuration" do + AmberLSP::Rules::RuleRegistry.register(MockTestRule.new) + + yaml = <<-YAML + rules: + mock/test-rule: + enabled: true + severity: error + YAML + + with_tempdir do |dir| + File.write(File.join(dir, ".amber-lsp.yml"), yaml) + + analyzer = AmberLSP::Analyzer.new + ctx = AmberLSP::ProjectContext.new(dir, amber_project: true) + analyzer.configure(ctx) + + diagnostics = analyzer.analyze("src/app.cr", "bad_pattern here") + + diagnostics.size.should eq(1) + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Error) + end + end + + it "skips disabled rules" do + AmberLSP::Rules::RuleRegistry.register(MockTestRule.new) + + yaml = <<-YAML + rules: + mock/test-rule: + enabled: false + YAML + + with_tempdir do |dir| + File.write(File.join(dir, ".amber-lsp.yml"), yaml) + + analyzer = AmberLSP::Analyzer.new + ctx = AmberLSP::ProjectContext.new(dir, amber_project: true) + analyzer.configure(ctx) + + diagnostics = analyzer.analyze("src/app.cr", "bad_pattern here") + + diagnostics.should be_empty + end + end + end +end diff --git a/spec/amber_lsp/configuration_spec.cr b/spec/amber_lsp/configuration_spec.cr new file mode 100644 index 0000000..30ab946 --- /dev/null +++ b/spec/amber_lsp/configuration_spec.cr @@ -0,0 +1,123 @@ +require "./spec_helper" + +describe AmberLSP::Configuration do + describe ".parse" do + it "parses rule enabled/disabled settings" do + yaml = <<-YAML + rules: + amber/model-naming: + enabled: false + amber/route-naming: + enabled: true + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.rule_enabled?("amber/model-naming").should be_false + config.rule_enabled?("amber/route-naming").should be_true + end + + it "parses rule severity overrides" do + yaml = <<-YAML + rules: + amber/model-naming: + enabled: true + severity: error + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.rule_severity("amber/model-naming", AmberLSP::Rules::Severity::Warning).should eq(AmberLSP::Rules::Severity::Error) + end + + it "returns default severity when no override is set" do + yaml = <<-YAML + rules: + amber/model-naming: + enabled: true + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.rule_severity("amber/model-naming", AmberLSP::Rules::Severity::Warning).should eq(AmberLSP::Rules::Severity::Warning) + end + + it "parses custom exclude patterns" do + yaml = <<-YAML + exclude: + - vendor/ + - generated/ + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.exclude_patterns.should eq(["vendor/", "generated/"]) + end + + it "uses default exclude patterns when none specified" do + yaml = <<-YAML + rules: + amber/model-naming: + enabled: true + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.exclude_patterns.should eq(["lib/", "tmp/", "db/migrations/"]) + end + + it "handles invalid YAML gracefully" do + config = AmberLSP::Configuration.parse("{{invalid") + config.rule_enabled?("any-rule").should be_true + end + end + + describe "#rule_enabled?" do + it "returns true for unconfigured rules" do + config = AmberLSP::Configuration.new + config.rule_enabled?("unknown-rule").should be_true + end + end + + describe "#rule_severity" do + it "returns default for unconfigured rules" do + config = AmberLSP::Configuration.new + config.rule_severity("unknown-rule", AmberLSP::Rules::Severity::Hint).should eq(AmberLSP::Rules::Severity::Hint) + end + end + + describe "#excluded?" do + it "excludes files matching default patterns" do + config = AmberLSP::Configuration.new + config.excluded?("lib/some_shard/src/foo.cr").should be_true + config.excluded?("tmp/cache/bar.cr").should be_true + config.excluded?("db/migrations/001_create_users.cr").should be_true + end + + it "does not exclude normal project files" do + config = AmberLSP::Configuration.new + config.excluded?("src/controllers/home_controller.cr").should be_false + config.excluded?("src/models/user.cr").should be_false + end + end + + describe ".load" do + it "loads configuration from .amber-lsp.yml in project root" do + with_tempdir do |dir| + yaml = <<-YAML + rules: + amber/model-naming: + enabled: false + YAML + + File.write(File.join(dir, ".amber-lsp.yml"), yaml) + + config = AmberLSP::Configuration.load(dir) + config.rule_enabled?("amber/model-naming").should be_false + end + end + + it "returns default configuration when no config file exists" do + with_tempdir do |dir| + config = AmberLSP::Configuration.load(dir) + config.rule_enabled?("any-rule").should be_true + config.exclude_patterns.should eq(["lib/", "tmp/", "db/migrations/"]) + end + end + end +end diff --git a/spec/amber_lsp/controller_spec.cr b/spec/amber_lsp/controller_spec.cr new file mode 100644 index 0000000..fb78e2e --- /dev/null +++ b/spec/amber_lsp/controller_spec.cr @@ -0,0 +1,128 @@ +require "./spec_helper" + +describe AmberLSP::Controller do + describe "#handle initialize" do + it "returns server capabilities with correct structure" do + input = IO::Memory.new("") + output = IO::Memory.new + server = AmberLSP::Server.new(input, output) + + request = { + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "capabilities" => {} of String => String, + }, + }.to_json + + response = server.controller.handle(request, server) + response.should_not be_nil + + json = JSON.parse(response.not_nil!) + json["jsonrpc"].as_s.should eq("2.0") + json["id"].as_i.should eq(1) + + result = json["result"] + capabilities = result["capabilities"] + + # Check textDocumentSync + text_doc_sync = capabilities["textDocumentSync"] + text_doc_sync["openClose"].as_bool.should be_true + text_doc_sync["change"].as_i.should eq(1) + text_doc_sync["save"]["includeText"].as_bool.should be_true + + # Check serverInfo + server_info = result["serverInfo"] + server_info["name"].as_s.should eq("amber-lsp") + server_info["version"].as_s.should eq(AmberLSP::VERSION) + end + end + + describe "#handle shutdown" do + it "returns null result" do + input = IO::Memory.new("") + output = IO::Memory.new + server = AmberLSP::Server.new(input, output) + + request = { + "jsonrpc" => "2.0", + "id" => 42, + "method" => "shutdown", + }.to_json + + response = server.controller.handle(request, server) + response.should_not be_nil + + json = JSON.parse(response.not_nil!) + json["id"].as_i.should eq(42) + json["result"].raw.should be_nil + end + end + + describe "#handle unknown method" do + it "returns method not found error for unknown methods with id" do + input = IO::Memory.new("") + output = IO::Memory.new + server = AmberLSP::Server.new(input, output) + + request = { + "jsonrpc" => "2.0", + "id" => 99, + "method" => "textDocument/hover", + }.to_json + + response = server.controller.handle(request, server) + response.should_not be_nil + + json = JSON.parse(response.not_nil!) + json["error"]["code"].as_i.should eq(-32601) + json["error"]["message"].as_s.should contain("Method not found") + end + + it "returns nil for unknown notifications (no id)" do + input = IO::Memory.new("") + output = IO::Memory.new + server = AmberLSP::Server.new(input, output) + + request = { + "jsonrpc" => "2.0", + "method" => "$/unknownNotification", + }.to_json + + response = server.controller.handle(request, server) + response.should be_nil + end + end + + describe "#handle invalid JSON" do + it "returns parse error for malformed JSON" do + input = IO::Memory.new("") + output = IO::Memory.new + server = AmberLSP::Server.new(input, output) + + response = server.controller.handle("{invalid json}", server) + response.should_not be_nil + + json = JSON.parse(response.not_nil!) + json["error"]["code"].as_i.should eq(-32700) + json["error"]["message"].as_s.should contain("Parse error") + end + end + + describe "#handle exit" do + it "stops the server" do + input = IO::Memory.new("") + output = IO::Memory.new + server = AmberLSP::Server.new(input, output) + + request = { + "jsonrpc" => "2.0", + "method" => "exit", + }.to_json + + response = server.controller.handle(request, server) + response.should be_nil + end + end +end diff --git a/spec/amber_lsp/custom_rules_integration_spec.cr b/spec/amber_lsp/custom_rules_integration_spec.cr new file mode 100644 index 0000000..5f8f0ab --- /dev/null +++ b/spec/amber_lsp/custom_rules_integration_spec.cr @@ -0,0 +1,287 @@ +require "./spec_helper" +require "../../src/amber_lsp/rules/custom_rule" + +describe "Custom Rules Integration" do + before_each do + AmberLSP::Rules::RuleRegistry.clear + end + + describe "Configuration parsing" do + it "parses custom_rules from YAML" do + yaml = <<-YAML + custom_rules: + - id: "project/no-puts" + description: "Do not use puts in production code" + severity: warning + applies_to: ["src/**"] + pattern: "\\\\bputs\\\\b" + message: "Avoid 'puts' in production code." + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.custom_rules.size.should eq(1) + config.custom_rules[0].id.should eq("project/no-puts") + config.custom_rules[0].description.should eq("Do not use puts in production code") + config.custom_rules[0].severity.should eq("warning") + config.custom_rules[0].applies_to.should eq(["src/**"]) + config.custom_rules[0].negate?.should be_false + end + + it "parses custom_rules with negate flag" do + yaml = <<-YAML + custom_rules: + - id: "project/require-copyright" + description: "Every file must have a copyright header" + severity: info + applies_to: ["src/**"] + pattern: "^# Copyright" + negate: true + message: "Missing copyright header." + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.custom_rules.size.should eq(1) + config.custom_rules[0].negate?.should be_true + end + + it "parses multiple custom_rules" do + yaml = <<-YAML + custom_rules: + - id: "project/no-puts" + description: "No puts" + severity: warning + pattern: "\\\\bputs\\\\b" + message: "No puts allowed." + - id: "project/no-sleep" + description: "No sleep" + severity: error + pattern: "\\\\bsleep\\\\b" + message: "No sleep allowed." + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.custom_rules.size.should eq(2) + config.custom_rules[0].id.should eq("project/no-puts") + config.custom_rules[1].id.should eq("project/no-sleep") + end + + it "returns empty custom_rules when section is absent" do + yaml = <<-YAML + rules: + amber/model-naming: + enabled: true + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.custom_rules.should be_empty + end + + it "skips malformed custom_rules entries missing required fields" do + yaml = <<-YAML + custom_rules: + - description: "Missing id and pattern" + severity: warning + message: "Should be skipped." + - id: "project/valid-rule" + pattern: "\\\\bputs\\\\b" + message: "This one is valid." + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.custom_rules.size.should eq(1) + config.custom_rules[0].id.should eq("project/valid-rule") + end + + it "uses default applies_to when not specified" do + yaml = <<-YAML + custom_rules: + - id: "project/no-puts" + pattern: "\\\\bputs\\\\b" + message: "No puts." + YAML + + config = AmberLSP::Configuration.parse(yaml) + config.custom_rules[0].applies_to.should eq(["src/**"]) + end + end + + describe "Analyzer with custom rules" do + it "loads custom rules from config and produces diagnostics" do + with_tempdir do |dir| + yaml = <<-YAML + custom_rules: + - id: "project/no-puts" + description: "No puts allowed" + severity: warning + applies_to: ["*.cr"] + pattern: "\\\\bputs\\\\b" + message: "Avoid 'puts' in production code." + YAML + + File.write(File.join(dir, ".amber-lsp.yml"), yaml) + + analyzer = AmberLSP::Analyzer.new + ctx = AmberLSP::ProjectContext.new(dir, amber_project: true) + analyzer.configure(ctx) + + content = "puts \"hello world\"" + diagnostics = analyzer.analyze("src/app.cr", content) + + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("project/no-puts") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Warning) + diagnostics[0].message.should eq("Avoid 'puts' in production code.") + end + end + + it "loads negated custom rules from config" do + with_tempdir do |dir| + yaml = <<-YAML + custom_rules: + - id: "project/require-copyright" + description: "Every file must have a copyright header" + severity: info + applies_to: ["*.cr"] + pattern: "^# Copyright" + negate: true + message: "Missing copyright header." + YAML + + File.write(File.join(dir, ".amber-lsp.yml"), yaml) + + analyzer = AmberLSP::Analyzer.new + ctx = AmberLSP::ProjectContext.new(dir, amber_project: true) + analyzer.configure(ctx) + + content = "def foo\n 42\nend" + diagnostics = analyzer.analyze("src/app.cr", content) + + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("project/require-copyright") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Information) + end + end + + it "custom rules can be disabled via rule configs" do + with_tempdir do |dir| + yaml = <<-YAML + rules: + project/no-puts: + enabled: false + custom_rules: + - id: "project/no-puts" + description: "No puts allowed" + severity: warning + applies_to: ["*.cr"] + pattern: "\\\\bputs\\\\b" + message: "Avoid 'puts'." + YAML + + File.write(File.join(dir, ".amber-lsp.yml"), yaml) + + analyzer = AmberLSP::Analyzer.new + ctx = AmberLSP::ProjectContext.new(dir, amber_project: true) + analyzer.configure(ctx) + + content = "puts \"hello\"" + diagnostics = analyzer.analyze("src/app.cr", content) + diagnostics.should be_empty + end + end + + it "custom rules severity can be overridden via rule configs" do + with_tempdir do |dir| + yaml = <<-YAML + rules: + project/no-puts: + severity: error + custom_rules: + - id: "project/no-puts" + description: "No puts allowed" + severity: warning + applies_to: ["*.cr"] + pattern: "\\\\bputs\\\\b" + message: "Avoid 'puts'." + YAML + + File.write(File.join(dir, ".amber-lsp.yml"), yaml) + + analyzer = AmberLSP::Analyzer.new + ctx = AmberLSP::ProjectContext.new(dir, amber_project: true) + analyzer.configure(ctx) + + content = "puts \"hello\"" + diagnostics = analyzer.analyze("src/app.cr", content) + + diagnostics.size.should eq(1) + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Error) + end + end + + it "custom rules coexist with built-in rules" do + # Register a built-in mock rule alongside the custom rule + AmberLSP::Rules::RuleRegistry.register(BuiltInMockRule.new) + + with_tempdir do |dir| + yaml = <<-YAML + custom_rules: + - id: "project/no-puts" + description: "No puts allowed" + severity: warning + applies_to: ["*.cr"] + pattern: "\\\\bputs\\\\b" + message: "Avoid 'puts'." + YAML + + File.write(File.join(dir, ".amber-lsp.yml"), yaml) + + analyzer = AmberLSP::Analyzer.new + ctx = AmberLSP::ProjectContext.new(dir, amber_project: true) + analyzer.configure(ctx) + + # Content that triggers both the built-in rule and the custom rule + content = "puts bad_pattern" + diagnostics = analyzer.analyze("src/app.cr", content) + + codes = diagnostics.map(&.code) + codes.should contain("builtin/mock-rule") + codes.should contain("project/no-puts") + end + end + end +end + +# A simple built-in mock rule for coexistence testing +class BuiltInMockRule < AmberLSP::Rules::BaseRule + def id : String + "builtin/mock-rule" + end + + def description : String + "A built-in mock rule" + end + + def default_severity : AmberLSP::Rules::Severity + AmberLSP::Rules::Severity::Warning + end + + def applies_to : Array(String) + ["*.cr"] + end + + def check(file_path : String, content : String) : Array(AmberLSP::Rules::Diagnostic) + diagnostics = [] of AmberLSP::Rules::Diagnostic + if content.includes?("bad_pattern") + diagnostics << AmberLSP::Rules::Diagnostic.new( + range: AmberLSP::Rules::TextRange.new( + AmberLSP::Rules::Position.new(0, 0), + AmberLSP::Rules::Position.new(0, 11) + ), + severity: default_severity, + code: id, + message: "Found bad_pattern" + ) + end + diagnostics + end +end diff --git a/spec/amber_lsp/diagnostic_spec.cr b/spec/amber_lsp/diagnostic_spec.cr new file mode 100644 index 0000000..d533bf9 --- /dev/null +++ b/spec/amber_lsp/diagnostic_spec.cr @@ -0,0 +1,55 @@ +require "./spec_helper" + +describe AmberLSP::Rules::Diagnostic do + describe "#to_lsp_json" do + it "returns a hash with correct LSP structure" do + diagnostic = AmberLSP::Rules::Diagnostic.new( + range: AmberLSP::Rules::TextRange.new( + AmberLSP::Rules::Position.new(5, 10), + AmberLSP::Rules::Position.new(5, 20) + ), + severity: AmberLSP::Rules::Severity::Warning, + code: "amber/test-rule", + message: "This is a test diagnostic" + ) + + json = diagnostic.to_lsp_json + + range = json["range"] + range["start"]["line"].as_i.should eq(5) + range["start"]["character"].as_i.should eq(10) + range["end"]["line"].as_i.should eq(5) + range["end"]["character"].as_i.should eq(20) + + json["severity"].as_i.should eq(2) # Warning = 2 + json["code"].as_s.should eq("amber/test-rule") + json["source"].as_s.should eq("amber-lsp") + json["message"].as_s.should eq("This is a test diagnostic") + end + + it "uses custom source when provided" do + diagnostic = AmberLSP::Rules::Diagnostic.new( + range: AmberLSP::Rules::TextRange.new( + AmberLSP::Rules::Position.new(0, 0), + AmberLSP::Rules::Position.new(0, 1) + ), + severity: AmberLSP::Rules::Severity::Error, + code: "test", + message: "error", + source: "custom-source" + ) + + json = diagnostic.to_lsp_json + json["source"].as_s.should eq("custom-source") + end + end +end + +describe AmberLSP::Rules::Severity do + it "has correct integer values for LSP protocol" do + AmberLSP::Rules::Severity::Error.value.should eq(1) + AmberLSP::Rules::Severity::Warning.value.should eq(2) + AmberLSP::Rules::Severity::Information.value.should eq(3) + AmberLSP::Rules::Severity::Hint.value.should eq(4) + end +end diff --git a/spec/amber_lsp/document_store_spec.cr b/spec/amber_lsp/document_store_spec.cr new file mode 100644 index 0000000..0824a7b --- /dev/null +++ b/spec/amber_lsp/document_store_spec.cr @@ -0,0 +1,64 @@ +require "./spec_helper" + +describe AmberLSP::DocumentStore do + describe "#update and #get" do + it "stores and retrieves a document by URI" do + store = AmberLSP::DocumentStore.new + store.update("file:///app/src/hello.cr", "puts \"hello\"") + + store.get("file:///app/src/hello.cr").should eq("puts \"hello\"") + end + + it "overwrites existing content on update" do + store = AmberLSP::DocumentStore.new + store.update("file:///app/src/hello.cr", "original") + store.update("file:///app/src/hello.cr", "updated") + + store.get("file:///app/src/hello.cr").should eq("updated") + end + + it "returns nil for unknown URIs" do + store = AmberLSP::DocumentStore.new + + store.get("file:///nonexistent.cr").should be_nil + end + end + + describe "#remove" do + it "removes a stored document" do + store = AmberLSP::DocumentStore.new + store.update("file:///app/src/hello.cr", "content") + store.remove("file:///app/src/hello.cr") + + store.get("file:///app/src/hello.cr").should be_nil + end + + it "does not raise when removing a nonexistent URI" do + store = AmberLSP::DocumentStore.new + store.remove("file:///nonexistent.cr") + end + end + + describe "#has?" do + it "returns true for stored documents" do + store = AmberLSP::DocumentStore.new + store.update("file:///app/src/hello.cr", "content") + + store.has?("file:///app/src/hello.cr").should be_true + end + + it "returns false for missing documents" do + store = AmberLSP::DocumentStore.new + + store.has?("file:///nonexistent.cr").should be_false + end + + it "returns false after removal" do + store = AmberLSP::DocumentStore.new + store.update("file:///app/src/hello.cr", "content") + store.remove("file:///app/src/hello.cr") + + store.has?("file:///app/src/hello.cr").should be_false + end + end +end diff --git a/spec/amber_lsp/integration/agent_e2e_spec.cr b/spec/amber_lsp/integration/agent_e2e_spec.cr new file mode 100644 index 0000000..912b3a7 --- /dev/null +++ b/spec/amber_lsp/integration/agent_e2e_spec.cr @@ -0,0 +1,215 @@ +require "../spec_helper" + +# End-to-end test that simulates an AI agent using the amber-lsp. +# +# The test proves the full feedback cycle: +# 1. Agent opens a file with Amber convention violations +# 2. LSP returns diagnostics identifying specific violations +# 3. Agent reads diagnostics, determines the fix +# 4. Agent saves the corrected file +# 5. LSP returns clean diagnostics (no violations) +# +# This demonstrates that an agent receiving LSP diagnostics can act on them +# to produce correct Amber code — the information loop works end-to-end. + +private def lsp_frame(message) : String + json = message.to_json + "Content-Length: #{json.bytesize}\r\n\r\n#{json}" +end + +private def read_lsp_response(io : IO) : JSON::Any? + content_length = -1 + + loop do + line = io.gets + return nil if line.nil? + + line = line.chomp + break if line.empty? + + if line.starts_with?("Content-Length:") + content_length = line.split(":")[1].strip.to_i + end + end + + return nil if content_length < 0 + + body = Bytes.new(content_length) + io.read_fully(body) + JSON.parse(String.new(body)) +rescue IO::EOFError + nil +end + +private def collect_responses(io : IO) : Array(JSON::Any) + responses = [] of JSON::Any + loop do + response = read_lsp_response(io) + break if response.nil? + responses << response + end + responses +end + +AGENT_E2E_BINARY_PATH = File.join(Dir.current, "bin", "amber-lsp") + +describe "Agent E2E: LSP diagnostic feedback loop" do + it "agent opens bad file, receives diagnostics, fixes file, receives clean diagnostics" do + with_tempdir do |dir| + # --- Setup: create a minimal Amber project --- + shard_content = <<-YAML + name: agent_test_project + version: 0.1.0 + dependencies: + amber: + github: amberframework/amber + YAML + File.write(File.join(dir, "shard.yml"), shard_content) + Dir.mkdir_p(File.join(dir, "src", "controllers")) + Dir.mkdir_p(File.join(dir, "spec", "controllers")) + + root_uri = "file://#{dir}" + file_uri = "file://#{dir}/src/controllers/users_controller.cr" + + # Create corresponding spec file (so spec-existence rule is satisfied) + File.write(File.join(dir, "spec", "controllers", "users_controller_spec.cr"), "# spec placeholder") + + # --- Step 1: Agent opens a file with multiple violations --- + # Violations: + # - Class name "UsersHandler" doesn't end with "Controller" (amber/controller-naming) + # - Public action "index" doesn't call render/redirect_to (amber/action-return-type) + bad_code = <<-CRYSTAL + class UsersHandler < Amber::Controller::Base + def index + users = ["Alice", "Bob"] + end + end + CRYSTAL + + # --- Step 2: Agent sends the file to the LSP --- + # Build the initial LSP session: initialize + didOpen + init_messages = [ + lsp_frame({ + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "textDocument/didOpen", + "params" => { + "textDocument" => { + "uri" => file_uri, + "languageId" => "crystal", + "version" => 1, + "text" => bad_code, + }, + }, + }), + ] + + # --- Step 3: Agent reads diagnostics and determines the fix --- + # The corrected code: + # - Renamed "UsersHandler" → "UsersController" (fixes controller-naming) + # - Added render call in index (fixes action-return-type) + fixed_code = <<-CRYSTAL + class UsersController < Amber::Controller::Base + def index + users = ["Alice", "Bob"] + render("index.ecr") + end + end + CRYSTAL + + # --- Step 4: Agent saves the corrected file --- + save_and_shutdown = [ + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "textDocument/didSave", + "params" => { + "textDocument" => {"uri" => file_uri}, + "text" => fixed_code, + }, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "id" => 2, + "method" => "shutdown", + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "exit", + }), + ] + + # Combine all messages into one session + all_messages = init_messages.map(&.as(String)).join + save_and_shutdown.map(&.as(String)).join + + # Spawn the LSP binary + process = Process.new( + AGENT_E2E_BINARY_PATH, + input: Process::Redirect::Pipe, + output: Process::Redirect::Pipe, + error: Process::Redirect::Close + ) + + process.input.print(all_messages) + process.input.close + + responses = collect_responses(process.output) + process.output.close + + status = process.wait + status.success?.should be_true + + # --- Verify Step 2: Initial diagnostics have violations --- + diag_notifications = responses.select { |r| + r["method"]?.try(&.as_s?) == "textDocument/publishDiagnostics" + } + + # We should get exactly 2 publishDiagnostics notifications: + # 1st from didOpen (with violations), 2nd from didSave (clean) + diag_notifications.size.should eq(2) + + # First notification: violations detected + first_diag = diag_notifications[0] + first_diag["params"]["uri"].as_s.should eq(file_uri) + violations = first_diag["params"]["diagnostics"].as_a + violation_codes = violations.map { |d| d["code"].as_s } + + # Agent received these specific violations from the LSP + violation_codes.should contain("amber/controller-naming") + violation_codes.should contain("amber/action-return-type") + + # Verify diagnostics have actionable messages + naming_diag = violations.find { |d| d["code"].as_s == "amber/controller-naming" }.not_nil! + naming_diag["message"].as_s.should contain("Controller") + naming_diag["source"].as_s.should eq("amber-lsp") + naming_diag["severity"].as_i.should eq(1) # Error severity + + action_diag = violations.find { |d| d["code"].as_s == "amber/action-return-type" }.not_nil! + action_diag["source"].as_s.should eq("amber-lsp") + + # --- Verify Step 4: After fix, diagnostics are clean --- + second_diag = diag_notifications[1] + second_diag["params"]["uri"].as_s.should eq(file_uri) + clean_diagnostics = second_diag["params"]["diagnostics"].as_a + + # No violations after the agent's fix + clean_diagnostics.should be_empty + + # --- Verify: LSP session completed cleanly --- + shutdown_response = responses.find { |r| r["id"]?.try(&.as_i?) == 2 } + shutdown_response.should_not be_nil + end + end +end diff --git a/spec/amber_lsp/integration/binary_spec.cr b/spec/amber_lsp/integration/binary_spec.cr new file mode 100644 index 0000000..0c27f3e --- /dev/null +++ b/spec/amber_lsp/integration/binary_spec.cr @@ -0,0 +1,411 @@ +require "../spec_helper" + +# Helper to format a JSON message as an LSP-framed message (Content-Length header + body) +private def lsp_frame(message) : String + json = message.to_json + "Content-Length: #{json.bytesize}\r\n\r\n#{json}" +end + +# Helper to read a single LSP response from an IO. +# Returns the parsed JSON, or nil if no more data is available. +private def read_lsp_response(io : IO) : JSON::Any? + content_length = -1 + + loop do + line = io.gets + return nil if line.nil? + + line = line.chomp + break if line.empty? + + if line.starts_with?("Content-Length:") + content_length = line.split(":")[1].strip.to_i + end + end + + return nil if content_length < 0 + + body = Bytes.new(content_length) + io.read_fully(body) + JSON.parse(String.new(body)) +rescue IO::EOFError + nil +end + +# Helper to collect all LSP responses from a process output until EOF. +private def collect_responses(io : IO) : Array(JSON::Any) + responses = [] of JSON::Any + loop do + response = read_lsp_response(io) + break if response.nil? + responses << response + end + responses +end + +BINARY_PATH = File.join(Dir.current, "bin", "amber-lsp") + +describe "amber-lsp binary" do + it "binary exists and is executable" do + File.exists?(BINARY_PATH).should be_true + File.info(BINARY_PATH).permissions.owner_execute?.should be_true + end + + it "responds to initialize and produces diagnostics via stdio" do + with_tempdir do |dir| + # Create an Amber project + shard_content = <<-YAML + name: test_project + version: 0.1.0 + dependencies: + amber: + github: amberframework/amber + YAML + File.write(File.join(dir, "shard.yml"), shard_content) + Dir.mkdir_p(File.join(dir, "src", "controllers")) + + root_uri = "file://#{dir}" + file_uri = "file://#{dir}/src/controllers/bad_handler.cr" + + bad_controller = <<-CRYSTAL + class BadHandler < ApplicationController + def index + # TODO: implement + end + end + CRYSTAL + + # Build the sequence of LSP messages + messages = [ + lsp_frame({ + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "textDocument/didOpen", + "params" => { + "textDocument" => { + "uri" => file_uri, + "languageId" => "crystal", + "version" => 1, + "text" => bad_controller, + }, + }, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "id" => 2, + "method" => "shutdown", + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "exit", + }), + ] + + input_data = messages.join + + # Spawn the binary process + process = Process.new( + BINARY_PATH, + input: Process::Redirect::Pipe, + output: Process::Redirect::Pipe, + error: Process::Redirect::Close + ) + + # Write all LSP messages to the process stdin + process.input.print(input_data) + process.input.close + + # Read all responses from stdout + responses = collect_responses(process.output) + process.output.close + + # Wait for the process to finish + status = process.wait + status.success?.should be_true + + # Verify we got responses + responses.size.should be >= 3 + + # First response: initialize result + init_response = responses[0] + init_response["id"].as_i.should eq(1) + init_response["result"]["serverInfo"]["name"].as_s.should eq("amber-lsp") + init_response["result"]["serverInfo"]["version"].as_s.should eq(AmberLSP::VERSION) + + # Second response: publishDiagnostics notification + diag_notification = responses[1] + diag_notification["method"].as_s.should eq("textDocument/publishDiagnostics") + diag_notification["params"]["uri"].as_s.should eq(file_uri) + + diagnostics = diag_notification["params"]["diagnostics"].as_a + codes = diagnostics.map { |d| d["code"].as_s } + + # BadHandler triggers controller-naming; missing response method triggers action-return-type + codes.should contain("amber/controller-naming") + codes.should contain("amber/action-return-type") + + # Verify proper LSP diagnostic structure + diagnostics.each do |diag| + diag["source"].as_s.should eq("amber-lsp") + diag["range"]["start"]["line"].as_i.should be >= 0 + diag["range"]["start"]["character"].as_i.should be >= 0 + diag["severity"].as_i.should be >= 1 + diag["severity"].as_i.should be <= 4 + end + + # Last response: shutdown with null result + shutdown_response = responses.find { |r| r["id"]?.try(&.as_i?) == 2 } + shutdown_response.should_not be_nil + shutdown_response.not_nil!["result"].raw.should be_nil + end + end + + it "produces no diagnostics for non-Amber projects via stdio" do + with_tempdir do |dir| + # Create a non-Amber project + shard_content = <<-YAML + name: plain_project + version: 0.1.0 + dependencies: + kemal: + github: kemalcr/kemal + YAML + File.write(File.join(dir, "shard.yml"), shard_content) + Dir.mkdir_p(File.join(dir, "src", "controllers")) + + root_uri = "file://#{dir}" + file_uri = "file://#{dir}/src/controllers/bad_handler.cr" + + bad_controller = <<-CRYSTAL + class BadHandler < HTTP::Server + def index + end + end + CRYSTAL + + messages = [ + lsp_frame({ + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "textDocument/didSave", + "params" => { + "textDocument" => {"uri" => file_uri}, + "text" => bad_controller, + }, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "id" => 2, + "method" => "shutdown", + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "exit", + }), + ] + + input_data = messages.join + + process = Process.new( + BINARY_PATH, + input: Process::Redirect::Pipe, + output: Process::Redirect::Pipe, + error: Process::Redirect::Close + ) + + process.input.print(input_data) + process.input.close + + responses = collect_responses(process.output) + process.output.close + + status = process.wait + status.success?.should be_true + + # Should have initialize and shutdown responses only (no publishDiagnostics) + diag_notifications = responses.select { |r| r["method"]?.try(&.as_s?) == "textDocument/publishDiagnostics" } + diag_notifications.should be_empty + end + end + + it "handles job rule violations via stdio" do + with_tempdir do |dir| + shard_content = <<-YAML + name: test_project + version: 0.1.0 + dependencies: + amber: + github: amberframework/amber + YAML + File.write(File.join(dir, "shard.yml"), shard_content) + Dir.mkdir_p(File.join(dir, "src", "jobs")) + + root_uri = "file://#{dir}" + file_uri = "file://#{dir}/src/jobs/bad_job.cr" + + bad_job = <<-CRYSTAL + class BadJob < Amber::Jobs::Job + end + CRYSTAL + + messages = [ + lsp_frame({ + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "textDocument/didOpen", + "params" => { + "textDocument" => { + "uri" => file_uri, + "languageId" => "crystal", + "version" => 1, + "text" => bad_job, + }, + }, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "id" => 2, + "method" => "shutdown", + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "exit", + }), + ] + + input_data = messages.join + + process = Process.new( + BINARY_PATH, + input: Process::Redirect::Pipe, + output: Process::Redirect::Pipe, + error: Process::Redirect::Close + ) + + process.input.print(input_data) + process.input.close + + responses = collect_responses(process.output) + process.output.close + + status = process.wait + status.success?.should be_true + + diag_notifications = responses.select { |r| r["method"]?.try(&.as_s?) == "textDocument/publishDiagnostics" } + diag_notifications.size.should be >= 1 + + codes = diag_notifications[0]["params"]["diagnostics"].as_a.map { |d| d["code"].as_s } + codes.should contain("amber/job-perform") + codes.should contain("amber/job-serializable") + end + end + + it "exits cleanly after shutdown + exit sequence" do + with_tempdir do |dir| + shard_content = <<-YAML + name: test_project + version: 0.1.0 + dependencies: + amber: + github: amberframework/amber + YAML + File.write(File.join(dir, "shard.yml"), shard_content) + + root_uri = "file://#{dir}" + + messages = [ + lsp_frame({ + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }), + lsp_frame({ + "jsonrpc" => "2.0", + "id" => 2, + "method" => "shutdown", + }), + lsp_frame({ + "jsonrpc" => "2.0", + "method" => "exit", + }), + ] + + input_data = messages.join + + process = Process.new( + BINARY_PATH, + input: Process::Redirect::Pipe, + output: Process::Redirect::Pipe, + error: Process::Redirect::Close + ) + + process.input.print(input_data) + process.input.close + + responses = collect_responses(process.output) + process.output.close + + status = process.wait + status.success?.should be_true + + # Should have initialize response and shutdown response + responses.size.should eq(2) + + init_response = responses[0] + init_response["id"].as_i.should eq(1) + init_response["result"]["serverInfo"]["name"].as_s.should eq("amber-lsp") + + shutdown_response = responses[1] + shutdown_response["id"].as_i.should eq(2) + shutdown_response["result"].raw.should be_nil + end + end +end diff --git a/spec/amber_lsp/integration/diagnostics_spec.cr b/spec/amber_lsp/integration/diagnostics_spec.cr new file mode 100644 index 0000000..7895292 --- /dev/null +++ b/spec/amber_lsp/integration/diagnostics_spec.cr @@ -0,0 +1,528 @@ +require "../spec_helper" + +# Require all rule implementations so they auto-register +require "../../../src/amber_lsp/rules/controllers/*" +require "../../../src/amber_lsp/rules/jobs/*" +require "../../../src/amber_lsp/rules/channels/*" +require "../../../src/amber_lsp/rules/pipes/*" +require "../../../src/amber_lsp/rules/mailers/*" +require "../../../src/amber_lsp/rules/schemas/*" +require "../../../src/amber_lsp/rules/file_naming/*" +require "../../../src/amber_lsp/rules/routing/*" +require "../../../src/amber_lsp/rules/specs/*" +require "../../../src/amber_lsp/rules/sockets/*" + +# Re-register all rules. This is needed because other spec files may call +# RuleRegistry.clear in their before_each blocks, removing the rules that +# were registered at require time. When running the full suite, the integration +# tests may execute after those clears have removed all rules. +private def register_all_rules : Nil + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::NamingRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::InheritanceRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::BeforeActionRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::ActionReturnRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Jobs::PerformRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Jobs::SerializableRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Channels::HandleMessageRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Pipes::CallNextRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Mailers::RequiredMethodsRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Schemas::FieldTypeRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::FileNaming::SnakeCaseRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::FileNaming::DirectoryStructureRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Routing::ControllerActionExistenceRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Specs::SpecExistenceRule.new) + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Sockets::SocketChannelRule.new) +end + +# Helper to create a temp Amber project directory with shard.yml +private def create_amber_project(dir : String) : Nil + shard_content = <<-YAML + name: test_project + version: 0.1.0 + dependencies: + amber: + github: amberframework/amber + YAML + File.write(File.join(dir, "shard.yml"), shard_content) +end + +# Helper to create a temp non-Amber project directory with shard.yml +private def create_non_amber_project(dir : String) : Nil + shard_content = <<-YAML + name: plain_project + version: 0.1.0 + dependencies: + kemal: + github: kemalcr/kemal + YAML + File.write(File.join(dir, "shard.yml"), shard_content) +end + +# Helper to build standard LSP initialize + initialized messages +private def initialize_messages(root_uri : String) : Array(Hash(String, String | Int32 | Hash(String, String))) + [ + { + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }, + { + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }, + ] +end + +# Helper to extract diagnostic notifications from responses +private def diagnostic_notifications(responses : Array(JSON::Any)) : Array(JSON::Any) + responses.select { |r| r["method"]?.try(&.as_s?) == "textDocument/publishDiagnostics" } +end + +# Helper to extract diagnostic codes from a publishDiagnostics notification +private def diagnostic_codes(notification : JSON::Any) : Array(String) + notification["params"]["diagnostics"].as_a.map { |d| d["code"].as_s } +end + +describe "LSP Integration: Full Lifecycle" do + before_each { register_all_rules } + + it "completes a full initialize -> didOpen -> didSave -> didClose -> shutdown -> exit lifecycle" do + with_tempdir do |dir| + create_amber_project(dir) + + # Create the controllers directory for the file + Dir.mkdir_p(File.join(dir, "src", "controllers")) + + root_uri = "file://#{dir}" + file_uri = "file://#{dir}/src/controllers/bad_handler.cr" + + bad_controller_content = <<-CRYSTAL + class BadHandler < ApplicationController + def index + # TODO: fix this action + end + end + CRYSTAL + + corrected_controller_content = <<-CRYSTAL + class HomeController < ApplicationController + def index + render("index.ecr") + end + end + CRYSTAL + + messages = [ + # 1. Initialize + { + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }, + # 2. Initialized notification + { + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }, + # 3. didOpen with invalid controller (bad naming + missing render) + { + "jsonrpc" => "2.0", + "method" => "textDocument/didOpen", + "params" => { + "textDocument" => { + "uri" => file_uri, + "languageId" => "crystal", + "version" => 1, + "text" => bad_controller_content, + }, + }, + }, + # 4. didSave with corrected version + { + "jsonrpc" => "2.0", + "method" => "textDocument/didSave", + "params" => { + "textDocument" => {"uri" => file_uri}, + "text" => corrected_controller_content, + }, + }, + # 5. didClose + { + "jsonrpc" => "2.0", + "method" => "textDocument/didClose", + "params" => { + "textDocument" => {"uri" => file_uri}, + }, + }, + # 6. Shutdown + { + "jsonrpc" => "2.0", + "id" => 2, + "method" => "shutdown", + }, + # 7. Exit + { + "jsonrpc" => "2.0", + "method" => "exit", + }, + ] + + responses = run_lsp_session(messages) + + # Verify initialize response + init_response = responses[0] + init_response["id"].as_i.should eq(1) + init_response["result"]["serverInfo"]["name"].as_s.should eq("amber-lsp") + init_response["result"]["capabilities"]["textDocumentSync"]["openClose"].as_bool.should be_true + + # Gather all diagnostic notifications + diag_notifications = diagnostic_notifications(responses) + + # Should have at least 3 publishDiagnostics: didOpen, didSave, didClose + diag_notifications.size.should be >= 3 + + # First publishDiagnostics (from didOpen with bad controller) + first_diag = diag_notifications[0] + first_diag["params"]["uri"].as_s.should eq(file_uri) + first_diag_codes = diagnostic_codes(first_diag) + # BadHandler triggers controller-naming; missing render triggers action-return-type + first_diag_codes.should contain("amber/controller-naming") + first_diag_codes.should contain("amber/action-return-type") + + # Second publishDiagnostics (from didSave with corrected controller) + second_diag = diag_notifications[1] + second_diag["params"]["uri"].as_s.should eq(file_uri) + second_diag_codes = diagnostic_codes(second_diag) + # Corrected controller should NOT have naming or action-return-type violations + second_diag_codes.should_not contain("amber/controller-naming") + second_diag_codes.should_not contain("amber/action-return-type") + + # Third publishDiagnostics (from didClose) should be empty + third_diag = diag_notifications[2] + third_diag["params"]["uri"].as_s.should eq(file_uri) + third_diag["params"]["diagnostics"].as_a.should be_empty + + # Verify shutdown response returns null result + shutdown_response = responses.find { |r| r["id"]?.try(&.as_i?) == 2 } + shutdown_response.should_not be_nil + shutdown_response.not_nil!["result"].raw.should be_nil + end + end +end + +describe "LSP Integration: Multi-Rule Diagnostics" do + before_each { register_all_rules } + + it "triggers controller-naming, controller-inheritance, filter-syntax, and action-return-type" do + with_tempdir do |dir| + create_amber_project(dir) + Dir.mkdir_p(File.join(dir, "src", "controllers")) + + root_uri = "file://#{dir}" + file_uri = "file://#{dir}/src/controllers/bad_handler.cr" + + # This content is designed to trigger 4 specific rules: + # 1. controller-naming: BadHandler does not end with Controller + # 2. controller-inheritance: PostsController inherits from HTTP::Server (wrong parent) + # 3. filter-syntax: before_action :authenticate uses Rails symbol syntax + # 4. action-return-type: create method has no response method call + multi_violation_content = <<-CRYSTAL + class BadHandler < ApplicationController + before_action :authenticate + def create + # TODO: implement this + end + end + + class PostsController < HTTP::Server + end + CRYSTAL + + messages = [ + { + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }, + { + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }, + { + "jsonrpc" => "2.0", + "method" => "textDocument/didOpen", + "params" => { + "textDocument" => { + "uri" => file_uri, + "languageId" => "crystal", + "version" => 1, + "text" => multi_violation_content, + }, + }, + }, + { + "jsonrpc" => "2.0", + "id" => 2, + "method" => "shutdown", + }, + { + "jsonrpc" => "2.0", + "method" => "exit", + }, + ] + + responses = run_lsp_session(messages) + + diag_notifications = diagnostic_notifications(responses) + diag_notifications.size.should be >= 1 + + codes = diagnostic_codes(diag_notifications[0]) + + # All 4 specific rule violations must be present + codes.should contain("amber/controller-naming") + codes.should contain("amber/controller-inheritance") + codes.should contain("amber/filter-syntax") + codes.should contain("amber/action-return-type") + + # Verify each diagnostic has the correct structure + diagnostics = diag_notifications[0]["params"]["diagnostics"].as_a + + diagnostics.each do |diag| + diag["source"].as_s.should eq("amber-lsp") + diag["range"]["start"]["line"].as_i.should be >= 0 + diag["range"]["start"]["character"].as_i.should be >= 0 + diag["range"]["end"]["line"].as_i.should be >= 0 + diag["range"]["end"]["character"].as_i.should be >= 0 + diag["severity"].as_i.should be >= 1 + diag["severity"].as_i.should be <= 4 + end + end + end +end + +describe "LSP Integration: Non-Amber Project" do + before_each { register_all_rules } + + it "produces no diagnostics for a non-Amber project" do + with_tempdir do |dir| + create_non_amber_project(dir) + Dir.mkdir_p(File.join(dir, "src", "controllers")) + + root_uri = "file://#{dir}" + file_uri = "file://#{dir}/src/controllers/bad_handler.cr" + + bad_code = <<-CRYSTAL + class BadHandler < HTTP::Server + before_action :authenticate + def create + end + end + CRYSTAL + + messages = [ + { + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }, + { + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }, + { + "jsonrpc" => "2.0", + "method" => "textDocument/didSave", + "params" => { + "textDocument" => {"uri" => file_uri}, + "text" => bad_code, + }, + }, + { + "jsonrpc" => "2.0", + "id" => 2, + "method" => "shutdown", + }, + { + "jsonrpc" => "2.0", + "method" => "exit", + }, + ] + + responses = run_lsp_session(messages) + + # Should have only initialize and shutdown responses -- no publishDiagnostics + diag_notifications = diagnostic_notifications(responses) + diag_notifications.should be_empty + end + end +end + +describe "LSP Integration: Job Rules" do + before_each { register_all_rules } + + it "detects missing perform method and missing JSON::Serializable in job classes" do + with_tempdir do |dir| + create_amber_project(dir) + Dir.mkdir_p(File.join(dir, "src", "jobs")) + + root_uri = "file://#{dir}" + file_uri = "file://#{dir}/src/jobs/bad_job.cr" + + bad_job_content = <<-CRYSTAL + class BadJob < Amber::Jobs::Job + end + CRYSTAL + + messages = [ + { + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }, + { + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }, + { + "jsonrpc" => "2.0", + "method" => "textDocument/didOpen", + "params" => { + "textDocument" => { + "uri" => file_uri, + "languageId" => "crystal", + "version" => 1, + "text" => bad_job_content, + }, + }, + }, + { + "jsonrpc" => "2.0", + "id" => 2, + "method" => "shutdown", + }, + { + "jsonrpc" => "2.0", + "method" => "exit", + }, + ] + + responses = run_lsp_session(messages) + + diag_notifications = diagnostic_notifications(responses) + diag_notifications.size.should be >= 1 + + codes = diagnostic_codes(diag_notifications[0]) + codes.should contain("amber/job-perform") + codes.should contain("amber/job-serializable") + end + end +end + +describe "LSP Integration: Configuration Override" do + before_each { register_all_rules } + + it "respects .amber-lsp.yml to disable specific rules" do + with_tempdir do |dir| + create_amber_project(dir) + Dir.mkdir_p(File.join(dir, "src", "controllers")) + + # Create config that disables controller-naming rule + config_content = <<-YAML + rules: + amber/controller-naming: + enabled: false + YAML + File.write(File.join(dir, ".amber-lsp.yml"), config_content) + + root_uri = "file://#{dir}" + file_uri = "file://#{dir}/src/controllers/bad_handler.cr" + + # This content violates controller-naming (BadHandler) and filter-syntax (before_action :auth) + bad_code = <<-CRYSTAL + class BadHandler < ApplicationController + before_action :authenticate + def index + render("index.ecr") + end + end + CRYSTAL + + messages = [ + { + "jsonrpc" => "2.0", + "id" => 1, + "method" => "initialize", + "params" => { + "rootUri" => root_uri, + "capabilities" => {} of String => String, + }, + }, + { + "jsonrpc" => "2.0", + "method" => "initialized", + "params" => {} of String => String, + }, + { + "jsonrpc" => "2.0", + "method" => "textDocument/didOpen", + "params" => { + "textDocument" => { + "uri" => file_uri, + "languageId" => "crystal", + "version" => 1, + "text" => bad_code, + }, + }, + }, + { + "jsonrpc" => "2.0", + "id" => 2, + "method" => "shutdown", + }, + { + "jsonrpc" => "2.0", + "method" => "exit", + }, + ] + + responses = run_lsp_session(messages) + + diag_notifications = diagnostic_notifications(responses) + diag_notifications.size.should be >= 1 + + codes = diagnostic_codes(diag_notifications[0]) + + # controller-naming should NOT be present (disabled in config) + codes.should_not contain("amber/controller-naming") + + # filter-syntax SHOULD still be present (not disabled) + codes.should contain("amber/filter-syntax") + end + end +end diff --git a/spec/amber_lsp/project_context_spec.cr b/spec/amber_lsp/project_context_spec.cr new file mode 100644 index 0000000..808a44b --- /dev/null +++ b/spec/amber_lsp/project_context_spec.cr @@ -0,0 +1,71 @@ +require "./spec_helper" + +describe AmberLSP::ProjectContext do + describe ".detect" do + it "detects an Amber project when shard.yml has amber dependency" do + with_tempdir do |dir| + shard_content = <<-YAML + name: my_app + version: 0.1.0 + dependencies: + amber: + github: amberframework/amber + version: ~> 2.0.0 + YAML + + File.write(File.join(dir, "shard.yml"), shard_content) + + ctx = AmberLSP::ProjectContext.detect(dir) + ctx.amber_project?.should be_true + ctx.root_path.should eq(dir) + end + end + + it "returns false when shard.yml has no amber dependency" do + with_tempdir do |dir| + shard_content = <<-YAML + name: my_app + version: 0.1.0 + dependencies: + kemal: + github: kemalcr/kemal + YAML + + File.write(File.join(dir, "shard.yml"), shard_content) + + ctx = AmberLSP::ProjectContext.detect(dir) + ctx.amber_project?.should be_false + end + end + + it "returns false when there is no shard.yml" do + with_tempdir do |dir| + ctx = AmberLSP::ProjectContext.detect(dir) + ctx.amber_project?.should be_false + end + end + + it "returns false when shard.yml has no dependencies section" do + with_tempdir do |dir| + shard_content = <<-YAML + name: my_app + version: 0.1.0 + YAML + + File.write(File.join(dir, "shard.yml"), shard_content) + + ctx = AmberLSP::ProjectContext.detect(dir) + ctx.amber_project?.should be_false + end + end + + it "returns false for invalid YAML" do + with_tempdir do |dir| + File.write(File.join(dir, "shard.yml"), "{{invalid yaml") + + ctx = AmberLSP::ProjectContext.detect(dir) + ctx.amber_project?.should be_false + end + end + end +end diff --git a/spec/amber_lsp/rule_registry_spec.cr b/spec/amber_lsp/rule_registry_spec.cr new file mode 100644 index 0000000..17f09d1 --- /dev/null +++ b/spec/amber_lsp/rule_registry_spec.cr @@ -0,0 +1,107 @@ +require "./spec_helper" + +# Reuse MockTestRule and MockControllerRule from analyzer_spec +# But we need to define them here too since specs can run independently + +class RegistryMockRule < AmberLSP::Rules::BaseRule + def id : String + "registry/mock-rule" + end + + def description : String + "A mock rule for registry testing" + end + + def default_severity : AmberLSP::Rules::Severity + AmberLSP::Rules::Severity::Warning + end + + def applies_to : Array(String) + ["*.cr"] + end + + def check(file_path : String, content : String) : Array(AmberLSP::Rules::Diagnostic) + [] of AmberLSP::Rules::Diagnostic + end +end + +class RegistryControllerMockRule < AmberLSP::Rules::BaseRule + def id : String + "registry/controller-mock" + end + + def description : String + "A controller-only rule" + end + + def default_severity : AmberLSP::Rules::Severity + AmberLSP::Rules::Severity::Error + end + + def applies_to : Array(String) + ["*_controller.cr"] + end + + def check(file_path : String, content : String) : Array(AmberLSP::Rules::Diagnostic) + [] of AmberLSP::Rules::Diagnostic + end +end + +describe AmberLSP::Rules::RuleRegistry do + before_each do + AmberLSP::Rules::RuleRegistry.clear + end + + describe ".register and .rules" do + it "registers and returns rules" do + rule = RegistryMockRule.new + AmberLSP::Rules::RuleRegistry.register(rule) + + AmberLSP::Rules::RuleRegistry.rules.size.should eq(1) + AmberLSP::Rules::RuleRegistry.rules[0].id.should eq("registry/mock-rule") + end + + it "accumulates multiple rules" do + AmberLSP::Rules::RuleRegistry.register(RegistryMockRule.new) + AmberLSP::Rules::RuleRegistry.register(RegistryControllerMockRule.new) + + AmberLSP::Rules::RuleRegistry.rules.size.should eq(2) + end + end + + describe ".rules_for_file" do + it "returns rules that match the file path" do + AmberLSP::Rules::RuleRegistry.register(RegistryMockRule.new) + AmberLSP::Rules::RuleRegistry.register(RegistryControllerMockRule.new) + + # *.cr matches any .cr file + rules = AmberLSP::Rules::RuleRegistry.rules_for_file("src/models/user.cr") + rules.size.should eq(1) + rules[0].id.should eq("registry/mock-rule") + end + + it "returns controller rules for controller files" do + AmberLSP::Rules::RuleRegistry.register(RegistryMockRule.new) + AmberLSP::Rules::RuleRegistry.register(RegistryControllerMockRule.new) + + rules = AmberLSP::Rules::RuleRegistry.rules_for_file("src/controllers/home_controller.cr") + rules.size.should eq(2) + end + + it "returns empty array when no rules match" do + AmberLSP::Rules::RuleRegistry.register(RegistryControllerMockRule.new) + + rules = AmberLSP::Rules::RuleRegistry.rules_for_file("src/models/user.cr") + rules.should be_empty + end + end + + describe ".clear" do + it "removes all registered rules" do + AmberLSP::Rules::RuleRegistry.register(RegistryMockRule.new) + AmberLSP::Rules::RuleRegistry.clear + + AmberLSP::Rules::RuleRegistry.rules.should be_empty + end + end +end diff --git a/spec/amber_lsp/rules/channels/handle_message_rule_spec.cr b/spec/amber_lsp/rules/channels/handle_message_rule_spec.cr new file mode 100644 index 0000000..98cfce4 --- /dev/null +++ b/spec/amber_lsp/rules/channels/handle_message_rule_spec.cr @@ -0,0 +1,102 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/channels/handle_message_rule" + +describe AmberLSP::Rules::Channels::HandleMessageRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Channels::HandleMessageRule.new) + end + + describe "#check" do + it "produces no diagnostics when channel defines handle_message" do + content = <<-CRYSTAL + class ChatChannel < Amber::WebSockets::Channel + def handle_message(msg) + rebroadcast!(msg) + end + end + CRYSTAL + + rule = AmberLSP::Rules::Channels::HandleMessageRule.new + diagnostics = rule.check("src/channels/chat_channel.cr", content) + diagnostics.should be_empty + end + + it "reports error when channel is missing handle_message" do + content = <<-CRYSTAL + class ChatChannel < Amber::WebSockets::Channel + def on_connect + true + end + end + CRYSTAL + + rule = AmberLSP::Rules::Channels::HandleMessageRule.new + diagnostics = rule.check("src/channels/chat_channel.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/channel-handle-message") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Error) + diagnostics[0].message.should contain("ChatChannel") + diagnostics[0].message.should contain("handle_message") + end + + it "skips abstract channel classes" do + content = <<-CRYSTAL + abstract class BaseChannel < Amber::WebSockets::Channel + end + CRYSTAL + + rule = AmberLSP::Rules::Channels::HandleMessageRule.new + diagnostics = rule.check("src/channels/base_channel.cr", content) + diagnostics.should be_empty + end + + it "skips files not in channels/ directory" do + content = <<-CRYSTAL + class ChatChannel < Amber::WebSockets::Channel + def on_connect + true + end + end + CRYSTAL + + rule = AmberLSP::Rules::Channels::HandleMessageRule.new + diagnostics = rule.check("src/models/chat.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Channels::HandleMessageRule.new + diagnostics = rule.check("src/channels/chat_channel.cr", "") + diagnostics.should be_empty + end + + it "produces no diagnostics for files without channel classes" do + content = <<-CRYSTAL + class Helper + def help + "not a channel" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Channels::HandleMessageRule.new + diagnostics = rule.check("src/channels/helper.cr", content) + diagnostics.should be_empty + end + + it "handles handle_message with typed parameters" do + content = <<-CRYSTAL + class ChatChannel < Amber::WebSockets::Channel + def handle_message(msg : String) + rebroadcast!(msg) + end + end + CRYSTAL + + rule = AmberLSP::Rules::Channels::HandleMessageRule.new + diagnostics = rule.check("src/channels/chat_channel.cr", content) + diagnostics.should be_empty + end + end +end diff --git a/spec/amber_lsp/rules/controllers/action_return_rule_spec.cr b/spec/amber_lsp/rules/controllers/action_return_rule_spec.cr new file mode 100644 index 0000000..7a0b6fb --- /dev/null +++ b/spec/amber_lsp/rules/controllers/action_return_rule_spec.cr @@ -0,0 +1,182 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/controllers/action_return_rule" + +describe AmberLSP::Rules::Controllers::ActionReturnRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::ActionReturnRule.new) + end + + describe "#check" do + it "produces no diagnostics when actions call render" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics when actions call redirect_to" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def create + redirect_to "/home" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics when actions call redirect_back" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def back + redirect_back + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics when actions call respond_with" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def show + respond_with do + json({ name: "test" }) + end + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics when actions call halt!" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def restricted + halt!(403, "Forbidden") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "reports warning when action does not call any response method" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def index + @users = User.all + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/action-return-type") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Warning) + diagnostics[0].message.should contain("index") + diagnostics[0].message.should contain("render") + end + + it "skips private methods" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def index + render("index.ecr") + end + + private def helper_method + "helper" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "skips methods after private keyword" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def index + render("index.ecr") + end + + private + + def helper_method + "helper" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "skips files not in controllers/ directory" do + content = <<-CRYSTAL + class SomeService + def call + "no render needed" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/services/some_service.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", "") + diagnostics.should be_empty + end + + it "handles multiple actions with mixed compliance" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def index + render("index.ecr") + end + + def show + @user = User.find(params[:id]) + end + + def create + redirect_to "/home" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::ActionReturnRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("show") + end + end +end diff --git a/spec/amber_lsp/rules/controllers/before_action_rule_spec.cr b/spec/amber_lsp/rules/controllers/before_action_rule_spec.cr new file mode 100644 index 0000000..6840ac6 --- /dev/null +++ b/spec/amber_lsp/rules/controllers/before_action_rule_spec.cr @@ -0,0 +1,140 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/controllers/before_action_rule" + +describe AmberLSP::Rules::Controllers::BeforeActionRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::BeforeActionRule.new) + end + + describe "#check" do + it "produces no diagnostics for correct Amber filter syntax" do + content = <<-CRYSTAL + class HomeController < ApplicationController + before_action do + redirect_to "/" unless logged_in? + end + + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::BeforeActionRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "reports error for Rails-style before_action with symbol" do + content = <<-CRYSTAL + class HomeController < ApplicationController + before_action :authenticate_user + + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::BeforeActionRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/filter-syntax") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Error) + diagnostics[0].message.should contain("before_action :authenticate_user") + diagnostics[0].message.should contain("block syntax") + end + + it "reports error for Rails-style after_action with symbol" do + content = <<-CRYSTAL + class HomeController < ApplicationController + after_action :log_activity + + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::BeforeActionRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("after_action :log_activity") + end + + it "reports error for deprecated before_filter" do + content = <<-CRYSTAL + class HomeController < ApplicationController + before_filter :authenticate + + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::BeforeActionRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("before_filter") + diagnostics[0].message.should contain("deprecated") + diagnostics[0].message.should contain("before_action") + end + + it "reports error for deprecated after_filter" do + content = <<-CRYSTAL + class HomeController < ApplicationController + after_filter :log_it + + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::BeforeActionRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("after_filter") + diagnostics[0].message.should contain("deprecated") + diagnostics[0].message.should contain("after_action") + end + + it "skips files not in controllers/ directory" do + content = <<-CRYSTAL + class SomeClass + before_action :something + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::BeforeActionRule.new + diagnostics = rule.check("src/models/some_class.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Controllers::BeforeActionRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", "") + diagnostics.should be_empty + end + + it "reports multiple violations in the same file" do + content = <<-CRYSTAL + class HomeController < ApplicationController + before_action :authenticate + after_action :log_activity + before_filter :old_method + + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::BeforeActionRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(3) + end + end +end diff --git a/spec/amber_lsp/rules/controllers/inheritance_rule_spec.cr b/spec/amber_lsp/rules/controllers/inheritance_rule_spec.cr new file mode 100644 index 0000000..a4428e5 --- /dev/null +++ b/spec/amber_lsp/rules/controllers/inheritance_rule_spec.cr @@ -0,0 +1,111 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/controllers/inheritance_rule" + +describe AmberLSP::Rules::Controllers::InheritanceRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::InheritanceRule.new) + end + + describe "#check" do + it "produces no diagnostics when inheriting from ApplicationController" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::InheritanceRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics when inheriting from Amber::Controller::Base" do + content = <<-CRYSTAL + class HomeController < Amber::Controller::Base + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::InheritanceRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "reports error when inheriting from an invalid base class" do + content = <<-CRYSTAL + class HomeController < SomeOtherBase + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::InheritanceRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/controller-inheritance") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Error) + diagnostics[0].message.should contain("SomeOtherBase") + diagnostics[0].message.should contain("ApplicationController") + end + + it "skips application_controller.cr file" do + content = <<-CRYSTAL + class ApplicationController < Amber::Controller::Base + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::InheritanceRule.new + diagnostics = rule.check("src/controllers/application_controller.cr", content) + diagnostics.should be_empty + end + + it "skips files not in controllers/ directory" do + content = <<-CRYSTAL + class HomeController < SomeOtherBase + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::InheritanceRule.new + diagnostics = rule.check("src/models/home.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Controllers::InheritanceRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", "") + diagnostics.should be_empty + end + + it "handles multiple controller classes in one file" do + content = <<-CRYSTAL + class HomeController < ApplicationController + end + + class AdminController < WrongBase + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::InheritanceRule.new + diagnostics = rule.check("src/controllers/controllers.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("WrongBase") + end + + it "only checks classes whose names end in Controller" do + content = <<-CRYSTAL + class Helper < SomeBase + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::InheritanceRule.new + diagnostics = rule.check("src/controllers/helper.cr", content) + diagnostics.should be_empty + end + end +end diff --git a/spec/amber_lsp/rules/controllers/naming_rule_spec.cr b/spec/amber_lsp/rules/controllers/naming_rule_spec.cr new file mode 100644 index 0000000..d1d50d8 --- /dev/null +++ b/spec/amber_lsp/rules/controllers/naming_rule_spec.cr @@ -0,0 +1,107 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/controllers/naming_rule" + +describe AmberLSP::Rules::Controllers::NamingRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::NamingRule.new) + end + + describe "#check" do + it "produces no diagnostics for correctly named controller classes" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::NamingRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "reports error when class name does not end with Controller" do + content = <<-CRYSTAL + class Home < ApplicationController + def index + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::NamingRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/controller-naming") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Error) + diagnostics[0].message.should contain("Home") + diagnostics[0].message.should contain("Controller") + end + + it "skips files not in controllers/ directory" do + content = <<-CRYSTAL + class Home < ApplicationController + def index + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::NamingRule.new + diagnostics = rule.check("src/models/home.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Controllers::NamingRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", "") + diagnostics.should be_empty + end + + it "handles multiple classes in one file" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def index + end + end + + class Dashboard < ApplicationController + def show + end + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::NamingRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("Dashboard") + end + + it "reports errors for multiple incorrectly named classes" do + content = <<-CRYSTAL + class Home < ApplicationController + end + + class Dashboard < ApplicationController + end + CRYSTAL + + rule = AmberLSP::Rules::Controllers::NamingRule.new + diagnostics = rule.check("src/controllers/misc.cr", content) + diagnostics.size.should eq(2) + end + + it "correctly positions the diagnostic range on the class name" do + content = "class HomeController < ApplicationController\nend" + rule = AmberLSP::Rules::Controllers::NamingRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + + content_bad = "class Home < ApplicationController\nend" + diagnostics = rule.check("src/controllers/home.cr", content_bad) + diagnostics.size.should eq(1) + diagnostics[0].range.start.line.should eq(0) + end + end +end diff --git a/spec/amber_lsp/rules/custom_rule_spec.cr b/spec/amber_lsp/rules/custom_rule_spec.cr new file mode 100644 index 0000000..0a4b413 --- /dev/null +++ b/spec/amber_lsp/rules/custom_rule_spec.cr @@ -0,0 +1,238 @@ +require "../spec_helper" +require "../../../src/amber_lsp/rules/custom_rule" + +describe AmberLSP::Rules::CustomRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + end + + describe "#check" do + it "matches a basic pattern and returns diagnostics" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/no-puts", + description: "No puts allowed", + default_severity: AmberLSP::Rules::Severity::Warning, + applies_to: ["src/**"], + pattern: /\bputs\b/, + message_template: "Avoid 'puts' in production code.", + ) + + content = <<-CRYSTAL + def index + puts "hello" + end + CRYSTAL + + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("test/no-puts") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Warning) + diagnostics[0].message.should eq("Avoid 'puts' in production code.") + end + + it "substitutes capture groups into message template using {0}, {1}" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/capture-groups", + description: "Capture group substitution test", + default_severity: AmberLSP::Rules::Severity::Warning, + applies_to: ["*.cr"], + pattern: /def\s+(\w+)/, + message_template: "Found method '{1}' (full match: '{0}').", + ) + + content = "def my_method\nend" + diagnostics = rule.check("src/app.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should eq("Found method 'my_method' (full match: 'def my_method').") + end + + it "returns multiple diagnostics for multiple matches" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/no-sleep", + description: "No sleep allowed", + default_severity: AmberLSP::Rules::Severity::Error, + applies_to: ["*.cr"], + pattern: /\bsleep\b/, + message_template: "Found 'sleep' call.", + ) + + content = <<-CRYSTAL + sleep 1 + puts "hi" + sleep 2 + CRYSTAL + + diagnostics = rule.check("src/app.cr", content) + diagnostics.size.should eq(2) + diagnostics[0].range.start.line.should eq(0) + diagnostics[1].range.start.line.should eq(2) + end + + it "returns empty diagnostics when pattern does not match" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/no-puts", + description: "No puts allowed", + default_severity: AmberLSP::Rules::Severity::Warning, + applies_to: ["*.cr"], + pattern: /\bputs\b/, + message_template: "Avoid 'puts'.", + ) + + content = "def index\n render(\"index.ecr\")\nend" + diagnostics = rule.check("src/app.cr", content) + diagnostics.should be_empty + end + + it "returns empty diagnostics for an empty file" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/no-puts", + description: "No puts allowed", + default_severity: AmberLSP::Rules::Severity::Warning, + applies_to: ["*.cr"], + pattern: /\bputs\b/, + message_template: "Avoid 'puts'.", + ) + + diagnostics = rule.check("src/app.cr", "") + diagnostics.should be_empty + end + + it "skips files that do not match applies_to patterns" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/no-puts", + description: "No puts allowed", + default_severity: AmberLSP::Rules::Severity::Warning, + applies_to: ["src/controllers/*"], + pattern: /\bputs\b/, + message_template: "Avoid 'puts'.", + ) + + content = "puts \"hello\"" + diagnostics = rule.check("spec/models/user_spec.cr", content) + diagnostics.should be_empty + end + + it "matches files that satisfy applies_to patterns" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/no-puts", + description: "No puts allowed", + default_severity: AmberLSP::Rules::Severity::Warning, + applies_to: ["src/controllers/*"], + pattern: /\bputs\b/, + message_template: "Avoid 'puts'.", + ) + + content = "puts \"hello\"" + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.size.should eq(1) + end + + it "correctly positions diagnostic ranges" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/detect-todo", + description: "Detect TODO comments", + default_severity: AmberLSP::Rules::Severity::Information, + applies_to: ["*.cr"], + pattern: /TODO/, + message_template: "Found TODO comment.", + ) + + content = "# Some comment\n# TODO: fix this\ndef foo\nend" + diagnostics = rule.check("src/app.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].range.start.line.should eq(1) + diagnostics[0].range.start.character.should eq(2) + diagnostics[0].range.end.line.should eq(1) + diagnostics[0].range.end.character.should eq(6) + end + end + + describe "negate mode" do + it "reports a diagnostic when the pattern is NOT found in the file" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/require-copyright", + description: "Require copyright header", + default_severity: AmberLSP::Rules::Severity::Information, + applies_to: ["*.cr"], + pattern: /^# Copyright/, + message_template: "Missing copyright header.", + negate: true, + ) + + content = "def foo\n 42\nend" + diagnostics = rule.check("src/app.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("test/require-copyright") + diagnostics[0].message.should eq("Missing copyright header.") + diagnostics[0].range.start.line.should eq(0) + diagnostics[0].range.start.character.should eq(0) + end + + it "returns no diagnostics when the pattern IS found in the file" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/require-copyright", + description: "Require copyright header", + default_severity: AmberLSP::Rules::Severity::Information, + applies_to: ["*.cr"], + pattern: /^# Copyright/, + message_template: "Missing copyright header.", + negate: true, + ) + + content = "# Copyright 2026 Amber Framework\ndef foo\n 42\nend" + diagnostics = rule.check("src/app.cr", content) + diagnostics.should be_empty + end + + it "reports a diagnostic for an empty file in negate mode" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/require-copyright", + description: "Require copyright header", + default_severity: AmberLSP::Rules::Severity::Information, + applies_to: ["*.cr"], + pattern: /^# Copyright/, + message_template: "Missing copyright header.", + negate: true, + ) + + diagnostics = rule.check("src/app.cr", "") + diagnostics.size.should eq(1) + diagnostics[0].message.should eq("Missing copyright header.") + end + + it "respects applies_to filtering in negate mode" do + rule = AmberLSP::Rules::CustomRule.new( + id: "test/require-copyright", + description: "Require copyright header", + default_severity: AmberLSP::Rules::Severity::Information, + applies_to: ["src/**"], + pattern: /^# Copyright/, + message_template: "Missing copyright header.", + negate: true, + ) + + # File path does not match applies_to, so should return nothing + diagnostics = rule.check("spec/app_spec.cr", "def foo\nend") + diagnostics.should be_empty + end + end + + describe "integration with RuleRegistry" do + it "works correctly when registered with RuleRegistry" do + rule = AmberLSP::Rules::CustomRule.new( + id: "custom/no-puts", + description: "No puts allowed", + default_severity: AmberLSP::Rules::Severity::Warning, + applies_to: ["*.cr"], + pattern: /\bputs\b/, + message_template: "Avoid 'puts'.", + ) + + AmberLSP::Rules::RuleRegistry.register(rule) + + rules = AmberLSP::Rules::RuleRegistry.rules_for_file("src/app.cr") + rules.size.should eq(1) + rules[0].id.should eq("custom/no-puts") + end + end +end diff --git a/spec/amber_lsp/rules/file_naming/directory_structure_rule_spec.cr b/spec/amber_lsp/rules/file_naming/directory_structure_rule_spec.cr new file mode 100644 index 0000000..513f837 --- /dev/null +++ b/spec/amber_lsp/rules/file_naming/directory_structure_rule_spec.cr @@ -0,0 +1,190 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/file_naming/directory_structure_rule" + +describe AmberLSP::Rules::FileNaming::DirectoryStructureRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::FileNaming::DirectoryStructureRule.new) + end + + describe "#check" do + it "produces no diagnostics when controller is in correct directory" do + content = <<-CRYSTAL + class PostsController < ApplicationController + def index + end + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/controllers/posts_controller.cr", content) + diagnostics.should be_empty + end + + it "reports warning when controller is in wrong directory" do + content = <<-CRYSTAL + class PostsController < ApplicationController + def index + end + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/models/posts_controller.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/directory-structure") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Warning) + diagnostics[0].message.should contain("src/controllers/") + end + + it "produces no diagnostics when job is in correct directory" do + content = <<-CRYSTAL + class EmailJob < Amber::Jobs::Job + def perform + end + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/jobs/email_job.cr", content) + diagnostics.should be_empty + end + + it "reports warning when job is in wrong directory" do + content = <<-CRYSTAL + class EmailJob < Amber::Jobs::Job + def perform + end + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/services/email_job.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("src/jobs/") + end + + it "produces no diagnostics when mailer is in correct directory" do + content = <<-CRYSTAL + class WelcomeMailer < Amber::Mailer::Base + def html_body + end + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/mailers/welcome_mailer.cr", content) + diagnostics.should be_empty + end + + it "reports warning when mailer is in wrong directory" do + content = <<-CRYSTAL + class WelcomeMailer < Amber::Mailer::Base + def html_body + end + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/services/welcome_mailer.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("src/mailers/") + end + + it "produces no diagnostics when channel is in correct directory" do + content = <<-CRYSTAL + class ChatChannel < Amber::WebSockets::Channel + def handle_message + end + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/channels/chat_channel.cr", content) + diagnostics.should be_empty + end + + it "reports warning when channel is in wrong directory" do + content = <<-CRYSTAL + class ChatChannel < Amber::WebSockets::Channel + def handle_message + end + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/models/chat_channel.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("src/channels/") + end + + it "produces no diagnostics when schema is in correct directory" do + content = <<-CRYSTAL + class UserSchema < Amber::Schema::Definition + field :name, String + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/schemas/user_schema.cr", content) + diagnostics.should be_empty + end + + it "reports warning when schema is in wrong directory" do + content = <<-CRYSTAL + class UserSchema < Amber::Schema::Definition + field :name, String + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/models/user_schema.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("src/schemas/") + end + + it "produces no diagnostics when socket is in correct directory" do + content = <<-CRYSTAL + struct UserSocket < Amber::WebSockets::ClientSocket + channel "chat:*", ChatChannel + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/sockets/user_socket.cr", content) + diagnostics.should be_empty + end + + it "reports warning when socket is in wrong directory" do + content = <<-CRYSTAL + struct UserSocket < Amber::WebSockets::ClientSocket + channel "chat:*", ChatChannel + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/models/user_socket.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("src/sockets/") + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/models/empty.cr", "") + diagnostics.should be_empty + end + + it "produces no diagnostics for regular classes" do + content = <<-CRYSTAL + class UserService + def call + end + end + CRYSTAL + + rule = AmberLSP::Rules::FileNaming::DirectoryStructureRule.new + diagnostics = rule.check("src/services/user_service.cr", content) + diagnostics.should be_empty + end + end +end diff --git a/spec/amber_lsp/rules/file_naming/snake_case_rule_spec.cr b/spec/amber_lsp/rules/file_naming/snake_case_rule_spec.cr new file mode 100644 index 0000000..354aecb --- /dev/null +++ b/spec/amber_lsp/rules/file_naming/snake_case_rule_spec.cr @@ -0,0 +1,76 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/file_naming/snake_case_rule" + +describe AmberLSP::Rules::FileNaming::SnakeCaseRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::FileNaming::SnakeCaseRule.new) + end + + describe "#check" do + it "produces no diagnostics for snake_case file names" do + rule = AmberLSP::Rules::FileNaming::SnakeCaseRule.new + diagnostics = rule.check("src/controllers/posts_controller.cr", "") + diagnostics.should be_empty + end + + it "produces no diagnostics for single word file names" do + rule = AmberLSP::Rules::FileNaming::SnakeCaseRule.new + diagnostics = rule.check("src/models/user.cr", "") + diagnostics.should be_empty + end + + it "reports warning for PascalCase file names" do + rule = AmberLSP::Rules::FileNaming::SnakeCaseRule.new + diagnostics = rule.check("src/controllers/PostsController.cr", "") + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/file-naming") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Warning) + diagnostics[0].message.should contain("PostsController.cr") + diagnostics[0].message.should contain("posts_controller.cr") + end + + it "reports warning for camelCase file names" do + rule = AmberLSP::Rules::FileNaming::SnakeCaseRule.new + diagnostics = rule.check("src/models/userProfile.cr", "") + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("userProfile.cr") + diagnostics[0].message.should contain("user_profile.cr") + end + + it "reports warning for hyphenated file names" do + rule = AmberLSP::Rules::FileNaming::SnakeCaseRule.new + diagnostics = rule.check("src/models/user-profile.cr", "") + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("user-profile.cr") + end + + it "reports warning for file names starting with uppercase" do + rule = AmberLSP::Rules::FileNaming::SnakeCaseRule.new + diagnostics = rule.check("src/models/User.cr", "") + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("User.cr") + diagnostics[0].message.should contain("user.cr") + end + + it "skips hidden files" do + rule = AmberLSP::Rules::FileNaming::SnakeCaseRule.new + diagnostics = rule.check("src/.hidden_file.cr", "") + diagnostics.should be_empty + end + + it "allows file names with numbers" do + rule = AmberLSP::Rules::FileNaming::SnakeCaseRule.new + diagnostics = rule.check("src/models/v2_user.cr", "") + diagnostics.should be_empty + end + + it "positions diagnostic at line 0, col 0" do + rule = AmberLSP::Rules::FileNaming::SnakeCaseRule.new + diagnostics = rule.check("src/BadName.cr", "") + diagnostics.size.should eq(1) + diagnostics[0].range.start.line.should eq(0) + diagnostics[0].range.start.character.should eq(0) + end + end +end diff --git a/spec/amber_lsp/rules/jobs/perform_rule_spec.cr b/spec/amber_lsp/rules/jobs/perform_rule_spec.cr new file mode 100644 index 0000000..51e604f --- /dev/null +++ b/spec/amber_lsp/rules/jobs/perform_rule_spec.cr @@ -0,0 +1,91 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/jobs/perform_rule" + +describe AmberLSP::Rules::Jobs::PerformRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Jobs::PerformRule.new) + end + + describe "#check" do + it "produces no diagnostics when job class defines perform" do + content = <<-CRYSTAL + class EmailJob < Amber::Jobs::Job + def perform + Mailer.send_email + end + end + CRYSTAL + + rule = AmberLSP::Rules::Jobs::PerformRule.new + diagnostics = rule.check("src/jobs/email_job.cr", content) + diagnostics.should be_empty + end + + it "reports error when job class is missing perform method" do + content = <<-CRYSTAL + class EmailJob < Amber::Jobs::Job + def send_email + Mailer.send_email + end + end + CRYSTAL + + rule = AmberLSP::Rules::Jobs::PerformRule.new + diagnostics = rule.check("src/jobs/email_job.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/job-perform") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Error) + diagnostics[0].message.should contain("EmailJob") + diagnostics[0].message.should contain("perform") + end + + it "skips files not in jobs/ directory" do + content = <<-CRYSTAL + class EmailJob < Amber::Jobs::Job + def send_email + Mailer.send_email + end + end + CRYSTAL + + rule = AmberLSP::Rules::Jobs::PerformRule.new + diagnostics = rule.check("src/services/email_job.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Jobs::PerformRule.new + diagnostics = rule.check("src/jobs/email_job.cr", "") + diagnostics.should be_empty + end + + it "produces no diagnostics for files without job classes" do + content = <<-CRYSTAL + class Helper + def perform + "not a job" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Jobs::PerformRule.new + diagnostics = rule.check("src/jobs/helper.cr", content) + diagnostics.should be_empty + end + + it "handles job class with perform method having arguments" do + content = <<-CRYSTAL + class EmailJob < Amber::Jobs::Job + def perform(email : String) + Mailer.send_email(email) + end + end + CRYSTAL + + rule = AmberLSP::Rules::Jobs::PerformRule.new + diagnostics = rule.check("src/jobs/email_job.cr", content) + diagnostics.should be_empty + end + end +end diff --git a/spec/amber_lsp/rules/jobs/serializable_rule_spec.cr b/spec/amber_lsp/rules/jobs/serializable_rule_spec.cr new file mode 100644 index 0000000..44da73c --- /dev/null +++ b/spec/amber_lsp/rules/jobs/serializable_rule_spec.cr @@ -0,0 +1,97 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/jobs/serializable_rule" + +describe AmberLSP::Rules::Jobs::SerializableRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Jobs::SerializableRule.new) + end + + describe "#check" do + it "produces no diagnostics when job includes JSON::Serializable" do + content = <<-CRYSTAL + class EmailJob < Amber::Jobs::Job + include JSON::Serializable + + property email : String + + def perform + Mailer.send_email(@email) + end + end + CRYSTAL + + rule = AmberLSP::Rules::Jobs::SerializableRule.new + diagnostics = rule.check("src/jobs/email_job.cr", content) + diagnostics.should be_empty + end + + it "reports warning when job class is missing JSON::Serializable" do + content = <<-CRYSTAL + class EmailJob < Amber::Jobs::Job + def perform + Mailer.send_email + end + end + CRYSTAL + + rule = AmberLSP::Rules::Jobs::SerializableRule.new + diagnostics = rule.check("src/jobs/email_job.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/job-serializable") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Warning) + diagnostics[0].message.should contain("EmailJob") + diagnostics[0].message.should contain("JSON::Serializable") + end + + it "skips files not in jobs/ directory" do + content = <<-CRYSTAL + class EmailJob < Amber::Jobs::Job + def perform + Mailer.send_email + end + end + CRYSTAL + + rule = AmberLSP::Rules::Jobs::SerializableRule.new + diagnostics = rule.check("src/services/email_job.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Jobs::SerializableRule.new + diagnostics = rule.check("src/jobs/email_job.cr", "") + diagnostics.should be_empty + end + + it "produces no diagnostics for files without job classes" do + content = <<-CRYSTAL + class Helper + def help + "not a job" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Jobs::SerializableRule.new + diagnostics = rule.check("src/jobs/helper.cr", content) + diagnostics.should be_empty + end + + it "detects JSON::Serializable even with extra whitespace" do + content = <<-CRYSTAL + class EmailJob < Amber::Jobs::Job + include JSON::Serializable + + def perform + Mailer.send_email + end + end + CRYSTAL + + rule = AmberLSP::Rules::Jobs::SerializableRule.new + diagnostics = rule.check("src/jobs/email_job.cr", content) + diagnostics.should be_empty + end + end +end diff --git a/spec/amber_lsp/rules/mailers/required_methods_rule_spec.cr b/spec/amber_lsp/rules/mailers/required_methods_rule_spec.cr new file mode 100644 index 0000000..7fd034d --- /dev/null +++ b/spec/amber_lsp/rules/mailers/required_methods_rule_spec.cr @@ -0,0 +1,131 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/mailers/required_methods_rule" + +describe AmberLSP::Rules::Mailers::RequiredMethodsRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Mailers::RequiredMethodsRule.new) + end + + describe "#check" do + it "produces no diagnostics when both methods are defined" do + content = <<-CRYSTAL + class WelcomeMailer < Amber::Mailer::Base + def html_body + "

Welcome

" + end + + def text_body + "Welcome" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Mailers::RequiredMethodsRule.new + diagnostics = rule.check("src/mailers/welcome_mailer.cr", content) + diagnostics.should be_empty + end + + it "reports error when html_body is missing" do + content = <<-CRYSTAL + class WelcomeMailer < Amber::Mailer::Base + def text_body + "Welcome" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Mailers::RequiredMethodsRule.new + diagnostics = rule.check("src/mailers/welcome_mailer.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/mailer-methods") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Error) + diagnostics[0].message.should contain("html_body") + diagnostics[0].message.should contain("WelcomeMailer") + end + + it "reports error when text_body is missing" do + content = <<-CRYSTAL + class WelcomeMailer < Amber::Mailer::Base + def html_body + "

Welcome

" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Mailers::RequiredMethodsRule.new + diagnostics = rule.check("src/mailers/welcome_mailer.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("text_body") + end + + it "reports two errors when both methods are missing" do + content = <<-CRYSTAL + class WelcomeMailer < Amber::Mailer::Base + def deliver + send_email + end + end + CRYSTAL + + rule = AmberLSP::Rules::Mailers::RequiredMethodsRule.new + diagnostics = rule.check("src/mailers/welcome_mailer.cr", content) + diagnostics.size.should eq(2) + messages = diagnostics.map(&.message) + messages.any? { |m| m.includes?("html_body") }.should be_true + messages.any? { |m| m.includes?("text_body") }.should be_true + end + + it "skips files not in mailers/ directory" do + content = <<-CRYSTAL + class WelcomeMailer < Amber::Mailer::Base + def deliver + send_email + end + end + CRYSTAL + + rule = AmberLSP::Rules::Mailers::RequiredMethodsRule.new + diagnostics = rule.check("src/services/welcome_mailer.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Mailers::RequiredMethodsRule.new + diagnostics = rule.check("src/mailers/welcome_mailer.cr", "") + diagnostics.should be_empty + end + + it "produces no diagnostics for files without mailer classes" do + content = <<-CRYSTAL + class Helper + def html_body + "not a mailer" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Mailers::RequiredMethodsRule.new + diagnostics = rule.check("src/mailers/helper.cr", content) + diagnostics.should be_empty + end + + it "handles mailer with methods that have arguments" do + content = <<-CRYSTAL + class WelcomeMailer < Amber::Mailer::Base + def html_body(user : String) + "

Welcome

" + end + + def text_body(user : String) + "Welcome" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Mailers::RequiredMethodsRule.new + diagnostics = rule.check("src/mailers/welcome_mailer.cr", content) + diagnostics.should be_empty + end + end +end diff --git a/spec/amber_lsp/rules/pipes/call_next_rule_spec.cr b/spec/amber_lsp/rules/pipes/call_next_rule_spec.cr new file mode 100644 index 0000000..8e67f44 --- /dev/null +++ b/spec/amber_lsp/rules/pipes/call_next_rule_spec.cr @@ -0,0 +1,112 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/pipes/call_next_rule" + +describe AmberLSP::Rules::Pipes::CallNextRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Pipes::CallNextRule.new) + end + + describe "#check" do + it "produces no diagnostics when pipe call method invokes call_next" do + content = <<-CRYSTAL + class AuthPipe < Amber::Pipe::Base + def call(context) + if authenticated?(context) + call_next(context) + else + context.response.status_code = 401 + end + end + end + CRYSTAL + + rule = AmberLSP::Rules::Pipes::CallNextRule.new + diagnostics = rule.check("src/pipes/auth_pipe.cr", content) + diagnostics.should be_empty + end + + it "reports error when pipe call method does not invoke call_next" do + content = <<-CRYSTAL + class AuthPipe < Amber::Pipe::Base + def call(context) + context.response.status_code = 200 + end + end + CRYSTAL + + rule = AmberLSP::Rules::Pipes::CallNextRule.new + diagnostics = rule.check("src/pipes/auth_pipe.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/pipe-call-next") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Error) + diagnostics[0].message.should contain("call_next") + diagnostics[0].message.should contain("pipeline") + end + + it "produces no diagnostics for files without pipe classes" do + content = <<-CRYSTAL + class HomeController < ApplicationController + def call + render("index.ecr") + end + end + CRYSTAL + + rule = AmberLSP::Rules::Pipes::CallNextRule.new + diagnostics = rule.check("src/controllers/home_controller.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Pipes::CallNextRule.new + diagnostics = rule.check("src/pipes/auth_pipe.cr", "") + diagnostics.should be_empty + end + + it "produces no diagnostics for pipe classes that do not override call" do + content = <<-CRYSTAL + class SimplePipe < Amber::Pipe::Base + def some_helper + "helper" + end + end + CRYSTAL + + rule = AmberLSP::Rules::Pipes::CallNextRule.new + diagnostics = rule.check("src/pipes/simple_pipe.cr", content) + diagnostics.should be_empty + end + + it "correctly handles call_next inside conditional blocks" do + content = <<-CRYSTAL + class AuthPipe < Amber::Pipe::Base + def call(context) + if context.valid? + call_next(context) + end + end + end + CRYSTAL + + rule = AmberLSP::Rules::Pipes::CallNextRule.new + diagnostics = rule.check("src/pipes/auth_pipe.cr", content) + diagnostics.should be_empty + end + + it "positions the diagnostic on the call method definition" do + content = <<-CRYSTAL + class AuthPipe < Amber::Pipe::Base + def call(context) + context.response.status_code = 200 + end + end + CRYSTAL + + rule = AmberLSP::Rules::Pipes::CallNextRule.new + diagnostics = rule.check("src/pipes/auth_pipe.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].range.start.line.should eq(1) + end + end +end diff --git a/spec/amber_lsp/rules/routing/controller_action_existence_rule_spec.cr b/spec/amber_lsp/rules/routing/controller_action_existence_rule_spec.cr new file mode 100644 index 0000000..b0db035 --- /dev/null +++ b/spec/amber_lsp/rules/routing/controller_action_existence_rule_spec.cr @@ -0,0 +1,143 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/routing/controller_action_existence_rule" + +describe AmberLSP::Rules::Routing::ControllerActionExistenceRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Routing::ControllerActionExistenceRule.new) + end + + describe "#check" do + it "produces no diagnostics when controller file exists" do + with_tempdir do |dir| + config_dir = File.join(dir, "config") + controller_dir = File.join(dir, "src", "controllers") + Dir.mkdir_p(config_dir) + Dir.mkdir_p(controller_dir) + + File.write(File.join(controller_dir, "posts_controller.cr"), "class PostsController < ApplicationController\nend") + + routes_file = File.join(config_dir, "routes.cr") + routes_content = %( get "/posts", PostsController, :index\n) + File.write(routes_file, routes_content) + + rule = AmberLSP::Rules::Routing::ControllerActionExistenceRule.new + diagnostics = rule.check(routes_file, routes_content) + diagnostics.should be_empty + end + end + + it "reports warning when controller file is missing" do + with_tempdir do |dir| + config_dir = File.join(dir, "config") + Dir.mkdir_p(config_dir) + Dir.mkdir_p(File.join(dir, "src", "controllers")) + + routes_file = File.join(config_dir, "routes.cr") + routes_content = %( get "/posts", PostsController, :index\n) + File.write(routes_file, routes_content) + + rule = AmberLSP::Rules::Routing::ControllerActionExistenceRule.new + diagnostics = rule.check(routes_file, routes_content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/route-controller-exists") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Warning) + diagnostics[0].message.should contain("PostsController") + diagnostics[0].message.should contain("posts_controller.cr") + end + end + + it "handles resources declarations" do + with_tempdir do |dir| + config_dir = File.join(dir, "config") + Dir.mkdir_p(config_dir) + Dir.mkdir_p(File.join(dir, "src", "controllers")) + + routes_file = File.join(config_dir, "routes.cr") + routes_content = %( resources "/users", UsersController\n) + File.write(routes_file, routes_content) + + rule = AmberLSP::Rules::Routing::ControllerActionExistenceRule.new + diagnostics = rule.check(routes_file, routes_content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("UsersController") + end + end + + it "handles multiple route declarations" do + with_tempdir do |dir| + config_dir = File.join(dir, "config") + controller_dir = File.join(dir, "src", "controllers") + Dir.mkdir_p(config_dir) + Dir.mkdir_p(controller_dir) + + File.write(File.join(controller_dir, "posts_controller.cr"), "class PostsController\nend") + + routes_file = File.join(config_dir, "routes.cr") + routes_content = <<-CRYSTAL + get "/posts", PostsController, :index + post "/comments", CommentsController, :create + resources "/users", UsersController + CRYSTAL + File.write(routes_file, routes_content) + + rule = AmberLSP::Rules::Routing::ControllerActionExistenceRule.new + diagnostics = rule.check(routes_file, routes_content) + diagnostics.size.should eq(2) + end + end + + it "handles various HTTP verbs" do + with_tempdir do |dir| + config_dir = File.join(dir, "config") + Dir.mkdir_p(config_dir) + Dir.mkdir_p(File.join(dir, "src", "controllers")) + + routes_file = File.join(config_dir, "routes.cr") + routes_content = <<-CRYSTAL + post "/items", ItemsController, :create + put "/items/:id", ItemsController, :update + patch "/items/:id", ItemsController, :patch + delete "/items/:id", ItemsController, :destroy + CRYSTAL + File.write(routes_file, routes_content) + + rule = AmberLSP::Rules::Routing::ControllerActionExistenceRule.new + diagnostics = rule.check(routes_file, routes_content) + diagnostics.size.should eq(4) + diagnostics.all? { |d| d.message.includes?("ItemsController") }.should be_true + end + end + + it "skips files not named routes.cr" do + content = %( get "/posts", PostsController, :index\n) + + rule = AmberLSP::Rules::Routing::ControllerActionExistenceRule.new + diagnostics = rule.check("src/some_file.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Routing::ControllerActionExistenceRule.new + diagnostics = rule.check("config/routes.cr", "") + diagnostics.should be_empty + end + + it "converts PascalCase to snake_case correctly" do + with_tempdir do |dir| + config_dir = File.join(dir, "config") + Dir.mkdir_p(config_dir) + Dir.mkdir_p(File.join(dir, "src", "controllers")) + + routes_file = File.join(config_dir, "routes.cr") + routes_content = %( get "/admin/user-settings", AdminUserSettingsController, :index\n) + File.write(routes_file, routes_content) + + rule = AmberLSP::Rules::Routing::ControllerActionExistenceRule.new + diagnostics = rule.check(routes_file, routes_content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("admin_user_settings_controller.cr") + end + end + end +end diff --git a/spec/amber_lsp/rules/schemas/field_type_rule_spec.cr b/spec/amber_lsp/rules/schemas/field_type_rule_spec.cr new file mode 100644 index 0000000..64dd3bc --- /dev/null +++ b/spec/amber_lsp/rules/schemas/field_type_rule_spec.cr @@ -0,0 +1,128 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/schemas/field_type_rule" + +describe AmberLSP::Rules::Schemas::FieldTypeRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Schemas::FieldTypeRule.new) + end + + describe "#check" do + it "produces no diagnostics for valid field types" do + content = <<-CRYSTAL + class UserSchema < Amber::Schema::Definition + field :name, String + field :age, Int32 + field :score, Float64 + field :active, Bool + field :created_at, Time + field :uuid, UUID + end + CRYSTAL + + rule = AmberLSP::Rules::Schemas::FieldTypeRule.new + diagnostics = rule.check("src/schemas/user_schema.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for valid array types" do + content = <<-CRYSTAL + class TagSchema < Amber::Schema::Definition + field :tags, Array(String) + field :ids, Array(Int32) + field :scores, Array(Float64) + field :flags, Array(Bool) + field :big_ids, Array(Int64) + end + CRYSTAL + + rule = AmberLSP::Rules::Schemas::FieldTypeRule.new + diagnostics = rule.check("src/schemas/tag_schema.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for valid hash type" do + content = <<-CRYSTAL + class MetaSchema < Amber::Schema::Definition + field :metadata, Hash(String,JSON::Any) + end + CRYSTAL + + rule = AmberLSP::Rules::Schemas::FieldTypeRule.new + diagnostics = rule.check("src/schemas/meta_schema.cr", content) + diagnostics.should be_empty + end + + it "reports error for invalid field type" do + content = <<-CRYSTAL + class UserSchema < Amber::Schema::Definition + field :data, CustomType + end + CRYSTAL + + rule = AmberLSP::Rules::Schemas::FieldTypeRule.new + diagnostics = rule.check("src/schemas/user_schema.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/schema-field-type") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Error) + diagnostics[0].message.should contain("CustomType") + diagnostics[0].message.should contain("Valid types") + end + + it "reports errors for multiple invalid field types" do + content = <<-CRYSTAL + class UserSchema < Amber::Schema::Definition + field :name, String + field :data, CustomType + field :other, AnotherType + end + CRYSTAL + + rule = AmberLSP::Rules::Schemas::FieldTypeRule.new + diagnostics = rule.check("src/schemas/user_schema.cr", content) + diagnostics.size.should eq(2) + diagnostics[0].message.should contain("CustomType") + diagnostics[1].message.should contain("AnotherType") + end + + it "skips files not in schemas/ directory" do + content = <<-CRYSTAL + class UserSchema < Amber::Schema::Definition + field :data, CustomType + end + CRYSTAL + + rule = AmberLSP::Rules::Schemas::FieldTypeRule.new + diagnostics = rule.check("src/models/user.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Schemas::FieldTypeRule.new + diagnostics = rule.check("src/schemas/empty_schema.cr", "") + diagnostics.should be_empty + end + + it "validates Int64 and Float32 types" do + content = <<-CRYSTAL + class NumericSchema < Amber::Schema::Definition + field :big_id, Int64 + field :small_float, Float32 + end + CRYSTAL + + rule = AmberLSP::Rules::Schemas::FieldTypeRule.new + diagnostics = rule.check("src/schemas/numeric_schema.cr", content) + diagnostics.should be_empty + end + + it "correctly positions the diagnostic range on the type" do + content = " field :name, CustomType" + + rule = AmberLSP::Rules::Schemas::FieldTypeRule.new + diagnostics = rule.check("src/schemas/user_schema.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].range.start.line.should eq(0) + end + end +end diff --git a/spec/amber_lsp/rules/sockets/socket_channel_rule_spec.cr b/spec/amber_lsp/rules/sockets/socket_channel_rule_spec.cr new file mode 100644 index 0000000..ec843e8 --- /dev/null +++ b/spec/amber_lsp/rules/sockets/socket_channel_rule_spec.cr @@ -0,0 +1,108 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/sockets/socket_channel_rule" + +describe AmberLSP::Rules::Sockets::SocketChannelRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Sockets::SocketChannelRule.new) + end + + describe "#check" do + it "produces no diagnostics when socket has channel macro" do + content = <<-CRYSTAL + struct UserSocket < Amber::WebSockets::ClientSocket + channel "chat:*", ChatChannel + end + CRYSTAL + + rule = AmberLSP::Rules::Sockets::SocketChannelRule.new + diagnostics = rule.check("src/sockets/user_socket.cr", content) + diagnostics.should be_empty + end + + it "reports warning when socket has no channel macro" do + content = <<-CRYSTAL + struct UserSocket < Amber::WebSockets::ClientSocket + def on_connect + true + end + end + CRYSTAL + + rule = AmberLSP::Rules::Sockets::SocketChannelRule.new + diagnostics = rule.check("src/sockets/user_socket.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/socket-channel-macro") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Warning) + diagnostics[0].message.should contain("UserSocket") + diagnostics[0].message.should contain("channel") + end + + it "produces no diagnostics with multiple channel macros" do + content = <<-CRYSTAL + struct UserSocket < Amber::WebSockets::ClientSocket + channel "chat:*", ChatChannel + channel "notifications:*", NotificationChannel + end + CRYSTAL + + rule = AmberLSP::Rules::Sockets::SocketChannelRule.new + diagnostics = rule.check("src/sockets/user_socket.cr", content) + diagnostics.should be_empty + end + + it "skips files not in sockets/ directory" do + content = <<-CRYSTAL + struct UserSocket < Amber::WebSockets::ClientSocket + def on_connect + true + end + end + CRYSTAL + + rule = AmberLSP::Rules::Sockets::SocketChannelRule.new + diagnostics = rule.check("src/models/user_socket.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Sockets::SocketChannelRule.new + diagnostics = rule.check("src/sockets/user_socket.cr", "") + diagnostics.should be_empty + end + + it "produces no diagnostics for files without socket structs" do + content = <<-CRYSTAL + class Helper + def connect + true + end + end + CRYSTAL + + rule = AmberLSP::Rules::Sockets::SocketChannelRule.new + diagnostics = rule.check("src/sockets/helper.cr", content) + diagnostics.should be_empty + end + + it "handles channel names with colons and wildcards" do + content = <<-CRYSTAL + struct AppSocket < Amber::WebSockets::ClientSocket + channel "room:lobby:*", LobbyChannel + end + CRYSTAL + + rule = AmberLSP::Rules::Sockets::SocketChannelRule.new + diagnostics = rule.check("src/sockets/app_socket.cr", content) + diagnostics.should be_empty + end + + it "correctly positions the diagnostic range on the struct name" do + content = "struct UserSocket < Amber::WebSockets::ClientSocket\nend" + rule = AmberLSP::Rules::Sockets::SocketChannelRule.new + diagnostics = rule.check("src/sockets/user_socket.cr", content) + diagnostics.size.should eq(1) + diagnostics[0].range.start.line.should eq(0) + end + end +end diff --git a/spec/amber_lsp/rules/specs/spec_existence_rule_spec.cr b/spec/amber_lsp/rules/specs/spec_existence_rule_spec.cr new file mode 100644 index 0000000..87a7ab8 --- /dev/null +++ b/spec/amber_lsp/rules/specs/spec_existence_rule_spec.cr @@ -0,0 +1,95 @@ +require "../../spec_helper" +require "../../../../src/amber_lsp/rules/specs/spec_existence_rule" + +describe AmberLSP::Rules::Specs::SpecExistenceRule do + before_each do + AmberLSP::Rules::RuleRegistry.clear + AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Specs::SpecExistenceRule.new) + end + + describe "#check" do + it "produces no diagnostics when spec file exists" do + with_tempdir do |dir| + controller_dir = File.join(dir, "src", "controllers") + spec_dir = File.join(dir, "spec", "controllers") + Dir.mkdir_p(controller_dir) + Dir.mkdir_p(spec_dir) + + controller_file = File.join(controller_dir, "posts_controller.cr") + spec_file = File.join(spec_dir, "posts_controller_spec.cr") + File.write(controller_file, "class PostsController < ApplicationController\nend") + File.write(spec_file, "describe PostsController do\nend") + + content = File.read(controller_file) + rule = AmberLSP::Rules::Specs::SpecExistenceRule.new + diagnostics = rule.check(controller_file, content) + diagnostics.should be_empty + end + end + + it "reports information when spec file is missing" do + with_tempdir do |dir| + controller_dir = File.join(dir, "src", "controllers") + Dir.mkdir_p(controller_dir) + + controller_file = File.join(controller_dir, "posts_controller.cr") + File.write(controller_file, "class PostsController < ApplicationController\nend") + + content = File.read(controller_file) + rule = AmberLSP::Rules::Specs::SpecExistenceRule.new + diagnostics = rule.check(controller_file, content) + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/spec-existence") + diagnostics[0].severity.should eq(AmberLSP::Rules::Severity::Information) + diagnostics[0].message.should contain("spec") + diagnostics[0].range.start.line.should eq(0) + diagnostics[0].range.start.character.should eq(0) + end + end + + it "skips application_controller.cr" do + content = <<-CRYSTAL + class ApplicationController < Amber::Controller::Base + end + CRYSTAL + + rule = AmberLSP::Rules::Specs::SpecExistenceRule.new + diagnostics = rule.check("src/controllers/application_controller.cr", content) + diagnostics.should be_empty + end + + it "skips files not in controllers/ directory" do + content = <<-CRYSTAL + class SomeModel + end + CRYSTAL + + rule = AmberLSP::Rules::Specs::SpecExistenceRule.new + diagnostics = rule.check("src/models/some_model.cr", content) + diagnostics.should be_empty + end + + it "produces no diagnostics for empty files" do + rule = AmberLSP::Rules::Specs::SpecExistenceRule.new + diagnostics = rule.check("src/controllers/empty_controller.cr", "") + diagnostics.size.should eq(1) + diagnostics[0].code.should eq("amber/spec-existence") + end + + it "correctly derives spec path from controller path" do + with_tempdir do |dir| + controller_dir = File.join(dir, "src", "controllers") + Dir.mkdir_p(controller_dir) + + controller_file = File.join(controller_dir, "users_controller.cr") + File.write(controller_file, "class UsersController < ApplicationController\nend") + + content = File.read(controller_file) + rule = AmberLSP::Rules::Specs::SpecExistenceRule.new + diagnostics = rule.check(controller_file, content) + diagnostics.size.should eq(1) + diagnostics[0].message.should contain("users_controller_spec.cr") + end + end + end +end diff --git a/spec/amber_lsp/server_spec.cr b/spec/amber_lsp/server_spec.cr new file mode 100644 index 0000000..5c34f57 --- /dev/null +++ b/spec/amber_lsp/server_spec.cr @@ -0,0 +1,77 @@ +require "./spec_helper" + +describe AmberLSP::Server do + describe "#run" do + it "reads a JSON-RPC message and writes a response" do + request = {"jsonrpc" => "2.0", "id" => 1, "method" => "shutdown"} + input_data = format_lsp_message(request) + input = IO::Memory.new(input_data) + output = IO::Memory.new + + server = AmberLSP::Server.new(input, output) + server.run + + output.rewind + header = output.gets + header.should_not be_nil + header.not_nil!.should start_with("Content-Length:") + + # Read blank line + output.gets + + length = header.not_nil!.split(":")[1].strip.to_i + body = Bytes.new(length) + output.read_fully(body) + json = JSON.parse(String.new(body)) + + json["jsonrpc"].as_s.should eq("2.0") + json["id"].as_i.should eq(1) + json["result"].raw.should be_nil + end + + it "stops on exit message" do + messages = [ + {"jsonrpc" => "2.0", "id" => 1, "method" => "shutdown"}, + {"jsonrpc" => "2.0", "method" => "exit"}, + ] + + input_data = messages.map { |m| format_lsp_message(m) }.join + input = IO::Memory.new(input_data) + output = IO::Memory.new + + server = AmberLSP::Server.new(input, output) + server.run + + # Server should have stopped cleanly + output.rewind + output.size.should be > 0 + end + + it "handles empty input gracefully" do + input = IO::Memory.new("") + output = IO::Memory.new + + server = AmberLSP::Server.new(input, output) + server.run + + output.rewind + output.size.should eq(0) + end + end + + describe "#write_notification" do + it "writes a pre-serialized JSON notification with Content-Length header" do + input = IO::Memory.new("") + output = IO::Memory.new + + server = AmberLSP::Server.new(input, output) + notification = {"jsonrpc" => "2.0", "method" => "test"}.to_json + server.write_notification(notification) + + output.rewind + header = output.gets + header.should_not be_nil + header.not_nil!.should start_with("Content-Length: #{notification.bytesize}") + end + end +end diff --git a/spec/amber_lsp/spec_helper.cr b/spec/amber_lsp/spec_helper.cr new file mode 100644 index 0000000..82d2b56 --- /dev/null +++ b/spec/amber_lsp/spec_helper.cr @@ -0,0 +1,51 @@ +require "spec" +require "file_utils" +require "../../src/amber_lsp/version" +require "../../src/amber_lsp/rules/severity" +require "../../src/amber_lsp/rules/diagnostic" +require "../../src/amber_lsp/rules/base_rule" +require "../../src/amber_lsp/rules/rule_registry" +require "../../src/amber_lsp/document_store" +require "../../src/amber_lsp/project_context" +require "../../src/amber_lsp/configuration" +require "../../src/amber_lsp/analyzer" +require "../../src/amber_lsp/controller" +require "../../src/amber_lsp/server" + +def with_tempdir(&) + dir = File.join(Dir.tempdir, "amber_lsp_test_#{Random::Secure.hex(8)}") + Dir.mkdir_p(dir) + begin + yield dir + ensure + FileUtils.rm_rf(dir) + end +end + +def format_lsp_message(message) : String + json = message.to_json + "Content-Length: #{json.bytesize}\r\n\r\n#{json}" +end + +def run_lsp_session(messages : Array) : Array(JSON::Any) + input_data = messages.map { |m| format_lsp_message(m) }.join + input = IO::Memory.new(input_data) + output = IO::Memory.new + + server = AmberLSP::Server.new(input, output) + server.run + + output.rewind + responses = [] of JSON::Any + while output.pos < output.size + header = output.gets + break unless header + next unless header.starts_with?("Content-Length:") + length = header.split(":")[1].strip.to_i + output.gets + body = Bytes.new(length) + output.read_fully(body) + responses << JSON.parse(String.new(body)) + end + responses +end diff --git a/spec/commands/new_command_spec.cr b/spec/commands/new_command_spec.cr new file mode 100644 index 0000000..4cba004 --- /dev/null +++ b/spec/commands/new_command_spec.cr @@ -0,0 +1,75 @@ +require "../amber_cli_spec" +require "../../src/amber_cli/commands/new" + +describe AmberCLI::Commands::NewCommand do + describe "#setup_command_options" do + it "accepts --type web (default)" do + command = AmberCLI::Commands::NewCommand.new("new") + command.app_type.should eq("web") + end + + it "accepts --type native flag" do + command = AmberCLI::Commands::NewCommand.new("new") + args = ["my_app", "--type", "native"] + + command.option_parser.unknown_args do |unknown_args, _| + command.remaining_arguments.concat(unknown_args) + end + command.option_parser.parse(args) + + command.app_type.should eq("native") + command.remaining_arguments.should eq(["my_app"]) + end + + it "accepts --type=native with equals syntax" do + command = AmberCLI::Commands::NewCommand.new("new") + args = ["my_app", "--type=native"] + + command.option_parser.unknown_args do |unknown_args, _| + command.remaining_arguments.concat(unknown_args) + end + command.option_parser.parse(args) + + command.app_type.should eq("native") + end + + it "accepts --type web explicitly" do + command = AmberCLI::Commands::NewCommand.new("new") + args = ["my_app", "--type=web"] + + command.option_parser.unknown_args do |unknown_args, _| + command.remaining_arguments.concat(unknown_args) + end + command.option_parser.parse(args) + + command.app_type.should eq("web") + end + + it "preserves database and template flags alongside --type" do + command = AmberCLI::Commands::NewCommand.new("new") + args = ["my_app", "-d", "sqlite", "-t", "slang", "--type=web"] + + command.option_parser.unknown_args do |unknown_args, _| + command.remaining_arguments.concat(unknown_args) + end + command.option_parser.parse(args) + + command.database.should eq("sqlite") + command.template.should eq("slang") + command.app_type.should eq("web") + end + + it "combines --type native with --no-deps" do + command = AmberCLI::Commands::NewCommand.new("new") + args = ["my_app", "--type=native", "--no-deps"] + + command.option_parser.unknown_args do |unknown_args, _| + command.remaining_arguments.concat(unknown_args) + end + command.option_parser.parse(args) + + command.app_type.should eq("native") + command.no_deps.should be_true + end + end +end diff --git a/spec/generators/native_app_spec.cr b/spec/generators/native_app_spec.cr new file mode 100644 index 0000000..1449d7c --- /dev/null +++ b/spec/generators/native_app_spec.cr @@ -0,0 +1,438 @@ +require "../amber_cli_spec" +require "../../src/amber_cli/generators/native_app" + +describe AmberCLI::Generators::NativeApp do + describe "#generate" do + it "creates the full native app project structure" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "test_native_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "test_native_app") + generator.generate + + # Verify top-level files exist + File.exists?(File.join(project_path, "shard.yml")).should be_true + File.exists?(File.join(project_path, ".amber.yml")).should be_true + File.exists?(File.join(project_path, ".gitignore")).should be_true + File.exists?(File.join(project_path, "Makefile")).should be_true + File.exists?(File.join(project_path, "CLAUDE.md")).should be_true + end + end + + it "creates shard.yml with correct dependencies" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + shard_content = File.read(File.join(project_path, "shard.yml")) + + # Must have amber (patterns only) + shard_content.should contain("amber:") + shard_content.should contain("crimson-knight/amber") + + # Must have asset_pipeline with cross-platform branch + shard_content.should contain("asset_pipeline:") + shard_content.should contain("feature/utility-first-css-asset-pipeline") + + # Must have crystal-audio + shard_content.should contain("crystal-audio:") + + # Must have correct project name + shard_content.should contain("name: my_app") + shard_content.should contain("main: src/my_app.cr") + end + end + + it "creates amber.yml with type: native" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + amber_content = File.read(File.join(project_path, ".amber.yml")) + amber_content.should contain("type: native") + amber_content.should contain("app: my_app") + end + end + + it "creates main file WITHOUT HTTP server" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + main_content = File.read(File.join(project_path, "src/my_app.cr")) + + # MUST use Amber.settings directly + main_content.should contain("Amber.settings.name") + + # MUST NOT start an HTTP server + main_content.should_not contain("Amber::Server.start") + + # Comments warn about Server.configure but it must not appear as actual code. + # Filter out comment lines and check no code line invokes it. + code_lines = main_content.lines.reject { |l| l.strip.starts_with?("#") } + code_lines.none? { |l| l.includes?("Amber::Server.configure") }.should be_true + + # MUST require asset_pipeline/ui (not just "ui") + main_content.should contain("require \"asset_pipeline/ui\"") + end + end + + it "creates config without HTTP server" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + config_content = File.read(File.join(project_path, "config/application.cr")) + config_content.should contain("Amber.settings.name") + + # Comments warn about Server.configure but it must not appear as actual code. + code_lines = config_content.lines.reject { |l| l.strip.starts_with?("#") } + code_lines.none? { |l| l.includes?("Amber::Server.configure") }.should be_true + end + end + + it "creates Makefile with correct platform flags" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + makefile_content = File.read(File.join(project_path, "Makefile")) + + # CRITICAL: -Dmacos flag must be present + makefile_content.should contain("-Dmacos") + + # Must have crystal-alpha compiler + makefile_content.should contain("crystal-alpha") + + # Must have -fno-objc-arc for ObjC bridge + makefile_content.should contain("-fno-objc-arc") + + # Must have framework link flags + makefile_content.should contain("-framework AppKit") + makefile_content.should contain("-framework Foundation") + makefile_content.should contain("-framework AVFoundation") + makefile_content.should contain("-lobjc") + + # Must have crystal-audio symlink in setup + makefile_content.should contain("ln -sf crystal-audio lib/crystal_audio") + + # Must have build targets + makefile_content.should contain("macos:") + makefile_content.should contain("macos-release:") + makefile_content.should contain("setup:") + makefile_content.should contain("spec:") + end + end + + it "creates FSDD process manager structure" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + # Process manager exists + File.exists?(File.join(project_path, "src/process_managers/main_process_manager.cr")).should be_true + + pm_content = File.read(File.join(project_path, "src/process_managers/main_process_manager.cr")) + pm_content.should contain("module ProcessManagers") + pm_content.should contain("class MainProcessManager") + + # Controller delegates to process manager + ctrl_content = File.read(File.join(project_path, "src/controllers/main_controller.cr")) + ctrl_content.should contain("@process_manager") + ctrl_content.should contain("ProcessManagers::MainProcessManager") + end + end + + it "creates event bus" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + File.exists?(File.join(project_path, "src/events/event_bus.cr")).should be_true + content = File.read(File.join(project_path, "src/events/event_bus.cr")) + content.should contain("module Events") + content.should contain("class EventBus") + end + end + + it "creates ObjC platform bridge with GCD helpers" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + bridge_path = File.join(project_path, "src/platform/my_app_platform_bridge.m") + File.exists?(bridge_path).should be_true + + bridge_content = File.read(bridge_path) + # Must have GCD dispatch helpers (never use Crystal spawn in NSApp) + bridge_content.should contain("dispatch_to_main") + bridge_content.should contain("dispatch_to_background") + bridge_content.should contain("dispatch_async") + + # Must document the alias vs type rule for C function pointers + bridge_content.should contain("alias") + end + end + + it "creates L1 Crystal specs" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + # Desktop specs + File.exists?(File.join(project_path, "spec/spec_helper.cr")).should be_true + File.exists?(File.join(project_path, "spec/macos/process_manager_spec.cr")).should be_true + + # Mobile bridge specs + File.exists?(File.join(project_path, "mobile/shared/spec/bridge_spec.cr")).should be_true + + spec_content = File.read(File.join(project_path, "spec/macos/process_manager_spec.cr")) + spec_content.should contain("ProcessManagers::MainProcessManager") + end + end + + it "creates mobile shared bridge with state machine" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + bridge_path = File.join(project_path, "mobile/shared/bridge.cr") + File.exists?(bridge_path).should be_true + + content = File.read(bridge_path) + content.should contain("enum AppState") + content.should contain("class Bridge") + content.should contain("transition_to") + end + end + + it "creates iOS build script with _main fix and correct flags" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + script_path = File.join(project_path, "mobile/ios/build_crystal_lib.sh") + File.exists?(script_path).should be_true + + content = File.read(script_path) + # CRITICAL: Must fix _main symbol conflict for iOS + content.should contain("unexported_symbol _main") + content.should contain("-Dios") + content.should contain("crystal-alpha") + + # Must be executable + File.info(script_path).permissions.owner_execute?.should be_true + end + end + + it "creates iOS project.yml with correct exclusions" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + content = File.read(File.join(project_path, "mobile/ios/project.yml")) + # CRITICAL: Crystal only compiles arm64 — must exclude x86_64 + content.should contain("EXCLUDED_ARCHS") + content.should contain("x86_64") + end + end + + it "creates Android build script with -laaudio flag" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + script_path = File.join(project_path, "mobile/android/build_crystal_lib.sh") + File.exists?(script_path).should be_true + + content = File.read(script_path) + # CRITICAL: -laaudio is required for Android audio + content.should contain("-laaudio") + content.should contain("-llog") + content.should contain("-landroid") + content.should contain("-Dandroid") + content.should contain("GC_BUILTIN_ATOMIC") + content.should contain("crystal-alpha") + + # Must be executable + File.info(script_path).permissions.owner_execute?.should be_true + end + end + + it "creates Android build.gradle.kts with JDK 17 and Compose" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + content = File.read(File.join(project_path, "mobile/android/build.gradle.kts")) + content.should contain("VERSION_17") + content.should contain("compose") + content.should contain("material-icons-extended") + content.should contain("arm64-v8a") + end + end + + it "creates iOS UI test template with test_id convention" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + content = File.read(File.join(project_path, "mobile/ios/UITests/UITests.swift")) + content.should contain("XCTestCase") + content.should contain("accessibilityIdentifier") + content.should contain("{epic}.{story}-{element-name}") + end + end + + it "creates Android UI test template with testTag convention" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + content = File.read(File.join(project_path, "mobile/android/app/src/androidTest/java/com/my_app/app/MyAppUITests.kt")) + content.should contain("onNodeWithTag") + content.should contain("{epic}.{story}-{element-name}") + end + end + + it "creates L3 E2E test scripts" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + # iOS E2E + ios_script = File.join(project_path, "mobile/ios/test_ios.sh") + File.exists?(ios_script).should be_true + File.info(ios_script).permissions.owner_execute?.should be_true + + # Android E2E + android_script = File.join(project_path, "mobile/android/test_android.sh") + File.exists?(android_script).should be_true + File.info(android_script).permissions.owner_execute?.should be_true + + # macOS E2E + macos_e2e = File.join(project_path, "test/macos/test_macos_e2e.sh") + File.exists?(macos_e2e).should be_true + File.info(macos_e2e).permissions.owner_execute?.should be_true + + # macOS UI tests + macos_ui = File.join(project_path, "test/macos/test_macos_ui.sh") + File.exists?(macos_ui).should be_true + File.info(macos_ui).permissions.owner_execute?.should be_true + end + end + + it "creates CI orchestrator script" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + ci_script = File.join(project_path, "mobile/run_all_tests.sh") + File.exists?(ci_script).should be_true + File.info(ci_script).permissions.owner_execute?.should be_true + + content = File.read(ci_script) + content.should contain("--e2e") + content.should contain("L1") + content.should contain("L2") + content.should contain("L3") + end + end + + it "creates FSDD documentation structure" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + File.exists?(File.join(project_path, "docs/fsdd/_index.md")).should be_true + File.exists?(File.join(project_path, "docs/fsdd/testing/TESTING_ARCHITECTURE.md")).should be_true + + testing_content = File.read(File.join(project_path, "docs/fsdd/testing/TESTING_ARCHITECTURE.md")) + testing_content.should contain("Three-Layer Test Strategy") + testing_content.should contain("L1: Crystal Specs") + testing_content.should contain("L2: Platform UI Tests") + testing_content.should contain("L3: E2E Scripts") + testing_content.should contain("test_id") + end + end + + it "uses correct pascal case for project names with underscores" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_cool_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_cool_app") + generator.generate + + main_content = File.read(File.join(project_path, "src/my_cool_app.cr")) + main_content.should contain("MyCoolApp") + end + end + + it "uses correct pascal case for project names with hyphens" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my-cool-app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my-cool-app") + generator.generate + + main_content = File.read(File.join(project_path, "src/my-cool-app.cr")) + main_content.should contain("MyCoolApp") + end + end + + it "does not create web-specific directories" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + # Native apps should NOT have these web-specific directories + Dir.exists?(File.join(project_path, "public")).should be_false + Dir.exists?(File.join(project_path, "src/views")).should be_false + Dir.exists?(File.join(project_path, "src/channels")).should be_false + Dir.exists?(File.join(project_path, "src/sockets")).should be_false + Dir.exists?(File.join(project_path, "src/mailers")).should be_false + Dir.exists?(File.join(project_path, "src/jobs")).should be_false + Dir.exists?(File.join(project_path, "db")).should be_false + end + end + + it "creates the correct directory structure" do + SpecHelper.within_temp_directory do |temp_dir| + project_path = File.join(temp_dir, "my_app") + generator = AmberCLI::Generators::NativeApp.new(project_path, "my_app") + generator.generate + + # Native app directories + Dir.exists?(File.join(project_path, "src/controllers")).should be_true + Dir.exists?(File.join(project_path, "src/models")).should be_true + Dir.exists?(File.join(project_path, "src/process_managers")).should be_true + Dir.exists?(File.join(project_path, "src/ui")).should be_true + Dir.exists?(File.join(project_path, "src/platform")).should be_true + Dir.exists?(File.join(project_path, "src/events")).should be_true + Dir.exists?(File.join(project_path, "spec/macos")).should be_true + Dir.exists?(File.join(project_path, "mobile/shared")).should be_true + Dir.exists?(File.join(project_path, "mobile/ios")).should be_true + Dir.exists?(File.join(project_path, "mobile/android")).should be_true + Dir.exists?(File.join(project_path, "test/macos")).should be_true + Dir.exists?(File.join(project_path, "docs/fsdd")).should be_true + end + end + end +end diff --git a/src/amber_cli.cr b/src/amber_cli.cr index 81f352d..9542a23 100644 --- a/src/amber_cli.cr +++ b/src/amber_cli.cr @@ -23,6 +23,8 @@ require "./amber_cli/commands/encrypt" require "./amber_cli/commands/exec" require "./amber_cli/commands/plugin" require "./amber_cli/commands/pipelines" +require "./amber_cli/commands/generate" +require "./amber_cli/commands/setup_lsp" backend = Log::IOBackend.new backend.formatter = Log::Formatter.new do |entry, io| @@ -47,6 +49,12 @@ module AmberCLI command_name = args[0] command_args = args[1..] + # Handle version flag + if command_name == "--version" || command_name == "-v" || command_name == "version" + puts "Amber CLI v#{VERSION}" + return + end + Core::CommandRegistry.execute_command(command_name, command_args) end @@ -57,14 +65,19 @@ module AmberCLI Usage: amber [options] Available commands: - new (n) Create a new Amber application - database (db) Database operations and migrations - routes (r) Display application routes - watch (w) Start development server with file watching - encrypt (e) Encrypt/decrypt environment files - exec (x) Execute Crystal code in application context - plugin (pl) Generate application plugins - pipelines Show application pipelines and plugs + new (n) Create a new Amber V2 application + generate (g) Generate models, controllers, scaffolds, jobs, mailers, schemas, channels + database (db) Database operations and migrations + routes (r) Display application routes + watch (w) Start development server with file watching + encrypt (e) Encrypt/decrypt environment files + exec (x) Execute Crystal code in application context + plugin (pl) Generate application plugins + pipelines Show application pipelines and plugs + setup:lsp (lsp) Set up Amber LSP for Claude Code integration + + Options: + --version, -v Show version number Use 'amber --help' for more information about a command. HELP diff --git a/src/amber_cli/commands/generate.cr b/src/amber_cli/commands/generate.cr new file mode 100644 index 0000000..5e53c25 --- /dev/null +++ b/src/amber_cli/commands/generate.cr @@ -0,0 +1,1696 @@ +require "../core/base_command" + +# The `generate` command creates models, controllers, migrations, scaffolds, +# jobs, mailers, schemas, and channels for an Amber V2 application. +# +# ## Usage +# ``` +# amber generate [TYPE] [NAME] [FIELDS...] +# ``` +# +# ## Types +# - `model` - Generate a model with migration +# - `controller` - Generate a controller with actions +# - `scaffold` - Generate model, controller, views, and migration +# - `migration` - Generate a blank migration file +# - `mailer` - Generate a mailer class (Amber::Mailer::Base) +# - `job` - Generate a background job class (Amber::Jobs::Job) +# - `schema` - Generate a schema definition (Amber::Schema::Definition) +# - `channel` - Generate a WebSocket channel (Amber::WebSockets::Channel) +# - `api` - Generate API-only controller with model +# - `auth` - Generate authentication system +# +# ## Examples +# ``` +# amber generate model User name:string email:string +# amber generate controller Posts index show create update destroy +# amber generate scaffold Article title:string body:text published:bool +# amber generate migration AddStatusToUsers +# amber generate job SendNotification --queue=mailers --max-retries=5 +# amber generate mailer User --actions=welcome,notify +# amber generate schema User name:string email:string:required age:int32 +# amber generate channel Chat +# amber generate api Product name:string price:float +# ``` +module AmberCLI::Commands + class GenerateCommand < AmberCLI::Core::BaseCommand + VALID_TYPES = %w[model controller scaffold migration mailer job schema channel api auth] + + FIELD_TYPE_MAP = { + "string" => "String", + "text" => "String", + "integer" => "Int32", + "int" => "Int32", + "int32" => "Int32", + "int64" => "Int64", + "float" => "Float64", + "float64" => "Float64", + "decimal" => "Float64", + "bool" => "Bool", + "boolean" => "Bool", + "time" => "Time", + "timestamp" => "Time", + "reference" => "Int64", + "uuid" => "String", + "email" => "String", + } + + # Maps CLI field types to Schema field types with default options + SCHEMA_TYPE_MAP = { + "string" => {type: "String", options: ""}, + "text" => {type: "String", options: ""}, + "integer" => {type: "Int32", options: ""}, + "int" => {type: "Int32", options: ""}, + "int32" => {type: "Int32", options: ""}, + "int64" => {type: "Int64", options: ""}, + "float" => {type: "Float64", options: ""}, + "float64" => {type: "Float64", options: ""}, + "decimal" => {type: "Float64", options: ""}, + "bool" => {type: "Bool", options: ""}, + "boolean" => {type: "Bool", options: ""}, + "time" => {type: "Time", options: ", format: \"datetime\""}, + "timestamp" => {type: "Time", options: ", format: \"datetime\""}, + "email" => {type: "String", options: ", format: \"email\""}, + "uuid" => {type: "String", options: ", format: \"uuid\""}, + } + + getter generator_type : String = "" + getter name : String = "" + getter fields : Array(Tuple(String, String)) = [] of Tuple(String, String) + getter actions : Array(String) = [] of String + + # Job generator options + getter queue_name : String = "default" + getter max_retries : Int32 = 3 + + # Mailer generator options + getter mailer_actions : Array(String) = ["welcome"] + + # Schema generator options + getter schema_fields : Array(Tuple(String, String, Bool)) = [] of Tuple(String, String, Bool) + + # Channel generator options + getter topics : Array(String) = [] of String + + def help_description : String + <<-HELP + Generate application components for Amber V2 + + Usage: amber generate [TYPE] [NAME] [FIELDS...] + + Types: + model Generate a model with migration + controller Generate a controller with actions + scaffold Generate model, schema, controller, views, and migration + migration Generate a blank migration file + mailer Generate a mailer class (Amber::Mailer::Base) + job Generate a background job (Amber::Jobs::Job) + schema Generate a schema definition (Amber::Schema::Definition) + channel Generate a WebSocket channel (Amber::WebSockets::Channel) + api Generate API-only controller with model + auth Generate authentication system + + Field format: name:type[:required] + string, text, integer, int64, float, decimal, bool, time, email, uuid, reference + + Examples: + amber generate model User name:string email:string + amber generate controller Posts index show create update destroy + amber generate scaffold Article title:string body:text published:bool + amber generate migration AddStatusToUsers + amber generate job SendNotification --queue=mailers --max-retries=5 + amber generate mailer User --actions=welcome,notify + amber generate schema User name:string email:string:required age:int32 + amber generate channel Chat + amber generate api Product name:string price:float + HELP + end + + def setup_command_options + option_parser.separator "" + option_parser.separator "Options:" + + option_parser.on("--queue=QUEUE", "Default queue name for jobs (default: \"default\")") do |q| + @queue_name = q + end + + option_parser.on("--max-retries=N", "Max retry attempts for jobs (default: 3)") do |n| + @max_retries = n.to_i + end + + option_parser.on("--actions=ACTIONS", "Comma-separated mailer actions (default: \"welcome\")") do |a| + @mailer_actions = a.split(",").map(&.strip) + end + + option_parser.on("--topics=TOPICS", "Comma-separated channel topics") do |t| + @topics = t.split(",").map(&.strip) + end + end + + def validate_arguments + if remaining_arguments.empty? + error "Generator type is required" + puts option_parser + exit(1) + end + + @generator_type = remaining_arguments[0].downcase + + unless VALID_TYPES.includes?(@generator_type) + error "Invalid generator type: #{@generator_type}" + info "Valid types: #{VALID_TYPES.join(", ")}" + exit(1) + end + + if remaining_arguments.size < 2 + error "Name is required" + puts option_parser + exit(1) + end + + @name = remaining_arguments[1] + + # Parse remaining arguments as fields or actions + remaining_arguments[2..].each do |arg| + if arg.includes?(":") + parts = arg.split(":") + field_name = parts[0] + field_type = parts[1].downcase + is_required = parts.size > 2 && parts[2].downcase == "required" + + @fields << {field_name, field_type} + @schema_fields << {field_name, field_type, is_required} + else + @actions << arg + end + end + end + + def execute + case generator_type + when "model" + generate_model + when "controller" + generate_controller + when "scaffold" + generate_scaffold + when "migration" + generate_migration + when "mailer" + generate_mailer + when "job" + generate_job + when "schema" + generate_schema + when "channel" + generate_channel + when "api" + generate_api + when "auth" + generate_auth + else + error "Unknown generator type: #{generator_type}" + exit(1) + end + end + + # ========================================================================= + # Job Generator + # ========================================================================= + + private def generate_job + info "Generating job: #{class_name}" + + job_path = "src/jobs/#{file_name}.cr" + create_file(job_path, job_template) + + spec_path = "spec/jobs/#{file_name}_spec.cr" + create_file(spec_path, job_spec_template) + + success "Job #{class_name} generated successfully!" + puts "" + info "Next steps:" + info " 1. Add properties to your job class for the data it needs" + info " 2. Implement the `perform` method with your job logic" + info " 3. Register the job: Amber::Jobs.register(#{class_name})" + info " 4. Enqueue: #{class_name}.new.enqueue" + end + + private def job_template + queue_override = if queue_name != "default" + <<-QUEUE + + # Queue this job will be enqueued to + def self.queue : String + "#{queue_name}" + end +QUEUE + else + <<-QUEUE + + # Override to customize queue (default: "default") + # def self.queue : String + # "#{queue_name}" + # end +QUEUE + end + + retries_override = if max_retries != 3 + <<-RETRIES + + # Maximum retry attempts before job is marked as dead + def self.max_retries : Int32 + #{max_retries} + end +RETRIES + else + <<-RETRIES + + # Override to customize max retries (default: 3) + # def self.max_retries : Int32 + # 3 + # end +RETRIES + end + + <<-JOB +# Background job for #{class_name.underscore.gsub("_", " ")}. +# +# Enqueue this job: +# #{class_name}.new.enqueue +# #{class_name}.new.enqueue(delay: 5.minutes) +# #{class_name}.new.enqueue(queue: "critical") +# +# See: https://docs.amberframework.org/amber/guides/jobs +class #{class_name} < Amber::Jobs::Job + include JSON::Serializable + + # Add your job properties here + # property user_id : Int64 + + def initialize + end + + def perform + # Implement your job logic here + end +#{queue_override} +#{retries_override} +end + +# Register the job for deserialization +Amber::Jobs.register(#{class_name}) +JOB + end + + private def job_spec_template + expected_queue = queue_name + + <<-SPEC +require "../spec_helper" + +describe #{class_name} do + it "can be instantiated" do + job = #{class_name}.new + job.should_not be_nil + end + + it "can be enqueued" do + job = #{class_name}.new + envelope = job.enqueue + envelope.job_class.should eq("#{class_name}") + envelope.queue.should eq("#{expected_queue}") + end +end +SPEC + end + + # ========================================================================= + # Mailer Generator (V2 - Amber::Mailer::Base) + # ========================================================================= + + private def generate_mailer + info "Generating mailer: #{class_name}Mailer" + + mailer_path = "src/mailers/#{file_name}_mailer.cr" + create_file(mailer_path, mailer_template) + + # Create mailer view directory and templates for each action + views_dir = "src/views/#{file_name}_mailer" + mailer_actions.each do |action| + create_file("#{views_dir}/#{action}.ecr", mailer_view_template(action)) + end + + spec_path = "spec/mailers/#{file_name}_mailer_spec.cr" + create_file(spec_path, mailer_spec_template) + + success "Mailer #{class_name}Mailer generated successfully!" + puts "" + info "Next steps:" + info " 1. Customize the mailer methods and templates" + info " 2. Configure the mail adapter in config/application.cr" + info " 3. Send mail: #{class_name}Mailer.new(\"Alice\", \"alice@example.com\")" + info " .to(\"alice@example.com\")" + info " .from(\"noreply@example.com\")" + info " .subject(\"Welcome!\")" + info " .deliver" + end + + private def mailer_template + action_methods = mailer_actions.map do |action| + <<-METHOD + # Renders the #{action} email HTML body. + # Template: src/views/#{file_name}_mailer/#{action}.ecr + def #{action}_html_body : String? + render("src/views/#{file_name}_mailer/#{action}.ecr") + end +METHOD + end.join("\n\n") + + first_action = mailer_actions.first + + <<-MAILER +# Mailer for #{class_name.underscore.gsub("_", " ")} related emails. +# +# Usage: +# #{class_name}Mailer.new("Alice", "alice@example.com") +# .to("alice@example.com") +# .from("noreply@example.com") +# .subject("Welcome!") +# .deliver +# +# See: https://docs.amberframework.org/amber/guides/mailers +class #{class_name}Mailer < Amber::Mailer::Base + def initialize(@user_name : String, @user_email : String) + end + + def html_body : String? + #{first_action}_html_body + end + + def text_body : String? + "Hello, \#{@user_name}!" + end + +#{action_methods} +end +MAILER + end + + private def mailer_view_template(action : String) + <<-VIEW +

Welcome, <%= HTML.escape(@user_name) %>!

+

Thank you for signing up.

+VIEW + end + + private def mailer_spec_template + first_action = mailer_actions.first + + <<-SPEC +require "../spec_helper" + +describe #{class_name}Mailer do + it "can build a #{first_action} email" do + mailer = #{class_name}Mailer.new("Alice", "alice@example.com") + email = mailer + .to("alice@example.com") + .from("noreply@example.com") + .subject("Welcome!") + .build + + email.to.should eq(["alice@example.com"]) + email.subject.should eq("Welcome!") + email.html_body.should_not be_nil + end +end +SPEC + end + + # ========================================================================= + # Schema Generator + # ========================================================================= + + private def generate_schema + info "Generating schema: #{class_name}Schema" + + schema_path = "src/schemas/#{file_name}_schema.cr" + create_file(schema_path, schema_template) + + spec_path = "spec/schemas/#{file_name}_schema_spec.cr" + create_file(spec_path, schema_spec_template) + + success "Schema #{class_name}Schema generated successfully!" + puts "" + info "Next steps:" + info " 1. Customize field validations (min_length, max_length, format, etc.)" + info " 2. Use in controllers: schema = #{class_name}Schema.new(merge_request_data)" + info " 3. Check result: result = schema.validate" + end + + private def schema_template + field_definitions = schema_fields.map do |field_name, field_type, is_required| + schema_info = SCHEMA_TYPE_MAP[field_type]? || {type: "String", options: ""} + crystal_type = schema_info[:type] + extra_options = schema_info[:options] + + required_str = is_required ? ", required: true" : "" + + " field :#{field_name}, #{crystal_type}#{required_str}#{extra_options}" + end.join("\n") + + # If no fields were parsed from schema_fields, use regular fields + if field_definitions.empty? && !fields.empty? + field_definitions = fields.map do |field_name, field_type| + schema_info = SCHEMA_TYPE_MAP[field_type]? || {type: "String", options: ""} + crystal_type = schema_info[:type] + extra_options = schema_info[:options] + + " field :#{field_name}, #{crystal_type}#{extra_options}" + end.join("\n") + end + + <<-SCHEMA +# Schema definition for validating #{class_name.underscore.gsub("_", " ")} data. +# +# Usage: +# data = {"name" => JSON::Any.new("value")} +# schema = #{class_name}Schema.new(data) +# result = schema.validate +# if result.success? +# # Access validated fields: schema.name +# else +# # Handle errors: result.errors +# end +# +# See: https://docs.amberframework.org/amber/guides/schemas +class #{class_name}Schema < Amber::Schema::Definition +#{field_definitions} +end +SCHEMA + end + + private def schema_spec_template + # Build valid test data from fields + valid_data_entries = schema_fields.map do |field_name, field_type, _| + value = case field_type + when "string", "text", "uuid" then "\"test_value\"" + when "email" then "\"test@example.com\"" + when "integer", "int", "int32" then "1" + when "int64" then "1_i64" + when "float", "float64" then "1.0" + when "decimal" then "1.0" + when "bool", "boolean" then "false" + when "time", "timestamp" then "\"2024-01-01T00:00:00Z\"" + else "\"test_value\"" + end + " \"#{field_name}\" => JSON::Any.new(#{value})," + end.join("\n") + + # Fall back to regular fields if schema_fields is empty + if valid_data_entries.empty? && !fields.empty? + valid_data_entries = fields.map do |field_name, field_type| + value = case field_type + when "string", "text", "uuid" then "\"test_value\"" + when "email" then "\"test@example.com\"" + when "integer", "int", "int32" then "1" + when "int64" then "1_i64" + when "float", "float64" then "1.0" + when "decimal" then "1.0" + when "bool", "boolean" then "false" + when "time", "timestamp" then "\"2024-01-01T00:00:00Z\"" + else "\"test_value\"" + end + " \"#{field_name}\" => JSON::Any.new(#{value})," + end.join("\n") + end + + <<-SPEC +require "../spec_helper" + +describe #{class_name}Schema do + it "validates with valid data" do + data = { +#{valid_data_entries} + } + schema = #{class_name}Schema.new(data) + result = schema.validate + result.success?.should be_true + end + + it "fails validation when required fields are missing" do + data = {} of String => JSON::Any + schema = #{class_name}Schema.new(data) + result = schema.validate + # If you have required fields, this should fail: + # result.failure?.should be_true + result.should_not be_nil + end +end +SPEC + end + + # ========================================================================= + # Channel Generator + # ========================================================================= + + private def generate_channel + info "Generating channel: #{class_name}Channel" + + channel_path = "src/channels/#{file_name}_channel.cr" + create_file(channel_path, channel_template) + + socket_path = "src/sockets/#{file_name}_socket.cr" + create_file(socket_path, socket_template) + + spec_path = "spec/channels/#{file_name}_channel_spec.cr" + create_file(spec_path, channel_spec_template) + + success "Channel #{class_name}Channel generated successfully!" + puts "" + info "Next steps:" + info " 1. Implement handle_message with your channel logic" + info " 2. Configure the socket in config/routes.cr:" + info " websocket \"/#{file_name}\", #{class_name}Socket" + info " 3. Connect from the client using JavaScript WebSocket API" + end + + private def channel_template + topic_name = file_name + + <<-CHANNEL +# WebSocket channel for #{class_name.underscore.gsub("_", " ")} communication. +# +# Clients subscribe to this channel through a ClientSocket. +# Messages sent to this channel are handled by `handle_message`. +# +# See: https://docs.amberframework.org/amber/guides/websockets +class #{class_name}Channel < Amber::WebSockets::Channel + # Called when a client subscribes to this channel. + # Use this for authorization or sending initial state. + def handle_joined(client_socket, message) + end + + # Called when a client unsubscribes from this channel. + def handle_leave(client_socket) + end + + # Called when a client sends a message to this channel. + # Implement your message handling logic here. + def handle_message(client_socket, msg) + # Rebroadcast to all subscribers: + rebroadcast!(msg) + end +end +CHANNEL + end + + private def socket_template + <<-SOCKET +# ClientSocket for #{class_name.underscore.gsub("_", " ")} WebSocket connections. +# +# Maps authenticated users to WebSocket connections and registers +# channels that clients can subscribe to. +# +# Configure in config/routes.cr: +# websocket "/#{file_name}", #{class_name}Socket +# +# See: https://docs.amberframework.org/amber/guides/websockets +struct #{class_name}Socket < Amber::WebSockets::ClientSocket + channel "#{file_name}:*", #{class_name}Channel + + # Optional: implement authentication + def on_connect : Bool + # Return true to allow connection, false to reject. + # Example: check session or token + # return get_bearer_token? != nil + true + end +end +SOCKET + end + + private def channel_spec_template + <<-SPEC +require "../spec_helper" + +describe #{class_name}Channel do + it "can be instantiated" do + channel = #{class_name}Channel.new("#{file_name}:lobby") + channel.should_not be_nil + end +end +SPEC + end + + # ========================================================================= + # Model Generator + # ========================================================================= + + private def generate_model + info "Generating model: #{class_name}" + + model_path = "src/models/#{file_name}.cr" + create_file(model_path, model_template) + + generate_migration_for_model + + spec_path = "spec/models/#{file_name}_spec.cr" + create_file(spec_path, model_spec_template) + + success "Model #{class_name} generated successfully!" + end + + private def model_template + field_definitions = fields.map do |field_name, field_type| + crystal_type = FIELD_TYPE_MAP[field_type]? || "String" + " column #{field_name} : #{crystal_type}" + end.join("\n") + + <<-MODEL +class #{class_name} < Grant::Model + table :#{table_name} + + primary_key id : Int64 + +#{field_definitions} + + timestamps + + # Add validations here: + # validate :name, "can't be blank" do |model| + # !model.name.to_s.empty? + # end +end +MODEL + end + + private def model_spec_template + <<-SPEC +require "../spec_helper" + +describe #{class_name} do + it "can be created" do + #{variable_name} = #{class_name}.new + #{variable_name}.should_not be_nil + end +end +SPEC + end + + # ========================================================================= + # Controller Generator (V2) + # ========================================================================= + + private def generate_controller + info "Generating controller: #{controller_name}" + + controller_path = "src/controllers/#{file_name}_controller.cr" + create_file(controller_path, controller_template) + + # Generate view files for each action + template_ext = detect_template_extension + view_actions = if actions.empty? + %w[index] + else + actions + end + + view_actions.each do |action| + view_path = "src/views/#{file_name}/#{action}.#{template_ext}" + create_file(view_path, controller_view_template(action, template_ext)) + end + + spec_path = "spec/controllers/#{file_name}_controller_spec.cr" + create_file(spec_path, controller_spec_template) + + success "Controller #{controller_name} generated successfully!" + info "Don't forget to add routes to config/routes.cr" + end + + private def controller_template + action_methods = if actions.empty? + %w[index] + else + actions + end + + template_ext = detect_template_extension + + methods = action_methods.map do |action| + <<-METHOD + def #{action} + render("#{action}.#{template_ext}") + end +METHOD + end.join("\n\n") + + <<-CONTROLLER +class #{controller_name} < ApplicationController +#{methods} +end +CONTROLLER + end + + private def controller_view_template(action : String, ext : String) + if ext == "slang" + <<-VIEW +h1 #{class_name} - #{action.capitalize} +p This is the #{action} action for #{controller_name}. +VIEW + else + <<-VIEW +

#{class_name} - #{action.capitalize}

+

This is the #{action} action for #{controller_name}.

+VIEW + end + end + + private def controller_spec_template + action_methods = if actions.empty? + %w[index] + else + actions + end + + action_specs = action_methods.map do |action| + verb = case action + when "index", "show", "new", "edit" then "GET" + when "create" then "POST" + when "update" then "PUT" + when "destroy" then "DELETE" + else "GET" + end + + path = case action + when "index" then "/#{plural_name}" + when "show" then "/#{plural_name}/1" + when "new" then "/#{plural_name}/new" + when "edit" then "/#{plural_name}/1/edit" + when "create" then "/#{plural_name}" + when "update" then "/#{plural_name}/1" + when "destroy" then "/#{plural_name}/1" + else "/#{plural_name}" + end + + <<-SPEC_BLOCK + describe "#{verb} #{path}" do + it "responds successfully" do + response = #{verb.downcase}("#{path}") + assert_response_success(response) + end + end +SPEC_BLOCK + end.join("\n\n") + + <<-SPEC +require "../spec_helper" + +describe #{controller_name} do + include Amber::Testing::RequestHelpers + include Amber::Testing::Assertions + +#{action_specs} +end +SPEC + end + + # ========================================================================= + # Scaffold Generator (V2) + # ========================================================================= + + private def generate_scaffold + info "Generating scaffold: #{class_name}" + + generate_model + generate_scaffold_schema + generate_controller_for_scaffold + generate_views + + success "Scaffold #{class_name} generated successfully!" + puts "" + info "Don't forget to add routes to config/routes.cr:" + info " resources \"/#{plural_name}\", #{controller_name}" + end + + private def generate_scaffold_schema + schema_path = "src/schemas/#{file_name}_schema.cr" + + field_definitions = fields.map do |field_name, field_type| + schema_info = SCHEMA_TYPE_MAP[field_type]? || {type: "String", options: ""} + crystal_type = schema_info[:type] + extra_options = schema_info[:options] + " field :#{field_name}, #{crystal_type}, required: true#{extra_options}" + end.join("\n") + + content = <<-SCHEMA +# Schema for validating #{class_name} create/update parameters. +# +# Used by #{controller_name} for request validation. +# +# See: https://docs.amberframework.org/amber/guides/schemas +class #{class_name}Schema < Amber::Schema::Definition +#{field_definitions} +end +SCHEMA + + create_file(schema_path, content) + end + + private def generate_controller_for_scaffold + controller_path = "src/controllers/#{file_name}_controller.cr" + create_file(controller_path, scaffold_controller_template) + + spec_path = "spec/controllers/#{file_name}_controller_spec.cr" + create_file(spec_path, scaffold_spec_template) + end + + private def scaffold_controller_template + template_ext = detect_template_extension + + schema_field_assignments = fields.map do |field_name, _| + " #{variable_name}.#{field_name} = schema.#{field_name}.not_nil!" + end.join("\n") + + update_field_assignments = fields.map do |field_name, _| + " #{variable_name}.#{field_name} = schema.#{field_name}.not_nil!" + end.join("\n") + + <<-CONTROLLER +class #{controller_name} < ApplicationController + def index + @#{plural_variable_name} = #{class_name}.all + render("index.#{template_ext}") + end + + def show + if #{variable_name} = #{class_name}.find(params[:id]) + @#{variable_name} = #{variable_name} + render("show.#{template_ext}") + else + flash[:danger] = "#{class_name} not found" + redirect_to "/#{plural_name}" + end + end + + def new + @#{variable_name} = #{class_name}.new + render("new.#{template_ext}") + end + + def create + # Schema-based parameter validation + schema = #{class_name}Schema.new(merge_request_data) + result = schema.validate + + if result.success? + #{variable_name} = #{class_name}.new +#{schema_field_assignments} + + if #{variable_name}.save + flash[:success] = "#{class_name} created successfully" + redirect_to "/#{plural_name}/\#{#{variable_name}.id}" + else + @#{variable_name} = #{variable_name} + flash[:danger] = "Could not create #{class_name}" + render("new.#{template_ext}") + end + else + @#{variable_name} = #{class_name}.new + @errors = result.errors + flash[:danger] = "Validation failed" + render("new.#{template_ext}") + end + end + + def edit + if #{variable_name} = #{class_name}.find(params[:id]) + @#{variable_name} = #{variable_name} + render("edit.#{template_ext}") + else + flash[:danger] = "#{class_name} not found" + redirect_to "/#{plural_name}" + end + end + + def update + if #{variable_name} = #{class_name}.find(params[:id]) + schema = #{class_name}Schema.new(merge_request_data) + result = schema.validate + + if result.success? +#{update_field_assignments} + + if #{variable_name}.save + flash[:success] = "#{class_name} updated successfully" + redirect_to "/#{plural_name}/\#{#{variable_name}.id}" + else + @#{variable_name} = #{variable_name} + flash[:danger] = "Could not update #{class_name}" + render("edit.#{template_ext}") + end + else + @#{variable_name} = #{variable_name} + @errors = result.errors + flash[:danger] = "Validation failed" + render("edit.#{template_ext}") + end + else + flash[:danger] = "#{class_name} not found" + redirect_to "/#{plural_name}" + end + end + + def destroy + if #{variable_name} = #{class_name}.find(params[:id]) + #{variable_name}.destroy + flash[:success] = "#{class_name} deleted successfully" + else + flash[:danger] = "#{class_name} not found" + end + redirect_to "/#{plural_name}" + end +end +CONTROLLER + end + + private def scaffold_spec_template + <<-SPEC +require "../spec_helper" + +describe #{controller_name} do + include Amber::Testing::RequestHelpers + include Amber::Testing::Assertions + + describe "GET /#{plural_name}" do + it "responds successfully" do + response = get("/#{plural_name}") + assert_response_success(response) + end + end + + describe "GET /#{plural_name}/new" do + it "responds successfully" do + response = get("/#{plural_name}/new") + assert_response_success(response) + end + end + + describe "GET /#{plural_name}/:id" do + it "responds successfully" do + response = get("/#{plural_name}/1") + # assert_response_success(response) + end + end + + describe "GET /#{plural_name}/:id/edit" do + it "responds successfully" do + response = get("/#{plural_name}/1/edit") + # assert_response_success(response) + end + end + + describe "POST /#{plural_name}" do + it "creates a new #{class_name.underscore}" do + response = post("/#{plural_name}") + # assert_response_redirect(response) + end + end + + describe "DELETE /#{plural_name}/:id" do + it "deletes the #{class_name.underscore}" do + response = delete("/#{plural_name}/1") + # assert_response_redirect(response) + end + end +end +SPEC + end + + private def generate_views + views_dir = "src/views/#{file_name}" + + template_ext = detect_template_extension + + create_file("#{views_dir}/index.#{template_ext}", index_view_template(template_ext)) + create_file("#{views_dir}/show.#{template_ext}", show_view_template(template_ext)) + create_file("#{views_dir}/new.#{template_ext}", new_view_template(template_ext)) + create_file("#{views_dir}/edit.#{template_ext}", edit_view_template(template_ext)) + create_file("#{views_dir}/_form.#{template_ext}", form_partial_template(template_ext)) + end + + # ========================================================================= + # Migration Generator + # ========================================================================= + + private def generate_migration + timestamp = Time.utc.to_s("%Y%m%d%H%M%S%3N") + migration_name = name.underscore + migration_path = "db/migrations/#{timestamp}_#{migration_name}.sql" + + Dir.mkdir_p("db/migrations") unless Dir.exists?("db/migrations") + + if fields.empty? + content = <<-SQL +-- Migration: #{migration_name} +-- Created: #{Time.utc} + +-- Add your migration SQL here + +SQL + else + content = create_table_migration + end + + create_file(migration_path, content) + success "Migration created: #{migration_path}" + end + + private def generate_migration_for_model + timestamp = Time.utc.to_s("%Y%m%d%H%M%S%3N") + migration_path = "db/migrations/#{timestamp}_create_#{table_name}.sql" + + Dir.mkdir_p("db/migrations") unless Dir.exists?("db/migrations") + create_file(migration_path, create_table_migration) + end + + # ========================================================================= + # API Generator + # ========================================================================= + + private def generate_api + info "Generating API: #{class_name}" + + generate_model + + # Generate schema for API validation + generate_scaffold_schema + + # API controller (JSON only) + api_dir = "src/controllers/api" + Dir.mkdir_p(api_dir) unless Dir.exists?(api_dir) + + api_controller_path = "#{api_dir}/#{file_name}_controller.cr" + create_file(api_controller_path, api_controller_template) + + spec_path = "spec/controllers/api_#{file_name}_controller_spec.cr" + create_file(spec_path, api_spec_template) + + success "API #{class_name} generated successfully!" + puts "" + info "Don't forget to add routes to config/routes.cr:" + info " routes :api do" + info " resources \"/#{plural_name}\", Api::#{controller_name}" + info " end" + end + + private def api_controller_template + schema_field_assignments = fields.map do |field_name, _| + " #{variable_name}.#{field_name} = schema.#{field_name}.not_nil!" + end.join("\n") + + update_field_assignments = fields.map do |field_name, _| + " #{variable_name}.#{field_name} = schema.#{field_name}.not_nil!" + end.join("\n") + + <<-CONTROLLER +module Api + class #{controller_name} < ApplicationController + def index + #{plural_variable_name} = #{class_name}.all + render json: #{plural_variable_name}.to_json + end + + def show + if #{variable_name} = #{class_name}.find(params[:id]) + render json: #{variable_name}.to_json + else + render json: {error: "#{class_name} not found"}.to_json, status: 404 + end + end + + def create + schema = #{class_name}Schema.new(merge_request_data) + result = schema.validate + + if result.success? + #{variable_name} = #{class_name}.new +#{schema_field_assignments} + + if #{variable_name}.save + render json: #{variable_name}.to_json, status: 201 + else + render json: {error: "Could not create #{class_name}"}.to_json, status: 422 + end + else + render json: {errors: result.errors.map(&.to_h)}.to_json, status: 422 + end + end + + def update + if #{variable_name} = #{class_name}.find(params[:id]) + schema = #{class_name}Schema.new(merge_request_data) + result = schema.validate + + if result.success? +#{update_field_assignments} + + if #{variable_name}.save + render json: #{variable_name}.to_json + else + render json: {error: "Could not update #{class_name}"}.to_json, status: 422 + end + else + render json: {errors: result.errors.map(&.to_h)}.to_json, status: 422 + end + else + render json: {error: "#{class_name} not found"}.to_json, status: 404 + end + end + + def destroy + if #{variable_name} = #{class_name}.find(params[:id]) + #{variable_name}.destroy + render json: {message: "#{class_name} deleted"}.to_json + else + render json: {error: "#{class_name} not found"}.to_json, status: 404 + end + end + end +end +CONTROLLER + end + + private def api_spec_template + <<-SPEC +require "../spec_helper" + +describe Api::#{controller_name} do + include Amber::Testing::RequestHelpers + include Amber::Testing::Assertions + + describe "GET /api/#{plural_name}" do + it "responds with JSON" do + response = get("/api/#{plural_name}") + assert_response_success(response) + assert_json_content_type(response) + end + end + + describe "POST /api/#{plural_name}" do + it "creates a new #{class_name.underscore}" do + # response = post_json("/api/#{plural_name}", {}) + # assert_response_status(response, 201) + end + end +end +SPEC + end + + # ========================================================================= + # Auth Generator (V2) + # ========================================================================= + + private def generate_auth + info "Generating authentication system" + + template_ext = detect_template_extension + + # Generate User model + @fields = [{"email", "string"}, {"hashed_password", "string"}] + @name = "User" + generate_model + + # Generate session controller + session_controller = <<-CONTROLLER +class SessionController < ApplicationController + def new + render("new.#{template_ext}") + end + + def create + if user = User.authenticate(params[:email], params[:password]) + session[:user_id] = user.id.to_s + flash[:success] = "Welcome back!" + redirect_to "/" + else + flash[:danger] = "Invalid email or password" + render("new.#{template_ext}") + end + end + + def destroy + session.delete(:user_id) + flash[:info] = "You have been logged out" + redirect_to "/" + end +end +CONTROLLER + + create_file("src/controllers/session_controller.cr", session_controller) + + # Generate registration controller + registration_controller = <<-CONTROLLER +class RegistrationController < ApplicationController + def new + @user = User.new + render("new.#{template_ext}") + end + + def create + user = User.new + user.email = params[:email] + user.password = params[:password] + + if user.save + session[:user_id] = user.id.to_s + flash[:success] = "Welcome! Your account has been created." + redirect_to "/" + else + @user = user + flash[:danger] = "Could not create account" + render("new.#{template_ext}") + end + end +end +CONTROLLER + + create_file("src/controllers/registration_controller.cr", registration_controller) + + # Create view directories and views + if template_ext == "ecr" + login_view = <<-VIEW +

Login

+ +<%= form_for("/session", method: "POST") { %> +
+ <%= label("email") %> + <%= email_field("email") %> +
+
+ <%= label("password") %> + <%= password_field("password") %> +
+ <%= submit_button("Login") %> +<% } %> +VIEW + + register_view = <<-VIEW +

Create Account

+ +<%= form_for("/register", method: "POST") { %> +
+ <%= label("email") %> + <%= email_field("email") %> +
+
+ <%= label("password") %> + <%= password_field("password") %> +
+
+ <%= label("password_confirmation", text: "Confirm Password") %> + <%= password_field("password_confirmation") %> +
+ <%= submit_button("Create Account") %> +<% } %> +VIEW + else + login_view = <<-VIEW +h1 Login +== form(action: "/session", method: "post") do + .form-group + label Email + input type="email" name="email" required=true + .form-group + label Password + input type="password" name="password" required=true + button type="submit" Login +VIEW + + register_view = <<-VIEW +h1 Create Account +== form(action: "/register", method: "post") do + .form-group + label Email + input type="email" name="email" required=true + .form-group + label Password + input type="password" name="password" required=true + .form-group + label Confirm Password + input type="password" name="password_confirmation" required=true + button type="submit" Create Account +VIEW + end + + create_file("src/views/session/new.#{template_ext}", login_view) + create_file("src/views/registration/new.#{template_ext}", register_view) + + success "Authentication system generated!" + puts "" + info "Add these routes to config/routes.cr:" + info " get \"/login\", SessionController, :new" + info " post \"/session\", SessionController, :create" + info " delete \"/session\", SessionController, :destroy" + info " get \"/register\", RegistrationController, :new" + info " post \"/register\", RegistrationController, :create" + end + + # ========================================================================= + # SQL Migration Templates + # ========================================================================= + + private def create_table_migration + column_definitions = fields.map do |field_name, field_type| + sql_type = case field_type + when "string", "uuid", "email" then "VARCHAR(255)" + when "text" then "TEXT" + when "integer", "int", "int32" then "INTEGER" + when "int64", "reference" then "BIGINT" + when "float", "float64" then "DOUBLE PRECISION" + when "decimal" then "DECIMAL(10,2)" + when "bool", "boolean" then "BOOLEAN DEFAULT FALSE" + when "time", "timestamp" then "TIMESTAMP" + else "VARCHAR(255)" + end + " #{field_name} #{sql_type}" + end.join(",\n") + + <<-SQL +-- Create #{table_name} table +CREATE TABLE IF NOT EXISTS #{table_name} ( + id BIGSERIAL PRIMARY KEY, +#{column_definitions}, + created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, + updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP +); +SQL + end + + # ========================================================================= + # View Templates (V2 with form helpers) + # ========================================================================= + + private def index_view_template(ext : String) + if ext == "slang" + <<-VIEW +h1 #{plural_class_name} + +a href="/#{plural_name}/new" New #{class_name} + +table + thead + tr + th ID +#{fields.map { |f, _| " th #{f.camelcase}" }.join("\n")} + th Actions + tbody + - @#{plural_variable_name}.each do |#{variable_name}| + tr + td = #{variable_name}.id +#{fields.map { |f, _| " td = #{variable_name}.#{f}" }.join("\n")} + td + a href="/#{plural_name}/\#{#{variable_name}.id}" Show + a href="/#{plural_name}/\#{#{variable_name}.id}/edit" Edit +VIEW + else + <<-VIEW +

#{plural_class_name}

+ +New #{class_name} + + + + + +#{fields.map { |f, _| " " }.join("\n")} + + + + + <% @#{plural_variable_name}.each do |#{variable_name}| %> + + +#{fields.map { |f, _| " " }.join("\n")} + + + <% end %> + +
ID#{f.camelcase}Actions
<%= #{variable_name}.id %><%= #{variable_name}.#{f} %> + Show + Edit +
+VIEW + end + end + + private def show_view_template(ext : String) + if ext == "slang" + <<-VIEW +h1 #{class_name} + +dl +#{fields.map { |f, _| " dt #{f.camelcase}\n dd = @#{variable_name}.#{f}" }.join("\n")} + +a href="/#{plural_name}" Back +a href="/#{plural_name}/\#{@#{variable_name}.id}/edit" Edit +VIEW + else + <<-VIEW +

#{class_name}

+ +
+#{fields.map { |f, _| "
#{f.camelcase}
\n
<%= @#{variable_name}.#{f} %>
" }.join("\n")} +
+ +Back +Edit +VIEW + end + end + + private def new_view_template(ext : String) + if ext == "slang" + <<-VIEW +h1 New #{class_name} + +== render("_form.slang") + +a href="/#{plural_name}" Back +VIEW + else + <<-VIEW +

New #{class_name}

+ +<%= render("_form.ecr") %> + +Back +VIEW + end + end + + private def edit_view_template(ext : String) + if ext == "slang" + <<-VIEW +h1 Edit #{class_name} + +== render("_form.slang") + +a href="/#{plural_name}" Back +VIEW + else + <<-VIEW +

Edit #{class_name}

+ +<%= render("_form.ecr") %> + +Back +VIEW + end + end + + private def form_partial_template(ext : String) + if ext == "slang" + form_fields = fields.map do |field_name, field_type| + input_type = case field_type + when "text" then "textarea" + when "bool", "boolean" then "checkbox" + when "integer", "int", "int32", "int64", "float", "decimal" then "number" + else "text" + end + + if input_type == "textarea" + <<-FIELD + .form-group + label #{field_name.camelcase} + textarea name="#{field_name}" = @#{variable_name}.try(&.#{field_name}) +FIELD + elsif input_type == "checkbox" + <<-FIELD + .form-group + label + input type="checkbox" name="#{field_name}" checked=@#{variable_name}.try(&.#{field_name}) + | #{field_name.camelcase} +FIELD + else + <<-FIELD + .form-group + label #{field_name.camelcase} + input type="#{input_type}" name="#{field_name}" value=@#{variable_name}.try(&.#{field_name}) +FIELD + end + end.join("\n") + + <<-VIEW +== form(action: "/#{plural_name}", method: "post") do +#{form_fields} + button type="submit" Save +VIEW + else + form_fields = fields.map do |field_name, field_type| + case field_type + when "text" + <<-FIELD +
+ <%= label("#{field_name}") %> + <%= text_area("#{field_name}", value: @#{variable_name}.try(&.#{field_name})) %> +
+FIELD + when "bool", "boolean" + <<-FIELD +
+ <%= checkbox("#{field_name}", checked: @#{variable_name}.try(&.#{field_name}) || false) %> + <%= label("#{field_name}") %> +
+FIELD + when "email" + <<-FIELD +
+ <%= label("#{field_name}") %> + <%= email_field("#{field_name}", value: @#{variable_name}.try(&.#{field_name})) %> +
+FIELD + when "integer", "int", "int32", "int64", "float", "float64", "decimal" + <<-FIELD +
+ <%= label("#{field_name}") %> + <%= number_field("#{field_name}", value: @#{variable_name}.try(&.#{field_name})) %> +
+FIELD + else + <<-FIELD +
+ <%= label("#{field_name}") %> + <%= text_field("#{field_name}", value: @#{variable_name}.try(&.#{field_name})) %> +
+FIELD + end + end.join("\n") + + <<-VIEW +<%= form_for("/#{plural_name}", method: "POST") { %> +#{form_fields} + <%= submit_button("Save") %> +<% } %> +VIEW + end + end + + # ========================================================================= + # Helper Methods + # ========================================================================= + + private def class_name + name.camelcase + end + + private def plural_class_name + pluralize(class_name) + end + + private def controller_name + "#{class_name}Controller" + end + + private def file_name + name.underscore + end + + private def table_name + pluralize(name.underscore) + end + + private def variable_name + name.underscore + end + + private def plural_variable_name + pluralize(name.underscore) + end + + private def plural_name + pluralize(name.underscore) + end + + private def default_actions + %w[index show new create edit update destroy] + end + + private def field_assignments + fields.map do |field_name, _| + " #{variable_name}.#{field_name} = params[:#{field_name}]" + end.join("\n") + end + + private def field_assignments_with_prefix + fields.map do |field_name, _| + " #{variable_name}.#{field_name} = params[:#{field_name}]" + end.join("\n") + end + + private def pluralize(word : String) : String + return word if word.empty? + + if word.ends_with?("y") && !%w[a e i o u].includes?(word[-2].to_s) + word[0..-2] + "ies" + elsif word.ends_with?("s") || word.ends_with?("x") || word.ends_with?("z") || + word.ends_with?("ch") || word.ends_with?("sh") + word + "es" + elsif word.ends_with?("f") + word[0..-2] + "ves" + elsif word.ends_with?("fe") + word[0..-3] + "ves" + else + word + "s" + end + end + + private def detect_template_extension + if File.exists?(".amber.yml") + content = File.read(".amber.yml") + if content.includes?("template: slang") + "slang" + else + "ecr" + end + else + "ecr" + end + end + + private def create_file(path : String, content : String) + dir = File.dirname(path) + Dir.mkdir_p(dir) unless Dir.exists?(dir) + + if File.exists?(path) + warning "Skipped (exists): #{path}" + else + File.write(path, content) + info "Created: #{path}" + end + end + end +end + +# Register the command +AmberCLI::Core::CommandRegistry.register("generate", ["g"], AmberCLI::Commands::GenerateCommand) diff --git a/src/amber_cli/commands/new.cr b/src/amber_cli/commands/new.cr index 0add807..7ea9b57 100644 --- a/src/amber_cli/commands/new.cr +++ b/src/amber_cli/commands/new.cr @@ -1,37 +1,47 @@ require "../core/base_command" +require "../generators/native_app" -# The `new` command creates a new Amber application with a default directory structure -# and configuration at the specified path. +# The `new` command creates a new Amber V2 application with a complete directory +# structure, configuration files, and a working home page. # # ## Usage # ``` -# amber new [app_name] -d [pg | mysql | sqlite] -t [slang | ecr] --no-deps +# amber new [app_name] -d [pg | mysql | sqlite] -t [ecr | slang] --type [web | native] --no-deps # ``` # # ## Options # - `-d, --database` - Database type (pg, mysql, sqlite) -# - `-t, --template` - Template language (slang, ecr) +# - `-t, --template` - Template language (ecr, slang) +# - `--type` - Application type: web (default) or native (cross-platform desktop/mobile) # - `--no-deps` - Skip dependency installation # # ## Examples # ``` -# # Create a new app with PostgreSQL and Slang -# amber new my_blog -d pg -t slang +# # Create a new web app with PostgreSQL and ECR (defaults) +# amber new my_blog +# +# # Create app with MySQL and Slang templates +# amber new my_blog -d mysql -t slang +# +# # Create a native cross-platform app (macOS, iOS, Android) +# amber new my_native_app --type native # # # Create app with SQLite (for development) # amber new quick_app -d sqlite # ``` module AmberCLI::Commands class NewCommand < AmberCLI::Core::BaseCommand + VALID_APP_TYPES = %w[web native] + getter database : String = "pg" - getter template : String = "slang" - getter recipe : String? + getter template : String = "ecr" + getter app_type : String = "web" getter assume_yes : Bool = false getter no_deps : Bool = false getter name : String = "" def help_description : String - "Generates a new Amber project" + "Generates a new Amber V2 project" end def setup_command_options @@ -40,14 +50,18 @@ module AmberCLI::Commands @database = db end - option_parser.on("-t TEMPLATE", "--template=TEMPLATE", "Select template engine (slang, ecr)") do |tmpl| + option_parser.on("-t TEMPLATE", "--template=TEMPLATE", "Select template engine (ecr, slang)") do |tmpl| @parsed_options["template"] = tmpl @template = tmpl end - option_parser.on("-r RECIPE", "--recipe=RECIPE", "Use a named recipe") do |recipe| - @parsed_options["recipe"] = recipe - @recipe = recipe + option_parser.on("--type=TYPE", "Application type: web (default), native (cross-platform)") do |type| + unless VALID_APP_TYPES.includes?(type) + error "Invalid app type '#{type}'. Valid types: #{VALID_APP_TYPES.join(", ")}" + exit(1) + end + @parsed_options["app_type"] = type + @app_type = type end option_parser.on("-y", "--assume-yes", "Assume yes to disable interactive mode") do @@ -63,9 +77,16 @@ module AmberCLI::Commands option_parser.separator "" option_parser.separator "Usage: amber new [NAME] [options]" option_parser.separator "" + option_parser.separator "App types:" + option_parser.separator " web Web application with HTTP server, routes, views (default)" + option_parser.separator " native Cross-platform native app (macOS, iOS, Android)" + option_parser.separator " Uses Asset Pipeline UI, FSDD process managers," + option_parser.separator " crystal-audio, and platform build scripts." + option_parser.separator "" option_parser.separator "Examples:" option_parser.separator " amber new my_app" - option_parser.separator " amber new my_app -d mysql -t ecr" + option_parser.separator " amber new my_app -d mysql -t slang" + option_parser.separator " amber new my_native_app --type native" option_parser.separator " amber new . -d sqlite" end @@ -94,13 +115,47 @@ module AmberCLI::Commands exit!(error: true) end - info "Creating new Amber application: #{project_name}" + if app_type == "native" + execute_native(full_path_name, project_name) + else + execute_web(full_path_name, project_name) + end + end + + private def execute_native(full_path_name : String, project_name : String) + info "Creating new Amber V2 native application: #{project_name}" + info "Type: native (cross-platform: macOS, iOS, Android)" + info "Location: #{full_path_name}" + + generator = AmberCLI::Generators::NativeApp.new(full_path_name, project_name) + generator.generate + + info "Created native project structure" + + success "Successfully created #{project_name}!" + puts "" + info "To get started:" + info " cd #{name}" unless name == "." + info " make setup # Install shards + create symlinks" + info " make macos # Build for macOS" + info " make run # Build and run" + info " make spec # Run Crystal specs" + puts "" + info "Cross-platform builds:" + info " ./mobile/ios/build_crystal_lib.sh simulator # iOS" + info " ./mobile/android/build_crystal_lib.sh # Android" + puts "" + info "Test suite:" + info " ./mobile/run_all_tests.sh # L1 + L2 tests" + info " ./mobile/run_all_tests.sh --e2e # Full E2E tests" + end + + private def execute_web(full_path_name : String, project_name : String) + info "Creating new Amber V2 application: #{project_name}" info "Database: #{database}" info "Template: #{template}" info "Location: #{full_path_name}" - # TODO: Implement the actual project generation using the new generator system - # For now, just create a basic directory structure create_project_structure(full_path_name, project_name) # Encrypt production.yml by default @@ -113,19 +168,31 @@ module AmberCLI::Commands end success "Successfully created #{project_name}!" + puts "" info "To get started:" info " cd #{name}" unless name == "." info " shards install" unless no_deps + info " amber database create" + info " amber database migrate" info " amber watch" end private def create_project_structure(path : String, name : String) - # Create basic directory structure + # Create V2 directory structure dirs = [ + # Config "config", "config/environments", "config/initializers", - "db", "db/migrations", "public", "public/css", "public/js", "public/img", - "spec", "src", "src/controllers", "src/models", "src/views", "src/views/layouts", - "src/views/home", + # Database + "db", "db/migrations", + # Public assets + "public", "public/css", "public/js", "public/img", + # Spec directories + "spec", "spec/controllers", "spec/models", "spec/schemas", + "spec/jobs", "spec/mailers", "spec/channels", "spec/requests", + # Source directories + "src", "src/controllers", "src/models", + "src/views", "src/views/layouts", "src/views/home", + "src/schemas", "src/jobs", "src/mailers", "src/channels", "src/sockets", ] dirs.each do |dir| @@ -133,192 +200,510 @@ module AmberCLI::Commands Dir.mkdir_p(full_dir) unless Dir.exists?(full_dir) end - # Create basic files + # Create all project files create_shard_yml(path, name) create_amber_yml(path, name) + create_gitignore(path) create_main_file(path, name) create_config_files(path, name) create_routes_file(path, name) + create_environment_files(path, name) create_home_controller(path, name) + create_application_controller(path) create_views(path, name) + create_spec_helper(path, name) + create_home_controller_spec(path) + create_seeds_file(path) + create_keep_files(path) + create_public_files(path) info "Created project structure" end private def create_shard_yml(path : String, name : String) shard_content = <<-SHARD - name: #{name} - version: 0.1.0 +name: #{name} +version: 0.1.0 - authors: - - Your Name +authors: + - Your Name - crystal: ">= 1.10.0" +crystal: ">= 1.10.0" - license: UNLICENSED +license: UNLICENSED - targets: - #{name}: - main: src/#{name}.cr +targets: + #{name}: + main: src/#{name}.cr - dependencies: - # Amber Framework V2 - amber: - github: crimson-knight/amber - branch: master +dependencies: + # Amber Framework V2 + amber: + github: crimson-knight/amber + branch: master - # Grant ORM (ActiveRecord-style, replaces Granite in V2) - grant: - github: crimson-knight/grant - branch: main + # Grant ORM (ActiveRecord-style, replaces Granite in V2) + grant: + github: crimson-knight/grant + branch: main - # Asset Pipeline (native ESM, no Webpack/npm required) - asset_pipeline: - github: amberframework/asset_pipeline + # Asset Pipeline (native ESM, no Webpack/npm required) + asset_pipeline: + github: amberframework/asset_pipeline - # File uploads (optional) - gemma: - github: crimson-knight/gemma + # File uploads (optional) + gemma: + github: crimson-knight/gemma - # Database adapters (all required by Grant at compile time) - pg: - github: will/crystal-pg - mysql: - github: crystal-lang/crystal-mysql - sqlite3: - github: crystal-lang/crystal-sqlite3 + # Database adapters (all required by Grant at compile time) + pg: + github: will/crystal-pg + mysql: + github: crystal-lang/crystal-mysql + sqlite3: + github: crystal-lang/crystal-sqlite3 - development_dependencies: - ameba: - github: crystal-ameba/ameba - version: ~> 1.4.3 - SHARD +development_dependencies: + ameba: + github: crystal-ameba/ameba + version: ~> 1.4.3 +SHARD File.write(File.join(path, "shard.yml"), shard_content) end private def create_amber_yml(path : String, name : String) amber_content = <<-AMBER - app: #{name} - author: Your Name - email: your.email@example.com - database: #{database} - language: crystal - model: grant - recipe_source: amberframework/recipes - template: #{template} - AMBER +app: #{name} +author: Your Name +email: your.email@example.com +database: #{database} +language: crystal +model: grant +template: #{template} +AMBER File.write(File.join(path, ".amber.yml"), amber_content) end + private def create_gitignore(path : String) + gitignore_content = <<-GITIGNORE +# Crystal +/docs/ +/lib/ +/bin/ +/.shards/ +*.dwarf + +# OS files +.DS_Store +Thumbs.db + +# Editor files +*.swp +*.swo +*~ +.idea/ +.vscode/ + +# Environment files (encrypted versions are safe to commit) +/config/environments/*.yml +!/config/environments/*.yml.enc + +# Dependencies +/node_modules/ + +# Build artifacts +/tmp/ +GITIGNORE + + File.write(File.join(path, ".gitignore"), gitignore_content) + end + private def create_main_file(path : String, name : String) main_content = <<-MAIN - require "../config/*" - require "./controllers/*" +require "../config/*" +require "./controllers/**" +require "./models/**" +require "./schemas/**" +require "./jobs/**" +require "./mailers/**" +require "./channels/**" - Amber::Server.configure do |settings| - settings.name = "#{name}" - settings.secret_key_base = ENV["SECRET_KEY_BASE"]? || "#{Random::Secure.hex(64)}" - end - - Amber::Server.start - MAIN +Amber::Server.start +MAIN File.write(File.join(path, "src/#{name}.cr"), main_content) end private def create_config_files(path : String, name : String) - # Create basic config/application.cr app_config = <<-CONFIG - require "amber" +require "amber" - Amber::Server.configure do |settings| - settings.name = "#{name}" - settings.port = ENV["PORT"]?.try(&.to_i) || 3000 - end - CONFIG +Amber::Server.configure do |settings| + settings.name = "#{name}" + settings.port = ENV["PORT"]?.try(&.to_i) || 3000 + settings.secret_key_base = ENV["SECRET_KEY_BASE"]? || "#{Random::Secure.hex(64)}" +end +CONFIG File.write(File.join(path, "config/application.cr"), app_config) + end - # Create basic controller + private def create_application_controller(path : String) controller_content = <<-CONTROLLER - class ApplicationController < Amber::Controller::Base - end - CONTROLLER +class ApplicationController < Amber::Controller::Base + LAYOUT = "application.#{template}" + + # Add shared before_action filters, helpers, etc. + # All controllers inherit from this class. +end +CONTROLLER File.write(File.join(path, "src/controllers/application_controller.cr"), controller_content) end private def create_routes_file(path : String, name : String) routes_content = <<-ROUTES - Amber::Server.configure do - routes :web do - get "/", HomeController, :index - end - end - ROUTES +Amber::Server.configure do + pipeline :web do + plug Amber::Pipe::Error.new + plug Amber::Pipe::Logger.new + plug Amber::Pipe::Session.new + plug Amber::Pipe::Flash.new + plug Amber::Pipe::CSRF.new + end + + pipeline :api do + plug Amber::Pipe::Error.new + plug Amber::Pipe::Logger.new + end + + routes :web do + get "/", HomeController, :index + end + + # routes :api do + # end +end +ROUTES File.write(File.join(path, "config/routes.cr"), routes_content) end + private def create_environment_files(path : String, name : String) + dev_config = <<-YML +database_url: postgres://localhost:5432/#{name}_development +YML + + test_config = <<-YML +database_url: postgres://localhost:5432/#{name}_test +YML + + prod_config = <<-YML +database_url: <%= ENV["DATABASE_URL"] %> +YML + + # Adjust database URLs based on selected database + case database + when "mysql" + dev_config = <<-YML +database_url: mysql://localhost:3306/#{name}_development +YML + test_config = <<-YML +database_url: mysql://localhost:3306/#{name}_test +YML + when "sqlite" + dev_config = <<-YML +database_url: sqlite3:./db/#{name}_development.db +YML + test_config = <<-YML +database_url: sqlite3:./db/#{name}_test.db +YML + prod_config = <<-YML +database_url: sqlite3:./db/#{name}_production.db +YML + end + + File.write(File.join(path, "config/environments/development.yml"), dev_config) + File.write(File.join(path, "config/environments/test.yml"), test_config) + File.write(File.join(path, "config/environments/production.yml"), prod_config) + end + private def create_home_controller(path : String, name : String) home_controller = <<-CONTROLLER - class HomeController < ApplicationController - def index - render("index.#{template}") - end - end - CONTROLLER +class HomeController < ApplicationController + def index + render("index.#{template}") + end +end +CONTROLLER File.write(File.join(path, "src/controllers/home_controller.cr"), home_controller) end private def create_views(path : String, name : String) - # Create layout file if template == "slang" layout_content = <<-LAYOUT - doctype html - html - head - meta charset="utf-8" - meta name="viewport" content="width=device-width, initial-scale=1" - title #{name} - body - == content - LAYOUT +doctype html +html + head + meta charset="utf-8" + meta name="viewport" content="width=device-width, initial-scale=1" + title #{name} + link rel="stylesheet" href="/css/app.css" + body + == content + script src="/js/app.js" +LAYOUT File.write(File.join(path, "src/views/layouts/application.slang"), layout_content) - # Create home/index view index_content = <<-VIEW - h1 Welcome to #{name}! - p Your Amber V2 application is running successfully. - VIEW +.welcome + h1 = "Welcome to \#{Amber.settings.name}!" + p Your Amber V2 application is running successfully. + + h2 Getting Started + ul + li + | Edit this page: + code src/views/home/index.slang + li + | Add routes: + code config/routes.cr + li + | Generate a resource: + code amber generate scaffold Post title:string body:text +VIEW File.write(File.join(path, "src/views/home/index.slang"), index_content) else layout_content = <<-LAYOUT - - - - - - #{name} - - - <%= content %> - - - LAYOUT + + + + + + #{name} + + + + <%= content %> + + + +LAYOUT File.write(File.join(path, "src/views/layouts/application.ecr"), layout_content) - # Create home/index view index_content = <<-VIEW -

Welcome to #{name}!

-

Your Amber V2 application is running successfully.

- VIEW +
+

Welcome to <%= Amber.settings.name %>!

+

Your Amber V2 application is running successfully.

+ +

Getting Started

+
    +
  • Edit this page: src/views/home/index.ecr
    • +
  • Add routes: config/routes.cr
    • +
  • Generate a resource: amber generate scaffold Post title:string body:text
    • +
+
+VIEW File.write(File.join(path, "src/views/home/index.ecr"), index_content) end end + + private def create_spec_helper(path : String, name : String) + spec_helper = <<-SPEC +require "spec" +require "../config/application" +require "../config/routes" +require "../src/**" + +# Amber Testing Framework +require "amber/testing/testing" + +# Include test helpers globally +include Amber::Testing::RequestHelpers +include Amber::Testing::Assertions +SPEC + + File.write(File.join(path, "spec/spec_helper.cr"), spec_helper) + end + + private def create_home_controller_spec(path : String) + spec_content = <<-SPEC +require "../spec_helper" + +describe HomeController do + include Amber::Testing::RequestHelpers + include Amber::Testing::Assertions + + describe "GET /" do + it "responds successfully" do + response = get("/") + assert_response_success(response) + end + end +end +SPEC + + File.write(File.join(path, "spec/controllers/home_controller_spec.cr"), spec_content) + end + + private def create_seeds_file(path : String) + seeds_content = <<-SEEDS +# Database seed file +# +# Use this file to populate your database with initial data. +# +# Example: +# User.create(name: "Admin", email: "admin@example.com") +# +# Run seeds with: +# amber database seed + +puts "Seeding database..." + +# Add your seed data here + +puts "Done!" +SEEDS + + File.write(File.join(path, "db/seeds.cr"), seeds_content) + end + + private def create_keep_files(path : String) + keep_dirs = [ + "config/initializers", + "spec/models", "spec/schemas", "spec/jobs", + "spec/mailers", "spec/channels", "spec/requests", + "src/models", "src/schemas", "src/jobs", + "src/mailers", "src/channels", "src/sockets", + ] + + keep_dirs.each do |dir| + keep_file = File.join(path, dir, ".keep") + File.write(keep_file, "") unless File.exists?(keep_file) + end + end + + private def create_public_files(path : String) + # CSS + css_content = <<-CSS +/* Application styles */ + +body { + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, + "Helvetica Neue", Arial, sans-serif; + line-height: 1.6; + color: #333; + max-width: 960px; + margin: 0 auto; + padding: 20px; +} + +.welcome { + text-align: center; + padding: 60px 20px; +} + +.welcome h1 { + font-size: 2.5em; + margin-bottom: 0.5em; +} + +.welcome code { + background: #f4f4f4; + padding: 2px 6px; + border-radius: 3px; + font-size: 0.9em; +} + +.form-group { + margin-bottom: 1em; +} + +.form-group label { + display: block; + margin-bottom: 0.25em; + font-weight: bold; +} + +.form-group input, +.form-group textarea, +.form-group select { + width: 100%; + padding: 0.5em; + border: 1px solid #ccc; + border-radius: 3px; + box-sizing: border-box; +} + +table { + width: 100%; + border-collapse: collapse; + margin: 1em 0; +} + +th, td { + padding: 0.75em; + text-align: left; + border-bottom: 1px solid #ddd; +} + +th { + background: #f4f4f4; + font-weight: bold; +} + +.flash { + padding: 1em; + margin-bottom: 1em; + border-radius: 4px; +} + +.flash-success { + background: #d4edda; + color: #155724; + border: 1px solid #c3e6cb; +} + +.flash-danger { + background: #f8d7da; + color: #721c24; + border: 1px solid #f5c6cb; +} + +.flash-info { + background: #d1ecf1; + color: #0c5460; + border: 1px solid #bee5eb; +} +CSS + + File.write(File.join(path, "public/css/app.css"), css_content) + + # JavaScript + js_content = <<-JS +// Application JavaScript +console.log("Amber V2 application loaded"); +JS + + File.write(File.join(path, "public/js/app.js"), js_content) + + # robots.txt + robots_content = <<-ROBOTS +User-agent: * +Disallow: +ROBOTS + + File.write(File.join(path, "public/robots.txt"), robots_content) + + # Placeholder favicon + File.write(File.join(path, "public/favicon.ico"), "") + + # .keep for img + File.write(File.join(path, "public/img/.keep"), "") + end end end diff --git a/src/amber_cli/commands/setup_lsp.cr b/src/amber_cli/commands/setup_lsp.cr new file mode 100644 index 0000000..6312bb1 --- /dev/null +++ b/src/amber_cli/commands/setup_lsp.cr @@ -0,0 +1,251 @@ +require "../core/base_command" + +# The `setup:lsp` command configures the Amber LSP server for Claude Code +# integration in an Amber project directory. +# +# ## Usage +# ``` +# amber setup: lsp [OPTIONS] +# ``` +# +# ## What It Does +# 1. Resolves or builds the `amber-lsp` binary +# 2. Creates `.lsp.json` for Claude Code LSP server discovery +# 3. Creates `.claude-plugin/plugin.json` as the plugin manifest +# 4. Creates `.amber-lsp.yml` with default rule configuration +# +# ## Examples +# ``` +# amber setup:lsp +# amber setup:lsp --binary-path=/usr/local/bin/amber-lsp +# amber setup:lsp --skip-build +# ``` +module AmberCLI::Commands + class SetupLSPCommand < AmberCLI::Core::BaseCommand + getter binary_path_option : String? = nil + getter is_skip_build : Bool = false + + def help_description : String + <<-HELP + Set up the Amber LSP server for Claude Code integration + + Usage: amber setup:lsp [OPTIONS] + + This command: + 1. Builds the amber-lsp binary (if needed) + 2. Creates .lsp.json for Claude Code LSP discovery + 3. Creates .claude-plugin/plugin.json + 4. Creates .amber-lsp.yml with default configuration + + Options: + --binary-path=PATH Path to pre-built amber-lsp binary + --skip-build Skip building the binary (assume it's on PATH) + HELP + end + + def setup_command_options + option_parser.separator "" + option_parser.separator "Options:" + + option_parser.on("--binary-path=PATH", "Path to pre-built amber-lsp binary") do |path| + @binary_path_option = path + end + + option_parser.on("--skip-build", "Skip building the binary (assume it's on PATH)") do + @is_skip_build = true + end + end + + def execute + info "Setting up Amber LSP for Claude Code..." + + binary_path = resolve_binary_path + + create_lsp_json(binary_path) + create_plugin_json + create_default_config + + success "Amber LSP setup complete!" + puts "" + info "Files created:" + info " .lsp.json - LSP server configuration" + info " .claude-plugin/plugin.json - Claude Code plugin manifest" + info " .amber-lsp.yml - Rule configuration (customize as needed)" + puts "" + info "The LSP will activate automatically when you start Claude Code in this directory." + end + + private def resolve_binary_path : String + # 1. Check --binary-path option first + if path = binary_path_option + unless File.exists?(path) + error "Specified binary not found: #{path}" + exit(1) + end + return File.expand_path(path) + end + + # 2. Check if amber-lsp is on PATH + if found = Process.find_executable("amber-lsp") + info "Found amber-lsp on PATH: #{found}" + return found + end + + # 3. Check if we're in the amber_cli project and binary exists + cli_project_root = find_cli_project_root + if cli_project_root + existing_binary = File.join(cli_project_root, "bin", "amber-lsp") + if File.exists?(existing_binary) + info "Found amber-lsp binary: #{existing_binary}" + return existing_binary + end + end + + # 4. If --skip-build is set, use bare command name + if is_skip_build + warning "Skipping build. Assuming 'amber-lsp' is available on PATH at runtime." + return "amber-lsp" + end + + # 5. Try to build it if source is available + if cli_project_root && File.exists?(File.join(cli_project_root, "src", "amber_lsp.cr")) + build_binary(cli_project_root) + else + error "Could not find or build amber-lsp binary." + error "Options:" + error " 1. Run this command from the amber_cli project directory" + error " 2. Use --binary-path=PATH to specify an existing binary" + error " 3. Use --skip-build to assume amber-lsp is on PATH" + exit(1) + end + end + + private def find_cli_project_root : String? + # Check if the current directory is the amber_cli project + if File.exists?("src/amber_lsp.cr") + return Dir.current + end + + # Check the known development location + dev_path = File.expand_path("~/open_source_coding_projects/amber_cli") + if File.exists?(File.join(dev_path, "src", "amber_lsp.cr")) + return dev_path + end + + nil + end + + private def build_binary(cli_project_root : String) : String + binary_path = File.join(cli_project_root, "bin", "amber-lsp") + source_path = File.join(cli_project_root, "src", "amber_lsp.cr") + + info "Building amber-lsp from source..." + info " Source: #{source_path}" + info " Output: #{binary_path}" + + Dir.mkdir_p(File.join(cli_project_root, "bin")) unless Dir.exists?(File.join(cli_project_root, "bin")) + + process = Process.run( + "crystal", + ["build", source_path, "-o", binary_path, "--release"], + output: Process::Redirect::Inherit, + error: Process::Redirect::Inherit + ) + + unless process.success? + error "Failed to build amber-lsp binary" + exit(1) + end + + success "Built amber-lsp successfully" + binary_path + end + + private def create_lsp_json(binary_path : String) + lsp_config = { + "amber" => { + "command" => binary_path, + "args" => [] of String, + "extensionToLanguage" => { + ".cr" => "crystal", + }, + "transport" => "stdio", + "restartOnCrash" => true, + "maxRestarts" => 3, + }, + } + + path = ".lsp.json" + if File.exists?(path) + warning "Overwriting existing #{path}" + end + File.write(path, lsp_config.to_pretty_json + "\n") + info "Created: #{path}" + end + + private def create_plugin_json + dir = ".claude-plugin" + Dir.mkdir_p(dir) unless Dir.exists?(dir) + + plugin_config = { + "name" => "amber-framework-lsp", + "version" => "1.0.0", + "description" => "Convention diagnostics for Amber V2 web framework projects.", + "author" => { + "name" => "Amber Framework", + }, + "homepage" => "https://github.com/amberframework/amber", + "lspServers" => "./.lsp.json", + } + + path = File.join(dir, "plugin.json") + if File.exists?(path) + warning "Overwriting existing #{path}" + end + File.write(path, plugin_config.to_pretty_json + "\n") + info "Created: #{path}" + end + + private def create_default_config + path = ".amber-lsp.yml" + if File.exists?(path) + warning "Skipped (exists): #{path} — remove it first to regenerate" + return + end + + content = <<-YAML + # Amber LSP Configuration + # See: https://docs.amberframework.org/amber/guides/lsp + + # Override built-in rule settings + # rules: + # amber/controller-naming: + # enabled: true + # severity: error + # amber/spec-existence: + # severity: hint + + # Exclude directories from analysis + exclude: + - lib/ + - tmp/ + - db/migrations/ + + # Custom project-specific rules + # custom_rules: + # - id: "project/no-puts" + # description: "Do not use puts in production code" + # severity: warning + # applies_to: ["src/**"] + # pattern: '^\\s*puts\\b' + # message: "Avoid 'puts' in production code. Use Log.info instead." + YAML + + File.write(path, content) + info "Created: #{path}" + end + end +end + +# Register the command +AmberCLI::Core::CommandRegistry.register("setup:lsp", ["lsp"], AmberCLI::Commands::SetupLSPCommand) diff --git a/src/amber_cli/config.cr b/src/amber_cli/config.cr index bc398f1..674622c 100644 --- a/src/amber_cli/config.cr +++ b/src/amber_cli/config.cr @@ -28,9 +28,7 @@ module Amber::CLI property database : String = "pg" property language : String = "slang" - property model : String = "granite" - property recipe : (String | Nil) = nil - property recipe_source : (String | Nil) = nil + property model : String = "grant" property watch : WatchOptions? def initialize diff --git a/src/amber_cli/documentation.cr b/src/amber_cli/documentation.cr index 43d81e6..25eb624 100644 --- a/src/amber_cli/documentation.cr +++ b/src/amber_cli/documentation.cr @@ -15,15 +15,16 @@ module AmberCLI::Documentation # # Amber CLI Documentation # # Amber CLI is a powerful command-line tool for managing Crystal web applications - # built with the Amber framework. This tool provides generators, database management, + # built with the Amber V2 framework. This tool provides generators, database management, # development utilities, and more. # # ## Quick Start # - # Create a new Amber application: + # Create a new Amber V2 application: # ```bash # amber new my_app # cd my_app + # shards install # amber database create # amber database migrate # amber watch @@ -31,9 +32,9 @@ module AmberCLI::Documentation # # ## Available Commands # - # - **new** - Create a new Amber application - # - **database** - Database operations and migrations + # - **new** - Create a new Amber V2 application # - **generate** - Generate application components + # - **database** - Database operations and migrations # - **routes** - Display application routes # - **watch** - Development server with file watching # - **encrypt** - Encrypt/decrypt environment files @@ -45,7 +46,7 @@ module AmberCLI::Documentation # ## Creating New Applications # - # The `new` command creates a new Amber application with a complete directory + # The `new` command creates a new Amber V2 application with a complete directory # structure and configuration files. # # ### Usage @@ -56,8 +57,7 @@ module AmberCLI::Documentation # ### Options # # - `-d, --database=DATABASE` - Database engine (pg, mysql, sqlite) - # - `-t, --template=TEMPLATE` - Template engine (slang, ecr) - # - `-r, --recipe=RECIPE` - Use a named recipe + # - `-t, --template=TEMPLATE` - Template engine (ecr, slang) # - `-y, --assume-yes` - Skip interactive prompts # - `--no-deps` - Don't install dependencies # @@ -70,7 +70,7 @@ module AmberCLI::Documentation # # Create with specific database and template: # ```bash - # amber new my_api -d mysql -t ecr + # amber new my_api -d mysql -t slang # ``` # # Create in current directory: @@ -81,16 +81,107 @@ module AmberCLI::Documentation # ### Generated Structure # # The new command creates: - # - **src/** - Application source code - # - **config/** - Configuration files + # - **src/** - Application source code (controllers, models, schemas, jobs, mailers, channels) + # - **config/** - Configuration files (application.cr, routes.cr, environments/) # - **db/** - Database migrations and seeds - # - **spec/** - Test files - # - **public/** - Static assets + # - **spec/** - Test files for all component types + # - **public/** - Static assets (css, js, img) # - **shard.yml** - Dependency configuration - # - **README.md** - Project documentation + # - **.amber.yml** - Project configuration + # - **.gitignore** - Git ignore rules class NewCommand end + # ## Code Generation System + # + # The `generate` command creates application components following V2 patterns. + # + # ### Available Generators + # + # #### Model Generator + # Creates a model with associated migration and spec: + # ```bash + # amber generate model User name:string email:string + # ``` + # + # #### Controller Generator + # Creates a controller with views and spec using `Amber::Testing`: + # ```bash + # amber generate controller Posts index show + # ``` + # + # #### Scaffold Generator + # Creates a complete CRUD resource with schema-based validation: + # ```bash + # amber generate scaffold Post title:string body:text published:bool + # ``` + # + # #### Migration Generator + # Creates a database migration file: + # ```bash + # amber generate migration AddStatusToUsers + # ``` + # + # #### Job Generator + # Creates a background job class extending `Amber::Jobs::Job`: + # ```bash + # amber generate job SendNotification --queue=mailers --max-retries=5 + # ``` + # + # #### Mailer Generator + # Creates a mailer class extending `Amber::Mailer::Base`: + # ```bash + # amber generate mailer User --actions=welcome,notify + # ``` + # + # #### Schema Generator + # Creates a schema definition extending `Amber::Schema::Definition`: + # ```bash + # amber generate schema User name:string email:string:required age:int32 + # ``` + # + # #### Channel Generator + # Creates a WebSocket channel extending `Amber::WebSockets::Channel`: + # ```bash + # amber generate channel Chat + # ``` + # + # #### API Generator + # Creates an API-only controller with model and schema: + # ```bash + # amber generate api Product name:string price:float + # ``` + # + # #### Auth Generator + # Creates an authentication system with login and registration: + # ```bash + # amber generate auth + # ``` + # + # ### Field Types + # + # Available field types for model, scaffold, schema, and api generators: + # - `string` - VARCHAR(255) / String + # - `text` - TEXT / String + # - `integer`, `int`, `int32` - INTEGER / Int32 + # - `int64` - BIGINT / Int64 + # - `float`, `float64` - DOUBLE PRECISION / Float64 + # - `decimal` - DECIMAL(10,2) / Float64 + # - `bool`, `boolean` - BOOLEAN / Bool + # - `time`, `timestamp` - TIMESTAMP / Time + # - `email` - VARCHAR(255) / String (with email format validation) + # - `uuid` - VARCHAR(255) / String (with UUID format validation) + # - `reference` - BIGINT / Int64 + # + # ### Schema Field Format + # + # Schema fields support a `:required` suffix: + # ```bash + # amber generate schema User name:string:required email:email:required age:int32 + # ``` + class GenerationSystem + end + # ## Database Management # # The `database` command provides comprehensive database management capabilities @@ -151,15 +242,6 @@ module AmberCLI::Documentation # amber database seed # ``` # - # ### Configuration - # - # Database configuration is handled through environment-specific YAML files - # in the `config/environments/` directory: - # - # ```yaml - # database_url: postgres://user:pass@localhost:5432/myapp_development - # ``` - # # ### Supported Databases # # - **PostgreSQL** (`pg`) - Recommended for production @@ -168,79 +250,6 @@ module AmberCLI::Documentation class DatabaseCommand end - # ## Code Generation System - # - # Amber CLI provides a flexible and configurable code generation system - # that can create models, controllers, views, and custom components. - # - # ### Built-in Generators - # - # The CLI includes several built-in generators: - # - # #### Model Generator - # Creates a new model with associated files: - # ```bash - # amber generate model User name:String email:String - # ``` - # - # Generates: - # - `src/models/user.cr` - Model class - # - `spec/models/user_spec.cr` - Model spec - # - `db/migrations/[timestamp]_create_users.sql` - Migration file - # - # #### Controller Generator - # Creates a new controller: - # ```bash - # amber generate controller Posts - # ``` - # - # Generates: - # - `src/controllers/posts_controller.cr` - Controller class - # - `spec/controllers/posts_controller_spec.cr` - Controller spec - # - # #### Scaffold Generator - # Creates a complete CRUD resource: - # ```bash - # amber generate scaffold Post title:String content:Text - # ``` - # - # Generates model, controller, views, and migration files. - # - # ### Custom Generators - # - # You can create custom generators by defining generator configuration files - # in JSON or YAML format. These files specify templates, transformations, - # and post-generation commands. - # - # #### Generator Configuration Format - # - # ```yaml - # name: "my_custom_generator" - # description: "Generates custom components" - # template_variables: - # author: "Your Name" - # license: "MIT" - # naming_conventions: - # snake_case: "underscore_separated" - # pascal_case: "CamelCase" - # file_generation_rules: - # service: - # - template: "service_template" - # output_path: "src/services/{{snake_case}}_service.cr" - # post_generation_commands: - # - "crystal tool format {{output_path}}" - # ``` - # - # ### Word Transformations - # - # The generator system includes intelligent word transformations: - # - **snake_case** - `user_account` - # - **pascal_case** - `UserAccount` - # - **plural forms** - `users`, `UserAccounts` - # - **singular forms** - `user`, `UserAccount` - class GenerationSystem - end - # ## Development Tools # # Amber CLI provides several tools to streamline development workflow. @@ -263,54 +272,15 @@ module AmberCLI::Documentation # - `-w, --watch=FILES` - Files to watch (comma-separated) # - `-i, --info` - Show current configuration # - # #### Examples - # - # Basic watch mode: - # ```bash - # amber watch - # ``` - # - # Custom build and run commands: - # ```bash - # amber watch --build "crystal build src/my_app.cr --release" --run "./my_app" - # ``` - # - # Show current configuration: - # ```bash - # amber watch --info - # ``` - # # ### Code Execution # # The `exec` command allows you to execute Crystal code within your - # application's context, similar to Rails console. + # application's context. # # #### Usage # ```bash # amber exec [CODE_OR_FILE] [options] # ``` - # - # #### Options - # - # - `-e, --editor=EDITOR` - Preferred editor (vim, nano, etc.) - # - `-b, --back=TIMES` - Run previous command files - # - # #### Examples - # - # Execute inline code: - # ```bash - # amber exec 'puts "Hello from Amber!"' - # ``` - # - # Execute a Crystal file: - # ```bash - # amber exec my_script.cr - # ``` - # - # Open editor for interactive session: - # ```bash - # amber exec --editor nano - # ``` class DevelopmentTools end @@ -327,32 +297,6 @@ module AmberCLI::Documentation # amber routes [options] # ``` # - # #### Options - # - # - `--json` - Output routes as JSON - # - # #### Examples - # - # Display routes in table format: - # ```bash - # amber routes - # ``` - # - # Output as JSON: - # ```bash - # amber routes --json - # ``` - # - # #### Sample Output - # - # ``` - # Verb Controller Action Pipeline Scope URI Pattern - # GET HomeController index web / / - # GET PostsController index web / /posts - # POST PostsController create web / /posts - # GET PostsController show web / /posts/:id - # ``` - # # ### Pipeline Analysis # # The `pipelines` command displays pipeline configuration and associated plugs. @@ -361,22 +305,6 @@ module AmberCLI::Documentation # ```bash # amber pipelines [options] # ``` - # - # #### Options - # - # - `--no-plugs` - Hide plug information - # - # #### Examples - # - # Show all pipelines with plugs: - # ```bash - # amber pipelines - # ``` - # - # Show only pipeline names: - # ```bash - # amber pipelines --no-plugs - # ``` class ApplicationAnalysis end @@ -391,47 +319,18 @@ module AmberCLI::Documentation # amber encrypt [ENVIRONMENT] [options] # ``` # - # #### Options - # - # - `-e, --editor=EDITOR` - Preferred editor - # - `--noedit` - Skip editing, just encrypt - # - # #### Examples - # - # Encrypt production environment: - # ```bash - # amber encrypt production - # ``` - # - # Encrypt staging with custom editor: - # ```bash - # amber encrypt staging --editor nano - # ``` - # - # Just encrypt without editing: - # ```bash - # amber encrypt production --noedit - # ``` - # # ### Configuration Files # - # Amber applications use several configuration files: + # Amber V2 applications use several configuration files: # # #### `.amber.yml` # Project-specific configuration: # ```yaml + # app: myapp # database: pg - # language: slang - # model: granite - # watch: - # run: - # build_commands: - # - "crystal build ./src/my_app.cr -o bin/my_app" - # run_commands: - # - "bin/my_app" - # include: - # - "./config/**/*.cr" - # - "./src/**/*.cr" + # language: crystal + # model: grant + # template: ecr # ``` # # #### Environment Files @@ -449,32 +348,6 @@ module AmberCLI::Documentation # ```bash # amber plugin [NAME] [args...] [options] # ``` - # - # ### Options - # - # - `-u, --uninstall` - Uninstall plugin - # - # ### Examples - # - # Install a plugin: - # ```bash - # amber plugin my_plugin - # ``` - # - # Install with arguments: - # ```bash - # amber plugin auth_plugin --with-sessions - # ``` - # - # Uninstall a plugin: - # ```bash - # amber plugin my_plugin --uninstall - # ``` - # - # ### Plugin Development - # - # Plugins are Crystal shards that extend Amber functionality. - # They can provide generators, middleware, or additional commands. class PluginSystem end @@ -497,6 +370,16 @@ module AmberCLI::Documentation # # #### Code Generation # - `generate` - Generate application components + # - `model` - Models with migrations + # - `controller` - Controllers with views + # - `scaffold` - Full CRUD resources + # - `migration` - Database migrations + # - `job` - Background jobs (Amber::Jobs::Job) + # - `mailer` - Email mailers (Amber::Mailer::Base) + # - `schema` - Request schemas (Amber::Schema::Definition) + # - `channel` - WebSocket channels (Amber::WebSockets::Channel) + # - `api` - API-only controllers + # - `auth` - Authentication system # # #### Database Operations # - `database` - All database-related commands @@ -511,18 +394,6 @@ module AmberCLI::Documentation # # #### Security # - `encrypt` - Environment encryption - # - # ### Getting Help - # - # For detailed help on any command: - # ```bash - # amber [command] --help - # ``` - # - # For general help: - # ```bash - # amber --help - # ``` class CommandReference end @@ -532,43 +403,8 @@ module AmberCLI::Documentation # # ### Generator Configuration # - # Generator configurations define how code generation works: - # - # #### Configuration Schema - # - # ```yaml - # name: string # Required: Generator name - # description: string # Optional: Description - # template_variables: # Optional: Default template variables - # key: value - # naming_conventions: # Optional: Word transformation rules - # snake_case: "underscore_format" - # pascal_case: "CamelCaseFormat" - # file_generation_rules: # Required: File generation rules - # generator_type: - # - template: "template_name" - # output_path: "path/{{variable}}.cr" - # transformations: # Optional: Variable transformations - # custom_var: "{{name}}_custom" - # conditions: # Optional: Generation conditions - # if_exists: "file.cr" - # post_generation_commands: # Optional: Commands to run after generation - # - "crystal tool format {{output_path}}" - # dependencies: # Optional: Required dependencies - # - "some_shard" - # ``` - # - # ### Template Variables - # - # Available template variables for file generation: - # - `{{name}}` - Original name provided - # - `{{snake_case}}` - Snake case transformation - # - `{{pascal_case}}` - Pascal case transformation - # - `{{snake_case_plural}}` - Plural snake case - # - `{{pascal_case_plural}}` - Plural pascal case - # - `{{output_path}}` - Generated file path - # - # Custom variables can be defined in generator configuration. + # Generator configurations define how code generation works. The CLI uses + # inline heredoc templates by default for zero-configuration experience. # # ### Watch Configuration # @@ -576,122 +412,16 @@ module AmberCLI::Documentation # # ```yaml # watch: - # run: # Development environment - # build_commands: # Commands to build the application - # - "mkdir -p bin" - # - "crystal build ./src/app.cr -o bin/app" - # run_commands: # Commands to run the application - # - "bin/app" - # include: # Files to watch for changes - # - "./config/**/*.cr" - # - "./src/**/*.cr" - # - "./src/views/**/*.slang" - # test: # Test environment (optional) - # build_commands: - # - "crystal spec" - # run_commands: - # - "echo 'Tests completed'" - # include: - # - "./spec/**/*.cr" - # ``` - # - # # Configuration Reference - # - # Amber CLI uses several configuration mechanisms to customize behavior - # for different project types and development workflows. - # - # ## Project Configuration (`.amber.yml`) - # - # The `.amber.yml` file in your project root configures project-specific settings: - # - # ```yaml - # database: pg # Database type: pg, mysql, sqlite - # language: slang # Template language: slang, ecr - # model: granite # ORM: granite, jennifer - # watch: # run: # build_commands: - # - "crystal build ./src/my_app.cr -o bin/my_app" + # - "mkdir -p bin" + # - "crystal build ./src/app.cr -o bin/app" # run_commands: - # - "bin/my_app" + # - "bin/app" # include: # - "./config/**/*.cr" # - "./src/**/*.cr" - # ``` - # - # ## Generator Configuration - # - # Custom generators can be configured using JSON or YAML files in the - # `generator_configs/` directory: - # - # ### Basic Generator Configuration - # - # ```yaml - # name: "custom_model" - # description: "Generate a custom model with validation" - # template_directory: "templates/models" - # amber_framework_version: "1.4.0" # Amber framework version for new projects - # custom_variables: - # author: "Your Name" - # license: "MIT" - # naming_conventions: - # table_prefix: "app_" - # file_generation_rules: - # - template_file: "model.cr.ecr" - # output_path: "src/models/{{snake_case}}.cr" - # transformations: - # class_name: "pascal_case" - # ``` - # - # ### Framework Version Configuration - # - # The `amber_framework_version` setting determines which version of the Amber - # framework gets used when creating new applications. This is separate from the - # CLI tool version and allows you to: - # - # - Pin projects to specific Amber versions - # - Test with different framework versions - # - Maintain compatibility with existing projects - # - # Available template variables: - # - `{{cli_version}}` - Current Amber CLI version - # - `{{amber_framework_version}}` - Configured Amber framework version - # - All word transformations (snake_case, pascal_case, etc.) - # - # ### Advanced Generator Features - # - # #### Conditional File Generation - # - # ```yaml - # file_generation_rules: - # - template_file: "api_spec.cr.ecr" - # output_path: "spec/{{snake_case}}_spec.cr" - # conditions: - # generate_specs: "true" - # ``` - # - # #### Custom Transformations - # - # ```yaml - # naming_conventions: - # namespace_prefix: "MyApp::" - # table_prefix: "my_app_" - # transformations: - # full_class_name: "pascal_case" # Will use namespace_prefix - # ``` - # - # ## Environment Configuration - # - # Environment-specific settings go in `config/environments/`: - # - # ```yaml - # # config/environments/development.yml - # database_url: "postgres://localhost/myapp_development" - # amber_framework_version: "1.4.0" - # - # # config/environments/production.yml - # database_url: ENV["DATABASE_URL"] - # amber_framework_version: "1.4.0" + # - "./src/views/**/*.ecr" # ``` class ConfigurationReference end @@ -713,33 +443,9 @@ module AmberCLI::Documentation # **Problem**: Template not found errors # **Solution**: # 1. Verify template files exist in expected locations - # 2. Check generator configuration syntax + # 2. Check `.amber.yml` for correct template setting (ecr or slang) # 3. Ensure template variables are properly defined # - # ### Watch Mode Issues - # - # **Problem**: Files not being watched - # **Solution**: - # 1. Check file patterns in `.amber.yml` - # 2. Verify files exist in specified directories - # 3. Use `amber watch --info` to see current configuration - # - # ### Build Failures - # - # **Problem**: Crystal compilation errors - # **Solution**: - # 1. Run `shards install` to ensure dependencies are installed - # 2. Check for syntax errors in generated files - # 3. Verify all required files are present - # - # ### Plugin Issues - # - # **Problem**: Plugin not found or loading errors - # **Solution**: - # 1. Verify plugin is properly installed - # 2. Check shard.yml dependencies - # 3. Ensure plugin is compatible with current Amber version - # # ### Getting More Help # # - Check the [Amber Framework documentation](https://docs.amberframework.org) diff --git a/src/amber_cli/generators/native_app.cr b/src/amber_cli/generators/native_app.cr new file mode 100644 index 0000000..e2404de --- /dev/null +++ b/src/amber_cli/generators/native_app.cr @@ -0,0 +1,1810 @@ +# Generates a native cross-platform application scaffold using Amber V2 patterns +# with Asset Pipeline UI, crystal-audio, and build scripts for macOS, iOS, and Android. +# +# This generator encodes the lessons learned from building Scribe: +# - Amber without HTTP server (Amber.settings, NOT Amber::Server.configure) +# - Asset Pipeline cross-platform UI (require "asset_pipeline/ui") +# - FSDD process manager architecture +# - Platform-specific ObjC bridge compilation with -fno-objc-arc +# - Mobile cross-compilation (iOS simulator/device, Android NDK) +# - Three-layer test infrastructure (L1 specs, L2 UI tests, L3 E2E scripts) +# - Critical build flags: -Dmacos, -Dios, -Dandroid (NOT auto-detected) +# - BoehmGC compilation for Android (GC_BUILTIN_ATOMIC flag) +# - _main symbol conflict resolution for iOS (ld -r -unexported_symbol _main) +# - crystal-audio symlink requirement (crystal-audio -> crystal_audio) +# - GCD usage instead of Crystal spawn in NSApp applications +module AmberCLI::Generators + class NativeApp + getter path : String + getter name : String + + def initialize(@path : String, @name : String) + end + + def generate + create_directories + create_shard_yml + create_amber_yml + create_gitignore + create_makefile + create_claude_md + create_main_file + create_config_files + create_application_controller + create_main_controller + create_main_process_manager + create_event_bus + create_main_view + create_platform_bridge + create_spec_helper + create_process_manager_spec + create_mobile_shared_bridge + create_mobile_shared_spec + create_ios_build_script + create_ios_project_yml + create_ios_ui_tests + create_ios_e2e_script + create_android_build_script + create_android_build_gradle + create_android_ui_tests + create_android_e2e_script + create_android_local_properties + create_macos_ui_test_script + create_macos_e2e_script + create_mobile_ci_script + create_fsdd_docs + create_keep_files + end + + private def create_directories + dirs = [ + # Source + "src", "src/controllers", "src/models", "src/process_managers", + "src/ui", "src/platform", "src/events", + # Config + "config", + # Desktop specs + "spec", "spec/macos", + # Mobile shared + "mobile/shared", "mobile/shared/spec", + # iOS + "mobile/ios", "mobile/ios/UITests", + # Android + "mobile/android", "mobile/android/app/src/main/jniLibs/arm64-v8a", + "mobile/android/app/src/androidTest/java/com/#{name}/app", + # macOS test scripts + "test/macos", + # FSDD documentation + "docs/fsdd", "docs/fsdd/feature-stories", "docs/fsdd/conventions", + "docs/fsdd/knowledge-gaps", "docs/fsdd/process-managers", + "docs/fsdd/testing", + # Build output + "bin", + ] + + dirs.each do |dir| + full_dir = File.join(path, dir) + Dir.mkdir_p(full_dir) unless Dir.exists?(full_dir) + end + end + + private def create_shard_yml + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-SHARD +name: #{name} +version: 0.1.0 + +authors: + - Your Name + +crystal: ">= 1.15.0" + +license: UNLICENSED + +targets: + #{name}: + main: src/#{name}.cr + +dependencies: + # Amber Framework V2 (patterns only, NO HTTP server for native apps) + amber: + github: crimson-knight/amber + branch: master + + # Grant ORM (ActiveRecord-style, replaces Granite in V2) + grant: + github: crimson-knight/grant + branch: main + + # Asset Pipeline (cross-platform UI: AppKit, UIKit, Android Views) + # IMPORTANT: Must use the feature branch for cross-platform UI support + asset_pipeline: + github: amberframework/asset_pipeline + branch: feature/utility-first-css-asset-pipeline + + # Audio recording, playback, and transcription + crystal-audio: + github: crimson-knight/crystal-audio + + # Database adapters (all required by Grant at compile time) + pg: + github: will/crystal-pg + mysql: + github: crystal-lang/crystal-mysql + sqlite3: + github: crystal-lang/crystal-sqlite3 + +development_dependencies: + ameba: + github: crystal-ameba/ameba + version: ~> 1.4.3 +SHARD + + File.write(File.join(path, "shard.yml"), content) + end + + private def create_amber_yml + content = <<-AMBER +app: #{name} +author: Your Name +email: your.email@example.com +database: sqlite +language: crystal +model: grant +type: native +AMBER + + File.write(File.join(path, ".amber.yml"), content) + end + + private def create_gitignore + content = <<-GITIGNORE +# Crystal +/docs/api/ +/lib/ +/bin/ +/.shards/ +*.dwarf +*.o + +# OS files +.DS_Store +Thumbs.db + +# Editor files +*.swp +*.swo +*~ +.idea/ +.vscode/ + +# Build artifacts +/tmp/ +/dist/ + +# Mobile build artifacts +/mobile/ios/build/ +/mobile/ios/*.xcodeproj +/mobile/ios/Scribe.xcworkspace +/mobile/android/build/ +/mobile/android/.gradle/ +/mobile/android/app/build/ +/mobile/android/local.properties +GITIGNORE + + File.write(File.join(path, ".gitignore"), content) + end + + private def create_makefile + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-MAKEFILE +PROJECT_DIR := $(shell pwd) +CRYSTAL := crystal-alpha +BIN := bin/#{name} + +# Bridge object files +AP_BRIDGE := $(PROJECT_DIR)/lib/asset_pipeline/src/ui/native/objc_bridge.o +AP_BRIDGE_SRC := $(PROJECT_DIR)/lib/asset_pipeline/src/ui/native/objc_bridge.m +APP_BRIDGE := $(PROJECT_DIR)/src/platform/#{name}_platform_bridge.o +APP_BRIDGE_SRC := $(PROJECT_DIR)/src/platform/#{name}_platform_bridge.m + +# crystal-audio native extensions +CA_EXT_DIR := $(PROJECT_DIR)/lib/crystal-audio/ext +CA_EXT_OBJS := $(wildcard $(CA_EXT_DIR)/*.o) +ifeq ($(CA_EXT_OBJS),) +CA_EXT_OBJS := $(CA_EXT_DIR)/block_bridge.o $(CA_EXT_DIR)/objc_helpers.o $(CA_EXT_DIR)/audio_write_helper.o +endif + +# Framework flags for macOS +# IMPORTANT: These frameworks are required for Asset Pipeline + crystal-audio +MACOS_FRAMEWORKS := -framework AppKit -framework Foundation \\ + -framework AVFoundation -framework AudioToolbox -framework CoreAudio \\ + -framework CoreFoundation -framework CoreMedia \\ + -lobjc + +# Full link flags for macOS +MACOS_LINK_FLAGS := $(AP_BRIDGE) $(APP_BRIDGE) $(CA_EXT_OBJS) $(MACOS_FRAMEWORKS) + +.PHONY: all setup macos macos-release ext ext-app ext-ap ext-audio run clean spec + +all: macos + +# --- First-time setup --- + +setup: + shards-alpha install || shards install || true + @# crystal-audio shard name has a hyphen but source uses underscore + @# Crystal's require resolution needs the underscore directory + @if [ ! -e lib/crystal_audio ]; then \\ + ln -sf crystal-audio lib/crystal_audio; \\ + echo "Created lib/crystal_audio symlink"; \\ + fi + +# --- Build targets --- + +# CRITICAL: -Dmacos flag is REQUIRED. Asset Pipeline gates AppKit renderer on it. +# Do NOT rely on auto-detection — Crystal does not auto-set platform flags. +macos: ext + $(CRYSTAL) build src/#{name}.cr -o $(BIN) -Dmacos \\ + --link-flags="$(MACOS_LINK_FLAGS)" + +macos-release: ext + $(CRYSTAL) build src/#{name}.cr -o $(BIN) -Dmacos --release \\ + --link-flags="$(MACOS_LINK_FLAGS)" + +# --- Native extensions --- + +ext: ext-ap ext-app ext-audio + +# Asset Pipeline ObjC bridge (cross-platform UI rendering) +# IMPORTANT: -fno-objc-arc is REQUIRED — the bridge manages its own memory +ext-ap: $(AP_BRIDGE) +$(AP_BRIDGE): $(AP_BRIDGE_SRC) + clang -c $(AP_BRIDGE_SRC) -o $(AP_BRIDGE) -fno-objc-arc + +# Application platform bridge +ext-app: $(APP_BRIDGE) +$(APP_BRIDGE): $(APP_BRIDGE_SRC) + clang -c $(APP_BRIDGE_SRC) -o $(APP_BRIDGE) -fno-objc-arc + +# crystal-audio extensions (recording, playback) +ext-audio: + @if [ -d "$(CA_EXT_DIR)" ]; then \\ + cd lib/crystal-audio && make ext 2>/dev/null || true; \\ + fi + +# --- Run --- + +run: macos + ./$(BIN) + +# --- Tests --- + +spec: + crystal-alpha spec spec/ -Dmacos + +# --- Clean --- + +clean: + rm -f $(BIN) $(APP_BRIDGE) $(AP_BRIDGE) + rm -f $(CA_EXT_DIR)/*.o + rm -rf mobile/ios/build mobile/android/build +MAKEFILE + + File.write(File.join(path, "Makefile"), content) + end + + private def create_claude_md + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-CLAUDEMD +# #{pascal_name} — Native Cross-Platform Application + +## What This Is + +#{pascal_name} is a native cross-platform application built with Crystal (via crystal-alpha compiler), +Amber V2 patterns, Asset Pipeline cross-platform UI, and crystal-audio. + +## Architecture (READ THIS FIRST) + +**This is NOT a web app.** Despite using Amber V2, #{pascal_name} is a native application: + +- **macOS:** Native AppKit application +- Uses Amber's patterns (MVC, process managers, configuration) but NOT its HTTP server +- All UI rendered via Asset Pipeline cross-platform components +- All business logic lives in Process Managers (FSDD pattern) +- Event-driven architecture, not request/response + +## Compiler + +Use `crystal-alpha` (NOT `crystal`) for all builds. **CRITICAL:** You MUST pass platform flags: +```bash +crystal-alpha build src/#{name}.cr -o bin/#{name} -Dmacos --link-flags="..." +``` +Platform flags: `-Dmacos`, `-Dios`, `-Dandroid` (NOT auto-detected by Crystal). + +## Amber Configuration + +Use `Amber.settings` directly — do NOT use `Amber::Server.configure` or start the HTTP server: +```crystal +Amber.settings.name = "#{pascal_name}" # Correct +# Amber::Server.configure { ... } # WRONG for native apps +``` + +## Build (macOS Development) + +```bash +make setup # First time: install shards + create symlinks +make macos # Build for macOS (compiles ObjC bridges + Crystal) +make run # Build and run +make spec # Run Crystal specs +``` + +## Key Constraints + +1. **No HTTP server.** Native app uses event loop, not Amber::Server. +2. **All UI through Asset Pipeline.** `require "asset_pipeline/ui"`, NOT `require "ui"`. +3. **Process managers own business logic.** Controllers only validate and delegate. +4. **crystal-alpha compiler.** Required for cross-compilation targets. +5. **Platform flags are mandatory.** Always pass -Dmacos, -Dios, or -Dandroid. +6. **ObjC bridge: -fno-objc-arc.** Asset Pipeline bridge manages its own memory. +7. **No Crystal spawn in NSApp.** Use GCD via ObjC bridge instead. +8. **crystal-audio symlink.** Needs `ln -sf crystal-audio lib/crystal_audio`. + +## Key Directories + +``` +src/ +├── controllers/ — Event handlers (adapted from Amber controllers) +├── models/ — Data models (Grant ORM + SQLite) +├── process_managers/ — All business logic (FSDD process managers) +├── ui/ — Views using Asset Pipeline UI components +├── platform/ — Platform-specific ObjC bridge +└── events/ — Internal event bus +``` + +## Cross-Platform Builds + +- **macOS:** `make macos` +- **iOS:** `cd mobile/ios && ./build_crystal_lib.sh simulator` +- **Android:** `cd mobile/android && ./build_crystal_lib.sh` +CLAUDEMD + + File.write(File.join(path, "CLAUDE.md"), content) + end + + private def create_main_file + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-MAIN +require "amber" +require "asset_pipeline/ui" +require "./controllers/**" +require "./models/**" +require "./process_managers/**" +require "./ui/**" +require "./events/**" + +# Configure Amber WITHOUT HTTP server. +# IMPORTANT: Use Amber.settings directly, NOT Amber::Server.configure. +# Native apps use an event loop, not an HTTP server. +Amber.settings.name = "#{pascal_name}" + +# Initialize and start the application +module #{pascal_name} + def self.start + # Initialize process managers + main_pm = ProcessManagers::MainProcessManager.new + + # Build the initial UI + main_view = UI::MainView.new + main_view.render + + # Start the native event loop + # On macOS, this will be the NSApplication run loop + {% if flag?(:macos) %} + # macOS: NSApplication run loop is started by Asset Pipeline + # IMPORTANT: Never use Crystal `spawn` in NSApp — use GCD via ObjC bridge + {% end %} + end +end + +#{pascal_name}.start +MAIN + + File.write(File.join(path, "src/#{name}.cr"), content) + end + + private def create_config_files + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-CONFIG +require "amber" + +# Native app configuration. +# IMPORTANT: Do NOT use Amber::Server.configure — that creates an HTTP server. +# Native apps use Amber.settings directly for configuration. +Amber.settings.name = "#{pascal_name}" +CONFIG + + File.write(File.join(path, "config/application.cr"), content) + end + + private def create_application_controller + content = <<-CONTROLLER +# Base controller for native app event handlers. +# In a native app, controllers handle UI events rather than HTTP requests. +# All business logic should be delegated to process managers. +class ApplicationController + # Override in subclasses to handle specific events + def handle(event : String, payload : Hash(String, String)? = nil) + end +end +CONTROLLER + + File.write(File.join(path, "src/controllers/application_controller.cr"), content) + end + + private def create_main_controller + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-CONTROLLER +# Main event controller for #{pascal_name}. +# Handles UI events and delegates to process managers. +# FSDD Rule: Controllers only validate and delegate — never contain business logic. +class MainController < ApplicationController + @process_manager : ProcessManagers::MainProcessManager + + def initialize(@process_manager = ProcessManagers::MainProcessManager.new) + end + + def handle(event : String, payload : Hash(String, String)? = nil) + case event + when "app:launched" + @process_manager.on_app_launched + when "app:will_terminate" + @process_manager.on_app_will_terminate + else + # Unknown event — log and ignore + end + end +end +CONTROLLER + + File.write(File.join(path, "src/controllers/main_controller.cr"), content) + end + + private def create_main_process_manager + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-PM +# Main process manager for #{pascal_name}. +# FSDD Rule: ALL business logic lives in process managers. +# Controllers only validate and delegate to this class. +module ProcessManagers + class MainProcessManager + getter state : String = "idle" + + def initialize + @state = "initialized" + end + + def on_app_launched + @state = "running" + # Add startup logic here + end + + def on_app_will_terminate + @state = "terminating" + # Add cleanup logic here + end + end +end +PM + + File.write(File.join(path, "src/process_managers/main_process_manager.cr"), content) + end + + private def create_event_bus + content = <<-EVENTS +# Simple event bus for native app communication. +# Process managers and controllers communicate through events, +# not direct method calls across boundaries. +module Events + alias EventHandler = String, Hash(String, String)? -> + + class EventBus + @@handlers = Hash(String, Array(EventHandler)).new + + def self.on(event : String, &handler : EventHandler) + @@handlers[event] ||= Array(EventHandler).new + @@handlers[event] << handler + end + + def self.emit(event : String, payload : Hash(String, String)? = nil) + if handlers = @@handlers[event]? + handlers.each { |handler| handler.call(event, payload) } + end + end + + def self.clear + @@handlers.clear + end + end +end +EVENTS + + File.write(File.join(path, "src/events/event_bus.cr"), content) + end + + private def create_main_view + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-VIEW +require "asset_pipeline/ui" + +# Main view for #{pascal_name}. +# Uses Asset Pipeline cross-platform UI components. +# IMPORTANT: require "asset_pipeline/ui" NOT "ui" +module UI + class MainView + def render + # Asset Pipeline renders to the appropriate native backend: + # - macOS: AppKit (NSView hierarchy) + # - iOS: UIKit (UIView hierarchy) + # - Android: Android Views (ViewGroup hierarchy) + # + # Example view composition: + # root = ::UI::VStack.new + # root.children << ::UI::Label.new(text: "Welcome to #{pascal_name}") + # root.children << ::UI::Button.new(text: "Get Started", test_id: "1.1-get-started-button") + # + # test_id convention (FSDD): {epic}.{story}-{element-name} + end + end +end +VIEW + + File.write(File.join(path, "src/ui/main_view.cr"), content) + end + + private def create_platform_bridge + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-OBJC +// #{pascal_name} Platform Bridge +// +// ObjC bridge for platform-specific functionality. +// Compiled with: clang -c #{name}_platform_bridge.m -o #{name}_platform_bridge.o -fno-objc-arc +// +// IMPORTANT: +// - Must compile with -fno-objc-arc (bridge manages its own memory) +// - Never use Crystal `spawn` in NSApp applications — use GCD instead +// - Use dispatch_async for async work, callback on main thread + +#import + +#ifdef __APPLE__ + #include + #if TARGET_OS_OSX + #import + #elif TARGET_OS_IOS + #import + #endif +#endif + +// ============================================================================ +// Section 1: GCD Dispatch Helpers +// ============================================================================ +// Use these instead of Crystal `spawn` in NSApp applications. +// Crystal fibers and NSApplication run loop do not cooperate safely. + +typedef void (*gcd_callback_t)(void *context); + +void dispatch_to_main(gcd_callback_t callback, void *context) { + dispatch_async(dispatch_get_main_queue(), ^{ + callback(context); + }); +} + +void dispatch_to_background(gcd_callback_t callback, void *context) { + dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{ + callback(context); + }); +} + +// ============================================================================ +// Section 2: Platform Detection +// ============================================================================ + +int platform_is_macos(void) { +#if TARGET_OS_OSX + return 1; +#else + return 0; +#endif +} + +int platform_is_ios(void) { +#if TARGET_OS_IOS + return 1; +#else + return 0; +#endif +} + +// ============================================================================ +// Section 3: Application-Specific Bridges +// ============================================================================ +// Add your platform-specific ObjC bridges here. +// Follow the pattern: C function signature callable from Crystal lib blocks. +// +// Example: +// void show_native_alert(const char *title, const char *message) { +// #if TARGET_OS_OSX +// NSAlert *alert = [[NSAlert alloc] init]; +// [alert setMessageText:[NSString stringWithUTF8String:title]]; +// [alert setInformativeText:[NSString stringWithUTF8String:message]]; +// [alert runModal]; +// #endif +// } +// +// Then in Crystal: +// @[Link(ldflags: "...")] +// lib PlatformBridge +// # IMPORTANT: Use `alias` NOT `type` for C function pointer types (GAP-17) +// alias GCDCallback = Pointer(Void) -> Void +// fun dispatch_to_main(callback : GCDCallback, context : Pointer(Void)) +// fun show_native_alert(title : LibC::Char*, message : LibC::Char*) +// end +OBJC + + File.write(File.join(path, "src/platform/#{name}_platform_bridge.m"), content) + end + + private def create_spec_helper + content = <<-SPEC +require "spec" +require "../src/process_managers/**" +require "../src/events/**" + +# Native app specs test process managers and event bus. +# UI rendering and platform bridges require hardware and are tested +# via L2 (UI tests) and L3 (E2E scripts) instead. +SPEC + + File.write(File.join(path, "spec/spec_helper.cr"), content) + end + + private def create_process_manager_spec + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-SPEC +require "../spec_helper" + +describe ProcessManagers::MainProcessManager do + describe "#initialize" do + it "starts in initialized state" do + pm = ProcessManagers::MainProcessManager.new + pm.state.should eq("initialized") + end + end + + describe "#on_app_launched" do + it "transitions to running state" do + pm = ProcessManagers::MainProcessManager.new + pm.on_app_launched + pm.state.should eq("running") + end + end + + describe "#on_app_will_terminate" do + it "transitions to terminating state" do + pm = ProcessManagers::MainProcessManager.new + pm.on_app_will_terminate + pm.state.should eq("terminating") + end + end +end + +describe Events::EventBus do + it "registers and emits events" do + received = false + Events::EventBus.on("test:event") { |_event, _payload| received = true } + Events::EventBus.emit("test:event") + received.should be_true + Events::EventBus.clear + end + + it "passes payload to handlers" do + received_payload = nil + Events::EventBus.on("test:payload") { |_event, payload| received_payload = payload } + Events::EventBus.emit("test:payload", {"key" => "value"}) + received_payload.should eq({"key" => "value"}) + Events::EventBus.clear + end +end +SPEC + + File.write(File.join(path, "spec/macos/process_manager_spec.cr"), content) + end + + private def create_mobile_shared_bridge + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-BRIDGE +# Shared mobile bridge for #{pascal_name}. +# This file is cross-compiled for both iOS and Android. +# +# iOS: crystal-alpha build ... --cross-compile --target=arm64-apple-ios-simulator -Dios +# Android: crystal-alpha build ... --cross-compile --target=aarch64-linux-android26 -Dandroid +# +# IMPORTANT: Guard platform-specific code with compile flags: +# {% if flag?(:darwin) %} — macOS or iOS +# {% if flag?(:ios) %} — iOS only +# {% if flag?(:android) %} — Android only +# {% unless flag?(:darwin) || flag?(:android) %} — neither (for stubs) + +module #{pascal_name}::MobileBridge + # State machine for the mobile app lifecycle + enum AppState + Idle + Ready + Recording + Processing + Error + end + + class Bridge + getter state : AppState = AppState::Idle + + def initialize + @state = AppState::Ready + end + + def transition_to(new_state : AppState) : Bool + case {state, new_state} + when {AppState::Ready, AppState::Recording}, + {AppState::Recording, AppState::Processing}, + {AppState::Processing, AppState::Ready}, + {AppState::Error, AppState::Ready} + @state = new_state + true + else + false + end + end + end +end +BRIDGE + + File.write(File.join(path, "mobile/shared/bridge.cr"), content) + end + + private def create_mobile_shared_spec + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-SPEC +require "spec" +require "../bridge" + +# L1 mobile bridge specs. +# Tests the state machine independently of platform code. +# Approach: standalone state machine replica (Option B) to avoid +# `fun main` conflict + hardware dependencies. + +describe #{pascal_name}::MobileBridge::Bridge do + describe "#initialize" do + it "starts in Ready state" do + bridge = #{pascal_name}::MobileBridge::Bridge.new + bridge.state.should eq(#{pascal_name}::MobileBridge::AppState::Ready) + end + end + + describe "#transition_to" do + it "transitions Ready -> Recording" do + bridge = #{pascal_name}::MobileBridge::Bridge.new + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Recording).should be_true + bridge.state.should eq(#{pascal_name}::MobileBridge::AppState::Recording) + end + + it "transitions Recording -> Processing" do + bridge = #{pascal_name}::MobileBridge::Bridge.new + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Recording) + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Processing).should be_true + bridge.state.should eq(#{pascal_name}::MobileBridge::AppState::Processing) + end + + it "transitions Processing -> Ready" do + bridge = #{pascal_name}::MobileBridge::Bridge.new + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Recording) + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Processing) + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Ready).should be_true + bridge.state.should eq(#{pascal_name}::MobileBridge::AppState::Ready) + end + + it "transitions Error -> Ready" do + bridge = #{pascal_name}::MobileBridge::Bridge.new + # Force error state for testing + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Recording) + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Processing) + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Ready) + # Now test Error -> Ready would work if we could set error state + end + + it "rejects invalid transitions" do + bridge = #{pascal_name}::MobileBridge::Bridge.new + # Ready -> Processing is not valid (must go through Recording) + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Processing).should be_false + bridge.state.should eq(#{pascal_name}::MobileBridge::AppState::Ready) + end + + it "rejects Ready -> Error" do + bridge = #{pascal_name}::MobileBridge::Bridge.new + bridge.transition_to(#{pascal_name}::MobileBridge::AppState::Error).should be_false + end + end +end +SPEC + + File.write(File.join(path, "mobile/shared/spec/bridge_spec.cr"), content) + end + + private def create_ios_build_script + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-BASH +#!/usr/bin/env bash +# build_crystal_lib.sh +# +# Build the #{pascal_name} Crystal bridge as a static library for iOS. +# +# Output: mobile/ios/build/lib#{name}.a +# +# Prerequisites +# ------------- +# - crystal-alpha installed +# - Xcode with iOS SDK: xcode-select --install +# +# Usage +# ----- +# cd #{name} && ./mobile/ios/build_crystal_lib.sh [simulator|device] +# +# Key learnings from Scribe: +# - MUST use ld -r -unexported_symbol _main on Crystal .o to avoid _main clash with Swift @main +# - BoehmGC (libgc.a) must be compiled targeting the iOS simulator SDK +# - ext files needed: block_bridge.c, objc_helpers.c, trace_helper.c, audio_write_helper.c + +set -euo pipefail + +# --------------------------------------------------------------------------- +# Configuration +# --------------------------------------------------------------------------- + +CRYSTAL=\${CRYSTAL:-crystal-alpha} +BUILD_TARGET="\${1:-simulator}" + +SCRIPT_DIR="\$(cd "\$(dirname "\$0")" && pwd)" +MOBILE_DIR="\$(cd "\$SCRIPT_DIR/.." && pwd)" +PROJECT_ROOT="\$(cd "\$MOBILE_DIR/.." && pwd)" +BUILD_DIR="\$SCRIPT_DIR/build" +OUTPUT_LIB="\$BUILD_DIR/lib#{name}.a" +BRIDGE_SRC="\$MOBILE_DIR/shared/bridge.cr" +BRIDGE_BASE="\$BUILD_DIR/bridge" + +# crystal-audio ext directory +CRYSTAL_AUDIO_EXT="" +if [[ -d "\$PROJECT_ROOT/lib/crystal-audio/ext" ]]; then + CRYSTAL_AUDIO_EXT="\$PROJECT_ROOT/lib/crystal-audio/ext" +elif [[ -d "\$PROJECT_ROOT/lib/crystal_audio/ext" ]]; then + CRYSTAL_AUDIO_EXT="\$PROJECT_ROOT/lib/crystal_audio/ext" +fi + +MIN_IOS_VER="16.0" + +case "\$BUILD_TARGET" in + simulator) + LLVM_TARGET="arm64-apple-ios-simulator" + SDK_NAME="iphonesimulator" + ;; + device) + LLVM_TARGET="arm64-apple-ios" + SDK_NAME="iphoneos" + ;; + *) + echo "Usage: \$0 [simulator|device]" + exit 1 + ;; +esac + +# --------------------------------------------------------------------------- +# Helpers +# --------------------------------------------------------------------------- + +info() { printf '\\033[0;34m[build]\\033[0m %s\\n' "\$*"; } +ok() { printf '\\033[0;32m[ok]\\033[0m %s\\n' "\$*"; } +fail() { printf '\\033[0;31m[fail]\\033[0m %s\\n' "\$*" >&2; exit 1; } + +require_cmd() { + command -v "\$1" >/dev/null 2>&1 || fail "Required command not found: \$1" +} + +# --------------------------------------------------------------------------- +# Preflight +# --------------------------------------------------------------------------- + +require_cmd "\$CRYSTAL" +require_cmd xcrun +require_cmd xcodebuild + +[[ ! -f "\$BRIDGE_SRC" ]] && fail "Bridge source not found: \$BRIDGE_SRC" + +SDK_PATH="\$(xcrun --sdk \$SDK_NAME --show-sdk-path)" +CLANG="\$(xcrun --sdk \$SDK_NAME --find clang)" + +info "Target : \$LLVM_TARGET" +info "SDK : \$SDK_PATH" +info "Bridge source : \$BRIDGE_SRC" + +mkdir -p "\$BUILD_DIR" + +# --------------------------------------------------------------------------- +# Step 1: Compile native extensions for iOS +# --------------------------------------------------------------------------- + +info "Compiling native extensions for \$BUILD_TARGET..." + +if [[ -n "\$CRYSTAL_AUDIO_EXT" ]]; then + for src_file in "\$CRYSTAL_AUDIO_EXT"/*.c "\$CRYSTAL_AUDIO_EXT"/*.m; do + [[ ! -f "\$src_file" ]] && continue + obj_name="\$(basename "\$src_file" | sed 's/\\.[cm]\$//')_ios.o" + "\$CLANG" -c "\$src_file" -o "\$BUILD_DIR/\$obj_name" \\ + -target "\$LLVM_TARGET" \\ + -isysroot "\$SDK_PATH" \\ + -mios-version-min=\$MIN_IOS_VER \\ + -fno-objc-arc 2>/dev/null || true + done + ok "Native extensions compiled" +else + info "No crystal-audio ext directory found, skipping" +fi + +# --------------------------------------------------------------------------- +# Step 2: Cross-compile Crystal bridge +# --------------------------------------------------------------------------- + +info "Cross-compiling Crystal bridge..." + +"\$CRYSTAL" build "\$BRIDGE_SRC" \\ + --cross-compile \\ + --target="\$LLVM_TARGET" \\ + -Dios \\ + -o "\$BRIDGE_BASE" + +ok "Crystal cross-compilation complete" + +# --------------------------------------------------------------------------- +# Step 3: Fix _main symbol conflict +# --------------------------------------------------------------------------- +# CRITICAL: Crystal emits a _main symbol that conflicts with Swift's @main. +# We must hide it using ld -r -unexported_symbol _main. + +info "Fixing _main symbol conflict..." + +if [[ -f "\$BRIDGE_BASE.o" ]]; then + ld -r -unexported_symbol _main "\$BRIDGE_BASE.o" -o "\$BUILD_DIR/bridge_fixed.o" + mv "\$BUILD_DIR/bridge_fixed.o" "\$BRIDGE_BASE.o" + ok "_main symbol hidden" +fi + +# --------------------------------------------------------------------------- +# Step 4: Pack into static library +# --------------------------------------------------------------------------- + +info "Creating static library..." + +OBJ_FILES="\$BRIDGE_BASE.o" +for obj in "\$BUILD_DIR"/*_ios.o; do + [[ -f "\$obj" ]] && OBJ_FILES="\$OBJ_FILES \$obj" +done + +ar rcs "\$OUTPUT_LIB" \$OBJ_FILES +ok "Static library created: \$OUTPUT_LIB" + +info "Done! Link with: -L\$BUILD_DIR -l#{name}" +BASH + + script_path = File.join(path, "mobile/ios/build_crystal_lib.sh") + File.write(script_path, content) + File.chmod(script_path, 0o755) + end + + private def create_ios_project_yml + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-YML +name: #{pascal_name} +options: + bundleIdPrefix: com.#{name}.app + deploymentTarget: + iOS: "16.0" +settings: + # CRITICAL: Crystal only compiles arm64. Exclude x86_64 from simulator builds. + EXCLUDED_ARCHS[sdk=iphonesimulator*]: x86_64 +targets: + #{pascal_name}: + type: application + platform: iOS + sources: + - path: Sources + settings: + LIBRARY_SEARCH_PATHS: $(PROJECT_DIR)/build + OTHER_LDFLAGS: + - -l#{name} + - -lgc + - -framework AVFoundation + - -framework AudioToolbox + - -framework CoreAudio + - -framework CoreFoundation + - -framework Foundation + - -framework UIKit + - -lobjc + dependencies: [] + #{pascal_name}UITests: + type: bundle.ui-testing + platform: iOS + sources: + - path: UITests + dependencies: + - target: #{pascal_name} +YML + + File.write(File.join(path, "mobile/ios/project.yml"), content) + end + + private def create_ios_ui_tests + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-SWIFT +import XCTest + +// L2 iOS UI Tests for #{pascal_name} +// Uses accessibilityIdentifier (mapped from Asset Pipeline test_id) +// test_id convention (FSDD): {epic}.{story}-{element-name} +// +// IMPORTANT: These tests require: +// 1. Build Crystal lib: ./build_crystal_lib.sh simulator +// 2. Generate Xcode project: xcodegen generate +// 3. Build app: xcodebuild -scheme #{pascal_name} -sdk iphonesimulator build +// 4. Then run tests: xcodebuild test -scheme #{pascal_name}UITests -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 15' + +final class #{pascal_name}UITests: XCTestCase { + + override func setUpWithError() throws { + continueAfterFailure = false + } + + func testAppLaunches() throws { + let app = XCUIApplication() + app.launch() + + // Verify the app launched successfully + XCTAssertTrue(app.exists) + } + + // Add UI tests using accessibilityIdentifier: + // func testMainViewExists() throws { + // let app = XCUIApplication() + // app.launch() + // let element = app.staticTexts["1.1-welcome-label"] + // XCTAssertTrue(element.waitForExistence(timeout: 5)) + // } +} +SWIFT + + File.write(File.join(path, "mobile/ios/UITests/UITests.swift"), content) + end + + private def create_ios_e2e_script + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-BASH +#!/usr/bin/env bash +# L3 E2E test script for #{pascal_name} iOS +# Runs the full build + test cycle without JS/Python dependencies. +# +# Usage: cd #{name} && ./mobile/ios/test_ios.sh + +set -euo pipefail + +SCRIPT_DIR="\$(cd "\$(dirname "\$0")" && pwd)" +PROJECT_ROOT="\$(cd "\$SCRIPT_DIR/../.." && pwd)" + +info() { printf '\\033[0;34m[test]\\033[0m %s\\n' "\$*"; } +ok() { printf '\\033[0;32m[pass]\\033[0m %s\\n' "\$*"; } +fail() { printf '\\033[0;31m[fail]\\033[0m %s\\n' "\$*" >&2; exit 1; } + +PASS=0 +TOTAL=0 + +check() { + TOTAL=\$((TOTAL + 1)) + if eval "\$2"; then + ok "\$1" + PASS=\$((PASS + 1)) + else + fail "\$1" + fi +} + +# Step 1: Build Crystal static library +info "Step 1/6: Building Crystal library for iOS simulator..." +cd "\$PROJECT_ROOT" +check "Crystal lib builds" "./mobile/ios/build_crystal_lib.sh simulator" + +# Step 2: Verify static library exists +info "Step 2/6: Verifying static library..." +check "lib#{name}.a exists" "[ -f mobile/ios/build/lib#{name}.a ]" + +# Step 3: Generate Xcode project +info "Step 3/6: Generating Xcode project..." +cd "\$SCRIPT_DIR" +check "xcodegen succeeds" "command -v xcodegen >/dev/null && xcodegen generate" + +# Step 4: Build the iOS app +info "Step 4/6: Building iOS app..." +check "xcodebuild succeeds" "xcodebuild -project #{pascal_name}.xcodeproj -scheme #{pascal_name} -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 15' build 2>/dev/null" + +# Step 5: Run UI tests +info "Step 5/6: Running UI tests..." +check "UI tests pass" "xcodebuild test -project #{pascal_name}.xcodeproj -scheme #{pascal_name}UITests -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 15' 2>/dev/null" + +# Step 6: Summary +info "Step 6/6: Results" +echo "" +echo "====================" +echo " \$PASS / \$TOTAL passed" +echo "====================" +BASH + + script_path = File.join(path, "mobile/ios/test_ios.sh") + File.write(script_path, content) + File.chmod(script_path, 0o755) + end + + private def create_android_build_script + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-BASH +#!/usr/bin/env bash +# build_crystal_lib.sh -- Cross-compile Crystal + JNI bridge for Android (aarch64) +# +# Produces: app/src/main/jniLibs/arm64-v8a/lib#{name}.so +# +# Prerequisites: +# - crystal-alpha compiler +# - Android NDK (ANDROID_SDK_ROOT or NDK_ROOT env var) +# - Pre-built libgc.a for aarch64-linux-android26 +# +# CRITICAL: libgc.a for Android must be compiled with GC_BUILTIN_ATOMIC flag. +# Use NDK's llvm-ar (not system ar) to create the archive. +# +# Usage: +# cd #{name} && ./mobile/android/build_crystal_lib.sh + +set -euo pipefail + +# --------------------------------------------------------------------------- +# Configuration +# --------------------------------------------------------------------------- + +CRYSTAL="\${CRYSTAL:-crystal-alpha}" +TARGET="aarch64-linux-android26" +API_LEVEL=26 +HOST_TAG="darwin-x86_64" + +SCRIPT_DIR="\$(cd "\$(dirname "\$0")" && pwd)" +MOBILE_DIR="\$(cd "\$SCRIPT_DIR/.." && pwd)" +PROJECT_ROOT="\$(cd "\$MOBILE_DIR/.." && pwd)" +BUILD_DIR="\$SCRIPT_DIR/build" +JNILIBS_DIR="\$SCRIPT_DIR/app/src/main/jniLibs/arm64-v8a" +BRIDGE_SRC="\$MOBILE_DIR/shared/bridge.cr" +BRIDGE_BASE="\$BUILD_DIR/bridge" + +# --------------------------------------------------------------------------- +# Helpers +# --------------------------------------------------------------------------- + +info() { printf '\\033[0;34m[build]\\033[0m %s\\n' "\$*"; } +ok() { printf '\\033[0;32m[ok]\\033[0m %s\\n' "\$*"; } +fail() { printf '\\033[0;31m[fail]\\033[0m %s\\n' "\$*" >&2; exit 1; } + +require_cmd() { + command -v "\$1" >/dev/null 2>&1 || fail "Required command not found: \$1" +} + +# --------------------------------------------------------------------------- +# Preflight +# --------------------------------------------------------------------------- + +require_cmd "\$CRYSTAL" + +[[ ! -f "\$BRIDGE_SRC" ]] && fail "Bridge source not found: \$BRIDGE_SRC" + +# Locate NDK +ANDROID_SDK_ROOT="\${ANDROID_SDK_ROOT:-/opt/homebrew/share/android-commandlinetools}" +NDK_ROOT="\${NDK_ROOT:-\$(ls -d "\$ANDROID_SDK_ROOT"/ndk/*/ 2>/dev/null | sort -V | tail -1)}" +NDK_ROOT="\${NDK_ROOT%/}" + +if [[ -z "\$NDK_ROOT" ]] || [[ ! -d "\$NDK_ROOT" ]]; then + fail "NDK not found. Set NDK_ROOT or install NDK under \\\$ANDROID_SDK_ROOT/ndk/" +fi + +NDK_CLANG="\$NDK_ROOT/toolchains/llvm/prebuilt/\$HOST_TAG/bin/\${TARGET}-clang" +CLANG_FLAGS="" +if [[ ! -f "\$NDK_CLANG" ]]; then + NDK_CLANG="\$NDK_ROOT/toolchains/llvm/prebuilt/\$HOST_TAG/bin/clang" + CLANG_FLAGS="--target=\$TARGET" + [[ ! -f "\$NDK_CLANG" ]] && fail "NDK clang not found at: \$NDK_CLANG" +fi + +SYSROOT="\$NDK_ROOT/toolchains/llvm/prebuilt/\$HOST_TAG/sysroot" + +info "Target : \$TARGET" +info "NDK root : \$NDK_ROOT" +info "Bridge source : \$BRIDGE_SRC" + +mkdir -p "\$BUILD_DIR" "\$JNILIBS_DIR" + +# --------------------------------------------------------------------------- +# Step 1: Compile JNI bridge +# --------------------------------------------------------------------------- + +info "Compiling JNI bridge..." + +cat > "\$BUILD_DIR/jni_bridge.c" << 'JNIC' +#include +#include + +// Crystal trace function — routes to Android logcat +void crystal_trace(const char *msg) { + __android_log_print(ANDROID_LOG_DEBUG, "#{pascal_name}", "%s", msg); +} +JNIC + +"\$NDK_CLANG" \$CLANG_FLAGS -c "\$BUILD_DIR/jni_bridge.c" -o "\$BUILD_DIR/jni_bridge.o" \\ + --sysroot="\$SYSROOT" + +ok "JNI bridge compiled" + +# --------------------------------------------------------------------------- +# Step 2: Cross-compile Crystal bridge +# --------------------------------------------------------------------------- + +info "Cross-compiling Crystal bridge for Android..." + +"\$CRYSTAL" build "\$BRIDGE_SRC" \\ + --cross-compile \\ + --target="\$TARGET" \\ + -Dandroid \\ + -o "\$BRIDGE_BASE" + +ok "Crystal cross-compilation complete" + +# --------------------------------------------------------------------------- +# Step 3: Link shared library +# --------------------------------------------------------------------------- +# CRITICAL: -laaudio is REQUIRED for AAudio recording/playback on Android. +# Missing -laaudio causes undefined symbol errors at runtime. + +info "Linking shared library..." + +"\$NDK_CLANG" \$CLANG_FLAGS \\ + "\$BRIDGE_BASE.o" "\$BUILD_DIR/jni_bridge.o" \\ + -shared -o "\$JNILIBS_DIR/lib#{name}.so" \\ + --sysroot="\$SYSROOT" \\ + -laaudio -llog -landroid \\ + -lm -ldl -lc + +ok "Shared library created: \$JNILIBS_DIR/lib#{name}.so" + +info "Done!" +BASH + + script_path = File.join(path, "mobile/android/build_crystal_lib.sh") + File.write(script_path, content) + File.chmod(script_path, 0o755) + end + + private def create_android_build_gradle + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-GRADLE +plugins { + id("com.android.application") + id("org.jetbrains.kotlin.android") +} + +android { + namespace = "com.#{name}.app" + compileSdk = 34 + + defaultConfig { + applicationId = "com.#{name}.app" + minSdk = 26 + targetSdk = 34 + versionCode = 1 + versionName = "1.0" + + testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" + + ndk { + // Crystal cross-compiles to arm64-v8a only + abiFilters += "arm64-v8a" + } + } + + buildTypes { + release { + isMinifyEnabled = false + } + } + + buildFeatures { + compose = true + } + + composeOptions { + kotlinCompilerExtensionVersion = "1.5.1" + } + + // IMPORTANT: Android build requires JDK 17 (AGP 8.x incompatible with JDK 25) + compileOptions { + sourceCompatibility = JavaVersion.VERSION_17 + targetCompatibility = JavaVersion.VERSION_17 + } + + kotlinOptions { + jvmTarget = "17" + } +} + +dependencies { + implementation("androidx.core:core-ktx:1.12.0") + implementation("androidx.activity:activity-compose:1.8.0") + implementation(platform("androidx.compose:compose-bom:2024.02.00")) + implementation("androidx.compose.ui:ui") + implementation("androidx.compose.material3:material3") + // material-icons-extended required for Mic/Stop/AudioFile icons + implementation("androidx.compose.material:material-icons-extended") + + androidTestImplementation("androidx.test.ext:junit:1.1.5") + androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1") + androidTestImplementation("androidx.compose.ui:ui-test-junit4") +} +GRADLE + + File.write(File.join(path, "mobile/android/build.gradle.kts"), content) + end + + private def create_android_ui_tests + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-KOTLIN +package com.#{name}.app + +import androidx.compose.ui.test.junit4.createAndroidComposeRule +import androidx.compose.ui.test.onNodeWithTag +import androidx.compose.ui.test.assertIsDisplayed +import androidx.test.ext.junit.runners.AndroidJUnit4 +import org.junit.Rule +import org.junit.Test +import org.junit.runner.RunWith + +// L2 Android Compose UI Tests for #{pascal_name} +// Uses testTag (mapped from Asset Pipeline test_id / contentDescription) +// test_id convention (FSDD): {epic}.{story}-{element-name} +// +// IMPORTANT: Build requires JDK 17 (AGP 8.x incompatible with JDK 25) +// JAVA_HOME=/opt/homebrew/Cellar/openjdk@17/17.0.18/libexec/openjdk.jdk/Contents/Home ./gradlew connectedAndroidTest + +@RunWith(AndroidJUnit4::class) +class #{pascal_name}UITests { + + // Add compose test rule when Activity is created: + // @get:Rule + // val composeTestRule = createAndroidComposeRule() + + @Test + fun appLaunches() { + // Verify the app launches without crashing + assert(true) + } + + // Add UI tests using testTag: + // @Test + // fun mainViewExists() { + // composeTestRule.onNodeWithTag("1.1-welcome-label").assertIsDisplayed() + // } +} +KOTLIN + + File.write(File.join(path, "mobile/android/app/src/androidTest/java/com/#{name}/app/#{pascal_name}UITests.kt"), content) + end + + private def create_android_e2e_script + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-BASH +#!/usr/bin/env bash +# L3 E2E test script for #{pascal_name} Android +# Runs the full build + test cycle without JS/Python dependencies. +# +# IMPORTANT: Requires JDK 17 (AGP 8.x incompatible with JDK 25) +# +# Usage: cd #{name} && ./mobile/android/test_android.sh + +set -euo pipefail + +SCRIPT_DIR="\$(cd "\$(dirname "\$0")" && pwd)" +PROJECT_ROOT="\$(cd "\$SCRIPT_DIR/../.." && pwd)" + +# JDK 17 required for Android Gradle Plugin +export JAVA_HOME="\${JAVA_HOME:-/opt/homebrew/Cellar/openjdk@17/17.0.18/libexec/openjdk.jdk/Contents/Home}" + +info() { printf '\\033[0;34m[test]\\033[0m %s\\n' "\$*"; } +ok() { printf '\\033[0;32m[pass]\\033[0m %s\\n' "\$*"; } +fail() { printf '\\033[0;31m[fail]\\033[0m %s\\n' "\$*" >&2; exit 1; } + +PASS=0 +TOTAL=0 + +check() { + TOTAL=\$((TOTAL + 1)) + if eval "\$2"; then + ok "\$1" + PASS=\$((PASS + 1)) + else + fail "\$1" + fi +} + +# Step 1: Build Crystal shared library +info "Step 1/6: Building Crystal library for Android..." +cd "\$PROJECT_ROOT" +check "Crystal lib builds" "ANDROID_SDK_ROOT=\${ANDROID_SDK_ROOT:-/opt/homebrew/share/android-commandlinetools} ./mobile/android/build_crystal_lib.sh" + +# Step 2: Verify shared library exists +info "Step 2/6: Verifying shared library..." +check "lib#{name}.so exists" "[ -f mobile/android/app/src/main/jniLibs/arm64-v8a/lib#{name}.so ]" + +# Step 3: Build Android APK +info "Step 3/6: Building Android APK..." +cd "\$SCRIPT_DIR" +check "Gradle build succeeds" "./gradlew assembleDebug 2>/dev/null" + +# Step 4: Verify APK exists +info "Step 4/6: Verifying APK..." +check "Debug APK exists" "[ -f app/build/outputs/apk/debug/app-debug.apk ]" + +# Step 5: Run instrumented tests (requires connected device/emulator) +info "Step 5/6: Running instrumented tests..." +check "Android tests pass" "./gradlew connectedAndroidTest 2>/dev/null || echo 'Skipped (no device)'" + +# Step 6: Summary +info "Step 6/6: Results" +echo "" +echo "====================" +echo " \$PASS / \$TOTAL passed" +echo "====================" +BASH + + script_path = File.join(path, "mobile/android/test_android.sh") + File.write(script_path, content) + File.chmod(script_path, 0o755) + end + + private def create_android_local_properties + content = <<-PROPS +# local.properties +# IMPORTANT: This file should NOT be committed to version control. +# Android SDK location (adjust to your system) +sdk.dir=/opt/homebrew/share/android-commandlinetools +PROPS + + File.write(File.join(path, "mobile/android/local.properties"), content) + end + + private def create_macos_ui_test_script + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-BASH +#!/usr/bin/env bash +# L2 macOS accessibility UI tests for #{pascal_name} +# Uses AppleScript accessibility inspection to verify UI elements. +# +# Usage: cd #{name} && ./test/macos/test_macos_ui.sh + +set -euo pipefail + +info() { printf '\\033[0;34m[test]\\033[0m %s\\n' "\$*"; } +ok() { printf '\\033[0;32m[pass]\\033[0m %s\\n' "\$*"; } +fail() { printf '\\033[0;31m[fail]\\033[0m %s\\n' "\$*" >&2; } + +PASS=0 +TOTAL=0 + +check() { + TOTAL=\$((TOTAL + 1)) + if eval "\$2" >/dev/null 2>&1; then + ok "\$1" + PASS=\$((PASS + 1)) + else + fail "\$1" + fi +} + +APP_NAME="#{pascal_name}" + +# Verify app is running +check "App is running" "pgrep -x #{name}" + +# Check main window exists via accessibility +check "Main window accessible" "osascript -e 'tell application \"System Events\" to tell process \"#{pascal_name}\" to get name of window 1'" + +echo "" +echo "====================" +echo " \$PASS / \$TOTAL passed" +echo "====================" +BASH + + script_path = File.join(path, "test/macos/test_macos_ui.sh") + File.write(script_path, content) + File.chmod(script_path, 0o755) + end + + private def create_macos_e2e_script + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-BASH +#!/usr/bin/env bash +# L3 macOS E2E test script for #{pascal_name} +# Full build-run-verify cycle. +# +# Usage: cd #{name} && ./test/macos/test_macos_e2e.sh + +set -euo pipefail + +SCRIPT_DIR="\$(cd "\$(dirname "\$0")" && pwd)" +PROJECT_ROOT="\$(cd "\$SCRIPT_DIR/../.." && pwd)" + +info() { printf '\\033[0;34m[test]\\033[0m %s\\n' "\$*"; } +ok() { printf '\\033[0;32m[pass]\\033[0m %s\\n' "\$*"; } +fail() { printf '\\033[0;31m[fail]\\033[0m %s\\n' "\$*" >&2; exit 1; } + +PASS=0 +TOTAL=0 + +check() { + TOTAL=\$((TOTAL + 1)) + if eval "\$2"; then + ok "\$1" + PASS=\$((PASS + 1)) + else + fail "\$1" + fi +} + +cd "\$PROJECT_ROOT" + +# Step 1: Setup +info "Step 1/6: Running setup..." +check "Setup succeeds" "make setup 2>/dev/null" + +# Step 2: Build +info "Step 2/6: Building macOS app..." +check "macOS build succeeds" "make macos 2>/dev/null" + +# Step 3: Verify binary +info "Step 3/6: Verifying binary..." +check "Binary exists" "[ -f bin/#{name} ]" +check "Binary is executable" "[ -x bin/#{name} ]" + +# Step 4: Run Crystal specs +info "Step 4/6: Running Crystal specs..." +check "Crystal specs pass" "make spec 2>/dev/null" + +# Step 5: Quick launch test (start and immediately stop) +info "Step 5/6: Launch test..." +check "App starts" "timeout 3 ./bin/#{name} 2>/dev/null || [ \$? -eq 124 ]" + +# Step 6: Summary +info "Step 6/6: Results" +echo "" +echo "====================" +echo " \$PASS / \$TOTAL passed" +echo "====================" +BASH + + script_path = File.join(path, "test/macos/test_macos_e2e.sh") + File.write(script_path, content) + File.chmod(script_path, 0o755) + end + + private def create_mobile_ci_script + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + content = <<-BASH +#!/usr/bin/env bash +# CI orchestrator for #{pascal_name} — runs tests across all platforms. +# +# Usage: +# ./mobile/run_all_tests.sh # L1 + L2 (default) +# ./mobile/run_all_tests.sh --e2e # L1 + L2 + L3 E2E tests +# +# Test layers: +# L1: Crystal specs (process managers, state machines, event bus) +# L2: Platform UI tests (XCUITest, Compose, AppleScript) +# L3: E2E scripts (full build-run-verify cycle) + +set -euo pipefail + +SCRIPT_DIR="\$(cd "\$(dirname "\$0")" && pwd)" +PROJECT_ROOT="\$(cd "\$SCRIPT_DIR/.." && pwd)" +RUN_E2E=false + +if [[ "\${1:-}" == "--e2e" ]]; then + RUN_E2E=true +fi + +info() { printf '\\033[0;34m[ci]\\033[0m %s\\n' "\$*"; } +ok() { printf '\\033[0;32m[pass]\\033[0m %s\\n' "\$*"; } +fail() { printf '\\033[0;31m[fail]\\033[0m %s\\n' "\$*" >&2; } + +PASS=0 +FAIL=0 + +run_step() { + info "\$1" + if eval "\$2"; then + ok "\$1" + PASS=\$((PASS + 1)) + else + fail "\$1" + FAIL=\$((FAIL + 1)) + fi +} + +cd "\$PROJECT_ROOT" + +echo "============================================" +echo " #{pascal_name} Test Suite" +echo "============================================" +echo "" + +# --- L1: Crystal Specs --- +info "=== L1: Crystal Specs ===" +run_step "Desktop process manager specs" "crystal-alpha spec spec/ -Dmacos 2>/dev/null" +run_step "Mobile bridge specs" "crystal-alpha spec mobile/shared/spec/ 2>/dev/null" + +# --- L2: Platform UI Tests --- +info "=== L2: Platform UI Tests ===" +run_step "macOS accessibility tests" "test/macos/test_macos_ui.sh 2>/dev/null || true" + +# --- L3: E2E Tests (optional) --- +if [[ "\$RUN_E2E" == "true" ]]; then + info "=== L3: E2E Tests ===" + run_step "macOS E2E" "test/macos/test_macos_e2e.sh 2>/dev/null" + run_step "iOS E2E" "mobile/ios/test_ios.sh 2>/dev/null || true" + run_step "Android E2E" "mobile/android/test_android.sh 2>/dev/null || true" +fi + +# --- Summary --- +echo "" +echo "============================================" +TOTAL=\$((PASS + FAIL)) +echo " Results: \$PASS / \$TOTAL passed" +if [[ \$FAIL -gt 0 ]]; then + echo " \$FAIL FAILED" +fi +echo "============================================" + +[[ \$FAIL -gt 0 ]] && exit 1 || exit 0 +BASH + + script_path = File.join(path, "mobile/run_all_tests.sh") + File.write(script_path, content) + File.chmod(script_path, 0o755) + end + + private def create_fsdd_docs + pascal_name = name.split(/[-_]/).map(&.capitalize).join + + # Project index + index_content = <<-INDEX +# #{pascal_name} — FSDD Project Index + +## Overview + +This project follows Feature Story Driven Development (FSDD) v1.2.0. + +## Layers + +1. **Feature Stories** — `docs/fsdd/feature-stories/` +2. **Conventions** — `docs/fsdd/conventions/` +3. **Knowledge Gaps** — `docs/fsdd/knowledge-gaps/` +4. **Process Managers** — `docs/fsdd/process-managers/` +5. **Testing** — `docs/fsdd/testing/` + +## Key Rules + +- All business logic in process managers +- Controllers only validate and delegate +- test_id convention: `{epic}.{story}-{element-name}` +- U-shaped flow: analyst -> architect -> developer -> implementer +INDEX + + File.write(File.join(path, "docs/fsdd/_index.md"), index_content) + + # Testing architecture + testing_content = <<-TESTING +# #{pascal_name} — Testing Architecture + +## Three-Layer Test Strategy + +### L1: Crystal Specs +- **Location:** `spec/macos/`, `mobile/shared/spec/` +- **What:** Process managers, state machines, event bus +- **Run:** `crystal-alpha spec spec/ -Dmacos` +- **No hardware required** — tests pure logic + +### L2: Platform UI Tests +- **macOS:** `test/macos/test_macos_ui.sh` (AppleScript accessibility) +- **iOS:** `mobile/ios/UITests/UITests.swift` (XCUITest) +- **Android:** `mobile/android/app/src/androidTest/` (Compose UI Tests) +- **test_id convention:** `{epic}.{story}-{element-name}` + - Maps to `accessibilityIdentifier` (iOS), `testTag` (Android), `data-testid` (web) + +### L3: E2E Scripts +- **macOS:** `test/macos/test_macos_e2e.sh` +- **iOS:** `mobile/ios/test_ios.sh` +- **Android:** `mobile/android/test_android.sh` +- **CI:** `mobile/run_all_tests.sh` (L1+L2 default, `--e2e` for L3) +- **No JS/Python dependency** — pure shell scripts + +## Test ID Mapping + +| Platform | Property | Source | +|----------|----------|--------| +| Web | `data-testid` | Asset Pipeline `test_id` | +| macOS/iOS | `accessibilityIdentifier` | Asset Pipeline `test_id` via `setAccessibilityIdentifier:` | +| Android | `contentDescription` / `testTag` | Asset Pipeline `test_id` | +TESTING + + File.write(File.join(path, "docs/fsdd/testing/TESTING_ARCHITECTURE.md"), testing_content) + + # Keep files for empty directories + ["feature-stories", "conventions", "knowledge-gaps", "process-managers"].each do |dir| + File.write(File.join(path, "docs/fsdd/#{dir}/.keep"), "") + end + end + + private def create_keep_files + keep_dirs = [ + "src/models", + "bin", + ] + + keep_dirs.each do |dir| + keep_file = File.join(path, dir, ".keep") + File.write(keep_file, "") unless File.exists?(keep_file) + end + end + + private def pascal_case(s : String) : String + s.split(/[-_]/).map(&.capitalize).join + end + end +end diff --git a/src/amber_cli/main_command.cr b/src/amber_cli/main_command.cr index 045c381..134f451 100644 --- a/src/amber_cli/main_command.cr +++ b/src/amber_cli/main_command.cr @@ -21,7 +21,7 @@ module AmberCLI option_parser.separator "" option_parser.separator "Commands:" - option_parser.separator " new [name] Create a new Amber application" + option_parser.separator " new [name] Create a new Amber application (web or native)" option_parser.separator " generate [type] [name] Generate components (model, controller, etc.)" option_parser.separator " routes Show all routes" option_parser.separator " watch Watch and reload application" diff --git a/src/amber_lsp.cr b/src/amber_lsp.cr new file mode 100644 index 0000000..472f055 --- /dev/null +++ b/src/amber_lsp.cr @@ -0,0 +1,28 @@ +require "json" +require "yaml" +require "uri" + +require "./amber_lsp/version" +require "./amber_lsp/rules/severity" +require "./amber_lsp/rules/diagnostic" +require "./amber_lsp/rules/base_rule" +require "./amber_lsp/rules/rule_registry" +require "./amber_lsp/rules/controllers/*" +require "./amber_lsp/rules/jobs/*" +require "./amber_lsp/rules/channels/*" +require "./amber_lsp/rules/pipes/*" +require "./amber_lsp/rules/mailers/*" +require "./amber_lsp/rules/schemas/*" +require "./amber_lsp/rules/file_naming/*" +require "./amber_lsp/rules/routing/*" +require "./amber_lsp/rules/specs/*" +require "./amber_lsp/rules/sockets/*" +require "./amber_lsp/rules/custom_rule" +require "./amber_lsp/document_store" +require "./amber_lsp/project_context" +require "./amber_lsp/configuration" +require "./amber_lsp/analyzer" +require "./amber_lsp/controller" +require "./amber_lsp/server" + +AmberLSP::Server.new(STDIN, STDOUT).run diff --git a/src/amber_lsp/analyzer.cr b/src/amber_lsp/analyzer.cr new file mode 100644 index 0000000..b65927f --- /dev/null +++ b/src/amber_lsp/analyzer.cr @@ -0,0 +1,69 @@ +module AmberLSP + class Analyzer + getter configuration : Configuration + + def initialize + @configuration = Configuration.new + end + + def configure(project_context : ProjectContext) : Nil + @configuration = Configuration.load(project_context.root_path) + register_custom_rules + end + + private def register_custom_rules : Nil + @configuration.custom_rules.each do |custom_config| + severity = case custom_config.severity + when "error" then Rules::Severity::Error + when "warning" then Rules::Severity::Warning + when "info" then Rules::Severity::Information + when "hint" then Rules::Severity::Hint + else Rules::Severity::Warning + end + + rule = Rules::CustomRule.new( + id: custom_config.id, + description: custom_config.description, + default_severity: severity, + applies_to: custom_config.applies_to, + pattern: Regex.new(custom_config.pattern), + message_template: custom_config.message, + negate: custom_config.negate?, + ) + Rules::RuleRegistry.register(rule) + end + rescue ex + STDERR.puts "WARNING: Failed to load custom rules: #{ex.message}" + end + + def analyze(file_path : String, content : String) : Array(Rules::Diagnostic) + return [] of Rules::Diagnostic if @configuration.excluded?(file_path) + + diagnostics = [] of Rules::Diagnostic + rules = Rules::RuleRegistry.rules_for_file(file_path) + + rules.each do |rule| + next unless @configuration.rule_enabled?(rule.id) + + rule_diagnostics = rule.check(file_path, content) + severity = @configuration.rule_severity(rule.id, rule.default_severity) + + rule_diagnostics.each do |diagnostic| + if diagnostic.severity != severity + diagnostics << Rules::Diagnostic.new( + range: diagnostic.range, + severity: severity, + code: diagnostic.code, + message: diagnostic.message, + source: diagnostic.source + ) + else + diagnostics << diagnostic + end + end + end + + diagnostics + end + end +end diff --git a/src/amber_lsp/configuration.cr b/src/amber_lsp/configuration.cr new file mode 100644 index 0000000..2b95cb9 --- /dev/null +++ b/src/amber_lsp/configuration.cr @@ -0,0 +1,153 @@ +require "yaml" + +module AmberLSP + class Configuration + DEFAULT_EXCLUDE_PATTERNS = ["lib/", "tmp/", "db/migrations/"] + CONFIG_FILE_NAME = ".amber-lsp.yml" + + struct RuleConfig + getter enabled : Bool + getter severity : Rules::Severity? + + def initialize(@enabled : Bool = true, @severity : Rules::Severity? = nil) + end + end + + struct CustomRuleConfig + getter id : String + getter description : String + getter severity : String + getter applies_to : Array(String) + getter pattern : String + getter message : String + getter? negate : Bool + + def initialize( + @id : String, + @description : String, + @severity : String = "warning", + @applies_to : Array(String) = ["src/**"], + @pattern : String = "", + @message : String = "", + @negate : Bool = false, + ) + end + end + + getter exclude_patterns : Array(String) + getter custom_rules : Array(CustomRuleConfig) + + def initialize( + @rule_configs : Hash(String, RuleConfig) = Hash(String, RuleConfig).new, + @exclude_patterns : Array(String) = DEFAULT_EXCLUDE_PATTERNS.dup, + @custom_rules : Array(CustomRuleConfig) = [] of CustomRuleConfig, + ) + end + + def self.load(project_root : String) : Configuration + config_path = File.join(project_root, CONFIG_FILE_NAME) + + if File.exists?(config_path) + parse(File.read(config_path)) + else + Configuration.new + end + end + + def self.parse(yaml_content : String) : Configuration + yaml = YAML.parse(yaml_content) + + rule_configs = Hash(String, RuleConfig).new + if rules_node = yaml["rules"]? + rules_node.as_h.each do |key, value| + enabled = true + severity = nil + + if value_hash = value.as_h? + if enabled_val = value_hash["enabled"]? + enabled = enabled_val.as_bool + end + if severity_val = value_hash["severity"]? + severity = parse_severity(severity_val.as_s) + end + end + + rule_configs[key.as_s] = RuleConfig.new(enabled: enabled, severity: severity) + end + end + + exclude_patterns = DEFAULT_EXCLUDE_PATTERNS.dup + if exclude_node = yaml["exclude"]? + exclude_patterns = exclude_node.as_a.map(&.as_s) + end + + custom_rules = [] of CustomRuleConfig + if custom_rules_node = yaml["custom_rules"]? + custom_rules_node.as_a.each do |rule_node| + rule_hash = rule_node.as_h + next unless rule_hash["id"]? && rule_hash["pattern"]? + + id = rule_hash["id"].as_s + description = rule_hash["description"]?.try(&.as_s) || "" + severity = rule_hash["severity"]?.try(&.as_s) || "warning" + pattern = rule_hash["pattern"].as_s + message = rule_hash["message"]?.try(&.as_s) || "" + negate = rule_hash["negate"]?.try(&.as_bool) || false + + applies_to = ["src/**"] + if applies_node = rule_hash["applies_to"]? + applies_to = applies_node.as_a.map(&.as_s) + end + + custom_rules << CustomRuleConfig.new( + id: id, + description: description, + severity: severity, + applies_to: applies_to, + pattern: pattern, + message: message, + negate: negate, + ) + end + end + + Configuration.new( + rule_configs: rule_configs, + exclude_patterns: exclude_patterns, + custom_rules: custom_rules, + ) + rescue YAML::ParseException + Configuration.new + end + + def rule_enabled?(id : String) : Bool + if config = @rule_configs[id]? + config.enabled + else + true + end + end + + def rule_severity(id : String, default : Rules::Severity) : Rules::Severity + if config = @rule_configs[id]? + config.severity || default + else + default + end + end + + def excluded?(file_path : String) : Bool + @exclude_patterns.any? { |pattern| file_path.includes?(pattern) } + end + + private def self.parse_severity(value : String) : Rules::Severity? + case value.downcase + when "error" then Rules::Severity::Error + when "warning" then Rules::Severity::Warning + when "information" then Rules::Severity::Information + when "hint" then Rules::Severity::Hint + else nil + end + end + end +end diff --git a/src/amber_lsp/controller.cr b/src/amber_lsp/controller.cr new file mode 100644 index 0000000..328ead6 --- /dev/null +++ b/src/amber_lsp/controller.cr @@ -0,0 +1,203 @@ +require "json" +require "uri" + +module AmberLSP + class Controller + @project_context : ProjectContext? = nil + + def initialize + @document_store = DocumentStore.new + @analyzer = Analyzer.new + end + + def handle(raw_message : String, server : Server) : String? + json = JSON.parse(raw_message) + method = json["method"]?.try(&.as_s) + id = json["id"]? + + case method + when "initialize" + handle_initialize(id, json) + when "initialized" + handle_initialized + when "textDocument/didOpen" + handle_did_open(json, server) + nil + when "textDocument/didSave" + handle_did_save(json, server) + nil + when "textDocument/didClose" + handle_did_close(json, server) + nil + when "shutdown" + handle_shutdown(id) + when "exit" + handle_exit(server) + nil + else + if id + error_response(id, -32601, "Method not found: #{method}") + else + nil + end + end + rescue ex : JSON::ParseException + error_response(JSON::Any.new(nil), -32700, "Parse error: #{ex.message}") + end + + private def handle_initialize(id : JSON::Any?, json : JSON::Any) : String + if params = json["params"]? + if root_uri = params["rootUri"]?.try(&.as_s?) + root_path = uri_to_path(root_uri) + @project_context = ProjectContext.detect(root_path) + if ctx = @project_context + @analyzer.configure(ctx) + end + elsif root_path = params["rootPath"]?.try(&.as_s?) + @project_context = ProjectContext.detect(root_path) + if ctx = @project_context + @analyzer.configure(ctx) + end + end + end + + result = { + "jsonrpc" => JSON::Any.new("2.0"), + "id" => id || JSON::Any.new(nil), + "result" => JSON::Any.new({ + "capabilities" => JSON::Any.new({ + "textDocumentSync" => JSON::Any.new({ + "openClose" => JSON::Any.new(true), + "change" => JSON::Any.new(1_i64), # Full sync + "save" => JSON::Any.new({ + "includeText" => JSON::Any.new(true), + }), + }), + }), + "serverInfo" => JSON::Any.new({ + "name" => JSON::Any.new("amber-lsp"), + "version" => JSON::Any.new(AmberLSP::VERSION), + }), + }), + } + + result.to_json + end + + private def handle_initialized : Nil + # No-op: client acknowledged initialization + nil + end + + private def handle_did_open(json : JSON::Any, server : Server) : Nil + params = json["params"]? + return unless params + + text_document = params["textDocument"]? + return unless text_document + + uri = text_document["uri"]?.try(&.as_s) + text = text_document["text"]?.try(&.as_s) + return unless uri && text + + @document_store.update(uri, text) + run_diagnostics(uri, text, server) + end + + private def handle_did_save(json : JSON::Any, server : Server) : Nil + params = json["params"]? + return unless params + + text_document = params["textDocument"]? + return unless text_document + + uri = text_document["uri"]?.try(&.as_s) + return unless uri + + text = params["text"]?.try(&.as_s) + if text + @document_store.update(uri, text) + run_diagnostics(uri, text, server) + elsif stored = @document_store.get(uri) + run_diagnostics(uri, stored, server) + end + end + + private def handle_did_close(json : JSON::Any, server : Server) : Nil + params = json["params"]? + return unless params + + text_document = params["textDocument"]? + return unless text_document + + uri = text_document["uri"]?.try(&.as_s) + return unless uri + + @document_store.remove(uri) + publish_diagnostics(uri, [] of Rules::Diagnostic, server) + end + + private def handle_shutdown(id : JSON::Any?) : String + result = { + "jsonrpc" => JSON::Any.new("2.0"), + "id" => id || JSON::Any.new(nil), + "result" => JSON::Any.new(nil), + } + result.to_json + end + + private def handle_exit(server : Server) : Nil + server.stop + end + + private def error_response(id : JSON::Any?, code : Int32, message : String) : String + result = { + "jsonrpc" => JSON::Any.new("2.0"), + "id" => id || JSON::Any.new(nil), + "error" => JSON::Any.new({ + "code" => JSON::Any.new(code.to_i64), + "message" => JSON::Any.new(message), + }), + } + result.to_json + end + + private def run_diagnostics(uri : String, content : String, server : Server) : Nil + file_path = uri_to_path(uri) + + # Only analyze Crystal files + return unless file_path.ends_with?(".cr") + + # Only run if we detected an Amber project + ctx = @project_context + return unless ctx && ctx.amber_project? + + diagnostics = @analyzer.analyze(file_path, content) + publish_diagnostics(uri, diagnostics, server) + end + + private def publish_diagnostics(uri : String, diagnostics : Array(Rules::Diagnostic), server : Server) : Nil + lsp_diagnostics = diagnostics.map(&.to_lsp_json) + + notification = { + "jsonrpc" => JSON::Any.new("2.0"), + "method" => JSON::Any.new("textDocument/publishDiagnostics"), + "params" => JSON::Any.new({ + "uri" => JSON::Any.new(uri), + "diagnostics" => JSON::Any.new(lsp_diagnostics.map { |d| JSON::Any.new(d) }), + }), + } + + server.write_notification(notification.to_json) + end + + private def uri_to_path(uri : String) : String + parsed = URI.parse(uri) + if parsed.scheme == "file" + URI.decode(parsed.path) + else + uri + end + end + end +end diff --git a/src/amber_lsp/document_store.cr b/src/amber_lsp/document_store.cr new file mode 100644 index 0000000..bf019b0 --- /dev/null +++ b/src/amber_lsp/document_store.cr @@ -0,0 +1,23 @@ +module AmberLSP + class DocumentStore + def initialize + @documents = Hash(String, String).new + end + + def update(uri : String, content : String) : Nil + @documents[uri] = content + end + + def get(uri : String) : String? + @documents[uri]? + end + + def remove(uri : String) : Nil + @documents.delete(uri) + end + + def has?(uri : String) : Bool + @documents.has_key?(uri) + end + end +end diff --git a/src/amber_lsp/plugin_templates/lsp.json b/src/amber_lsp/plugin_templates/lsp.json new file mode 100644 index 0000000..ed7199a --- /dev/null +++ b/src/amber_lsp/plugin_templates/lsp.json @@ -0,0 +1,12 @@ +{ + "amber": { + "command": "amber-lsp", + "args": [], + "extensionToLanguage": { + ".cr": "crystal" + }, + "transport": "stdio", + "restartOnCrash": true, + "maxRestarts": 3 + } +} diff --git a/src/amber_lsp/plugin_templates/plugin.json b/src/amber_lsp/plugin_templates/plugin.json new file mode 100644 index 0000000..b93aaf5 --- /dev/null +++ b/src/amber_lsp/plugin_templates/plugin.json @@ -0,0 +1,10 @@ +{ + "name": "amber-framework-lsp", + "version": "1.0.0", + "description": "Convention diagnostics for Amber V2 web framework projects.", + "author": { + "name": "Amber Framework" + }, + "homepage": "https://github.com/amberframework/amber", + "lspServers": "./.lsp.json" +} diff --git a/src/amber_lsp/project_context.cr b/src/amber_lsp/project_context.cr new file mode 100644 index 0000000..10b6d19 --- /dev/null +++ b/src/amber_lsp/project_context.cr @@ -0,0 +1,34 @@ +require "yaml" + +module AmberLSP + class ProjectContext + getter root_path : String + getter? amber_project : Bool + + def initialize(@root_path : String, @amber_project : Bool = false) + end + + def self.detect(root_path : String) : ProjectContext + shard_path = File.join(root_path, "shard.yml") + + unless File.exists?(shard_path) + return ProjectContext.new(root_path, amber_project: false) + end + + content = File.read(shard_path) + is_amber = has_amber_dependency?(content) + + ProjectContext.new(root_path, amber_project: is_amber) + end + + private def self.has_amber_dependency?(shard_content : String) : Bool + yaml = YAML.parse(shard_content) + dependencies = yaml["dependencies"]? + return false unless dependencies + + dependencies["amber"]? != nil + rescue YAML::ParseException + false + end + end +end diff --git a/src/amber_lsp/rules/base_rule.cr b/src/amber_lsp/rules/base_rule.cr new file mode 100644 index 0000000..4e98963 --- /dev/null +++ b/src/amber_lsp/rules/base_rule.cr @@ -0,0 +1,42 @@ +module AmberLSP::Rules + abstract class BaseRule + abstract def id : String + abstract def description : String + abstract def default_severity : Severity + abstract def applies_to : Array(String) + abstract def check(file_path : String, content : String) : Array(Diagnostic) + + # Finds the line and character range for the first occurrence of a pattern. + # Returns nil if the pattern is not found. + def find_line_range(content : String, pattern : Regex) : TextRange? + content.each_line.with_index do |line, line_number| + match = pattern.match(line) + if match + start_char = match.begin(0) || 0 + end_char = match.end(0) || line.size + return TextRange.new( + Position.new(line_number.to_i32, start_char.to_i32), + Position.new(line_number.to_i32, end_char.to_i32) + ) + end + end + nil + end + + # Finds all line and character ranges for occurrences of a pattern. + def find_all_line_ranges(content : String, pattern : Regex) : Array(TextRange) + ranges = [] of TextRange + content.each_line.with_index do |line, line_number| + line.scan(pattern) do |match| + start_char = match.begin(0) || 0 + end_char = match.end(0) || line.size + ranges << TextRange.new( + Position.new(line_number.to_i32, start_char.to_i32), + Position.new(line_number.to_i32, end_char.to_i32) + ) + end + end + ranges + end + end +end diff --git a/src/amber_lsp/rules/channels/handle_message_rule.cr b/src/amber_lsp/rules/channels/handle_message_rule.cr new file mode 100644 index 0000000..b5219fb --- /dev/null +++ b/src/amber_lsp/rules/channels/handle_message_rule.cr @@ -0,0 +1,58 @@ +module AmberLSP::Rules::Channels + class HandleMessageRule < AmberLSP::Rules::BaseRule + def id : String + "amber/channel-handle-message" + end + + def description : String + "Non-abstract channel classes inheriting Amber::WebSockets::Channel must define handle_message" + end + + def default_severity : AmberLSP::Rules::Severity + Severity::Error + end + + def applies_to : Array(String) + ["src/channels/*"] + end + + def check(file_path : String, content : String) : Array(Diagnostic) + return [] of Diagnostic unless file_path.includes?("channels/") + + diagnostics = [] of Diagnostic + class_pattern = /^\s*class\s+(\w+)\s*<\s*Amber::WebSockets::Channel/ + abstract_class_pattern = /^\s*abstract\s+class\s+\w+/ + handle_message_pattern = /^\s+def\s+handle_message\b/ + + has_handle_message = content.lines.any? { |line| handle_message_pattern.matches?(line) } + + content.each_line.with_index do |line, line_number| + # Skip abstract classes + next if abstract_class_pattern.matches?(line) + + match = class_pattern.match(line) + next unless match + + unless has_handle_message + class_name = match[1] + start_char = (match.begin(1) || 0).to_i32 + end_char = (match.end(1) || line.size).to_i32 + + diagnostics << Diagnostic.new( + range: TextRange.new( + Position.new(line_number.to_i32, start_char), + Position.new(line_number.to_i32, end_char) + ), + severity: default_severity, + code: id, + message: "Channel class '#{class_name}' must define a 'handle_message' method" + ) + end + end + + diagnostics + end + end +end + +AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Channels::HandleMessageRule.new) diff --git a/src/amber_lsp/rules/controllers/action_return_rule.cr b/src/amber_lsp/rules/controllers/action_return_rule.cr new file mode 100644 index 0000000..b09a090 --- /dev/null +++ b/src/amber_lsp/rules/controllers/action_return_rule.cr @@ -0,0 +1,99 @@ +module AmberLSP::Rules::Controllers + class ActionReturnRule < AmberLSP::Rules::BaseRule + RESPONSE_METHODS = ["render", "redirect_to", "redirect_back", "respond_with", "halt!"] + SKIPPED_METHODS = ["initialize", "before_action", "after_action", "before_filter", "after_filter"] + VISIBILITY_CHANGE = /^\s*(private|protected)\s*$/ + + def id : String + "amber/action-return-type" + end + + def description : String + "Public controller actions should call render, redirect_to, redirect_back, respond_with, or halt!" + end + + def default_severity : AmberLSP::Rules::Severity + Severity::Warning + end + + def applies_to : Array(String) + ["src/controllers/*"] + end + + def check(file_path : String, content : String) : Array(Diagnostic) + return [] of Diagnostic unless file_path.includes?("controllers/") + + diagnostics = [] of Diagnostic + lines = content.lines + + in_public_method = false + method_name = "" + method_line = 0 + method_start_char = 0 + method_end_char = 0 + method_indent = 0 + has_response_call = false + is_private_section = false + + lines.each_with_index do |line, line_number| + # Track visibility section changes + if VISIBILITY_CHANGE.matches?(line) + is_private_section = true + next + end + + # Detect method start at standard 2-space indent (methods inside a class) + method_match = /^(\s{2,4})def\s+(\w+)/.match(line) + if method_match && !in_public_method + indent = method_match[1].size + name = method_match[2] + + # Skip private/protected methods and special methods + next if is_private_section + next if SKIPPED_METHODS.includes?(name) + next if line.includes?("private def") || line.includes?("protected def") + + in_public_method = true + method_name = name + method_line = line_number + method_start_char = (method_match.begin(2) || 0).to_i32 + method_end_char = (method_match.end(2) || line.size).to_i32 + method_indent = indent + has_response_call = false + next + end + + if in_public_method + # Check for response method calls + if RESPONSE_METHODS.any? { |m| line.includes?(m) } + has_response_call = true + end + + # Detect method end at same or lesser indent level + end_match = /^(\s*)end\b/.match(line) + if end_match + end_indent = end_match[1].size + if end_indent <= method_indent + unless has_response_call + diagnostics << Diagnostic.new( + range: TextRange.new( + Position.new(method_line.to_i32, method_start_char), + Position.new(method_line.to_i32, method_end_char) + ), + severity: default_severity, + code: id, + message: "Action '#{method_name}' does not appear to call render, redirect_to, redirect_back, respond_with, or halt!" + ) + end + in_public_method = false + end + end + end + end + + diagnostics + end + end +end + +AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::ActionReturnRule.new) diff --git a/src/amber_lsp/rules/controllers/before_action_rule.cr b/src/amber_lsp/rules/controllers/before_action_rule.cr new file mode 100644 index 0000000..d0c0938 --- /dev/null +++ b/src/amber_lsp/rules/controllers/before_action_rule.cr @@ -0,0 +1,71 @@ +module AmberLSP::Rules::Controllers + class BeforeActionRule < AmberLSP::Rules::BaseRule + def id : String + "amber/filter-syntax" + end + + def description : String + "Detect Rails-style before_action :method_name and deprecated before_filter/after_filter syntax" + end + + def default_severity : AmberLSP::Rules::Severity + Severity::Error + end + + def applies_to : Array(String) + ["src/controllers/*"] + end + + def check(file_path : String, content : String) : Array(Diagnostic) + return [] of Diagnostic unless file_path.includes?("controllers/") + + diagnostics = [] of Diagnostic + + rails_action_pattern = /^\s*(before_action|after_action)\s+:(\w+)/ + deprecated_filter_pattern = /^\s*(before_filter|after_filter)\b/ + + content.each_line.with_index do |line, line_number| + # Check for Rails-style symbol syntax: before_action :method_name + rails_match = rails_action_pattern.match(line) + if rails_match + start_char = (rails_match.begin(0) || 0).to_i32 + end_char = (rails_match.end(0) || line.size).to_i32 + # Trim leading whitespace from the range start + actual_start = (rails_match.begin(1) || start_char).to_i32 + + diagnostics << Diagnostic.new( + range: TextRange.new( + Position.new(line_number.to_i32, actual_start), + Position.new(line_number.to_i32, end_char) + ), + severity: default_severity, + code: id, + message: "Rails-style '#{rails_match[1]} :#{rails_match[2]}' is not supported in Amber. Use 'before_action do ... end' block syntax instead." + ) + next + end + + # Check for deprecated filter syntax + filter_match = deprecated_filter_pattern.match(line) + if filter_match + start_char = (filter_match.begin(1) || 0).to_i32 + end_char = (filter_match.end(1) || line.size).to_i32 + + diagnostics << Diagnostic.new( + range: TextRange.new( + Position.new(line_number.to_i32, start_char), + Position.new(line_number.to_i32, end_char) + ), + severity: default_severity, + code: id, + message: "'#{filter_match[1]}' is deprecated. Use '#{filter_match[1].gsub("filter", "action")}' instead." + ) + end + end + + diagnostics + end + end +end + +AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::BeforeActionRule.new) diff --git a/src/amber_lsp/rules/controllers/inheritance_rule.cr b/src/amber_lsp/rules/controllers/inheritance_rule.cr new file mode 100644 index 0000000..dbb4ad8 --- /dev/null +++ b/src/amber_lsp/rules/controllers/inheritance_rule.cr @@ -0,0 +1,54 @@ +module AmberLSP::Rules::Controllers + class InheritanceRule < AmberLSP::Rules::BaseRule + VALID_BASE_CLASSES = ["ApplicationController", "Amber::Controller::Base"] + + def id : String + "amber/controller-inheritance" + end + + def description : String + "Controller classes must inherit from ApplicationController or Amber::Controller::Base" + end + + def default_severity : AmberLSP::Rules::Severity + Severity::Error + end + + def applies_to : Array(String) + ["src/controllers/*"] + end + + def check(file_path : String, content : String) : Array(Diagnostic) + return [] of Diagnostic unless file_path.includes?("controllers/") + return [] of Diagnostic if file_path.ends_with?("application_controller.cr") + + diagnostics = [] of Diagnostic + class_pattern = /^\s*class\s+\w+Controller\s*<\s*(\S+)/ + + content.each_line.with_index do |line, line_number| + match = class_pattern.match(line) + next unless match + + parent_class = match[1] + unless VALID_BASE_CLASSES.includes?(parent_class) + start_char = (match.begin(1) || 0).to_i32 + end_char = (match.end(1) || line.size).to_i32 + + diagnostics << Diagnostic.new( + range: TextRange.new( + Position.new(line_number.to_i32, start_char), + Position.new(line_number.to_i32, end_char) + ), + severity: default_severity, + code: id, + message: "Controller should inherit from ApplicationController or Amber::Controller::Base, found '#{parent_class}'" + ) + end + end + + diagnostics + end + end +end + +AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Controllers::InheritanceRule.new) diff --git a/src/amber_lsp/rules/controllers/naming_rule.cr b/src/amber_lsp/rules/controllers/naming_rule.cr new file mode 100644 index 0000000..b203cc5 --- /dev/null +++ b/src/amber_lsp/rules/controllers/naming_rule.cr @@ -0,0 +1,51 @@ +module AmberLSP::Rules::Controllers + class NamingRule < AmberLSP::Rules::BaseRule + def id : String + "amber/controller-naming" + end + + def description : String + "Classes defined in controllers/ must have names ending in 'Controller'" + end + + def default_severity : AmberLSP::Rules::Severity + Severity::Error + end + + def applies_to : Array(String) + ["src/controllers/*"] + end + + def check(file_path : String, content : String) : Array(Diagnostic) + return [] of Diagnostic unless file_path.includes?("controllers/") + + diagnostics = [] of Diagnostic + class_pattern = /^\s*class\s+(\w+)\s* JSON::Any.new({ + "start" => JSON::Any.new({ + "line" => JSON::Any.new(@range.start.line.to_i64), + "character" => JSON::Any.new(@range.start.character.to_i64), + }), + "end" => JSON::Any.new({ + "line" => JSON::Any.new(@range.end.line.to_i64), + "character" => JSON::Any.new(@range.end.character.to_i64), + }), + }), + "severity" => JSON::Any.new(@severity.value.to_i64), + "code" => JSON::Any.new(@code), + "source" => JSON::Any.new(@source), + "message" => JSON::Any.new(@message), + } + end + end +end diff --git a/src/amber_lsp/rules/file_naming/directory_structure_rule.cr b/src/amber_lsp/rules/file_naming/directory_structure_rule.cr new file mode 100644 index 0000000..0c0ee51 --- /dev/null +++ b/src/amber_lsp/rules/file_naming/directory_structure_rule.cr @@ -0,0 +1,59 @@ +module AmberLSP::Rules::FileNaming + class DirectoryStructureRule < AmberLSP::Rules::BaseRule + LOCATION_RULES = [ + {pattern: /^\s*class\s+\w+Controller\s* spec/controllers/posts_controller_spec.cr + spec_path = file_path + .sub("src/controllers/", "spec/controllers/") + .sub(/\.cr$/, "_spec.cr") + + unless File.exists?(spec_path) + diagnostics << Diagnostic.new( + range: TextRange.new( + Position.new(0_i32, 0_i32), + Position.new(0_i32, 0_i32) + ), + severity: default_severity, + code: id, + message: "Missing spec file: expected '#{spec_path}' to exist" + ) + end + + diagnostics + end + end +end + +AmberLSP::Rules::RuleRegistry.register(AmberLSP::Rules::Specs::SpecExistenceRule.new) diff --git a/src/amber_lsp/server.cr b/src/amber_lsp/server.cr new file mode 100644 index 0000000..457f3ca --- /dev/null +++ b/src/amber_lsp/server.cr @@ -0,0 +1,63 @@ +module AmberLSP + class Server + getter controller : Controller + + def initialize(@input : IO, @output : IO) + @running = false + @controller = Controller.new + end + + def run : Nil + @running = true + + while @running + raw_message = read_message + break if raw_message.nil? + + response = @controller.handle(raw_message, self) + write_message(response) if response + end + end + + def stop : Nil + @running = false + end + + def write_notification(json : String) : Nil + write_message(json) + end + + private def read_message : String? + content_length = -1 + + loop do + line = @input.gets + return nil if line.nil? + + line = line.chomp + break if line.empty? + + if line.starts_with?("Content-Length:") + content_length = line.split(":")[1].strip.to_i + end + end + + return nil if content_length < 0 + + body = Bytes.new(content_length) + bytes_read = @input.read_fully(body) + return nil if bytes_read == 0 + + String.new(body) + rescue IO::EOFError + nil + end + + private def write_message(json : String) : Nil + header = "Content-Length: #{json.bytesize}\r\n\r\n" + @output.print(header) + @output.print(json) + @output.flush + end + end +end diff --git a/src/amber_lsp/version.cr b/src/amber_lsp/version.cr new file mode 100644 index 0000000..3767460 --- /dev/null +++ b/src/amber_lsp/version.cr @@ -0,0 +1,3 @@ +module AmberLSP + VERSION = "1.0.0" +end