plutonium 0.13.3 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d53d01dfc30698f6bc1b3493db5509baab84b07fa49b4539ff18f6b033336982
-  data.tar.gz: 45b8cf3a4d0f2b022ce5ad495d519724175bc62eda2c783851bf4b5d44e2e958
+  metadata.gz: fba393cb403832162cff127ae398c28751984ad8070292ea2e4bc0b01e726678
+  data.tar.gz: deeca5afea70265663e0343d2b23fb7f0522fcacbd8c6f79fe864b6b0b2fd7a7
 SHA512:
-  metadata.gz: a59752cd033c146756b2a330f7e42bc7ae526570cc9851c26fec6daabbf5fe41794c0069b0a21f4c5a9ea4425f5ddb4a7d90d1df89097db700231bd119dcb9c0
-  data.tar.gz: 1e64998368c580cd5a52a0c22c1e7df3a883e963a32a2f65b5e6f390a9b3e2d9cda19f568091a0c9cf2e0bea06f66ab459e25c7eb8672d86880aa83008b1c844
+  metadata.gz: aad819f43bb0a0707d02649fc169b9f4fa9e3bac860bb7fb01530d4f630a36e025eaea4f6e1502c94cb50b04c139735ad46eb9bef1de91d27ebfaf1e6461f589
+  data.tar.gz: 9c3bdb87605c5fa2339285b8a0ae6347016f40b72fbbfcdf93cadaf21281a0a1ce07dfb2630bc006a404e2265eefbc20dc238272c6e5091b8e6eaf871e5f892d

data/lib/generators/pu/core/assets/assets_generator.rb

@@ -37,8 +37,8 @@ module Pu
           registerControllers(application)
         EOT
 
-        environment "config.plutonium.assets.stylesheet = \"application\""
-        environment "config.plutonium.assets.script = \"application\""
+        configure_plutonium "config.assets.stylesheet = \"application\""
+        configure_plutonium "config.assets.script = \"application\""
       end
     end
   end

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

@@ -31,9 +31,6 @@ module Pu
       def setup_app
         directory "config"
         directory "app"
-
-        environment "# config.plutonium.assets.favicon = \"favicon.ico\""
-        environment "# config.plutonium.assets.logo = \"logo.png\""
       end
 
       def eject_views

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

@@ -1,5 +1,15 @@
 # Configure plutonium
 
+Plutonium.configure do |config|
+  config.load_defaults 1.0
+
+  # config.assets.logo = "logo.png"
+  # Configure plutonium above this
+end
+
 Rails.application.config.to_prepare do
   # Register components here
+
+  # e.g
+  # Plutonium::Core::Fields::Renderers::Factory.map_type :mapped_collection, to: Fields::Renderers::MappedCollectionRenderer
 end

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

@@ -272,6 +272,25 @@ module PlutoniumGenerators
         end
       end
 
+      def configure_plutonium(data = nil, options = {})
+        data ||= yield if block_given?
+
+        log :configure_plutonium, data
+
+        in_root do
+          replace_existing = ->(file, data) do
+            gsub_file file, Regexp.new(".*#{data.split("=").first.strip}.*=.*\n"), data, verbose: false
+          end
+
+          data = optimize_indentation(data, 2)
+          file = "config/initializers/plutonium.rb"
+          replace_existing.call file, data
+          break if File.read(file).match? regexify_config(data)
+
+          inject_into_file file, data, before: /.*# Configure plutonium above this.*/, verbose: false
+        end
+      end
+
       #
       # Set a config in the application generator block
       # If the configuration exists already, it is updated

data/lib/generators/pu/pkg/app/templates/config/routes.rb.tt

@@ -1,11 +1,10 @@
-<%= package_name %>::Engine.draw_custom_routes do
-  # draw custom routes here
-
+<%= package_name %>::Engine.routes.draw do
   root to: "dashboard#index"
-end
 
-# draw routes for registered resources
-<%= package_name %>::Engine.draw_resource_routes
+  # register resources above.
+
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+end
 
 # mount our app
 Rails.application.routes.draw do

data/lib/generators/pu/pkg/app/templates/lib/engine.rb.tt

@@ -4,11 +4,7 @@ module <%= package_name %>
     # add concerns above.
 
     config.after_initialize do
-      initialize_register!
-
       # add directives above.
-
-      # register resources above.
     end
   end
 end

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

@@ -15,13 +15,13 @@ module Pu
 
       def start
         source_feature = select_feature msg: "Select source feature"
