plutonium 0.5.0

data/app/views/resource/_table.html.erb

@@ -0,0 +1,78 @@
+<%
+  # locals: {
+  #   table: "instance of Plutonium::UI::Builder::Collection"
+  # }
+
+  resource_class = table.resource_class
+  resources = table.records.to_a
+  record_actions = table.actions.collection_record_actions
+  search_object = table.search_object
+%>
+<div class="row">
+  <% unless resources.any? %>
+    <div class="col-12">
+      <%=
+        render 'empty_card', message: "You have no #{resource_name_plural(resource_class).downcase}" do
+          if policy(resource_class).create?
+            link_to "Create #{resource_name(resource_class)}", adapt_route_args(resource_class, action: :new), class: 'btn btn-outline-primary'
+          end
+        end
+      %>
+    </div>
+  <% else %>
+    <div id="table-container" class="col-12 table-responsive max-vh-75 pb-2" data-controller="scroll-preserver" data-action="scroll->scroll-preserver#scrolled"  >
+      <table class="table table-hover table-striped my-0">
+        <thead class="sticky-top">
+          <tr>
+            <th scope="col" class="text-center resource-table-col-id"><%= sort_link(search_object, :id, '#', class: "text-decoration-none") %></th>
+            <% table.fields.each do |name, field| %>
+              <th scope="col" class="resource-table-col-attr">
+                <% if resource_class.ransortable_attributes.include? name.to_s %>
+                  <%= sort_link(search_object, name, field.label, class: "text-decoration-none") %>
+                <% else %>
+                  <%= field.label %>
+                <% end %>
+              </th>
+            <% end %>
+            <th scope="col" class="text-center resource-table-col-actions">Actions</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% resources.each do |resource| %>
+            <tr class="align-middle">
+              <td class="text-center text-truncate resource-table-cell-id">
+                <% if policy(resource).show? %>
+                  <%= link_to resource.to_param, adapt_route_args(resource), class: "text-decoration-none" %>
+                <% else %>
+                  <%= resource.to_param %>
+                <% end %>
+              </td>
+              <% table.fields.each do |name, field| %>
+                <%
+                  options = field.options
+                  max_width = options.delete :pu_max_width
+                %>
+                <td class='text-truncate resource-table-cell-attr' style="max-width: <%= max_width %>px;">
+                  <%= field.render self, resource %>
+                </td>
+              <% end %>
+              <td class="text-center resource-table-cell-actions">
+                <%=
+                render partial: 'table_actions', locals: {
+                  actions: record_actions.permitted_for(policy(resource)),
+                  resource: resource
+                }
+              %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+    <% if table.pagination.present? %>
+      <div class="col-12">
+        <%= render 'pagination', pagination: table.pagination %>
+      </div>
+    <% end  %>
+  <% end %>
+</div>

data/app/views/resource/_table_actions.html.erb

@@ -0,0 +1,15 @@
+<%
+  # locals: {
+  #   resource: "the resource to generate actions for",
+  #   actions: "list of actions to generate",
+  # }
+%>
+<% actions.values.each do |action| %>
+  <%=
+    table_action_button adapt_route_args(resource, action: action.route_options.action, **action.route_options.options),
+                      icon: action.icon,
+                      button_class: action.action_class,
+                      method: action.route_options.method,
+                      confirm: action.confirmation
+  %>
+<% end %>

data/app/views/resource/_toast.html.erb

@@ -0,0 +1,26 @@
+<div aria-live="polite" aria-atomic="true" class="position-relative" data-controller="toasts">
+  <div class="toast-container top-0 end-0 p-3 ">
+    <% flash.each do |type, msg| %>
+      <%
+        type = { alert: :danger, error: :danger, warning: :warning, success: :success }[type.to_sym] || :primary
+        title = { danger: 'Error', warning: 'Warning', success: 'Success' }[type] || 'Info'
+        icon = {
+          danger: 'exclamation-triangle-fill',
+          warning: 'exclamation-diamond',
+          success: 'check-circle-fill'
+        }[type] || 'exclamation-circle'
+      %>
+      <div class="toast text-bg-<%= type %>" role="alert" aria-live="assertive" aria-atomic="true" data-turbo-temporary>
+        <div class="toast-header">
+          <i class="bi bi-<%= icon %>"></i>&nbsp;
+          <strong class="me-auto"><%= title %></strong>
+          <small class="text-body-secondary"><%= timeago(DateTime.now) %></small>
+          <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
+        </div>
+        <div class="toast-body">
+          <%= msg %>
+        </div>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/resource/_toolbar.html.erb

