plutonium 0.12.9 → 0.12.11

data/lib/plutonium/core/fields/renderers/base.rb

@@ -0,0 +1,83 @@
+module Plutonium
+  module Core
+    module Fields
+      module Renderers
+        class Base
+          include Plutonium::Core::Renderable
+
+          attr_reader :name
+
+          # Initializes the Base renderer class with a name and user-defined options.
+          #
+          # @param name [String] the name of the renderer.
+          # @param user_options [Hash] user-defined options for the renderer.
+          def initialize(name, **user_options)
+            @name = name
+            @user_options = user_options
+          end
+
+          # Sets the record object on the renderer and merges render options.
+          #
+          # @param record [Object] the record object.
+          # @param render_options [Hash] additional options for rendering.
+          # @return [self] the renderer instance.
+          def with(record:, **render_options)
+            @record = record
+            @render_options = render_options
+            @options = build_options(render_options)
+
+            self
+          end
+
+          def label
+            options[:label] || record.class.human_attribute_name(name)
+          end
+
+          private
+
+          # Returns the merged options for rendering.
+          #
+          # @raise [RuntimeError] if accessed before rendering.
+          # @return [Hash] the merged options.
+          def options
+            raise "cannot access #options before calling #with" unless defined?(@options)
+
+            @options
+          end
+
+          # Returns the record object.
+          #
+          # @raise [RuntimeError] if accessed before rendering.
+          # @return [Object] the record object.
+          def record
+            raise "cannot access #record before calling #with" unless defined?(@record)
+
+            @record
+          end
+
+          # Returns the value of the record's attribute corresponding to the renderer's name.
+          #
+          # @return [Object] the value of the attribute.
+          def value
+            record.public_send(name)
+          end
+
+          # Returns renderer-specific options, can be overridden by subclasses.
+          #
+          # @return [Hash] the renderer-specific options.
+          def renderer_options
+            {}
+          end
+
+          # Builds the options for rendering by merging renderer options, user options, and render options.
+          #
+          # @param render_options [Hash] additional options for rendering.
+          # @return [Hash] the merged options.
+          def build_options(render_options)
+            renderer_options.deep_merge(@user_options).deep_merge(render_options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/fields/renderers/basic_renderer.rb

@@ -2,24 +2,10 @@ module Plutonium
   module Core
     module Fields
       module Renderers
-        class BasicRenderer
-          attr_reader :name, :label, :user_options
-
-          def initialize(name, label:, **user_options)
-            @name = name
-            @label = label
-            @user_options = user_options
+        class BasicRenderer < Base
+          def render
+            display_field value:, **options
           end
-
-          def render(view_context, record)
-            view_context.display_field value: record.send(name), **options
-          end
-
-          def options = @options ||= renderer_options.deep_merge(@user_options)
-
-          private
-
-          def renderer_options = {}
         end
       end
     end

data/lib/plutonium/core/fields/renderers/factory.rb

@@ -17,7 +17,6 @@ module Plutonium
 
           def self.for_resource_attribute(resource_class, attr_name, **options)
             type = nil
-            options[:label] ||= resource_class.human_attribute_name(attr_name)
 
             if (attachment = resource_class.try(:reflect_on_attachment, attr_name))
               type = :attachment

data/lib/plutonium/core/renderable.rb

@@ -0,0 +1,20 @@
+module Plutonium
+  module Core
+    module Renderable
+      extend ActiveSupport::Concern
+
+      included do
+        delegate_missing_to :@view_context
+      end
+
+      def render_in(view_context)
+        @view_context = view_context
+        render
+      end
+
+      def render
+        raise NotImplementedError, "#{self.class}#render"
+      end
+    end
+  end
+end

data/lib/plutonium/helpers/display_helper.rb

@@ -73,7 +73,7 @@ module Plutonium
 
         # Fallback to retrieving the value from a predefined list
         %i[to_label name title].each do |method|
-          name = obj.send(method) if obj.respond_to?(method)
+          name = obj.public_send(method) if obj.respond_to?(method)
           return name if name.present?
         end
 

data/lib/plutonium/resource/controller.rb

@@ -69,7 +69,7 @@ module Plutonium
         override_entity_scoping_params(input_params)
         override_parent_params(input_params)
 
-        current_presenter.defined_inputs_for(*permitted_attributes).collect_all(input_params)
+        current_presenter.defined_field_inputs_for(*permitted_attributes).collect_all(input_params)
       end
 
       # Returns the resource parameter key

data/lib/plutonium/resource/policy.rb

@@ -18,7 +18,7 @@ module Plutonium
           raise NotImplementedError, "#{self.class.name} does not implement the required #{method}"
         end
 
-        send(method)
+        public_send(method)
       end
 
       # Core actions

data/lib/plutonium/resource/presenter.rb

@@ -63,7 +63,7 @@ module Plutonium
 
         nested_attribute_options_class = nested_attribute_options&.[](:class)
         if nested_attribute_options_class.nil? && model_class.nil?
-          raise ArgumentError, "model_class is required if your field is not an association or is polymorphic"
+          raise ArgumentError, "model_class is required if your field is not an association or is polymorphic. also ensure you have called `accepts_nested_attributes_for :#{name}`"
         end
         model_class ||= nested_attribute_options_class
 
@@ -83,7 +83,7 @@ module Plutonium
         )
         yield input if block_given?
 
