layered-resource-rails 0.1.0

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

@@ -0,0 +1,34 @@
+<% record_label = layered_record_label(@record) %>
+<% index_path = @_route_entry[:actions].include?(:index) ? layered_collection_path : nil %>
+
+<div class="l-ui-spread">
+  <div>
+    <% if layered_breadcrumbs.any? || index_path %>
+      <%= l_ui_breadcrumbs do %>
+        <% layered_breadcrumbs.each do |crumb| %>
+          <%= l_ui_breadcrumb_item crumb[:label], crumb[:path] %>
+        <% end %>
+        <% if index_path %>
+          <%= l_ui_breadcrumb_item @model.model_name.human.pluralize, index_path %>
+        <% end %>
+      <% end %>
+    <% end %>
+
+    <h1 class="l-ui-heading"><%= record_label %></h1>
+  </div>
+
+  <div class="l-ui-spread">
+    <% if resource_can?(:edit, @record) %>
+      <%= link_to "Edit",
+            layered_member_path(@record, action: :edit),
+            class: "l-ui-button l-ui-button--primary" %>
+    <% end %>
+    <% if resource_can?(:destroy, @record) %>
+      <%= button_to "Delete",
+            layered_member_path(@record),
+            method: :delete,
+            class: "l-ui-button l-ui-button--outline-danger",
+            data: { turbo_confirm: "Are you sure?" } %>
+    <% end %>
+  </div>
+</div>

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  layered:
+    resource:
+      flash:
+        created: "%{model} created"
+        updated: "%{model} updated"
+        deleted: "%{model} deleted"
+        not_deleted: "%{model} could not be deleted"
+        dependent_records: "%{model} could not be deleted because other records depend on it"

data/lib/generators/layered/resource/column/column_generator.rb

@@ -0,0 +1,63 @@
+require "rails/generators/base"
+
+module Layered
+  module Resource
+    module Generators
+      # Ejects a built-in column partial into the host app, or scaffolds a
+      # custom one. Lookup order at runtime is per-resource → host-wide →
+      # gem default, so ejected partials override the gem's built-ins.
+      #
+      #   rails g layered:resource:column badge              # → app/views/layered/resource/columns/_badge.html.erb
+      #   rails g layered:resource:column badge questions    # → app/views/layered/questions/columns/_badge.html.erb
+      #   rails g layered:resource:column priority_badge     # → scaffold a new type (host-wide)
+      class ColumnGenerator < ::Rails::Generators::Base
+        BUILT_INS = %w[text datetime badge boolean].freeze
+
+        argument :type, type: :string, banner: "type"
+        argument :resource, type: :string, default: nil, optional: true,
+                            banner: "[resource]"
+
+        source_root Layered::Resource::Engine.root.join("app/views/layered/resource/columns")
+
+        desc "Eject a built-in column partial, or scaffold a custom one."
+
+        def create_partial
+          if BUILT_INS.include?(type)
+            copy_file "_#{type}.html.erb", target_path
+          else
+            create_file target_path, scaffold_template
+          end
+        end
+
+        def show_next_steps
+          say ""
+          say "Edit #{target_path} to customise rendering."
+          say ""
+          say "Use it from a resource with:"
+          say "  columns [{ attribute: :something, as: :#{type} }]"
+          say ""
+        end
+
+        private
+
+        def target_path
+          dir = resource.present? ? "app/views/layered/#{resource}/columns" : "app/views/layered/resource/columns"
+          File.join(dir, "_#{type}.html.erb")
+        end
+
+        # Starter content for a new (non-built-in) column type. Locals
+        # contract matches the runtime: (record, value, options).
+        def scaffold_template
+          <<~ERB
+            <%# Column partial for as: :#{type}.
+                Locals:
+                  record  - the model instance
+                  value   - record.public_send(column_attribute)
+                  options - the column hash (read keys like :variants, :format) %>
+            <%= value %>
+          ERB
+        end
+      end
+    end
+  end
+end

data/lib/generators/layered/resource/controller/controller_generator.rb

@@ -0,0 +1,54 @@
+require "rails/generators/named_base"
+
+module Layered
+  module Resource
+    module Generators
+      # Creates a controller that inherits from
+      # Layered::Resource::ResourcesController so the user can override
+      # individual actions while keeping the rest of the gem's behaviour.
+      #
+      #   rails g layered:resource:controller articles
+      #
+      # Generates app/controllers/articles_controller.rb and prints the
+      # routes change needed to wire it up.
+      class ControllerGenerator < ::Rails::Generators::NamedBase
+        source_root File.expand_path("templates", __dir__)
+
+        desc "Generate a controller that inherits from Layered::Resource::ResourcesController."
+
+        def create_controller_file
+          path = File.join("app/controllers", class_path, "#{file_name}_controller.rb")
+          full_path = File.join(destination_root, path)
+          if File.exist?(full_path) && !options[:force]
+            raise Thor::Error,
+                  "#{path} already exists. The layered:resource:controller generator " \
+                  "scaffolds a fresh subclass and would overwrite your existing file. " \
+                  "Pass --force to overwrite, or delete/rename the existing file first."
+          end
+          template "controller.rb.tt", path
+        end
+
+        def show_routing_instructions
+          say ""
+          say "Point the route at the new controller:"
+          say ""
+          indent = "  "
+          class_path.each_with_index do |segment, depth|
+            say "#{indent * (depth + 1)}namespace :#{segment} do"
+          end
+          say "#{indent * (class_path.length + 1)}layered_resources :#{file_name}, controller: \"#{file_name}\""
+          class_path.length.downto(1) do |depth|
+            say "#{indent * depth}end"
+          end
+          say ""
+        end
+
+        private
+
+        def file_name
+          @_file_name ||= super.sub(/_?controller$/i, "")
+        end
+      end
+    end
+  end
+end

