Update database setup specs to use TestHelper database

Author: dcalixto

spec/db_setup_spec.cr

@@ -1,45 +1,46 @@
 require "./spec_helper"
 
+require "./spec_helper"
+
 describe "DB Setup" do
   describe "database connection" do
     it "creates punches table with correct schema" do
-      DB.open(PunchingBag::Configuration.database_url) do |db|
-        bag = PunchingBag::Tracker.new(PunchingBag.db)
-        bag.setup_database
+      db = TestHelper.database
+      bag = PunchingBag::Tracker.new(db)
+      bag.setup_database
 
-        result = PunchingBag.db.query_all(<<-SQL, as: {column_name: String, data_type: String})
-          SELECT column_name, data_type
-          FROM information_schema.columns
-          WHERE table_name = 'punches'
-          ORDER BY ordinal_position
-        SQL
+      result = db.query_all(<<-SQL, as: {column_name: String, data_type: String})
+        SELECT column_name, data_type
+        FROM information_schema.columns
+        WHERE table_name = 'punches'
+        ORDER BY ordinal_position
+      SQL
 
-        result.should contain({column_name: "id", data_type: "bigint"})
-        result.should contain({column_name: "punchable_type", data_type: "character varying"})
-        result.should contain({column_name: "hits", data_type: "integer"})
-        result.should contain({column_name: "created_at", data_type: "timestamp with time zone"})
-      end
+      result.should contain({column_name: "id", data_type: "bigint"})
+      result.should contain({column_name: "punchable_type", data_type: "character varying"})
+      result.should contain({column_name: "hits", data_type: "integer"})
+      result.should contain({column_name: "created_at", data_type: "timestamp with time zone"})
     end
   end
-
-  describe "table schema" do
-    it "has the expected columns" do
-      DB.open(PunchingBag::Configuration.database_url) do |db|
-        result = db.query_all(<<-SQL, as: {column_name: String, data_type: String})
+end
+describe "table schema" do
+  it "has the expected columns" do
+    DB.open(PunchingBag::Configuration.database_url) do |db|
+      result = db.query_all(<<-SQL, as: {column_name: String, data_type: String})
           SELECT column_name, data_type
           FROM information_schema.columns
           WHERE table_name = 'punches'
           ORDER BY ordinal_position
         SQL
 
-        result.should contain({column_name: "id", data_type: "bigint"})
-        result.should contain({column_name: "punchable_type", data_type: "character varying"})
-        result.should contain({column_name: "hits", data_type: "integer"})
-        result.should contain({column_name: "created_at", data_type: "timestamp with time zone"})
-      end
+      result.should contain({column_name: "id", data_type: "bigint"})
+      result.should contain({column_name: "punchable_type", data_type: "character varying"})
+      result.should contain({column_name: "hits", data_type: "integer"})
+      result.should contain({column_name: "created_at", data_type: "timestamp with time zone"})
     end
   end
 end
+
 describe PunchingBag do
   before_each do
     File.delete("./punching_bag.db") if File.exists?("./punching_bag.db")

spec/punching_bag_spec.cr

@@ -1,9 +1,8 @@
-require "../src/punching_bag"
-require "spec"
+require "./spec_helper"
 
 describe PunchingBag do
   it "tracks and retrieves hits correctly" do
-    bag = PunchingBag::Tracker.new(PunchingBag.db)
+    bag = PunchingBag::Tracker.new(TestHelper.database)
     bag.clear
 
     # Insert data for the test
@@ -19,7 +18,7 @@ describe PunchingBag do
   end
 
   it "calculates average time correctly for multiple punches" do
-    bag = PunchingBag::Tracker.new(PunchingBag.db)
+    bag = PunchingBag::Tracker.new(TestHelper.database)
     bag.clear
 
     now = Time.utc
@@ -31,7 +30,7 @@ describe PunchingBag do
   end
 
   it "returns UTC time when no punches exist" do
-    bag = PunchingBag::Tracker.new(PunchingBag.db.not_nil!)
+    bag = PunchingBag::Tracker.new(TestHelper.database)
     bag.clear
 
     now = Time.utc
@@ -41,7 +40,7 @@ describe PunchingBag do
   end
 
   it "calculates average time for single punch" do
-    bag = PunchingBag::Tracker.new(PunchingBag.db)
+    bag = PunchingBag::Tracker.new(TestHelper.database)
     bag.clear
 
     specific_time = Time.utc
@@ -50,33 +49,18 @@ describe PunchingBag do
     result = bag.average_time("Post", 1_i64)
     result.should be_close(specific_time, 1.second)
   end
-
-  it "retrieves most hit items within a time range" do
-    bag = PunchingBag::Tracker.new(PunchingBag.db.not_nil!)
-    bag.clear
-
-    bag.punch("Post", 1_i64, 5)
-    bag.punch("Post", 2_i64, 3)
-    bag.punch("Comment", 1_i64, 1)
-
-    since = Time.utc - 1.day
-    most_hit = bag.most_hit(since)
-
-    most_hit[0][:punchable_id].should eq(1_i64)
-    most_hit[0][:total_hits].should eq(5_i64)
-  end
 end
-
 describe "Database Setup" do
   it "creates punches table with correct schema" do
+    db = TestHelper.database
     sql = <<-SQL
       SELECT column_name, data_type, is_nullable
       FROM information_schema.columns
       WHERE table_name = 'punches'
       ORDER BY ordinal_position
     SQL
 
-    results = PunchingBag.db.query_all(sql) do |rs|
+    results = db.query_all(sql) do |rs|
       {
         name:     rs.read(String),
         type:     rs.read(String),
@@ -93,7 +77,8 @@ describe "Database Setup" do
   end
 
   it "creates required indexes" do
-    results = PunchingBag.db.query_all(<<-SQL, as: {name: String})
+    db = TestHelper.database
+    results = db.query_all(<<-SQL, as: {name: String})
       SELECT indexname as name 
       FROM pg_indexes 
       WHERE tablename = 'punches'

spec/spec_helper.cr

@@ -1,30 +1,34 @@
 require "spec"
-require "webmock"
 require "../src/punching_bag"
+require "./test_helper"
 
-ENV["DATABASE_URL"] = "postgres://localhost/punching_bag_test" # Or a different test database
+PunchingBag.configure do |config|
+  config.database_url = "postgres://postgres:postgres@localhost:5432/punching_bag_test"
+end
 
-module TestHelper
-  # DB_URL = "postgres://daniel:password@localhost/punching_bag_test"
-  @@database : DB::Database? = nil
+Spec.before_each do
+  TestHelper.database.exec "DROP TABLE IF EXISTS punches"
 
-  def self.database
-    @@database ||= DB.open(ENV["DATABASE_URL"]? || "postgres://postgres:postgres@localhost:5432/punching_bag_test")
-  end
+  TestHelper.database.exec <<-SQL
+    CREATE TABLE punches (
+      id BIGSERIAL PRIMARY KEY,
+      punchable_type VARCHAR(255),
+      punchable_id BIGINT,
+      hits INTEGER DEFAULT 1,
+      created_at TIMESTAMP WITH TIME ZONE,
+      starts_at TIMESTAMP WITH TIME ZONE,
+      ends_at TIMESTAMP WITH TIME ZONE
+    )
+  SQL
 
-  def self.setup_database
-    @@database = DB.open(ENV["DATABASE_URL"]? || "postgres://postgres:postgres@localhost:5432/punching_bag_test")
-    PunchingBag.db = database
-    database.exec "DROP TABLE IF EXISTS punches CASCADE" # Assuming this is your table
-  end
+  TestHelper.database.exec <<-SQL
+    CREATE INDEX punchable_index ON punches (punchable_type, punchable_id)
+  SQL
 
-  def self.cleanup_database
-    @@database.try &.close
-    @@database = nil
-  end
+  TestHelper.database.exec <<-SQL
+    CREATE INDEX idx_punches_created_at ON punches (created_at)
+  SQL
+end
+Spec.after_suite do
+  TestHelper.database.close
 end
-
-Spec.before_suite { TestHelper.setup_database }
-Spec.after_suite { TestHelper.cleanup_database }
-# Mocking setup
-WebMock.allow_net_connect = false

spec/test_helper.cr

@@ -0,0 +1,7 @@
+module TestHelper
+  @@db : DB::Database?
+
+  def self.database
+    @@db ||= DB.open(PunchingBag::Configuration.database_url)
+  end
+end

src/punching_bag/configuration.cr

@@ -1,13 +1,19 @@
 module PunchingBag
   class Configuration
-    class_property database_url : String = "postgres://localhost/punching_bag_test"
+    class_property database_url : String = "postgres://postgres:postgres@localhost:5432/punching_bag_test"
+
+    @@db : DB::Database?
+
+    def self.db
+      @@db ||= DB.open(database_url)
+    end
   end
 
   def self.configure
     yield Configuration
   end
 
-  def self.db : DB::Database
-    DB.open(Configuration.database_url)
+  def self.db
+    Configuration.db
   end
 end