jets 3.1.0 → 5.0.0

data/engines/internal/lib/internal/actionmailer.rb

@@ -0,0 +1,51 @@
+require "action_mailer"
+
+module Jets::Internal
+  # Reference: https://github.com/rails/rails/blob/master/actionmailer/lib/action_mailer/railtie.rb
+  class Actionmailer < ::Jets::Turbine
+    config.action_mailer = ActiveSupport::OrderedOptions.new
+    config.action_mailer.show_previews = false
+
+    initializer "action_mailer.logger" do
+      ActiveSupport.on_load(:action_mailer) { self.logger ||= Jets.logger }
+    end
+
+    initializer "action_mailer.set_configs" do |app|
+      options = app.config.action_mailer
+      options.default_url_options ||= {}
+      options.preview_path ||= "#{Jets.root}/app/previews" if options.show_previews
+
+      ActiveSupport.on_load(:action_mailer) do
+        include AbstractController::UrlFor
+        extend ::JetsTurbines::RoutesHelpers.with(app.routes) # named routes helpers
+        include app.routes.mounted_helpers # mounted routes helpers: main_app and blorgh
+
+        register_interceptors(options.delete(:interceptors))
+        register_preview_interceptors(options.delete(:preview_interceptors))
+        register_observers(options.delete(:observers))
+
+        if options.smtp_settings
+          self.smtp_settings = options.smtp_settings
+        end
+
+        smtp_timeout = options.delete(:smtp_timeout)
+
+        if self.smtp_settings && smtp_timeout
+          self.smtp_settings[:open_timeout] ||= smtp_timeout
+          self.smtp_settings[:read_timeout] ||= smtp_timeout
+        end
+
+        options.each { |k, v| send("#{k}=", v) }
+      end
+    end
+
+    initializer "action_mailer.routes" do |app|
+      if app.config.action_mailer.show_previews
+        app.routes.append do
+          get "/jets/mailers", to: "jets/mailers#index", internal: true
+          get "/jets/mailers/*path", to: "jets/mailers#preview", internal: true
+        end
+      end
+    end
+  end
+end

data/engines/internal/lib/internal/actionview.rb