-        define_input name, input:
+        define_field_input name, input:
       end
 
       # Determines the limit for a nested input
@@ -92,7 +92,7 @@ module Plutonium
       # @param [Integer, nil] nested_attribute_limit The limit from nested attributes
       # @return [Integer, nil] The determined limit
       def determine_nested_input_limit(macro, option_limit, nested_attribute_limit)
-        if macro == :has_one
+        if %i[belongs_to has_one].include? macro
           1
         elsif option_limit
           option_limit

data/lib/plutonium/resource/query_object.rb

@@ -5,7 +5,7 @@ module Plutonium
       end
 
       class Query
-        include Plutonium::Core::Definers::InputDefiner
+        include Plutonium::Core::Definers::FieldInputDefiner
 
         # Applies the query to the given scope using the provided parameters.
         #
@@ -65,7 +65,7 @@ module Plutonium
         # @param params [Hash] The parameters for the query.
         # @return [Object] The modified scope.
         def apply_internal(scope, params)
-          scope.send(name, **params)
+          scope.public_send(name, **params)
         end
       end
 
@@ -215,7 +215,7 @@ module Plutonium
         end
 
         sort_definitions[name] = build_query(body) do |query|
-          query.define_input :direction
+          query.define_field_input :direction
         end
       end
 
@@ -224,7 +224,7 @@ module Plutonium
       # @param body [Proc, Symbol] The body of the search filter.
       def define_search(body)
         @search_filter = build_query(body) do |query|
-          query.define_input :search
+          query.define_field_input :search
         end
       end
 

data/lib/plutonium/resource/record.rb

@@ -22,7 +22,7 @@ module Plutonium
           record_association = klass.find_association_to_self(record)
           if record_association
             # TODO: add a warning here about a potentially poor performing query
-            return where(id: record.send(record_association.name))
+            return where(id: record.public_send(record_association.name))
           end
 
           klass.raise_association_error(record, named_scope)

data/lib/plutonium/simple_form/attachment_component.rb

@@ -40,7 +40,7 @@ module Plutonium
       private
 
       def value
-        @value ||= object.send(attribute_name) if object&.respond_to?(attribute_name)
+        @value ||= object.public_send(attribute_name) if object&.respond_to?(attribute_name)
       end
 
       def multiple?

data/lib/plutonium/version.rb

@@ -1,3 +1,3 @@
 module Plutonium
-  VERSION = "0.12.9"
+  VERSION = "0.12.11"
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@radioactive-labs/plutonium",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Core assets for the Plutonium gem",
   "type": "module",
   "main": "src/js/core.js",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plutonium
 version: !ruby/object:Gem::Version
