plutonium 0.10.2 → 0.11.0

data/lib/generators/pu/res/conn/conn_generator.rb

@@ -17,7 +17,7 @@ module Pu
         source_feature = select_feature
         source_module = (source_feature == "main_app") ? "ResourceRecord" : "#{source_feature.classify}::ResourceRecord"
 
-        Rails.application.eager_load!
+        Plutonium.eager_load_rails!
         available_resources = source_module.constantize.descendants.map(&:to_s)
         selected_resources = prompt.multi_select("Select resources", available_resources)
 
@@ -27,9 +27,9 @@ module Pu
           @resource_class = resource
 
           template "app/controllers/resource_controller.rb", "packages/#{package_namespace}/app/controllers/#{package_namespace}/#{resource.pluralize.underscore}_controller.rb"
-          template "app/policies/resource_policy.rb", "packages/#{package_namespace}/app/policies/#{package_namespace}/#{resource.underscore}_policy.rb"
-          template "app/presenters/resource_presenter.rb", "packages/#{package_namespace}/app/presenters/#{package_namespace}/#{resource.underscore}_presenter.rb"
-          template "app/query_objects/resource_query_object.rb", "packages/#{package_namespace}/app/query_objects/#{package_namespace}/#{resource.underscore}_query_object.rb"
+          # template "app/policies/resource_policy.rb", "packages/#{package_namespace}/app/policies/#{package_namespace}/#{resource.underscore}_policy.rb"
+          # template "app/presenters/resource_presenter.rb", "packages/#{package_namespace}/app/presenters/#{package_namespace}/#{resource.underscore}_presenter.rb"
+          # template "app/query_objects/resource_query_object.rb", "packages/#{package_namespace}/app/query_objects/#{package_namespace}/#{resource.underscore}_query_object.rb"
 
           insert_into_file "packages/#{package_namespace}/lib/engine.rb",
             indent("register_resource ::#{resource}\n", 6),

data/lib/generators/pu/res/conn/templates/app/controllers/resource_controller.rb.tt

@@ -1,3 +1,3 @@
 class <%= app_namespace %>::<%= resource_class.pluralize %>Controller < ::<%= resource_class.pluralize %>Controller
-  include <%= app_namespace %>::<%= app_namespace %>Controller
+  include <%= app_namespace %>::Concerns::Controller
 end

data/lib/generators/pu/res/model/model_generator.rb

@@ -14,9 +14,9 @@ module Pu
       def run_create_model
         model_class = class_name.safe_constantize
         if model_class.present? && !model_class.include?(Plutonium::Resource::Record)
-          insert_into_file File.join("app/models", class_path, "#{file_name}.rb"),
-            indent("include Plutonium::Resource::Record\n", 2),
-            after: /.*class .*\n/
+          gsub_file File.join("app/models", class_path, "#{file_name}.rb"),
+            "< ApplicationRecord",
+            "< ResourceRecord"
         end
 
         create_model_file if create_files?

data/lib/generators/pu/res/scaffold/templates/policy.rb.tt

@@ -19,5 +19,11 @@ class <%= class_name %>Policy < <%= [feature_package_name, "ResourcePolicy"].joi
   def permitted_attributes_for_read
     <%= attributes.select{ |a| !a.rich_text? && !a.password_digest? && !a.token? }.map(&:name).map(&:to_sym).inspect %>
   end
+
+  # Associations
+
+  def permitted_associations
+    %i[]
+  end
 end
 <% end -%>

data/lib/generators/pu/rodauth/account_generator.rb

@@ -28,7 +28,7 @@ module Pu
       end
 
       def create_rodauth_app
-        template "app/misc/account_rodauth_plugin.rb", "app/misc/#{account_path}_rodauth_plugin.rb"
+        template "app/rodauth/account_rodauth_plugin.rb", "app/rodauth/#{account_path}_rodauth_plugin.rb"
       end
 
       def configure_rodauth_plugin