@@ -0,0 +1,22 @@
+<%
+  # locals: {
+  #   parent?: "parent of the resource to render toolbar for",
+  #   resource?: "resource to render toolbar for",
+  #   resource_class: "Class of resource being rendered",
+  # }
+
+  resource = nil unless local_assigns[:resource].present?
+  associations = nil unless local_assigns[:associations].present?
+%>
+<div class="row justify-content-between py-2 mb-3 border-bottom">
+  <div class="col-sm-6">
+    <%= render partial: 'toolbar_breadcrumbs', locals: {
+                                                  resource: resource,
+                                                  resource_class: resource_class,
+                                                  parent: parent
+                                                } %>
+  </div>
+  <div class="col-sm-6 text-end">
+    <%= yield %>
+  </div>
+</div>

data/app/views/resource/_toolbar_actions.html.erb

@@ -0,0 +1,16 @@
+<%
+  # locals: {
+  #   resource: "the resource to generate actions for",
+  #   actions: "list of actions to generate",
+  # }
+%>
+<% actions.values.each do |action| %>
+  <%=
+    toolbar_action_button adapt_route_args(resource, action: action.route_options.action, **action.route_options.options),
+                        icon: action.icon,
+                        button_class: action.action_class,
+                        method: action.route_options.method,
+                        confirm: action.confirmation,
+                        turbo_frame: action.turbo_frame
+  %>
+<% end %>

data/app/views/resource/_toolbar_breadcrumbs.html.erb

@@ -0,0 +1,32 @@
+<%#
+  locals: {
+    parent?: "parent of the resource to render toolbar for",
+    resource?: "resource to render toolbar for",
+    resource_class: "Class of resource being rendered",
+  }
+%>
+<nav aria-label="breadcrumb" style="--bs-breadcrumb-divider: url(&#34;data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='8' height='8'%3E%3Cpath d='M2.5 0L1 1.5 3.5 4 1 6.5 2.5 8l4-4-4-4z' fill='%236c757d'/%3E%3C/svg%3E&#34;);">
+  <ol class="breadcrumb my-1">
+    <% if parent.present? %>
+      <li class="breadcrumb-item"><%= link_to resource_name_plural(parent.class), adapt_route_args(parent.class, use_parent: false), class: 'text-decoration-none' %></li>
+      <li class="breadcrumb-item"><%= link_to display_name_of(parent), adapt_route_args(parent, use_parent: false), class: 'text-decoration-none' %></li>
+    <% end %>
+
+    <% if resource.present? %>
+      <li class="breadcrumb-item"><%= link_to resource_name_plural(resource_class), adapt_route_args(resource_class), class: 'text-decoration-none' %></li>
+      <% if /edit|update|.*interactive_resource.*/.match? action_name %>
+        <li class="breadcrumb-item"><%= link_to display_name_of(resource), adapt_route_args(resource), class: 'text-decoration-none' %></li>
+        <li class="breadcrumb-item active" aria-current="page"><%= (params[:interactive_action] || 'Edit').titleize %></li>
+      <% else %>
+        <li class="breadcrumb-item active" aria-current="page"><%= resource.persisted? ? display_name_of(resource) : 'New' %></li>
+      <% end %>
+    <% else %>
+      <% if /.*interactive_resource.*/.match? action_name %>
+      <li class="breadcrumb-item"><%= link_to resource_name_plural(resource_class), adapt_route_args(resource_class), class: 'text-decoration-none' %></li>
+        <li class="breadcrumb-item active" aria-current="page"><%= params[:interactive_action].titleize %></li>
+      <% else %>
+        <li class="breadcrumb-item"><%= resource_name_plural(resource_class) %></li>
+      <% end %>
+    <% end %>
+  </ol>
+</nav>

data/app/views/resource/_toolbar_search_input.erb

@@ -0,0 +1,27 @@
+<%
+  # locals: {
+  #   search_object: "the object to build the search form for",
+  #   search_field: "search input field name",
+  # }
+%>
+<%= search_form_for adapt_route_args(search_object), class: "d-inline", html: { data: { controller: "form", turbo_frame: nil } } do |f| %>
+  <label for="search" class="visually-hidden">Search</label>
+  <% if search_field.present? %>
+    <%=
+      f.search_field search_field, id: "search",
+                                class: "form-control form-control-sm d-inline w-auto",
+                                # since ransack trims strings, we instead
+                                # use the url param because it preserves trailing spaces
+                                # that way, when the frame reloads the user gets to continue typing
+                                value: params[:q].try(:[], search_field),
+                                placeholder: "search...",
+                                data: {
+                                  action: "form#submit",
+                                  form_target: "focus"
+                                }
+
+    %>
+  <% end %>
+  <%# preserve sorting %>
+  <%= f.hidden_field :s, value: params[:q].try(:[], :s) %>
+<% end %>

