tramway 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12b9bb73f91f5c694ee64efaa36d66a5ee68c6b41066a5e775b42e4ba81678d4
-  data.tar.gz: 79c240ff539d4762fb8a2c4b3fe29ff05805c2699e12225d53038fafb53c5a1d
+  metadata.gz: eee7e8b57c93fd646e96a26e07e9dab81b6deee977c50c2ab34b1df93f48e96d
+  data.tar.gz: 48d411dcce7d057eb867862f2b8410b5320bbf2dfdc47f5a0e06508f34049139
 SHA512:
-  metadata.gz: 5ccd8cdeb8bb8b9df08d4885ff473e68ef7a29f5980460050e52db4d7b7b758da170cabece248f78589dbc102d47f1ae4c3ee1410d50d8103cbb4ffc549d0a2e
-  data.tar.gz: 58c752011aa51d3c0afd9e074380411657a390b0a09568226de9d4c38b033d1b9b23f172b27af2a3ae137bc342185fad3736085412025d66cac4dab68e4ff994
+  metadata.gz: dc78481a707c0688c774469549b8c1dc319adfe51f67cdd871b4b4751f03367206c674298c764a54110aa9c9b634082c6c844e1b97df0e9d2b2411fb536fa527
+  data.tar.gz: 2bdf9eca337acd11afacb0fca442e6047b1b600d5b6a499bad31ad7522777edf0c2079c247491334a32eb3bb8682d54c78e596256b120c14a6c4a62593592150

data/README.md

@@ -26,6 +26,23 @@ end
 
 By default, links to the Tramway Entities index page are rendered in [Tramway Navbar](https://github.com/Purple-Magic/tramway#tramway-navbar).
 
+#### Define entities with options
+
+Tramway Entity supports several options that are used in different features.
+
+**route**
+
+*config/initializers/tramway.rb*
+```ruby
+Tramway.configure do |config|
+  config.entities = [
+    { name: :user, route: { namespace: :admin } },                                 # `admin_users_path` link in the Tramway Navbar
+    { name: :podcast, route: { route_method: :shows } },                           # `shows_path` link in the Tramway Navbar
+    { name: :episodes, route: { namespace: :podcasts, route_method: :episodes } }, # `podcasts_episodes_path` link in the Tramway Navbar
+  ]
+end
+```
+
 ### Tailwind components
 
 Tramway uses [Tailwind](https://tailwindcss.com/) by default. All UI helpers are implemented with [ViewComponent](https://github.com/viewcomponent/view_component).

data/lib/tramway/config.rb

@@ -15,7 +15,9 @@ module Tramway
 
     def entities=(collection)
       @entities = collection.map do |entity|
-        Tramway::Configs::Entity.new(name: entity)
+        entity_options = entity.is_a?(Hash) ? entity : { name: entity }
+
+        Tramway::Configs::Entity.new(**entity_options)
       end
     end
 

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Configs
+    module Entities
+      # 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"
+        end
+      end
+    end
+  end
+end

data/lib/tramway/configs/entity.rb

@@ -1,24 +1,44 @@
 # frozen_string_literal: true
 
+require 'tramway/configs/entities/route'
+
 module Tramway
   module Configs
-    # Tramway is entity based framework
-    #
-    class Entity
-      attr_reader :name
+    # Tramway is an entity-based framework
+    class Entity < Dry::Struct
+      attribute :name, Types::Coercible::String
+      attribute? :route, Tramway::Configs::Entities::Route
 
-      def initialize(name:)
-        @name = name.to_s
+      def routes
+        OpenStruct.new index: Rails.application.routes.url_helpers.public_send(route_helper_method)
       end
 
-      def routes
-        underscored_name = name.parameterize.pluralize.underscore
+      def human_name
+        options = if model_class.present?
+                    model_name = model_class.model_name.human
+                    { single: model_name, plural: model_name.pluralize }
+                  else
+                    { single: name.capitalize, plural: name.pluralize.capitalize }
+                  end
+        OpenStruct.new(**options)
+      end
+
+      private
 
-        OpenStruct.new index: Rails.application.routes.url_helpers.public_send("#{underscored_name}_path")
+      def model_class
+        name.camelize.constantize
+      rescue StandardError
+        nil
       end
 
-      def human_name
-        OpenStruct.new single: name.capitalize, plural: name.pluralize.capitalize
+      def route_helper_method
+        underscored_name = name.parameterize.pluralize.underscore
+
+        if route.present?
+          route.helper_method_by(underscored_name)
+        else
+          "#{underscored_name}_path"
+        end
       end
     end
   end

data/lib/tramway/navbar.rb

@@ -51,8 +51,6 @@ module Tramway
       filling_side :left
 
       entities.each do |entity|
-        entity.to_s.pluralize
-
         item entity.human_name.plural, entity.routes.index
       end
 

data/lib/tramway/version.rb

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

data/lib/tramway.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'types'
 require 'tramway/version'
 require 'tramway/engine'
 require 'tramway/base_decorator'

data/lib/types.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+
+# We need because of this https://dry-rb.org/gems/dry-struct/1.6/recipes/
+module Types
+  include Dry.Types()
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-26 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml-rails
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +103,7 @@ files:
 - lib/tramway.rb
 - lib/tramway/base_decorator.rb
 - lib/tramway/config.rb
+- lib/tramway/configs/entities/route.rb
 - lib/tramway/configs/entity.rb
 - lib/tramway/decorators/class_helper.rb
 - lib/tramway/decorators/collection_decorator.rb
@@ -98,6 +113,7 @@ files:
 - lib/tramway/navbar.rb
 - lib/tramway/utils/render.rb
 - lib/tramway/version.rb
+- lib/types.rb
 homepage: https://github.com/purple-magic/tramway
 licenses:
 - MIT