logstruct 0.1.0 → 0.1.2

data/lib/log_struct/shared/shared/add_request_fields.rb

@@ -0,0 +1,28 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "../../enums/log_field"
+require_relative "../interfaces/request_fields"
+
+module LogStruct
+  module Log
+    module Shared
+      module AddRequestFields
+        extend T::Sig
+        extend T::Helpers
+
+        requires_ancestor { Interfaces::RequestFields }
+
+        sig { params(hash: T::Hash[Symbol, T.untyped]).void }
+        def add_request_fields(hash)
+          hash[LogField::Path.serialize] = path if path
+          hash[LogField::HttpMethod.serialize] = http_method if http_method
+          hash[LogField::SourceIp.serialize] = source_ip if source_ip
+          hash[LogField::UserAgent.serialize] = user_agent if user_agent
+          hash[LogField::Referer.serialize] = referer if referer
+          hash[LogField::RequestId.serialize] = request_id if request_id
+        end
+      end
+    end
+  end
+end

data/lib/log_struct/shared/shared/merge_additional_data_fields.rb

@@ -0,0 +1,27 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "../interfaces/additional_data_field"
+
+module LogStruct
+  module Log
+    module Shared
+      module MergeAdditionalDataFields
+        extend T::Sig
+        extend T::Helpers
+
+        requires_ancestor { T::Struct }
+        requires_ancestor { Interfaces::AdditionalDataField }
+
+        sig { params(hash: T::Hash[Symbol, T.untyped]).void }
+        def merge_additional_data_fields(hash)
+          ad = additional_data
+          return unless ad
+          ad.each do |key, value|
+            hash[key.to_sym] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/log_struct/shared/shared/serialize_common.rb

@@ -0,0 +1,58 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "../../enums/log_field"
+require_relative "../interfaces/common_fields"
+require_relative "../../log/shared/merge_additional_data_fields"
+
+module LogStruct
+  module Log
+    module Shared
+      module SerializeCommon
+        extend T::Sig
+        extend T::Helpers
+
+        requires_ancestor { Interfaces::CommonFields }
+
+        sig { params(strict: T::Boolean).returns(T::Hash[Symbol, T.untyped]) }
+        def serialize(strict = true)
+          # Start with shared fields (source, event, level, timestamp)
+          out = serialize_common(strict)
+
+          # Merge event/base fields from the struct-specific hash
+          kernel_self = T.cast(self, Kernel)
+          field_hash = T.cast(kernel_self.public_send(:to_h), T::Hash[LogStruct::LogField, T.untyped])
+          field_hash.each do |log_field, value|
+            next if value.nil?
+            key = log_field.serialize
+            out[key] = value.is_a?(::Time) ? value.iso8601 : value
+          end
+
+          # Merge any additional_data at top level if available
+          if kernel_self.respond_to?(:merge_additional_data_fields)
+            # merge_additional_data_fields expects symbol keys
+            merge_target = T.cast(self, LogStruct::Log::Shared::MergeAdditionalDataFields)
+            merge_target.merge_additional_data_fields(out)
+          end
+
+          out
+        end
+
+        sig { params(strict: T::Boolean).returns(T::Hash[Symbol, T.untyped]) }
+        def serialize_common(strict = true)
+          {
+            LogField::Source.serialize => source.serialize.to_s,
+            LogField::Event.serialize => event.serialize.to_s,
+            LogField::Level.serialize => level.serialize.to_s,
+            LogField::Timestamp.serialize => timestamp.iso8601(3)
+          }
+        end
+
+        sig { params(options: T.untyped).returns(T::Hash[String, T.untyped]) }
+        def as_json(options = nil)
+          serialize.transform_keys(&:to_s)
+        end
+      end
+    end
+  end
+end

data/lib/log_struct/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module LogStruct
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/log_struct.rb

@@ -4,7 +4,7 @@
 # Core library files
 require "log_struct/sorbet"
 require "log_struct/version"
-require "log_struct/enums"  # All enums are now in the enums directory
+require "log_struct/enums"
 require "log_struct/configuration"
 require "log_struct/formatter"
 require "log_struct/railtie"
@@ -12,9 +12,6 @@ require "log_struct/concerns/error_handling"
 require "log_struct/concerns/configuration"
 require "log_struct/concerns/logging"
 
