plutonium 0.5.0

data/lib/generators/pu/rodauth/templates/app/views/rodauth_mailer/email_auth.text.erb

@@ -0,0 +1,5 @@
+Someone has requested a login link for the account with this email
+address.  If you did not request a login link, please ignore this
+message.  If you requested a login link, please go to
+<%= @rodauth.email_auth_email_link %>
+to login to this account.

data/lib/generators/pu/rodauth/templates/app/views/rodauth_mailer/password_changed.text.erb

@@ -0,0 +1,2 @@
+Someone (hopefully you) has changed the password for the account
+associated to this email address.

data/lib/generators/pu/rodauth/templates/app/views/rodauth_mailer/reset_password.text.erb

@@ -0,0 +1,5 @@
+Someone has requested a password reset for the account with this email
+address.  If you did not request a password reset, please ignore this
+message.  If you requested a password reset, please go to
+<%= @rodauth.reset_password_email_link %>
+to reset the password for the account.

data/lib/generators/pu/rodauth/templates/app/views/rodauth_mailer/reset_password_notify.text.erb

@@ -0,0 +1,2 @@
+Someone (hopefully you) has reset the password for the account
+associated to this email address.

data/lib/generators/pu/rodauth/templates/app/views/rodauth_mailer/unlock_account.text.erb

@@ -0,0 +1,5 @@
+Someone has requested that the account with this email be unlocked.
+If you did not request the unlocking of this account, please ignore this
+message.  If you requested the unlocking of this account, please go to
+<%= @rodauth.unlock_account_email_link %>
+to unlock this account.

data/lib/generators/pu/rodauth/templates/app/views/rodauth_mailer/verify_account.text.erb

@@ -0,0 +1,4 @@
+Someone has created an account with this email address.  If you did not create
+this account, please ignore this message.  If you created this account, please go to
+<%= @rodauth.verify_account_email_link %>
+to verify the account.

data/lib/generators/pu/rodauth/templates/app/views/rodauth_mailer/verify_login_change.text.erb

@@ -0,0 +1,10 @@
+Someone with an account has requested their login be changed to this email address:
+
+Old email: <%= @account.email %>
+
+New email: <%= @new_email %>
+
+If you did not request this login change, please ignore this message.  If you
+requested this login change, please go to
+<%= @rodauth.verify_login_change_email_link %>
+to verify the login change.

data/lib/generators/pu/rodauth/templates/config/initializers/rodauth.rb.tt

@@ -0,0 +1,3 @@
+Rodauth::Rails.configure do |config|
+  config.app = "RodauthApp"
+end

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

@@ -0,0 +1,13 @@
+<% if defined?(::ActiveRecord::Railtie) -%>
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+<%= migration_content -%>
+  end
+end
+<% else -%>
+Sequel.migration do
+  change do
+<%= migration_content -%>
+  end
+end
+<% end -%>

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

