derail_specs 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. checksums.yaml +7 -0
  2. data/.rspec +3 -0
  3. data/.rubocop.yml +25 -0
  4. data/.rubocop_todo.yml +47 -0
  5. data/.tool-versions +1 -0
  6. data/CHANGELOG.md +5 -0
  7. data/CODE_OF_CONDUCT.md +84 -0
  8. data/Gemfile +13 -0
  9. data/Gemfile.lock +122 -0
  10. data/LICENSE.txt +21 -0
  11. data/README.md +85 -0
  12. data/Rakefile +12 -0
  13. data/bin/console +15 -0
  14. data/bin/setup +8 -0
  15. data/derail_specs.gemspec +34 -0
  16. data/example/.gitignore +23 -0
  17. data/example/.ruby-version +1 -0
  18. data/example/Gemfile +15 -0
  19. data/example/Gemfile.lock +159 -0
  20. data/example/README.md +24 -0
  21. data/example/Rakefile +8 -0
  22. data/example/app/controllers/application_controller.rb +4 -0
  23. data/example/app/models/application_record.rb +5 -0
  24. data/example/app/views/layouts/application.html.erb +15 -0
  25. data/example/bin/bundle +118 -0
  26. data/example/bin/rails +6 -0
  27. data/example/bin/rake +6 -0
  28. data/example/bin/setup +35 -0
  29. data/example/config/application.rb +40 -0
  30. data/example/config/boot.rb +5 -0
  31. data/example/config/credentials.yml.enc +1 -0
  32. data/example/config/database.yml +25 -0
  33. data/example/config/environment.rb +7 -0
  34. data/example/config/environments/development.rb +62 -0
  35. data/example/config/environments/production.rb +98 -0
  36. data/example/config/environments/test.rb +51 -0
  37. data/example/config/initializers/application_controller_renderer.rb +9 -0
  38. data/example/config/initializers/backtrace_silencers.rb +10 -0
  39. data/example/config/initializers/content_security_policy.rb +29 -0
  40. data/example/config/initializers/cookies_serializer.rb +7 -0
  41. data/example/config/initializers/derail_specs.rb +3 -0
  42. data/example/config/initializers/filter_parameter_logging.rb +8 -0
  43. data/example/config/initializers/inflections.rb +17 -0
  44. data/example/config/initializers/mime_types.rb +5 -0
  45. data/example/config/initializers/permissions_policy.rb +12 -0
  46. data/example/config/initializers/wrap_parameters.rb +16 -0
  47. data/example/config/locales/en.yml +33 -0
  48. data/example/config/puma.rb +45 -0
  49. data/example/config/routes.rb +5 -0
  50. data/example/config.ru +8 -0
  51. data/example/public/404.html +67 -0
  52. data/example/public/422.html +67 -0
  53. data/example/public/500.html +66 -0
  54. data/example/public/apple-touch-icon-precomposed.png +0 -0
  55. data/example/public/apple-touch-icon.png +0 -0
  56. data/example/public/favicon.ico +0 -0
  57. data/example/public/robots.txt +1 -0
  58. data/example/tests.sh +4 -0
  59. data/lib/derail_specs/boot.rb +28 -0
  60. data/lib/derail_specs/railtie.rb +7 -0
  61. data/lib/derail_specs/server/app.rb +15 -0
  62. data/lib/derail_specs/server/checker.rb +43 -0
  63. data/lib/derail_specs/server/middleware.rb +67 -0
  64. data/lib/derail_specs/server/puma.rb +32 -0
  65. data/lib/derail_specs/server/timer.rb +20 -0
  66. data/lib/derail_specs/server.rb +117 -0
  67. data/lib/derail_specs/transaction.rb +84 -0
  68. data/lib/derail_specs/version.rb +5 -0
  69. data/lib/derail_specs.rb +24 -0
  70. data/lib/generators/derail_specs/install_generator.rb +16 -0
  71. data/lib/generators/templates/config/initializers/derail_specs.rb +5 -0
  72. data/lib/tasks/derail_specs.rake +5 -0
  73. metadata +145 -0