-# Monkey-patch ActiveSupport::TaggedLogging::Formatter to support hash input/output
-require "log_struct/monkey_patches/active_support/tagged_logging/formatter"
-
 # Require integrations
 require "log_struct/integrations"
 
@@ -23,15 +20,50 @@ require "log_struct/semantic_logger/formatter"
 require "log_struct/semantic_logger/color_formatter"
 require "log_struct/semantic_logger/logger"
 require "log_struct/semantic_logger/setup"
+require "log_struct/rails_boot_banner_silencer"
 
 module LogStruct
+  extend T::Sig
+
+  @server_mode = T.let(false, T::Boolean)
+
   class Error < StandardError; end
 
   extend Concerns::ErrorHandling::ClassMethods
   extend Concerns::Configuration::ClassMethods
   extend Concerns::Logging::ClassMethods
 
+  sig { returns(T::Boolean) }
+  def self.server_mode?
+    @server_mode
+  end
+
+  sig { params(value: T::Boolean).void }
+  def self.server_mode=(value)
+    @server_mode = value
+  end
+
   # Set enabled at require time based on current Rails environment.
   # (Users can disable or enable LogStruct later in an initializer.)
   set_enabled_from_rails_env!
+
+  # Silence Rails boot banners for cleaner server output
+  LogStruct::RailsBootBannerSilencer.install!
+
+  # Patch Puma immediately for server runs so we can convert its lifecycle
+  # messages into structured logs reliably.
+  if ARGV.include?("server")
+    begin
+      require "log_struct/integrations/puma"
+      LogStruct::Integrations::Puma.install_patches!
+
+      # Patches installed now; Rack handler patch covers server boot path
+    rescue => e
+      if defined?(::Rails) && ::Rails.respond_to?(:env) && ::Rails.env.test?
+        raise e
+      else
+        LogStruct.handle_exception(e, source: LogStruct::Source::Puma)
+      end
+    end
+  end
 end

data/logstruct.gemspec

@@ -47,8 +47,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "shrine", "~> 3.5"
   spec.add_development_dependency "sidekiq", "~> 7.2"
   spec.add_development_dependency "sorbet", "~> 0.5"
-  spec.add_development_dependency "ahoy_matey", "~> 5.2"
+  spec.add_development_dependency "ahoy_matey", ">= 4.1", "< 6.0"
   spec.add_development_dependency "active_model_serializers", "~> 0.10.13"
+  spec.add_development_dependency "dotenv-rails", "~> 3.1"
 
   spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: logstruct
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - DocSpring
 bindir: exe
 cert_chain: []
-date: 2025-09-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -181,16 +181,22 @@ dependencies:
   name: ahoy_matey
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
@@ -205,6 +211,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.13
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: An opinionated and type-safe structured logging solution. Configures
   any Rails app to log JSON to stdout. Structured logging is automatically configured
   for many gems, including Sidekiq, Carrierwave, Shrine, etc. Log messages, params,
@@ -219,6 +239,8 @@ files:
 - LICENSE
 - README.md
 - lib/log_struct.rb
+- lib/log_struct/boot_buffer.rb
+- lib/log_struct/builders/active_job.rb
 - lib/log_struct/concerns/configuration.rb
 - lib/log_struct/concerns/error_handling.rb
 - lib/log_struct/concerns/logging.rb
@@ -231,6 +253,7 @@ files:
 - lib/log_struct/enums/error_reporter.rb
 - lib/log_struct/enums/event.rb
 - lib/log_struct/enums/level.rb
+- lib/log_struct/enums/log_field.rb
 - lib/log_struct/enums/source.rb
 - lib/log_struct/formatter.rb
 - lib/log_struct/handlers.rb
@@ -248,12 +271,14 @@ files:
 - lib/log_struct/integrations/active_storage.rb
 - lib/log_struct/integrations/ahoy.rb
 - lib/log_struct/integrations/carrierwave.rb
+- lib/log_struct/integrations/dotenv.rb
 - lib/log_struct/integrations/good_job.rb
 - lib/log_struct/integrations/good_job/log_subscriber.rb
 - lib/log_struct/integrations/good_job/logger.rb
 - lib/log_struct/integrations/host_authorization.rb
 - lib/log_struct/integrations/integration_interface.rb
 - lib/log_struct/integrations/lograge.rb