@@ -0,0 +1,152 @@
+require_relative "turbines/asset_tag_helper"
+
+module Jets::Internal
+  class Actionview < ::Jets::Turbine
+    config.action_view = ActiveSupport::OrderedOptions.new
+    config.action_view.embed_authenticity_token_in_remote_forms = nil
+    config.action_view.debug_missing_translation = true
+    config.action_view.default_enforce_utf8 = nil
+    config.action_view.image_loading = nil
+    config.action_view.image_decoding = nil
+    config.action_view.apply_stylesheet_media_default = true
+
+    config.after_initialize do |app|
+      ActionView::Helpers::FormTagHelper.embed_authenticity_token_in_remote_forms =
+        app.config.action_view.delete(:embed_authenticity_token_in_remote_forms)
+    end
+
+    config.after_initialize do |app|
+      form_with_generates_remote_forms = app.config.action_view.delete(:form_with_generates_remote_forms)
+      ActionView::Helpers::FormHelper.form_with_generates_remote_forms = form_with_generates_remote_forms
+    end
+
+    config.after_initialize do |app|
+      form_with_generates_ids = app.config.action_view.delete(:form_with_generates_ids)
+      unless form_with_generates_ids.nil?
+        ActionView::Helpers::FormHelper.form_with_generates_ids = form_with_generates_ids
+      end
+    end
+
+    config.after_initialize do |app|
+      default_enforce_utf8 = app.config.action_view.delete(:default_enforce_utf8)
+      unless default_enforce_utf8.nil?
+        ActionView::Helpers::FormTagHelper.default_enforce_utf8 = default_enforce_utf8
+      end
+    end
+
+    config.after_initialize do |app|
+      button_to_generates_button_tag = app.config.action_view.delete(:button_to_generates_button_tag)
+      unless button_to_generates_button_tag.nil?
+        ActionView::Helpers::UrlHelper.button_to_generates_button_tag = button_to_generates_button_tag
+      end
+    end
+
+    config.after_initialize do |app|
+      frozen_string_literal = app.config.action_view.delete(:frozen_string_literal)
+      ActionView::Template.frozen_string_literal = frozen_string_literal
+    end
+
+    config.after_initialize do |app|
+      ActionView::Helpers::AssetTagHelper.image_loading = app.config.action_view.delete(:image_loading)
+      ActionView::Helpers::AssetTagHelper.image_decoding = app.config.action_view.delete(:image_decoding)
+      ActionView::Helpers::AssetTagHelper.preload_links_header = app.config.action_view.delete(:preload_links_header)
+      ActionView::Helpers::AssetTagHelper.apply_stylesheet_media_default = app.config.action_view.delete(:apply_stylesheet_media_default)
+    end
+
+    config.after_initialize do |app|
+      ActiveSupport.on_load(:action_view) do
+        app.config.action_view.each do |k, v|
+          send "#{k}=", v
+        end
+      end
+    end
+
+    initializer "action_view.logger" do
+      # Override log subscriber rails_root to use Jets.root
+      require "action_view/log_subscriber"
+      ActionView::LogSubscriber.class_eval do
+        def rails_root
+          @root ||= "#{Jets.root}/"
+        end
+      end
+      ActiveSupport.on_load(:action_view) { self.logger ||= Jets.logger }
+    end
+
+    initializer "action_view.caching" do |app|
+      ActiveSupport.on_load(:action_view) do
+        if app.config.action_view.cache_template_loading.nil?
+          ActionView::Resolver.caching = app.config.cache_classes
+        end
+      end
+    end
+
+    initializer "action_view.setup_action_pack" do |app|
+      # Changed to :jets_controller
+      ActiveSupport.on_load(:jets_controller) do
+        ActionView::RoutingUrlFor.include(ActionDispatch::Routing::UrlFor)
+      end
+    end
+
+    initializer "action_view.collection_caching", after: "jets_controller.set_configs" do |app|
+      ActiveSupport.on_load(:action_view) do
+        ActionView::PartialRenderer.collection_cache = app.config.jets_controller.cache_store
+      end
+    end
+
+    config.after_initialize do |app|
+      enable_caching = if app.config.action_view.cache_template_loading.nil?
+        app.config.cache_classes
+      else
+        app.config.action_view.cache_template_loading
+      end
+
+      unless enable_caching
+        app.executor.register_hook ActionView::CacheExpiry::Executor.new(watcher: app.config.file_watcher)
+      end
+    end
+
+    rake_tasks do |app|
+      unless app.config.api_only
+        load "action_view/tasks/cache_digests.rake"
+      end
+    end
+
+    # Jets additions
+    initializer "action_view.event" do |app|
+      ActiveSupport.on_load :action_view do
+        class_eval do
+          def event
+            @event
+          end
+        end
+      end
+    end
+
+    initializer "action_view.asset_tag_helper" do |app|
+      ActiveSupport.on_load :action_view do
+        ActionView::Helpers.send(:include, JetsTurbines::AssetTagHelper)
+      end
+    end
+
+    initializer "action_view.override_debug_exceptions" do |app|
+      ActiveSupport.on_load :jets_controller do
+        require_relative "overrides/debug_exceptions"
+      end
+    end
+
+    # Deprecated: Will remove support for webpacker in the future.
+    initializer "action_view.webpacker" do |app|
+      if Jets.webpacker?
+        require 'webpacker'
+        require 'webpacker/helper'
+        ActiveSupport.on_load :action_controller do
+          ActionController::Base.helper Webpacker::Helper
+        end
+
+        ActiveSupport.on_load :action_view do
+          include Webpacker::Helper
+        end
+      end
+    end
+  end
+end

data/engines/internal/lib/internal/activerecord.rb

