tramway 0.4.3 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cae2dee0a95959ec9a4d2edb886ffd6fbd2ec305770e0ba78f9dc09f04d641ce
-  data.tar.gz: e3d287cd49a4b181279aa8574bec79364af8b9c0b240299cddb3f7ae18dfcd55
+  metadata.gz: 54d135e0a0a71941eecdbbbf042963727d6b0e13e7a024f1c86f22d099d76feb
+  data.tar.gz: fa8e45c0a89c065df62d580e368b1e73a43a4abd06c9e542d8b8a8706dba24c0
 SHA512:
-  metadata.gz: a2cdabe494be288cc8c1d538b727e41cfa0ce2d8d0c49ca8be1561dbc1780e4ba5826be7ee9c9d7c62dff3749b0a94568f747d03d35405c74a22e62b24e210d3
-  data.tar.gz: 36b601a82003ea9c623247d57a068b60fb98998265d7d5dc2a9f505c8e8accbf7ba4e7831bf36601fb05e8b952600bd16900c84db7e8fe4b421b408349914ca5
+  metadata.gz: 2b2b51bb24ca9c973ccd2cc3a925c102a2bedc1c1c1daa43c5be00d4563cc6491a521796a00f7cd80c8019718709e41d683c6f69819cd96172af0a5756f9ef29
+  data.tar.gz: 5db00c69d1d90c75d924d30a6989d087affbe2b2de546d774bfb58b732efce5b5a6615bd6801cdcfdd55d9f0c088c34fa2f7223793cd4d0e8c268dd10334a25e

data/README.md

