better_auth-cli 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f43bdbfe1ccede48e41d7ea7ff77f974ad177daec7f1b3e41925009a638d23d
+  data.tar.gz: aadb7a3c1aee35097385d9e9a27c437312d3c38673bd8c70ff74b4e2292459ec
+SHA512:
+  metadata.gz: ee5873d758ffdb11eabf209cc80de5052929035775493fb9e46bf981260ba360877aa52b763ed39ff9c0266b80cecdec42517078fa8d0d30f5d63fc57a03c9d0
+  data.tar.gz: b2b28e050690c78559ac01ae3235b02a7509d018c6583dc87fc899a44b54af0a8d4234e1e31b283c23803b1a8abb384adf8e8e2c4dea29e72bc0e2f5651de1db

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.10.0
+
+- Improved CLI error handling and expanded command coverage.
+
+## 0.9.0
+
+- Initial Better Auth CLI package with `better-auth generate`, `better-auth migrate`, `better-auth migrate status`, `better-auth doctor`, and `better-auth mongo indexes`.

data/README.md

@@ -0,0 +1,19 @@
+# better_auth-cli
+
+Command-line tools for Better Auth Ruby.
+
+```bash
+better-auth generate --config config/better_auth.rb --dialect postgres --output db/better_auth/schema.sql
+better-auth migrate --config config/better_auth.rb --yes
+better-auth migrate status --config config/better_auth.rb
+better-auth doctor --config config/better_auth.rb
+better-auth mongo indexes --config config/better_auth.rb
+```
+
+The config file should return a `Hash` or `BetterAuth::Configuration`.
+`doctor` validates the config, secret strength, HTTPS base URL, rate-limit
+storage, SQL adapter support, and pending Better Auth migrations.
+`mongo indexes` is for MongoDB adapters and idempotently ensures the indexes
+declared by the active Better Auth schema.
+
+Install `openauth-cli` for the `openauth` executable alias.

data/exe/better-auth

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "better_auth/cli"
+
+exit BetterAuth::CLI.run(ARGV)

data/lib/better_auth/cli/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BetterAuth
+  class CLI
+    VERSION = "0.10.0"
+  end
+end