-        source_module = (source_feature == "main_app") ? "ResourceRecord" : "#{source_feature.classify}::ResourceRecord"
+        source_module = (source_feature == "main_app") ? "ResourceRecord" : "#{source_feature.camelize}::ResourceRecord"
 
         Plutonium.eager_load_rails!
         available_resources = source_module.constantize.descendants.map(&:to_s).sort
         selected_resources = prompt.multi_select("Select resources", available_resources)
 
-        @app_namespace = select_app.classify
+        @app_namespace = select_app.camelize
 
         selected_resources.each do |resource|
           @resource_class = resource
@@ -31,8 +31,8 @@ module Pu
           # 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),
+          insert_into_file "packages/#{package_namespace}/config/routes.rb",
+            indent("register_resource ::#{resource}\n", 2),
             before: /.*# register resources above.*/
         end
       rescue => e

data/lib/plutonium/application/controller.rb

@@ -36,7 +36,7 @@ module Plutonium
       # end
 
       def registered_resources
-        current_engine.resource_register
+        current_engine.resource_register.resources
       end
     end
   end

data/lib/plutonium/application/dynamic_controllers.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module Application
+    # DynamicControllers module provides functionality for dynamically creating controller classes
+    # when they are missing in the current module's namespace.
+    #
+    # @example Usage
+    #   module MyApp
+    #     include Plutonium::Application::DynamicControllers
+    #   end
+    #
+    #   # Now, MyApp::SomeController will be dynamically created if it doesn't exist,
+    #   # inheriting from ::SomeController and including MyApp::Concerns::Controller
+    #
+    # @note This module is designed to be included in a parent module that represents
+    #   a namespace for controllers.
+    module DynamicControllers
+      extend ActiveSupport::Concern
+
+      class_methods do
+        # Handles missing constant lookup, specifically for controller classes
+        #
+        # @param const_name [Symbol] The name of the missing constant
+        # @return [Class, nil] The dynamically created controller class if applicable, otherwise nil
+        # @raise [NameError] If the constant is not a controller and cannot be found
+        def const_missing(const_name)
+          if const_name.to_s.end_with?("Controller")
+            create_dynamic_controller(const_name)
+          else
+            super
+          end
+        end
+
+        private
+
+        # Creates a dynamic controller class
+        #
+        # @param const_name [Symbol] The name of the controller class to create
+        # @return [Class] The newly created controller class
+        # @raise [NameError] If the parent controller or concerns module cannot be found
+        def create_dynamic_controller(const_name)
+          parent_controller = "::#{const_name}".constantize
+          current_module = name
+          const_full_name = "#{current_module}::#{const_name}"
+
+          klass = Class.new(parent_controller) do
+            # YARD documentation for the dynamically created controller
+            # @!parse
+            #   class DynamicController < ParentController
+            #     include ParentModule::Concerns::Controller
+            #     # Dynamically created controller for handling actions in the parent module
+            #     #
+            #     # This controller is created at runtime to handle requests within the parent namespace.
+            #     # It inherits from the corresponding top-level controller (e.g., ::ClientsController for ParentModule::ClientsController).
+            #     # It also includes ParentModule::Concerns::Controller.
+            #     #
+            #     # @note This class is created dynamically and may not have explicit method definitions.
+            #   end
+          end
+
+          # Define the constant in the global namespace
+          define_nested_constant(const_full_name, klass)
+
+          # Include required modules
+          concerns_module = "#{current_module}::Concerns::Controller".constantize
+          route_helpers_module = "#{AdminApp}::Engine".constantize.routes.url_helpers
+          klass.include route_helpers_module
+          klass.include concerns_module
+
+          # # Run the load hooks to include necessary modules and configurations
+          # ActiveSupport.run_load_hooks(:action_controller, klass)
+
+          log_controller_creation(const_full_name, parent_controller)
+          const_full_name.constantize
+        rescue => e
+          Plutonium.logger.error "[plutonium] Failed to create dynamic controller: #{e.message}"
+          raise
+        end
+
+        # Defines a constant in the global namespace, handling nested modules
+        #
+        # @param const_full_name [String] The full module name
+        # @param value [Object] The value to assign to the constant
+        def define_nested_constant(const_full_name, value)
+          names = const_full_name.split("::")
+          const_name = names.pop
+
+          names.inject(Object) do |mod, name|
+            if mod.const_defined?(name)
+              mod.const_get(name)
+            else
+              mod.const_set(name, Module.new)
+            end
+          end.const_set(const_name, value)
+        end
+
+        # Logs the creation of a dynamic controller
+        #
+        # @param const_full_name [String] The full name of the created controller
+        # @param parent_controller [Class] The parent controller class
+        def log_controller_creation(const_full_name, parent_controller)
+          Plutonium.logger.info "[plutonium] Dynamically created #{const_full_name} < #{parent_controller}"
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/auth/rodauth.rb

