whodunit-chronicles 0.1.0.pre → 0.2.0

data/lib/whodunit/chronicles/service.rb

@@ -4,10 +4,10 @@ require 'concurrent-ruby'
 
 module Whodunit
   module Chronicles
-    # Main service orchestrator for audit streaming
+    # Main service orchestrator for chronicle streaming
     #
-    # Coordinates the stream adapter and audit processor to provide
-    # a complete audit streaming solution with error handling and monitoring.
+    # Coordinates the stream adapter and processor to provide
+    # a complete chronicle streaming solution with error handling and monitoring.
     class Service
       attr_reader :adapter, :processor, :logger, :executor
 
@@ -17,7 +17,7 @@ module Whodunit
         logger: Chronicles.logger
       )
         @adapter = adapter || build_adapter
-        @processor = processor || AuditProcessor.new(logger: logger)
+        @processor = processor || Processor.new(logger: logger)
         @logger = logger
         @executor = Concurrent::ThreadPoolExecutor.new(
           min_threads: 1,
@@ -29,13 +29,13 @@ module Whodunit
         @retry_count = 0
       end
 
-      # Start the audit streaming service
+      # Start the chronicle streaming service
       #
       # @return [self]
       def start
         return self if running?
 
-        log(:info, 'Starting Chronicles audit streaming service')
+        log(:info, 'Starting Chronicles streaming service')
 
         validate_setup!
         test_connections!
@@ -45,7 +45,7 @@ module Whodunit
 
         start_streaming_with_retry
 
-        log(:info, 'Chronicles audit streaming service started successfully')
+        log(:info, 'Chronicles streaming service started successfully')
         self
       rescue StandardError => e
         log(:error, 'Failed to start service', error: e.message)
@@ -53,13 +53,13 @@ module Whodunit
         raise
       end
 
-      # Stop the audit streaming service
+      # Stop the chronicle streaming service
       #
       # @return [void]
       def stop
         return unless running?
 
-        log(:info, 'Stopping Chronicles audit streaming service')
+        log(:info, 'Stopping Chronicles streaming service')
         @running = false
 
         adapter.stop_streaming if adapter.streaming?
@@ -67,7 +67,7 @@ module Whodunit
         @executor.wait_for_termination(timeout: 30)
 
         processor.close
-        log(:info, 'Chronicles audit streaming service stopped')
+        log(:info, 'Chronicles streaming service stopped')
       end
 
       # Check if service is running
@@ -94,23 +94,23 @@ module Whodunit
         }
       end
 
-      # Set up the audit streaming infrastructure
+      # Set up the chronicle streaming infrastructure
       #
       # @return [void]
       def setup!
-        log(:info, 'Setting up audit streaming infrastructure')
+        log(:info, 'Setting up chronicle streaming infrastructure')
         adapter.setup
-        log(:info, 'Audit streaming infrastructure setup completed')
+        log(:info, 'Chronicle streaming infrastructure setup completed')
       end
 
-      # Tear down the audit streaming infrastructure
+      # Tear down the chronicle streaming infrastructure
       #
       # @return [void]
       def teardown!
-        log(:info, 'Tearing down audit streaming infrastructure')
+        log(:info, 'Tearing down chronicle streaming infrastructure')
         stop if running?
         adapter.teardown
-        log(:info, 'Audit streaming infrastructure teardown completed')
+        log(:info, 'Chronicle streaming infrastructure teardown completed')
       end
 
       private
@@ -119,6 +119,8 @@ module Whodunit
         case Chronicles.config.adapter
         when :postgresql
           Adapters::PostgreSQL.new(logger: logger)
+        when :mysql
+          Adapters::MySQL.new(logger: logger)
         else
           raise ConfigurationError, "Unsupported adapter: #{Chronicles.config.adapter}"
         end
@@ -134,8 +136,8 @@ module Whodunit
 
       def test_connections!
         adapter.test_connection
-        # Test audit processor connection by creating a dummy connection
-        processor.send(:ensure_audit_connection)
+        # Test processor connection by creating a dummy connection
+        processor.send(:ensure_connection)
       rescue StandardError => e
         raise AdapterError, "Connection test failed: #{e.message}"
       end
@@ -159,7 +161,7 @@ module Whodunit
 
       def process_change_event(change_event)
         return unless change_event
-        return unless should_audit_table?(change_event)
+        return unless should_chronicle_table?(change_event)
 
         log(:debug, 'Processing change event',
           table: change_event.qualified_table_name,
@@ -174,8 +176,8 @@ module Whodunit
         )
       end
 
