gemstack-cli 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 302c6d867a26dcdbf305cc2c4d54479bc3b5094b30dc7c79873882b5d6062598
-  data.tar.gz: f09ed00f2ac675747ab91c808a682b75c71be04193defc59755e7798c0dbfc49
+  metadata.gz: 9d9243d3986f9d45d5aa9de84f699ea7fcac37504ed266d7998e5a4eab6ff484
+  data.tar.gz: 6cf9300583fb65e103c7b71b48859721863766837180a362365639ec0186c5fc
 SHA512:
-  metadata.gz: 94dddfd035b6782455385e61a8306bcb46526e5979c43f43b4604cb133593713b0166528df8345ab6850f288c7f6118e75381a91c5729c9dcba2977e12819d81
-  data.tar.gz: cae54dd8b24e7ce6ba106570d858476992c6b11634e717e9ef2b79b1ac1d853ea3292bd32b96994a65e98cc22320bbc860d55d781843c289320cccc6902deaaa
+  metadata.gz: 54009542d20d3bcc5ae67e2b89e19965c285e32b6400ca43e7ecf22af1f2bc3a8303803c2c1708cc967f5c50fed4c159e7807e5f41bdb9da702c87f9cc4e8229
+  data.tar.gz: 0acb8e759970a5154f11fae58d530c960575849ec4f93018f46b9a8ef70f1d43cfac289c0606ae16508efd16f843ade368b0fa49777e15caacdb42e42e9db22a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.1
+
+See the [GemStack changelog](https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md).
+
 ## 0.2.0
 
 See the [GemStack changelog](https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md).

data/lib/gemstack/cli/add_generator.rb

@@ -70,6 +70,7 @@ module GemStack
 
       def add_storage
         add_gem("gemstack-storage")
