crudable-rails 1.4.0 → 1.5.0

data/lib/generators/crudable/templates/crudable_controller.rb.tt

@@ -0,0 +1,257 @@
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  crudable
+
+  private
+
+  # ---------------------------------------------------------------------------
+  # Optional overrides (self-documenting hooks)
+  #
+  # `crudable` mixes in `Crudable::Rails::Base` (which includes `Resourceable`
+  # and `Nestable`), which provides the REST actions and calls these hooks.
+  # Uncomment and tailor any of the following as needed.
+  # ---------------------------------------------------------------------------
+  #
+  # # Override the model class when it cannot be inferred from the controller name.
+  # def resource_class
+  #   <%= class_name %>
+  # end
+  #
+  # # Customize the record passed to Pundit (e.g. namespaced authorization).
+  # def authorizable_resource
+  #   @<%= singular_table_name %>
+  # end
+  #
+  # # If this resource is singular (e.g. SettingsController), return true.
+  # def singleton?
+  #   false
+  # end
+  #
+  # # Which param key to use when finding a member resource.
+  # def finder_param
+  #   :id
+  # end
+  #
+  # # Enable FriendlyId finders/redirects.
+  # def friendly_finders?
+  #   return false unless defined?(FriendlyId) && resource_class.respond_to?(:friendly)
+  #
+  #   true
+  # end
+  #
+  # # Nested parent lookup: use FriendlyId for the parent when available.
+  # def parent_friendly_finders?
+  #   return false unless defined?(FriendlyId)
+  #   return false unless parent_class.respond_to?(:friendly)
+  #
+  #   friendly_finders?
+  # end
+  #
+  # # Enable pagination (requires Kaminari).
+  # def paginate_resource?
+  #   return false unless defined?(Kaminari)
+  #
+  #   true
+  # end
+  #
+  # # Customize the base scope for index (before HasScope and Pundit).
+  # def find_scope
+  #   if parent_resource_association.present?
+  #     instance_variable_get("@#{parent_var_name}").send(parent_resource_association)
+  #   else
+  #     <%= class_name %>
+  #   end
+  # end
+  #
+  # # Customize the scope used for index. Primary hook for filtering.
+  # # (HasScope is applied automatically if present.)
+  # def authorizable_scope
+  #   scope = find_scope
+  #   return scope.all unless authorize_with_pundit?
+  #   return scope.all unless pundit_authorization_available?
+  #
+  #   policy_scope(resource_namespace + [scope])
+  # end
+  #
+  # # Full scope used for index (after HasScope, Pundit, etc).
+  # def resource_scope
+  #   return apply_scopes(authorizable_scope) if defined?(HasScope)
+  #
+  #   authorizable_scope
+  # end
+  #
+  # # Skip initializing a new instance in create (useful for custom create flows).
+  # def skip_initialize_create?
+  #   false
+  # end
+  #
+  # # Discard/soft-delete support (requires Discard). When true, destroy will
+  # # choose discard vs destroy based on record state and params.
+  # def discard?
+  #   false
+  # end
+  #
+  # # Control whether Pundit authorization should be performed.
+  # def authorize_with_pundit?
+  #   defined?(Pundit)
+  # end
+  #
+  # # Authorization lifecycle hooks (called inside create/update).
+  # def before_authorize_create; end
+  # def after_authorize_create; end
+  # def before_authorize_update; end
+  # def after_authorize_update; end
+  #
+  # # Post-success hooks (side-effects, instrumentation, etc).
+  # def on_successful_create
+  #   flash[:success] = after_create_notice
+  # end
+  #
+  # def on_successful_update
+  #   flash[:success] = after_update_notice
+  # end
+  #
+  # def on_successful_destroy
+  #   flash[:success] = after_destroy_notice
+  # end
+  #
+  # # Failure setup hooks (e.g., rebuild form collections).
+  # def on_failed_create_setup; end
+  # def on_failed_update_setup; end
+  #
+  # def on_failed_destroy
+  #   flash[:alert] = after_failed_destroy_alert
+  # end
+  #
+  # # Customize success redirects/flash messages.
+  # def after_create_redirect_path
+  #   if respond_to?(:parent_present?) && parent_present? && instance_variable_get("@#{parent_var_name}")
+  #     parent = instance_variable_get("@#{parent_var_name}")
+  #     resource_namespace + [parent, :<%= plural_table_name %>]
+  #   else
+  #     resource_namespace + [:<%= plural_table_name %>]
+  #   end
+  # rescue NoMethodError
+  #   resource_namespace + [:<%= plural_table_name %>]
+  # end
+  #
+  # def after_create_notice
+  #   t('crudable.created', model_name: <%= class_name %>.model_name.human)
+  # end
+  #
+  # def after_update_redirect_path
+  #   resource_namespace + [@<%= singular_table_name %>]
+  # end
+  #
+  # def after_update_notice
+  #   t('crudable.updated', model_name: <%= class_name %>.model_name.human)
+  # end
+  #
+  # def after_destroy_redirect_path
+  #   resource_namespace + [:<%= plural_table_name %>]
+  # end
+  #
+  # def after_failed_destroy_redirect_path
+  #   after_destroy_redirect_path
+  # end
+  #
+  # def after_destroy_notice
+  #   t('crudable.destroyed', model_name: <%= class_name %>.model_name.human)
+  # end
+  #
+  # def after_failed_destroy_alert
+  #   t('crudable.not_destroyed', model_name: <%= class_name %>.model_name.human)
+  # end
+  #
+  # # Customize rendering for success/failure outcomes (Turbo/HTML).
+  # def on_successful_create_render
+  #   redirect_to after_create_redirect_path
+  # end
+  #
+  # def on_failed_create_render
+  #   resource = @<%= singular_table_name %>
+  #   @<%= singular_table_name %> = new_instance if resource.nil?
+  #   respond_to do |format|
+  #     format.turbo_stream { render_action(:new) }
+  #     format.html { render :new, status: :unprocessable_content }
+  #   end
+  # end
+  #
+  # def on_successful_update_render
+  #   redirect_to after_update_redirect_path
+  # end
+  #
+  # def on_failed_update_render
+  #   respond_to do |format|
+  #     format.turbo_stream { render_action(:edit) }
+  #     format.html { render :edit, status: :unprocessable_content }
+  #   end
+  # end
+  #
+  # def on_successful_destroy_render
+  #   redirect_to after_destroy_redirect_path
+  # end
+  #
+  # def on_failed_destroy_render
+  #   redirect_to after_failed_destroy_redirect_path
+  # end
+  #
+  # # Customize pagination when enabled.
+  # def paginate_resource
+  #   return unless paginate_resource?
+  #
+  #   @<%= plural_table_name %> = @<%= plural_table_name %>.page(params[:page]).per(params[:per])
+  # end
+  #
+  # # Customize 404 responses.
+  # def render_not_found
+  #   head :not_found
+  # end
+  #
+  # # Nested resources: parent scoping is automatic when a `*_id` param is present.
+  # def use_parent_as_scope?
+  #   true
+  # end
+  #
+  # # Nested resources: customize which `*_id` param is treated as the parent id.
+  # def parent_id_param
+  #   return nil unless use_parent_as_scope?
+  #
+  #   @parent_id_param ||= begin
+  #     keys = parent_id_param_keys
+  #     keys.map(&:to_s).grep(/(.+)_id$/).last
+  #   end
+  # end
+  #
+  # # Override when create and update need different permitted attributes.
+  # def create_params
+  #   resource_params
+  # end
+  #
+  # def update_params
+  #   resource_params
+  # end
+  #
+  # # Strong params API used by `resource_params`.
+  # def param_method
+  #   @param_method ||= ActionController::Parameters.method_defined?(:expect) ? :expect : :require
+  # end
+  #
+  # # def resource_params
+  # #   if param_method == :expect
+  # #     params.expect(<%= singular_table_name %>: permitted_params)
+  # #   else
+  # #     params.require(:<%= singular_table_name %>).permit(*permitted_params)
+  # #   end
+  # # end
+  #
+  # Required: return the attributes permitted for create/update.
+  def permitted_params
+    <%- if attributes_names.empty? -%>
+    []
+    <%- else -%>
+    [<%= permitted_params_list %>]
+    <%- end -%>
+  end
+end
+<% end -%>

