plutonium 0.10.2 → 0.11.0

data/lib/generators/pu/docker/install/templates/Dockerfile.dev.tt

@@ -0,0 +1,30 @@
+# syntax = docker/dockerfile:1
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
+ARG RUBY_VERSION=<%= ruby_version %>
+FROM registry.docker.com/library/ruby:$RUBY_VERSION
+
+WORKDIR /rails
+
+# Install packages needed to build gems and node modules
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential curl git libpq-dev node-gyp pkg-config python-is-python3
+
+# Install JavaScript dependencies
+ARG NODE_VERSION=22.2.0
+ARG YARN_VERSION=1.22.22
+ENV PATH=/usr/local/node/bin:$PATH
+RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
+    /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
+    npm install -g yarn@$YARN_VERSION && \
+    rm -rf /tmp/node-build-master
+
+# Additional dependencies go here
+
+# Upgrade RubyGems and install the latest Bundler version
+RUN gem update --system && gem install bundler
+
+# Document that we're going to expose port 3000
+EXPOSE 3000
+# Use Bash as the default command
+CMD ["/bin/bash"]

data/lib/generators/pu/docker/install/templates/Dockerfile.tt

@@ -0,0 +1,75 @@
+# syntax = docker/dockerfile:1
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
+ARG RUBY_VERSION=<%= ruby_version %>
+FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development"
+
+
+# Throw-away build stage to reduce size of final image
+FROM base as build
+
+# Install packages needed to build gems and node modules
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential curl git libpq-dev node-gyp pkg-config python-is-python3
+
+# Install JavaScript dependencies
+ARG NODE_VERSION=22.2.0
+ARG YARN_VERSION=1.22.22
+ENV PATH=/usr/local/node/bin:$PATH
+RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
+    /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
+    npm install -g yarn@$YARN_VERSION && \
+    rm -rf /tmp/node-build-master
+
+# Install application gems
+COPY .ruby-version Gemfile Gemfile.lock ./
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
+    bundle exec bootsnap precompile --gemfile
+
+# Install node modules
+COPY package.json yarn.lock ./
+RUN yarn install --frozen-lockfile
+
+# Copy application code
+COPY . .
+
+# Precompile bootsnap code for faster boot times
+RUN bundle exec bootsnap precompile app/ lib/
+
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+
+# Final stage for app image
+FROM base
+
+# Install packages needed for deployment
+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
+
+# Copy built artifacts: gems, application
+COPY --from=build /usr/local/bundle /usr/local/bundle
+COPY --from=build /rails /rails
+
+# Run and own only the runtime files as a non-root user for security
+RUN useradd rails --create-home --shell /bin/bash && \
+    chown -R rails:rails db log tmp
+USER rails:rails
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["./bin/rails", "server"]

data/lib/generators/pu/docker/install/templates/bin/console

@@ -0,0 +1,3 @@
+#!/bin/bash -e
+
+docker compose run --rm web bash -c "bundle && rails c"

data/lib/generators/pu/docker/install/templates/bin/restart

@@ -0,0 +1,3 @@
+#!/bin/bash -e
+
+touch tmp/restart.txt

data/lib/generators/pu/docker/install/templates/bin/shell

@@ -0,0 +1,3 @@
+#!/bin/bash -e
+
+docker compose run --rm web bash

data/lib/generators/pu/docker/install/templates/docker-compose.yml

@@ -0,0 +1,29 @@
+---
+x-managed-by: plutonium
+
+x-app: &app
+  build: # x-app
+    context: . # x-app
+    dockerfile: Dockerfile.dev # x-app
+  # x-app properties
+  volumes: # x-app
+  - ".:/rails" # x-app
+  - "./.volumes/bundle:/usr/local/bundle" # x-app
+  - "./.volumes/node_modules:/rails/node_modules" # x-app
+  - "./.volumes/shell_history:/root/shell_history" # x-app
+  depends_on: [] # x-app
+  environment: # x-app
+    RUBY_DEBUG_OPEN: true # x-app
+    PORT: 3000 # x-app
+    HISTFILE: /root/shell_history/.bash_history # x-app
+  tty: true # for binding.pry # x-app
+  stdin_open: true # for binding.pry # x-app
+
+services:
+  web:
+    <<: *app
+    command: /bin/sh -c "rm -f tmp/pids/server.pid && bundle && yarn && bin/dev" # web
+    # web properties
+    ports: # web
+      - "3000:3000" # app
+  # additional services go here

