tramway 2.1.3.2 → 2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1499a2fac32ccc2bde7698f5a27e860b398241bac79ccaaa57e5c1daed7261e0
-  data.tar.gz: bbefbba5682e649affd877f94a83778bad6f0866002158b21f89bd0b9005ab17
+  metadata.gz: 31f2e19d40c2dcccde24e3060fd4a735d10a8fd41634f7b633c09dfefe37b06a
+  data.tar.gz: 403c3df3f7b9dcdc4e458dabd26d00c438817bbfd89821fa4807aa2622b36490
 SHA512:
-  metadata.gz: 93619c3b3adc9a585f95c710d073c33bbe6dfe36fb32e80e2acd47a7456439a5a5524b78145aaf440b6e263331fc62fe650267d6ce5cde212bcddaae8b06a18f
-  data.tar.gz: 62acddb7ccfdaad83c282c56f7b41968466250d6f7579ccbd7d4b5606e1ab286470e5e916d7dcb8c2ff673e7cb2894f9d0e7dfaa017075b1bb29e65aae7754be
+  metadata.gz: b1728c3e1eacff00ae976d376f6e7fa6d595cee42d7c5a7d2722bd9cd559f3d574a24ac83d53a825ab0008a357ce95bd8e8ceda1a461f7668f5d4ecfa0d10d95
+  data.tar.gz: 6ae4c7bda4c7c984683ebf8c44190bc1ec8177db68243f7d3401c4e0aa279451f860e01b69398b547b314587d0f994fbf110528fe9f4d9149431f5bf2f28cf66

data/README.md

@@ -1,6 +1,9 @@
 # Tramway
 Unite Ruby on Rails brilliance. Streamline development with Tramway.
 