@@ -28,7 +28,7 @@ module Plutonium
           end
 
           define_singleton_method(:to_s) { "Plutonium::Auth::Rodauth(:#{name})" }
-          define_singleton_method(:inspect) { "Plutonium::Auth::Rodautht(:#{name})" }
+          define_singleton_method(:inspect) { "Plutonium::Auth::Rodauth(:#{name})" }
         RUBY
         mod
       end

data/lib/plutonium/concerns/resource_validatable.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module Concerns
+    # Provides methods for validating Plutonium resources
+    module ResourceValidatable
+      extend ActiveSupport::Concern
+
+      # Custom error class for invalid resources
+      class InvalidResourceError < StandardError; end
+
+      private
+
+      # Validates if a given resource is a valid Plutonium::Resource::Record
+      #
+      # @param resource [Object] The resource to validate
+      # @raise [InvalidResourceError] If the resource is not valid
+      # @return [void]
+      def validate_resource!(resource)
+        unless valid_resource?(resource)
+          raise InvalidResourceError, "#{resource} is not a valid Plutonium::Resource::Record"
+        end
+      end
+
+      # Checks if a given resource is a valid Plutonium::Resource::Record
+      #
+      # @param resource [Object] The resource to check
+      # @return [Boolean] True if the resource is valid, false otherwise
+      def valid_resource?(resource)
+        resource.is_a?(Class) && resource.include?(Plutonium::Resource::Record)
+      end
+    end
+  end
+end

data/lib/plutonium/config/overlayed_hash.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module Config
+    # OverlayedHash provides a hash-like structure that overlays values on top of a base hash.
+    #
+    # This class allows you to create a new hash-like object that uses a base hash for default values,
+    # but can be modified without affecting the original base hash. When a key is accessed, it first
+    # checks if the key exists in the overlay; if not, it falls back to the base hash.
+    #
+    # @example Usage
+    #   base = { a: 1, b: 2 }
+    #   overlay = OverlayedHash.new(base)
+    #   overlay[:b] = 3
+    #   overlay[:c] = 4
+    #
+    #   overlay[:a] # => 1 (from base)
+    #   overlay[:b] # => 3 (from overlay)
+    #   overlay[:c] # => 4 (from overlay)
+    #   base[:b]    # => 2 (unchanged)
+    class OverlayedHash
+      # Initialize a new OverlayedHash with a base hash.
+      #
+      # @param base [Hash] The base hash to use for fallback values.
+      def initialize(base)
+        @base = base
+        @overlay = {}
+      end
+
+      # Retrieve a value from the overlay hash or the base hash.
+      #
+      # @param key The key to look up.
+      # @return The value associated with the key, or nil if not found.
+      def [](key)
+        @overlay.key?(key) ? @overlay[key] : @base[key]
+      end
+
+      # Set a value in the overlay hash.
+      #
+      # @param key The key to set.
+      # @param value The value to associate with the key.
+      def []=(key, value)
+        @overlay[key] = value
+      end
+
+      # Check if a key exists in either the overlay or base hash.
+      #
+      # @param key The key to check for.
+      # @return [Boolean] true if the key exists, false otherwise.
+      def key?(key)
+        @overlay.key?(key) || @base.key?(key)
+      end
+
+      # Enumerate over all keys in both the overlay and base hash.
+      #
+      # @yield [key] Gives each key to the block.
+      # @return [Enumerator] If no block is given.
+      def each_key
+        return to_enum(:each_key) unless block_given?
+
+        keys.each { |key| yield key }
+      end
+
+      # Retrieve all keys from both the overlay and base hash.
+      #
+      # @return [Array] An array of all unique keys.
+      def keys
+        (@overlay.keys + @base.keys).uniq
+      end
+
+      # Retrieve all values, prioritizing the overlay over the base.
+      #
+      # @return [Array] An array of values corresponding to all keys.
+      def values
+        keys.map { |key| self[key] }
+      end
+
+      # Convert the OverlayedHash to a regular Hash.
+      #
+      # @return [Hash] A new Hash with all keys and values from the OverlayedHash.
+      def to_h
+        keys.each_with_object({}) { |key, hash| hash[key] = self[key] }
+      end
+    end
+  end
+end