data/lib/generators/layered/resource/controller/templates/controller.rb.tt

@@ -0,0 +1,31 @@
+<% module_namespacing do -%>
+class <%= class_name %>Controller < Layered::Resource::ResourcesController
+  # Override any of the standard CRUD actions (#index, #show, #new,
+  # #create, #edit, #update, #destroy) and call `super` when you only
+  # want to tweak behaviour. Drop the inheritance and write a plain
+  # Rails controller if you outgrow the gem entirely.
+  #
+  # Custom member/collection actions declared in the matching
+  # `layered_resources` block dispatch here. @resource, @model,
+  # @columns, @fields, and the @resource_can_* flags are already set.
+  #
+  # Member actions also get @record auto-loaded from params[:id] via
+  # @resource.scope(self).find — add
+  # `skip_before_action :load_layered_member_record, only: [:foo]`
+  # to opt out. Collection actions never auto-load (no :id in the
+  # path), so do any lookups yourself.
+  #
+  # Example member action:
+  #
+  #   def publish
+  #     @record.update!(published_at: Time.current)
+  #     redirect_to layered_member_path(@record), notice: "Published"
+  #   end
+  #
+  # Path helpers available:
+  #   layered_collection_path           # index
+  #   layered_member_path(record)       # show/update/destroy
+  #   layered_routes.<name>_path(...)   # any registered route,
+  #                                     # parent params filled in
+end
+<% end -%>

data/lib/generators/layered/resource/install_agent_skill_generator.rb

@@ -0,0 +1,26 @@
+module Layered
+  module Resource
+    module Generators
+      class InstallAgentSkillGenerator < Rails::Generators::Base
+        desc "Copy the layered-resource-rails agent skill into the host application"
+
+        def self.source_root
+          Layered::Resource::Engine.root
+        end
+
+        def copy_skill
+          skill_source = File.join(self.class.source_root, ".claude/skills/layered-resource-rails")
+          skill_dest = ".claude/skills/layered-resource-rails"
+
+          directory skill_source, skill_dest
+        end
+
+        def show_instructions
+          say ""
+          say "Agent skill installed to .claude/skills/layered-resource-rails/", :green
+          say ""
+        end
+      end
+    end
+  end
+end

data/lib/generators/layered/resource/resource_generator.rb

@@ -0,0 +1,63 @@
+require "rails/generators/named_base"
+
+module Layered
+  module Resource
+    module Generators
+      # Generates an `app/layered_resources/<name>_resource.rb` file and
+      # appends a `layered_resources :name` route. Use
+      # `rails g layered:resource:scaffold` for the full one-shot that also
+      # creates the model and migration.
+      #
+      #   rails g layered:resource article title:string body:text
+      class ResourceGenerator < ::Rails::Generators::NamedBase
+        source_root File.expand_path("templates", __dir__)
+
+        argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
+        class_option :skip_route, type: :boolean, default: false,
+                                  desc: "Skip appending a layered_resources route"
+
+        desc "Generate an app/layered_resources/<name>_resource.rb file and a route."
+
+        def create_resource_file
+          template "resource.rb.tt",
+                   File.join("app/layered_resources", "#{singular_name}_resource.rb")
+        end
+
+        def add_route
+          return if options[:skip_route]
+
+          route "layered_resources :#{plural_name}"
+        end
+
+        private
+
+        def singular_name
+          file_name.singularize
+        end
+
+        def plural_name
+          file_name.pluralize
+        end
+
+        def resource_class_name
+          singular_name.camelize
+        end
+
+        def column_attributes
+          attributes.reject { |a| a.reference? || a.password_digest? }
+        end
+
+        def field_attributes
+          column_attributes
+        end
+
+        def field_as(attr)
+          case attr.type
+          when :text then ", as: :text"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/layered/resource/scaffold/scaffold_generator.rb