@@ -0,0 +1,37 @@
+require "active_record"
+
+module Jets::Internal
+  # Reference: https://github.com/rails/rails/blob/master/actionmailer/lib/action_mailer/railtie.rb
+  class Activerecord < ::Jets::Turbine
+    config.active_record = ActiveSupport::OrderedOptions.new
+    config.active_record.log_queries = false
+
+    rake_tasks do
+      namespace :db do
+        task :load_config do
+          if defined?(ENGINE_ROOT) && engine = Jets::Engine.find(ENGINE_ROOT)
+            if engine.paths["db/migrate"].existent
+              ActiveRecord::Tasks::DatabaseTasks.migrations_paths += engine.paths["db/migrate"].to_a
+            end
+          end
+        end
+      end
+
+      load "active_record/railties/databases.rake"
+    end
+
+    initializer "active_record.initialize_database" do
+      ActiveSupport.on_load(:active_record) do
+        self.configurations = Jets.application.config.database_configuration
+        establish_connection
+      end
+    end
+
+    initializer "active_record.logger" do
+      # use STDOUT instead of Jets.logger so we don't have to set Jets.logger.level = :debug
+      if config.active_record.log_queries || ENV['JETS_AR_LOG'] || ENV['AR_LOG']
+        ActiveSupport.on_load(:active_record) { self.logger = Logger.new(STDOUT) }
+      end
+    end
+  end
+end

data/engines/internal/lib/internal/activesupport.rb

@@ -0,0 +1,47 @@
+require "active_support/ordered_options"
+
+module Jets::Internal
+  # Reference: https://github.com/rails/rails/blob/master/activesupport/lib/active_support/railtie.rb
+  # Naming Activesupport to avoid having to use ::ActiveSupport::OrderedOptions.new
+  class Activesupport < ::Jets::Turbine
+    config.active_support = ActiveSupport::OrderedOptions.new
+    config.active_support.disable_to_s_conversion = false
+
+    # Currently, config.active_support.cache_format_version is used in application/bootstrap.rb
+
+    # Note this is how Rails does it. Jets uses Jets.report_exception
+    # Consider using the Rails approach. Unsure if it's worth it.
+    initializer "active_support.set_error_reporter" do |app|
+      ActiveSupport.error_reporter = app.executor.error_reporter
+    end
+
+    initializer "active_support.set_configs" do |app|
+      app.config.active_support.each do |k, v|
+        k = "#{k}="
+        ActiveSupport.public_send(k, v) if ActiveSupport.respond_to? k
+      end
+    end
+
+    # Sets the default value for Time.zone
+    # If assigned value cannot be matched to a TimeZone, an exception will be raised.
+    initializer "active_support.initialize_time_zone" do |app|
+      begin
+        TZInfo::DataSource.get
+      rescue TZInfo::DataSourceNotFound => e
+        raise e.exception "tzinfo-data is not present. Please add gem 'tzinfo-data' to your Gemfile and run bundle install"
+      end
+      require "active_support/core_ext/time/zones"
+      Time.zone_default = Time.find_zone!(app.config.time_zone)
+    end
+
+    # Sets the default week start
+    # If assigned value is not a valid day symbol (e.g. :sunday, :monday, ...), an exception will be raised.
+    initializer "active_support.initialize_beginning_of_week" do |app|
+      require "active_support/core_ext/date/calculations"
+      beginning_of_week_default = Date.find_beginning_of_week!(app.config.beginning_of_week)
+
+      Date.beginning_of_week_default = beginning_of_week_default
+    end
+
+  end
+end

data/engines/internal/lib/internal/engine.rb

@@ -0,0 +1,13 @@
+module Jets::Internal
+  # Reference: https://github.com/rails/rails/blob/master/actionmailer/lib/action_mailer/railtie.rb
+  class Engine < ::Jets::Engine
+  end
+end
+
+require_relative "actiondispatch"
+require_relative "actionmailer"
+require_relative "actionview"
+require_relative "activerecord"
+require_relative "activesupport"
+require_relative "i18n_engine"
+require_relative "jets_controller"

data/engines/internal/lib/internal/i18n_engine.rb

@@ -0,0 +1,19 @@
+module Jets::Internal
+  # Reference: https://github.com/rails/rails/blob/master/activesupport/lib/active_support/i18n_railtie.rb
+  class I18nEngine < ::Jets::Turbine
+    config.i18n = ActiveSupport::OrderedOptions.new
+    config.i18n.turbines_load_path = []
+    config.i18n.load_path = []
+    config.i18n.fallbacks = ActiveSupport::OrderedOptions.new
+
+    # Set the i18n configuration after initialization since a lot of
+    # configuration is still usually done in application initializers.
+    config.after_initialize do |app|
+      I18n.load_path |= app.config.i18n.turbines_load_path.flat_map(&:existent)
+      I18n.load_path |= app.config.i18n.load_path.flat_map(&:existent)
+      I18n.load_path |= Dir["#{app.root}/config/locales/*.yml"]
+      I18n.load_path.uniq!
+      I18n.backend.load_translations
+    end
+  end
+end