data/lib/plutonium/configuration.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Plutonium
+  # Configuration class for Plutonium module
+  #
+  # @example
+  #   Plutonium.configure do |config|
+  #     config.load_defaults 1.0
+  #     config.development = true
+  #     config.cache_discovery = false
+  #     config.enable_hotreload = true
+  #     config.assets.logo = "custom_logo.png"
+  #   end
+  class Configuration
+    # @return [Boolean] whether Plutonium is in development mode
+    attr_accessor :development
+
+    # @return [Boolean] whether to cache discovery
+    attr_accessor :cache_discovery
+
+    # @return [Boolean] whether to enable hot reloading
+    attr_accessor :enable_hotreload
+
+    # @return [AssetConfiguration] asset configuration
+    attr_reader :assets
+
+    # @return [Float] the current defaults version
+    attr_reader :defaults_version
+
+    # Map of version numbers to their default configurations
+    VERSION_DEFAULTS = {
+      1.0 => proc do |config|
+        # No changes for 1.0 yet as it's the current base configuration
+      end
+      # Add more version configurations here as needed
+      # 1.1 => proc do |config|
+      #   config.some_new_setting = true
+      # end
+    }.freeze
+
+    # Initialize a new Configuration instance
+    #
+    # @note This method sets initial values
+    def initialize
+      @defaults_version = nil
+      @assets = AssetConfiguration.new
+
+      @development = parse_boolean_env("PLUTONIUM_DEV")
+      @cache_discovery = !Rails.env.development?
+      @enable_hotreload = Rails.env.development?
+    end
+
+    # Load default configuration for a specific version
+    #
+    # @param version [Float] the version to load defaults for
+    # @return [void]
+    def load_defaults(version)
+      available_versions = VERSION_DEFAULTS.keys.sort
+      applicable_versions = available_versions.select { |v| v <= version }
+
+      if applicable_versions.empty?
+        raise "No applicable defaults found for version #{version}."
+      end
+
+      applicable_versions.each do |v|
+        VERSION_DEFAULTS[v].call(self)
+      end
+
+      @defaults_version = applicable_versions.last
+    end
+
+    # whether Plutonium is in development mode
+    #
+    # @return [Boolean]
+    def development?
+      @development
+    end
+
+    private
+
+    # Parse boolean environment variable
+    #
+    # @param env_var [String] name of the environment variable
+    # @return [Boolean] parsed boolean value
+    def parse_boolean_env(env_var)
+      ActiveModel::Type::Boolean.new.cast(ENV[env_var]).present?
+    end
+
+    # Asset configuration for Plutonium
+    class AssetConfiguration
+      # @return [String] path to logo file
+      attr_accessor :logo
+
+      # @return [String] path to favicon file
+      attr_accessor :favicon
+
+      # @return [String] path to stylesheet file
+      attr_accessor :stylesheet
+
+      # @return [String] path to JavaScript file
+      attr_accessor :script
+
+      # Initialize a new AssetConfiguration instance with default values
+      def initialize
+        @logo = "plutonium.png"
+        @favicon = "plutonium.ico"
+        @stylesheet = "plutonium.css"
+        @script = "plutonium.min.js"
+      end
+    end
+  end
+
+  class << self
+    # Get the current configuration
+    #
+    # @return [Configuration] current configuration instance
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Configure Plutonium
+    #
+    # @yield [config] Configuration instance
+    # @yieldparam config [Configuration] current configuration instance
+    # @return [void]
+    def configure
+      yield(configuration)
+    end
+
+    # Load default configuration for a specific version
+    #
+    # @param version [Float] the version to load defaults for
+    # @return [void]
+    def load_defaults(version)
+      configuration.load_defaults(version)
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ module Plutonium
         # 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
+          if Plutonium.configuration.cache_discovery
             self.class.autodiscovery_association_renderer_cache
           else
             @autodiscovery_association_renderer_cache ||= {}

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

@@ -14,7 +14,7 @@ module Plutonium
         # If cache_discovery is enabled, use the class level cache that persists
         # between requests, otherwise use the instance one.
         def autodiscovery_input_cache
-          if Rails.application.config.plutonium.cache_discovery
+          if Plutonium.configuration.cache_discovery
             self.class.autodiscovery_input_cache
           else
             @autodiscovery_input_cache ||= {}

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

@@ -14,7 +14,7 @@ module Plutonium
         # If cache_discovery is enabled, use the class level cache that persists
         # between requests, otherwise use the instance one.
         def autodiscovery_renderer_cache
-          if Rails.application.config.plutonium.cache_discovery
+          if Plutonium.configuration.cache_discovery
             self.class.autodiscovery_renderer_cache
           else
             @autodiscovery_renderer_cache ||= {}