storyteller 0.0.2

data/lib/story_teller/formatters.rb

@@ -0,0 +1,26 @@
+class StoryTeller::Formatters
+  # These are autoloaded because it's wasteful to 
+  # load all the code for each output if the application
+  # is not going to use them.
+  autoload :Development, "story_teller/formatters/development"
+  autoload :Structured, "story_teller/formatters/structured"
+  autoload :Null, "story_teller/formatters/null"
+
+  class Base
+    attr_reader :output, :name
+
+    def initialize(name:, output:)
+      @name = name
+      @output = output
+      config
+    end
+
+    def replace_output!(new_output)
+      @output = new_output
+    end
+
+    def write(story)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/story_teller/levels.rb

@@ -0,0 +1,4 @@
+module StoryTeller::Levels
+  INFO = "info"
+  ERROR = "error"
+end

data/lib/story_teller/logger.rb

@@ -0,0 +1,62 @@
+module StoryTeller
+  # Logger is a helper class to allow
+  # libraries and application to use StoryTeller
+  # through.
+
+  # This also includes a bunch of hacks that makes
+  # sure the logger behaves with rails.
+  class Logger < ::Logger
+    def initialize(formatter:, log_level: ::Logger::DEBUG)
+      @formatter = formatter
+      @logdev = self
+      self.level = log_level
+    end
+
+    def add(severity, message = nil, progname = nil)
+      return if severity < self.level
+
+      data = {severity: format_severity(severity)}
+
+      if message.nil?
+        if block_given?
+          message = yield
+        else
+          message = progname
+        end
+      end
+
+      @formatter.write(StoryTeller::Story.new(message: message.to_s, **data))
+
+      nil
+    end
+
+    def silence(*args)
+      if block_given?
+        yield
+      end
+    end
+
+    # This is not used and is only needed
+    # so ActiveSupport doesn't extend this Logger
+    # with other method like it does here:
+    # https://github.com/rails/rails/blob/fad0c6b899ba786994c506f11f587e29d7bf9c2d/activesupport/lib/active_support/logger.rb#L16-L20
+    # https://github.com/rails/rails/blob/25d52ab782623e59c0bc920076393d1691999e4e/activerecord/lib/active_record/railtie.rb#L66
+    # https://github.com/rails/rails/blob/1bb9f0e616fb60a9cc1ea67c9bbdb49b2e18835a/railties/lib/rails/commands/server/server_command.rb#L84
+    def dev
+      STDOUT
+    end
+
+    def <<(msg)
+      self.add(Logger::DEBUG, msg)
+    end
+
+    # Following methods have an effect on the Logger but don't within StoryTeller.
+    def reopen(logdev = nil);
+      self
+    end
+
+    def close
+      nil
+    end
+  end
+end

data/lib/story_teller/message.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+#
+class StoryTeller::Message
+  NIL_STRING = ""
+
+  def initialize(template)
+    template = template.to_s
+
+    unless template.encoding.name == "UTF-8"
+      template = template.encode("UTF-8", invalid: :replace)
+    end
+
+    @template = template
+  end
+
+  def render(attrs)
+    attrs.each_pair do |k, v|
+      attributes[k] = v.to_s
+    end
+
+    template % attributes
+  rescue StandardError => e
+    e.message
+  end
+
+  private
+
+  attr_reader :template
+
+  def attributes
+    @attributes ||= Hash.new do
+      NIL_STRING
+    end
+  end
+end

data/lib/story_teller/railtie.rb

