tramway 0.2.1.3 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2ed52c776d761d5afe99a7d31c99084191c032af8f35c13a49f1d3f6155d01f
-  data.tar.gz: e6cee0a18222ae4d3a99f63a8b8959bfaec6dab11107006040451254c14aa4b4
+  metadata.gz: eee7e8b57c93fd646e96a26e07e9dab81b6deee977c50c2ab34b1df93f48e96d
+  data.tar.gz: 48d411dcce7d057eb867862f2b8410b5320bbf2dfdc47f5a0e06508f34049139
 SHA512:
-  metadata.gz: 676f475214beb3bab65636d145bf797d48efadf0519294c2551b26caf58c47270238fce3f2a3bb72953a9a8d55708aa88fc4cda61deed86d60cd82f8cbc47bf8
-  data.tar.gz: 3f5847c31384d66b892ab8eddec5a730579cd0fcebbf85302316b8f98c00677b7ff3b2c778cdb22e39427c7a3f10baa73c74599c7237c06c9b6a2c24c68fec60
+  metadata.gz: dc78481a707c0688c774469549b8c1dc319adfe51f67cdd871b4b4751f03367206c674298c764a54110aa9c9b634082c6c844e1b97df0e9d2b2411fb536fa527
+  data.tar.gz: 2bdf9eca337acd11afacb0fca442e6047b1b600d5b6a499bad31ad7522777edf0c2079c247491334a32eb3bb8682d54c78e596256b120c14a6c4a62593592150

data/README.md

@@ -11,11 +11,43 @@ gem "view_component"
 
 ## Usage
 
+### Tramway Entities
+
+Tramway is an entity-based framework. **Entity** is the class on whose objects actions be applied: _index, show, create, update, and destroy_. Tramway will support numerous classes as entities. For now, Entity could be only **ActiveRecord::Base** class.
+
+#### Define entity for Tramway
+
+*config/initializers/tramway.rb*
+```ruby
+Tramway.configure do |config|
+  config.entities = [ :user, :podcast, :episode ] # entities based on models User, Podcast and Episode are defined
+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).
 
-### Decorators
+### Tramway Decorators
 
 Tramway provides convenient decorators for your objects. **NOTE:** This is not the decorator pattern in its usual representation.
 
@@ -65,8 +97,7 @@ def show
 end
 ```
 
-
-### Navbar
+### Tramway Navbar
 
 Tramway provides DSL for rendering Tailwind Navgiation bar.
 