data/app/views/resource/edit.html.erb

@@ -0,0 +1,10 @@
+<% content_for :toolbar do %>
+  <%=
+    render partial: 'toolbar', locals: {
+      resource_class: resource_class,
+      resource: @form.record,
+      parent: current_parent,
+    }
+  %>
+<% end %>
+<%= render "form", form: @form %>

data/app/views/resource/errors.rabl

@@ -0,0 +1,3 @@
+collection @errors, root: :errors, object_root: false
+
+attributes :attribute, :detail, :message, :full_message

data/app/views/resource/index.html.erb

@@ -0,0 +1,19 @@
+<% content_for :toolbar do %>
+  <%= render 'toolbar', resource_class: resource_class,
+                        parent: current_parent do %>
+    <%=
+      render partial: 'toolbar_search_input', locals: {
+        search_object: @collection.search_object,
+        search_field: nil
+      }
+    %>
+    <%=
+      render partial: 'toolbar_actions', locals: {
+        actions: @collection.actions.collection_actions.permitted_for(policy(resource_class)),
+        resource: resource_class
+      }
+    %>
+  <% end %>
+<% end %>
+
+<%= render 'table', table: @collection %>

data/app/views/resource/index.rabl

@@ -0,0 +1,3 @@
+collection @resource_records, root: resource_class.to_s.demodulize.underscore.pluralize.to_sym, object_root: false
+
+extends "_resource"

data/app/views/resource/interactive_resource_collection_action.html.erb

@@ -0,0 +1,11 @@
+<% content_for :toolbar do %>
+  <%=
+    render partial: 'toolbar', locals: {
+      resource_class: resource_class,
+      resource: resource_record,
+      parent: current_parent,
+    }
+  %>
+<% end %>
+
+<%= render "interactive_resource_action_form", interactive_action: current_interactive_action %>

data/app/views/resource/interactive_resource_record_action.html.erb

@@ -0,0 +1,11 @@
+<% content_for :toolbar do %>
+  <%=
+    render partial: 'toolbar', locals: {
+      resource_class: resource_class,
+      resource: resource_record,
+      parent: current_parent,
+    }
+  %>
+<% end %>
+
+<%= render "interactive_resource_action_form", interactive_action: current_interactive_action %>

data/app/views/resource/interactive_resource_recordless_action.html.erb

@@ -0,0 +1,11 @@
+<% content_for :toolbar do %>
+  <%=
+    render partial: 'toolbar', locals: {
+      resource_class: resource_class,
+      resource: resource_record,
+      parent: current_parent,
+    }
+  %>
+<% end %>
+
+<%= render "interactive_resource_action_form", interactive_action: current_interactive_action %>

data/app/views/resource/new.html.erb

@@ -0,0 +1,11 @@
+<% content_for :toolbar do %>
+  <%=
+    render partial: 'toolbar', locals: {
+      resource_class: resource_class,
+      resource: @form.record,
+      parent: current_parent,
+    }
+  %>
+<% end %>
+
+<%= render "form", form: @form %>

data/app/views/resource/readme.md

@@ -0,0 +1,16 @@
+# Example View Lookup
+
+    Missing partial demo_app/blogs/_nav_user, blogs/_nav_user, resource/_nav_user with {:locale=>[:en], :formats=>[:html], :variants=>[], :handlers=>[:raw, :erb, :html, :builder, :ruby, :jbuilder]}.
+
+    Searched in:
+
+    - "/Users/user/plutonium/demo/packages/demo_app/app/views"
+    - "/Users/user/plutonium/demo/app/views"
+    - "/Users/user/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/turbo-rails-2.0.3/app/views"
+    - "/Users/user/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/actiontext-7.1.3/app/views"
+    - "/Users/user/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/actionmailbox-7.1.3/app/views"
+    - "/Users/user/plutonium/plutonium/app/views"
+
+# Partials vs Shared Partials
+
+Rails does not apply namespace lookup to shared partials. So instead, we go with normal partials.

data/app/views/resource/show.html.erb

