tramway 0.5.3 → 0.5.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c116b7002a5f382a5b2d54704e425d6a7e2e1a5208cb2eb1f0cd060bf5852718
-  data.tar.gz: 6a183fa879258d651afcd2479265854139dcc8e5da69f9684a331f859274de64
+  metadata.gz: 0b3a940800b0be153a5c1eb7655a1f4203ac977accf41579e43221766843c0e8
+  data.tar.gz: ead462e416c64538748b393652233a4fb755f6c874dcf2d618e027ff4cfa77dc
 SHA512:
-  metadata.gz: 7765e1c762c50ba2cb543ef79f155f6649cd5c5ac0ee38aa530f9472f0a7024ca489473ac0cf597a30a8fa2c99ce2ed8fde0d62fa34198a7903e3c90e8edfc92
-  data.tar.gz: d136698275286b8188609c2883756a9e338ca6c6faf118166f1374f443ae68ac7ed99849811703f6bf2f70e71d5aaadaec1433d4bec41e70568e27fea015edf1
+  metadata.gz: 835993aedeccd2cd7873c3cb12416d5c7c90f45d0cb234926e544a251e6bbc7a889a4a68db36f9adec55b360d246f146701a37307875ad7729f2f029f0e829fe
+  data.tar.gz: b78685a91ce1adbb6da37659972a5206b891cccde030a3fb18ee8ba559f49bc73144b5db0636fedc22ed2f9466cab67e74afe0192f0c162283f1009e85ed4886

data/README.md

