readymade 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d8b08e5bcf92035a49dbec37847653f0b99743c2f508c96e50b0aba312b3905
-  data.tar.gz: 2ec517133167b7ec909d9bf2e77c0fdb185774017f70f8871586ec0eb942925e
+  metadata.gz: a4fa8901d76050e8ef3597f3e079ebbfa6bcd565dbc05a22dc3578616da556b1
+  data.tar.gz: e52a10d9513e21c61501305edae074bd7e80aa00a993f4f3bba8b266d1e420c1
 SHA512:
-  metadata.gz: c2388b93ffa8fd5bb5fe988546dab3383a70ec36296ca0efe6a34475c2e06514a43ff0b12c61986aaf50d6a03c529076c92d1b802647a310a12b44b966dc27d4
-  data.tar.gz: ec9b42d63e9ba52d2a27fa10ac2ccf572de6c287b14a1f0e9269c7554adb0f10deee2ad0a6fb62a05c5ac7db2854e96abb6ca554774b632bfaa4f037057822b0
+  metadata.gz: b5fca515c5b236aa72f49f84326d4e6b02e50d7af50636e8fd79774fb5d246d42a7f82341864729f25051dbf24f9d937c72ef7ae9a76ab794ecca6e0b61eeb3c
+  data.tar.gz: 671f7bdf6ba9362306e790bc6ed02d7c08d3007110d6f256072b4efd5cca0f88719a080489fe023f1e60c3d7ae7de050da252637d2a638fa28665e2f337d7b58

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.1.8] - 2022-03-30
+
+### Improvements
+
+* Improve README.md and form examples
+
 ## [0.1.6] - 2021-12-20
 
 ### Features

data/README.md

@@ -1,4 +1,4 @@
-# Readymade 0.1.7
+# Readymade 0.1.8
 
 This gems contains basic components to follow [ABDI architecture](https://github.com/OrestF/OrestF/blob/master/abdi/ABDI_architecture.md)
 
@@ -29,13 +29,35 @@ Inherit your components from:
 
 ### Readymade::Response
 
-```TODO: add```
+```ruby
+response = Readymade::Response.new(:success, my_data: data)
+response.success? # true
+response =Readymade::Response.new(:fail, errors: errors)
+response.success? # false
+response.fail? # true
+response.status # 'fail'
+response.data # { errors: { some: 'errors' } }
+```
 
 ### Readymade::Form
 
-```TODO: add```
+Check more form features examples in `lib/readymade/form.rb`
+```ruby
+class Orders::Forms::Create < Readymade::Form
+  PERMITTED_ATTRIBUTES = %i[email name category country customer]
+  REQUIRED_ATTRIBUTES = %i[email]
+
+  validates :customer, presence: true, if: args[:validate_customer]
+end
+
+order_form = Orders::Forms::Create.new(params, order: order, validate_customer: false)
 
-#### #form_options
+order_form.valid? # true
+
+
+```
+
+#### form_options
 
 ```ruby
 # app/forms/my_form.rb
@@ -57,17 +79,17 @@ end
 # app/controllers/items_controller.rb
 
 def new
-  @form_options = MyForm.form_options(company: current_company)
+  @form = 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
+= f.select :category, collection: @form[:categories]
+= f.select :country, collection: @form[:countries]
+= f.text_field :email, required: @form.required?(:email) # true
+= f.text_field :name, required: @form.required?(:name) # false
 ```
 
 ### Readymade::InstantForm
@@ -80,11 +102,46 @@ Readymade::InstantForm.new(my_params, permitted: %i[name phone], required: %i[em
 
 ### Readymade::Action
 
-```TODO: add```
+```ruby
+class Orders::Actions::SendNotifications < Readymade::Action
+  def call
+    send_email
+    send_push
+    send_slack
+
+    response(:success, record: record, any_other_data: data)
+  end
+end
+```
+
+```ruby
+response = Orders::Actions::SendNotifications.call(order: order)
+
+response.fail? # false
+response.success? # true
+response.data[:record]
+response.data[:any_other_data]
+```
 
 ### Readymade::Operation
 
-```TODO: add```
+Provides set of help methods like: `build_form`, `form_valid?`, `validation_fail`, `save_record`, etc.
+```ruby
+class Orders::Operations::Create < Readymade::Operation
+  def call
+    build_record
+    build_form
+    return validation_fail unless form_valid?
+
+    assign_attributes
+    return validation_fail unless record_valid?
+
+    save_record
+
+    success(record: record)
+  end
+end
+```
 
 
 ## Development

data/lib/readymade/form.rb

@@ -147,21 +147,19 @@ module Readymade
 
     # EXAMPLE
     # class Items::Forms::Create::Value < ::Readymade::Form
-    #   PERMITTED_ATTRIBUTES = %i[attr1 attr2].freeze
-    #   REQUIRED_ATTRIBUTES = %i[attr1].freeze
+    #   PERMITTED_ATTRIBUTES = %i[vat_percent price_type item_category].freeze
+    #   REQUIRED_ATTRIBUTES = %i[item_category].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
+    #   def form_options
+    #     {
+    #       vat_percent: Item::VAT_OPTIONS,
+    #       price_type: Item.price_types.keys,
+    #       item_category: args[:company].item_categories
+    #     }
     #   end
 
-    # @form_options = Items::Forms::Create::Value.new(company: current_company)
-    # f.association :item_category, collection: @form_options[:item_category]
+    # @form = Items::Forms::Create.form_options(company: current_company)
+    # f.association :item_category, collection: @form[:item_category], required: @form.required?(:item_category)
 
     def self.form_options(**args)
       Readymade::Form::FormOptions.new(**args.merge!(form_class: self))

data/lib/readymade/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readymade
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - OrestF
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-15 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug