fact_db 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 366d437bac93188689e47aaa27989e39ff0460440c26c03d8452ec4600790bdb
-  data.tar.gz: 469c50a37a1316cef4f0a792d07478f4429909f668eff8ce53aed2a15ac7e1dd
+  metadata.gz: a87c848e8b274c26d7960e6ac91c5efaf3238b568fb264e2c92e3d37548aa398
+  data.tar.gz: 72d964331f79436f8efefc0627896709fe2a32487195da21a180504c15c67082
 SHA512:
-  metadata.gz: f0da5fd32ac9bf5d2df045938e268cf99e10f10babf6809ef752138dfa0f0dcc26c7751e1ca8578fdb35c1eaf15b0dd69dd3bfd38734c05bec10b12b75ea3572
-  data.tar.gz: 3e77ff65b642ae413b6527d0576018f9c73fb856a93e95444d278b856ec5ccf58ebbf9b43efbea15ff4248e2d7a17c416027ba93ec428778f38d29132bb1f2a3
+  metadata.gz: 74c901b77d7081e53ff87dc81800cc4cb862b83de96ce1e8b15de2f46e0b4d7b8e7b91daaaaedaca9fa723c36da9b0142fa68c2a9583a1f52731b7642ed29245
+  data.tar.gz: 6f7359db8aaaa3c60c8fba762d4c96157834f2427e4295e760b74671ca30dfa4340c2070078d287b9263d77be7e8f89cb6a6731792a4273cc3233d4bb11aba81

data/CHANGELOG.md

@@ -8,6 +8,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.2] - 2025-01-08
+
+### Fixed
+
+- Database connection now validates configuration before connecting, providing a clear `ConfigurationError: Database URL required` message instead of confusing ActiveRecord errors when `database_url` is not set
+- README Getting Started examples now work correctly when copied into IRB:
+  - Database URL uses `ENV['USER']` for the PostgreSQL role instead of defaulting to non-existent "postgres" role
+  - Added `FactDb::Database.migrate!` step to set up the schema
+  - Examples are now split into logical blocks that build on each other
+
 ## [0.0.1] - 2025-01-08
 
 ### Added

data/README.md

@@ -49,37 +49,52 @@ bundle install
 ```ruby
 require 'fact_db'
 
-# Configure
+# Configure with a PostgreSQL database URL
 FactDb.configure do |config|
-  config.database_url = ENV['DATABASE_URL']
+  config.database_url = ENV.fetch("DATABASE_URL", "postgres://#{ENV['USER']}@localhost/fact_db_demo")
 end
 
+# Run migrations to create the schema (only needed once)
+FactDb::Database.migrate!
+
 # Create a facts instance
 facts = FactDb.new
+```
 
+Once configured, you can ingest content and create facts:
+
+```ruby
 # Ingest content
 content = facts.ingest(
   "Paula Chen joined Microsoft as Principal Engineer on January 10, 2024.",
   type: :email,
-  captured_at: Time.current
+  captured_at: Time.now
 )
 
 # Create entities
 paula = facts.entity_service.create("Paula Chen", type: :person)
+microsoft = facts.entity_service.create("Microsoft", type: :organization)
 
-# Create a fact
+# Create a fact with entity mentions
 facts.fact_service.create(
   "Paula Chen is Principal Engineer at Microsoft",
   valid_at: Date.new(2024, 1, 10),
-  mentions: [{ entity_id: paula.id, role: :subject, text: "Paula Chen" }]
+  mentions: [
+    { entity_id: paula.id, role: :subject, text: "Paula Chen" },
+    { entity_id: microsoft.id, role: :object, text: "Microsoft" }
+  ]
 )
+```
+
+Query facts temporally:
 
-# Query current facts
+```ruby
+# Query current facts about Paula
 facts.current_facts_for(paula.id).each do |fact|
   puts fact.fact_text
 end
 
-# Query facts at a point in time
+# Query facts at a point in time (before she joined)
 facts.facts_at(Date.new(2023, 6, 15), entity: paula.id)
 ```
 

data/lib/fact_db/database.rb

@@ -7,6 +7,7 @@ module FactDb
   module Database
     class << self
       def establish_connection!(config = FactDb.config)
+        config.validate!
         ActiveRecord::Base.establish_connection(config.database_url)
         ActiveRecord::Base.logger = config.logger if config.logger
       end

data/lib/fact_db/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FactDb
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fact_db
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dewayne VanHoozer