jets 3.1.0 → 5.0.0

data/lib/jets/generators/overrides/app/app_generator.rb

@@ -0,0 +1,148 @@
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+
+module Jets::Generators::Overrides::App
+  # Allows overriding generator creation of the Gemfile, README, etc.
+  # See: Rails::AppBuilder for the full list of overridable methods.
+  class AppBuilder < Rails::AppBuilder
+  end
+
+  module AppBaseOverrides
+    extend ActiveSupport::Concern
+    DATABASES = Rails::Generators::Database::DATABASES
+    VALID_MODES = %w[html api job]
+
+    module ClassMethods
+      # Override to support jets options only
+      def add_shared_options_for(name)
+        class_option :name,     type: :string, aliases: "-n",
+                                desc: "Name of the app"
+
+        class_option :template, type: :string, aliases: "-m",
+                                desc: "Path to some #{name} template (can be a filesystem path or URL)"
+
+        class_option :database, type: :string, aliases: "-d", default: "mysql",
+                                desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+        class_option :mode, default: 'html',
+                            desc: "mode: #{VALID_MODES.join(',')}"
+
+        class_option :javascript, type: :string, aliases: "-j", default: "importmap",
+                                  desc: "Choose JavaScript approach [options: importmap (default)]"
+
+      end
+
+      # Prepend jets_template_path to source_paths so that the jets templates
+      # can override the rails templates.
+      def source_paths
+        rails_templates_path = Rails::Generators::AppGenerator.source_root
+        [jets_templates_path, rails_templates_path] + super
+      end
+
+      def jets_templates_path
+        File.join(jets_generator_root, "templates")
+      end
+
+      def jets_generator_root
+        File.expand_path(__dir__)
+      end
+
+      def banner # :doc:
+        "jets new #{arguments.map(&:usage).join(' ')} [options]"
+      end
+
+      def usage_path
+        path = File.join(jets_generator_root, "USAGE")
+        if File.exist?(path)
+          path
+        else
+          super
+        end
+      end
+
+      # We want to exit on failure to be kind to other libraries
+      # This is only when accessing via CLI
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+
+  class AppGenerator < Rails::Generators::AppBase
+    include AppBaseOverrides
+    include Helpers
+
+    add_shared_options_for "application"
+
+    public_task :set_default_accessors!
+    public_task :create_root
+    # public_task :target_rails_prerelease
+
+    # The Rails way generates a project piecemeal like so:
+    #
+    #   def create_root_files
+    #     build(:readme)
+    #     build(:rakefile)
+    #   end
+    #
+    # The Jets way generates the entire project at once.
+    #
+    # We first create the entire project at once because it's easier to maintain.
+    # But we can also use the Rails way to generate piecemeal and leverage
+    # the existing Rails generators.
+
+    public_task :set_initial_variables
+    public_task :copy_project # Note: Support for clone has been removed
+
+    def create_root_files
+      build(:version_control)
+    end
+
+    def create_bin_files
+      build(:bin)
+    end
+
+    # def create_active_record_files
+    #   return if options[:skip_active_record]
+    #   build(:database_yml)
+    # end
+
+    public_task :run_bundle
+
+    # Custom version because Rails run_javascript calls rails importmap:install
+    def run_javascript
+      return unless options[:mode] == "html"
+
+      if options[:javascript] == "importmap"
+        sh "bundle exec jets importmap:install"
+      else
+        puts "WARN: Only importmap is supported at this time."
+      end
+    end
+
+    public_task :git_first_commit
+
+  private
+    def gemfile_entries # :doc:
+      if options[:database].nil? # --no-database
+        return []
+      end
+
+      [
+        database_gemfile_entry,
+      ].flatten.compact.select(&@gem_filter)
+    end
+
+  def sh(command)
+      puts "=> #{command}"
+      system(command)
+    end
+
+    def get_builder_class
+      AppBuilder
+    end
+  end
+end
+
+# Keeps zeitwerk happy
+Jets::Generators::AppGenerator = Jets::Generators::Overrides::App::AppGenerator