@@ -8,6 +8,7 @@ Unite Ruby on Rails brilliance. Streamline development with Tramway.
   * [Tramway Decorators](https://github.com/Purple-Magic/tramway#tramway-decorators)
   * [Tramway Form](https://github.com/Purple-Magic/tramway#tramway-form)
   * [Tramway Navbar](https://github.com/Purple-Magic/tramway#tramway-navbar)
+  * [Tramway Table Component](https://github.com/Purple-Magic/tramway#tramway-table-component)
   * [Tailwind-styled forms](https://github.com/Purple-Magic/tramway#tailwind-styled-forms)
     * [Stimulus-based inputs](https://github.com/Purple-Magic/tramway#stimulus-based-inputs)
   * [Tailwind-styled pagination](https://github.com/Purple-Magic/tramway?tab=readme-ov-file#tailwind-styled-pagination-for-kaminari)
@@ -39,7 +40,7 @@ Tramway.configure do |config|
   config.entities = [
     {
       name: :user,
-      pages: [:index],
+      pages: [{ action: :index }],
     }
   ]
 end
@@ -194,6 +195,8 @@ end
 
 #### Decorate associations
 
+**Decorate single association**
+
 ```ruby
 class UserDecorator < Tramway::BaseDecorator
   association :posts
@@ -203,6 +206,14 @@ user = tramway_decorate User.first
 user.posts # => decorated collection of posts with PostDecorator
 ```
 
+**Decorate multiple associations**
+
+```ruby
+class UserDecorator < Tramway::BaseDecorator
+  associations :posts, :users
+end
+```
+
 #### Decorate nil
 
 Tramway Decorator does not decorate nil objects
@@ -454,10 +465,22 @@ title_link: Link on Tramway Navbar title. Default: '/'
 background:
   color: Css-color. Supports all named CSS colors and HEX colors
   intensity: Color intensity. Range: **100..950**. Used by Tailwind. Not supported in case of using HEX color in the background.color
+with_entities: Show Tramway Entities index page links to navbar. Default: true
 ```
 
 **NOTE:** `tramway_navbar` method called without arguments and block of code will render only [Tramway Entities](https://github.com/Purple-Magic/tramway#tramway-entities) links on the left.
 
+In case you want to hide entity links you can pass `with_entities: false`.
+
+```haml
+- if current_user.present?
+  = tramway_navbar title: 'WaiWai' do |nav|
+    - nav.left do
+      - nav.item 'Board', admin_board_path
+- else
+  = tramway_navbar title: 'WaiWai', with_entities: false
+```
+
 #### nav.left and nav.right
 
 Tramway navbar provides `left` and `right` methods that puts items to left and right part of navbar.
@@ -491,6 +514,20 @@ tramway_navbar title: 'Purple Magic' do |nav|
 end
 ```
 
+### Tramway Table Component
+
+Tramway provides a responsive, tailwind-styled table with light and dark themes.
+
+```haml
+= component 'tailwinds/table' do
+  = component 'tailwinds/table/header', headers: ['Column 1', 'Column 2']
+  = component 'tailwinds/table/row' do
+    = component 'tailwinds/table/cell' do
+      Something
+    = component 'tailwinds/table/cell' do
+      Another
+```
+
 ### Tailwind-styled forms
 
 Tramway uses [Tailwind](https://tailwindcss.com/) by default. All UI helpers are implemented with [ViewComponent](https://github.com/viewcomponent/view_component).

data/app/components/tailwinds/form/select_component.html.haml

@@ -2,4 +2,4 @@
   - if @label
     = component('tailwinds/form/label', for: @for) do
       = @label
-  = @input.call(@attribute, @collection, { selected: @value }, @options.merge(class: 'bg-white border border-gray-300 text-gray-700 rounded focus:outline-none focus:ring-2 focus:ring-blue-500 focus:border-transparent py-2 px-3'))
+  = @input.call(@attribute, @collection, { selected: @value }, @options.merge(class: 'bg-white border border-gray-300 text-gray-700 rounded focus:outline-none focus:ring-2 focus:ring-blue-500 focus:border-transparent py-2 px-3 disabled:bg-gray-100 disabled:text-gray-400 disabled:cursor-not-allowed'))

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

@@ -1,4 +1,4 @@
-.div-table-row.block.grid.text-white.text-small.gap-4.bg-purple-700.dark:bg-gray-700.dark:text-gray-400{ class: "grid-cols-#{headers.count}" }
+.div-table-row.grid.text-white.text-small.gap-4.bg-purple-700.dark:bg-gray-700.dark:text-gray-400{ class: "grid-cols-#{headers.count}", aria: { label: "Table Header" }, role: "row" }
   - if headers.any?
     - headers.each do |header|
       .div-table-cell.py-4.px-6

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

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

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

@@ -1,4 +1,5 @@
 = helpers.component 'tailwinds/table/row/preview'
 
-.div-table.w-full.text-left.rtl:text-right.text-gray-500.dark:text-gray-400.mt-4{ **options }
+- width_class = options[:class]&.include?('w-') ? '' : 'w-full'
+.div-table.text-left.rtl:text-right.text-gray-500.dark:text-gray-400.mt-4{ class: "#{options[:class]} #{width_class}", **options.except(:class) }
   = content

data/app/controllers/tramway/entities_controller.rb

@@ -11,7 +11,13 @@ module Tramway
     include Rails.application.routes.url_helpers
 
     def index
-      @entities = model_class.order(id: :desc).page(params[:page])
+      @entities = if entity.page(:index).scope.present?
+                    model_class.public_send(entity.page(:index).scope)
+                  else
+                    model_class.order(id: :desc)
+                  end.page(params[:page])
+
+      @namespace = entity.route&.namespace
     end
 
     private
@@ -19,5 +25,9 @@ module Tramway
     def model_class
       @model_class ||= params[:entity][:name].classify.constantize
     end
+
+    def entity
+      @entity ||= Tramway.config.entities.find { |e| e.name == params[:entity][:name] }
+    end
   end
 end

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

@@ -1,3 +1,3 @@
-- decorator = decorator_class(entity)
-- decorated_object = decorator.decorate(entity)
-= component 'tailwinds/table/row', cells: decorator.list_attributes.reduce({}) { |hash, attribute| hash.merge! attribute => decorated_object.public_send(attribute) }, href: decorated_object.show_path
+- 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

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

@@ -1,4 +1,4 @@
-- decorator = Tramway::Decorators::NameBuilder.default_decorator_class_name(@model_class)
+- decorator = Tramway::Decorators::ClassHelper.decorator_class_name(@model_class, @namespace)
 - list_attributes = decorator.constantize.list_attributes
 
 .mt-8.w-full

data/config/routes.rb

@@ -2,29 +2,30 @@
 
 Tramway::Engine.routes.draw do
   Tramway.config.entities.each do |entity|
-    define_resource = lambda do |resource_name, entity| # rubocop:disable Lint/ShadowingOuterLocalVariable
+    segments      = entity.name.split('/')
+    resource_name = segments.pop          
+
+    define_resource = proc do
       resources resource_name.pluralize.to_sym,
-                only: [:index],
-                controller: '/tramway/entities',
-                defaults: { entity: }
+                only:      [:index],
+                controller:'/tramway/entities',
+                defaults:   { entity: entity }
     end
 
-    if entity.name.include?('/')
-      *namespaces, resource_name = entity.name.split('/')
-
-      define_namespace = lambda do |index|
-        namespace namespaces[index].to_sym do
-          if namespaces[index] == namespaces.last
-            define_resource.call(resource_name, entity)
+    if segments.empty?
+      define_resource.call
+    else
+      nest = lambda do |names|
+        namespace names.first.to_sym do
+          if names.size > 1
+            nest.call(names.drop(1))
           else
-            define_namespace.call(namespaces[index + 1])
+            define_resource.call
           end
         end
       end
 
-      define_namespace.call(0)
-    else
-      define_resource.call(entity.name, entity)
+      nest.call(segments)
     end
   end
 end

data/config/tailwind.config.js

@@ -50,6 +50,9 @@ module.exports = {
     'space-x-1',
     'justify-end',
     'mt-2',
+    'disabled:bg-gray-100',
+    'disabled:text-gray-400',
+    'disabled:cursor-not-allowed',
     // pagination
     'bg-white', 'rounded-md', 'hover:bg-purple-100', 'dark:text-white', 'dark:bg-gray-800', 'dark:hover:bg-gray-700',
     // multiselect styles

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Configs
+    module Entities
+      # Route struct describes rules for route management
+      #
+      class Page < Dry::Struct
+        attribute :action, Types::Coercible::String
+        attribute? :scope, Types::Coercible::String
+      end
+    end
+  end
+end

data/lib/tramway/configs/entity.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
 require 'tramway/configs/entities/route'
+require 'tramway/configs/entities/page'
 
 module Tramway
   module Configs
     # Tramway is an entity-based framework
     class Entity < Dry::Struct
       attribute :name, Types::Coercible::String
-      attribute? :pages, Types::Array.of(Types::Symbol).default([].freeze)
+      attribute? :pages, Types::Array.of(Tramway::Configs::Entities::Page).default([].freeze)
       attribute? :route, Tramway::Configs::Entities::Route
 
       # Route Struct contains implemented in Tramway CRUD and helpful routes for the entity
       RouteStruct = Struct.new(:index)
 
-      # HumanNameStruct contains human names forms for the entity
+      # HumanName Struct contains human names forms for the entity
       HumanNameStruct = Struct.new(:single, :plural)
 
       def routes
@@ -31,6 +32,10 @@ module Tramway
         HumanNameStruct.new(single, plural)
       end
 
+      def page(name)
+        pages.find { |page| page.action == name.to_s }
+      end
+
       private
 
       def pluralized(model_name)
@@ -48,7 +53,7 @@ module Tramway
       def route_helper_method
         underscored_name = name.parameterize.pluralize.underscore
 
-        method_name = if pages.include?(:index) || route.blank?
+        method_name = if set_page?(:index) || route.blank?
                         "#{underscored_name}_path"
                       else
                         route.helper_method_by(underscored_name)
@@ -58,8 +63,10 @@ module Tramway
       end
 
       def route_helper_engine
-        pages.include?(:index) ? Tramway::Engine : Rails.application
+        set_page?(:index) ? Tramway::Engine : Rails.application
       end
+
+      alias set_page? page
     end
   end
 end

data/lib/tramway/decorators/association.rb

@@ -22,14 +22,14 @@ module Tramway
       end
 
       # has_and_belongs_to_many is not supported for now
-      def association(association)
+      def association(association, decorator: nil)
         define_method(association) do
           assoc = object.send(association)
 
           if assoc.is_a?(ActiveRecord::Relation)
-            AssocDecoratorHelper.decorate_has_many_association assoc
+            AssocDecoratorHelper.decorate_has_many_association assoc, decorator_class: decorator
           elsif assoc.present?
-            AssocDecoratorHelper.decorate_associated_object(assoc)
+            AssocDecoratorHelper.decorate_associated_object(assoc, decorator_class: decorator)
           end
         end
       end
@@ -38,12 +38,18 @@ module Tramway
     # Helper module for association decorators
     module AssocDecoratorHelper
       class << self
-        def decorate_has_many_association(assoc)
-          assoc.empty? ? [] : decorator(assoc.klass).decorate(assoc)
+        def decorate_has_many_association(assoc, decorator_class: nil)
+          return [] if assoc.empty?
+          
+          decorator_class ||= decorator(assoc.klass)
+
+          decorator_class.decorate(assoc)
         end
 
-        def decorate_associated_object(assoc)
-          decorator(assoc.class).decorate(assoc)
+        def decorate_associated_object(assoc, decorator_class: nil)
+          decorator_class ||= decorator(assoc.class)
+
+          decorator_class.decorate(assoc)
         end
 
         def decorator(class_name)

data/lib/tramway/decorators/class_helper.rb

@@ -6,27 +6,37 @@ module Tramway
     module ClassHelper
       module_function
 
-      def decorator_class(object_or_array, decorator = nil)
+      def decorator_class(object_or_array, decorator = nil, namespace = nil)
         raise_error_if_object_empty object_or_array, decorator
 
         return decorator if decorator.present?
 
         begin
-          class_name = decorator_class_name(object_or_array)
+          class_name = decorator_class_name(object_or_array, namespace)
           class_name.constantize
         rescue NameError
           raise NameError, "You should define #{class_name} decorator class."
         end
       end
 
-      def decorator_class_name(object_or_array)
-        klass = if Tramway::Decorators::CollectionDecorators.collection?(object_or_array)
-                  object_or_array.first.class
+      def decorator_class_name(object_or_array_or_class, namespace)
+        klass = if Tramway::Decorators::CollectionDecorators.collection?(object_or_array_or_class)
+                  object_or_array_or_class.first.class
+                elsif object_or_array_or_class.is_a?(Class)
+                  object_or_array_or_class
                 else
-                  object_or_array.class
+                  object_or_array_or_class.class
                 end
 
-        Tramway::Decorators::NameBuilder.default_decorator_class_name(klass)
+        base_class_name = Tramway::Decorators::NameBuilder.default_decorator_class_name(klass)
+
+        klass_name = namespace.present? ? "#{namespace.to_s.camelize}::#{base_class_name}" : base_class_name
+
+        if klass_name.safe_constantize
+          klass_name
+        else
+          raise NameError, "You should define #{klass_name} decorator class in app/decorators/ folder."
+        end
       end
 
       # :reek:NilCheck { enabled: false }

data/lib/tramway/forms/properties.rb

@@ -9,7 +9,23 @@ module Tramway
         def property(attribute)
           @properties << attribute
 
-          delegate attribute, to: :object
+          define_method(attribute) do
+            if object.respond_to?(attribute)
+              object.public_send(attribute)
+            else
+              raise NoMethodError, "#{self.class}##{attribute} is not defined"
+            end
+          end
+
+          set_method = "#{attribute}="
+
+          define_method(set_method) do |value|
+            if object.respond_to?(set_method)
+              object.public_send(set_method, value)
+            else
+              raise NoMethodError, "#{self.class}##{set_method} is not defined"
+            end
+          end
         end
 
         def properties(*attributes)

data/lib/tramway/helpers/decorate_helper.rb

@@ -8,12 +8,12 @@ module Tramway
     #
     module DecorateHelper
       # :reek:NilCheck { enabled: false } because checking for nil is not a type-checking issue but business logic
-      def tramway_decorate(object_or_array, decorator: nil)
+      def tramway_decorate(object_or_array, decorator: nil, namespace: nil)
         return [] if Tramway::Decorators::CollectionDecorators.collection?(object_or_array) && object_or_array.empty?
 
         return if object_or_array.nil?
 
-        Tramway::Decorators::ClassHelper.decorator_class(object_or_array, decorator).decorate object_or_array
+        Tramway::Decorators::ClassHelper.decorator_class(object_or_array, decorator, namespace).decorate object_or_array
       end
     end
   end

data/lib/tramway/helpers/navbar_helper.rb

@@ -6,8 +6,8 @@ module Tramway
   module Helpers
     # Provides navbar helpers for ActionView
     module NavbarHelper
-      def tramway_navbar(**options)
-        initialize_navbar
+      def tramway_navbar(with_entities: true, **options)
+        initialize_navbar(with_entities:)
 
         yield @navbar if block_given?
 
@@ -18,8 +18,8 @@ module Tramway
 
       private
 
-      def initialize_navbar
-        @navbar = Tramway::Navbar.new self
+      def initialize_navbar(with_entities:)
+        @navbar = Tramway::Navbar.new self, with_entities:
       end
 
       def assign_navbar_items(options)

data/lib/tramway/navbar.rb

@@ -5,16 +5,18 @@ module Tramway
   class Navbar
     attr_reader :items, :context
 
-    def initialize(context)
+    def initialize(context, with_entities:)
       @context = context
       @items = { left: [], right: [] }
       @filling = nil
 
-      entities = Tramway.config.entities
+      if with_entities
+        entities = Tramway.config.entities
 
-      return unless entities.any?
+        return unless entities.any?
 
-      preset_left entities
+        preset_left entities
+      end
     end
 
     def left

data/lib/tramway/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4.1
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-19 00:00:00.000000000 Z
+date: 2025-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -219,6 +219,7 @@ files:
 - lib/tramway/base_decorator.rb
 - lib/tramway/base_form.rb
 - lib/tramway/config.rb
+- lib/tramway/configs/entities/page.rb
 - lib/tramway/configs/entities/route.rb
 - lib/tramway/configs/entity.rb
 - lib/tramway/decorators/association.rb