@@ -0,0 +1,73 @@
+require "action_view/log_subscriber"
+require "action_controller/log_subscriber"
+require "action_mailer/log_subscriber"
+require "active_job/log_subscriber"
+require "active_storage/log_subscriber"
+require "active_record/log_subscriber"
+require "tempfile"
+
+module StoryTeller
+  class Railtie < ::Rails::Railtie
+    class ProtectedNameError < StandardError; end
+
+    env_module = case
+    when Rails.env.development?
+      StoryTeller::Environments::Development
+    when Rails.env.staging?
+      StoryTeller::Environments::Staging
+    when Rails.env.test?
+      StoryTeller::Environments::Test
+    when Rails.env.production?
+      StoryTeller::Environments::Production
+    end
+
+    StoryTeller.include(env_module)
+
+    config.story_teller = StoryTeller.config
+
+    # Detaching the default ones from Rails
+    initializer "story_teller.log_subscribers" do |app|
+      ::ActionController::LogSubscriber.detach_from :action_controller
+      ::ActionView::LogSubscriber.detach_from :action_view
+      ::ActionMailer::LogSubscriber.detach_from :action_mailer
+
+      ::ActiveJob::LogSubscriber.detach_from :active_job
+      ::ActiveStorage::LogSubscriber.detach_from :active_storage
+      ::ActiveRecord::LogSubscriber.detach_from :active_record
+    end
+
+    initializer "story_teller.logger" do |app|
+      Rails.logger = StoryTeller::Logger.new(formatter: app.config.story_teller.log_formatter, log_level: app.config.log_level)
+    end
+
+    initializer "story_teller.middlewares" do |app|
+      ::ActionController::Base.use(StoryTeller::Middleware)
+
+      app.config.middleware.insert_before(
+        ActionDispatch::ActionableExceptions,
+        StoryTeller::Rack, 
+        app,
+        app.config.debug_exception_response_format
+      )
+
+      app.config.middleware.delete Rails::Rack::Logger
+      app.config.middleware.delete ::ActionDispatch::DebugExceptions
+    end
+
+    initializer "story_teller.finalize" do |app|
+      StoryTeller.initialize!(StoryTeller.config)
+    end
+
+    console do
+      file = Tempfile.new
+
+      puts "\u{1F58B}  StoryTeller redirected logs while using the console: #{file.path}"
+
+      config.story_teller.formatters.each do |formatter|
+        formatter.replace_output!(file)
+      end
+
+      Rails::Console.prepend(StoryTeller::Console)
+    end
+  end
+end

data/lib/story_teller/story.rb

@@ -0,0 +1,26 @@
+require "story_teller/message"
+
+class StoryTeller::Story
+  attr_reader :attributes, :message, :chapter, :timestamp
+
+  def initialize(message: "", chapter: nil, **data)
+    self.timestamp = Time.now.utc
+    self.message = StoryTeller::Message.new(message)
+    self.attributes = data.symbolize_keys
+    self.chapter = chapter
+  end
+
+  def to_hash
+    {
+      timestamp: timestamp.strftime("%s%N"),
+      message: message.render(attributes),
+      data: {
+        story: attributes,
+        chapter: chapter&.attributes
+      }
+    }
+  end
+
+  private
+  attr_writer :timestamp, :message, :attributes, :chapter
+end

data/lib/story_teller/version.rb

@@ -0,0 +1,13 @@
+module StoryTeller
+  module Version
+    module_function
+
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 2
+
+    def to_s
+      [MAJOR, MINOR, PATCH].join(".")
+    end
+  end
+end

data/lib/story_teller.rb