@@ -0,0 +1,125 @@
+return unless defined?(Rodauth::Rails)
+
+require "rails/generators/base"
+
+require "#{__dir__}/concerns/configuration"
+
+module Pu
+  module Rodauth
+    class ViewsGenerator < ::Rails::Generators::Base
+      include Concerns::Configuration
+
+      source_root "#{__dir__}/templates"
+      # namespace "rodauth:views"
+
+      desc "Generate views for selected features\n\n" \
+           "Supported Features\n" \
+           "=========================================\n" \
+           "#{VIEW_CONFIG.keys.sort.map(&:to_s).join "\n"}\n\n\n\n"
+
+      argument :plugin_name, type: :string, optional: true,
+        desc: "[CONFIG] Name of the configured rodauth app. Leave blank to use the primary account."
+
+      class_option :features, required: true, type: :array,
+        desc: "Rodauth features to generate views for (login, create_account, reset_password, verify_account etc.)"
+
+      class_option :all, aliases: "-a", type: :boolean,
+        desc: "Generates views for all Rodauth features",
+        default: false
+
+      class_option :css, type: :string, enum: %w[bootstrap tailwind tailwindcss],
+        desc: "CSS framework to generate views for",
+        default: "bootstrap"
+
+      def validate_selected_features
+        if selected_features.empty?
+          say "No view features specified!", :yellow
+          exit(1)
+        elsif (selected_features - view_config.keys).any?
+          say "No available view template for feature(s): #{(selected_features - view_config.keys).join(", ")}", :red
+          exit(1)
+        end
+      end
+
+      def create_views
+        views.each do |view|
+          copy_file view_location(view), "app/views/#{directory}/#{view}.html.erb" do |content|
+            content = content.gsub("rodauth.", "rodauth(:#{configuration_name}).") if configuration_name
+            content = content.gsub("rodauth/", "#{directory}/")
+            content = form_helpers_compatibility(content) if ActionView.version < Gem::Version.new("5.1")
+            content
+          end
+        end
+      end
+
+      private
+
+      def features
+        options[:features]
+      end
+
+      def views
+        selected_features.flat_map { |feature| view_config.fetch(feature) }
+      end
+
+      def selected_features
+        if options[:all]
+          view_config.keys
+        elsif features
+          features.map(&:to_sym)
+        else
+          rodauth_configuration.features & view_config.keys
+        end
+      end
+
+      def directory
+        if controller.abstract?
+          raise Error, "no controller configured for configuration: #{configuration_name.inspect}"
+        end
+
+        controller.controller_path
+      end
+
+      def controller
+        rodauth_configuration.allocate.rails_controller
+      end
+
+      def rodauth_configuration
+        require "rodauth-rails" # this requires the project to include the package
+
+        ::Rodauth::Rails.app.rodauth!(configuration_name&.to_sym)
+      rescue ArgumentError => e
+        say "An error occurred generating views for " \
+            "#{configuration_name.present? ? "'#{configuration_name}'" : "primary"} account:\n\n#{e}", :red
+        exit(1)
+      end
+
+      def configuration_name
+        plugin_name
+      end
+
+      # We need to use the *_tag helpers on versions lower than Rails 5.1.
+      def form_helpers_compatibility(content)
+        content
+          .gsub(/form_with url: (.+) do \|form\|/, 'form_tag \1 do')
+          .gsub(/form\.(label|submit)/, '\1_tag')
+          .gsub(/form\.(email|password|text|telephone|hidden)_field (\S+), value:/, '\1_field_tag \2,')
+          .gsub(/form\.radio_button (\S+), (\S+),/, 'radio_button_tag \1, \2, false,')
+          .gsub(/form\.check_box (\S+), (.+) /, 'check_box_tag \1, "t", false, \2 ')
+      end
+
+      def view_location(view)
+        if tailwind?
+          "app/views/rodauth/tailwind/#{view}.html.erb"
+        else
+          "app/views/rodauth/#{view}.html.erb"
+        end
+      end
+
+      def tailwind?
+        ::Rails.application.config.generators.options[:rails][:template_engine] == :tailwindcss ||
+          options[:css]&.downcase&.start_with?("tailwind")
+      end
+    end
+  end
+end

data/lib/plutonium/auth/public_access.rb

@@ -0,0 +1,17 @@
+module Plutonium
+  module Auth
+    module PublicAccess
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :current_user
+      end
+
+      private
+
+      def current_user
+        "Guest"
+      end
+    end
+  end
+end

data/lib/plutonium/auth/rodauth.rb