+- lib/log_struct/integrations/puma.rb
 - lib/log_struct/integrations/rack.rb
 - lib/log_struct/integrations/rack_error_handler.rb
 - lib/log_struct/integrations/rack_error_handler/middleware.rb
@@ -263,37 +288,81 @@ files:
 - lib/log_struct/integrations/sorbet.rb
 - lib/log_struct/log.rb
 - lib/log_struct/log/action_mailer.rb
+- lib/log_struct/log/action_mailer/delivered.rb
+- lib/log_struct/log/action_mailer/delivery.rb
 - lib/log_struct/log/active_job.rb
+- lib/log_struct/log/active_job/enqueue.rb
+- lib/log_struct/log/active_job/finish.rb
+- lib/log_struct/log/active_job/schedule.rb
+- lib/log_struct/log/active_job/start.rb
 - lib/log_struct/log/active_model_serializers.rb
 - lib/log_struct/log/active_storage.rb
+- lib/log_struct/log/active_storage/delete.rb
+- lib/log_struct/log/active_storage/download.rb
+- lib/log_struct/log/active_storage/exist.rb
+- lib/log_struct/log/active_storage/metadata.rb
+- lib/log_struct/log/active_storage/stream.rb
+- lib/log_struct/log/active_storage/upload.rb
+- lib/log_struct/log/active_storage/url.rb
 - lib/log_struct/log/ahoy.rb
 - lib/log_struct/log/carrierwave.rb
+- lib/log_struct/log/carrierwave/delete.rb
+- lib/log_struct/log/carrierwave/download.rb
+- lib/log_struct/log/carrierwave/upload.rb
+- lib/log_struct/log/dotenv.rb
+- lib/log_struct/log/dotenv/load.rb
+- lib/log_struct/log/dotenv/restore.rb
+- lib/log_struct/log/dotenv/save.rb
+- lib/log_struct/log/dotenv/update.rb
 - lib/log_struct/log/error.rb
 - lib/log_struct/log/good_job.rb
+- lib/log_struct/log/good_job/enqueue.rb
+- lib/log_struct/log/good_job/error.rb
+- lib/log_struct/log/good_job/finish.rb
+- lib/log_struct/log/good_job/log.rb
+- lib/log_struct/log/good_job/schedule.rb
+- lib/log_struct/log/good_job/start.rb
 - lib/log_struct/log/interfaces/additional_data_field.rb
 - lib/log_struct/log/interfaces/common_fields.rb
-- lib/log_struct/log/interfaces/message_field.rb
 - lib/log_struct/log/interfaces/public_common_fields.rb
 - lib/log_struct/log/interfaces/request_fields.rb
 - lib/log_struct/log/plain.rb
+- lib/log_struct/log/puma.rb
+- lib/log_struct/log/puma/shutdown.rb
+- lib/log_struct/log/puma/start.rb
 - lib/log_struct/log/request.rb
 - lib/log_struct/log/security.rb
+- lib/log_struct/log/security/blocked_host.rb
+- lib/log_struct/log/security/csrf_violation.rb
+- lib/log_struct/log/security/ip_spoof.rb
 - lib/log_struct/log/shared/add_request_fields.rb
 - lib/log_struct/log/shared/merge_additional_data_fields.rb
 - lib/log_struct/log/shared/serialize_common.rb
 - lib/log_struct/log/shared/serialize_common_public.rb
 - lib/log_struct/log/shrine.rb
+- lib/log_struct/log/shrine/delete.rb
+- lib/log_struct/log/shrine/download.rb
+- lib/log_struct/log/shrine/exist.rb
+- lib/log_struct/log/shrine/metadata.rb
+- lib/log_struct/log/shrine/upload.rb
 - lib/log_struct/log/sidekiq.rb
 - lib/log_struct/log/sql.rb
-- lib/log_struct/log_keys.rb
 - lib/log_struct/monkey_patches/active_support/tagged_logging/formatter.rb
 - lib/log_struct/multi_error_reporter.rb
 - lib/log_struct/param_filters.rb
