Add marten seed command (#266)

* Add seed command

* Fix findings

docs/docs/development/management-commands.md

@@ -56,6 +56,7 @@ Available commands:
   › play             Start a Crystal playground server initialized for the current project.
   › resetmigrations  Reset an existing set of migrations into a single one.
   › routes           Display all the routes of the application.
+  › seed             Populate the database by running the seed file.
   › serve / s        Start a development server that is automatically recompiled when source files change.
   › version          Show the Marten version.
 

docs/docs/development/reference/management-commands.md

@@ -230,6 +230,16 @@ marten resetmigrations foo # Resets the migrations of the "foo" application
 
 Displays all the routes of the application.
 
+## `seed`
+
+**Usage:** `marten seed [options]`
+
+Populate the database by running the seed file.
+
+### Options
+
+* `-f PATH, --file=PATH` - Specify a custom path to the seed file
+
 ## `serve`
 
 **Usage:** `marten serve [options]`

spec/marten/cli/manage/command/new_spec.cr

@@ -482,6 +482,7 @@ module Marten::CLI::Manage::Command::NewSpec
     "src/templates/base.html",
     ".editorconfig",
     ".gitignore",
+    "seed.cr",
     "manage.cr",
     "shard.yml",
   ]

spec/marten/cli/manage/command/seed_spec.cr

@@ -0,0 +1,90 @@
+require "./spec_helper"
+
+describe Marten::CLI::Manage::Command::Seed do
+  after_each do
+    File.delete("./seed.cr") if File.exists?("./seed.cr")
+  end
+
+  describe "#run" do
+    it "runs the default seed file when no custom path is provided" do
+      stdout = IO::Memory.new
+      stderr = IO::Memory.new
+
+      # Create a mock seed file to simulate seeding
+      message = "Seeding..."
+      File.write("./seed.cr", "puts \"#{message}\"")
+
+      command = Marten::CLI::Manage::Command::Seed.new(
+        options: [] of String,
+        stdout: stdout,
+        stderr: stderr
+      )
+
+      command.handle
+      output = stdout.rewind.gets_to_end
+
+      output.includes?("Running seed file at ./seed.cr").should be_true
+      output.includes?(message).should be_true
+      stderr.rewind.gets_to_end.empty?.should be_true
+    end
+
+    it "runs the seed file from a custom path when provided" do
+      stdout = IO::Memory.new
+      stderr = IO::Memory.new
+
+      custom_seed_path = "./custom_seed.cr"
+      message = "Custom seeding..."
+      File.write(custom_seed_path, "puts \"#{message}\"")
+
+      command = Marten::CLI::Manage::Command::Seed.new(
+        options: ["--file", custom_seed_path],
+        stdout: stdout,
+        stderr: stderr
+      )
+
+      command.handle
+
+      output = stdout.rewind.gets_to_end
+
+      File.delete(custom_seed_path) if File.exists?(custom_seed_path)
+
+      output.includes?("Running seed file at #{custom_seed_path}").should be_true
+      output.includes?(message).should be_true
+      stderr.rewind.gets_to_end.empty?.should be_true
+    end
+
+    it "prints an error if no seed file was found" do
+      stdout = IO::Memory.new
+      stderr = IO::Memory.new
+
+      command = Marten::CLI::Manage::Command::Seed.new(
+        options: [] of String,
+        stdout: stdout,
+        stderr: stderr
+      )
+
+      command.handle
+
+      stdout.rewind.gets_to_end.includes?("Seed file not found at ./seed.cr").should be_true
+    end
+
+    it "handles errors if the seed file fails to run" do
+      stdout = IO::Memory.new
+      stderr = IO::Memory.new
+
+      # Create a seed file with invalid content
+      File.write("./seed.cr", "invalid_crystal_code")
+
+      command = Marten::CLI::Manage::Command::Seed.new(
+        options: [] of String,
+        stdout: stdout,
+        stderr: stderr
+      )
+
+      command.handle
+
+      output = stderr.rewind.gets_to_end
+      output.includes?("Error:").should be_true
+    end
+  end
+end

src/marten/cli/manage/command/new/templates.cr

@@ -76,6 +76,7 @@ module Marten
               # Other files
               files << {".editorconfig", editorconfig}
               files << {".gitignore", gitignore}
+              files << {"seed.cr", ECR.render("#{__DIR__}/templates/project/seed.cr.ecr")}
               files << {"manage.cr", ECR.render("#{__DIR__}/templates/project/manage.cr.ecr")}
               files << {"shard.yml", ECR.render("#{__DIR__}/templates/project/shard.yml.ecr")}
               if context.edge

src/marten/cli/manage/command/new/templates/project/seed.cr.ecr

@@ -0,0 +1,6 @@
+require "./src/project"
+
+# Setup the project.
+Marten.setup
+
+# Add your seeding logic here.

src/marten/cli/manage/command/seed.cr

@@ -0,0 +1,39 @@
+module Marten
+  module CLI
+    class Manage
+      module Command
+        class Seed < Base
+          @seed_path : String = "./seed.cr"
+
+          help "Populate the database by running the seed file."
+
+          def setup
+            on_option_with_arg(
+              :f,
+              :file,
+              arg: "path",
+              description: "Specify a custom path to the seed file"
+            ) do |v|
+              @seed_path = v
+            end
+          end
+
+          def run
+            run_seed_file
+          end
+
+          private getter seed_path
+
+          private def run_seed_file
+            if File.exists?(seed_path)
+              print "Running seed file at #{seed_path}"
+              Process.run("crystal #{seed_path}", shell: true, output: stdout, error: stderr)
+            else
+              print "Seed file not found at #{seed_path}."
+            end
+          end
+        end
+      end
+    end
+  end
+end