tramway 0.1.3.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c47949a76aef2c3d5dc7e663bb34012b3450fbbe6f699e4ca7e9d0d98a9613f
-  data.tar.gz: 1bbed346affab3a710234b4848af549200ae94cb1f3d05f97b3c7bd3acd63dcf
+  metadata.gz: 711582391b4cec7b6f8c8808a9d20a1c9695825e94e292073fe85e15d066f11c
+  data.tar.gz: 178c09a9c02feaf8f02094849cbe9fd8756a6f1806419eee369bb1ae0df023b2
 SHA512:
-  metadata.gz: 7119b80a25ff0a302a3b8fd36b10877ce9f256952faf784d88097e7c0862e770f88eb948e909efc6a431ce273817f3847e17296211946bdfd95113984770658b
-  data.tar.gz: 8fc6359c32257287ee3ae2383dfb502d6ed8415a15c1b6e977bbfed087cf4f1352316a2afb2db4657930a3ff4f75cc114a973b1b00bf5ef8c82db18dea833b14
+  metadata.gz: 63d37dcea2ec474996c0a261b0b9d7e3619337f0fc3443f75608633c4c4c1ed08be7a367d79ce8b4c7db33695cfaa18e4052458f78ebbff3d13bc89e9e319418
+  data.tar.gz: 0a10282ff924f4adfd5c892852ed0943a23f3374c1ded44c59344854cdd43034549cd39a2eafd2b8e4af6d5dd60abd06c2cb247ab1a2e70f01b8bc8aba3076f0

data/README.md

