Module: A::NtiMannerKickCourse

Defined in:
lib/a/nti_manner_kick_course.rb,
lib/a/nti_manner_kick_course/railtie.rb,
lib/a/nti_manner_kick_course/version.rb

Defined Under Namespace

Classes: Railtie

Constant Summary collapse

MONITORED_HOOKS = 
%i[
 action_controller action_controller_base action_controller_api action_controller_test_case action_dispatch_response action_dispatch_integration_test
 message_pack active_model active_model_translation active_job active_job_test_case active_record_fixtures
 action_cable_connection action_cable_connection_test_case action_cable action_cable_channel action_cable_channel_test_case
 action_text_encrypted_rich_text action_text_record action_text_rich_text action_text_content active_record active_record_fixture_set
 active_record_sqlite3adapter active_record_mysql2adapter active_record_trilogyadapter active_record_postgresqladapter active_record_encryption
 action_view action_view_test_case action_mailer action_mailer_test_case active_storage_blog active_storage_record active_storage_variant_record
 active_storage_attachment action_mailbox_inbound_email action_mailbox_record action_mailbox action_mailbox_test_case
].freeze
VERSION = 
"0.1.1"

Class Method Summary collapse

Class Method Details

.already_checked ⇒ Object 



79
80
81
 
# File 'lib/a/nti_manner_kick_course.rb', line 79

def already_checked
  @already_checked = true
end

.already_checked? ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'lib/a/nti_manner_kick_course.rb', line 75

def already_checked?
  @already_checked
end

.debug? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/a/nti_manner_kick_course.rb', line 21

def debug?
  ENV["ANTI_MANNER_DEBUG"]
end

.enabled? ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/a/nti_manner_kick_course.rb', line 17

def enabled?
  ENV["ANTI_MANNER"]
end

.filtering ⇒ Object

TODO: We need to make this list more comprehensive.



71
72
73
 
# File 'lib/a/nti_manner_kick_course.rb', line 71

def filtering
  %r{<internal:|/bundled_gems.rb|/(a-nti_manner_kick_course|activesupport|actionpack|activerecord|bootsnap|bundler|zeitwerk)-[0-9a-z\.]+/}
end

.finish_monitoring ⇒ Object 



66
67
68
 
# File 'lib/a/nti_manner_kick_course.rb', line 66

def finish_monitoring
  @monitoring = false
end

.monitor ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/a/nti_manner_kick_course.rb', line 25

def monitor
  require "active_support/lazy_load_hooks"

  start_monitoring

  MONITORED_HOOKS.each do |framework|
    ActiveSupport.on_load(framework) do
      if A::NtiMannerKickCourse.monitoring? && !A::NtiMannerKickCourse.already_checked?
        A::NtiMannerKickCourse.already_checked
        message = if A::NtiMannerKickCourse.debug?
          <<~"MESSAGE"
            During Rails startup, the block inside ActiveSupport.on_load(:#{framework}) was executed.
            There is code that is not being deferred as expected.

            Currently, debug mode is enabled, so the full stack trace is being displayed.
            To show only the suspicious code line, remove the ANTI_MANNER_DEBUG environment variable and rerun.

            #{caller}
          MESSAGE
        else
          suspect = caller.find { |c| !A::NtiMannerKickCourse.filtering.match?(c) }
          <<~"MESSAGE"
            During Rails startup, the block inside ActiveSupport.on_load(:#{framework}) was executed.
            There is code that is not being deferred as expected. The suspicious part is here.

            #{suspect}

            If you want to check the entire stack trace, set the ANTI_MANNER_DEBUG environment variable.
          MESSAGE
        end

        abort(message)
      end
    end
  end
end

.monitoring? ⇒ Boolean

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/a/nti_manner_kick_course.rb', line 62

def monitoring?
  @monitoring
end