captive-stack-detector 0.9.2 → 0.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 390061bda035fdc2b686a8fa5b9cffd1df43bfec160ea01147444f7f07d2526d
-  data.tar.gz: 71c351bbf691e952d2aa5972e2a9c22d27caf5fdca2da4bcffe07188a8293e56
+  metadata.gz: b90c2a1855bd23b857f4f142a0c674795992d33a98512e4b7a1cbcfb7db5df7f
+  data.tar.gz: 49a6d7ae837f68ed2e0995fcb8623249ceb93168ddac120108c5b032c93afff5
 SHA512:
-  metadata.gz: fe04ff00ac23c390404eb2176fded572115311cf81f023f04c6cf2c4d0bfe8273186491151e73e1e252f7f57e7601c24f94949aae55edb3fcedcbd03991e8f00
-  data.tar.gz: '08fa5dd4dc07f8b6026b581a3259ba07dbbd66cad39ec08696235dc48fe28f800ddd87c3505782e5db7ba9eeb0f46e441acf91d08c87a0945208a61c4d48d836'
+  metadata.gz: d430ba6a7b0077093dff4a48d756b106e5f47c64f8fe981d7fbf18c5c0c89035ff8dd045e6b2da56d9705f607ab0d0a626e67247f72aa51771fb4c1b5b972c1f
+  data.tar.gz: a89e85828b1be7b804c4ef860ddc7664a3354e8c78c719714c3cd16229a0eca4d85f1084d3be6248d16a5f706d8e87d7b0a83642c2551390c90d04db75ad50e9

data/docs/stacks.md

@@ -112,13 +112,26 @@ Ces variables sont lues **au build** : après en avoir changé une, redéployez.
 
 ### Site statique sans build
 
-Condition : ni `Gemfile` ni `package.json` à la racine, mais un `public/index.html` ou un `index.html` à la racine. Rien n'est installé ni buildé : vos fichiers sont servis tels quels.
+Condition : pas de `Gemfile` à la racine, mais un `public/index.html` ou un `index.html` à la racine. Un `package.json` est accepté s'il ne sert qu'à l'outillage (Supabase CLI, prettier…) : sans dépendance `expo` ni script `start` ou `build`. Rien n'est installé ni buildé : vos fichiers sont servis tels quels.
 
 - Si `public/` existe, seul ce dossier est servi.
 - Sinon la racine est servie, limitée aux fichiers web (HTML, JavaScript, CSS, JSON, images, polices, manifeste, texte). Les dossiers cachés (`.git/`, `.github/`), `supabase/`, vos scripts SQL ou votre documentation ne sont jamais publiés.
 - Un dossier `supabase/` avec son `config.toml` provisionne un backend Supabase et sa base Postgres.
 - Faute de build, aucune variable n'est injectée : votre code lit directement l'adresse de l'API, par exemple `location.origin`.
 
+## Options Supabase recommandées
+
+Avec un backend Supabase (application Node ou site statique), Captive lit votre code et vous recommande les options de l'add-on dont il a besoin, chacune avec sa raison (par exemple « votre code appelle signUp »). Une recommandation ne s'active pas seule : vous la retrouvez dans le dashboard au moment de la création.
+
+| Option | Recommandée quand |
+| --- | --- |
+| `smtp` | votre JavaScript ou TypeScript appelle `signUp`, `resetPasswordForEmail`, `signInWithOtp`, `inviteUserByEmail` ou `updateUser({ email })` : Supabase doit envoyer un email. Une connexion par `signInWithPassword` ou la double authentification (`auth.mfa`) n'en envoie pas. |
+| `realtime` | votre code s'abonne à un canal (`.channel(`) ou aux changements de la base (`postgres_changes`). |
+| `pg_cron` | un fichier `.sql` du dépôt (dont `supabase/migrations/` et `db/`) appelle `cron.schedule`, ou `net.http_` (pg_net est livré avec pg_cron). |
+| `vault` | un fichier `.sql` utilise le coffre Supabase (`vault.create_secret`, `vault.decrypted_secrets`…). |
+
+Les dépendances (`node_modules/`), sorties de build, tests et fichiers vendored sont ignorés, comme pour les variables. L'analyse est statique : un appel construit dynamiquement n'est pas vu ; activez alors l'option vous-même.
+
 ## Expo
 
 Condition : un `package.json` à la racine avec la dépendance `expo` (dans `dependencies` ou `devDependencies`). Aucun script n'est exigé.