@@ -97,6 +128,8 @@ background:
   intensity: Color intensity. Range: **100..950**. Used by Tailwind. Not supported in case of using HEX color in the background.color
 ```
 
+**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.
+
 #### nav.left and nav.right
 
 Tramway navbar provides `left` and `right` methods that puts items to left and right part of navbar.

data/lib/tramway/base_decorator.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require 'tramway/decorators/collection_decorator'
-require 'tramway/utils/decorators/render'
+require 'tramway/utils/render'
 
 module Tramway
   # Provides decorate function for Tramway projects
   #
   class BaseDecorator
     include Tramway::Decorators::CollectionDecorators
-    include Tramway::Utils::Decorators::Render
+    include Tramway::Utils::Render
 
     attr_reader :object
 

data/lib/tramway/config.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'tramway/configs/entity'
+
+module Tramway
+  # Basic configuration of Tramway
+  #
+  class Config
+    include Singleton
+
+    def initialize
+      @entities = []
+    end
+
+    def entities=(collection)
+      @entities = collection.map do |entity|
+        entity_options = entity.is_a?(Hash) ? entity : { name: entity }
+
+        Tramway::Configs::Entity.new(**entity_options)
+      end
+    end
+
+    attr_reader :entities
+  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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'tramway/configs/entities/route'
+
+module Tramway
+  module Configs
+    # Tramway is an entity-based framework
+    class Entity < Dry::Struct
+      attribute :name, Types::Coercible::String
+      attribute? :route, Tramway::Configs::Entities::Route
+
+      def routes
+        OpenStruct.new index: Rails.application.routes.url_helpers.public_send(route_helper_method)
+      end
+
+      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
+
+      def model_class
+        name.camelize.constantize
+      rescue StandardError
+        nil
+      end
+
+      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
+end

data/lib/tramway/helpers/navbar_helper.rb

@@ -7,13 +7,11 @@ module Tramway
     # Providing navbar helpers for ActionView
     module NavbarHelper
       def tramway_navbar(**options)
-        if block_given?
-          initialize_navbar
+        initialize_navbar
 
-          yield @navbar
+        yield @navbar if block_given?
 
-          assign_navbar_items(options)
-        end
+        assign_navbar_items(options)
 
         render_navbar_component(options)
       end
@@ -21,7 +19,7 @@ module Tramway
       private
 
       def initialize_navbar
-        @navbar = Tramway::Navbar.new(self)
+        @navbar = Tramway::Navbar.new self
       end
 
       def assign_navbar_items(options)

data/lib/tramway/navbar.rb

@@ -3,18 +3,23 @@
 module Tramway
   # Navbar object provides left and right elements
   class Navbar
-    attr_reader :items
+    attr_reader :items, :context
 
     def initialize(context)
-      @items = {}
       @context = context
+      @items = { left: [], right: [] }
       @filling = nil
+
+      entities = Tramway.config.entities
+
+      return unless entities.any?
+
+      preset_left entities
     end
 
     def left
       return unless block_given?
 
-      @items[:left] = []
       filling_side(:left)
       yield self
       reset_filling
@@ -23,7 +28,6 @@ module Tramway
     def right
       return unless block_given?
 
-      @items[:right] = []
       filling_side(:right)
       yield self
       reset_filling
@@ -43,6 +47,16 @@ module Tramway
 
     private
 
+    def preset_left(entities)
+      filling_side :left
+
+      entities.each do |entity|
+        item entity.human_name.plural, entity.routes.index
+      end
+
+      reset_filling
+    end
+
     def provided_url_and_block?(url)
       url.present? && block_given?
     end
@@ -57,12 +71,14 @@ module Tramway
 
     def render_ignoring_block(text_or_url, url, options)
       options.merge!(href: url)
-      @context.render(Tailwinds::Nav::ItemComponent.new(**options)) { text_or_url }
+
+      context.render(Tailwinds::Nav::ItemComponent.new(**options)) { text_or_url }
     end
 
     def render_using_block(text_or_url, options, &block)
       options.merge!(href: text_or_url)
-      @context.render(Tailwinds::Nav::ItemComponent.new(**options), &block)
+
+      context.render(Tailwinds::Nav::ItemComponent.new(**options), &block)
     end
   end
 end

data/lib/tramway/utils/render.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Utils
+    # Provides helper method render that depends on ActionController::Base.render method
+    #
+    module Render
+      def render(*args, &)
+        ActionController::Base.render(*args, &)
+      end
+    end
+  end
+end

data/lib/tramway/version.rb

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

data/lib/tramway.rb

@@ -1,11 +1,22 @@
 # frozen_string_literal: true
 
+require 'types'
 require 'tramway/version'
 require 'tramway/engine'
 require 'tramway/base_decorator'
+require 'tramway/config'
 require 'view_component/compiler'
 require 'view_component/engine'
 
 # Core module for the whole gem
 module Tramway
+  module_function
+
+  def configure(&)
+    yield config
+  end
+
+  def config
+    Tramway::Config.instance
+  end
 end

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.1.3
+  version: 0.2.3
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-22 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
@@ -88,14 +102,18 @@ files:
 - lib/tasks/tramway_tasks.rake
 - 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
 - lib/tramway/engine.rb
 - lib/tramway/helpers/decorate_helper.rb
 - lib/tramway/helpers/navbar_helper.rb
 - lib/tramway/navbar.rb
-- lib/tramway/utils/decorators/render.rb
+- lib/tramway/utils/render.rb
 - lib/tramway/version.rb
+- lib/types.rb
 homepage: https://github.com/purple-magic/tramway
 licenses:
 - MIT

data/lib/tramway/utils/decorators/render.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Tramway
-  module Utils
-    module Decorators
-      # Provides helper method render that depends on ActionController::Base.render method
-      #
-      module Render
-        def render(*args)
-          ActionController::Base.render(*args, layout: false)
-        end
-      end
-    end
-  end
-end