@@ -0,0 +1,14 @@
+<% content_for :toolbar do %>
+  <%= render 'toolbar', resource_class: resource_class,
+                        resource: @detail.record,
+                        parent: current_parent do %>
+    <%=
+      render partial: 'toolbar_actions', locals: {
+        actions: @detail.actions.record_actions.permitted_for(policy(@detail.record)),
+        resource: @detail.record
+      }
+    %>
+  <% end %>
+<% end %>
+
+<%= render "resource", details: @detail %>

data/app/views/resource/show.rabl

@@ -0,0 +1,3 @@
+object @resource_record
+
+extends "_resource"

data/brakeman.ignore

@@ -0,0 +1,51 @@
+{
+  "ignored_warnings": [
+    {
+      "warning_type": "Cross-Site Request Forgery",
+      "warning_code": 7,
+      "fingerprint": "1cb8570b8c91f38317cdf909e01e7016359846174f427e86011633c344d30fc3",
+      "check_name": "ForgerySetting",
+      "message": "`protect_from_forgery` should be called in `Plutonium::Reactor::ResourceController`",
+      "file": "lib/plutonium/reactor/resource_controller.rb",
+      "line": 10,
+      "link": "https://brakemanscanner.org/docs/warning_types/cross-site_request_forgery/",
+      "code": null,
+      "render_path": null,
+      "location": {
+        "type": "controller",
+        "controller": "Plutonium::Reactor::ResourceController"
+      },
+      "user_input": null,
+      "confidence": "High",
+      "cwe_id": [
+        352
+      ],
+      "note": "this is tested and confirmed to be a false flag"
+    },
+    {
+      "warning_type": "Mass Assignment",
+      "warning_code": 70,
+      "fingerprint": "873ee0d868e06a32e8ff387a38ddb8c6183a419813d5c20122fa9c3a887f4e54",
+      "check_name": "MassAssignment",
+      "message": "Specify exact keys allowed for mass assignment instead of using `permit!` which allows any keys",
+      "file": "lib/plutonium/reactor/resource_controller.rb",
+      "line": 58,
+      "link": "https://brakemanscanner.org/docs/warning_types/mass_assignment/",
+      "code": "params.require(resource_param_key).permit!",
+      "render_path": null,
+      "location": {
+        "type": "method",
+        "class": "Plutonium::Reactor::ResourceController",
+        "method": "resource_params"
+      },
+      "user_input": null,
+      "confidence": "Medium",
+      "cwe_id": [
+        915
+      ],
+      "note": "we manually filter params"
+    }
+  ],
+  "updated": "2024-02-18 00:37:39 +0000",
+  "brakeman_version": "6.1.2"
+}

data/lib/active_model/validations/array_validator.rb

@@ -0,0 +1,74 @@
+# require 'active_model/validations/each_validator'
+
+module ActiveModel
+  module Validations
+    # Based on https://gist.github.com/ssimeonov/6519423
+    #
+    # Validates the values of an Array with other validators.
+    # Generates error messages that include the index and value of
+    # invalid elements.
+    #
+    # Example:
+    #
+    #   validates :values, array: { presence: true, inclusion: { in: %w{ big small } } }
+    #
+    class ArrayValidator < EachValidator
+      attr_reader :record, :attribute, :proxy_attribute
+
+      def validate_each(record, attribute, values)
+        @record = record
+        @attribute = attribute
+
+        # Cache any existing errors temporarily.
+        @existing_errors = record.errors.delete(attribute) || []
+
+        # Run validations
+        validate_each_internal values
+
+        # Restore any existing errors.
+        return if @existing_errors.blank?
+
+        @existing_errors.each { |e| record.errors.add attribute, e }
+      end
+
+      private
+
+      def validate_each_internal(values)
+        [values].flatten.each_with_index do |value, index|
+          options.except(:if, :unless, :on, :strict).each do |key, args|
+            validator_options = {attributes: attribute}
+            validator_options.merge!(args) if args.is_a?(Hash)
+
+            next if skip? value, validator_options
+
+            validator = validator_class_for(key).new(validator_options)
+            validator.validate_each(record, attribute, value)
+          end
+          maybe_normalize_errors index
+        end
+      end
+
+      def maybe_normalize_errors(index)
+        errors = record.errors.delete attribute
+        return if errors.nil?
+
+        @existing_errors += errors.map { |e| "item #{index + 1} #{e}" }
+      end
+
+      def skip?(value, validator_options)
+        return true if value.nil? && validator_options[:allow_nil]
+
+        true if value.blank? && validator_options[:allow_blank]
+      end
+
+      def validator_class_for(key)
+        validator_class_name = "#{key.to_s.camelize}Validator"
+        begin
+          validator_class_name.constantize
+        rescue NameError
+          "ActiveModel::Validations::#{validator_class_name}".constantize
+        end
+      end
+    end
+  end
+end

