tramway 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5d6641dda4dedcf7e4d1a4e0638690e21b5f72fbfdccca6c40fa423eec9e3f8
-  data.tar.gz: c0e4e0955c58b253c5aac6198302b6c11f3393f42d5edfd4fc317dd7b1a7894b
+  metadata.gz: c88b945e6fe61b58431c5598687538fb9514ec49333e11bfdb4b4027ff755e94
+  data.tar.gz: dde0abe3237e06f5aa5119e8cd28162643301fb534e949082cb930eca4a2b5dc
 SHA512:
-  metadata.gz: f2b1fd87395239845d1eeb4e901e44063e1487bdd83f226a247746dc1bc4fc555cfba4c8357345486dd31e5f5e8c0b5be59e2831e599a87d9c10632b221ad64e
-  data.tar.gz: eb6e88f325e65e1c49094a197a58419c11c71a5c24f78a5132167798ea4bff644c0a6d98320b073d16cea1b8baa258fa2300583474e95223e0f4ba09e9152327
+  metadata.gz: 7c27968e67c7c6da3047aadb5be9e39c52eb8049d558777674c8633e34cea10f996e0bf7d3dc04d2744fdd509f9e5019d321a730c2292c55336a2a5e32575b14
+  data.tar.gz: a5eab082d14d3c3158745135fdeedc5bf65789b59b6996523c0584e03522ceeeba63529b25b3549ab368123b6712257865e7098dd7641ec87cbb28358089f0ab

data/README.md

@@ -13,7 +13,58 @@ gem "view_component"
 
 ### Tailwind components
 
