tramway 0.3.1.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc672cadc5513d98dce14491b39bc240f08019a61bd19ff795ca9ee2cd4cefd
-  data.tar.gz: 10d6bb6bb570855763921365260899b1da88c36a7e0eb102b784331d6e4c2021
+  metadata.gz: fc95797d7be71f61b7a8350b3ef71905d41c8281d3a134feefc4e8477b910b44
+  data.tar.gz: 9fc4aa0e0bbec968e96620532082142b3ad48ab701e97ab52c2bd05a8236c047
 SHA512:
-  metadata.gz: a27d64991c18ad3ef69dd1ef660a9b743e4f5e481bfd46dbd9aea4e56651b576d161f932f9eaf5bb249a5e7bcad1c2f6c5bc13b5ad8e6307c3e032a020216058
-  data.tar.gz: 64cf301904e00cb8c0b9504fc6081f8cecc21262426d309e55d8046d6d26887f06e9d3841e82dcd40a8d53fd4f8e0f9b407e40413bdd38fb2931790c770f6777
+  metadata.gz: ef921bd83394ebde2404a8e5e1b7332af573713553ed73676850955ff8e32f9fc93cdddfa0124658ad40c096557fcd60ed420a55d252f5e5c3fb40ea34cae19e
+  data.tar.gz: d0a2b72e6e35ea9a297a9af346e794cf1833e8b5922c2e09d98a5f8f06a2d283db49b33753510535a0594365b072aff666712ee50a0b2c9d6036aa530ab52e38

data/README.md

@@ -81,7 +81,7 @@ class UserDecorator < Tramway::BaseDecorator
 end
 ```
 
-#### Decorate single object
+#### Decorate a single object
 
 You can use the same method to decorate a single object either
 
@@ -91,6 +91,20 @@ def show
 end
 ```
 
+#### Decorate a collection of objects
+
+```ruby
+def index
+  @users = tramway_decorate User.all
+end
+```
+
+```ruby
+def index
+  @posts = tramway_decorate user.posts
+end
+```
+
 #### Decorate with a specific decorator
 
 You can implement a specific decorator and ask Tramway to decorate with it
@@ -101,6 +115,15 @@ def show
 end
 ```
 
+#### Decorate nil
+
+Tramway Decorator does not decorate nil objects
+
+```ruby
+user = nil
+UserDecorator.decorate user # => nil
+```
+
 ### 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.
@@ -325,6 +348,7 @@ Tramway provides `tramway_form_for` helper that renders Tailwind-styled forms by
 = tramway_form_for User.new do |f|
   = f.text_field :text
   = f.password_field :password
+  = f.select :role, [:admin, :user]
   = f.file_field :file
   = f.submit "Create User"
 ```
@@ -335,6 +359,7 @@ Available form helpers:
 * text_field
 * password_field
 * file_field
+* select
 * submit
 
 ## Contributing

data/app/components/tailwind_component.rb

@@ -4,4 +4,12 @@ require 'view_component'
 
 # Base TailwindComponent. Contains base features for all tailwind components
 class TailwindComponent < ViewComponent::Base
+  extend Dry::Initializer[undefined: false]
+
+  option :template
+  option :attribute
+  option :object_name
+  option :options
+  option :label
+  option :for
 end

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

@@ -3,21 +3,22 @@
 module Tailwinds
   module Form
     # Provides Tailwind-styled forms
+    # :reek:InstanceVariableAssumption
     class Builder < Tramway::Views::FormBuilder
       def text_field(attribute, **options, &)
-        input = super(attribute, **options.merge(class: text_input_class))
-        render(Tailwinds::Form::TextFieldComponent.new(input, attribute, object_name:, **options), &)
+        render(Tailwinds::Form::TextFieldComponent.new(**default_options(attribute, options)), &)
       end
 
       def password_field(attribute, **options, &)
-        input = super(attribute, **options.merge(class: text_input_class))
-        render(Tailwinds::Form::TextFieldComponent.new(input, attribute, object_name:, **options), &)
+        render(Tailwinds::Form::TextFieldComponent.new(**default_options(attribute, options)), &)
       end
 
       def file_field(attribute, **options, &)
