tramway 0.4.5.1 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef5809ca8f857fbc319595ce2ada4409120a4a89dc657bf2f7625e9b329d7d47
-  data.tar.gz: da8094f83cc2f21d4470afef2311c790a079f9597aee99ebb448ea98cb83df61
+  metadata.gz: 69d16412bfd7e8fcb33e3ddc27a8be714350cd7fe97a56451a47dced641546c7
+  data.tar.gz: 60d32317870e16a0e4aadc618a8a2170939fda2e7d06d7202935a40d1ee945f7
 SHA512:
-  metadata.gz: a8e9018040b8068c41e98f57682d12e3e08ce191ebef5c252185ff8ccacfbd71f75d6935a03e35c883e240ee5b402fd997c934779faf831e112cf46fe5d3c073
-  data.tar.gz: e51b2512f9c078a2f094d4fb027c038c097ac7c1a4410da898563abc9eac2c94fa1e84f51e3438576ac9785b2e8ee6999b1b18b8505f1ab9c85be1095e1a7c3c
+  metadata.gz: a31a8b31885e7bf84aed5896850e7e98930fcf7bdf5dcc74eaf006172b7d6f305458f79c659618ac8da82d2050d18b818a891ac93ef1ff4bf01a5fe20cf8dabc
+  data.tar.gz: f21ecdb0d87afb50afae3c3b5a01d953f3736778fad9f0e47e2b16e8a1d35b33002ef4bf96b1624af20e2aaa619d90c7195b1ed225bad68279e211dbf795f6f7

data/README.md

@@ -18,6 +18,12 @@ gem "tramway"
 gem "view_component"
 ```
 
+OR
+
+```shell
+bundle add tramway view_component
+```
+
 ## Usage
 
 ### Tramway Entities
@@ -70,6 +76,8 @@ class UserDecorator < Tramway::BaseDecorator
   # delegates attributes to decorated object
   delegate_attributes :email, :first_name, :last_name
 
+  association :posts
+
   # you can provide your own methods with access to decorated object attributes with the method `object`
   def created_at
     I18n.l object.created_at
@@ -116,6 +124,17 @@ def show
 end
 ```
 
+#### Decorate associations
+
+```ruby
+class UserDecorator < Tramway::BaseDecorator
+  association :posts
+end
+
+user = tramway_decorate User.first
+user.posts # => decorated collection of posts with PostDecorator
+```
+
 #### Decorate nil
 
 Tramway Decorator does not decorate nil objects
@@ -198,6 +217,8 @@ class UsersController < ApplicationController
 end
 ```
 
+We also provide `submit!` as `save!` method that returns an exception in case of failed saving.
+
 #### Implement Form objects for any case
 
 *app/forms/user_updating_email_form.rb*
@@ -307,7 +328,21 @@ class UserForm < Tramway::BaseForm
 end
 ```
 
-#### Update and Destroy
+### Assign values
+
+Tramway Form provides `assign` method that allows to assign values without saving
+
+```ruby
+class UsersController < ApplicationController
+  def update
+    @user = tramway_form User.new
+    @user.assign params[:user] # assigns values to the form object
+    @user.reload # restores previous values
+  end
+end
+```
+
+### Update and Destroy
 
 Read [behave_as_ar](https://github.com/Purple-Magic/tramway#behave_as_ar) section
 
@@ -433,6 +468,18 @@ Pagination buttons looks like [this](https://play.tailwindcss.com/mqgDS5l9oY)
 
 **Tramway Decorator** and **Tramway Form** support `behave_as_ar` method. It allows to use `update` and `destroy` methods with decorated and form objects.
 
+### `object` method
+
+**Tramway Decorator** and **Tramway Form** have public `object` method. It allows to access ActiveRecord object itself.
+
+```ruby
+user_1 = tramway_decorate User.first
+user_1.object #=> returns pure user object
+
+user_2 = tramway_form User.first
+user_2.object #=> returns pure user object
+```
+
 ## Contributing
 
 Install [lefthook](https://github.com/evilmartians/lefthook)

data/lib/tramway/base_decorator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'tramway/decorators/name_builder'
+require 'tramway/decorators/association'
 require 'tramway/decorators/collection_decorator'
 require 'tramway/utils/render'
 require 'tramway/duck_typing'
@@ -38,6 +40,8 @@ module Tramway
           delegate attribute, to: :object
         end
       end
+
+      include Tramway::Decorators::AssociationClassMethods
     end
 
     def to_partial_path

data/lib/tramway/base_form.rb

@@ -45,6 +45,10 @@ module Tramway
       end
     end
 
+    def assign(params)
+      __submit params
+    end
+
     def method_missing(method_name, *args)
       if method_name.to_s.end_with?('=') && args.count == 1
         object.public_send(method_name, args.first)

data/lib/tramway/decorators/association.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Decorators
+    # Module for defining association instance-level methods
+    module Association
+      private
+
+      # :reek:UtilityFunction { enabled: false }
+      def decorate_has_many_association(assoc)
+        AssocDecoratorHelper.decorate_has_many_association(assoc)
+      end
+    end
+
+    # Module for defining association class-level methods
+    #
+    module AssociationClassMethods
+      def associations(*associations)
+        associations.each do |assoc|
+          association assoc
+        end
+      end
+
+      # has_and_belongs_to_many is not supported for now
+      def association(association)
+        define_method(association) do
+          assoc = object.send(association)
+
+          if assoc.is_a?(ActiveRecord::Relation)
+            AssocDecoratorHelper.decorate_has_many_association assoc
+          elsif assoc.present?
+            AssocDecoratorHelper.decorate_associated_object(assoc)
+          end
+        end
+      end
+    end
+
+    # Helper module for association decorators
+    module AssocDecoratorHelper
+      class << self
+        def decorate_has_many_association(assoc)
+          assoc.empty? ? [] : decorator(assoc.klass).decorate(assoc)
+        end
+
+        def decorate_associated_object(assoc)
+          decorator(assoc.class).decorate(assoc)
+        end
+
+        def decorator(class_name)
+          Tramway::Decorators::NameBuilder.default_decorator_class_name(class_name).constantize
+        end
+      end
+    end
+  end
+end

data/lib/tramway/decorators/class_helper.rb

@@ -16,7 +16,7 @@ module Tramway
                     object_or_array.class
                   end
 
-          "#{klass}Decorator".constantize
+          Tramway::Decorators::NameBuilder.default_decorator_class_name(klass).constantize
         end
       end
     end

data/lib/tramway/decorators/name_builder.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Decorators
+    # Implements name convention for decorators
+    #
+    module NameBuilder
+      module_function
+
+      def default_decorator_class_name(klass)
+        "#{klass}Decorator"
+      end
+    end
+  end
+end

data/lib/tramway/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.4.5.1
+  version: 0.4.7
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-06 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -124,8 +124,10 @@ files:
 - lib/tramway/config.rb
 - lib/tramway/configs/entities/route.rb
 - lib/tramway/configs/entity.rb
+- lib/tramway/decorators/association.rb
 - lib/tramway/decorators/class_helper.rb
 - lib/tramway/decorators/collection_decorator.rb
+- lib/tramway/decorators/name_builder.rb
 - lib/tramway/duck_typing.rb
 - lib/tramway/duck_typing/active_record_compatibility.rb
 - lib/tramway/engine.rb