-Tramway use [Tailwind](https://tailwindcss.com/) by default. All UI helpers implemented with [ViewComponent](https://github.com/viewcomponent/view_component).
+Tramway uses [Tailwind](https://tailwindcss.com/) by default. All UI helpers are implemented with [ViewComponent](https://github.com/viewcomponent/view_component).
+
+### Decorators
+
+Tramway provides convenient decorators for your objects. **NOTE:** This is not the decorator pattern in its usual representation.
+
+*app/controllers/users_controller.rb*
+```ruby
+def index
+  # this line of code decorates the users collection with the default UserDecorator
+  @users = tramway_decorate User.all 
+end
+```
+
+*app/decorators/user_decorator.rb*
+```ruby
+class UserDecorator < Tramway::BaseDecorator
+  # delegates attributes to decorated object
+  delegate_attributes :email, :first_name, :last_name
+
+  # you can provide your own methods with access to decorated object attributes with the method `object`
+  def created_at
+    I18n.l object.created_at
+  end
+
+  # you can provide representations with ViewComponent to avoid implementing views with Rails Helpers
+  def posts_table
+    render TableComponent.new(object.posts)
+  end
+end
+```
+
+#### Decorate single object
+
+You can use the same method to decorate a single object either
+
+```ruby
+def show
+  @user = tramway_decorate User.find params[:id]
+end
+```
+
+#### Decorate with a specific decorator
+
+You can implement a specific decorator and ask Tramway to decorate with it
+
+```ruby
+def show
+  @user = tramway_decorate User.find(params[:id]), decorator: Users::ShowDecorator
+end
+```
+
 
 ### Navbar
 

data/app/components/tailwind_component.rb

@@ -2,5 +2,6 @@
 
 require 'view_component'
 
+# Base TailwindComponent. Contains base features for all tailwind components
 class TailwindComponent < ViewComponent::Base
 end

data/app/components/tailwinds/nav/item_component.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rules/turbo_html_attributes_rules'
+
 module Tailwinds
   module Nav
     # Render button styled with Tailwind using button_to or link_to methods
@@ -8,20 +10,7 @@ module Tailwinds
       def initialize(**options)
         @href = options[:href]
         @style = 'text-white hover:bg-red-300 px-4 py-2 rounded'
-        @options = prepare(options:)
-      end
-
-      private
-
-      def prepare(options:)
-        options.reduce({}) do |hash, (key, value)|
-          case key
-          when :method, :confirm
-            hash.deep_merge data: { "turbo_#{key}".to_sym => value }
-          else
-            hash.merge key => value
-          end
-        end
+        @options = Rules::TurboHtmlAttributesRules.prepare_turbo_html_attributes(options:)
       end
     end
   end

data/app/components/tailwinds/navbar_component.rb

@@ -1,26 +1,19 @@
 # frozen_string_literal: true
 
 module Tailwinds
-  # Navbar class main class
+  # Background helper module
   #
-  class NavbarComponent < TailwindComponent
-    def initialize(**options)
-      @title = options[:title]
-      @left_items = options[:left_items]
-      @right_items = options[:right_items]
-      @color = background(options)
-    end
-
-    private
-
+  module BackgroundHelper
     CSS_COLORS = %i[aqua black blue fuchsia gray green lime maroon navy olive orange purple red
                     silver teal white yellow].freeze
     MIN_INTENSITY = 100
     MAX_INTENSITY = 950
+    DEFAULT_BACKGROUND_COLOR = :purple
+    DEFAULT_BACKGROUND_INTENSITY = 700
 
-    def background(options)
-      color = options.dig(:background, :color) || :purple
-      intensity = options.dig(:background, :intensity) || 700
+    def self.background(options)
+      color = options.dig(:background, :color) || DEFAULT_BACKGROUND_COLOR
+      intensity = options.dig(:background, :intensity) || DEFAULT_BACKGROUND_INTENSITY
 
       unless (MIN_INTENSITY..MAX_INTENSITY).cover?(intensity)
         raise "Navigation Background Color intensity should be between #{MIN_INTENSITY} and #{MAX_INTENSITY}"
@@ -33,4 +26,17 @@ module Tailwinds
       end
     end
   end
+
+  # Navbar class main class
+  #
+  class NavbarComponent < TailwindComponent
+    include Tailwinds::BackgroundHelper
+
+    def initialize(**options)
+      @title = options[:title]
+      @left_items = options[:left_items]
+      @right_items = options[:right_items]
+      @color = BackgroundHelper.background(options)
+    end
+  end
 end

data/lib/rules/turbo_html_attributes_rules.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Rules
+  # Provides rules for turbo html attributes
+  # It allows users to :method and :confirm attributes instead of data-turbo_method and data-turbo_confirm
+  module TurboHtmlAttributesRules
+    def self.prepare_turbo_html_attributes(options:)
+      options.reduce({}) do |hash, (key, value)|
+        case key
+        when :method, :confirm
+          hash.deep_merge data: { "turbo_#{key}".to_sym => value }
+        else
+          hash.merge key => value
+        end
+      end
+    end
+  end
+end

data/lib/tramway/base_decorator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'tramway/decorators/collection_decorator'
+
+module Tramway
+  # Provides decorate function for Tramway projects
+  #
+  class BaseDecorator
+    include Tramway::Decorators::CollectionDecorators
+
+    attr_reader :object, :context
+
+    def initialize(object, context)
+      @object = object
+      @context = context
+    end
+
+    def render(*args)
+      context.render(*args, layout: false)
+    end
+
+    class << self
+      def decorate(object_or_array, context)
+        if Tramway::Decorators::CollectionDecorators.collection?(object_or_array)
+          Tramway::Decorators::CollectionDecorators.decorate_collection(collection: object_or_array, context:)
+        else
+          new(object_or_array, context)
+        end
+      end
+
+      def delegate_attributes(*args)
+        args.each do |attribute|
+          delegate attribute, to: :object
+        end
+      end
+    end
+
+    delegate_attributes :id
+
+    def to_partial_path
+      underscored_class_name = object.class.name.underscore
+
+      "#{underscored_class_name.pluralize}/#{underscored_class_name}"
+    end
+
+    def to_param
+      id.to_s
+    end
+  end
+end

data/lib/tramway/decorators/class_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Decorators
+    # Provides method to determine decorators classes
+    module ClassHelper
+      module_function
+
+      def decorator_class(object_or_array, decorator)
+        if decorator.present?
+          decorator
+        else
+          klass = if Tramway::Decorators::CollectionDecorators.collection?(object_or_array)
+                    object_or_array.first.class
+                  else
+                    object_or_array.class
+                  end
+
+          "#{klass}Decorator".constantize
+        end
+      end
+    end
+  end
+end

data/lib/tramway/decorators/collection_decorator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Decorators
+    # Provides functions for collection decorating
+    #
+    module CollectionDecorators
+      module_function
+
+      def decorate_collection(collection:, context:)
+        collection.map do |item|
+          Tramway::Decorators::BaseDecorator.decorate item, context
+        end
+      end
+
+      def collection?(object)
+        object.class.name.in? ['ActiveRecord::Relation', 'Array']
+      end
+    end
+  end
+end

data/lib/tramway/engine.rb

@@ -7,10 +7,16 @@ module Tramway
     isolate_namespace Tramway
 
     initializer 'tramway.load_helpers' do
-      ActiveSupport.on_load(:action_view) do
+      ActiveSupport.on_load(:action_view) do |loaded_class|
         require 'tramway/helpers/navbar_helper'
 
-        ActionView::Base.include Tramway::Helpers::NavbarHelper
+        loaded_class.include Tramway::Helpers::NavbarHelper
+      end
+
+      ActiveSupport.on_load(:action_controller) do |loaded_class|
+        require 'tramway/helpers/decorate_helper'
+
+        loaded_class.include Tramway::Helpers::DecorateHelper
       end
     end
   end

data/lib/tramway/helpers/decorate_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'tramway/decorators/class_helper'
+
+module Tramway
+  module Helpers
+    # Provides methods into Rails ActionController
+    #
+    module DecorateHelper
+      def tramway_decorate(object_or_array, decorator: nil)
+        Tramway::Decorators::ClassHelper.decorator_class(object_or_array, decorator).decorate object_or_array, self
+      end
+    end
+  end
+end

data/lib/tramway/helpers/navbar_helper.rb

@@ -5,18 +5,40 @@ require 'tramway/navbar'
 module Tramway
   module Helpers
     # Providing navbar helpers for ActionView
-    #
     module NavbarHelper
       def tramway_navbar(**options)
         if block_given?
-          @navbar = Tramway::Navbar.new self
+          initialize_navbar
 
           yield @navbar
 
-          options[:left_items] = @navbar.items[:left]
-          options[:right_items] = @navbar.items[:right]
+          assign_navbar_items(options)
         end
 
+        render_navbar_component(options)
+      end
+
+      private
+
+      def initialize_navbar
+        @navbar = Tramway::Navbar.new(self)
+      end
+
+      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".to_sym
+                         else
+                           key
+                         end
+
+          options.merge! key_to_merge => value
+        end
+      end
+
+      def render_navbar_component(options)
         render(Tailwinds::NavbarComponent.new(**options))
       end
     end

data/lib/tramway/navbar.rb

@@ -1,48 +1,68 @@
 # frozen_string_literal: true
 
 module Tramway
-  # Navbar class for Tramway navbars
-  #
+  # Navbar object provides left and right elements
   class Navbar
     attr_reader :items
 
     def initialize(context)
       @items = {}
       @context = context
+      @filling = nil
     end
 
     def left
       return unless block_given?
 
       @items[:left] = []
-
-      @filling = :left
-
+      filling_side(:left)
       yield self
+      reset_filling
     end
 
     def right
       return unless block_given?
 
       @items[:right] = []
-
-      @filling = :right
-
+      filling_side(:right)
       yield self
+      reset_filling
     end
 
     def item(text_or_url, url = nil, **options, &block)
-      raise 'You can not provide argument and code block in the same time' if url.present? && block_given?
+      raise 'You cannot provide an argument and a code block at the same time' if provided_url_and_block?(url, &block)
 
       rendered_item = if url.present?
-                        options.merge! href: url
-                        @context.render(Tailwinds::Nav::ItemComponent.new(**options)) { text_or_url }
+                        render_ignoring_block(text_or_url, url, options)
                       else
-                        options.merge! href: text_or_url
-                        @context.render(Tailwinds::Nav::ItemComponent.new(**options), &block)
+                        render_using_block(text_or_url, options, &block)
                       end
 
       @items[@filling] << rendered_item
     end
+
+    private
+
+    def provided_url_and_block?(url)
+      url.present? && block_given?
+    end
+
+    def filling_side(side)
+      @filling = side
+    end
+
+    def reset_filling
+      @filling = nil
+    end
+
+    def render_ignoring_block(text_or_url, url, options)
+      options.merge!(href: 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)
+    end
   end
 end

data/lib/tramway/version.rb

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

data/lib/tramway.rb

@@ -2,6 +2,7 @@
 
 require 'tramway/version'
 require 'tramway/engine'
+require 'tramway/base_decorator'
 require 'view_component/compiler'
 require 'view_component/engine'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml-rails
@@ -84,9 +84,14 @@ files:
 - app/components/tailwinds/navbar_component.html.haml
 - app/components/tailwinds/navbar_component.rb
 - config/routes.rb
+- lib/rules/turbo_html_attributes_rules.rb
 - lib/tasks/tramway_tasks.rake
 - lib/tramway.rb
+- lib/tramway/base_decorator.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/version.rb