data/example/bin/setup ADDED
@@ -0,0 +1,35 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require "fileutils"
5
+
6
+ # path to your application root.
7
+ APP_ROOT = File.expand_path('..', __dir__)
8
+
9
+ def system!(*args)
10
+ system(*args) || abort("\n== Command #{args} failed ==")
11
+ end
12
+
13
+ FileUtils.chdir APP_ROOT do
14
+ # This script is a way to set up or update your development environment automatically.
15
+ # This script is idempotent, so that you can run it at any time and get an expectable outcome.
16
+ # Add necessary setup steps to this file.
17
+
18
+ puts '== Installing dependencies =='
19
+ system! 'gem install bundler --conservative'
20
+ system('bundle check') || system!('bundle install')
21
+
22
+ # puts "\n== Copying sample files =="
23
+ # unless File.exist?('config/database.yml')
24
+ # FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
25
+ # end
26
+
27
+ puts "\n== Preparing database =="
28
+ system! 'bin/rails db:prepare'
29
+
30
+ puts "\n== Removing old logs and tempfiles =="
31
+ system! 'bin/rails log:clear tmp:clear'
32
+
33
+ puts "\n== Restarting application server =="
34
+ system! 'bin/rails restart'
35
+ end
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "boot"
4
+
5
+ require "rails"
6
+ # Pick the frameworks you want:
7
+ require "active_model/railtie"
8
+ # require "active_job/railtie"
9
+ require "active_record/railtie"
10
+ # require "active_storage/engine"
11
+ require "action_controller/railtie"
12
+ # require "action_mailer/railtie"
13
+ # require "action_mailbox/engine"
14
+ # require "action_text/engine"
15
+ require "action_view/railtie"
16
+ # require "action_cable/engine"
17
+ # require "sprockets/railtie"
18
+ # require "rails/test_unit/railtie"
19
+
20
+ # Require the gems listed in Gemfile, including any gems
21
+ # you've limited to :test, :development, or :production.
22
+ Bundler.require(*Rails.groups)
23
+
24
+ module Example
25
+ class Application < Rails::Application
26
+ # Initialize configuration defaults for originally generated Rails version.
27
+ config.load_defaults 6.1
28
+
29
+ # Configuration for the application, engines, and railties goes here.
30
+ #
31
+ # These settings can be overridden in specific environments using the files
32
+ # in config/environments, which are processed later.
33
+ #
34
+ # config.time_zone = "Central Time (US & Canada)"
35
+ # config.eager_load_paths << Rails.root.join("extras")
36
+
37
+ # Don't generate system test files.
38
+ config.generators.system_tests = nil
39
+ end
40
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
4
+
5
+ require "bundler/setup" # Set up gems listed in the Gemfile.
@@ -0,0 +1 @@
1
+ 5DclUhUCj200XhfAmP7bwqP34OjTvO1dEj4hXBgKcDFpduHx+kSUh4Ee7BRRSHVMZtxLD8dEDX/VKHawvWai+aMSzd9qqVpRW1mvZkJ72Z/Q8wY0TQzOgzcHaL993gELZewqfT9yO9/0JRRSBU6MkWnyWBHRIABiQUaXnk/auzXCeNR60b4sMHId/ltoE+ccesDXzxIn4oGNWRb8U8L3pfYeX4ZlKsqS2D+FmORp4MDzIMb61SbWcLnd4XUy7845T5ldDHaLTgLIqE9TBShbbMh/0WO4o3WctQbtWb8YAhrHraLPKH20ZvEe8IDRw07ylWWq6MSHDrI5clk2KqWVMBveVIFVHW7+u0NV/IREJ9toku6c5wVJVPX6OYOcF68q3YjK6FqPqYkN0g9nJH2CsXXtfB6LJWWskpG2--BOexv/y5VMF9OV0u--jQzDJGOhwBBHUB2vG4J5HA==
@@ -0,0 +1,25 @@
1
+ # SQLite. Versions 3.8.0 and up are supported.
2
+ # gem install sqlite3
3
+ #
4
+ # Ensure the SQLite 3 gem is defined in your Gemfile
5
+ # gem 'sqlite3'
6
+ #
7
+ default: &default
8
+ adapter: sqlite3
9
+ pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
10
+ timeout: 5000
11
+
12
+ development:
13
+ <<: *default
14
+ database: db/development.sqlite3
15
+
16
+ # Warning: The database defined as "test" will be erased and
17
+ # re-generated from your development database when you run "rake".
18
+ # Do not set this db to the same as development or production.
19
+ test:
20
+ <<: *default
21
+ database: db/test.sqlite3
22
+
23
+ production:
24
+ <<: *default
25
+ database: db/production.sqlite3
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Load the Rails application.
4
+ require_relative "application"
5
+
6
+ # Initialize the Rails application.
7
+ Rails.application.initialize!
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "active_support/core_ext/integer/time"
4
+
5
+ Rails.application.configure do
6
+ # Settings specified here will take precedence over those in config/application.rb.
7
+
8
+ # In the development environment your application's code is reloaded any time
9
+ # it changes. This slows down response time but is perfect for development
10
+ # since you don't have to restart the web server when you make code changes.
11
+ config.cache_classes = false
12
+
13
+ # Do not eager load code on boot.
14
+ config.eager_load = false
15
+
16
+ # Show full error reports.
17
+ config.consider_all_requests_local = true
18
+
19
+ # Enable/disable caching. By default caching is disabled.
20
+ # Run rails dev:cache to toggle caching.
21
+ if Rails.root.join('tmp', 'caching-dev.txt').exist?
22
+ config.action_controller.perform_caching = true
23
+ config.action_controller.enable_fragment_cache_logging = true
24
+
25
+ config.cache_store = :memory_store
26
+ config.public_file_server.headers = {
27
+ 'Cache-Control' => "public, max-age=#{2.days.to_i}",
28
+ }
29
+ else
30
+ config.action_controller.perform_caching = false
31
+
32
+ config.cache_store = :null_store
33
+ end
34
+
35
+ # Print deprecation notices to the Rails logger.
36
+ config.active_support.deprecation = :log
37
+
38
+ # Raise exceptions for disallowed deprecations.
39
+ config.active_support.disallowed_deprecation = :raise
40
+
41
+ # Tell Active Support which deprecation messages to disallow.
42
+ config.active_support.disallowed_deprecation_warnings = []
43
+
44
+ # Raise an error on page load if there are pending migrations.
45
+ config.active_record.migration_error = :page_load
46
+
47
+ # Highlight code that triggered database queries in logs.
48
+ config.active_record.verbose_query_logs = true
49
+
50
+ # Raises error for missing translations.
51
+ # config.i18n.raise_on_missing_translations = true
52
+
53
+ # Annotate rendered view with file names.
54
+ # config.action_view.annotate_rendered_view_with_filenames = true
55
+
56
+ # Use an evented file watcher to asynchronously detect changes in source code,
57
+ # routes, locales, etc. This feature depends on the listen gem.
58
+ # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
59
+
60
+ # Uncomment if you wish to allow Action Cable access from any origin.
61
+ # config.action_cable.disable_request_forgery_protection = true
62
+ end
@@ -0,0 +1,98 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "active_support/core_ext/integer/time"
4
+
5
+ Rails.application.configure do
6
+ # Settings specified here will take precedence over those in config/application.rb.
7
+
8
+ # Code is not reloaded between requests.
9
+ config.cache_classes = true
10
+
11
+ # Eager load code on boot. This eager loads most of Rails and
12
+ # your application in memory, allowing both threaded web servers
13
+ # and those relying on copy on write to perform better.
14
+ # Rake tasks automatically ignore this option for performance.
15
+ config.eager_load = true
16
+
17
+ # Full error reports are disabled and caching is turned on.
18
+ config.consider_all_requests_local = false
19
+ config.action_controller.perform_caching = true
20
+
21
+ # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
22
+ # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
23
+ # config.require_master_key = true
24
+
25
+ # Disable serving static files from the `/public` folder by default since
26
+ # Apache or NGINX already handles this.
27
+ config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
28
+
29
+ # Enable serving of images, stylesheets, and JavaScripts from an asset server.
30
+ # config.asset_host = 'http://assets.example.com'
31
+
32
+ # Specifies the header that your server uses for sending files.
33
+ # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
34
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
35
+
36
+ # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
37
+ # config.force_ssl = true
38
+
39
+ # Include generic and useful information about system operation, but avoid logging too much
40
+ # information to avoid inadvertent exposure of personally identifiable information (PII).
41
+ config.log_level = :info
42
+
43
+ # Prepend all log lines with the following tags.
44
+ config.log_tags = [:request_id]
45
+
46
+ # Use a different cache store in production.
47
+ # config.cache_store = :mem_cache_store
48
+
49
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
50
+ # the I18n.default_locale when a translation cannot be found).
51
+ config.i18n.fallbacks = true
52
+
53
+ # Send deprecation notices to registered listeners.
54
+ config.active_support.deprecation = :notify
55
+
56
+ # Log disallowed deprecations.
57
+ config.active_support.disallowed_deprecation = :log
58
+
59
+ # Tell Active Support which deprecation messages to disallow.
60
+ config.active_support.disallowed_deprecation_warnings = []
61
+
62
+ # Use default logging formatter so that PID and timestamp are not suppressed.
63
+ config.log_formatter = ::Logger::Formatter.new
64
+
65
+ # Use a different logger for distributed setups.
66
+ # require "syslog/logger"
67
+ # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
68
+
69
+ if ENV["RAILS_LOG_TO_STDOUT"].present?
70
+ logger = ActiveSupport::Logger.new($stdout)
71
+ logger.formatter = config.log_formatter
72
+ config.logger = ActiveSupport::TaggedLogging.new(logger)
73
+ end
74
+
75
+ # Do not dump schema after migrations.
76
+ config.active_record.dump_schema_after_migration = false
77
+
78
+ # Inserts middleware to perform automatic connection switching.
79
+ # The `database_selector` hash is used to pass options to the DatabaseSelector
80
+ # middleware. The `delay` is used to determine how long to wait after a write
81
+ # to send a subsequent read to the primary.
82
+ #
83
+ # The `database_resolver` class is used by the middleware to determine which
84
+ # database is appropriate to use based on the time delay.
85
+ #
86
+ # The `database_resolver_context` class is used by the middleware to set
87
+ # timestamps for the last write to the primary. The resolver uses the context
88
+ # class timestamps to determine how long to wait before reading from the
89
+ # replica.
90
+ #
91
+ # By default Rails will store a last write timestamp in the session. The
92
+ # DatabaseSelector middleware is designed as such you can define your own
93
+ # strategy for connection switching and pass that into the middleware through
94
+ # these configuration options.
95
+ # config.active_record.database_selector = { delay: 2.seconds }
96
+ # config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
97
+ # config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session
98
+ end
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "active_support/core_ext/integer/time"
4
+
5
+ # The test environment is used exclusively to run your application's
6
+ # test suite. You never need to work with it otherwise. Remember that
7
+ # your test database is "scratch space" for the test suite and is wiped
8
+ # and recreated between test runs. Don't rely on the data there!
9
+
10
+ Rails.application.configure do
11
+ # Settings specified here will take precedence over those in config/application.rb.
12
+
13
+ config.cache_classes = true
14
+
15
+ # Do not eager load code on boot. This avoids loading your whole application
16
+ # just for the purpose of running a single test. If you are using a tool that
17
+ # preloads Rails for running tests, you may have to set it to true.
18
+ config.eager_load = false
19
+
20
+ # Configure public file server for tests with Cache-Control for performance.
21
+ config.public_file_server.enabled = true
22
+ config.public_file_server.headers = {
23
+ 'Cache-Control' => "public, max-age=#{1.hour.to_i}",
24
+ }
25
+
26
+ # Show full error reports and disable caching.
27
+ config.consider_all_requests_local = true
28
+ config.action_controller.perform_caching = false
29
+ config.cache_store = :null_store
30
+
31
+ # Raise exceptions instead of rendering exception templates.
32
+ config.action_dispatch.show_exceptions = false
33
+
34
+ # Disable request forgery protection in test environment.
35
+ config.action_controller.allow_forgery_protection = false
36
+
37
+ # Print deprecation notices to the stderr.
38
+ config.active_support.deprecation = :stderr
39
+
40
+ # Raise exceptions for disallowed deprecations.
41
+ config.active_support.disallowed_deprecation = :raise
42
+
43
+ # Tell Active Support which deprecation messages to disallow.
44
+ config.active_support.disallowed_deprecation_warnings = []
45
+
46
+ # Raises error for missing translations.
47
+ # config.i18n.raise_on_missing_translations = true
48
+
49
+ # Annotate rendered view with file names.
50
+ # config.action_view.annotate_rendered_view_with_filenames = true
51
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+ # Be sure to restart your server when you modify this file.
3
+
4
+ # ActiveSupport::Reloader.to_prepare do
5
+ # ApplicationController.renderer.defaults.merge!(
6
+ # http_host: 'example.org',
7
+ # https: false
8
+ # )
9
+ # end
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Be sure to restart your server when you modify this file.
4
+
5
+ # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
6
+ # Rails.backtrace_cleaner.add_silencer { |line| /my_noisy_library/.match?(line) }
7
+
8
+ # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code
9
+ # by setting BACKTRACE=1 before calling your invocation, like "BACKTRACE=1 ./bin/rails runner 'MyClass.perform'".
10
+ Rails.backtrace_cleaner.remove_silencers! if ENV["BACKTRACE"]
@@ -0,0 +1,29 @@
1
+ # frozen_string_literal: true
2
+ # Be sure to restart your server when you modify this file.
3
+
4
+ # Define an application-wide content security policy
5
+ # For further information see the following documentation
6
+ # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
7
+
8
+ # Rails.application.config.content_security_policy do |policy|
9
+ # policy.default_src :self, :https
10
+ # policy.font_src :self, :https, :data
11
+ # policy.img_src :self, :https, :data
12
+ # policy.object_src :none
13
+ # policy.script_src :self, :https
14
+ # policy.style_src :self, :https
15
+
16
+ # # Specify URI for violation reports
17
+ # # policy.report_uri "/csp-violation-report-endpoint"
18
+ # end
19
+
20
+ # If you are using UJS then enable automatic nonce generation
21
+ # Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) }
22
+
23
+ # Set the nonce only to specific directives
24
+ # Rails.application.config.content_security_policy_nonce_directives = %w(script-src)
25
+
26
+ # Report CSP violations to a specified URI
27
+ # For further information see the following documentation:
28
+ # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy-Report-Only
29
+ # Rails.application.config.content_security_policy_report_only = true
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Be sure to restart your server when you modify this file.
4
+
5
+ # Specify a serializer for the signed and encrypted cookie jars.
6
+ # Valid options are :json, :marshal, and :hybrid.
7
+ Rails.application.config.action_dispatch.cookies_serializer = :json
@@ -0,0 +1,3 @@
1
+ DerailSpecs.configure do |config|
2
+ config.command = './tests.sh'
3
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Be sure to restart your server when you modify this file.
4
+
5
+ # Configure sensitive parameters which will be filtered from the log file.
6
+ Rails.application.config.filter_parameters += %i[
7
+ passw secret token _key crypt salt certificate otp ssn
8
+ ]
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ # Be sure to restart your server when you modify this file.
3
+
4
+ # Add new inflection rules using the following format. Inflections
5
+ # are locale specific, and you may define rules for as many different
6
+ # locales as you wish. All of these examples are active by default:
7
+ # ActiveSupport::Inflector.inflections(:en) do |inflect|
8
+ # inflect.plural /^(ox)$/i, '\1en'
9
+ # inflect.singular /^(ox)en/i, '\1'
10
+ # inflect.irregular 'person', 'people'
11
+ # inflect.uncountable %w( fish sheep )
12
+ # end
13
+
14
+ # These inflection rules are supported but not enabled by default:
15
+ # ActiveSupport::Inflector.inflections(:en) do |inflect|
16
+ # inflect.acronym 'RESTful'
17
+ # end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+ # Be sure to restart your server when you modify this file.
3
+
4
+ # Add new mime types for use in respond_to blocks:
5
+ # Mime::Type.register "text/richtext", :rtf
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+ # Define an application-wide HTTP permissions policy. For further
3
+ # information see https://developers.google.com/web/updates/2018/06/feature-policy
4
+ #
5
+ # Rails.application.config.permissions_policy do |f|
6
+ # f.camera :none
7
+ # f.gyroscope :none
8
+ # f.microphone :none
9
+ # f.usb :none
10
+ # f.fullscreen :self
11
+ # f.payment :self, "https://secure.example.com"
12
+ # end