@@ -0,0 +1,76 @@
+module StoryTeller
+  require "story_teller/configurable"
+  require "story_teller/levels"
+  require "story_teller/logger"
+  require "story_teller/book"
+  require "story_teller/exception"
+  require "story_teller/chapter"
+  require "story_teller/story"
+  require "story_teller/formatters"
+  require "story_teller/environments"
+  require "story_teller/console"
+
+  class AlreadyInitializedError < StandardError; end
+  class FormatterNotAllowedWithName < StandardError; end
+
+  module_function
+
+  def chapter(title: "", subject: "", **options, &block)
+    chapter = StoryTeller::Chapter.new(
+      title: title,
+      subject: subject,
+      parent: book.current_chapter
+    )
+
+    book.open(chapter, **options, &block)
+  end
+
+  def book
+    StoryTeller::Book.current_book
+  end
+
+  def config(&block)
+    @config ||= StoryTeller::Configuration.new
+
+    block.call(@config) if block_given?
+
+    @config
+  end
+
+  def initialize!(config)
+    raise AlreadyInitializedError if frozen?
+
+    mod = Module.new do
+      config.formatters.each do |formatter|
+        func_name = formatter.name.to_sym
+
+        if method_defined?(func_name)
+          raise FormatterNotAllowedWithName, "#{func_name} is already defined as a method on StoryTeller. Please choose another name for your formatter"
+        end
+
+        define_method(func_name, ->(message, **data) {
+          chapter = StoryTeller.book.current_chapter
+          story = case message
+          when StoryTeller::Story
+            message
+          when StoryTeller::Exception
+            StoryTeller::Book.current_book.current_exception = message.exception
+            message
+          else
+            StoryTeller::Story.new(message: message, chapter: chapter, **data)
+          end
+
+          formatter.write(story)
+          nil
+        })
+      end
+    end
+
+    self.extend mod
+    freeze
+  end
+end
+
+if defined?(::Rails::Engine)
+  require "story_teller/railtie"
+end

data/storyteller.gemspec

@@ -0,0 +1,19 @@
+require_relative "lib/story_teller/version"
+
+Gem::Specification.new do |s|
+  s.name        = "storyteller"
+  s.version     = StoryTeller::Version.to_s
+  s.licenses    = ["Apache-2.0"]
+  s.summary     = "Observe and understand how your application is used."
+  s.description = %s{
+    StoryTeller is an observation framework that allows teams to
+    create meaningful stories to help them understand what's going on in
+    your production environment.
+  }
+  s.authors     = ["Pier-Olivier Thibault"]
+  s.email       = "storyteller@pier-olivier.dev"
+  s.homepage    = "https://github.com/pier-oliviert/storyteller.rb"
+  s.metadata    = { "source_code_uri" => "https://github.com/pier-oliviert/storyteller.rb" }
+
+  s.files = %w[storyteller.gemspec README.md LICENSE] + `git ls-files | grep -E '^(bin|lib|web)'`.split("\n")
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: storyteller
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Pier-Olivier Thibault
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-01 00:00:00.000000000 Z
+dependencies: []
+description: "\n    StoryTeller is an observation framework that allows teams to\n
+  \   create meaningful stories to help them understand what's going on in\n    your
+  production environment.\n  "
+email: storyteller@pier-olivier.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/story_teller.rb
+- lib/story_teller/book.rb
+- lib/story_teller/chapter.rb
+- lib/story_teller/configurable.rb
+- lib/story_teller/console.rb
+- lib/story_teller/environments.rb
+- lib/story_teller/environments/development.rb
+- lib/story_teller/environments/development/configuration.rb
+- lib/story_teller/environments/development/middleware.rb
+- lib/story_teller/environments/development/notifications.rb
+- lib/story_teller/environments/development/rack.rb
+- lib/story_teller/environments/development/sidekiq.rb
+- lib/story_teller/environments/production.rb
+- lib/story_teller/environments/production/configuration.rb
+- lib/story_teller/environments/production/middleware.rb
+- lib/story_teller/environments/production/rack.rb
+- lib/story_teller/environments/staging.rb
+- lib/story_teller/environments/staging/configuration.rb
+- lib/story_teller/environments/test.rb
+- lib/story_teller/environments/test/configuration.rb
+- lib/story_teller/exception.rb
+- lib/story_teller/formatters.rb
+- lib/story_teller/formatters/development.rb
+- lib/story_teller/formatters/development/error.rb
+- lib/story_teller/formatters/development/info.rb
+- lib/story_teller/formatters/null.rb
+- lib/story_teller/formatters/structured.rb
+- lib/story_teller/levels.rb
+- lib/story_teller/logger.rb
+- lib/story_teller/message.rb
+- lib/story_teller/railtie.rb
+- lib/story_teller/story.rb
+- lib/story_teller/version.rb
+- storyteller.gemspec
+homepage: https://github.com/pier-oliviert/storyteller.rb
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/pier-oliviert/storyteller.rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Observe and understand how your application is used.
+test_files: []