tramway 0.6.1.4 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec528ac8b5a4e453d42fabc91d5c2f1582306f35f967778e08ec2bcd81ce3baf
-  data.tar.gz: d23709dc4ac56fdded982a018907944cbdd414ea4d4a1fab650ea9db24154a8b
+  metadata.gz: df69b76e870abe067b6088b43e5a9731fcad1f07083aeb4c7c58d903421096f3
+  data.tar.gz: 480513c2fe10f2c6caa3a1cdcc42b532f897b03d2df20862f4384e2a68c1c9f3
 SHA512:
-  metadata.gz: 6833594b499a896b3e7c0e2f8a1c5dfc3e5c3410fd2da2f20fc736dcd59f5ffc86198030ae7c1e779cc93af4617e660781b26c6b50f2f8be2499b0220b83c08e
-  data.tar.gz: cacc7d5d5575a686cc7fb084becd1756841428cbafd4974d024dd8246be643109bbd599dc114b98c242c14413f8daa4a2f7b560fab273f305b855811307e1ffa
+  metadata.gz: 7b7625417d873f2e99317a03bb70c99869c2416aa35161d53fb82375e199d3916303b8fb702dc0ab697b46d7fdc5c7df2e5447195080daf8f3ba6566dbe2b486
+  data.tar.gz: 49a048f27dde057100b4e6be9b9073e6c65dc299e45ab8fbf1b41e929380ab186589fabf29695765b5586e755830437ad58f7f961f4d2ced52e354b8583a401d

data/README.md

@@ -18,11 +18,13 @@ Unite Ruby on Rails brilliance. Streamline development with Tramway.
 
 Tramway is actively verified against the following Ruby and Rails versions.
 
