readymade 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a730db0a4c2ccfefcb7c48a607ba75e691b8133ac8f6f7cdc6a67554bed180c3
-  data.tar.gz: 84567afe201fd84977f5a56a46b68093c4bc7d814f4395d2cbb87325f268fa17
+  metadata.gz: 9d8b08e5bcf92035a49dbec37847653f0b99743c2f508c96e50b0aba312b3905
+  data.tar.gz: 2ec517133167b7ec909d9bf2e77c0fdb185774017f70f8871586ec0eb942925e
 SHA512:
-  metadata.gz: 53c0991bce0adcfc2c9e2cbe8498936c90bcd01b197d3483027e04b594bb2ea9fbaf4b69cf7306312b4b2cb3784613f5facbde0d6ee46a6fba6b07fcab7b1814
-  data.tar.gz: 6d280789685dc5bead01c40191668c58e56124108d9c2d5c81a9537b0ee147e4d2718d03460b2e4b512ee4b43ca98947781eff1f006746fb1108bac352294fb0
+  metadata.gz: c2388b93ffa8fd5bb5fe988546dab3383a70ec36296ca0efe6a34475c2e06514a43ff0b12c61986aaf50d6a03c529076c92d1b802647a310a12b44b966dc27d4
+  data.tar.gz: ec9b42d63e9ba52d2a27fa10ac2ccf572de6c287b14a1f0e9269c7554adb0f10deee2ad0a6fb62a05c5ac7db2854e96abb6ca554774b632bfaa4f037057822b0

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.1.6] - 2021-12-20
+
+### Features
+
+* Add Readymade::Controller::Serialization
+
+## [0.1.5] - 2021-12-07
+
+### Improvements
+
+* Better errors with Rails 6.1.
+
 ## [0.1.4] - 2021-11-22
 
 ### Features

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    readymade (0.1.4)
+    readymade (0.1.7)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,4 +1,4 @@
-# Readymade
+# Readymade 0.1.7
 
 This gems contains basic components to follow [ABDI architecture](https://github.com/OrestF/OrestF/blob/master/abdi/ABDI_architecture.md)
 
@@ -35,6 +35,41 @@ Inherit your components from:
 
 ```TODO: add```
 
+#### #form_options
+
+```ruby
+# app/forms/my_form.rb
+
+class MyForm < Readymade::Form
+  PERMITTED_ATTRIBUTES = %i[email name category country]
+  REQUIRED_ATTRIBUTES = %i[email]
+  
+  def form_options
+    {
+      categories: args[:company].categories,
+      countries: Country.all
+    }
+  end
+end
+```
+
+```ruby
+# app/controllers/items_controller.rb
+
+def new
+  @form_options = MyForm.form_options(company: current_company)
+end
+```
+
+```slim
+/ app/views/items/new.html.slim
+
+= f.select :category, collection: @form_options[:categories]
+= f.select :country, collection: @form_options[:countries]
+= f.text_field :email, required: @form_options.required?(:email) # true
+= f.text_field :name, required: @form_options.required?(:name) # false
+```
+
 ### Readymade::InstantForm
 
 Permit params and validates presence inline
@@ -60,7 +95,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/readymade. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/readymade/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/OrestF/readymade. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/readymade/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License

data/lib/readymade/controller/serialization.rb

@@ -0,0 +1,70 @@
+require 'active_support/concern'
+
+module Readymade
+  module Controller
+    module Serialization
+      extend ActiveSupport::Concern
+
+      def record_response(record, *args)
+        options = args.extract_options!
+        return render_json({}, :not_found) if record.nil?
+
+        hash = serialize_record(record, options)
+
+        status = if record.errors.none?
+                   options[:status] || :ok
+                 else
+                   hash[:errors] = record.errors.messages
+                   :bad_request
+                 end
+        render_json(hash, status)
+      end
+
+      def collection_response(collection, *args)
+        options = args.extract_options!
+
+        render_json(
+          {
+            items: serialize_collection(paginate(collection, options), options),
+            count: collection.count
+          },
+          options[:status] || :ok
+        )
+      end
+
+      def render_json(message, status)
+        render json: message, status: status
+      end
+
+      def serialize_collection(collection, options = {})
+        serializer = options.delete(:serializer) || "#{collection.klass.name}Serializer".constantize
+        serializer.render_as_hash(collection, options)
+      end
+
+      def serialize_record(record, options = {})
+        serializer = options.delete(:serializer) || "#{record.class.name}Serializer".constantize
+        serializer.render_as_hash(record, { root: :data }.merge!(options))
+      end
+
+      def operation_response(response_obj, options = {})
+        message, status = case response_obj.status.to_sym
+                          when :success, :ok
+                            [
+                              if response_obj.data[:record].present?
+                                serialize_record(response_obj.data[:record],
+                                                 options)
+                              else
+                                {}
+                              end,
+                              :ok
+                            ]
+                          when :validation_fail, :bad_request
+                            [{ errors: response_obj.data[:errors] }, :bad_request]
+                          else
+                            [response_obj.status.to_sym, {}]
+                          end
+        render_json(message, status)
+      end
+    end
+  end
+end

data/lib/readymade/form.rb

@@ -31,6 +31,7 @@ module Readymade
           attr_accessor key
         end
       end
+
       # automatically validates all REQUIRED_ATTRIBUTES
       singleton_class.validates(*required_attributes, presence: true) if required_attributes.present?
 
@@ -52,8 +53,13 @@ module Readymade
         next if params[attr].blank?
 
         if form_class.is_a?(Array)
-          n_forms = params[attr].map { |_i, attrs| form_class[0].new(attrs) }
-
+          n_forms = if params[attr].is_a?(Hash)
+                      # { 0 => {id: 1, name: 'my name'}, 1 => { id: 2, name: 'other name' }}
+                      params[attr].map { |_i, attrs| form_class[0].new(attrs) }
+                    else
+                      # [{id: 1, name: 'my name'}, { id: 2, name: 'other name' }]
+                      params[attr].map { |attrs| form_class[0].new(attrs) }
+                    end
           @nested_forms.push(*n_forms)
           define_singleton_method("#{attr}_forms") { n_forms }
         else
@@ -71,6 +77,7 @@ module Readymade
       nested_forms.compact.map(&:validate).all? || sync_nested_errors(nested_forms)
     end
 
+    # copy errors from nested forms into parent form
     def sync_nested_errors(nested_forms)
       nested_forms.each do |n_form|
         n_form.errors.each do |code, text|
@@ -81,14 +88,23 @@ module Readymade
       false
     end
 
+    # sync errors from form to record or vice-versa
     def sync_errors(from: self, to: record)
       return if [from, to].any?(&:blank?)
 
-      errors = from.errors.instance_variable_get('@messages').to_h
-      errors.merge!(to.errors.instance_variable_get('@messages').to_h)
+      if Rails.version.to_f > 6.0
+        from.errors.messages.each do |key, values|
+          Array.wrap(values).uniq.each do |uv|
+            to.errors.add(key, uv)
+          end
+        end
+      else
+        errors = from.errors.instance_variable_get('@messages').to_h
+        errors.merge!(to.errors.instance_variable_get('@messages').to_h)
 
-      to.errors.instance_variable_set('@messages', errors)
-      to.errors.messages.transform_values!(&:uniq) # Does not work with rails 6.1
+        to.errors.instance_variable_set('@messages', errors)
+        to.errors.messages.transform_values!(&:uniq) # Does not work with rails 6.1
+      end
     rescue FrozenError => _e
     end
 
@@ -128,5 +144,53 @@ module Readymade
     def nested_forms_mapping
       {}
     end
+
+    # EXAMPLE
+    # class Items::Forms::Create::Value < ::Readymade::Form
+    #   PERMITTED_ATTRIBUTES = %i[attr1 attr2].freeze
+    #   REQUIRED_ATTRIBUTES = %i[attr1].freeze
+    #
+    #   class Value < ::Readymade::Form::Value
+    #     def to_h
+    #       {
+    #         vat_percent: Item::VAT_OPTIONS,
+    #         price_type: Item.price_types.keys,
+    #         item_category: args[:company].item_categories
+    #       }
+    #     end
+    #   end
+
+    # @form_options = Items::Forms::Create::Value.new(company: current_company)
+    # f.association :item_category, collection: @form_options[:item_category]
+
+    def self.form_options(**args)
+      Readymade::Form::FormOptions.new(**args.merge!(form_class: self))
+    end
+    class FormOptions
+      attr_reader :args
+
+      def initialize(**args)
+        @args = args
+        @f_class = args.delete(:form_class)
+      end
+
+      def [](key)
+        to_h[key]
+      end
+
+      def to_h
+        raise Readymade::Error.new('define form_options on your form') unless (f = @f_class.new({}, @args)).respond_to?(:form_options)
+
+        f.form_options
+      end
+
+      def as_json(options = {})
+        to_h.as_json(options)
+      end
+
+      def required?(attr)
+        @f_class::REQUIRED_ATTRIBUTES.include?(attr.to_sym)
+      end
+    end
   end
 end

data/lib/readymade/instant_form.rb

@@ -2,6 +2,5 @@
 
 module Readymade
   class InstantForm < Form
-
   end
 end

data/lib/readymade/operation.rb

@@ -26,7 +26,7 @@ module Readymade
     def record_valid?
       return true if record.errors.none? && record.valid?
 
-      sync_errors_to_form && false
+      false
     end
 
     def save_record
@@ -43,6 +43,7 @@ module Readymade
 
     def validation_fail(status = :validation_fail, args = {})
       sync_errors_to_form
+
       response(status, args.merge!(record: record,
                                    record_params: record_params,
                                    form: form,

data/lib/readymade/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Readymade
-  VERSION = '0.1.4'
+  VERSION = '0.1.7'
 end

data/lib/readymade.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'readymade/controller/serialization'
 require 'readymade/action'
 require 'readymade/form'
 require 'readymade/instant_form'

data/readymade.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+  spec.files << 'lib/readymade/controller/serialization.rb'
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readymade
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors:
 - OrestF
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -73,6 +73,7 @@ files:
 - bin/setup
 - lib/readymade.rb
 - lib/readymade/action.rb
+- lib/readymade/controller/serialization.rb
 - lib/readymade/form.rb
 - lib/readymade/instant_form.rb
 - lib/readymade/operation.rb