+Tramway ships with full CRUD (index, show, create, update, destroy) out of the box, and it includes a great AGENTS.md guide
+that helps you generate good, Tramway-native code with all the framework features.
+
 [![RubyGems Version](https://img.shields.io/gem/v/tramway.svg)](https://rubygems.org/gems/tramway)
 [![Tests](https://github.com/Purple-Magic/tramway/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Purple-Magic/tramway/actions/workflows/test.yml)
 [![Lint](https://github.com/Purple-Magic/tramway/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/Purple-Magic/tramway/actions/workflows/lint.yml)
@@ -60,7 +63,13 @@ Tramway.configure do |config|
   config.entities = [
     {
       name: :user,
-      pages: [{ action: :index }],
+      pages: [
+        { action: :index },
+        { action: :show },
+        { action: :create },
+        { action: :update },
+        { action: :destroy }
+      ],
     }
   ]
 end
@@ -215,6 +224,63 @@ end
 With this configuration in place, visiting the show page displays a two-column table where the left column contains the
 localized attribute names and the right column renders their values.
 
+**create page**
+
+To render a create page for an entity, declare a `:create` action inside the `pages` array in
+`config/initializers/tramway.rb`. Tramway will generate the route and render the form fields based on your form object.
+
+```ruby
+Tramway.configure do |config|
+  config.entities = [
+    {
+      name: :campaign,
+      pages: [
+        { action: :index },
+        { action: :create }
+      ]
+    }
+  ]
+end
+```
+
+**update page**
+
+To render an update page, declare an `:update` action inside the `pages` array in `config/initializers/tramway.rb`.
+Tramway will generate the edit route and reuse the same form partial as create.
+
+```ruby
+Tramway.configure do |config|
+  config.entities = [
+    {
+      name: :campaign,
+      pages: [
+        { action: :index },
+        { action: :update }
+      ]
+    }
+  ]
+end
+```
+
+**destroy page**
+
+To render a destroy action, declare a `:destroy` action inside the `pages` array in `config/initializers/tramway.rb`.
+Tramway will generate the destroy route and render the delete action button.
+
+```ruby
+Tramway.configure do |config|
+  config.entities = [
+    {
+      name: :campaign,
+      pages: [
+        { action: :index },
+        { action: :destroy }
+      ]
+    }
+  ]
+end
+```
+
 **route_helper**
 
 To get routes Tramway generated just Tramway::Engine.

data/app/components/tailwinds/table/row_component.html.haml

@@ -8,8 +8,8 @@
   - cells = Nokogiri::HTML.fragment(content).xpath('./*[@class and contains(concat(" ", normalize-space(@class), " "), " div-table-cell ")]')
 
   - if href.present?
-    = tag.a href:, class: [desktop_row_classes(cells.count), link_row_classes].join(' '), **options do
+    = tag.a href:, class: [desktop_row_classes(cells.count), link_row_classes].join(' '), **default_attributes do
       = content
   - else
-    = tag.div class: desktop_row_classes(cells.count), **options do
+    = tag.div class: desktop_row_classes(cells.count), **default_attributes do
       = content

data/app/components/tailwinds/table/row_component.rb

@@ -8,9 +8,11 @@ module Tailwinds
       option :href, optional: true
       option :options, optional: true, default: -> { {} }
 
-      def row_tag(**options, &)
-        default_attributes = { role: :row }
+      def default_attributes
+        { role: :row }
+      end
 
+      def row_tag(**options, &)
         if href.present?
           link_to(href, options.merge(class: "#{options[:class] || ''} #{link_row_classes}", **default_attributes)) do
             yield if block_given?

data/app/components/tramway/actions_buttons_container_component.html.haml

@@ -0,0 +1,2 @@
+.flex.justify-end.mt-2.space-x-2
+  = content

data/app/components/tramway/actions_buttons_container_component.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Tramway
+  class ActionsButtonsContainerComponent < Tramway::BaseComponent
+  end
+end

data/app/components/tramway/entity_component.html.haml

@@ -1 +1,19 @@
-= tramway_row cells:, href:
+= tramway_row href: do
+  - cells.each do |(attribute, value)|
+    = tramway_cell do
+      = value
+  - if @entity.page(:update).present? || @entity.page(:destroy).present?
+    = tramway_cell do
+      = component 'tramway/actions_buttons_container' do
+        - if @entity.page(:update).present?
+          = tramway_button text: t('tramway.actions.edit'),
+            path: Tramway::Engine.routes.url_helpers.public_send(entity.routes.edit, item.id),
+            type: :will,
+            size: :small
+
+        - if @entity.page(:destroy).present?
+          = tramway_button text: t('tramway.actions.destroy'),
+            path: Tramway::Engine.routes.url_helpers.public_send(entity.routes.destroy, item.id),
+            type: :rage,
+            method: :delete,
+            size: :small

data/app/controllers/tramway/entities_controller.rb

@@ -35,6 +35,10 @@ module Tramway
       @record = tramway_form model_class.new, namespace: entity.namespace
     end
 
+    def edit
+      @record = tramway_form model_class.find(params[:id]), namespace: entity.namespace
+    end
+
     # rubocop:disable Metrics/AbcSize
     def create
       @record = tramway_form model_class.new, namespace: entity.namespace
@@ -45,8 +49,26 @@ module Tramway
         render :new
       end
     end
+
+    def update
+      @record = tramway_form model_class.find(params[:id]), namespace: entity.namespace
+
+      if @record.submit params[model_class.model_name.param_key]
+        redirect_to public_send(entity.show_helper_method, @record.id), notice: t('tramway.notices.updated')
+      else
+        render :edit
+      end
+    end
     # rubocop:enable Metrics/AbcSize
 
+    def destroy
+      @record = model_class.find(params[:id])
+
+      @record.destroy
+
+      redirect_to public_send(entity.index_helper_method), notice: t('tramway.notices.deleted')
+    end
+
     private
 
     def model_class
@@ -70,7 +92,8 @@ module Tramway
         {
           name: association,
           decorator: records.first.class,
-          records:
+          records:,
+          model_class: records.first.object.class
         }
       end.compact
     end

data/app/views/tramway/entities/_form.html.haml

@@ -1,4 +1,7 @@
-= tramway_form_for @record, local: true, url: public_send(@entity.create_helper_method), method: :post do |f|
+- url = @record.new_record? ? public_send(@entity.create_helper_method) : public_send(@entity.update_helper_method, @record.id)
+- method = @record.new_record? ? :post : :patch
+
+= tramway_form_for @record, local: true, url:, method: do |f|
   - if @record.errors.any?
     .alert.alert-danger
       %h4= "#{pluralize(@record.errors.count, 'error')} prohibited this record from being saved:"

data/app/views/tramway/entities/_list.html.haml

@@ -12,7 +12,7 @@
 
     - if Tramway.config.pagination[:enabled]
       = paginate @entities, custom_path_method:
-  .flex.justify-end.mt-2
+  = component 'tramway/actions_buttons_container' do
     - if @entity.page(:create).present?
       = tramway_button text: t('tramway.actions.new'),
         path: Tramway::Engine.routes.url_helpers.public_send(@entity.routes.new),
@@ -26,7 +26,7 @@
       = decorator
   - else
     = tramway_table class: 'mt-4' do
-      = tramway_header headers: index_attributes.map { |attribute| @model_class.human_attribute_name(attribute) }
+      = tramway_header headers: decorator.constantize.table_headers(entity: @entity)
       - @entities.each do |item|
         = component 'tramway/entity', entity: @entity, item: item
 

data/app/views/tramway/entities/edit.html.haml

@@ -0,0 +1,5 @@
+= tramway_container do
+  = tramway_title text: t('tramway.pages.edit.title', model_name: @record.object.model_name.human)
+
+  .mt-4
+    = render 'form'

data/app/views/tramway/entities/show.html.haml

@@ -3,6 +3,18 @@
     %h1.text-4xl.font-bold.mb-4
       = @record.title
 
+  = component 'tramway/actions_buttons_container' do
+    - if @entity.page(:update).present?
+      = tramway_button text: t('tramway.actions.edit'),
+        path: Tramway::Engine.routes.url_helpers.public_send(@entity.routes.edit, @record.id),
+        type: :will
+
+    - if @entity.page(:destroy).present?
+      = tramway_button text: t('tramway.actions.destroy'),
+        path: Tramway::Engine.routes.url_helpers.public_send(@entity.routes.destroy, @record.id),
+        type: :rage,
+        method: :delete
+
   .flex.justify-end.mt-2
     - if @record.show_header_content.present?
       = @record.show_header_content
@@ -31,8 +43,7 @@
           custom_path_arguments: [@record.id]
 
     = tramway_table class: 'mt-4' do 
-      -# FIXME: don't use first object for getting association decorator
-      = tramway_header headers: association[:records].first.table_headers
+      = tramway_header headers: association[:decorator].table_headers(model_class: association[:model_class])
 
       - association[:records].each do |record|
         = tramway_row do

data/config/locales/en.yml

@@ -3,5 +3,15 @@ en:
     pages:
       new:
         title: "Create %{model_name}"
+      edit:
+        title: "Edit %{model_name}"
+    actions:
+      new: "New"
+      edit: "Edit"
+      destroy: "Destroy"
+      save: "Save"
+      cancel: "Cancel"
     notices:
       created: "The record is created"
+      updated: "The record is updated"
+      deleted: "The record is deleted"

data/config/routes.rb

@@ -22,6 +22,10 @@ Tramway::Engine.routes.draw do
           acc << :show
         when 'create'
           acc + %i[create new]
+        when 'update'
+          acc + %i[edit update]
+        when 'destroy'
+          acc << :destroy
         else
           acc
         end
@@ -31,31 +35,6 @@ Tramway::Engine.routes.draw do
                 only: actions.map(&:to_sym),
                 controller: '/tramway/entities',
                 defaults: { entity: }
-
-      # entity.pages.each do |page|
-      #   case page.action
-      #   when 'index'
-      #     get resource_name.pluralize,
-      #       to: '/tramway/entities#index',
-      #       defaults: { entity: },
-      #       as: resource_name.pluralize
-
-      #   when 'show'
-      #     get "#{resource_name.pluralize}/:id",
-      #       to: '/tramway/entities#show',
-      #       defaults: { entity: },
-      #       as: resource_name.singularize
-
-      #   when 'create'
-      #     post resource_name.pluralize,
-      #       to: '/tramway/entities#create',
-      #       defaults: { entity: }
-
-      #     get "#{resource_name.pluralize}/new",
-      #       to: '/tramway/entities#new',
-      #       defaults: { entity: }
-      #   end
-      # end
     end
 
     if segments.empty?

data/docs/AGENTS.md

@@ -78,7 +78,7 @@ config/
 
 ## Rules
 
-- Use Tramway Entities and Tramway actions (index, show, create) by default unless custom behavior is needed. Configure in `config/initializers/tramway.rb`.
+- Use Tramway Entities and Tramway actions (index, show, create, update, destroy) by default unless custom behavior is needed. Configure in `config/initializers/tramway.rb`.
 - Normalize input with `normalizes` (from Tramway) for attributes like email, phone, etc.
 - Use Tramway Navbar for navigation
 - Use Tramway Flash for user notifications.

data/lib/tramway/base_decorator.rb

@@ -63,6 +63,16 @@ module Tramway
         nil
       end
 
+      def table_headers(entity: nil, model_class: nil)
+        headers = index_attributes.map do |attribute|
+          (model_class || entity.model_class).human_attribute_name(attribute)
+        end
+
+        headers += ['Actions'] if entity&.page(:update).present? || entity&.page(:destroy).present?
+
+        headers
+      end
+
       include Tramway::Decorators::AssociationClassMethods
     end
 
@@ -102,11 +112,5 @@ module Tramway
     def respond_to_missing?(method_name, include_private = false)
       method_name.to_s.end_with?('_path', '_url') || super
     end
-
-    def table_headers
-      self.class.index_attributes.map do |attribute|
-        object.class.human_attribute_name(attribute)
-      end
-    end
   end
 end

data/lib/tramway/base_form.rb

@@ -66,6 +66,7 @@ module Tramway
     end
 
     delegate :to_model, to: :object
+    delegate :new_record?, to: :object
 
     private
 

data/lib/tramway/configs/entity.rb

@@ -13,7 +13,7 @@ module Tramway
       attribute? :namespace, Types::Coercible::String
 
       # Route Struct contains implemented in Tramway CRUD and helpful routes for the entity
-      ACTIONS = %i[index show new create].freeze
+      ACTIONS = %i[index show new create edit update destroy].freeze
       RouteStruct = Struct.new(*ACTIONS)
 
       # HumanName Struct contains human names forms for the entity
@@ -55,12 +55,16 @@ module Tramway
         build_helper_method(name, route:, namespace:, plural: true)
       end
 
-      private
+      def edit_helper_method
+        build_helper_method(name, route:, namespace:, plural: false, action: :edit)
+      end
 
-      def pluralized(model_name)
-        local_plural = I18n.t("#{name}.many", scope: 'activerecord.plural.models', default: nil)
+      def update_helper_method
+        build_helper_method(name, route:, namespace:, plural: false)
+      end
 
-        local_plural.presence || model_name.pluralize
+      def destroy_helper_method
+        build_helper_method(name, route:, namespace:, plural: false)
       end
 
       def model_class
@@ -69,16 +73,23 @@ module Tramway
         nil
       end
 
+      private
+
+      def pluralized(model_name)
+        local_plural = I18n.t("#{name}.many", scope: 'activerecord.plural.models', default: nil)
+
+        local_plural.presence || model_name.pluralize
+      end
+
       def route_helper_methods
         ACTIONS.map do |action|
-          case action
-          when :index, :show
-            page(action).present?
-          when :new, :create
-            page(:create).present?
-          end => existing_condition
-
-          send("#{action}_helper_method") if existing_condition
+          cond = case action
+                 when :index, :show, :destroy   then page(action).present?
+                 when :new, :create             then page(:create).present?
+                 when :edit, :update            then page(:update).present?
+                 end
+
+          send("#{action}_helper_method") if cond
         end
       end
 

data/lib/tramway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tramway
-  VERSION = '2.1.3.2'
+  VERSION = '2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 2.1.3.2
+  version: '2.2'
 platform: ruby
 authors:
 - kalashnikovisme
@@ -213,6 +213,8 @@ files:
 - app/components/tailwinds/table_component.rb
 - app/components/tailwinds/title_component.html.haml
 - app/components/tailwinds/title_component.rb
+- app/components/tramway/actions_buttons_container_component.html.haml
+- app/components/tramway/actions_buttons_container_component.rb
 - app/components/tramway/base_component.rb
 - app/components/tramway/entity_component.html.haml
 - app/components/tramway/entity_component.rb
@@ -227,6 +229,7 @@ files:
 - app/views/kaminari/_prev_page.html.haml
 - app/views/tramway/entities/_form.html.haml
 - app/views/tramway/entities/_list.html.haml
+- app/views/tramway/entities/edit.html.haml
 - app/views/tramway/entities/index.html.haml
 - app/views/tramway/entities/new.html.haml
 - app/views/tramway/entities/show.html.haml