data/lib/generators/crudable/templates/turbo_forms/_form.html.erb.tt

@@ -0,0 +1,37 @@
+<%%= form_with model: <%= form_with_model %> do |f| %>
+  <%% if f.object.errors.any? %>
+    <div style="color: red">
+      <h2><%%= pluralize(f.object.errors.count, "error") %> prohibited this <%= singular_table_name %> from being saved:</h2>
+
+      <ul>
+        <%% f.object.errors.each do |error| %>
+          <li><%%= error.full_message %></li>
+        <%% end %>
+      </ul>
+    </div>
+  <%% end %>
+
+<% form_attributes.each do |attribute| -%>
+  <div>
+<% if attribute.password_digest? -%>
+    <%%= f.label :password, style: "display: block" %>
+    <%%= f.password_field :password %>
+  </div>
+
+  <div>
+    <%%= f.label :password_confirmation, style: "display: block" %>
+    <%%= f.password_field :password_confirmation %>
+<% elsif attribute.attachments? -%>
+    <%%= f.label :<%= attribute.column_name %>, style: "display: block" %>
+    <%%= f.<%= attribute.field_type %> :<%= attribute.column_name %>, multiple: true %>
+<% else -%>
+    <%%= f.label :<%= attribute.column_name %>, style: "display: block" %>
+    <%%= f.<%= attribute.field_type %> :<%= attribute.column_name %> %>
+<% end -%>
+  </div>
+
+<% end -%>
+  <div>
+    <%%= f.submit %>
+  </div>
+<%% end %>