+- lib/log_struct/rails_boot_banner_silencer.rb
 - lib/log_struct/railtie.rb
 - lib/log_struct/semantic_logger/color_formatter.rb
 - lib/log_struct/semantic_logger/formatter.rb
 - lib/log_struct/semantic_logger/logger.rb
 - lib/log_struct/semantic_logger/setup.rb
+- lib/log_struct/shared/interfaces/additional_data_field.rb
+- lib/log_struct/shared/interfaces/common_fields.rb
+- lib/log_struct/shared/interfaces/public_common_fields.rb
+- lib/log_struct/shared/interfaces/request_fields.rb
+- lib/log_struct/shared/shared/add_request_fields.rb
+- lib/log_struct/shared/shared/merge_additional_data_fields.rb
+- lib/log_struct/shared/shared/serialize_common.rb
 - lib/log_struct/sorbet.rb
 - lib/log_struct/sorbet/serialize_symbol_keys.rb
 - lib/log_struct/string_scrubber.rb
@@ -322,7 +391,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Type-Safe JSON Structured Logging for Rails Apps
 test_files: []

data/lib/log_struct/log/interfaces/message_field.rb

@@ -1,20 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module LogStruct
-  module Log
-    module Interfaces
-      # Common interface for logs that include a message field
-      module MessageField
-        extend T::Sig
-        extend T::Helpers
-
-        interface!
-
-        # Message field
-        sig { abstract.returns(T.nilable(String)) }
-        def message; end
-      end
-    end
-  end
-end

data/lib/log_struct/log_keys.rb

@@ -1,102 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module LogStruct
-  # Define a mapping of property names to JSON keys
-  LOG_KEYS = T.let({
-    # Ruby struct property name => JSON key name
-
-    # Shared fields
-    source: :src,
-    event: :evt,
-    timestamp: :ts,
-    level: :lvl,
-
-    # Common fields
-    message: :msg,
-    data: :data,
-
-    # Request-related fields
-    path: :path,
-    http_method: :method, # Use `http_method` because `method` is a reserved word
-    source_ip: :source_ip,
-    user_agent: :user_agent,
-    referer: :referer,
-    request_id: :request_id,
-
-    # HTTP-specific fields
-    format: :format,
-    controller: :controller,
-    action: :action,
-    status: :status,
-    duration: :duration,
-    view: :view,
-    db: :db,
-    params: :params,
-
-    # Security-specific fields
-    blocked_host: :blocked_host,
-    blocked_hosts: :blocked_hosts,
-    client_ip: :client_ip,
-    x_forwarded_for: :x_forwarded_for,
-
-    # Email-specific fields
-    to: :to,
-    from: :from,
-    subject: :subject,
-
-    # Error fields
-    err_class: :err_class,
-    backtrace: :backtrace,
-
-    # Job-specific fields
-    job_id: :job_id,
-    job_class: :job_class,
-    queue_name: :queue_name,
-    arguments: :arguments,
-    retry_count: :retry_count,
-
-    # Sidekiq-specific fields
-    process_id: :pid,
-    thread_id: :tid,
-    context: :ctx,
-
-    # Storage-specific fields (ActiveStorage)
-    checksum: :checksum,
-    exist: :exist,
-    url: :url,
-    prefix: :prefix,
-    range: :range,
-
-    # Storage-specific fields (Shrine)
-    storage: :storage,
-    operation: :op,
-    file_id: :file_id,
-    filename: :filename,
-    mime_type: :mime_type,
-    size: :size,
-    metadata: :metadata,
-    location: :location,
-    upload_options: :upload_opts,
-    download_options: :download_opts,
-    options: :opts,
-    uploader: :uploader,
-
-    # CarrierWave-specific fields
-    model: :model,
-    mount_point: :mount_point,
-
-    # SQL-specific fields
-    sql: :sql,
-    name: :name,
-    row_count: :row_count,
-    connection_adapter: :connection_adapter,
-    bind_params: :bind_params,
-    database_name: :database_name,
-    connection_pool_size: :connection_pool_size,
-    active_connections: :active_connections,
-    operation_type: :operation_type,
-    table_names: :table_names
-  }.freeze,
-    T::Hash[Symbol, Symbol])
-end