data/lib/active_model/validations/attached_validator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  module Validations
+    # Validates that a file is attached
+    #
+    # Example:
+    #
+    #   validates :logo, attached: true
+    #
+    class AttachedValidator < EachValidator
+      def validate_each(record, attribute, value)
+        record.errors.add(attribute, (options[:message] || "must be attached")) unless value.attached?
+      end
+    end
+  end
+end

data/lib/active_model/validations/url_validator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  module Validations
+    # Validates that the value is a url
+    #
+    # Example:
+    #
+    #   validates :website_url, url: true
+    #
+    class UrlValidator < EachValidator
+      URL_PATTERN = URI::DEFAULT_PARSER.make_regexp(%w[http https]).freeze
+
+      attr_reader :record, :attribute, :value
+
+      def validate_each(record, attribute, value)
+        @record = record
+        @attribute = attribute
+        @value = value
+
+        return if skip?
+        return unless validate_url
+
+        nil unless maybe_validate_image_url
+      end
+
+      private
+
+      def skip?
+        return true if value.nil? && options[:allow_nil]
+
+        true if value.blank? && options[:allow_blank]
+      end
+
+      def validate_url
+        return true if URL_PATTERN.match?(value)
+
+        record.errors.add attribute, (options[:message] || "is not a valid URL")
+        false
+      end
+
+      def maybe_validate_image_url
+        return true unless options[:image].present?
+        return true unless FastImage.type(value).nil?
+
+        record.errors.add(attribute, (options[:message] || "is not a valid image URL"))
+        false
+      end
+    end
+  end
+end

data/lib/generators/pu/core/install/install_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "plutonium_generators"
+
+module Pu
+  module Core
+    class InstallGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Set up the base requirements for Plutonium"
+
+      def start
+        setup_packaging_system
+        install_required_gems
+        setup_app
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def setup_packaging_system
+        copy_file "config/packages.rb"
+        create_file "packages/.keep"
+        insert_into_file "config/application.rb", "\nrequire_relative \"packages\"\n", after: /Bundler\.require.*\n/
+        # insert_into_file "config/application.rb", indent("Plutonium.configure_rails config\n\n", 4), after: /.*< Rails::Application\n/
+      end
+
+      def setup_app
+        directory "config"
+        directory "app"
+      end
+
+      def install_required_gems
+        # invoke "pu:gem:simple_form"
+        # invoke "pu:gem:pagy"
+        # invoke "pu:gem:rabl"
+      end
+    end
+  end
+end

data/lib/generators/pu/core/install/templates/app/controllers/resource_controller.rb.tt

@@ -0,0 +1,2 @@
+class ResourceController < Plutonium::Reactor::ResourceController
+end

data/lib/generators/pu/core/install/templates/app/interactions/resource_interaction.rb.tt

@@ -0,0 +1,2 @@
+class ResourceInteraction < Plutonium::Reactor::ResourceInteraction
+end

data/lib/generators/pu/core/install/templates/app/models/resource_record.rb.tt

@@ -0,0 +1,5 @@
+class ResourceRecord < ApplicationRecord
+  include Plutonium::Reactor::ResourceRecord
+
+  self.abstract_class = true
+end

data/lib/generators/pu/core/install/templates/app/policies/resource_policy.rb.tt

@@ -0,0 +1,2 @@
+class ResourcePolicy < Plutonium::Reactor::ResourcePolicy
+end

data/lib/generators/pu/core/install/templates/app/presenters/resource_presenter.rb.tt

@@ -0,0 +1,2 @@
+class ResourcePresenter < Plutonium::Reactor::ResourcePresenter
+end

data/lib/generators/pu/core/install/templates/config/initializers/plutonium.rb

@@ -0,0 +1,2 @@
+# get the ball rolling
+Plutonium::Reactor::Core.achieve_criticality!

data/lib/generators/pu/core/install/templates/config/packages.rb

@@ -0,0 +1,3 @@
+Dir[File.expand_path("../packages/**/lib/engine.rb", __dir__)].each do |package|
+  load package
+end

data/lib/generators/pu/gem/pagy/pagy_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "plutonium_generators"
+
+module Pu
+  module Gem
+    class PagyGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Install Pagy"
+
+      def start
+        Bundler.with_unbundled_env do
+          run "bundle add pagy"
+        end
+
+        directory "config"
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+    end
+  end
+end