data/lib/jets/generators/overrides/app/helpers.rb

@@ -0,0 +1,139 @@
+module Jets::Generators::Overrides::App
+  module Helpers
+  private
+    def set_initial_variables
+      @project_folder = app_path
+      @project_name = app_path == '.' ? File.basename(Dir.pwd) : app_path
+      @app_namespace = @project_name.gsub('-','_').gsub(/[^a-zA-Z_0-9]/, '').camelize
+      @database_name = @project_name.gsub('-','_')
+
+      # options is a frozen hash by Thor so cannot modify it.
+      # Also had trouble unfreezing it with .dup. So using instance variables instead
+      case options[:mode]
+      when 'html'
+        @bootstrap = options[:bootstrap]
+        @database = options[:database]
+        @javascript = options[:javascript] # importmap or webpacker
+      when 'api'
+        @bootstrap = false
+        @database = options[:database]
+        @javascript = 'none'
+      when 'job'
+        @bootstrap = false
+        @database = false
+        @javascript = 'none'
+      else
+        puts "Invalid mode provided: #{@options[:mode].color(:red)}. Please pass in an valid mode: #{VALID_MODES.join(',').color(:green)}."
+        exit 1
+      end
+    end
+
+    def jets_minor_version
+      md = Jets::VERSION.match(/(\d+)\.(\d+)\.\d+/)
+      major, minor = md[1], md[2]
+      [major, minor, '0'].join('.')
+    end
+
+    def clone_project
+      unless git_installed?
+        abort "Unable to detect git installation on your system. Git needs to be installed in order to use the --repo option."
+      end
+
+      if File.exist?(project_folder)
+        abort "The folder #{project_folder} already exists."
+      else
+        run "git clone https://github.com/#{options[:repo]} #{project_folder}"
+      end
+      confirm_jets_project
+    end
+
+    def confirm_jets_project
+      jets_project = File.exist?("#{project_folder}/config/application.rb")
+      unless jets_project
+        puts "#{options[:repo]} does not look like a Jets project. Double check your repo!".color(:red)
+        exit 1
+      end
+    end
+
+    def copy_project
+      directory ".", ".", copy_options
+    end
+
+    def copy_options
+      excludes = excludes()
+      default_excludes = %w[
+        bin
+      ]
+      excludes += default_excludes
+      excludes.uniq!
+
+      unless @database
+        excludes += %w[
+          database.yml
+          db
+          models/application_record
+        ]
+      end
+
+      if excludes.empty?
+        {}
+      else
+        pattern = Regexp.new(excludes.join('|'))
+        {exclude_pattern: pattern }
+      end
+    end
+
+    def excludes
+      case @options[:mode]
+      when 'job'
+        # For job mode: list of words to include in the exclude pattern and will not be generated.
+        %w[
+          app/views
+          assets
+          config.ru
+          config/database.yml
+          config/dynamodb.yml
+          config/initializers
+          controllers
+          db/
+          helpers
+          javascript
+          models/application_
+          Procfile
+          public
+          routes
+          spec
+          yarn
+        ]
+      when 'api'
+        %w[
+          app/assets
+          app/views
+        ]
+      else # html
+        []
+      end
+    end
+
+    def git_first_commit
+      return unless git_installed? && git_credentials_set?
+      run("git add .")
+      run("git commit -m 'first commit'")
+    end
+
+    def git_installed?
+      system("type git > /dev/null 2>&1")
+    end
+
+    # In order to automatically create first commit
+    # the user needs to have their credentials set
+    def git_credentials_set?
+      configs = `git config --list`.split("\n")
+      configs.any? { |c| c.start_with? 'user.name=' } && configs.any? { |c| c.start_with? 'user.email=' }
+    end
+
+    def yarn_installed?
+      system("type yarn > /dev/null 2>&1")
+    end
+  end
+end