data/lib/generators/crudable/templates/turbo_forms/edit.html.erb.tt

@@ -0,0 +1,14 @@
+<%% content_for :title, "Editing <%= human_name.downcase %>" %>
+
+<h1>Editing <%= human_name.downcase %></h1>
+
+<%%= tag.div id: dom_id(@<%= singular_table_name %>, :form) do %>
+  <%%= render "form", <%= singular_table_name %>: @<%= singular_table_name %> %>
+<%% end %>
+
+<br>
+
+<div>
+  <%%= link_to "Show this <%= human_name.downcase %>", <%= model_resource_name(prefix: "@") %> %> |
+  <%%= link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper(type: :path) %> %>
+</div>

data/lib/generators/crudable/templates/turbo_forms/edit.turbo_stream.erb.tt

@@ -0,0 +1,3 @@
+<%%= turbo_stream.replace dom_id(@<%= singular_table_name %>, :form) do %>
+  <%%= render "form", <%= singular_table_name %>: @<%= singular_table_name %> %>
+<%% end %>

data/lib/generators/crudable/templates/turbo_forms/new.html.erb.tt

@@ -0,0 +1,13 @@
+<%% content_for :title, "New <%= human_name.downcase %>" %>
+
+<h1>New <%= human_name.downcase %></h1>
+
+<%%= tag.div id: dom_id(@<%= singular_table_name %>, :form) do %>
+  <%%= render "form", <%= singular_table_name %>: @<%= singular_table_name %> %>
+<%% end %>
+
+<br>
+
+<div>
+  <%%= link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper(type: :path) %> %>
+</div>

data/lib/generators/crudable/templates/turbo_forms/new.turbo_stream.erb.tt

@@ -0,0 +1,3 @@
+<%%= turbo_stream.replace dom_id(@<%= singular_table_name %>, :form) do %>
+  <%%= render "form", <%= singular_table_name %>: @<%= singular_table_name %> %>
+<%% end %>

data/lib/tasks/crudable_tasks.rake

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 
-# desc "Explaining what the task does"
-# task :crudable do
-#   # Task goes here
-# end
+namespace :crudable do
+  desc 'Install crudable-rails configuration'
+  task install: :environment do
+    updated = Crudable::Rails.postinstall
+
+    if updated.any?
+      puts "Set raise_on_missing_callback_actions to true in: #{updated.join(', ')}"
+    else
+      puts 'No environment files with raise_on_missing_callback_actions = false were found.'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crudable-rails
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Tomislav Simnett
@@ -15,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 9.0.0
@@ -25,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 9.0.0
@@ -102,15 +102,27 @@ files:
 - lib/crudable/rails/base.rb
 - lib/crudable/rails/controller.rb
 - lib/crudable/rails/engine.rb