@@ -8,7 +8,7 @@ Unite Ruby on Rails brilliance. Streamline development with Tramway.
   * [Tramway Form](https://github.com/Purple-Magic/tramway#tramway-form)
   * [Tramway Navbar](https://github.com/Purple-Magic/tramway#tramway-navbar)
   * [Tailwind-styled forms](https://github.com/Purple-Magic/tramway#tailwind-styled-forms)
-  * [Tailwind-styled pagination](https://github.com/Purple-Magic/tramway#tailwind-styled-pagination)
+  * [Tailwind-styled pagination](https://github.com/Purple-Magic/tramway?tab=readme-ov-file#tailwind-styled-pagination-for-kaminari)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -125,6 +125,10 @@ user = nil
 UserDecorator.decorate user # => nil
 ```
 
+#### Update and Destroy
+
+Read [behave_as_ar](https://github.com/Purple-Magic/tramway#behave_as_ar) section
+
 ### Tramway Form
 
 Tramway provides **convenient** form objects for Rails applications. List properties you want to change and the rules in Form classes. No controllers overloading.
@@ -303,6 +307,10 @@ class UserForm < Tramway::BaseForm
 end
 ```
 
+#### Update and Destroy
+
+Read [behave_as_ar](https://github.com/Purple-Magic/tramway#behave_as_ar) section
+
 ### Tramway Navbar
 
 Tramway provides DSL for rendering Tailwind Navgiation bar.
@@ -421,6 +429,10 @@ end
 
 Pagination buttons looks like [this](https://play.tailwindcss.com/mqgDS5l9oY)
 
+### `behave_as_ar`
+
+**Tramway Decorator** and **Tramway Form** support `behave_as_ar` method. It allows to use `update` and `destroy` methods with decorated and form objects.
+
 ## Contributing
 
 Install [lefthook](https://github.com/evilmartians/lefthook)

data/app/components/tailwinds/form/builder.rb

@@ -30,7 +30,7 @@ module Tailwinds
         render(Tailwinds::Form::SelectComponent.new(
                  input: input(:select),
                  value: options[:selected] || object.public_send(attribute),
-                 collection:,
+                 collection: explicitly_add_blank_option(collection, options),
                  **default_options(attribute, options)
                ), &)
       end
@@ -53,20 +53,32 @@ module Tailwinds
       def default_options(attribute, options)
         {
           attribute:,
-          label: label(attribute, options),
+          label: label_build(attribute, options),
           for: for_id(attribute),
           options:
         }
       end
 
       # :reek:UtilityFunction
-      def label(attribute, options)
-        options[:label] || attribute.to_s.humanize
+      def label_build(attribute, options)
+        options[:label].presence || attribute.to_s.humanize
       end
 
       def for_id(attribute)
         "#{object_name}_#{attribute}"
       end
+
+      # REMOVE IT. WE MUST UNDERSTAND WHY INCLUDE_BLANK DOES NOT WORK
+      # :reek:UtilityFunction
+      def explicitly_add_blank_option(collection, options)
+        if options[:include_blank]
+          collection = collection.to_a if collection.is_a? Hash
+
+          collection.unshift([nil, ''])
+        else
+          collection
+        end
+      end
     end
   end
 end

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

@@ -1,4 +1,5 @@
 .mb-4
-  %label.inline-block.bg-blue-500.hover:bg-blue-700.text-white.font-bold.py-2.px-4.rounded.cursor-pointer.mt-4{ for: @for }
-    = @label
+  - if @label
+    %label.inline-block.bg-blue-500.hover:bg-blue-700.text-white.font-bold.py-2.px-4.rounded.cursor-pointer.mt-4{ for: @for }
+      = @label
   = @input

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

@@ -1,4 +1,5 @@
 .mb-4
-  %label.block.text-gray-700.text-sm.font-bold.mb-2{ for: @for }
-    = @label
+  - if @label
+    %label.block.text-gray-700.text-sm.font-bold.mb-2{ for: @for }
+      = @label
   = @input.call(@attribute, @collection, { selected: @value }, @options.merge(class: 'bg-white border border-gray-300 text-gray-700 py-2 px-2 rounded-lg focus:outline-none focus:ring-2 focus:ring-blue-500 focus:border-transparent'))

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

@@ -1,4 +1,5 @@
 .mb-4
-  %label.block.text-gray-700.text-sm.font-bold.mb-2{ for: @for }
-    = @label
+  - if @label
+    %label.block.text-gray-700.text-sm.font-bold.mb-2{ for: @for }
+      = @label
   = @input.call @attribute, **@options.merge(class: 'w-full px-3 py-2 border border-gray-300 rounded focus:outline-none focus:border-red-500'), value: @value

data/app/components/tailwinds/nav/item/button_component.html.haml

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

data/app/components/tailwinds/nav/item/button_component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rules/turbo_html_attributes_rules'
+
+module Tailwinds
+  module Nav
+    module Item
+      # Render button styled with Tailwind using button_to methods
+      #
+      class ButtonComponent < TailwindComponent
+        def initialize(**options)
+          @href = options[:href]
+          @method = options[:method]
+          @style = 'text-white hover:bg-red-300 px-4 py-2 rounded'
+          @options = options.except(:href, :method)
+        end
+      end
+    end
+  end
+end

data/app/components/tailwinds/nav/item/link_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rules/turbo_html_attributes_rules'
+
+module Tailwinds
+  module Nav
+    module Item
+      # Render button styled with Tailwind using link_to methods
+      #
+      class LinkComponent < TailwindComponent
+        def initialize(**options)
+          @href = options[:href]
+          @style = 'text-white hover:bg-red-300 px-4 py-2 rounded'
+          @options = Rules::TurboHtmlAttributesRules.prepare_turbo_html_attributes(options:)
+        end
+      end
+    end
+  end
+end

data/lib/tasks/tramway_tasks.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :tramway do
 #   # Task goes here

data/lib/tramway/base_decorator.rb

@@ -2,6 +2,7 @@
 
 require 'tramway/decorators/collection_decorator'
 require 'tramway/utils/render'
+require 'tramway/duck_typing'
 
 module Tramway
   # Provides decorate function for Tramway projects
@@ -9,6 +10,7 @@ module Tramway
   class BaseDecorator
     include Tramway::Decorators::CollectionDecorators
     include Tramway::Utils::Render
+    include Tramway::DuckTyping::ActiveRecordCompatibility
 
     attr_reader :object
 
@@ -38,16 +40,10 @@ module Tramway
       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/base_form.rb

@@ -2,6 +2,7 @@
 
 require 'tramway/forms/properties'
 require 'tramway/forms/normalizations'
+require 'tramway/duck_typing'
 
 module Tramway
   # Provides form object for Tramway
@@ -9,13 +10,10 @@ module Tramway
   class BaseForm
     include Tramway::Forms::Properties
     include Tramway::Forms::Normalizations
+    include Tramway::DuckTyping::ActiveRecordCompatibility
 
     attr_reader :object
 
-    %i[model_name to_key to_model errors attributes update destroy].each do |method_name|
-      delegate method_name, to: :object
-    end
-
     def initialize(object)
       @object = object
 

data/lib/tramway/duck_typing/active_record_compatibility.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Tramway
+  module DuckTyping
+    # This module is used to make duck object compatible with ActiveRecord objects
+    module ActiveRecordCompatibility
+      # Contains behave_as_ar method
+      module ClassMethods
+        def behave_as_ar
+          %i[update update! destroy].each do |method_name|
+            delegate method_name, to: :object
+          end
+        end
+      end
+
+      %i[id model_name to_key errors to_param attributes].each do |method_name|
+        delegate method_name, to: :object
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+    end
+  end
+end

data/lib/tramway/duck_typing.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'tramway/duck_typing/active_record_compatibility'
+
+module Tramway
+  # This module is used to make duck object compatible
+  module DuckTyping
+  end
+end

data/lib/tramway/navbar.rb

@@ -37,9 +37,9 @@ module Tramway
       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?
-                        render_ignoring_block(text_or_url, url, options)
+                        render_ignoring_block(text_or_url, url, **options)
                       else
-                        render_using_block(text_or_url, options, &block)
+                        render_using_block(text_or_url, **options, &block)
                       end
 
       @items[@filling] << rendered_item
@@ -69,16 +69,24 @@ module Tramway
       @filling = nil
     end
 
-    def render_ignoring_block(text_or_url, url, options)
+    def render_ignoring_block(text_or_url, url, method: nil, **options)
       options.merge!(href: url)
 
-      context.render(Tailwinds::Nav::ItemComponent.new(**options)) { text_or_url }
+      if method.present? && method.to_sym != :get
+        context.render(Tailwinds::Nav::Item::ButtonComponent.new(method:, **options)) { text_or_url }
+      else
+        context.render(Tailwinds::Nav::Item::LinkComponent.new(method:, **options)) { text_or_url }
+      end
     end
 
-    def render_using_block(text_or_url, options, &block)
+    def render_using_block(text_or_url, method: nil, **options, &block)
       options.merge!(href: text_or_url)
 
-      context.render(Tailwinds::Nav::ItemComponent.new(**options), &block)
+      if method.present? && method.to_sym != :get
+        context.render(Tailwinds::Nav::Item::ButtonComponent.new(method:, **options), &block)
+      else
+        context.render(Tailwinds::Nav::Item::LinkComponent.new(method:, **options), &block)
+      end
     end
   end
 end

data/lib/tramway/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.5
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-05 00:00:00.000000000 Z
+date: 2024-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -102,8 +102,10 @@ files:
 - app/components/tailwinds/form/submit_button_component.rb
 - app/components/tailwinds/form/text_field_component.html.haml
 - app/components/tailwinds/form/text_field_component.rb
-- app/components/tailwinds/nav/item_component.html.haml
-- app/components/tailwinds/nav/item_component.rb
+- app/components/tailwinds/nav/item/button_component.html.haml
+- app/components/tailwinds/nav/item/button_component.rb
+- app/components/tailwinds/nav/item/link_component.html.haml
+- app/components/tailwinds/nav/item/link_component.rb
 - app/components/tailwinds/navbar_component.html.haml
 - app/components/tailwinds/navbar_component.rb
 - app/views/kaminari/_first_page.html.haml
@@ -124,6 +126,8 @@ files:
 - lib/tramway/configs/entity.rb
 - lib/tramway/decorators/class_helper.rb
 - lib/tramway/decorators/collection_decorator.rb
+- lib/tramway/duck_typing.rb
+- lib/tramway/duck_typing/active_record_compatibility.rb
 - lib/tramway/engine.rb
 - lib/tramway/forms/class_helper.rb
 - lib/tramway/forms/normalizations.rb

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

@@ -1,17 +0,0 @@
-# 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
-    #
-    class ItemComponent < TailwindComponent
-      def initialize(**options)
-        @href = options[:href]
-        @style = 'text-white hover:bg-red-300 px-4 py-2 rounded'
-        @options = Rules::TurboHtmlAttributesRules.prepare_turbo_html_attributes(options:)
-      end
-    end
-  end
-end