data/lib/jets/generators/overrides/app/templates/.env

@@ -0,0 +1,10 @@
+# Variables in here are available and shared across all environments: development, production, etc
+# Docs: https://docs.rubyonjets.com/docs/env-files/
+
+# Examples:
+# DATABASE_URL="mysql2://user:pass@host.com/db_name?pool=5" # raw value as-is
+# SSM can be use to reference a parameter store value
+# DATABASE_URL=SSM                       # conventionally references /PROJECT_NAME/JETS_ENV/DATABASE_URL
+# DATABASE_URL=SSM                       # /demo/development/DATABASE_URL
+# DATABASE_URL=SSM:database-url          # /demo/development/database-url
+# DATABASE_URL=SSM:/path/to/database-url # /path/to/database-url

data/lib/jets/{commands/templates/skeleton/.gitignore → generators/overrides/app/templates/.gitignore.tt}

@@ -1,9 +1,10 @@
-*.gem
 .bundle
 .byebug_history
 .DS_Store
 .env*
+*.gem
 /node_modules
+/public/assets
 /public/packs
 /public/packs-test
 bundled

data/lib/jets/generators/overrides/app/templates/Gemfile.tt

@@ -0,0 +1,25 @@
+source "https://rubygems.org"
+
+gem "jets", "~> <%= Jets::VERSION %>"
+
+<%- if options[:mode] != 'job' && !options[:database].nil? -%>
+<%= database_gemfile_entry %>
+gem "sprockets-jets"
+<%- end -%>
+<%- if options[:mode] == 'html' -%>
+gem "importmap-jets"
+<%- end -%>
+gem "zeitwerk", ">= 2.6.12"
+
+# development and test groups are not bundled as part of the deployment
+group :development, :test do
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+<%- unless options[:mode] == 'job' -%>
+  gem 'rack'
+  gem 'puma'
+<%- end -%>
+end
+
+group :test do
+  gem 'rspec'
+end

data/lib/jets/generators/overrides/app/templates/Rakefile

@@ -0,0 +1,2 @@
+require 'jets'
+Jets.application.load_tasks

data/lib/jets/generators/overrides/app/templates/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link_tree ../javascripts .js

data/lib/jets/generators/overrides/app/templates/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS (and SCSS, if configured) file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/lib/jets/generators/overrides/app/templates/app/javascript/application.js

@@ -0,0 +1,5 @@
+// Configure your import map in config/importmap.rb. Read more: https://github.com/boltops-tools/importmap-jets
+import jquery from 'jquery'
+window.$ = jquery
+import Jets from "@rubyonjets/ujs-compat"
+Jets.start()

data/lib/jets/{commands/templates/skeleton → generators/overrides/app/templates}/app/models/application_record.rb

@@ -1,3 +1,3 @@
 class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
+  primary_abstract_class
 end

data/lib/jets/generators/overrides/app/templates/app/views/layouts/application.html.erb.tt

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="theme-color" content="#000000">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <%%= csrf_meta_tags %>
+    <title>Jets App</title>
+    <link rel="shortcut icon" href="<%%= favicon_path %>">
+    <% if @webpacker %>
+    <%%= javascript_pack_tag "application" %>
+    <%%= stylesheet_pack_tag "theme" %>
+    <% else %>
+    <%%= stylesheet_link_tag "application" %><%# NOTE: javascript_importmap_tags is inserted by importmap:install %>
+    <% end %>
+  </head>
+<body>
+<section class="starter">
+  <div class="container">
+    <div class="row">
+      <div class="col-md-9 content-body">
+        <%% if @title %><h1><%%= @title %></h1><%% end %>
+        <%%= yield %>
+      </div>
+    </div>
+  </div>
+</section>
+</body>
+</html>

data/lib/jets/generators/overrides/app/templates/bin/jets

