active_dry_form 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c28b3e63865ce1e56a06a1e544e0bff16ed8404539ff57825ce34e529b1eae1
-  data.tar.gz: d470fc5ba86f63a5ba48b9355468b958c82f8f08f83182e455930c3f9c1dd3b7
+  metadata.gz: a1bc39aacc5e7a40501a20eeadc515470220ba16439fa8c92c31bdf85f330103
+  data.tar.gz: 14f34c96e37c815f85c2adfee658e2fcf5801c92d8a17574f8f620ff90ab3159
 SHA512:
-  metadata.gz: 11c27d50c4bf87a26ac9c9e1901e8961674fdd871f5cf7f3669eb44d3cdadb7f3bc6443690a26a6bee6a5866416f9854b22e9a8e34dd2731a81b81b16f31571d
-  data.tar.gz: 530b8d0416ad67c9b5db3080b44d348b7b9336723134499290b484ab245f46b9634b11f32a574f01c65069de86623214a723b70a9e19e4e1e1e3eb920a15fa7f
+  metadata.gz: 295333f32cd4a66a5e8dc30953af57b527370abbb808d7f668bafd13ee1f256976245f4ba1db7bf8288caa5ba5f92ddaab6f32d085f285bfe1d7599652cd67c3
+  data.tar.gz: 96e147d7df5450147c17722c8867cdd7836108f91c274f1b6e660857c2742c52942fc9de10744cdde5fc9da8ba3a2817f4ae03242d00f91b5a5644672af000ad

data/.rubocop.yml

@@ -1,3 +1,20 @@
 inherit_gem:
   rubocop-gp:
-    - ./config/default.yml
+    - ./config/default.yml
+
+Gp/OptArgParameters:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Exclude:
+    - lib/active_dry_form/builder.rb
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Rails/Delegate:
+  Enabled: false
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.2

data/Gemfile

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in active_dry_form.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'dry-schema', github: 'dry-rb/dry-schema'
 
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+
+gem 'sqlite3', '~> 1.4'
 
 gem 'rubocop-gp', github: 'corp-gp/rubocop-gp', require: false

data/Gemfile.lock