data/engines/internal/lib/internal/jets_controller.rb

@@ -0,0 +1,46 @@
+require_relative "turbines/helpers"
+require_relative "turbines/routes_helpers"
+
+module Jets::Internal
+  class JetsController < ::Jets::Turbine
+    config.cache_store = :memory_store
+    config.jets_controller = ActiveSupport::OrderedOptions.new
+    config.jets_controller.default_protect_from_forgery = nil
+    config.jets_controller.perform_caching = false
+    config.jets_controller.wrap_parameters_by_default = true
+    config.jets_controller.cache_store = nil
+
+    initializer "action_controller.set_helpers_path" do |app|
+      require "action_controller/metal/helpers"
+      ActionController::Helpers.helpers_path = app.helpers_paths
+    end
+
+    initializer "jets_controller.set_configs" do |app|
+      paths   = app.config.paths
+      options = app.config.jets_controller
+
+      options.logger      ||= Jets.logger
+      options.cache_store ||= Jets.cache
+
+      ActiveSupport.on_load(:jets_controller) do
+        wrap_parameters format: [:json] if app.config.jets_controller.wrap_parameters_by_default && respond_to?(:wrap_parameters)
+      end
+    end
+
+    initializer "jets_controller.set_caching" do |app|
+      ActiveSupport.on_load(:jets_controller) do
+        self.perform_caching = app.config.jets_controller.perform_caching
+        self.cache_store = app.config.cache_store # IE: default is :memory_store
+      end
+    end
+
+    initializer "jets_controller.request_forgery_protection" do |app|
+      ActiveSupport.on_load(:jets_controller) do
+        default_protect_from_forgery = app.config.jets_controller.default_protect_from_forgery
+        if default_protect_from_forgery.nil? && app.config.mode == "html" || default_protect_from_forgery
+          protect_from_forgery with: :exception
+        end
+      end
+    end
+  end
+end

data/engines/internal/lib/internal/overrides/debug_exceptions.rb

@@ -0,0 +1,40 @@
+# These overrides allows DebugExceptions middleware to work with Jets.
+
+# Straight override the initialize method to customize the template paths and
+# include additiional jets rescue templates when needed.
+# Note: With the way the ActionDispatch::DebugView class is written, we cannot
+# use super to call the original initialize method.  Got to override the whole
+# method.
+ActionDispatch::DebugView.class_eval do
+  def initialize(assigns)
+    jets_templates = File.expand_path("../templates", __dir__)
+    paths = [jets_templates, ActionDispatch::DebugView::RESCUES_TEMPLATE_PATH]
+    lookup_context = ActionView::LookupContext.new(paths)
+    super(lookup_context, assigns, nil)
+  end
+end
+
+# Override source_fragment to use Jets.root instead of Rails.root
+ActionDispatch::ExceptionWrapper.class_eval do
+private
+  def source_fragment(path, line)
+    # Jets.root was Rails.root
+    return unless Jets.respond_to?(:root) && Jets.root
+    full_path = Jets.root.join(path)
+    if File.exist?(full_path)
+      File.open(full_path, "r") do |file|
+        start = [line - 3, 0].max
+        lines = file.each_line.drop(start).take(6)
+        Hash[*(start + 1..(lines.count + start)).zip(lines).flatten]
+      end
+    end
+  end
+end
+
+load "action_dispatch/middleware/debug_exceptions.rb"
+
+ActionView::Helpers::SanitizeHelper::ClassMethods.module_eval do
+  def sanitizer_vendor
+    Jets::Html::Sanitizer # was Rails::Html::Sanitizer
+  end
+end

data/engines/internal/lib/internal/templates/rescues/_trace.html.erb