@@ -0,0 +1,3 @@
+APP_PATH = File.expand_path("../config/application", __dir__)
+require "jets"
+require "jets/commands"

data/lib/jets/generators/overrides/app/templates/config/application.rb.tt

@@ -0,0 +1,15 @@
+module <%= @app_namespace %>
+  class Application < Jets::Application
+    config.load_defaults 5.0
+
+    config.project_name = "<%= @project_name %>"
+    config.mode = "<%= @options[:mode] %>"
+
+<%- if @options[:mode] == 'job' -%>
+    config.prewarm.enable = false
+<%- end -%>
+    # Docs:
+    # https://rubyonjets.com/docs/config/
+    # https://rubyonjets.com/docs/config/reference/
+  end
+end

data/lib/jets/{commands/templates/skeleton → generators/overrides/app/templates}/config/database.yml.tt

@@ -11,7 +11,7 @@ default: &default
   password: <%%= ENV['DB_PASS'] %>
   host: <%%= ENV["DB_HOST"] %>
   url: <%%= ENV['DATABASE_URL'] %> # takes higher precedence than other settings
-  reconnect: true
+  # reconnect: true # reconnect option is deprecated with newer mysql database versions
 
 development:
   <<: *default

data/lib/jets/generators/overrides/app/templates/config/environments/development.rb.tt

@@ -0,0 +1,29 @@
+Jets.application.configure do
+  # Docs: https://rubyonjets.com/docs/config/reference/
+
+  config.cache_classes = false
+  config.eager_load = false
+  config.logging.event = false # dont show large event in local development logging
+
+<%- unless options[:mode] == 'job' -%>
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable server timing
+  config.server_timing = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Jets.root.join("tmp/caching-dev.txt").exist?
+    config.jets_controller.perform_caching = true
+    config.cache_store = :memory_store
+  else
+    config.jets_controller.perform_caching = false
+    config.cache_store = :null_store
+  end
+
+  # Docs: http://rubyonjets.com/docs/email-sending/
+  config.action_mailer.raise_delivery_errors = false
+  config.action_mailer.perform_caching = false
+  # config.action_mailer.default_url_options = { host: 'localhost', port: 8888 }
+<%- end -%>
+end

data/lib/jets/generators/overrides/app/templates/config/environments/production.rb.tt

@@ -0,0 +1,19 @@
+Jets.application.configure do
+  config.cache_classes = true
+  config.eager_load = true
+  config.log_level = :info
+  config.logging.event = true # useful for CloudWatch logs
+
+<%- unless options[:mode] == 'job' -%>
+  config.consider_all_requests_local       = false
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # Docs: http://rubyonjets.com/docs/email-sending/
+  config.action_mailer.raise_delivery_errors = true
+  config.action_mailer.perform_caching = false
+  # config.action_mailer.default_url_options = { host: 'localhost', port: 8888 }
+<%- end -%>
+end

data/lib/jets/generators/overrides/app/templates/config/environments/test.rb.tt

@@ -0,0 +1,23 @@
+Jets.application.configure do
+  config.cache_classes = false
+  config.eager_load = ENV["CI"].present?
+  config.cache_store = :null_store
+
+<%- unless options[:mode] == 'job' -%>
+  config.consider_all_requests_local = true
+  config.server_timing = true
+
+  config.jets_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # Docs: http://rubyonjets.com/docs/email-sending/
+  config.action_mailer.delivery_method = :test
+  config.action_mailer.perform_caching = false
+  # config.action_mailer.default_url_options = { host: 'localhost', port: 8888 }
+<%- end -%>
+end

data/lib/jets/generators/overrides/app/templates/config/initializers/content_security_policy.rb