-| Ruby \ Rails | 7.1 | 7.2 | 8.0 | 8.1 |
-| ------------- | --- | --- | --- | --- |
-| 3.2           | ✅  | ✅  | ✅  | ✅  |
-| 3.3           | ✅  | ✅  | ✅  | ✅  |
-| 3.4           | ✅  | ✅  | ✅  | ✅  |
+| Ruby \ Rails | 7.1* | 7.2 | 8.0 | 8.1 |
+| ------------- | ---- | --- | --- | --- |
+| 3.2           | ✅   | ✅  | ✅  | ✅  |
+| 3.3           | ✅   | ✅  | ✅  | ✅  |
+| 3.4           | ✅   | ✅  | ✅  | ✅  |
+
+\* Rails 7.1 receives only residual support because it no longer receives updates from the Rails core team. See the [announcement](https://rubyonrails.org/2025/10/29/new-rails-releases-and-end-of-support-announcement) for details.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -71,7 +73,7 @@ end
 
 ```ruby
 class UserDecorator < Tramway::BaseDecorator
-  def self.list_attributes
+  def self.index_attributes
     [:id, :email, :created_at]
   end
 end
@@ -174,6 +176,37 @@ end
 In this example, the `Campaign` entity will display only records returned by the `active` scope on its index page, while all
 other pages continue to show every record unless another scope is specified.
 
+**show page**
+
+To render a show page for an entity, declare a `:show` action inside the `pages` array in
+`config/initializers/tramway.rb`. Tramway will generate the route and render a table using the attributes returned by the
+decorator's `self.show_attributes` method.
+
+```ruby
+Tramway.configure do |config|
+  config.entities = [
+    {
+      name: :campaign,
+      pages: [
+        { action: :index },
+        { action: :show }
+      ]
+    }
+  ]
+end
+```
+
+```ruby
+class CampaignDecorator < Tramway::BaseDecorator
+  def self.show_attributes
+    %i[name status starts_at]
+  end
+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.
+
 **route_helper**
 
 To get routes Tramway generated just Tramway::Engine.

data/app/components/tailwind_component.rb

@@ -3,7 +3,7 @@
 require 'view_component'
 
 # Base TailwindComponent. Contains base features for all tailwind components
-class TailwindComponent < Tramway::Component::Base
+class TailwindComponent < Tramway::BaseComponent
   option :input
   option :attribute
   option :value, optional: true

data/app/components/tailwinds/base_component.rb

@@ -2,6 +2,6 @@
 
 module Tailwinds
   # Shared base component for Tailwinds components
-  class BaseComponent < Tramway::Component::Base
+  class BaseComponent < Tramway::BaseComponent
   end
 end

data/app/components/tailwinds/containers/narrow_component.rb

@@ -3,7 +3,7 @@
 module Tailwinds
   module Containers
     # Default page container in Tramway
-    class NarrowComponent < Tramway::Component::Base
+    class NarrowComponent < Tramway::BaseComponent
       option :id, optional: true, default: proc { SecureRandom.uuid }
     end
   end

data/app/components/tailwinds/form/label_component.rb

@@ -3,7 +3,7 @@
 module Tailwinds
   module Form
     # Form label for all tailwind-styled forms
-    class LabelComponent < Tramway::Component::Base
+    class LabelComponent < Tramway::BaseComponent
       option :for
     end
   end

data/app/components/tailwinds/navbar_component.html.haml

@@ -7,7 +7,7 @@
             .text-xl.text-white.font-bold.dark:text-white
               = @title[:text]
         - if @left_items.present?
-          %ul.block.flex.flex-row.items-center.space-x-4.ml-4
+          %ul.flex-row.items-center.space-x-4.ml-4.hidden.md:flex
             - @left_items.each do |item|
               = item
 
@@ -16,7 +16,7 @@
         ☰
 
   - if @right_items.present?
-    %ul.block.sm:flex.items-center.space-x-4
+    %ul.items-center.space-x-4.hidden.md:flex
       - @right_items.each do |item|
         = item
 

data/app/components/tailwinds/pagination/base.rb

@@ -3,7 +3,7 @@
 module Tailwinds
   module Pagination
     # Base component for rendering a Kaminari pagination
-    class Base < Tramway::Component::Base
+    class Base < Tramway::BaseComponent
       option :current_page
       option :url
       option :remote

data/app/components/tailwinds/pagination/gap_component.rb

@@ -3,7 +3,7 @@
 module Tailwinds
   module Pagination
     # Kaminari gap component for rendering a gap in a pagination
-    class GapComponent < Tramway::Component::Base
+    class GapComponent < Tramway::BaseComponent
     end
   end
 end

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

@@ -3,7 +3,7 @@
 module Tailwinds
   module Table
     # Component for rendering a cell in a table
-    class CellComponent < Tramway::Component::Base
+    class CellComponent < Tramway::BaseComponent
     end
   end
 end

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

@@ -3,7 +3,7 @@
 module Tailwinds
   module Table
     # Component for rendering a header in a table
-    class HeaderComponent < Tramway::Component::Base
+    class HeaderComponent < Tramway::BaseComponent
       option :headers, optional: true, default: -> { [] }
       option :columns, optional: true, default: -> { 3 }
 

data/app/components/tailwinds/table/row/preview_component.rb

@@ -4,7 +4,7 @@ module Tailwinds
   module Table
     module Row
       # Row component for rendering a row in a table
-      class PreviewComponent < Tramway::Component::Base
+      class PreviewComponent < Tramway::BaseComponent
       end
     end
   end

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

@@ -1,7 +1,7 @@
 - if cells.any?
   = row_tag class: desktop_row_classes(cells.count), **options do
     - cells.each do |(_, value)|
-      .div-table-cell.px-6.py-4.font-medium.text-gray-900.whitespace-nowrap.dark:text-white.text-xs.sm:text-base
+      .div-table-cell.px-6.py-4.font-medium.text-gray-900.dark:text-white.text-xs.sm:text-base
         = value
 
 - else

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

@@ -3,7 +3,7 @@
 module Tailwinds
   module Table
     # Component for rendering a row in a table
-    class RowComponent < Tramway::Component::Base
+    class RowComponent < Tramway::BaseComponent
       option :cells, optional: true, default: -> { [] }
       option :href, optional: true
       option :options, optional: true, default: -> { {} }

data/app/components/tailwinds/table_component.rb

@@ -2,7 +2,7 @@
 
 module Tailwinds
   # Table component for rendering a table
-  class TableComponent < Tramway::Component::Base
+  class TableComponent < Tramway::BaseComponent
     option :options, optional: true, default: -> { {} }
   end
 end

data/app/components/tramway/base_component.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'tramway/helpers/component_helper'
+require 'tramway/helpers/decorate_helper'
+require 'tramway/helpers/views_helper'
+
+module Tramway
+  # You can use this class as a base for all your components
+  class BaseComponent < ViewComponent::Base
+    extend Dry::Initializer[undefined: false]
+    include Tramway::Helpers::ComponentHelper
+    include Tramway::Helpers::DecorateHelper
+    include Tramway::Helpers::ViewsHelper
+  end
+end

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

@@ -0,0 +1 @@
+= tramway_row cells:, href:

data/app/components/tramway/entity_component.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Tramway
+  # Component for displaying an entity row in a list
+  #
+  class EntityComponent < Tramway::BaseComponent
+    option :item
+    option :entity
+
+    def decorated_item
+      tramway_decorate item, namespace: entity.namespace
+    end
+
+    def href
+      if entity.pages.find { _1.action == 'show' }.present?
+        Tramway::Engine.routes.url_helpers.public_send entity.routes.show, decorated_item.id
+      else
+        decorated_item.show_path
+      end
+    end
+
+    def cells
+      decorated_item.class.index_attributes.reduce({}) do |hash, attribute|
+        hash.merge! attribute => decorated_item.public_send(attribute)
+      end
+    end
+  end
+end

data/app/controllers/tramway/entities_controller.rb

@@ -22,6 +22,10 @@ module Tramway
       @namespace = entity.route&.namespace
     end
 
+    def show
+      @entity = tramway_decorate model_class.find(params[:id]), namespace: entity.route&.namespace
+    end
+
     private
 
     def model_class

data/app/helpers/tramway/application_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'tramway/helpers/component_helper'
+require 'tramway/helpers/views_helper'
 require 'kaminari/helpers/tag'
 
 module Tramway
@@ -8,6 +9,7 @@ module Tramway
   module ApplicationHelper
     include Tramway::Decorators::ClassHelper
     include Tramway::Helpers::ComponentHelper
+    include Tramway::Helpers::ViewsHelper
 
     def page_title
       @model_class.model_name.human.pluralize # rubocop:disable Rails/HelperInstanceVariable

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

@@ -1,5 +1,5 @@
 - decorator = Tramway::Decorators::ClassHelper.decorator_class_name(@model_class, @namespace)
-- list_attributes = decorator.constantize.list_attributes
+- index_attributes = decorator.constantize.index_attributes
 
 .mt-8.w-full
   - content_for :title, page_title
@@ -13,15 +13,15 @@
   .flex.justify-end.mt-2
     = decorator.constantize.index_header_content.call(@entities) if decorator.constantize.index_header_content.present?
 
-  - if list_attributes.empty?
+  - if index_attributes.empty?
     %p.text-center.mt-10
-      You should fill class-level method `self.list_attributes` inside your
+      You should fill class-level method `self.index_attributes` inside your
       = decorator
   - else
-    = component 'tailwinds/table' do
-      = component 'tailwinds/table/header', headers: list_attributes.map { |attribute| @model_class.human_attribute_name(attribute) }
+    = tramway_table do
+      = tramway_header headers: index_attributes.map { |attribute| @model_class.human_attribute_name(attribute) }
       - @entities.each do |item|
-        = render 'tramway/entities/entity', entity: item
+        = component 'tramway/entity', entity: @entity, item: item
 
       - if Tramway.config.pagination[:enabled]
         .flex.mt-4

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

@@ -0,0 +1,15 @@
+= tramway_container do
+  %h1.text-2xl.font-bold.mb-4
+    = @entity.title
+
+  - if @entity.show_attributes.empty?
+    %p.text-center.mt-10
+      You should fill object-level method `show_attributes` inside your
+      = @entity.class.name
+  = tramway_table do
+    - @entity.show_attributes.each do |attribute|
+      = tramway_row do
+        = tramway_cell do
+          = @model_class.human_attribute_name(attribute)
+        = tramway_cell do
+          = @entity.public_send(attribute)

data/config/routes.rb

@@ -7,7 +7,7 @@ Tramway::Engine.routes.draw do
 
     define_resource = proc do
       resources resource_name.pluralize.to_sym,
-                only: [:index],
+                only: entity.pages.map(&:action),
                 controller: '/tramway/entities',
                 defaults: { entity: entity }
     end

data/config/tailwind.config.js

@@ -2,6 +2,8 @@ module.exports = {
   safelist: [
     // === Navbar ===
     'ml-4',
+    'text-white',
+    'md:flex',
     
     // === Custom table layout utilities ===
     'div-table',

data/lib/tramway/base_decorator.rb

@@ -48,7 +48,7 @@ module Tramway
         end
       end
 
-      def list_attributes
+      def index_attributes
         []
       end
 
@@ -67,6 +67,10 @@ module Tramway
 
     def show_path = nil
 
+    def show_attributes
+      []
+    end
+
     # :reek:ManualDispatch { enabled: false } because there is the idea to manual dispatch
     def method_missing(method_name, *, &)
       url_helpers = Rails.application.routes.url_helpers

data/lib/tramway/configs/entities/route.rb

@@ -6,11 +6,10 @@ module Tramway
       # Route struct describes rules for route management
       #
       class Route < Dry::Struct
-        attribute? :namespace, Types::Coercible::String
         attribute? :route_method, Types::Coercible::String
 
         def helper_method_by(underscored_name)
-          "#{[namespace, route_method || underscored_name].compact.join('_')}_path"
+          "#{route_method || underscored_name}_path"
         end
       end
     end

data/lib/tramway/configs/entity.rb

@@ -10,24 +10,26 @@ module Tramway
       attribute :name, Types::Coercible::String
       attribute? :pages, Types::Array.of(Tramway::Configs::Entities::Page).default([].freeze)
       attribute? :route, Tramway::Configs::Entities::Route
+      attribute? :namespace, Types::Coercible::String
 
       # Route Struct contains implemented in Tramway CRUD and helpful routes for the entity
-      RouteStruct = Struct.new(:index)
+      RouteStruct = Struct.new(:index, :show)
 
       # HumanName Struct contains human names forms for the entity
       HumanNameStruct = Struct.new(:single, :plural)
 
       def routes
-        RouteStruct.new(route_helper_method)
+        RouteStruct.new(*route_helper_methods)
       end
 
       def human_name
-        single, plural = if model_class.present?
-                           model_name = model_class.model_name.human
-                           [model_name, pluralized(model_name)]
-                         else
-                           [name.capitalize, name.pluralize.capitalize]
-                         end
+        if model_class.present?
+          model_name = model_class.model_name.human
+
+          [model_name, pluralized(model_name)]
+        else
+          [name.capitalize, name.pluralize.capitalize]
+        end => single, plural
 
         HumanNameStruct.new(single, plural)
       end
@@ -50,16 +52,29 @@ module Tramway
         nil
       end
 
-      def route_helper_method
-        underscored_name = name.parameterize.pluralize.underscore
+      def route_helper_methods
+        %i[index show].map do |action|
+          page(action).present? ? send("#{action}_helper_method") : nil
+        end.compact
+      end
+
+      def build_helper_method(base_name, route: nil, namespace: nil, plural: false)
+        if plural
+          base_name.to_s.parameterize.underscore.pluralize
+        else
+          base_name.to_s.parameterize.underscore
+        end => underscored
 
-        method_name = if set_page?(:index) || route.blank?
-                        "#{underscored_name}_path"
-                      else
-                        route.helper_method_by(underscored_name)
-                      end
+        method_name = route.present? ? route.helper_method_by(underscored) : "#{underscored}_path"
+        namespace.present? ? "#{namespace}_#{method_name}" : method_name
+      end
+
+      def show_helper_method
+        build_helper_method(name, route:, namespace:, plural: false)
+      end
 
-        route_helper_engine.routes.url_helpers.public_send(method_name)
+      def index_helper_method
+        build_helper_method(name, route:, namespace:, plural: true)
       end
 
       def route_helper_engine

data/lib/tramway/helpers/navbar_helper.rb

@@ -25,12 +25,12 @@ module Tramway
       def assign_navbar_items(options)
         navbar_items = @navbar.items
         navbar_items.each do |(key, value)|
-          key_to_merge = case key
-                         when :left, :right
-                           :"#{key}_items"
-                         else
-                           key
-                         end
+          case key
+          when :left, :right
+            :"#{key}_items"
+          else
+            key
+          end => key_to_merge
 
           options.merge! key_to_merge => value
         end

data/lib/tramway/navbar.rb

@@ -38,11 +38,11 @@ module Tramway
     def item(text_or_url, url = nil, **, &)
       raise 'You cannot provide an argument and a code block at the same time' if provided_url_and_block?(url, &)
 
-      rendered_item = if url.present?
-                        render_ignoring_block(text_or_url, url, **)
-                      else
-                        render_using_block(text_or_url, **, &)
-                      end
+      if url.present?
+        render_ignoring_block(text_or_url, url, **)
+      else
+        render_using_block(text_or_url, **, &)
+      end => rendered_item
 
       @items[@filling] << rendered_item
     end
@@ -53,7 +53,9 @@ module Tramway
       filling_side :left
 
       entities.each do |entity|
-        item entity.human_name.plural, entity.routes.index
+        next if entity.routes.index.blank?
+
+        item entity.human_name.plural, Tramway::Engine.routes.url_helpers.public_send(entity.routes.index)
       end
 
       reset_filling

data/lib/tramway/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.6.1.4
+  version: '1.0'
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-29 00:00:00.000000000 Z
+date: 2025-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -205,7 +205,9 @@ files:
 - app/components/tailwinds/table/row_component.rb
 - app/components/tailwinds/table_component.html.haml
 - app/components/tailwinds/table_component.rb
-- app/components/tramway/component/base.rb
+- app/components/tramway/base_component.rb
+- app/components/tramway/entity_component.html.haml
+- app/components/tramway/entity_component.rb
 - app/controllers/tramway/entities_controller.rb
 - app/helpers/tramway/application_helper.rb
 - app/views/kaminari/_first_page.html.haml
@@ -215,9 +217,9 @@ files:
 - app/views/kaminari/_page.html.haml
 - app/views/kaminari/_paginator.html.haml
 - app/views/kaminari/_prev_page.html.haml
-- app/views/tramway/entities/_entity.html.haml
 - app/views/tramway/entities/_list.html.haml
 - app/views/tramway/entities/index.html.haml
+- app/views/tramway/entities/show.html.haml
 - app/views/tramway/layouts/application.html.haml
 - config/routes.rb
 - config/tailwind.config.js

data/app/components/tramway/component/base.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'tramway/helpers/component_helper'
-
-module Tramway
-  module Component
-    # You can use this class as a base for all your components
-    class Base < ViewComponent::Base
-      extend Dry::Initializer[undefined: false]
-      include Tramway::Helpers::ComponentHelper
-    end
-  end
-end

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

@@ -1,3 +0,0 @@
-- decorator = decorator_class_name(entity, @namespace)
-- decorated_object = decorator.constantize.decorate(entity)
-= component 'tailwinds/table/row', cells: decorator.constantize.list_attributes.reduce({}) { |hash, attribute| hash.merge! attribute => decorated_object.public_send(attribute) }, href: decorated_object.show_path