data/lib/better_auth/cli.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+require "better_auth"
+require "better_auth/cli/version"
+require "better_auth/doctor"
+require "better_auth/sql_migration"
+require "fileutils"
+require "optparse"
+
+module BetterAuth
+  class CLI
+    class Error < StandardError; end
+
+    class << self
+      attr_accessor :configuration
+
+      def configure(value = nil)
+        @configuration = block_given? ? yield : value
+      end
+
+      def run(argv = ARGV, stdout: $stdout, stderr: $stderr)
+        new(argv, stdout: stdout, stderr: stderr).run
+      rescue Error, BetterAuth::SQLMigration::UnsupportedAdapterError, BetterAuth::Error, OptionParser::ParseError => error
+        stderr.puts error.message
+        1
+      end
+    end
+
+    def initialize(argv, stdout:, stderr:)
+      @argv = argv.dup
+      @stdout = stdout
+      @stderr = stderr
+    end
+
+    def run
+      command = argv.shift
+      case command
+      when "generate"
+        generate(argv)
+      when "migrate"
+        migrate(argv)
+      when "doctor"
+        doctor(argv)
+      when "mongo"
+        mongo(argv)
+      when "-h", "--help", "help", nil
+        stdout.puts usage
+        0
+      else
+        raise Error, "Unknown command: #{command}"
+      end
+    end
+
+    private
+
+    attr_reader :argv, :stdout, :stderr
+
+    def generate(args)
+      options = parse_generate_options(args)
+      config = load_config(options.fetch(:config))
+      adapter = sql_adapter_for(config)
+      connection = adapter&.connection
+      dialect = BetterAuth::SQLMigration.normalize_dialect(options[:dialect] || adapter&.dialect || "postgres")
+      sql = if connection
+        BetterAuth::SQLMigration.render_pending(config, connection: connection, dialect: dialect, generator: "better_auth-cli")
+      else
+        BetterAuth::SQLMigration.render(config, dialect: dialect, generator: "better_auth-cli")
+      end
+
+      if sql.empty?
+        stdout.puts "No migrations needed."
+        return 0
+      end
+
+      output = options.fetch(:output)
+      FileUtils.mkdir_p(File.dirname(output))
+      File.write(output, sql)
+      stdout.puts "generated #{output}"
+      0
+    end
+
+    def migrate(args)
+      if args.first == "status"
+        args.shift
+        return migration_status(args)
+      end
+
+      options = parse_migrate_options(args)
+      raise Error, "Pass --yes to apply migrations." unless options[:yes]
+
+      auth = auth_for(load_config(options.fetch(:config)))
+      migrated = BetterAuth::SQLMigration.migrate_pending(auth)
+      stdout.puts(migrated ? "migration completed successfully." : "No migrations needed.")
+      0
+    end
+
+    def migration_status(args)
+      options = parse_config_options(args, "migrate status --config PATH is required")
+      config = load_config(options.fetch(:config))
+      adapter = required_sql_adapter_for(config)
+      plan = BetterAuth::SQLMigration.plan(config, connection: adapter.connection, dialect: adapter.dialect)
+
+      if plan.empty?
+        stdout.puts "No migrations needed."
+      else
+        plan.to_create.each { |change| stdout.puts "create table #{change.table_name}" }
+        plan.to_add.each { |change| stdout.puts "add #{change.fields.keys.join(", ")} to #{change.table_name}" }
+        plan.to_index.each { |change| stdout.puts "create index #{change.name}" }
+        plan.warnings.each { |warning| stdout.puts "warning: #{warning}" }
+      end
+      0
+    end
+
+    def doctor(args)
+      options = parse_config_options(args, "doctor --config PATH is required")
+      config = load_config(options.fetch(:config))
+      BetterAuth::Doctor.print(BetterAuth::Doctor.check(config), stdout: stdout, stderr: stderr)
+    end
+
+    def mongo(args)
+      command = args.shift
+      case command
+      when "indexes"
+        mongo_indexes(args)
+      else
+        raise Error, "Unknown mongo command: #{command || "(none)"}"
+      end
+    end
+
+    def mongo_indexes(args)
+      options = parse_config_options(args, "mongo indexes --config PATH is required")
+      auth = auth_for(load_config(options.fetch(:config)))
+      adapter = auth.context.adapter
+      unless adapter.respond_to?(:ensure_indexes!)
+        raise Error, "MongoDB index setup requires an adapter that supports ensure_indexes!"
+      end
+
+      indexes = adapter.ensure_indexes!
+      if indexes.empty?
+        stdout.puts "No MongoDB indexes needed."
+      else
+        indexes.each do |index|
+          validate_mongo_index!(index)
+          unique = index[:unique] ? " unique" : ""
+          stdout.puts "ensured#{unique} index #{index[:collection]}.#{index[:field]}"
+        end
+      end
+      0
+    end
+
+    def parse_generate_options(args)
+      options = {}
+      OptionParser.new do |parser|
+        parser.on("--config PATH") { |value| options[:config] = value }
+        parser.on("--dialect DIALECT") { |value| options[:dialect] = value }
+        parser.on("--output PATH") { |value| options[:output] = value }
+      end.parse!(args)
+      require_option!(options, :config, "generate --config PATH is required")
+      require_option!(options, :output, "generate --output PATH is required")
+      options
+    end
+
+    def parse_migrate_options(args)
+      options = {yes: false}
+      OptionParser.new do |parser|
+        parser.on("--config PATH") { |value| options[:config] = value }
+        parser.on("--yes", "-y") { options[:yes] = true }
+      end.parse!(args)
+      require_option!(options, :config, "migrate --config PATH is required")
+      options
+    end
+
+    def parse_config_options(args, missing_message)
+      options = {}
+      OptionParser.new do |parser|
+        parser.on("--config PATH") { |value| options[:config] = value }
+      end.parse!(args)
+      require_option!(options, :config, missing_message)
+      options
+    end
+
+    def require_option!(options, key, message)
+      raise Error, message unless options[key]
+    end
+
+    def load_config(path)
+      raise Error, "Config file not found: #{path}" unless File.exist?(path)
+
+      self.class.configure(nil)
+      result = TOPLEVEL_BINDING.eval(File.read(path), path)
+      value = normalize_config_value(result) || self.class.configuration
+      raise Error, "Config file must return a Hash, BetterAuth::Configuration, or BetterAuth::Auth" unless value
+
+      BetterAuth::SQLMigration.configuration_for(value)
+    end
+
+    def normalize_config_value(value)
+      value if value.is_a?(Hash) || value.is_a?(BetterAuth::Configuration) || value.is_a?(BetterAuth::Auth)
+    end
+
+    def validate_mongo_index!(index)
+      return if index[:collection] && index[:field]
+
+      raise Error, "MongoDB index metadata must include collection and field"
+    end
+
+    def sql_adapter_for(config)
+      required_sql_adapter_for(config)
+    rescue BetterAuth::SQLMigration::UnsupportedAdapterError
+      nil
+    end
+
+    def required_sql_adapter_for(config)
+      adapter = auth_for(config).context.adapter
+      unless adapter.respond_to?(:dialect) && adapter.respond_to?(:connection)
+        raise BetterAuth::SQLMigration::UnsupportedAdapterError,
+          "Better Auth SQL migrations require core SQL adapters with connection and dialect support"
+      end
+
+      adapter
+    end
+
+    def auth_for(config)
+      return config if config.is_a?(BetterAuth::Auth)
+
+      BetterAuth.auth(config.to_h)
+    end
+
+    def usage
+      <<~TEXT
+        Usage:
+          better-auth generate --config PATH --dialect DIALECT --output PATH
+          better-auth migrate --config PATH --yes
+          better-auth migrate status --config PATH
+          better-auth doctor --config PATH
+          better-auth mongo indexes --config PATH
+      TEXT
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: better_auth-cli
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+platform: ruby
+authors:
+- Sebastian Sala
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: better_auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Generates and applies Better Auth Ruby database migrations from app configuration.
+email:
+- sebastian.sala.tech@gmail.com
+executables:
+- better-auth
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- exe/better-auth
+- lib/better_auth/cli.rb
+- lib/better_auth/cli/version.rb
+homepage: https://github.com/sebasxsala/better-auth-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sebasxsala/better-auth-rb
+  source_code_uri: https://github.com/sebasxsala/better-auth-rb
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Command-line tools for Better Auth Ruby
+test_files: []