-      def should_audit_table?(change_event)
-        Chronicles.config.audit_table?(
+      def should_chronicle_table?(change_event)
+        Chronicles.config.chronicle_table?(
           change_event.table_name,
           change_event.schema_name,
         )

data/lib/whodunit/chronicles/table.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Whodunit
+  module Chronicles
+    # Handles table creation for different database adapters
+    #
+    # Provides adapter-specific SQL for creating chronicles tables
+    module Table
+      private
+
+      def ensure_table_exists
+        db_type = detect_database_type(@audit_database_url || Chronicles.config.database_url)
+
+        case db_type
+        when :postgresql
+          create_postgresql_table
+        when :mysql
+          create_mysql_table
+        end
+      end
+
+      def create_postgresql_table
+        create_sql = <<~SQL
+          CREATE TABLE IF NOT EXISTS whodunit_chronicles_audits (
+            id BIGSERIAL PRIMARY KEY,
+            table_name TEXT NOT NULL,
+            schema_name TEXT NOT NULL DEFAULT 'public',
+            record_id JSONB,
+            action TEXT NOT NULL CHECK (action IN ('INSERT', 'UPDATE', 'DELETE')),
+            old_data JSONB,
+            new_data JSONB,
+            changes JSONB,
+            user_id BIGINT,
+            user_type TEXT,
+            transaction_id TEXT,
+            sequence_number INTEGER,
+            occurred_at TIMESTAMP WITH TIME ZONE NOT NULL,
+            created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
+            metadata JSONB DEFAULT '{}'::jsonb,
+          #{'  '}
+            -- Indexes for performance
+            CONSTRAINT valid_data_for_action CHECK (
+              (action = 'INSERT' AND old_data IS NULL AND new_data IS NOT NULL) OR
+              (action = 'UPDATE' AND old_data IS NOT NULL AND new_data IS NOT NULL) OR#{'  '}
+              (action = 'DELETE' AND old_data IS NOT NULL AND new_data IS NULL)
+            )
+          );
+
+          -- Performance indexes
+          CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_chronicles_audits_table_record#{' '}
+            ON whodunit_chronicles_audits (table_name, (record_id->>'id'));
+
+          CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_chronicles_audits_occurred_at#{' '}
+            ON whodunit_chronicles_audits (occurred_at DESC);
+
+          CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_chronicles_audits_user#{' '}
+            ON whodunit_chronicles_audits (user_id, user_type);
+
+          CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_chronicles_audits_action#{' '}
+            ON whodunit_chronicles_audits (action);
+
+          -- GIN index for JSONB columns
+          CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_chronicles_audits_record_id_gin#{' '}
+            ON whodunit_chronicles_audits USING GIN (record_id);
+
+          CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_chronicles_audits_changes_gin#{' '}
+            ON whodunit_chronicles_audits USING GIN (changes);
+        SQL
+
+        @connection.exec(create_sql)
+      rescue PG::Error => e
+        # Ignore "already exists" errors from CONCURRENTLY
+        raise unless e.message.include?('already exists')
+      end
+
+      def create_mysql_table
+        create_sql = <<~SQL
+          CREATE TABLE IF NOT EXISTS whodunit_chronicles_audits (
+            id BIGINT AUTO_INCREMENT PRIMARY KEY,
+            table_name TEXT NOT NULL,
+            schema_name TEXT NOT NULL DEFAULT 'public',
+            record_id JSON,
+            action TEXT NOT NULL CHECK (action IN ('INSERT', 'UPDATE', 'DELETE')),
+            old_data JSON,
+            new_data JSON,
+            changes JSON,
+            user_id BIGINT,
+            user_type TEXT,
+            transaction_id TEXT,
+            sequence_number INTEGER,
+            occurred_at TIMESTAMP NOT NULL,
+            created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+            metadata JSON DEFAULT (JSON_OBJECT()),
+          #{'  '}
+            -- Constraint for data integrity
+            CONSTRAINT valid_data_for_action CHECK (
+              (action = 'INSERT' AND old_data IS NULL AND new_data IS NOT NULL) OR
+              (action = 'UPDATE' AND old_data IS NOT NULL AND new_data IS NOT NULL) OR
+              (action = 'DELETE' AND old_data IS NOT NULL AND new_data IS NULL)
+            ),
+          #{'  '}
+            -- Performance indexes
+            INDEX idx_chronicles_audits_table_record (table_name(255), (JSON_UNQUOTE(JSON_EXTRACT(record_id, '$.id')))),
+            INDEX idx_chronicles_audits_occurred_at (occurred_at DESC),
+            INDEX idx_chronicles_audits_user (user_id, user_type(255)),
+            INDEX idx_chronicles_audits_action (action(50))
+          );
+        SQL
+
+        @connection.query(create_sql)
+      rescue StandardError => e
+        # Ignore "already exists" errors
+        unless e.message.include?('already exists') ||
+               (e.message.include?('Table') && e.message.include?('already exists'))
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/whodunit/chronicles/version.rb

@@ -2,6 +2,6 @@
 
 module Whodunit
   module Chronicles
-    VERSION = '0.1.0.pre'
+    VERSION = '0.2.0'
   end
 end

data/lib/whodunit/chronicles.rb

@@ -8,11 +8,15 @@ require_relative 'chronicles/version'
 require_relative 'chronicles/configuration'
 require_relative 'chronicles/change_event'
 require_relative 'chronicles/stream_adapter'
-require_relative 'chronicles/audit_processor'
+require_relative 'chronicles/connection'
+require_relative 'chronicles/table'
+require_relative 'chronicles/persistence'
+require_relative 'chronicles/processor'
 require_relative 'chronicles/service'
 
 # Adapters
 require_relative 'chronicles/adapters/postgresql'
+require_relative 'chronicles/adapters/mysql'
 
 module Whodunit
   # Chronicles - The complete historical record of `whodunit did what?` data
@@ -28,8 +32,11 @@ module Whodunit
     setting :database_url, default: ENV.fetch('DATABASE_URL', nil)
     setting :audit_database_url, default: ENV.fetch('AUDIT_DATABASE_URL', nil)
     setting :adapter, default: :postgresql
+    # PostgreSQL-specific settings
     setting :publication_name, default: 'whodunit_audit'
     setting :replication_slot_name, default: 'whodunit_audit_slot'
+    # MySQL-specific settings
+    setting :mysql_server_id, default: 1001
     setting :batch_size, default: 100
     setting :max_retry_attempts, default: 3
     setting :retry_delay, default: 5
@@ -46,6 +53,9 @@ module Whodunit
     #     config.database_url = "postgresql://localhost/myapp"
     #     config.audit_database_url = "postgresql://localhost/myapp_audit"
     #     config.adapter = :postgresql
+    #     # OR for MySQL:
+    #     config.adapter = :mysql
+    #     config.mysql_server_id = 1001
     #   end
     def self.configure
       yield(config) if block_given?

data/whodunit-chronicles.gemspec

@@ -41,7 +41,9 @@ Gem::Specification.new do |spec|
   # Database dependencies
   spec.add_dependency 'pg', '~> 1.5'
   # Driver for MySQL-compatible database
-  # spec.add_dependency 'trilogy', '~> 2.9'
+  spec.add_dependency 'trilogy', '~> 2.9'
+  # Required for Ruby 3.4+ compatibility (trilogy dependency)
+  spec.add_dependency 'bigdecimal', '~> 3.1'
 
   # Development dependencies
   spec.add_development_dependency 'kramdown', '~> 2.5'
@@ -49,13 +51,15 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'mocha', '~> 2.1'
   spec.add_development_dependency 'pry', '~> 0.14'
   spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.6.0'
   spec.add_development_dependency 'rubocop', '~> 1.60'
   spec.add_development_dependency 'rubocop-minitest', '~> 0.34'
   spec.add_development_dependency 'rubocop-performance', '~> 1.19'
   spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'simplecov-cobertura', '~> 3.0'
   spec.add_development_dependency 'yard', '~> 0.9'
 
   # Security scanning dependencies
-  spec.add_development_dependency 'brakeman', '~> 6.0'
+  spec.add_development_dependency 'brakeman', '~> 7.1'
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whodunit-chronicles
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.2.0
 platform: ruby
 authors:
 - Ken C. Demanawa
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: trilogy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +234,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +268,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -243,6 +299,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".rubocop.yml"
 - ".yardopts"
 - CHANGELOG.md
@@ -250,15 +307,22 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/images/campaign-performance-analytics.png
+- examples/images/candidate-journey-analytics.png
+- examples/images/recruitment-funnel-analytics.png
 - lib/.gitkeep
 - lib/whodunit-chronicles.rb
 - lib/whodunit/chronicles.rb
+- lib/whodunit/chronicles/adapters/mysql.rb
 - lib/whodunit/chronicles/adapters/postgresql.rb
-- lib/whodunit/chronicles/audit_processor.rb
 - lib/whodunit/chronicles/change_event.rb
 - lib/whodunit/chronicles/configuration.rb
+- lib/whodunit/chronicles/connection.rb
+- lib/whodunit/chronicles/persistence.rb
+- lib/whodunit/chronicles/processor.rb
 - lib/whodunit/chronicles/service.rb
 - lib/whodunit/chronicles/stream_adapter.rb
+- lib/whodunit/chronicles/table.rb
 - lib/whodunit/chronicles/version.rb
 - whodunit-chronicles.gemspec
 homepage: https://github.com/whodunit-gem/whodunit-chronicles