plutonium 0.10.2 → 0.10.3

data/lib/generators/pu/lib/plutonium_generators/concerns/actions.rb

@@ -22,7 +22,10 @@ module PlutoniumGenerators
 
         in_root do
           create_file ".ruby-version", version, force: true, verbose: false
-          gsub_file "Gemfile", /^ruby ["'].*["']/, "ruby '~> #{version}'", verbose: false
+          gsub_file("Gemfile", /^ruby .*/, "ruby File.read(\".ruby-version\").strip", verbose: false)
+          %w[Dockerfile Dockerfile.prod Dockerfile.dev].each do |file|
+            gsub_file(file, /^ARG RUBY_VERSION=.*/, "ARG RUBY_VERSION=#{version}", verbose: false) if File.exist?(file)
+          end
         end
       end
 
@@ -95,29 +98,84 @@ module PlutoniumGenerators
       #   gsub_file "Gemfile", /(:?^.*#.*\n)*.*gem ['"]#{gem}['"].*\n/, "", verbose: false
       # end
 
-      #
-      # Evaluates the given template and merges it with the project's docker-compose.yml
-      #
-      # @param [String] source the template filename
-      #
-      # @return [void]
-      #
-      def docker_compose(source)
-        log :docker_compose, source
+      # #
+      # # Evaluates the given template and merges it with the project's docker-compose.yml
+      # #
+      # # @param [String] source the template filename
+      # #
+      # # @return [void]
+      # #
+      # def docker_compose(source)
+      #   log :docker_compose, source
+
+      #   in_root do
+      #     compose_file = "docker-compose.yml"
+      #     compose_definition = YAML.load_file(compose_file) if File.exist?(compose_file)
+      #     compose_definition ||= {
+      #       version: "3.7",
+      #       services: {}
+      #     }
+      #     compose_definition.deep_stringify_keys!
+
+      #     new_definition = YAML.load template_eval("docker-compose/#{source}.yml.tt")
+      #     compose_definition.deep_merge! new_definition.deep_stringify_keys
+
+      #     create_file compose_file, YAML.dump(compose_definition), force: true
+      #   end
+      # end
+
+      def managed_compose(file = "docker-compose.yml")
+        @managed_compose ||= {}
+
+        @managed_compose[file] ||= in_root do
+          next unless File.exist?(file)
+
+          parsed_yaml = YAML.load_file(file, aliases: true)
+          parsed_yaml if parsed_yaml["x-managed-by"] == "plutonium"
+        end
+      end
+
+      def add_compose_service(service, config, file = "docker-compose.yml")
+        docker_compose = managed_compose(file)
+        error "Docker compose is not managed by plutonium" unless docker_compose
+        error "#{service} is already added to compose" if docker_compose["services"].key?(service.to_s)
 
         in_root do
-          compose_file = "docker-compose.yml"
-          compose_definition = YAML.load_file(compose_file) if File.exist?(compose_file)
-          compose_definition ||= {
-            version: "3.7",
-            services: {}
-          }
-          compose_definition.deep_stringify_keys!
-
-          new_definition = YAML.load template_eval("docker-compose/#{source}.yml.tt")
-          compose_definition.deep_merge! new_definition.deep_stringify_keys
-
-          create_file compose_file, YAML.dump(compose_definition), force: true
+          insert_into_file file, indent(config, 2), after: /.*# additional services go here.*\n/
+        end
+      end
+
+      def add_compose_env(key, value, service = "x-app", file = "docker-compose.yml")
+        raise NotImplementedError, "only service: x-app is currently supported" unless service == "x-app"
+
+        docker_compose = managed_compose(file)
+        error "Docker compose is not managed by plutonium" unless docker_compose
+
+        in_root do
+          gsub_file file, "environment: {} # x-app", "environment: # #{service}"
+          gsub_file file, /.*#{key}:.*# #{service}.*\n/, ""
+          config = "#{key}: #{value} # #{service}\n"
+          insert_into_file file, indent(config, 4), after: /.*environment: # #{service}.*\n/
+        end
+      end
+
+      def add_compose_dependency(value, service = "x-app", file = "docker-compose.yml")
+        raise NotImplementedError, "only service: x-app is currently supported" unless service == "x-app"
+
+        docker_compose = managed_compose(file)
+        error "Docker compose is not managed by plutonium" unless docker_compose
+
+        in_root do
+          gsub_file file, "depends_on: [] # x-app", "depends_on: # #{service}"
+          gsub_file file, /.*- #{value}.*# #{service}.*\n/, ""
+          config = "- #{value} # #{service}\n"
+          insert_into_file file, indent(config, 4), after: /.*depends_on: # #{service}.*\n/
+        end
+      end
+
+      def add_docker_dependency(config, file = "Dockerfile.dev")
+        in_root do
+          insert_into_file file, "#{config}\n", after: /.*# Additional dependencies go here*\n\n/
         end
       end
 
@@ -283,6 +341,23 @@ module PlutoniumGenerators
         end
       end
 
+      #
+      # Insert the given directives into .dockerignore
+      #
+      # @param [String] *directives directives to ignore
+      #
+      # @return [void]
+      #
+      def dockerignore(*directives)
+        in_root do
+          # Doing this one by one so that duplication detection during insertion will work
+          directives.each do |directive|
+            log :dockerignore, directive
+            insert_into_file ".dockerignore", "#{directive}\n", verbose: false
+          end
+        end
+      end
+
       #
       # Similar to #run, this executes a command but returns both success and output
       #
@@ -313,6 +388,58 @@ module PlutoniumGenerators
         [success, output]
       end
 
+      def bin_directory
+        # Copy the directory and store the list of copied files
+        @copied_files = directory "bin"
+        # Change permissions of the copied files to make them executable
+        in_root do
+          @copied_files.each do |file|
+            file = file.split("/bin/")[1]
+            file = "bin/#{file}"
+            puts file
+            chmod file, "+x" if File.file?(file)
+          end
+        end
+      end
+
+      def bundle!
+        log :bundle, "install"
+
+        Bundler.with_unbundled_env do
+          run "bundle install", verbose: false
+        end
+      end
+
+      def bundle(*gems, **options)
+        gems = Array(gems).join " "
+        options = hash_to_cli_options options
+        cmd_args = "add #{gems} #{options}"
+
+        log :bundle, cmd_args
+        Bundler.with_unbundled_env do
+          run "bundle #{cmd_args}", verbose: false
+        end
+      end
+
+      def unbundle(*gems)
+        gems = Array(gems).join " "
+        cmd_args = "remove #{gems}"
+
+        log :bundle, cmd_args
+        Bundler.with_unbundled_env do
+          run "bundle remove #{Array(gems).join " "}", verbose: false
+        end
+      end
+
+      def add_required_env_vars(*vars)
+        vars = Array(vars).join " "
+        log :equired_env_vars, vars
+        in_root do
+          cmd = "required_env_vars += %w[#{vars}]\n"
+          insert_into_file "config/initializers/001_ensure_required_env.rb", cmd, after: /# Add additional env vars here.*\n/
+        end
+      end
+
       private
 
       #
@@ -351,16 +478,11 @@ module PlutoniumGenerators
         end
       end
 
-      def bundle(*gems)
-        Bundler.with_unbundled_env do
-          run "bundle add #{Array(gems).join " "}"
-        end
-      end
-
-      def unbundle(*gems)
-        Bundler.with_unbundled_env do
-          run "bundle remove #{Array(gems).join " "}"
-        end
+      def hash_to_cli_options(hash)
+        hash.map do |key, value|
+          formatted_value = value.is_a?(Array) ? value.join(",") : value
+          "--#{key.to_s.tr("_", "-")}=#{formatted_value}"
+        end.join(" ")
       end
     end
   end

data/lib/generators/pu/lib/plutonium_generators/generator.rb

@@ -64,13 +64,13 @@ module PlutoniumGenerators
       @prompt ||= TTY::Prompt.new
     end
 
-    def appname
-      defined?(Rails.application) ? Rails.application.class.module_parent.name : "PlutoniumGenerators"
-    end
+    # def appname
+    #   defined?(Rails.application) ? Rails.application.class.module_parent.name : "PlutoniumGenerators"
+    # end
 
-    def app_name
-      appname.underscore
-    end
+    # def app_name
+    #   appname.underscore
+    # end
 
     def pug_installed?(feature, version: nil)
       installed_version = read_config(:installed, feature)

data/lib/generators/pu/lib/plutonium_generators/installer.rb

@@ -21,7 +21,7 @@ module PlutoniumGenerators
     protected
 
     def install!(feature)
-      set_ruby_version! if root_pug?
+      # set_ruby_version! if root_pug?
 
       from_version = read_config(:installed, feature, default: "0.0.0")
       versions = methods.map do |m|

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,62 @@
+# 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"
+        bundle "sidekiq-failures"
+        directory "app"
+        directory "config"
+
+        in_root do
+          insert_into_file "app/jobs/application_job.rb", "\n  sidekiq_options failures: :exhausted\n", before: /^end/
+        end
+
+        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,5 @@
+class SidekiqJob
+  include Sidekiq::Job
+
+  sidekiq_options failures: :exhausted
+end