@@ -36,16 +36,16 @@ module Pu
           plugin_name = indent(
             "configure ::#{account_path.classify}RodauthPlugin#{", :#{table_prefix}" unless primary?}\n", 2
           )
-          gsub_file "app/misc/rodauth_app.rb", /.*# configure RodauthMain\n/, ""
-          insert_into_file "app/misc/rodauth_app.rb", plugin_name, after: "# auth configuration\n"
+          gsub_file "app/rodauth/rodauth_app.rb", /.*# configure RodauthMain\n/, ""
+          insert_into_file "app/rodauth/rodauth_app.rb", plugin_name, after: "# auth configuration\n"
         end
       end
 
       def configure_rodauth_plugin_load_route
         in_root do
           route_config = indent("r.rodauth#{"(:#{table_prefix})" unless primary?}\n", 4)
-          gsub_file "app/misc/rodauth_app.rb", /.*# r\.rodauth\n/, ""
-          insert_into_file "app/misc/rodauth_app.rb", route_config, after: "# auth route configuration\n"
+          gsub_file "app/rodauth/rodauth_app.rb", /.*# r\.rodauth\n/, ""
+          insert_into_file "app/rodauth/rodauth_app.rb", route_config, after: "# auth route configuration\n"
         end
       end
 
@@ -54,15 +54,15 @@ module Pu
           plugin_config = indent(
             "rodauth#{"(:#{table_prefix})" unless primary?}.load_memory # autologin remembered #{table}\n", 4
           )
-          gsub_file "app/misc/rodauth_app.rb", /.*# rodauth\.load_memory.*\n/, ""
+          gsub_file "app/rodauth/rodauth_app.rb", /.*# rodauth\.load_memory.*\n/, ""
 
           if remember?
-            insert_into_file "app/misc/rodauth_app.rb", plugin_config, after: "# plugin route configuration\n"
+            insert_into_file "app/rodauth/rodauth_app.rb", plugin_config, after: "# plugin route configuration\n"
           else
-            gsub_file "app/misc/rodauth_app.rb", plugin_config, ""
+            gsub_file "app/rodauth/rodauth_app.rb", plugin_config, ""
             in_root do
-              unless File.read("app/misc/rodauth_app.rb").match?(/.*\.load_memory # autologin/)
-                insert_into_file "app/misc/rodauth_app.rb", indent("# rodauth.load_memory # autologin remembered users\n", 4),
+              unless File.read("app/rodauth/rodauth_app.rb").match?(/.*\.load_memory # autologin/)
+                insert_into_file "app/rodauth/rodauth_app.rb", indent("# rodauth.load_memory # autologin remembered users\n", 4),
                   after: "# plugin route configuration\n"
               end
             end

data/lib/generators/pu/rodauth/install_generator.rb

@@ -1,9 +1,12 @@
 require "rails/generators/base"
+require "rails/generators/active_record/migration"
 require "securerandom"
 
 module Pu
   module Rodauth
     class InstallGenerator < ::Rails::Generators::Base
+      include ::ActiveRecord::Generators::Migration
+
       SEQUEL_ADAPTERS = {
         "postgresql" => (RUBY_ENGINE == "jruby") ? "postgresql" : "postgres",
         "mysql2" => (RUBY_ENGINE == "jruby") ? "mysql" : "mysql2",
@@ -31,8 +34,8 @@ module Pu
       end
 
       def create_rodauth_app
-        template "app/misc/rodauth_app.rb"
-        template "app/misc/rodauth_plugin.rb"
+        template "app/rodauth/rodauth_app.rb"
+        template "app/rodauth/rodauth_plugin.rb"
       end
 
       def add_dev_config
@@ -41,6 +44,10 @@ module Pu
           before: /^end/
       end
 
+      def create_install_migration
+        migration_template "db/migrate/install_rodauth.rb", "db/migrate/install_rodauth.rb" # , File.join(db_migrate_path, "#{migration_name}.rb")
+      end
+
       def show_instructions
         readme "INSTRUCTIONS" if behavior == :invoke
       end

data/lib/generators/pu/rodauth/migration/sequel/audit_logging.erb

@@ -12,6 +12,6 @@ create_table :<%= table_prefix %>_authentication_audit_logs do
 <% else -%>
   String :metadata
 <% end -%>
-  index [:<%= table_prefix %>_id, :at], name: :audit_<%= table_prefix %>_at_idx
-  index :at, name: :audit_at_idx
+  index [:<%= table_prefix %>_id, :at], name: :<%= table_prefix %>_audit_<%= table_prefix %>_at_idx
+  index :at, name: :<%= table_prefix %>_audit_at_idx
 end

data/lib/generators/pu/rodauth/migration_generator.rb

@@ -69,7 +69,7 @@ module Pu
       private
 
       def plugin_filename
-        "app/misc/#{account_path}_rodauth_plugin.rb"
+        "app/rodauth/#{account_path}_rodauth_plugin.rb"
       end
 
       def migration_name

data/lib/generators/pu/rodauth/templates/app/{misc → rodauth}/account_rodauth_plugin.rb.tt

@@ -38,8 +38,8 @@ class <%= account_path.classify %>RodauthPlugin < RodauthPlugin
     rails_account_model { <%= account_path.classify %> }
 <% if verify_account? -%>
 
-    # Set password when verifying account.
-    verify_account_set_password? false
+    # Set password password during create account.
+    # verify_account_set_password? false
 <% end -%>
 
     # Change some default param keys.

data/lib/generators/pu/rodauth/templates/app/{misc → rodauth}/rodauth_plugin.rb.tt

@@ -50,9 +50,6 @@ class RodauthPlugin < Rodauth::Rails::Auth
     # Store account status in an integer column without foreign key constraint.
     account_status_column :status
 
-    # Set password when verifying account.
-    # verify_account_set_password? false
-
     # Change some default param keys/labels.
     login_label "Email"
     login_param "email"

data/lib/generators/pu/rodauth/templates/db/migrate/install_rodauth.rb.tt

@@ -0,0 +1,5 @@
+class InstallRodauth < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    enable_extension "citext"
+  end
+end

data/lib/generators/pu/service/postgres/postgres_generator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Service
+    class PostgresGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Set up postgres for project"
+
+      def start
+        bundle "goldiloader"
+        template "database.yml", "config/database.yml", force: true
+        bin_directory
+        add_compose_env :POSTGRES_HOST, service
+        add_compose_dependency service
+        add_compose_service service, compose_config
+        add_docker_dependency docker_deps
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def service
+        :postgres
+      end
+
+      def compose_config
+        <<~COMPOSE
+          postgres:
+            image: postgres:15 # postgres
+            # postgres properties
+            environment: # postgres
+              POSTGRES_MULTIPLE_DATABASES: #{db_prefix}_development,#{db_prefix}_test # postgres
+              POSTGRES_USER: postgres # postgres
+              POSTGRES_PASSWORD: postgres # postgres
+            volumes: # postgres
+            - "./.volumes/postgres/data:/var/lib/postgresql/data" # postgres
+            - "./bin/initdb.d:/docker-entrypoint-initdb.d" # postgres
+        COMPOSE
+      end
+
+      def docker_deps
+        <<~DEPS
+          # Install packages needed for postgres
+          RUN apt-get update -qq && \\
+              apt-get install --no-install-recommends -y curl postgresql-client && \\
+              rm -rf /var/lib/apt/lists /var/cache/apt/archives
+        DEPS
+      end
+
+      def db_prefix
+        Plutonium.application_name.underscore
+      end
+    end
+  end
+end

data/lib/generators/pu/service/postgres/templates/bin/initdb.d/create-multiple-postgresql-databases.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+set -u
+
+function create_user_and_database() {
+	local database=$1
+	echo "  Creating user and database '$database'"
+	psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL
+	    CREATE USER $database;
+	    CREATE DATABASE $database;
+	    GRANT ALL PRIVILEGES ON DATABASE $database TO $database;
+EOSQL
+}
+
+if [ -n "$POSTGRES_MULTIPLE_DATABASES" ]; then
+	echo "Multiple database creation requested: $POSTGRES_MULTIPLE_DATABASES"
+	for db in $(echo $POSTGRES_MULTIPLE_DATABASES | tr ',' ' '); do
+		create_user_and_database $db
+	done
+	echo "Multiple databases created"
+fi

data/lib/generators/pu/service/postgres/templates/database.yml.tt

@@ -0,0 +1,93 @@
+# PostgreSQL. Versions 9.3 and up are supported.
+#
+# Install the pg driver:
+#   gem install pg
+# On macOS with Homebrew:
+#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
+# On Windows:
+#   gem install pg
+#       Choose the win32 build.
+#       Install PostgreSQL and put its /bin directory on your path.
+#
+# Configure Using Gemfile
+# gem "pg"
+#
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  # For details on connection pooling, see Rails configuration guide
+  # https://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  # Timeouts
+  connect_timeout: 1
+  checkout_timeout: 1
+  variables:
+    statement_timeout: <%%= ENV["STATEMENT_TIMEOUT"] || "15s" %> # or ms, min, etc
+
+local: &local
+  host: <%%= ENV["POSTGRES_HOST"] %>
+  port: 5432
+  username: postgres
+  password: postgres
+
+development:
+  <<: [*default, *local]
+  database: <%= db_prefix %>_development
+
+  # The specified database role being used to connect to PostgreSQL.
+  # To create additional roles in PostgreSQL see `$ createuser --help`.
+  # When left blank, PostgreSQL will use the default role. This is
+  # the same name as the operating system user running Rails.
+  #username: <%= db_prefix %>
+
+  # The password associated with the PostgreSQL role (username).
+  #password:
+
+  # Connect on a TCP socket. Omitted by default since the client uses a
+  # domain socket that doesn't need configuration. Windows does not have
+  # domain sockets, so uncomment these lines.
+  #host: localhost
+
+  # The TCP port the server listens on. Defaults to 5432.
+  # If your server runs on a different port number, change accordingly.
+  #port: 5432
+
+  # Schema search path. The server defaults to $user,public
+  #schema_search_path: myapp,sharedapp,public
+
+  # Minimum log levels, in increasing order:
+  #   debug5, debug4, debug3, debug2, debug1,
+  #   log, notice, warning, error, fatal, and panic
+  # Defaults to warning.
+  #min_messages: notice
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: [*default, *local]
+  database: <%= db_prefix %>_test
+
+# As with config/credentials.yml, you never want to store sensitive information,
+# like your database password, in your source code. If your source code is
+# ever seen by anyone, they now have access to your database.
+#
+# Instead, provide the password or a full connection URL as an environment
+# variable when you boot the app. For example:
+#
+#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
+#
+# If the connection URL is provided in the special DATABASE_URL environment
+# variable, Rails will automatically merge its configuration values on top of
+# the values provided in this file. Alternatively, you can specify a connection
+# URL environment variable explicitly:
+#
+#   production:
+#     url: <%%= ENV["MY_APP_DATABASE_URL"] %>
+#
+# Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
+# for a full overview on how database connection configuration can be specified.
+#
+production:
+  <<: *default
+  database: <%= db_prefix %>_production

data/lib/generators/pu/service/sidekiq/sidekiq_generator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Service
+    class SidekiqGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Set up sidekiq for project"
+
+      def start
+        bundle "sidekiq"
+        directory "app"
+        directory "config"
+
+        add_compose_env :REDIS_QUEUE_URL, "redis://redis-queue/0"
+        add_required_env_vars :REDIS_QUEUE_URL
+        add_compose_dependency redis_service
+        add_compose_service service, sidekiq_compose_config
+        add_compose_service redis_service, redis_compose_config
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def service
+        :sidekiq
+      end
+
+      def redis_service
+        :"redis-queue"
+      end
+
+      def sidekiq_compose_config
+        <<~COMPOSE
+          sidekiq:
+            <<: *app # sidekiq
+            command: /bin/sh -c "bundle && sidekiq" # sidekiq
+            # sidekiq properties
+        COMPOSE
+      end
+
+      def redis_compose_config
+        <<~COMPOSE
+          redis-queue:
+            image: redis # redis-queue
+            command: bash -c "redis-server --maxmemory-policy noeviction" # redis-queue
+            # redis-queue properties
+        COMPOSE
+      end
+    end
+  end
+end

data/lib/generators/pu/service/sidekiq/templates/app/sidekiq/sidekiq_job.rb

@@ -0,0 +1,3 @@
+class SidekiqJob
+  include Sidekiq::Job
+end

data/lib/generators/pu/service/sidekiq/templates/config/initializers/sidekiq.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+redis_config = {
+  url: ENV.fetch("REDIS_QUEUE_URL", ""),
+  connect_timeout: 1,  # Defaults to 1 second
+  read_timeout: 0.2, # Defaults to 1 second
+  write_timeout: 0.2, # Defaults to 1 second
+  # https://github.com/redis/redis-rb#reconnections
+  reconnect_attempts: [ # Defaults to 1
+    0, # retry immediately
+    0.25, # retry a second time after 250ms
+    1, # retry a third time after another 1s
+    5, # retry a fourth time after another 5s
+    10 # retry a fifth and final time after another 15s
+  ]
+}
+
+Sidekiq.configure_client do |config|
+  config.redis = redis_config
+
+  # Configure sidekiq client here
+end
+
+Sidekiq.configure_server do |config|
+  config.redis = redis_config
+  config.logger = Rails.logger = Sidekiq::Logger.new($stdout)
+  config.death_handlers << lambda { |job, exception|
+    worker = job["wrapped"].safe_constantize
+    worker&.sidekiq_retries_exhausted_block&.call(job, exception)
+  }
+
+  if defined?(Prosopite)
+    # configure prosopite
+    config.server_middleware do |chain|
+      require "prosopite/middleware/sidekiq"
+      chain.add(Prosopite::Middleware::Sidekiq)
+    end
+  end
+
+  # Configure sidekiq server here
+end
+
+# Use sidekiq
+Rails.application.config.active_job.queue_adapter = :sidekiq
+
+# nil will use the "default" queue
+# some of these options will not work with your Rails version. add/remove as necessary
+Rails.application.config.action_mailer.deliver_later_queue_name = nil if Rails.application.config.respond_to?(:action_mailbox)  # defaults to "mailers"
+Rails.application.config.action_mailbox.queues.routing = nil if Rails.application.config.respond_to?(:action_mailbox)  # defaults to "action_mailbox_routing"
+Rails.application.config.active_storage.queues.analysis = nil if Rails.application.config.respond_to?(:active_storage)  # defaults to "active_storage_analysis"
+Rails.application.config.active_storage.queues.purge = nil if Rails.application.config.respond_to?(:active_storage)  # defaults to "active_storage_purge"
+Rails.application.config.active_storage.queues.mirror = nil if Rails.application.config.respond_to?(:active_storage)  # defaults to "active_storage_mirror"
+Rails.application.config.active_storage.queues.purge = :low if Rails.application.config.respond_to?(:active_storage) # put purge jobs in the `low` queue

data/lib/generators/pu/service/sidekiq/templates/config/sidekiq.yml

@@ -0,0 +1,6 @@
+---
+:queues:
+  - [critical, 5]
+  - [high, 3]
+  - [default, 2]
+  - [low, 1]

data/lib/plutonium/config.rb

@@ -3,14 +3,7 @@ require "active_model"
 
 module Plutonium
   module Config
-    mattr_accessor :stylesheet_tag
-    @@stylesheet_tag = ->(view_context) {
-      "<link rel=\"stylesheet\" href=\"#{Plutonium.stylesheet_link}\" />"
-    }
-
-    mattr_accessor :script_tag
-    @@script_tag = ->(view_context) {
-      "<script src=\"#{Plutonium.script_link}\"></script>"
-    }
+    mattr_accessor :logo
+    @@logo = "plutonium-logo.png"
   end
 end

data/lib/plutonium/core/associations/renderers/basic_renderer.rb

@@ -0,0 +1,28 @@
+module Plutonium
+  module Core
+    module Associations
+      module Renderers
+        class BasicRenderer
+          attr_reader :name, :label, :reflection, :user_options
+
+          def initialize(name, label:, reflection:, **user_options)
+            @name = name
+            @label = label
+            @reflection = reflection
+            @user_options = user_options
+          end
+
+          def render(view_context, record)
+            raise NotImplementedError
+          end
+
+          def options = @options ||= renderer_options.deep_merge(@user_options)
+
+          private
+
+          def renderer_options = {}
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/associations/renderers/factory.rb

@@ -0,0 +1,36 @@
+require "simple_form/map_type"
+
+module Plutonium
+  module Core
+    module Associations
+      module Renderers
+        class Factory
+          extend ::SimpleForm::MapType
+
+          map_type :has_many, to: Plutonium::Core::Associations::Renderers::HasManyRenderer
+
+          def self.build(name, type:, **)
+            mapping = mappings[type]
+            raise ArgumentError, "Unknown association renderer type #{type}" unless mapping.present?
+
+            mapping.new(name, **)
+          end
+
+          def self.for_resource_association(resource_class, attr_name, **options)
+            options[:label] ||= resource_class.human_attribute_name(attr_name)
+
+            association = resource_class.try(:reflect_on_association, attr_name)
+            raise ArgumentError, "#{attr_name} is not a valid association of #{resource_class}" unless association.present?
+            raise ArgumentError, "#{association.klass} does is not a resource record" unless association.klass.include?(Plutonium::Resource::Record)
+
+            type = association.macro
+            raise NotImplementedError, "#{macro} associations are currently not supported." unless type == :has_many
+
+            options[:reflection] = association
+            build(attr_name, type:, **options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/associations/renderers/has_many_renderer.rb

@@ -0,0 +1,16 @@
+module Plutonium
+  module Core
+    module Associations
+      module Renderers
+        class HasManyRenderer < BasicRenderer
+          def render(view_context, record)
+            view_context.render_component :has_many_panel,
+              title: label,
+              src: view_context.resource_url_for(reflection.klass, parent: record),
+              **options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/autodiscovery/association_renderer_discoverer.rb

@@ -0,0 +1,31 @@
+module Plutonium
+  module Core
+    module Autodiscovery
+      module AssociationRendererDiscoverer
+        extend ActiveSupport::Concern
+        include Discoverer
+
+        class_methods do
+          def autodiscovery_association_renderer_cache = @autodiscovery_association_renderer_cache ||= {}
+        end
+
+        private
+
+        # If cache_discovery is enabled, use the class level cache that persists
+        # between requests, otherwise use the instance one.
+        def autodiscovery_association_renderer_cache
+          if Rails.application.config.plutonium.cache_discovery
+            self.class.autodiscovery_association_renderer_cache
+          else
+            @autodiscovery_association_renderer_cache ||= {}
+          end
+        end
+
+        def autodiscover_association_renderer(name)
+          autodiscovery_association_renderer_cache[name] ||=
+            Plutonium::Core::Associations::Renderers::Factory.for_resource_association(resource_class, name)
+        end
+      end
+    end
+  end
+end