@@ -0,0 +1,94 @@
+require "rails/generators/named_base"
+require "generators/layered/resource/resource_generator"
+require "generators/layered/resource/views/views_generator"
+
+module Layered
+  module Resource
+    module Generators
+      # One-shot scaffolder: generates the migration + model (via Rails'
+      # built-in model generator), an `app/layered_resources/<name>_resource.rb`
+      # (via `layered:resource`), and appends a `layered_resources :name` route.
+      # Views are intentionally left to the gem's defaults - run
+      # `rails g layered:resource:views <name>` to eject them.
+      #
+      #   rails g layered:resource:scaffold article title:string body:text
+      class ScaffoldGenerator < ::Rails::Generators::NamedBase
+        argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
+        class_option :skip_model, type: :boolean, default: false,
+                                  desc: "Skip generating the migration and model (use when they already exist)"
+        class_option :actions, type: :array, default: nil, banner: "index show new create edit update destroy",
+                               desc: "Restrict the generated route to these actions (passed to layered_resources only:)"
+        class_option :except, type: :array, default: nil, banner: "destroy",
+                              desc: "Exclude these actions from the generated route (passed to layered_resources except:)"
+        class_option :controller, type: :boolean, default: false,
+                                  desc: "Also eject a controller (invokes layered:resource:controller) and wire it into the route"
+        class_option :views, type: :boolean, default: false,
+                             desc: "Also eject the view templates (invokes layered:resource:views)"
+
+        desc "Generate a model, migration, resource class, and route in one shot."
+
+        def create_model
+          return if options[:skip_model]
+
+          invoke "model", [singular_name, *attributes.map(&:to_s)]
+        end
+
+        def create_resource_file
+          invoke ResourceGenerator, [singular_name, *attributes.map(&:to_s)], skip_route: true
+        end
+
+        def eject_controller
+          invoke "layered:resource:controller", [plural_name] if options[:controller]
+        end
+
+        def eject_views
+          invoke ViewsGenerator, [plural_name] if options[:views]
+        end
+
+        def add_route
+          route "layered_resources :#{plural_name}#{route_controller_option}#{route_action_filter}"
+        end
+
+        def show_next_steps
+          say ""
+          say "Next steps for app/layered_resources/#{singular_name}_resource.rb:"
+          say "  - Add `validates` calls to #{resource_class_name} for any required fields - the form marks fields required based on unconditional presence validators."
+          say "  - Consider `default_sort attribute: :created_at, direction: :desc` (or another column) so the index has a stable order."
+          say "  - Consider `search_fields [...]` listing the columns the index search box should match against."
+          say ""
+        end
+
+        private
+
+        def route_controller_option
+          ", controller: \"#{plural_name}\"" if options[:controller]
+        end
+
+        def route_action_filter
+          if options[:actions].present?
+            ", only: #{action_list(options[:actions])}"
+          elsif options[:except].present?
+            ", except: #{action_list(options[:except])}"
+          end
+        end
+
+        def action_list(actions)
+          "[#{actions.map { |a| ":#{a}" }.join(', ')}]"
+        end
+
+        def singular_name
+          file_name.singularize
+        end
+
+        def plural_name
+          file_name.pluralize
+        end
+
+        def resource_class_name
+          singular_name.camelize
+        end
+      end
+    end
+  end
+end

data/lib/generators/layered/resource/templates/resource.rb.tt

@@ -0,0 +1,19 @@
+class <%= resource_class_name %>Resource < Layered::Resource::Base
+  model <%= resource_class_name %>
+<% if column_attributes.any? -%>
+
+  columns [
+<% column_attributes.each_with_index do |attr, i| -%>
+    { attribute: :<%= attr.name %><%= ", primary: true" if i.zero? %> }<%= "," unless i == column_attributes.length - 1 %>
+<% end -%>
+  ]
+<% end -%>
+<% if field_attributes.any? -%>
+
+  fields [
+<% field_attributes.each_with_index do |attr, i| -%>
+    { attribute: :<%= attr.name %><%= field_as(attr) %> }<%= "," unless i == field_attributes.length - 1 %>
+<% end -%>
+  ]
+<% end -%>
+end

data/lib/generators/layered/resource/views/views_generator.rb

@@ -0,0 +1,49 @@
+require "rails/generators/named_base"
+
+module Layered
+  module Resource
+    module Generators
+      # Copies the gem's view templates into the host app so they can be
+      # edited freely. The controller's view-resolution escape hatch picks
+      # them up automatically - no further wiring needed.
+      #
+      #   rails g layered:resource:views articles
+      #
+      # Generates app/views/layered/articles/{index,show,new,edit}.html.erb.
+      class ViewsGenerator < ::Rails::Generators::NamedBase
+        source_root Layered::Resource::Engine.root.join("app/views/layered/resource/resources")
+
+        desc "Copy the gem's view templates into app/views/layered/<name>/ for full customisation."
+
+        VIEWS = %w[index.html.erb show.html.erb new.html.erb edit.html.erb
+                   _filters.html.erb _filter_control.html.erb].freeze
+
+        def copy_views
+          VIEWS.each do |view|
+            copy_file view, File.join("app/views/layered", resource_directory, view)
+          end
+        end
+
+        def show_next_steps
+          say ""
+          say "Edit any of the templates in app/views/layered/#{resource_directory}/ - the gem will use them in place of its defaults."
+          say ""
+        end
+
+        private
+
+        # The controller's view-resolution escape hatch keys off the
+        # plural name passed to `layered_resources`, ignoring any Rails
+        # namespace. Mirror that here so generated files actually get
+        # picked up.
+        def resource_directory
+          file_name.pluralize
+        end
+
+        def file_name
+          @_file_name ||= super.singularize
+        end
+      end
+    end
+  end
+end