@@ -0,0 +1,35 @@
+module Plutonium
+  module Auth
+    module Rodauth
+      def self.for(name)
+        mod = Module.new
+        mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          extend ActiveSupport::Concern
+
+          included do
+            helper_method :current_user
+            helper_method :logout_url
+          end
+
+          private
+
+          def rodauth(name = :#{name})
+            super(name)
+          end
+
+          def current_user
+            rodauth.rails_account
+          end
+
+          def logout_url
+            rodauth.logout_path
+          end
+
+          define_singleton_method(:to_s) { "Plutonium::Auth::Rodauth(:#{name})" }
+          define_singleton_method(:inspect) { "Plutonium::Auth::Rodautht(:#{name})" }
+        RUBY
+        mod
+      end
+    end
+  end
+end

data/lib/plutonium/auth.rb

@@ -0,0 +1,12 @@
+module Plutonium
+  module Auth
+    extend ActiveSupport::Autoload
+
+    def self.rodauth(name)
+      Rodauth.for(name)
+    end
+
+    autoload :Rodauth
+    autoload :PublicAccess
+  end
+end

data/lib/plutonium/config.rb

@@ -0,0 +1,11 @@
+require "active_support"
+
+module Plutonium
+  module Config
+    mattr_accessor :reload_files
+    @@reload_files = defined?(Rails.env) && Rails.env.local?
+
+    mattr_accessor :cache_discovery
+    @@cache_discovery = defined?(Rails.env) && !Rails.env.development?
+  end
+end

data/lib/plutonium/core/action.rb

@@ -0,0 +1,46 @@
+module Plutonium
+  module Core
+    class Action
+      RouteOptions = Data.define :action, :method, :options do
+        def initialize(action: nil, method: :get, options: {})
+          super
+        end
+      end
+
+      attr_reader :name, :label, :icon, :route_options, :confirmation, :turbo_frame, :action_class
+
+      def initialize(name, label: nil, icon: nil, action_class: nil,
+        confirmation: nil,
+        route_options: nil, turbo_frame: nil,
+        collection_action: false, collection_record_action: false, record_action: false, bulk_action: false)
+        @name = name
+        @icon = icon
+        @label = label || name.to_s.humanize
+        @route_options = route_options || RouteOptions.new
+        @turbo_frame = turbo_frame
+        @action_class = action_class
+        @confirmation = confirmation
+        @collection_action = collection_action
+        @collection_record_action = collection_record_action
+        @record_action = record_action
+        @bulk_action = bulk_action
+      end
+
+      def collection_action?
+        @collection_action
+      end
+
+      def collection_record_action?
+        @collection_record_action
+      end
+
+      def record_action?
+        @record_action
+      end
+
+      def bulk_action?
+        @bulk_action
+      end
+    end
+  end
+end

data/lib/plutonium/core/actions/basic_action.rb

@@ -0,0 +1,16 @@
+module Plutonium
+  module Core
+    module Actions
+      class BasicAction < Plutonium::Core::Action
+        def initialize(*args, **kwargs)
+          kwargs.reverse_merge! action_options
+          super(*args, **kwargs)
+        end
+
+        private
+
+        def action_options = {}
+      end
+    end
+  end
+end

data/lib/plutonium/core/actions/collection.rb

@@ -0,0 +1,33 @@
+module Plutonium
+  module Core
+    module Actions
+      class Collection
+        delegate_missing_to :@collection
+
+        def initialize(collection = {})
+          @collection = collection
+        end
+
+        def permitted_for(policy)
+          Collection.new(@collection.select { |name, action| policy.send :"#{action.name}?" })
+        end
+
+        def collection_actions
+          Collection.new(@collection.select { |name, action| action.collection_action? })
+        end
+
+        def collection_record_actions
+          Collection.new(@collection.select { |name, action| action.collection_record_action? })
+        end
+
+        def record_actions
+          Collection.new(@collection.select { |name, action| action.record_action? })
+        end
+
+        def bulk_actions
+          Collection.new(@collection.select { |name, action| action.bulk_action? })
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/actions/destroy_action.rb

@@ -0,0 +1,21 @@
+module Plutonium
+  module Core
+    module Actions
+      class DestroyAction < BasicAction
+        private
+
+        def action_options
+          {
+            icon: "trash",
+            route_options: Plutonium::Core::Action::RouteOptions.new(method: :delete),
+            action_class: "danger",
+            confirmation: "Are you sure?",
+            turbo_frame: "_top",
+            collection_record_action: true,
+            record_action: true
+          }
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/actions/edit_action.rb

@@ -0,0 +1,19 @@
+module Plutonium
+  module Core
+    module Actions
+      class EditAction < BasicAction
+        private
+
+        def action_options
+          {
+            icon: "pencil",
+            route_options: Plutonium::Core::Action::RouteOptions.new(action: :edit),
+            action_class: "warning",
+            collection_record_action: true,
+            record_action: true
+          }
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/actions/interactive_action.rb

@@ -0,0 +1,64 @@
+module Plutonium
+  module Core
+    module Actions
+      class InteractiveAction < Plutonium::Core::Action
+        include Plutonium::Core::Definers::InputDefiner
+
+        Context = Data.define :resource_class
+
+        attr_reader :interaction, :inline, :inputs
+
+        def initialize(name, *args, interaction:, **kwargs)
+          set_interaction interaction
+
+          kwargs[:route_options] ||= build_route_options name
+          kwargs.reverse_merge! action_options
+          super(name, *args, **kwargs)
+        end
+
+        def confirmation
+          super || (inline ? "#{label}?" : nil)
+        end
+
+        private
+
+        def resource_class = interaction
+
+        def action_options
+          {
+            # TODO: move these into config
+            collection_action: [:interactive_resource_collection_action,
+              :interactive_resource_recordless_action].include?(action_type),
+            collection_record_action: action_type == :interactive_resource_record_action,
+            record_action: action_type == :interactive_resource_record_action,
+            bulk_action: action_type == :interactive_resource_collection_action
+          }
+        end
+
+        def set_interaction(interaction)
+          @interaction = interaction
+          @inputs = defined_inputs_for(interaction.filters.keys - [:resource, :resources])
+          @inline = @inputs.blank? unless inline == false
+        end
+
+        def build_route_options(name)
+          method = inline ? :post : :get
+          action = action_type
+          options = {interactive_action: name}
+
+          RouteOptions.new action:, method:, options:
+        end
+
+        def action_type
+          if interaction.filters.key? :resource
+            :interactive_resource_record_action
+          elsif interaction.filters.key? :resources
+            :interactive_resource_collection_action
+          else
+            :interactive_resource_recordless_action
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/actions/new_action.rb

@@ -0,0 +1,18 @@
+module Plutonium
+  module Core
+    module Actions
+      class NewAction < BasicAction
+        private
+
+        def action_options
+          {
+            icon: "plus-lg",
+            route_options: Plutonium::Core::Action::RouteOptions.new(action: :new),
+            action_class: "primary",
+            collection_action: true
+          }
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/actions/show_action.rb

@@ -0,0 +1,17 @@
+module Plutonium
+  module Core
+    module Actions
+      class ShowAction < BasicAction
+        private
+
+        def action_options
+          {
+            icon: "box-arrow-up-right",
+            action_class: "primary",
+            collection_record_action: true
+          }
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/actions.rb

@@ -0,0 +1,17 @@
+module Plutonium
+  module Core
+    module Actions
+      extend ActiveSupport::Autoload
+
+      eager_autoload do
+        autoload :BasicAction
+        autoload :Collection
+        autoload :NewAction
+        autoload :DestroyAction
+        autoload :EditAction
+        autoload :InteractiveAction
+        autoload :ShowAction
+      end
+    end
+  end
+end

data/lib/plutonium/core/app_controller.rb

@@ -0,0 +1,121 @@
+module Plutonium
+  module Core
+    module AppController
+      extend ActiveSupport::Concern
+      include Plutonium::Core::Controllers::EntityScoping
+
+      included do
+        helper_method :current_parent
+        helper_method :adapt_route_args
+      end
+
+      private
+
+      def resource_presenter(resource_class)
+        presenter_class = "#{current_package}::#{resource_class}Presenter".constantize
+        presenter_class.new resource_context
+      end
+
+      def policy_namespace(scope)
+        [current_package.to_s.underscore.to_sym, scope]
+      end
+
+      # Menu Builder
+      def build_namespace_node(namespaces, resource, parent)
+        current = namespaces.shift
+        if namespaces.size.zero?
+          parent[current.pluralize] = url_for(adapt_route_args(resource, use_parent: false))
+        else
+          parent[current] = {}
+          build_namespace_node(namespaces, resource, parent[current])
+        end
+        # parent.sort!
+      end
+
+      def build_namespace_tree(resources)
+        root = {}
+        resources.each do |resource|
+          namespaces = resource.name.split("::")
+          build_namespace_node(namespaces, resource, root)
+        end
+        root
+      end
+
+      def build_sidebar_menu
+        build_namespace_tree(current_engine.resource_register)
+      end
+
+      # Menu Builder
+
+      def current_parent
+        return unless parent_route_param.present?
+
+        @current_parent ||= begin
+          parent_route_key = parent_route_param.to_s.gsub(/_id$/, "").to_sym
+          parent_class = current_engine.registered_resource_route_key_lookup[parent_route_key]
+          parent_scope = parent_class.from_path_param(params[parent_route_param])
+          parent_scope = parent_scope.associated_with(current_scoped_entity) if scoped_to_entity?
+          parent_scope.first!
+        end
+      end
+
+      def parent_route_param
+        @parent_route_param ||= request.path_parameters.keys.reverse.find { |key| /_id$/.match? key }
+      end
+
+      #
+      # Returns the attribute on the resource if there is a current parent and the resource has a belongs to association to it
+      #
+      def parent_input_param
+        return unless current_parent.present?
+
+        resource_class.reflect_on_all_associations(:belongs_to).find { |assoc| assoc.klass == current_parent.class }&.name&.to_sym
+      end
+
+      #
+      # Returns a dynamic list of args to be used with `url_for` which considers the route namespace and nesting.
+      # The current entity and parent record (for nested routes) are inserted appropriately, ensuring that generated urls
+      # obey the current routing.
+      #
+      # e.g. of route helpers that will be invoked given the output of this method
+      #
+      # - when invoked in a root route (/acme/dashboard/users)
+      #
+      # `adapt_route_args User`                   => `entity_users_*`
+      # `adapt_route_args @user`                  => `entity_user_*`
+      # `adapt_route_args @user, action: :edit`   => `edit_entity_user_*`
+      # `adapt_route_args @user, Post             => `entity_user_posts_*`
+      #
+      # - when invoked in a nested route (/acme/dashboard/users/1/post/1)
+      #
+      # `adapt_route_args Post`                   => `entity_user_posts_*`
+      # `adapt_route_args @post`                  => `entity_user_post_*`
+      # `adapt_route_args @post, action: :edit`   => `edit_entity_user_post_*`
+      #
+      # @param [Class, ApplicationRecord] *args arguments you would normally pass to `url_for`
+      # @param [Symbol] action optional action to invoke e.g. :new, :edit
+      #
+      # @return [Array[Class, ApplicationRecord, Symbol]] args to pass to `url_for`
+      #
+      def adapt_route_args(*args, action: nil, use_parent: true, **kwargs)
+        # If the last item is a class and the action is :new e.g. `adapt_route_args User, action: :new`,
+        # it must be converted into a symbol to generate the appropriate helper i.e `new_user_*`
+        # to match the url helper generated by `resources :users`
+        resource = args.pop
+        resource = resource.model_name.singular_route_key.to_sym if action == :new && resource.is_a?(Class)
+        args.push resource
+
+        parent = use_parent ? current_parent : nil
+
+        base_args = if scoped_to_entity?
+          [action, current_scoped_entity.becomes(scoped_entity_class), parent]
+        else
+          [action, parent]
+        end
+
+        # rails compacts this list. no need to handle nils
+        base_args + args + [**kwargs]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Plutonium
+  module Core
+    module Autodiscovery
+      module Discoverer
+        extend ActiveSupport::Concern
+
+        private
+
+        def resource_class
+          raise NotImplementedError, "#{self.class}#resource_class"
+        end
+      end
+    end
+  end
+end