@@ -137,6 +150,6 @@ Condition : un `package.json` à la racine avec la dépendance `expo` (dans `dep
 | --- | --- | --- |
 | Aucun Gemfile ni package.json à la racine du dépôt. | Pas de fichier de dépendances ni d'`index.html` à la racine. | Vérifiez que l'application est bien à la racine du dépôt, pas dans un sous-dossier (`app/`, `frontend/`…). Les monorepos ne sont pas pris en charge. |
 | Gemfile trouvé, mais sans la gem rails. | Application Ruby non Rails (Sinatra, Hanami…), ou `Gemfile` d'outillage dans un projet JavaScript. | Seul Rails est pris en charge côté Ruby. Si le `Gemfile` ne sert qu'à de l'outillage, retirez-le du dépôt. |
-| package.json trouvé, mais sans dépendance expo ni script start ou build. | Captive ne sait pas comment construire l'application. | Ajoutez un script `build` (application web) ou `start` (serveur), comme dans les exemples ci-dessus. |
+| package.json trouvé, mais sans dépendance expo ni script start ou build. | Captive ne sait pas comment construire l'application, et aucun `index.html` ne permet de la servir telle quelle. | Ajoutez un script `build` (application web) ou `start` (serveur), comme dans les exemples ci-dessus, ou un `index.html` pour un site statique. |
 
 Si votre stack n'est pas listée ici, contactez l'équipe Captive.

data/lib/captive_stack_detector/addon_recommender.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "recommendation_rule"
+require_relative "repo_sources"
+
+module CaptiveStackDetector
+  # Propose les options de l'add-on Supabase que le code du dépôt utilise, chacune avec sa raison.
+  class AddonRecommender
+    # Appels d'auth qui envoient un email ; signInWithPassword et auth.mfa n'en envoient pas.
+    AUTH_EMAILS = /
+      \b(?<call>signUp|resetPasswordForEmail|signInWithOtp|inviteUserByEmail)\(
+      | \b(?<call>updateUser)\(\s*\{\s*email\b
+    /x
+    RULES = [
+      RecommendationRule.new("smtp", :js, AUTH_EMAILS),
+      RecommendationRule.new("realtime", :js, /\.(?<call>channel)\(|(?<call>postgres_changes)/),
+      RecommendationRule.new("pg_cron", :sql, /\b(?<call>cron\.schedule|net\.http_)/),
+      RecommendationRule.new("vault", :sql, /\b(?<call>vault)\./),
+    ].freeze
+
+    def initialize(reader)
+      @reader = reader
+    end
+
+    # Seul Supabase a des options : les autres stacks gardent recommendations vide, sans lire les sources.
+    def apply(result)
+      return result unless result.services.backend == "supabase"
+
+      sources = RepoSources.new(@reader)
+      result.with(recommendations: RULES.filter_map { |rule| rule.recommend(sources) })
+    end
+  end
+end

data/lib/captive_stack_detector/js_stack_detector.rb

@@ -11,6 +11,8 @@ module CaptiveStackDetector
       @analyzer = PackageJsonAnalyzer.new(package_json)
     end
 
+    def entry? = !@analyzer.type.nil?
+
     def detect
       type = @analyzer.type
       raise UnsupportedStack, :no_node_entry unless type

data/lib/captive_stack_detector/rails_stack_detector.rb

@@ -20,7 +20,7 @@ module CaptiveStackDetector
         subtype:         @analyzer.subtype,
         services:        Services.new(database: @analyzer.database, queue: @analyzer.queue, backend: nil),
         worker:          build_worker,
-        runtime:         Runtime.new(ruby: @reader.ruby_version, node: nil),
+        runtime:         Runtime.new(ruby: @reader.ruby_version, node: @reader.node_version),
         env_vars:        @reader.env_vars,
         system_packages: system_packages,
       )

data/lib/captive_stack_detector/recommendation_rule.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "types"
+
+module CaptiveStackDetector
+  # Une option d'add-on et les appels qui la justifient ; le groupe nommé call est l'appel cité dans la raison.
+  class RecommendationRule < Data.define(:option, :kind, :pattern)
+    LABELS = { js: "votre code", sql: "votre SQL" }.freeze
+
+    def recommend(sources)
+      call = pattern.match(sources.of(kind))&.[](:call)
+      call && Recommendation.new(addon: "supabase", option: option, reason: "#{LABELS.fetch(kind)} appelle #{call}")
+    end
+  end
+end

data/lib/captive_stack_detector/repo_sources.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "js_env_files"
+
+module CaptiveStackDetector
+  # Contenu des sources JS et SQL du dépôt, hors dépendances, builds et tests (mêmes exclusions que JsEnvFiles).
+  class RepoSources
+    def self.kind(path)
+      return nil if JsEnvFiles::EXCLUDED.match?(path)
+      return :sql if path.end_with?(".sql")
+
+      :js if JsEnvFiles::SOURCE.match?(path)
+    end
+
+    def initialize(reader)
+      @reader = reader
+      @paths  = reader.list(".").sort.map { |entry| entry.delete_prefix("./") }.group_by { |path| self.class.kind(path) }
+    end
+
+    # Tout le code d'un genre (:js ou :sql), fichier par fichier, en un seul texte.
+    def of(kind) = @paths.fetch(kind, []).map { |path| @reader.read(path).to_s }.join("\n")
+  end
+end

data/lib/captive_stack_detector/stack_router.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "types"
+require_relative "gemfile_analyzer"
+require_relative "rails_stack_detector"
+require_relative "js_stack_detector"
+require_relative "static_site_detector"
+
+module CaptiveStackDetector
+  # Aiguille un dépôt vers le détecteur de sa stack, d'après ses manifestes à la racine.
+  class StackRouter
+    def initialize(reader)
+      @reader = reader
+    end
+
+    def detect
+      gemfile      = @reader.read("Gemfile")
+      package_json = @reader.read("package.json")
+
+      return RailsStackDetector.new(@reader, GemfileAnalyzer.new(gemfile)).detect if gemfile
+
+      static_site = StaticSiteDetector.new(@reader)
+      # Un package.json sans point d'entrée (Supabase CLI, prettier…) n'est que de l'outillage :
+      # un index.html présent reste servi tel quel au lieu d'un refus no_node_entry.
+      js = package_json && JsStackDetector.new(@reader, package_json)
+      return js.detect if js && (js.entry? || !static_site.site?)
+      raise UnsupportedStack, :no_manifest unless static_site.site?
+
+      static_site.detect
+    end
+  end
+end

data/lib/captive_stack_detector/types.rb

@@ -4,12 +4,14 @@ module CaptiveStackDetector
   Services = Data.define(:database, :queue, :backend)
   Worker   = Data.define(:command)
   Runtime  = Data.define(:ruby, :node)
+  # Option d'add-on que la détection propose d'activer, avec sa raison lisible par le client.
+  Recommendation = Data.define(:addon, :option, :reason)
   # public_env_prefix : préfixe des variables que le bundler expose au navigateur
   # (VITE_, NEXT_PUBLIC_, EXPO_PUBLIC_), nil sans bundler front (PackageJsonAnalyzer).
   Result   = Data.define(:type, :subtype, :services, :worker, :runtime, :env_vars, :system_packages,
-                         :public_env_prefix) do
+                         :public_env_prefix, :recommendations) do
     # env_vars : { "NOM" => valeur }, fusionné par captive-admin au provisionnement.
-    def initialize(env_vars:, public_env_prefix: nil, **)
+    def initialize(env_vars:, public_env_prefix: nil, recommendations: [], **)
       Hash.try_convert(env_vars) or raise ArgumentError, "env_vars doit être un Hash"
       super
     end

data/lib/captive_stack_detector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CaptiveStackDetector
-  VERSION = "0.9.2"
+  VERSION = "0.12.4"
 end

data/lib/captive_stack_detector.rb

@@ -3,11 +3,10 @@
 require "json"
 require_relative "captive_stack_detector/types"
 require_relative "captive_stack_detector/file_reader"
-require_relative "captive_stack_detector/gemfile_analyzer"
-require_relative "captive_stack_detector/rails_stack_detector"
-require_relative "captive_stack_detector/js_stack_detector"
-require_relative "captive_stack_detector/static_site_detector"
+require_relative "captive_stack_detector/stack_router"
+require_relative "captive_stack_detector/addon_recommender"
 
+# Déduit d'un dépôt sa stack, ses services et les options d'add-on à recommander.
 module CaptiveStackDetector
   # Doc publique des stacks supportées, livrée dans la gem et affichée par le dashboard (ADR 0003).
   DOC_PATH = File.expand_path("../docs/stacks.md", __dir__)
@@ -18,16 +17,7 @@ module CaptiveStackDetector
   end
 
   def self.detect_from(reader)
-    gemfile      = reader.read("Gemfile")
-    package_json = reader.read("package.json")
-
-    return RailsStackDetector.new(reader, GemfileAnalyzer.new(gemfile)).detect if gemfile
-    return JsStackDetector.new(reader, package_json).detect                    if package_json
-
-    static_site = StaticSiteDetector.new(reader)
-    raise UnsupportedStack, :no_manifest unless static_site.site?
-
-    static_site.detect
+    AddonRecommender.new(reader).apply(StackRouter.new(reader).detect)
   end
   private_class_method :detect_from
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: captive-stack-detector
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.12.4
 platform: ruby
 authors:
 - Captive Studio
@@ -20,6 +20,7 @@ files:
 - docs/stacks.md
 - lib/captive/stack/detector.rb
 - lib/captive_stack_detector.rb
+- lib/captive_stack_detector/addon_recommender.rb
 - lib/captive_stack_detector/aptfile_parser.rb
 - lib/captive_stack_detector/env_template_scanner.rb
 - lib/captive_stack_detector/env_vars_scanner.rb
@@ -38,11 +39,14 @@ files:
 - lib/captive_stack_detector/node_version_detector.rb
 - lib/captive_stack_detector/package_json_analyzer.rb
 - lib/captive_stack_detector/rails_stack_detector.rb
+- lib/captive_stack_detector/recommendation_rule.rb
 - lib/captive_stack_detector/recurring_schedule.rb
+- lib/captive_stack_detector/repo_sources.rb
 - lib/captive_stack_detector/ruby_version_detector.rb
 - lib/captive_stack_detector/solid_queue_usage.rb
 - lib/captive_stack_detector/solid_queue_worker.rb
 - lib/captive_stack_detector/ssr_framework_detector.rb
+- lib/captive_stack_detector/stack_router.rb
 - lib/captive_stack_detector/static_site_detector.rb
 - lib/captive_stack_detector/system_package_detector.rb
 - lib/captive_stack_detector/types.rb