-        input = super(attribute, **options.merge(class: :hidden))
+        render(Tailwinds::Form::FileFieldComponent.new(**default_options(attribute, options)), &)
+      end
 
-        render(Tailwinds::Form::FileFieldComponent.new(input, attribute, object_name:, **options), &)
+      def select(attribute, collection, **options, &)
+        render(Tailwinds::Form::SelectComponent.new(**default_options(attribute, options).merge(collection:)), &)
       end
 
       def submit(action, **options, &)
@@ -26,8 +27,24 @@ module Tailwinds
 
       private
 
-      def text_input_class
-        'w-full px-3 py-2 border border-gray-300 rounded focus:outline-none focus:border-red-500'
+      def default_options(attribute, options)
+        {
+          template: @template,
+          attribute:,
+          object_name:,
+          label: label(attribute, options),
+          for: for_id(attribute),
+          options:
+        }
+      end
+
+      # :reek:UtilityFunction
+      def label(attribute, options)
+        options[:label] || attribute.to_s.humanize
+      end
+
+      def for_id(attribute)
+        "#{object_name}_#{attribute}"
       end
     end
   end

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

@@ -1,4 +1,4 @@
 .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
-  = @input
+  = @template.file_field @object_name, @attribute

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

@@ -4,11 +4,6 @@ module Tailwinds
   module Form
     # Tailwind-styled file_field input
     class FileFieldComponent < TailwindComponent
-      def initialize(input, attribute, object_name: nil, **options)
-        @label = options[:label] || attribute.to_s.capitalize
-        @for = "#{object_name}_#{attribute}"
-        @input = input
-      end
     end
   end
 end

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

@@ -0,0 +1,4 @@
+.mb-4
+  %label.block.text-gray-700.text-sm.font-bold.mb-2{ for: @for }
+    = @label
+  = @template.select @object_name, @attribute, @collection, {}, @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/select_component.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  module Form
+    # Tailwind-styled text field
+    class SelectComponent < TailwindComponent
+      option :collection
+    end
+  end
+end

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

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

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

@@ -4,11 +4,6 @@ module Tailwinds
   module Form
     # Tailwind-styled text field
     class TextFieldComponent < TailwindComponent
-      def initialize(input, attribute, object_name: nil, **options)
-        @label = options[:label] || attribute.to_s.humanize
-        @for = "#{object_name}_#{attribute}"
-        @input = input
-      end
     end
   end
 end

data/lib/tramway/base_decorator.rb

@@ -17,7 +17,10 @@ module Tramway
     end
 
     class << self
+      # :reek:NilCheck { enabled: false } because checking for nil is not a type-checking issue but business logic
       def decorate(object_or_array)
+        return if object_or_array.nil?
+
         if Tramway::Decorators::CollectionDecorators.collection?(object_or_array)
           Tramway::Decorators::CollectionDecorators.decorate_collection(
             collection: object_or_array,

data/lib/tramway/base_form.rb

@@ -12,6 +12,8 @@ module Tramway
 
     def initialize(object)
       @object = object
+
+      self.class.delegate object.class.primary_key, to: :object
     end
 
     class << self

data/lib/tramway/decorators/collection_decorator.rb

@@ -14,7 +14,7 @@ module Tramway
       end
 
       def collection?(object)
-        object.class.name.in? ['ActiveRecord::Relation', 'Array']
+        object.is_a?(Array) || object.is_a?(ActiveRecord::Relation)
       end
     end
   end

data/lib/tramway/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.3.1.1
+  version: 0.3.2
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -96,6 +96,8 @@ files:
 - app/components/tailwinds/form/builder.rb
 - app/components/tailwinds/form/file_field_component.html.haml
 - app/components/tailwinds/form/file_field_component.rb
+- app/components/tailwinds/form/select_component.html.haml
+- app/components/tailwinds/form/select_component.rb
 - app/components/tailwinds/form/submit_button_component.html.haml
 - app/components/tailwinds/form/submit_button_component.rb
 - app/components/tailwinds/form/text_field_component.html.haml