+- lib/crudable/rails/generators/scaffold_controller_extension.rb
+- lib/crudable/rails/generators/scaffold_extension.rb
+- lib/crudable/rails/generators/turbo_forms_generator_option.rb
+- lib/crudable/rails/generators/turbo_forms_scaffold_extension.rb
+- lib/crudable/rails/installer.rb
 - lib/crudable/rails/nestable.rb
 - lib/crudable/rails/resourceable.rb
 - lib/crudable/rails/version.rb
+- lib/generators/crudable/controller/USAGE
+- lib/generators/crudable/controller/controller_generator.rb
+- lib/generators/crudable/controller_helpers.rb
+- lib/generators/crudable/install/USAGE
+- lib/generators/crudable/install/install_generator.rb
 - lib/generators/crudable/scaffold/USAGE
 - lib/generators/crudable/scaffold/scaffold_generator.rb
-- lib/generators/crudable/scaffold/templates/crudable_controller.rb.tt
-- lib/generators/scaffold_controller/USAGE
-- lib/generators/scaffold_controller/scaffold_controller_generator.rb
-- lib/generators/scaffold_controller/templates/crudable_controller.rb.tt
+- lib/generators/crudable/templates/crudable_controller.rb.tt
+- lib/generators/crudable/templates/turbo_forms/_form.html.erb.tt
+- lib/generators/crudable/templates/turbo_forms/edit.html.erb.tt
+- lib/generators/crudable/templates/turbo_forms/edit.turbo_stream.erb.tt
+- lib/generators/crudable/templates/turbo_forms/new.html.erb.tt
+- lib/generators/crudable/templates/turbo_forms/new.turbo_stream.erb.tt
 - lib/tasks/crudable_tasks.rake
 homepage: https://gitlab.com/initforthe/crudable-rails
 licenses:
@@ -124,14 +136,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.12
+rubygems_version: 4.0.10
 specification_version: 4
 summary: CRUD operations for Rails controllers
 test_files: []

data/lib/generators/crudable/scaffold/templates/crudable_controller.rb.tt