@@ -0,0 +1,62 @@
+<% names = traces.keys %>
+<% error_index = local_assigns[:error_index] || 0 %>
+
+<p><code>Jets.root: <%= defined?(Jets) && Jets.respond_to?(:root) ? Jets.root : "unset" %></code></p>
+
+<div id="traces-<%= error_index %>">
+  <% names.each do |name| %>
+    <%
+      show = "show('#{name.gsub(/\s/, '-')}-#{error_index}');"
+      hide = (names - [name]).collect {|hide_name| "hide('#{hide_name.gsub(/\s/, '-')}-#{error_index}');"}
+    %>
+    <a href="#" onclick="<%= hide.join %><%= show %>; return false;"><%= name %></a> <%= '|' unless names.last == name %>
+  <% end %>
+
+  <% traces.each do |name, trace| %>
+    <div id="<%= "#{name.gsub(/\s/, '-')}-#{error_index}" %>" style="display: <%= (name == trace_to_show) ? 'block' : 'none' %>;">
+      <code class="traces">
+        <% trace.each do |frame| %>
+          <a class="trace-frames trace-frames-<%= error_index %>" data-exception-object-id="<%= frame[:exception_object_id] %>" data-frame-id="<%= frame[:id] %>" href="#">
+            <%= frame[:trace] %>
+          </a>
+          <br>
+        <% end %>
+      </code>
+    </div>
+  <% end %>
+
+  <script>
+    (function() {
+      var traceFrames = document.getElementsByClassName('trace-frames-<%= error_index %>');
+      var selectedFrame, currentSource = document.getElementById('frame-source-<%= error_index %>-0');
+
+      // Add click listeners for all stack frames
+      for (var i = 0; i < traceFrames.length; i++) {
+        traceFrames[i].addEventListener('click', function(e) {
+          e.preventDefault();
+          var target = e.target;
+          var frame_id = target.dataset.frameId;
+
+          if (selectedFrame) {
+            selectedFrame.className = selectedFrame.className.replace("selected", "");
+          }
+
+          target.className += " selected";
+          selectedFrame = target;
+
+          // Change the extracted source code
+          changeSourceExtract(frame_id);
+        });
+
+        function changeSourceExtract(frame_id) {
+          var el = document.getElementById('frame-source-<%= error_index %>-' + frame_id);
+          if (currentSource && el) {
+            currentSource.className += " hidden";
+            el.className = el.className.replace(" hidden", "");
+            currentSource = el;
+          }
+        }
+      }
+    })();
+  </script>
+</div>

data/engines/internal/lib/internal/templates/rescues/_trace.text.erb

@@ -0,0 +1,9 @@
+Jets.root: <%= defined?(Jets) && Jets.respond_to?(:root) ? Jets.root : "unset" %>
+
+<% @traces.each do |name, trace| %>
+<% if trace.any? %>
+<%= name %>
+<%= trace.map { |t| t[:trace] }.join("\n") %>
+
+<% end %>
+<% end %>

data/engines/internal/lib/internal/turbines/asset_tag_helper.rb