@@ -0,0 +1,212 @@
+GIT
+  remote: https://github.com/corp-gp/rubocop-gp.git
+  revision: e5bd900ce4b10077cf8f4ae88a5a6e32e7861b65
+  specs:
+    rubocop-gp (0.0.4)
+      rubocop
+      rubocop-capybara
+      rubocop-factory_bot
+      rubocop-performance
+      rubocop-rails
+      rubocop-rspec
+      rubocop-rspec_rails
+
+GIT
+  remote: https://github.com/dry-rb/dry-schema.git
+  revision: ced2c60aef958eb7f9b2fa0057540249f1ec4e20
+  specs:
+    dry-schema (1.13.4)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-logic (>= 1.4, < 2)
+      dry-types (>= 1.7, < 2)
+      zeitwerk (~> 2.6)
+
+PATH
+  remote: .
+  specs:
+    active_dry_form (0.1.0)
+      actionpack
+      activerecord
+      dry-configurable
+      dry-monads
+      dry-validation
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activemodel (7.1.3.4)
+      activesupport (= 7.1.3.4)
+    activerecord (7.1.3.4)
+      activemodel (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      timeout (>= 0.4.0)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    dry-configurable (1.2.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.1.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-monads (1.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.2)
+      bigdecimal (~> 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    dry-validation (1.10.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-schema (>= 1.12, < 2)
+      zeitwerk (~> 2.6)
+    erubi (1.13.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.24.1)
+    mutex_m (0.2.0)
+    nokogiri (1.16.6-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.6-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.0)
+    rack (3.1.6)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.1)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.25.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (3.0.2)
+      rubocop (~> 1.61)
+    rubocop-rspec_rails (2.30.0)
+      rubocop (~> 1.61)
+      rubocop-rspec (~> 3, >= 3.0.1)
+    ruby-progressbar (1.13.0)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
+    strscan (3.1.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    zeitwerk (2.6.16)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  active_dry_form!
+  dry-schema!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop-gp!
+  sqlite3 (~> 1.4)
+
+BUNDLED WITH
+   2.4.6

data/README.md

@@ -1,9 +1,4 @@
 # ActiveDryForm
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_dry_form`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -11,18 +6,280 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'active_dry_form'
 ```
+---
+
+### Under the hood ActiveDryForm uses [dry-validation](https://dry-rb.org/gems/dry-validation), [dry-monads](https://dry-rb.org/gems/dry-monads)
+
+#### Initialize form
+```ruby
+ProductForm.new(params: { title: 'n', price: '120' })
+ProductForm.new(params: { product: { title: 'n', price: '120' } })
+ProductForm.new(record: Product.find(params[:id]), params:)
+```
+
+#### Attribute accessors
+```ruby
+form.title # => 'n'
+form.price # => '120'
+form.price = '119' # => '119'
+form[:price] # => '119'
+form[:price] = '121' # => '121'
+```
+
+#### Methods
+```ruby
+form.validate # => checks field validity
+form.validator # => #<Dry::Validation::Result{:title=>"n", :price=>120, errors={:title=>["minimum length 2"]}...>
+form.valid? # => false
+form.persisted? # => true
+form.errors # => {:title=>["minimum length 2"]}
+form.base_errors = []
+form.errors_full_messages # => ['Cannot be less than 2 words']
+form.record # => #<Product:0x00007f05c27106c8 id: 1, title: 'name', price: 100, description: 'product'>
+# form.data - is hash, casted to types, after validate
+form.data # => {:title=>"n", :price=>120}
+form.data[:price] # => 120
+form.update # Failure(:invalid_form)
+```
+
+
+
+Methods `form.update` and `form.create` return [Result monad](https://dry-rb.org/gems/dry-monads/1.3/result/)
+
+```ruby
+# app/forms/product_form.rb
+
+class ProductForm < Form
+  fields :product do
+    params do
+      required(:title).filled(:string, min_size?: 2)
+      required(:price).filled(:integer)
+      optional(:description).maybe(:string)
+      optional(:upload_attachments).maybe(:array)
+    end
+
+    rule(:description) do
+      key.failure('Cannot be less than 2 words') if value.split.size < 2
+    end
+  end
+
+  action def update
+    # Here you can implement any save logic
+
+    record.update!(data)
+    Success(record)
+  end
+
+end
+```
+
+In your controller
+
+```ruby
+class ProductsController < ApplicationController
+  include Dry::Monads[:result]
+
+  def new
+    @form = ProductForm.new
+  end
+
+  def create # without monads
+    @form = ProductForm.new(params:)
+    @form.validate
+
+    if @form.valid?
+      Product.create!(@form)
+
+      redirect_to products_path
+    else
+      render :new
+    end
+  end
+
+  def edit
+    @form = ProductForm.new(record:)
+  end
+
+  def update # with monads
+    @form = ProductForm.new(record:, params:)
+
+    case @form.update
+    in Success(product)
+      redirect_to product
+    else
+      render :edit
+    end
+  end
+
+  private def record = Product.find(params[:id])
+end
+```
+
+in your view (slim for example)
+
+```slim
+/ app/views/products/new.slim
+
+- active_dry_form_for @form do |f|
+  = f.input :title
+  = f.input :price
+  = f.input_select :status, Product::STATUSES.values
+  = f.input_file :upload_attachments, multiple: true, label: false
+  = f.button 'Submit'
+```
+
+### Fill attributes init values
+
+In your controller
+
+```ruby
+def new
+  @form = ProductForm.new(params: { title: 'name', price: 120 })
+  @form.attributes = { title: 'new name', price: 100 }
+  @form.description = 'product description'
+end
+```
 
-And then execute:
+or like this
 
-    $ bundle install
+```ruby
+def new
+  @form = ProductForm.new
+  @form.create_default(params[:title])
 
-Or install it yourself as:
+  # class ProductForm < Form
+  #   ...
+  #   def create_default(title)
+  #     self.title = title
+  #   end
+  # end
+end
+```
 
-    $ gem install active_dry_form
+### Inputs
 
-## Usage
+`Inputs` under the hood uses [standard rails builder form methods](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-text_area), and you can use it on form.
 
-TODO: Write usage instructions here
+[input](https://github.com/corp-gp/active_dry_form/blob/master/lib/active_dry_form/builder.rb#L97) method automatically determines tag type:
+
+- by [dry type predicates](https://dry-rb.org/gems/dry-schema/main/basics/built-in-predicates/) - date, time, integer, number, string, boolean
+- by field name - password, email, telephone, url
+
+```slim
+- active_dry_form_for @form, html: { 'data-controller': 'product'} do |f|
+  = f.input :title, 'data-product-target': 'title', readonly: true,
+  = f.show_error(:title)
+  = f.input_select :category_id, Category.pluck(:name, :id),
+    { include_blank: true },
+    { label: false, multiple: true, style: 'max-width:unset;'}
+  = f.input_check_box :is_discount
+  = f.input_check_box_inline :is_sale
+  = f.input_text :shipper_name
+  = f.input_text_area :description
+  = f.input_hidden :admin_id
+  = f.input_file :upload_attachments, multiple: true, label: false
+  = f.input_date :date
+  = f.input_datetime :date_time
+  = f.input_integer :category_id
+  = f.input_number :number
+  = f.input_password :password
+  = f.input_email :email
+  = f.input_url :url
+  = f.input_telephone :telephone
+
+  // standard rails builder form methods
+  = f.label :name
+  = f.search_field :name
+
+  = f.button 'Submit'
+```
+
+### Create custom `input`
+
+```ruby
+# lib/acitve_dry_form/builder.rb
+
+module ActiveDryForm
+  class Builder
+
+    def input_date_native(field, options = {})
+      wrap_input(__method__, field, options) { |opts| date_field(field, opts) }
+    end
+
+  end
+end
+```
+
+### The form can be nested
+
+```ruby
+class NestedDryForm < Form
+
+  class BookmarkForm < Form
+    fields(:bookmark) do
+      params do
+        required(:url).filled(:string)
+        optional(:id).maybe(:integer)
+        optional(:name).maybe(:string)
+      end
+    end
+  end
+
+  fields :product do
+    params do
+      required(:title).filled(:string, min_size?: 2)
+      required(:price).filled(:integer)
+      optional(:description).maybe(:string)
+      optional(:upload_attachments).maybe(:array)
+      optional(:bookmarks).array(Dry.Types.Constructor(BookmarkForm) { |params| BookmarkForm.new(params: params) })
+    end
+  end
+
+  action def update
+    bookmarks_data = data.delete(:bookmarks)
+
+    record.attributes = data
+    record.bookmarks_attributes = bookmarks_data if bookmarks_data
+    record.save!
+
+    Success(record)
+  end
+
+end
+```
+
+As you noticed in the above example, we use the construction `Dry.Types.Constructor(BookmarkForm) { |params| BookmarkForm.new(params: params) }`,
+what it is `dry types` you can find out [here](https://dry-rb.org/gems/dry-types)
+
+
+### Internationalization
+By default, uses `i18n_key` from `fields(:user)`, but you can set a custom key using `fields(:profile, i18n_key: :user)`.
+
+Using standard rails i18n path:
+
+[helpers.label](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-label)
+
+```yml
+ru:
+  helpers:
+    label:
+      user:
+        id: Идентификатор
+        name: Имя
+```
+
+or [translations for your model attribute names](https://api.rubyonrails.org/classes/ActiveModel/Translation.html#method-i-human_attribute_name)
+
+```yml
+ru:
+  activerecord:
+    attributes:
+      user:
+        id: Идентификатор
+        name: Имя
+```
+
+---
 
 ## Development
 
@@ -30,10 +287,14 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+---
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_dry_form.
 
+---
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/config/locales/dry_validation.ru.yml

@@ -0,0 +1,62 @@
+ru:
+  dry_validation:
+    or: "или"
+
+    errors:
+      not_format?: 'не соответствует формату'
+      array?: 'должно быть массивом'
+      empty?: 'должно быть пустым'
+      excludes?: 'не должно содержать %{value}'
+      excluded_from?:
+        arg:
+          default: 'не должно быть одним из: %{list}'
+          range: 'не должно быть одним из: %{list_left} - %{list_right}'
+      exclusion?: 'не должно быть одним из: %{list}'
+      eql?: 'должно быть равным %{left}'
+      not_eql?: 'не должно быть равным %{left}'
+      filled?: 'должно быть заполнено'
+      format?: 'имеет недопустимый формат'
+      number?: 'должно быть числом'
+      odd?: 'должно быть нечётным'
+      even?: 'должно быть чётным'
+      gt?: 'должно быть больше %{num}'
+      gteq?: 'должно быть больше или равным %{num}'
+      hash?: 'должно быть хешем'
+      included_in?:
+        arg:
+          default: 'должно быть выбрано из списка'
+          range: 'должно быть одним из: %{list_left} - %{list_right}'
+      inclusion?: 'должно быть одним из: %{list}'
+      includes?: 'должно содержать %{value}'
+      bool?: 'должно быть булевым'
+      true?: 'должно быть истинным'
+      false?: 'должно быть false'
+      int?: 'должно быть целым числом'
+      float?: 'должно быть числом с плавающей точкой одинарной точности'
+      decimal?: 'должно быть числом с плавающей точкой расширенной точности'
+      date?: 'должно быть датой'
+      date_time?: 'должно быть датой и временем'
+      time?: 'должно быть временем'
+      key?: 'отсутствует'
+      attr?: 'отсутствует'
+      lt?: 'должно быть меньше %{num}'
+      lteq?: 'должно быть меньше или равным %{num}'
+      max_size?: 'максимальная длинна %{num}'
+      min_size?: 'минимальная длинна %{num}'
+      none?: 'не может быть определён'
+      str?: 'должно быть строкой'
+      type?: 'должно иметь тип %{type}'
+      size?:
+        arg:
+          default: 'размер должно быть %{size}'
+          range: 'размер должно быть от %{size_left} до %{size_right}'
+        value:
+          string:
+            arg:
+              default: 'длина должна быть %{size}'
+              range: 'длина должна быть от %{size_left} до %{size_right}'
+      valid?: 'неверное значение'
+
+      rules:
+        name:
+          ivan_cant_be_maria: 'Иван не может стать Марией'

data/lib/active_dry_form/base_contract.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ActiveDryForm
+  class BaseContract < Dry::Validation::Contract
+
+    config.messages.load_paths << 'config/locales/dry_validation.ru.yml'
+    config.messages.default_locale = :ru
+
+  end
+end