data/lib/generators/pu/gem/dotenv/dotenv_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Gem
+    class DotenvGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Set up dotenv"
+
+      def start
+        in_root do
+          [".env", ".env.local", ".env.template", ".env.local.template"].each do |file|
+            copy_file file
+          end
+
+          copy_file "config/initializers/001_ensure_required_env.rb"
+
+          gitignore "!/.env.template", "!/.env.local.template", "!/.env"
+
+          insert_into_file "Gemfile", "\ngem \"dotenv\", :groups => [:development, :test]\n", after: /^gem ["']rails["'].*\n/
+          bundle!
+        end
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+    end
+  end
+end

data/lib/generators/pu/gem/dotenv/templates/.env

@@ -0,0 +1,6 @@
+# Secrets should NOT be added here.
+# Set them in `.env.local`
+
+# # == S3
+# S3_REGION=S3_REGION
+# S3_BUCKET=S3_BUCKET

data/lib/generators/pu/gem/dotenv/templates/.env.local

@@ -0,0 +1,5 @@
+# Secrets for local testing should be added here.
+
+# # == S3
+# S3_ACCESS_KEY_ID=S3_ACCESS_KEY_ID
+# S3_SECRET_ACCESS_KEY=S3_SECRET_ACCESS_KEY

data/lib/generators/pu/gem/dotenv/templates/.env.local.template

@@ -0,0 +1,5 @@
+# Secrets for local testing should be added here.
+
+# # == S3
+# S3_ACCESS_KEY_ID=S3_ACCESS_KEY_ID
+# S3_SECRET_ACCESS_KEY=S3_SECRET_ACCESS_KEY

data/lib/generators/pu/gem/dotenv/templates/.env.template

@@ -0,0 +1,6 @@
+# Secrets should NOT be added here.
+# Set them in `.env.local`
+
+# # == S3
+# S3_REGION=S3_REGION
+# S3_BUCKET=S3_BUCKET

data/lib/generators/pu/gem/dotenv/templates/config/initializers/001_ensure_required_env.rb

@@ -0,0 +1,21 @@
+return if ENV["SECRET_KEY_BASE_DUMMY"].present?
+
+# Add required env vars to this list
+required_env_vars = %w[]
+
+if Rails.env.production?
+  required_env_vars += %w[RAILS_MASTER_KEY DATABASE_URL]
+end
+
+# Add additional env vars here
+
+# Check required env vars
+required_env_vars.each do |env_var|
+  if !ENV.has_key?(env_var) || ENV[env_var].blank?
+    raise <<~EOL
+      Missing required environment variable: #{env_var}
+
+      Ask a teammate for the appropriate value.
+    EOL
+  end
+end

data/lib/generators/pu/gem/redis/redis_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Gem
+    class RedisGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Set up redis"
+
+      def start
+        bundle "redis"
+        bundle "hiredis"
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+    end
+  end
+end

data/lib/generators/pu/gen/component/component_generator.rb

@@ -20,10 +20,9 @@ module Pu
         template "component.html.erb", "#{component_path}.html.erb"
         template "controller.js", controller_path
 
-        controllers_index_file = File.join __dir__, "../../../../../app/assets/javascripts/controllers/index.js"
+        controllers_index_file = File.join __dir__, "../../../../../src/js/controllers/register_controllers.js"
         insert_into_file controllers_index_file, controller_import, after: /.*Import controllers here*\n/
         insert_into_file controllers_index_file, controller_registration, after: /.*Register controllers here*\n/
-        insert_into_file controllers_index_file, controller_export, after: /.*Export controllers here*\n/
       end
 
       protected
@@ -45,7 +44,7 @@ module Pu
       end
 
       def component_namespace
-        ["Plutonium::Ui", component_module].compact.join "::"
+        ["PlutoniumUi", component_module].compact.join "::"
       end
 
       def component_reference
@@ -68,8 +67,16 @@ module Pu
         [component_module, component_name].compact.join("::").gsub("::", "__").underscore
       end
 
+      def controller_filename
+        "#{[component_module, component_name].compact.join("::").underscore}_controller.js"
+      end
+
+      def controllers_dir
+        File.join "src", "js", "controllers"
+      end
+
       def controller_path
-        "#{component_base_path}_controller.js"
+        File.join controllers_dir, controller_filename
       end
 
       def controller_identifier
@@ -77,20 +84,16 @@ module Pu
       end
 
       def controller_reference
-        [component_module, "#{component_name}Controller"].compact.join("::").gsub("::", "_")
+        [component_module, "#{component_name}Controller"].compact.join("")
       end
 
       def controller_import
-        "import #{controller_reference} from \"../../../../#{controller_path}\"\n"
+        "import #{controller_reference} from \"./#{controller_filename}\"\n"
       end
 
       def controller_registration
         "  application.register(\"#{controller_identifier}\", #{controller_reference})\n"
       end
-
-      def controller_export
-        "export { #{controller_reference} }\n"
-      end
     end
   end
 end

data/lib/generators/pu/gen/component/templates/component.html.erb.tt

@@ -1,3 +1,3 @@
-<div data-controller="<%= controller_identifier %>" <%%= render_component_attributes %>>
+<div <%%= attributes_html %>>
   <%%= content %>
 </div>

data/lib/generators/pu/gen/component/templates/component.rb.tt

@@ -1,8 +1,14 @@
 module <%= component_namespace %>
-  class <%= component_classname %> < Plutonium::Ui::Base
-    # def base_classname
-    #   "base classnames here"
-    # end
+  class <%= component_classname %> < PlutoniumUi::Base
+    private
+
+    def base_attributes
+      # base attributes go here
+      {
+        classname: "<%= controller_identifier %>",
+        controller: "<%= controller_identifier %>"
+      }
+    end
   end
 end
 

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/pkg/app/app_generator.rb

@@ -28,10 +28,10 @@ module Pu
         template "lib/engine.rb", "packages/#{package_namespace}/lib/engine.rb"
         template "config/routes.rb", "packages/#{package_namespace}/config/routes.rb"
 
-        template "app/controllers/package_controller.rb",
-          "packages/#{package_namespace}/app/controllers/#{package_namespace}/#{package_namespace}_controller.rb"
-        template "app/controllers/app_controller.rb",
-          "packages/#{package_namespace}/app/controllers/#{package_namespace}/app_controller.rb"
+        template "app/controllers/concerns/controller.rb",
+          "packages/#{package_namespace}/app/controllers/#{package_namespace}/concerns/controller.rb"
+        template "app/controllers/controller.rb",
+          "packages/#{package_namespace}/app/controllers/#{package_namespace}/controller.rb"
 
         template "app/controllers/dashboard_controller.rb",
           "packages/#{package_namespace}/app/controllers/#{package_namespace}/dashboard_controller.rb"

data/lib/generators/pu/pkg/app/templates/app/controllers/concerns/controller.rb.tt

@@ -0,0 +1,28 @@
+module <%= package_name %>
+  module Concerns
+    module Controller
+      extend ActiveSupport::Concern
+      include Plutonium::Application::Controller
+      <%- if rodauth_account.present? -%>
+      include Plutonium::Auth.rodauth(:<%= rodauth_account %>)
+      <%- elsif public_access? -%>
+      include Plutonium::Auth::Public
+      <%- end -%>
+      # add concerns above.
+
+      included do
+        boot <%= package_name %>
+        <%- if bring_your_own_auth? -%>
+
+        helper_method :current_user
+        <%- end -%>
+      end
+      <%- if bring_your_own_auth? -%>
+
+      def current_user
+        raise NotImplementedError, "#{self.class}#current_user must return a non nil value"
+      end
+      <%- end -%>
+    end
+  end
+end

data/lib/generators/pu/pkg/app/templates/app/controllers/controller.rb.tt

@@ -0,0 +1,5 @@
+module <%= package_name %>
+  class Controller < ::ApplicationController
+    include <%= package_name %>::Concerns::Controller
+  end
+end

data/lib/generators/pu/pkg/app/templates/app/controllers/dashboard_controller.rb.tt

@@ -1,5 +1,5 @@
 module <%= package_name %>
-  class DashboardController < AppController
+  class DashboardController < Controller
     def index
     end
   end