@@ -0,0 +1,70 @@
+# Override to prepend stage name when on AWS.
+module JetsTurbines
+  module AssetTagHelper
+    extend Memoist
+    include Jets::Controller::Decorate::ApigwStage
+    include Jets::AwsServices
+
+    # All paths lead to here: path_to_asset / asset_path
+    # Examples:
+    #
+    #   javascript_include_tag => path_to_javascript => path_to_asset
+    #   stylesheet_link_tag => path_to_stylesheet => path_to_asset
+    #   image_tag => path_to_image => path_to_asset
+    #
+    # Also note: Tried using compute_path but that does not always get reached.
+    # IE: jetpacker will copute sources for manifest before calling javascript_include_tag
+    #
+    #   javascript_include_tag(*sources_from_manifest_entries...)
+    # On the other hand, path_to_asset is always called.
+    def asset_path(source, options = {})
+      path = super
+      # Decorate path and prepend with s3 url when on AWS Lambda
+      # This serves assets out of s3 when on AWS Lambda.
+      path = prepend_s3_jets_public(path)
+      path
+    end
+    alias_method :path_to_asset, :asset_path
+    # Note: Must alias path_to_asset again because asset_path conflicts with an asset_path named route
+    # Otherwise, method is not called.
+    # Rails does this internally also.
+
+    # Serves favicon out of s3 when on API gateway.
+    #
+    # Useful helper for API Gateway since serving binary data like images without
+    # an Accept header doesnt work well. You can changed Media Types to '*/*'
+    # but then that messes up form data.
+    #
+    # This is Jets specific and not part of Rails. It was in the orignal Jets v3 codebase.
+    # Example usage:
+    #   <link rel="shortcut icon" href="<%= favicon_path %>">
+    #   public/favicon.ico
+    # Since Jets v5, you can also use asset_path helper and put the asset in app/assets/images
+    # Example:
+    #   <link rel="shortcut icon" href="<%= asset_path('favicon.ico') %>">
+    #   app/assets/images/favicon.ico
+    #
+    def favicon_path(path='favicon.ico')
+      add_s3_public? ? "#{s3_public}/#{path}" : "/#{path}"
+    end
+
+  private
+    def prepend_s3_jets_public(asset_path)
+      if add_s3_public? && !asset_path.starts_with?('http')
+        asset_path = "#{s3_public}#{asset_path}"
+      end
+      asset_path
+    end
+
+    def add_s3_public?
+      !!ENV['_HANDLER'] # only add s3 public when on AWS Lambda
+    end
+
+    def s3_public
+      # s3_base_url.txt is created as part of the build and deploy process
+      s3_base_url = IO.read("#{Jets.root}/config/s3_base_url.txt").strip
+      "#{s3_base_url}/public"
+    end
+    memoize :s3_public
+  end
+end

data/engines/internal/lib/internal/turbines/helpers.rb

@@ -0,0 +1,18 @@
+# Implemented this way to remind us how Rails implemented it.
+# Otherwise, would have just added another module to the include chain in
+# Jets::Controller::Base.
+module JetsTurbines
+  module Helpers
+    def inherited(klass)
+      super
+      return unless klass.respond_to?(:helpers_path=) # IE: ActionMailer does not respond to helpers_path=
+
+      paths = ActionController::Helpers.helpers_path
+      klass.helpers_path = paths
+
+      if klass.superclass == Jets::Controller::Base
+        klass.helper :all
+      end
+    end
+  end
+end

data/engines/internal/lib/internal/turbines/routes_helpers.rb

@@ -0,0 +1,42 @@
+# Rails implements with abstract_controller/turbines/routes_helpers.rb
+#
+# It's implement it this way by Rails so that the controller class _routes
+# definition points at the namespace engine routes correctly.
+#
+# This _routes controller class method used in ActionView::Rendering to create a
+# view_context_class that includes the routes url_helpers and mounted_helpers.
+#
+require "active_support/core_ext/module/introspection"
+
+module JetsTurbines
+  module RoutesHelpers
+    def self.with(routes, include_path_helpers = true)
+      Module.new do
+        define_method(:inherited) do |klass|
+          super(klass)
+
+          namespace = klass.module_parents.detect { |m| m.respond_to?(:turbine_routes_url_helpers) }
+          actual_routes = namespace ? namespace.turbine_routes_url_helpers._routes : routes
+
+          if namespace
+            klass.include(namespace.turbine_routes_url_helpers(include_path_helpers))
+          else
+            klass.include(routes.url_helpers(include_path_helpers))
+          end
+
+          # In the case that we have ex.
+          #   class A::Foo < ApplicationController
+          #   class Bar < A::Foo
+          # We will need to redefine _routes because it will not be correct
+          # via inheritance.
+          unless klass._routes.equal?(actual_routes)
+            klass.redefine_singleton_method(:_routes) { actual_routes }
+            klass.include(Module.new do
+              define_method(:_routes) { @_routes || actual_routes }
+            end)
+          end
+        end
+      end
+    end
+  end
+end

data/exe/jets

@@ -1,14 +1,5 @@
 #!/usr/bin/env ruby
 
-# traps: INT - ^C
-['INT', 'TERM', 'QUIT'].each do |signal|
-  trap(signal) do
-    puts "Detected stop signal"
-    sleep 0.2
-    exit
-  end
-end
-
 $:.unshift(File.expand_path("../../lib", __FILE__))
 require "jets"
-Jets::CLI.start
+require "jets/cli"