@@ -1,164 +0,0 @@
-<% module_namespacing do -%>
-class <%= controller_class_name %>Controller < ApplicationController
-  crudable
-
-  private
-
-  # ---------------------------------------------------------------------------
-  # Optional overrides (self-documenting hooks)
-  #
-  # `crudable` mixes in `Crudable::Rails::Base` (which includes `Nestable`),
-  # which provides the REST actions and calls these hooks. Uncomment and tailor
-  # any of the following as needed.
-  # ---------------------------------------------------------------------------
-  #
-  # # If this resource is singular (e.g. SettingsController), return true.
-  # def singleton?
-  #   false
-  # end
-  #
-  # # Which param key to use when finding a member resource (default :id).
-  # # Common examples: :slug, :uuid
-  # def finder_param
-  #   :id
-  # end
-  #
-  # # Enable FriendlyId finders/redirects (default false).
-  # def friendly_finders?
-  #   false
-  # end
-  #
-  # # Nested parent lookup: use FriendlyId for the parent (defaults to friendly_finders?).
-  # # This is only applied when FriendlyId is available and the parent model responds to `.friendly`.
-  # def parent_friendly_finders?
-  #   friendly_finders?
-  # end
-  #
-  # # Enable pagination (requires Kaminari) (default true when Kaminari is defined).
-  # def paginate_resource?
-  #   super
-  # end
-  #
-  # # Customize the scope used for index. This is the primary hook for filtering.
-  # # (HasScope is applied automatically if present.)
-  # def authorizable_scope
-  #   super
-  # end
-  #
-  # # Full scope used for index (after HasScope, Pundit, etc).
-  # def resource_scope
-  #   super
-  # end
-  #
-  # # Skip initializing a new instance in create (useful for custom create flows).
-  # def skip_initialize_create?
-  #   false
-  # end
-  #
-  # # Discard/soft-delete support (requires Discard). When true, destroy will
-  # # choose discard vs destroy based on record state and params.
-  # def discard?
-  #   false
-  # end
-  #
-  # # Control whether Pundit authorization should be performed.
-  # # Override this to customize authorization behavior (e.g., feature flags, user roles).
-  # # Default: returns true when Pundit is defined.
-  # def authorize_with_pundit?
-  #   super
-  # end
-  #
-  # # Authorization lifecycle hooks (called inside create/update).
-  # def before_authorize_create; end
-  # def after_authorize_create; end
-  # def before_authorize_update; end
-  # def after_authorize_update; end
-  #
-  # # Post-success hooks (side-effects, instrumentation, etc).
-  # def on_successful_create; end
-  # def on_successful_update; end
-  #
-  # # Failure setup hooks (e.g., rebuild form collections).
-  # def on_failed_create_setup; end
-  # def on_failed_update_setup; end
-  #
-  # # Customize success redirects/flash messages.
-  # def after_create_redirect_path
-  #   super
-  # end
-  #
-  # def after_create_notice
-  #   super
-  # end
-  #
-  # def after_update_redirect_path
-  #   super
-  # end
-  #
-  # def after_update_notice
-  #   super
-  # end
-  #
-  # def after_destroy_redirect_path
-  #   super
-  # end
-  #
-  # def after_failed_destroy_redirect_path
-  #   super
-  # end
-  #
-  # def after_destroy_notice
-  #   super
-  # end
-  #
-  # def after_failed_destroy_alert
-  #   super
-  # end
-  #
-  # # Customize rendering for failed creates/updates (Turbo/HTML).
-  # def on_failed_create_render
-  #   super
-  # end
-  #
-  # def on_failed_update_render
-  #   super
-  # end
-  #
-  # # Customize rendering for destroy outcomes.
-  # def on_successful_destroy_render
-  #   super
-  # end
-  #
-  # def on_failed_destroy_render
-  #   super
-  # end
-  #
-  # # Nested resources: parent scoping is automatic when a `*_id` param is present.
-  # # Override `use_parent_as_scope?` to disable parent scoping.
-  # def find_parent
-  #   super
-  # end
-  #
-  # def use_parent_as_scope?
-  #   true
-  # end
-  #
-  # # Nested resources: customize which `*_id` param is treated as the parent id.
-  # # Useful for multi-level nesting or non-standard param names.
-  # def parent_id_param
-  #   super
-  # end
-  #
-  # Strong params used by `create` (and by default `update` via `update_params`).
-  # Adjust the permitted attributes to match your model and nested params shape.
-  def create_params
-    <%- if attributes_names.empty? -%>
-    params.fetch(:<%= singular_table_name %>, {})
-    <%- else -%>
-    params.expect(<%= singular_table_name %>: [ <%= permitted_params %> ])
-    <%- end -%>
-  end
-  # By default, updates permit the same attributes as creates.
-  alias update_params create_params
-end
-<% end -%>

data/lib/generators/scaffold_controller/USAGE

@@ -1,13 +0,0 @@
-Description:
-    Extends the Rails scaffold controller generator with an option to generate a Crudable controller.
-
-Example:
-    bin/rails generate scaffold Thing
-
-    This will create:
-         It will invoke the rails scaffold controller with an optional Crudable controller (use `--crudable`).
-
-Notes:
-    Nested routing is automatically supported: if a parent `*_id` param is present and an association
-    exists between the parent and resource, collections and resources will be scoped through the parent.
-    Override `use_parent_as_scope?` in your controller to disable parent scoping.

data/lib/generators/scaffold_controller/scaffold_controller_generator.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-class ScaffoldControllerGenerator < Rails::Generators::NamedBase
-  include Rails::Generators::ResourceHelpers
-
-  source_root File.expand_path('templates', __dir__)
-
-  class_exclusive do
-    class_option :crudable, type: :boolean, desc: 'Generate with crudable controller'
-  end
-
-  argument :attributes, type: :array, default: [], banner: 'field:type field:type'
-
-  hook_for :scaffold_controller, in: :rails
-
-  def crudable
-    return unless options.crudable?
-
-    template 'crudable_controller.rb',
-             File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb"), force: true
-  end
-
-  private
-
-  def permitted_params
-    attachments, others = attributes_names.partition { |name| attachments?(name) }
-    params = others.map { |name| ":#{name}" }
-    params += attachments.map { |name| "#{name}: []" }
-    params.join(', ')
-  end
-
-  def attachments?(name)
-    attribute = attributes.find { |attr| attr.name == name }
-    attribute&.attachments?
-  end
-end