@@ -17,23 +17,55 @@ Tramway use [Tailwind](https://tailwindcss.com/) by default. All UI helpers impl
 
 ### Navbar
 
-#### Button
+Tramway provides DSL for rendering Tailwind Navgiation bar.
 
-Tramway provides `Tailwinds::Navbar::ButtonComponent`, that uses `button_to` or `link_to`
-
-```haml
-= render(Tailwinds::Navbar::ButtonComponent.new(href: "/users/sign_in")) do
-  Sign In
+```ruby
+tramway_navbar title: 'Purple Magic' do |nav|
+  nav.left do
+    nav.item 'Users', '/users'
+    nav.item 'Podcasts', '/podcasts'
+  end
+
+  nav.right do
+    nav.item 'Sign out', '/users/sessions', method: :delete, confirm: 'Wanna quit?'
+  end
+end
 ```
 
-will render [this](https://play.tailwindcss.com/RT3Vvauu78)
+will render [this](https://play.tailwindcss.com/UZPTCudFw5)
 
-```haml
-= render(Tailwinds::Navbar::ButtonComponent.new(action: "/users/sign_out", method: :delete)) do
-  Sign Out
-```
+#### nav.left and nav.right
+
+Tramway navbar provides `left` and `right` methods that puts items to left and right part of navbar.
 
-will render [this](https://play.tailwindcss.com/pJ8450tV21)
+#### nav.item
+
+Item in navigation is rendered `li a` inside navbar `ul` tag on the left or right sides. `nav.item` uses the same approach as `link_to` method with syntax sugar.
+
+```ruby
+tramway_navbar title: 'Purple Magic' do |nav|
+  nav.left do
+    nav.item 'Users', '/users'
+
+    # NOTE you can achieve the same with
+
+    nav.item '/users' do
+      'Users'
+    end
+
+    # NOTE nav.item supports turbo-method and turbo-confirm attributes
+
+    nav.item 'Delete user', '/users/destroy', method: :delete, confirm: 'Are you sure?'
+    
+    # will render this
+    # <li>
+    #   <a data-turbo-method="delete" data-turbo-confirm="Are you sure?" href="/users/sign_out" class="text-white hover:bg-red-300 px-4 py-2 rounded">
+    #     Sign out
+    #   </a>
+    # </li>
+  end
+end
+```
 
 ## Contributing
 

data/app/components/tailwinds/nav/item_component.html.haml

@@ -0,0 +1,3 @@
+%li
+  = link_to @href, class: @style, **@options do
+    = content

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  module Nav
+    # Render button styled with Tailwind using button_to or link_to methods
+    #
+    class ItemComponent < TailwindComponent
+      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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+%nav.bg-red-500.py-4.px-8.flex.justify-between.items-center
+  - if @title.present? || @left_items.present?
+    .flex
+      - if @title.present?
+        .text-xl.text-white.font-bold
+          = @title
+      - if @left_items.present?
+        %ul.flex.items-center.space-x-4
+          - @left_items.each do |item|
+            = item
+
+  - if @right_items.present?
+    %ul.flex.items-center.space-x-4
+      - @right_items.each do |item|
+        = item

data/app/components/tailwinds/navbar_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  # Navbar class main class
+  #
+  class NavbarComponent < TailwindComponent
+    def initialize(**options)
+      @title = options[:title]
+      @left_items = options[:left_items]
+      @right_items = options[:right_items]
+    end
+  end
+end

data/lib/tramway/engine.rb

@@ -5,5 +5,13 @@ module Tramway
   #
   class Engine < ::Rails::Engine
     isolate_namespace Tramway
+
+    initializer 'tramway.load_helpers' do
+      ActiveSupport.on_load(:action_view) do
+        require 'tramway/helpers/navbar_helper'
+
+        ActionView::Base.include Tramway::Helpers::NavbarHelper
+      end
+    end
   end
 end

data/lib/tramway/helpers/navbar_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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
+
+          yield @navbar
+
+          options[:left_items] = @navbar.items[:left]
+          options[:right_items] = @navbar.items[:right]
+        end
+
+        render(Tailwinds::NavbarComponent.new(**options))
+      end
+    end
+  end
+end

data/lib/tramway/navbar.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Tramway
+  # Navbar class for Tramway navbars
+  #
+  class Navbar
+    attr_reader :items
+
+    def initialize(context)
+      @items = {}
+      @context = context
+    end
+
+    def left
+      return unless block_given?
+
+      @items[:left] = []
+
+      @filling = :left
+
+      yield self
+    end
+
+    def right
+      return unless block_given?
+
+      @items[:right] = []
+
+      @filling = :right
+
+      yield self
+    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?
+
+      rendered_item = if url.present?
+                        options.merge! href: url
+                        @context.render(Tailwinds::Nav::ItemComponent.new(**options)) { text_or_url }
+                      else
+                        options.merge! href: text_or_url
+                        @context.render(Tailwinds::Nav::ItemComponent.new(**options), &block)
+                      end
+
+      @items[@filling] << rendered_item
+    end
+  end
+end

data/lib/tramway/version.rb

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

data/lib/tramway.rb

@@ -7,5 +7,4 @@ require 'view_component/engine'
 
 # Core module for the whole gem
 module Tramway
-  # Your code goes here...
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.1.3.1
+  version: 0.1.5
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-04 00:00:00.000000000 Z
+date: 2023-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml-rails
@@ -79,12 +79,16 @@ files:
 - Rakefile
 - app/components/tailwind_component.html.haml
 - app/components/tailwind_component.rb
-- app/components/tailwinds/navbar/button_component.html.haml
-- app/components/tailwinds/navbar/button_component.rb
+- app/components/tailwinds/nav/item_component.html.haml
+- app/components/tailwinds/nav/item_component.rb
+- app/components/tailwinds/navbar_component.html.haml
+- app/components/tailwinds/navbar_component.rb
 - config/routes.rb
 - lib/tasks/tramway_tasks.rake
 - lib/tramway.rb
 - lib/tramway/engine.rb
+- lib/tramway/helpers/navbar_helper.rb
+- lib/tramway/navbar.rb
 - lib/tramway/version.rb
 homepage: https://github.com/purple-magic/tramway
 licenses:

data/app/components/tailwinds/navbar/button_component.html.haml

@@ -1,6 +0,0 @@
-- if @action.present?
-  = button_to @action, class: @style, **@options do
-    = content
-- else
-  = link_to @href, class: @style, **@options do
-    = content

data/app/components/tailwinds/navbar/button_component.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Tailwinds
-  module Navbar
-    # Render button styled with Tailwind using button_to or link_to methods
-    #
-    class ButtonComponent < TailwindComponent
-      def initialize(**options)
-        if options[:action].present?
-          @action = options[:action]
-        else
-          @href = options[:href]
-        end
-
-        @style = 'text-white hover:bg-red-300 px-4 py-2 rounded'
-        @options = options.except(:action, :href)
-      end
-    end
-  end
-end