@@ -0,0 +1,31 @@
+# Be sure to restart your server when you modify this file.
+#
+# Define an application-wide content security policy.
+# The Rails docs cover how to use Content Security Policy headers, Jets
+# uses the same interface.
+# See the Securing Rails Applications Guide for more information:
+# https://guides.rubyonrails.org/security.html#content-security-policy-header
+#
+# Note: Turning on the policy below will result in not being able to use
+# inline tags unless their are secure. For example, inline style
+# tags will not work.
+#
+# Jets.application.configure do
+#   config.content_security_policy do |policy|
+#     policy.default_src :self, :https
+#     policy.font_src    :self, :https, :data
+#     policy.img_src     :self, :https, :data
+#     policy.object_src  :none
+#     policy.script_src  :self, :https
+#     policy.style_src   :self, :https
+#     # Specify URI for violation reports
+#     # policy.report_uri "/csp-violation-report-endpoint"
+#   end
+#
+#   # Generate session nonces for permitted importmap and inline scripts
+#   config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s }
+#   config.content_security_policy_nonce_directives = %w(script-src)
+#
+#   # Report violations without enforcing the policy.
+#   # config.content_security_policy_report_only = true
+# end

data/lib/jets/generators/overrides/app/templates/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure parameters to be filtered from the log file. Use this to limit dissemination of
+# sensitive information. See the ActiveSupport::ParameterFilter documentation for supported
+# notations and behaviors.
+Jets.application.config.filter_parameters += [
+  :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
+]

data/lib/jets/generators/overrides/app/templates/config/initializers/permissions_policy.rb

@@ -0,0 +1,11 @@
+# Define an application-wide HTTP permissions policy. For further
+# information see https://developers.google.com/web/updates/2018/06/feature-policy
+#
+# Jets.application.config.permissions_policy do |f|
+#   f.camera      :none
+#   f.gyroscope   :none
+#   f.microphone  :none
+#   f.usb         :none
+#   f.fullscreen  :self
+#   f.payment     :self, "https://secure.example.com"
+# end

data/lib/jets/{commands/templates/skeleton → generators/overrides/app/templates}/config/routes.rb

@@ -1,5 +1,9 @@
 Jets.application.routes.draw do
-  root "jets/public#show"
+  root "jets/welcome#index"
+
+  # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
+  # Can be used by load balancers and uptime monitors to verify that the app is live.
+  get "up" => "jets/health#show", as: :jets_health_check
 
   # The jets/public#show controller can serve static utf8 content out of the public folder.
   # Note, as part of the deploy process Jets uploads files in the public folder to s3

data/lib/jets/{commands/templates/skeleton → generators/overrides/app/templates}/public/404.html

@@ -4,7 +4,7 @@
   <title>The page you were looking for doesn't exist (404)</title>
   <meta name="viewport" content="width=device-width,initial-scale=1">
   <style>
-  .rails-default-error-page {
+  .jets-default-error-page {
     background-color: #EFEFEF;
     color: #2E2F30;
     text-align: center;
@@ -12,13 +12,13 @@
     margin: 0;
   }
 
-  .rails-default-error-page div.dialog {
+  .jets-default-error-page div.dialog {
     width: 95%;
     max-width: 33em;
     margin: 4em auto 0;
   }
 
-  .rails-default-error-page div.dialog > div {
+  .jets-default-error-page div.dialog > div {
     border: 1px solid #CCC;
     border-right-color: #999;
     border-left-color: #999;
@@ -31,13 +31,13 @@
     box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
   }
 
-  .rails-default-error-page h1 {
+  .jets-default-error-page h1 {
     font-size: 100%;
     color: #730E15;
     line-height: 1.5em;
   }
 
-  .rails-default-error-page div.dialog > p {
+  .jets-default-error-page div.dialog > p {
     margin: 0 0 1em;
     padding: 1em;
     background-color: #F7F7F7;
@@ -54,7 +54,7 @@
   </style>
 </head>
 
-<body class="rails-default-error-page">
+<body class="jets-default-error-page">
   <!-- This file lives in public/404.html -->
   <div class="dialog">
     <div>