+        ensure_base_classes(@root, :serializer)
         copy_feature_templates("storage")
         add_routes(%(post "/uploads", to: "uploads#create" # direct uploads (gemstack add storage)\n),
                    marker: "uploads#create")
@@ -94,6 +95,7 @@ module GemStack
         add_gem("gemstack-mail")
         add_gem("gemstack-auth")
         JobGenerator.install_migration(@root, output: @output) # emails are sent from background jobs
+        ensure_base_classes(@root, :model, :serializer, :mailer)
         copy_feature_templates("auth", skip_migration: "*_create_auth_tables.rb")
         include_in_application_controller("GemStack::Auth::Controller")
         add_routes(AUTH_ROUTES, marker: "/auth/login")

data/lib/gemstack/cli/app_generator.rb

@@ -54,7 +54,7 @@ module GemStack
         database_adapter if database? # fail early on an unknown --database
         @output.puts("Creating GemStack application #{name} in #{destination}")
         render_directory("app", destination, skip: lambda { |rel|
-          !database? && (rel.start_with?("db/") || rel == "config/database.yml.tt")
+          !database? && (rel.start_with?("db/", "app/models/") || rel == "config/database.yml.tt")
         })
         render_directory("frontend", File.join(destination, "frontend")) if frontend?
         install unless @options[:skip_install]
@@ -86,6 +86,8 @@ module GemStack
 
         run_step("npm install", File.join(destination, "frontend"), "npm", "install", "--no-fund",
                  "--no-audit")
+        # The TypeScript contract, so frontend/lib/api/generated exists from the start.
+        run_step("gemstack contract", destination, "bin/gemstack", "contract", "--quiet") if bundled
       end
 
       # Best effort: a missing or password-protected database server shouldn't fail `new`.

data/lib/gemstack/cli/deploy_generator.rb

@@ -18,8 +18,7 @@ module GemStack
       def jobs?
         return true if gemfile.match?(/^\s*gem "gemstack-auth"/)
 
-        gemfile.match?(/^\s*gem "gemstack-jobs"/) &&
-          %w[app/jobs/*.rb app/mailers/*.rb].any? { |glob| !Dir.glob(File.join(@root, glob)).empty? }
+        gemfile.match?(/^\s*gem "gemstack-jobs"/) && Generator.background_work?(@root)
       end
 
       def mail? = gemfile.match?(/^\s*gem "gemstack-(mail|auth)"/)

data/lib/gemstack/cli/doctor.rb

@@ -290,7 +290,7 @@ module GemStack
       end
 
       def jobs_used?
-        %w[app/jobs/*.rb app/mailers/*.rb].any? { |glob| !Dir.glob(path(glob)).empty? }
+        Generator.background_work?(@root)
       end
 
       def location(error)

data/lib/gemstack/cli/generator.rb

@@ -59,6 +59,28 @@ module GemStack
       end
 
       # Every template file for a generator, with app overrides applied.
+      # The app's base classes (written by `gemstack new` since 0.2.1). Apps
+      # created earlier get the ones a generator's code inherits from.
+      BASE_CLASSES = {
+        model: "app/models/application_model.rb", serializer: "app/serializers/application_serializer.rb",
+        job: "app/jobs/application_job.rb", mailer: "app/mailers/application_mailer.rb"
+      }.freeze
+
+      # Whether the app has jobs or mailers of its own (base classes don't count).
+      def self.background_work?(root)
+        %w[app/jobs/*.rb app/mailers/*.rb].any? do |glob|
+          Dir.glob(File.join(root, glob)).any? { |file| !File.basename(file).start_with?("application_") }
+        end
+      end
+
+      def ensure_base_classes(root, *kinds)
+        kinds.each do |kind|
+          rel = BASE_CLASSES.fetch(kind)
+          target = File.join(root, rel)
+          write(target, File.read(File.join(template_root("app"), rel))) unless File.exist?(target)
+        end
+      end
+
       def template_files(name, override_root: nil)
         files = relative_files(template_root(name)).to_h { |rel| [rel, File.join(template_root(name), rel)] }
         if override_root

data/lib/gemstack/cli/job_generator.rb

@@ -35,6 +35,7 @@ module GemStack
       end
 
       def run
+        ensure_base_classes(@root, :job)
         template_files("job", override_root: @root).each do |rel, source|
           target = File.join(@root, rel.delete_suffix(".tt").gsub("%file_name%", file_name))
           write(target, render(File.read(source), source))

data/lib/gemstack/cli/resource_generator.rb

@@ -34,6 +34,7 @@ module GemStack
       end
 
       def run
+        ensure_base_classes(@root, *(%i[model serializer] & @parts))
         @parts.each { |part| render_part(part) }
         add_routes if @parts.include?(:controller)
         self

data/templates/app/Gemfile.tt

@@ -14,6 +14,7 @@ path "<%= gemstack_path %>" do
   gem "gemstack-db"
 <% end -%>
   gem "gemstack-jobs"
+  gem "gemstack-mail"
   gem "gemstack-dev"
   gem "gemstack-http"
   gem "gemstack-schema"
@@ -24,6 +25,7 @@ gem "gemstack", "~> <%= version %>"
 gem "gemstack-db", "~> <%= version %>"
 <% end -%>
 gem "gemstack-jobs", "~> <%= version %>"
+gem "gemstack-mail", "~> <%= version %>"
 <% end -%>
 gem "puma", ">= 6.4"
 <% if database? -%>

data/templates/app/app/jobs/application_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# The base class for this app's background jobs (docs/background-jobs.md):
+# retry and discard rules declared here apply to every job.
+class ApplicationJob < GemStack::Job
+  # retry_on Net::ReadTimeout, attempts: 5, wait: 30   # seconds, :exponential or ->(attempt) { … }
+  # discard_on GemStack::NotFound                      # e.g. the record was deleted before the job ran
+  # queue :default
+end

data/templates/app/app/mailers/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# The base class for this app's mailers (docs/mail.md). Templates live in
+# app/mailers/templates/<mailer>/<action>.{text,html}.erb.
+class ApplicationMailer < GemStack::Mailer
+  # default from: "My App <hello@example.com>"          # otherwise config.mail.default_from (MAIL_FROM)
+  # default reply_to: "support@example.com"
+end

data/templates/app/app/models/application_model.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# The base class for this app's models — add plugins, validations and helpers
+# every model should share here. `class Product < ApplicationModel` maps to the
+# products table (docs/models.md).
+#
+# Created with Class.new on purpose: `class ApplicationModel < GemStack::Model`
+# would make Sequel look for an "application_models" table.
+ApplicationModel = Class.new(GemStack::Model) # rubocop:disable Style/EmptyClassDefinition
+
+class ApplicationModel
+  # Sequel plugins for every model, e.g.:
+  # plugin :dirty                                    # previous values after an update (column_changes)
+
+  # Shared query helpers:
+  # dataset_module do
+  #   def recent = order(Sequel.desc(:created_at))
+  # end
+end

data/templates/app/app/serializers/application_serializer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# The base class for this app's serializers (docs/serialization.md): attributes
+# and helpers defined here are shared by every serializer.
+class ApplicationSerializer < GemStack::Serializer
+end

data/templates/app/config/environments/development.rb.tt

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Development settings: applied after config/app.rb when GEMSTACK_ENV=development
+# (the default). Each line shows the default value — uncomment one to change it.
+# All settings: docs/configuration.md.
+GemStack.configure do |config|
+  # ── Code ────────────────────────────────────────────────────────────────
+  # config.reload_code = true                  # reload app/ and config/routes.rb when they change
+  # config.eager_load = false                  # load app/ lazily, for a faster boot
+  # config.jit = nil                           # :yjit or :zjit to try Ruby's JIT locally
+
+  # ── Logging ─────────────────────────────────────────────────────────────
+  # config.logger.level = :debug               # :debug, :info, :warn, :error (or GEMSTACK_LOG_LEVEL)
+  # config.logger.format = :pretty             # readable lines; :json to see what production logs
+
+  # ── HTTP ────────────────────────────────────────────────────────────────
+  # config.http.show_exceptions = true         # 500s carry the exception; browsers get an error page
+  # config.contract.docs = true                # interactive API docs at /api/docs
+
+  # ── gemstack dev ────────────────────────────────────────────────────────
+  # config.dev.port = 3000                     # the one public port (or PORT)
+  # config.dev.jobs_command = %w[bundle exec gemstack jobs]   # nil: don't start a jobs worker
+<% if database? -%>
+
+  # ── Database (connection: config/database.yml) ──────────────────────────
+  # config.db.log_queries = true               # every SQL statement at DEBUG
+  # config.db.slow_query_ms = 500              # slower queries are logged at WARN
+<% end -%>
+
+  # ── Cache ───────────────────────────────────────────────────────────────
+  # config.cache.store = :memory               # :null to switch caching off, :redis to share it
+
+  # ── Mail ────────────────────────────────────────────────────────────────
+  # config.mail.delivery = :log                # saved to tmp/mail (.eml + .html); :smtp really sends
+end

data/templates/app/config/environments/production.rb.tt

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Production settings: applied after config/app.rb when GEMSTACK_ENV=production.
+# Each line shows the default value — uncomment one to change it.
+#
+# Secrets and connections come from environment variables, never from files:
+# SECRET_KEY_BASE, <% if database? %>DATABASE_URL, <% end %>SMTP_URL, MAIL_FROM, APP_URL, REDIS_URL…
+# `gemstack doctor --production` checks what's missing (docs/deployment.md).
+GemStack.configure do |config|
+  # ── Code ────────────────────────────────────────────────────────────────
+  # config.eager_load = true                   # load all code at boot (copy-on-write friendly with Puma workers)
+  # config.jit = :yjit                         # Ruby's JIT (or GEMSTACK_JIT=yjit|zjit|off)
+
+  # ── Logging ─────────────────────────────────────────────────────────────
+  # config.logger.level = :info
+  # config.logger.format = :json               # one JSON object per line, with the request id
+
+  # ── HTTP ────────────────────────────────────────────────────────────────
+  # config.http.show_exceptions = false        # never send exception details to clients
+  # config.http.hsts = "max-age=63072000; includeSubDomains"   # on HTTPS requests; nil if your proxy sets it
+  # config.http.cors.origins = ["https://app.example.com"]    # only if the frontend is on another domain
+  # config.http.max_body_size = 10 * 1024 * 1024               # larger requests get 413
+<% if database? -%>
+
+  # ── Database ────────────────────────────────────────────────────────────
+  # config.db.pool_size = 5                    # connections per process (GEMSTACK_MAX_THREADS)
+  # config.db.statement_timeout = 5_000        # ms; stop runaway queries (PostgreSQL, MySQL)
+  # config.db.slow_query_ms = 500              # slower queries are logged at WARN
+<% end -%>
+
+  # ── Cache: :memory is per process — use Redis with several processes or servers ──
+  # config.cache.store = :redis                # add gem "redis-client"; REDIS_URL
+
+  # ── Background jobs (`gemstack jobs`) ───────────────────────────────────
+  # config.jobs.concurrency = 5                # threads per worker (or GEMSTACK_JOB_CONCURRENCY)
+
+  # ── Mail ────────────────────────────────────────────────────────────────
+  # config.mail.delivery = :smtp               # SMTP_URL=smtp://user:password@smtp.example.com:587
+  # config.mail.default_from = "App <hello@example.com>"      # or MAIL_FROM
+end

data/templates/app/config/environments/test.rb.tt

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Test settings: applied after config/app.rb when tests run (`gemstack test`).
+# Each line shows the default value — uncomment one to change it.
+GemStack.configure do |config|
+  # ── Logging ─────────────────────────────────────────────────────────────
+  # config.logger.level = :debug               # logs are discarded in tests unless this (or GEMSTACK_LOG_LEVEL) is set
+
+  # ── HTTP ────────────────────────────────────────────────────────────────
+  # config.http.show_exceptions = true         # a failing request's JSON includes the exception
+<% if database? -%>
+
+  # ── Database (connection: the test section of config/database.yml, or TEST_DATABASE_URL) ──
+  # config.db.log_queries = false
+<% end -%>
+
+  # ── Background work is recorded, not performed ──────────────────────────
+  # config.jobs.adapter = :test                # assert_enqueued / perform_enqueued_jobs; :inline runs jobs at once
+  # config.mail.delivery = :test               # assert_emails / last_email
+  # config.cache.store = :null                 # no caching, so tests can't leak into each other; :memory to test it
+end

data/templates/auth/app/mailers/auth_mailer.rb

@@ -2,7 +2,7 @@
 
 # Account emails. Templates: app/mailers/templates/auth_mailer/*.erb.
 # Links point at the Next.js pages (config.auth.app_url, APP_URL in production).
-class AuthMailer < GemStack::Mailer
+class AuthMailer < ApplicationMailer
   def password_reset(user_id)
     @user = User[user_id] or return
     token, = GemStack::Auth::Tokens.issue(@user.id, purpose: "password_reset")

data/templates/auth/app/models/auth_token.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # API tokens (and single-use reset/verification tokens) — see GemStack::Auth::Tokens.
-class AuthToken < GemStack::Model
+class AuthToken < ApplicationModel
   field :purpose, :string, null: false
   field :name, :string, size: 100
   field :last_used_at, :datetime

data/templates/auth/app/models/user.rb

@@ -2,7 +2,7 @@
 
 # Accounts. GemStack::Auth::User adds password hashing (Argon2id), email
 # normalization, validations and User.authenticate_by(email:, password:).
-class User < GemStack::Model
+class User < ApplicationModel
   include GemStack::Auth::User
 
   field :email, :string, null: false, size: 254

data/templates/auth/app/serializers/api_token_serializer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ApiTokenSerializer < GemStack::Serializer
+class ApiTokenSerializer < ApplicationSerializer
   model AuthToken
   attributes :id, :name, :last_used_at, :expires_at, :created_at
 end

data/templates/auth/app/serializers/new_api_token_serializer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # The response to creating an API token: the only time the token itself is shown.
-class NewApiTokenSerializer < GemStack::Serializer
+class NewApiTokenSerializer < ApplicationSerializer
   Result = Data.define(:token, :api_token)
 
   attribute :token, :string

data/templates/auth/app/serializers/user_serializer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # What the API shows about the signed-in user. Never add password_digest.
-class UserSerializer < GemStack::Serializer
+class UserSerializer < ApplicationSerializer
   attributes :id, :email, :email_verified_at, :created_at
 end

data/templates/job/app/jobs/%file_name%.rb.tt

@@ -2,7 +2,7 @@
 
 # Enqueue with <%= class_name %>.perform_later(...) — arguments must be JSON values (pass ids, not records).
 # Runs in `gemstack jobs` (and in `gemstack dev`). Delivery is at-least-once: keep perform idempotent.
-class <%= class_name %> < GemStack::Job
+class <%= class_name %> < ApplicationJob
 <% if queue_name -%>
   queue :<%= queue_name %>
 <% end -%>

data/templates/resource/model/app/models/%file_name%.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class <%= class_name %> < GemStack::Model
+class <%= class_name %> < ApplicationModel
 <% fields.each do |field| -%>
   <%= model_field(field) %>
 <% end -%>

data/templates/resource/serializer/app/serializers/%file_name%_serializer.rb.tt

@@ -2,6 +2,6 @@
 
 # What the API returns for a <%= class_name %>. Only listed attributes are exposed;
 # their types (from <%= class_name %>'s fields) drive the generated TypeScript types.
-class <%= class_name %>Serializer < GemStack::Serializer
+class <%= class_name %>Serializer < ApplicationSerializer
   attributes :id, <%= fields.map { |f| ":#{f.column}" }.join(", ") %>, :created_at, :updated_at
 end

data/templates/storage/app/serializers/upload_serializer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Where and how the browser sends the file (see UploadsController).
-class UploadSerializer < GemStack::Serializer
+class UploadSerializer < ApplicationSerializer
   Result = Data.define(:signed_id, :url, :http_method, :headers)
 
   attribute :signed_id, :string

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemstack-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Shoaib Malik
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: gemstack-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -80,13 +80,18 @@ files:
 - templates/app/Gemfile.tt
 - templates/app/README.md.tt
 - templates/app/app/controllers/application_controller.rb
+- templates/app/app/jobs/application_job.rb
+- templates/app/app/mailers/application_mailer.rb
+- templates/app/app/mailers/templates/dot_keep
+- templates/app/app/models/application_model.rb
+- templates/app/app/serializers/application_serializer.rb
 - templates/app/bin/gemstack
 - templates/app/config.ru
 - templates/app/config/app.rb.tt
 - templates/app/config/database.yml.tt
-- templates/app/config/environments/development.rb
-- templates/app/config/environments/production.rb
-- templates/app/config/environments/test.rb
+- templates/app/config/environments/development.rb.tt
+- templates/app/config/environments/production.rb.tt
+- templates/app/config/environments/test.rb.tt
 - templates/app/config/puma.rb
 - templates/app/config/routes.rb
 - templates/app/db/migrations/dot_keep

data/templates/app/config/environments/development.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-# Development-only settings. config/app.rb applies to every environment.
-GemStack.configure do |config|
-  # config.http.show_exceptions = true   # exception details in 500 responses (default in development)
-end

data/templates/app/config/environments/production.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-# Production-only settings. Defaults here: JSON logs, no exception details in
-# responses, eager loading, HSTS on HTTPS requests.
-GemStack.configure do |config|
-  # config.logger.level = :info
-  # config.http.cors.origins = ["https://app.example.com"]   # only if the frontend is on another domain
-end

data/templates/app/config/environments/test.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-# Test-only settings. config/app.rb applies to every environment.
-GemStack.configure do |config|
-  # Logs are discarded in tests unless GEMSTACK_LOG_LEVEL is set, e.g.:
-  # config.logger.level = :debug
-end