-  version: 0.12.9
+  version: 0.12.11
 platform: ruby
 authors:
 - Stefan Froelich
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -208,6 +208,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- "# Plutonium: The pre-alpha demo.md"
 - ".node-version"
 - ".rspec"
 - ".ruby-version"
@@ -877,6 +878,15 @@ files:
 - lib/generators/pu/docker/install/templates/docker-compose.yml
 - lib/generators/pu/eject/layout/layout_generator.rb
 - lib/generators/pu/eject/shell/shell_generator.rb
+- lib/generators/pu/field/input/input_generator.rb
+- lib/generators/pu/field/input/templates/.keep
+- lib/generators/pu/field/input/templates/input.rb.tt
+- lib/generators/pu/field/renderer/renderer_generator.rb
+- lib/generators/pu/field/renderer/templates/.keep
+- lib/generators/pu/field/renderer/templates/renderer.rb.tt
+- lib/generators/pu/gem/annotate/annotate_generator.rb
+- lib/generators/pu/gem/annotate/templates/.keep
+- lib/generators/pu/gem/annotate/templates/lib/tasks/auto_annotate_models.rake
 - lib/generators/pu/gem/dotenv/dotenv_generator.rb
 - lib/generators/pu/gem/dotenv/templates/.env
 - lib/generators/pu/gem/dotenv/templates/.env.local
@@ -1029,7 +1039,7 @@ files:
 - lib/plutonium/core/actions/interactive_action.rb
 - lib/plutonium/core/actions/new_action.rb
 - lib/plutonium/core/actions/show_action.rb
-- lib/plutonium/core/associations/renderers/basic_renderer.rb
+- lib/plutonium/core/associations/renderers/base.rb
 - lib/plutonium/core/associations/renderers/factory.rb
 - lib/plutonium/core/associations/renderers/has_many_renderer.rb
 - lib/plutonium/core/autodiscovery/association_renderer_discoverer.rb
@@ -1047,8 +1057,8 @@ files:
 - lib/plutonium/core/definers/action_definer.rb
 - lib/plutonium/core/definers/association_renderer_definer.rb
 - lib/plutonium/core/definers/field_definer.rb
-- lib/plutonium/core/definers/input_definer.rb
-- lib/plutonium/core/definers/renderer_definer.rb
+- lib/plutonium/core/definers/field_input_definer.rb
+- lib/plutonium/core/definers/field_renderer_definer.rb
 - lib/plutonium/core/fields/inputs/attachment_input.rb
 - lib/plutonium/core/fields/inputs/base.rb
 - lib/plutonium/core/fields/inputs/belongs_to_association_input.rb
@@ -1064,8 +1074,10 @@ files:
 - lib/plutonium/core/fields/inputs/simple_form_input.rb
 - lib/plutonium/core/fields/renderers/association_renderer.rb
 - lib/plutonium/core/fields/renderers/attachment_renderer.rb
+- lib/plutonium/core/fields/renderers/base.rb
 - lib/plutonium/core/fields/renderers/basic_renderer.rb
 - lib/plutonium/core/fields/renderers/factory.rb
+- lib/plutonium/core/renderable.rb
 - lib/plutonium/core/ui/collection.rb
 - lib/plutonium/core/ui/detail.rb
 - lib/plutonium/core/ui/form.rb

data/lib/plutonium/core/associations/renderers/basic_renderer.rb

@@ -1,28 +0,0 @@
-module Plutonium
-  module Core
-    module Associations
-      module Renderers
-        class BasicRenderer
-          attr_reader :name, :label, :reflection, :user_options
-
-          def initialize(name, label:, reflection:, **user_options)
-            @name = name
-            @label = label
-            @reflection = reflection
-            @user_options = user_options
-          end
-
-          def render(view_context, record)
-            raise NotImplementedError
-          end
-
-          def options = @options ||= renderer_options.deep_merge(@user_options)
-
-          private
-
-          def renderer_options = {}
-        end
-      end
-    end
-  end
-end