view_component-form 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 869789c616058368805d6dba5564a79c4e2ddb9fe85919721a052da761d34e91
-  data.tar.gz: 58b02a2e260e61a97386e41d0c891d5aee3344ca4b5c6aebe3fb1f00514b75f4
+  metadata.gz: 85efb54495b971620e090764d16af0253225b448f47cd65e688e45d5b156ff2d
+  data.tar.gz: ba85d7de360b93c16e1c74868169c82e555290b0d783427a77e61cad46e9b129
 SHA512:
-  metadata.gz: 82b77433712fbe3b1453d6dceebaa02bb01be4deba4ddcab28e97b1fe60667feacfaf50cc0d8cf2dcecc18db83738ae5a07441255db4728fcfe8420ef4340d86
-  data.tar.gz: 2c08a19fa894929aaeb2a03afa0bd666fa05e9f63bed5e85671f74d32190d2a3d45f58c761a7da1bad2eb20744c7e498da3a9a6c2dcb40f9ba3c15e5afdcb967
+  metadata.gz: 1cb013fe12f393f641faa269d38268f5bd3a3c959078c33b5266c0612c1f046d24a2354e3b8b1dbf4d635cd8cfdb0da9d455b3fd1b4bd6aac2456cdd9a44316e
+  data.tar.gz: 44c37beaaed85850e70819cd0b6df1f7f14ce6edb79e334f3fcdc4f2b232e78374f9463b4f8ad84047689f1a46e08dcf9a392a1d788f7a19228efdfbe04e2ee2

data/CHANGELOG.md

@@ -5,6 +5,28 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+Nothing yet
+
+## [0.1.2] - 2021-12-07
+### Added
+- Add missing component specs (#75)
+- Add missing builder specs for return values (#76)
+- Add accurate test cases for all helpers from ActionView::Helpers::FormBuilder
+  documentation (#85)
+
+### Changed
+- Cross-documented Rails form helpers (#84)
+- Made tag_klass optional when inheriting from a component class (#87)
+- Improve README: generator, html_class example (#88)
+- Make rails version condition used the same way (#92)
+- Add rails 7.0 and make rails head works (#94)
+- Allow `Base` and `FieldComponent` to support forms without objects (#95)
+
+### Fixed
+- Fix `phone_field` helper (#74)
+- Fix `datetime_local_field` helper (#76)
+- Fix `time_zone_select` helper (#76)
+- Resolve Rails 6.1 deprecation on ActiveModel::Errors#keys call (#91)
 
 ## [0.1.1] - 2021-09-27
 
@@ -17,7 +39,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.1.0] - 2021-09-16
 
 ### Added
-
 - `FormBuilder`: add `.namespace` method to allow local lookup of components (#54)
 - Add basic `ViewComponent::Form::Builder` that can be used in place of Rails' `ActionView::Helpers::FormBuilder` (#1)
 - Add all standard FormBuilder helpers provided by Rails, implemented as ViewComponents (#4)
@@ -25,6 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add CHANGELOG (#50)
 - Add CI (#2)
 
-[Unreleased]: https://github.com/pantographe/view_component-form/compare/v0.1.1...HEAD
+[Unreleased]: https://github.com/pantographe/view_component-form/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/pantographe/view_component-form/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/pantographe/view_component-form/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/pantographe/view_component-form/releases/tag/v0.1.0

data/README.md

@@ -24,7 +24,7 @@ And then execute:
 
 ## Usage
 
-Add a `builder` param to your `form_for` of `form_with`:
+Add a `builder` param to your `form_for`, `form_with`, `fields_for` or `fields`:
 
 ```diff
 - <%= form_for @user do |f| %>
@@ -64,10 +64,10 @@ It should work out of the box, but does nothing particularly interesting for now
 
   <label for="user_last_name">Last name</label>
   <input type="text" value="Doe" name="user[last_name]" id="user_last_name" />
-  
+
   <label for="user_email">E-mail</label>
   <input type="email" value="john.doe@example.com" name="user[email]" id="user_email" />
-  
+
   <label for="user_password">Password</label>
   <input type="password" name="user[password]" id="user_password" />
 </form>
@@ -91,14 +91,14 @@ This allows you to pick the namespace your components will be loaded from.
 # lib/custom_form_builder.rb
 class CustomFormBuilder < ViewComponent::Form::Builder
   # Set the namespace you want to use for your own components
-  namespace Form
+  namespace Custom::Form
 end
 ```
 
-You can change the default namespace and path:
+Use the generator options to change the default namespace or the path where the file will be created:
 
 ```console
-bin/rails generate vcf:builder AnotherCustomFormBuilder --namespace Forms::Components --path app/forms
+bin/rails generate vcf:builder AnotherCustomFormBuilder --namespace AnotherCustom::Form --path app/forms
 
       create  app/forms/another_custom_form_builder.rb
 ```
@@ -107,23 +107,22 @@ bin/rails generate vcf:builder AnotherCustomFormBuilder --namespace Forms::Compo
 # app/forms/another_custom_form_builder.rb
 class AnotherCustomFormBuilder < ViewComponent::Form::Builder
   # Set the namespace you want to use for your own components
-  namespace Forms::Components
+  namespace AnotherCustom::Form
 end
 ```
 
-:warning: **Everything below this line describes the future usage and is subject to change. It does not work yet as the gem is still under heavy development.**
-
-Now let's generate your own components to customize the rendering.
+Now let's generate your own components to customize their rendering. We can use the standard view_component generator:
 
 ```console
-bin/rails generate vcf:component Form::TextField
+bin/rails generate component Custom::Form::TextField --inline --parent ViewComponent::Form::TextFieldComponent
 
       invoke  test_unit
-      create  test/components/form/text_field_component_test.rb
-      create  app/components/form/text_field_component.rb
-      create  app/components/form/text_field_component.html.erb
+      create  test/components/custom/form/text_field_component_test.rb
+      create  app/components/custom/form/text_field_component.rb
 ```
 
+:warning: The `--parent` option is available since ViewComponent [`v2.41.0`](https://viewcomponent.org/CHANGELOG.html#2410). If you're using a previous version, you can always edit the generated `Custom::Form::CustomTextFieldComponent` class to make it inherit from `ViewComponent::Form::TextFieldComponent`.
+
 Change your forms to use your new builder:
 
 ```diff
@@ -131,26 +130,43 @@ Change your forms to use your new builder:
 + <%= form_for @user, builder: CustomFormBuilder do |f| %>
 ```
 
-You can then customize the behavior of your `Form::TextFieldComponent`:
+You can then customize the behavior of your `Custom::Form::CustomTextFieldComponent`:
 
 ```rb
-# app/components/form/text_field_component.rb
+# app/components/custom/form/text_field_component.rb
 
-module Form
-  class TextFieldComponent < ViewComponent::Form::TextFieldComponent
-    def html_class
-      class_names("text-field", "border-error": method_errors?)
-    end
+class Admin::Form::TextFieldComponent < ViewComponent::Form::TextFieldComponent
+  def html_class
+    class_names("custom-text-field", "has-error": method_errors?)
   end
 end
 ```
 
-The generated form field with now have your class names:
+In this case we leverage the [`#class_names`](https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-class_names) helper to:
+- always add the `custom-text-field` class;
+- add the `has-error` class if there is an error on the attribute (using `ViewComponent::Form::FieldComponent#method_errors?`).
+
+The rendered form field will now look like this:
 
 ```html
-<input class="text-field" type="text" value="John" name="user[first_name]" id="user_first_name">
+<input class="custom-text-field" type="text" value="John" name="user[first_name]" id="user_first_name">
 ```
 
+You can use the same approach to inject options, wrap the input in a `<div>`, etc.
+
+We'll add more use cases to the documentation soon.
+
+### Using your form components without a backing model
+
+If you want to ensure that your fields display consistently across your app, you'll need to lean on Rails' own helpers. You may be used to using form tag helpers such as `text_field_tag` to generate tags, or even writing out plain HTML tags. These can't be integrated with a form builder, so they won't offer you the benefits of this gem.
+
+You'll most likely want to use either:
+
+- [`form_with`](https://api.rubyonrails.org/v6.1.4/classes/ActionView/Helpers/FormHelper.html#method-i-form_with) and supply a route as the endpoint, e.g. `form_with url: users_path do |f| ...`, or
+- [`fields`](https://api.rubyonrails.org/v6.1.4/classes/ActionView/Helpers/FormHelper.html#method-i-fields), supplying a namespace if necessary. `fields do |f| ...` ought to work in the most basic case.
+
+[`fields_for`](https://api.rubyonrails.org/v6.1.4/classes/ActionView/Helpers/FormHelper.html#method-i-fields_for) may also be of interest. To make consistent use of `view_component-form`, you'll want to be using these three helpers to build your forms wherever possible.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/app/components/view_component/form/base_component.rb

@@ -14,8 +14,8 @@ module ViewComponent
 
       attr_reader :form, :object_name, :options
 
-      delegate :object, to: :form
-      delegate :errors, to: :object, prefix: true
+      delegate :object, to: :form, allow_nil: true
+      delegate :errors, to: :object, prefix: true, allow_nil: true
 
       def initialize(form, object_name, options = {})
         @form = form
@@ -28,6 +28,8 @@ module ViewComponent
       end
 
       def object_errors?
+        return false unless object
+
         object.errors.any?
       end
 

data/app/components/view_component/form/field_component.rb

@@ -3,9 +3,8 @@
 module ViewComponent
   module Form
     class FieldComponent < BaseComponent
-      class << self
-        attr_accessor :tag_klass
-      end
+      class_attribute :tag_klass, instance_reader: false, instance_writer: false, instance_accessor: false,
+                                  instance_predicate: false
 
       attr_reader :method_name
 
@@ -31,8 +30,18 @@ module ViewComponent
                                         .map(&:upcase_first)
       end
 
-      def method_errors?
-        (object_errors.keys & object_method_names).any?
+      if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new("6.1")
+        def method_errors?
+          return false unless object_errors
+
+          (object_errors.attribute_names & object_method_names).any?
+        end
+      else
+        def method_errors?
+          return false unless object_errors
+
+          (object_errors.keys & object_method_names).any?
+        end
       end
 
       def value

data/lib/view_component/form/builder.rb

@@ -35,7 +35,18 @@ module ViewComponent
         super
       end
 
-      (field_helpers - %i[label check_box radio_button fields_for fields hidden_field file_field]).each do |selector|
+      (field_helpers - %i[
+        check_box
+        datetime_field
+        datetime_local_field
+        fields
+        fields_for
+        file_field
+        hidden_field
+        label
+        phone_field
+        radio_button
+      ]).each do |selector|
         class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
           def #{selector}(method, options = {}) # def text_field(method, options = {})
             render_component(                   #   render_component(
@@ -47,12 +58,20 @@ module ViewComponent
           end                                   # end
         RUBY_EVAL
       end
+      alias phone_field telephone_field
 
       # See: https://github.com/rails/rails/blob/33d60cb02dcac26d037332410eabaeeb0bdc384c/actionview/lib/action_view/helpers/form_helper.rb#L2280
       def label(method, text = nil, options = {}, &block)
         render_component(:label, @object_name, method, text, objectify_options(options), &block)
       end
 
+      def datetime_field(method, options = {})
+        render_component(
+          :datetime_local_field, @object_name, method, objectify_options(options)
+        )
+      end
+      alias datetime_locale_field datetime_field
+
       def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
         render_component(
           :check_box, @object_name, method, checked_value, unchecked_value, objectify_options(options)
@@ -88,18 +107,6 @@ module ViewComponent
         render_component(:button, value, options, &block)
       end
 
-      # SELECTORS.each do |selector|
-      #   class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
-      #     def #{selector}(*args)
-      #       render_component(
-      #         :#{selector},
-      #         *args,
-      #         super,
-      #       )
-      #     end
-      #   RUBY_EVAL
-      # end
-
       # See: https://github.com/rails/rails/blob/fe76a95b0d252a2d7c25e69498b720c96b243ea2/actionview/lib/action_view/helpers/form_options_helper.rb
       def select(method, choices = nil, options = {}, html_options = {}, &block)
         render_component(
@@ -169,9 +176,9 @@ module ViewComponent
         )
       end
 
-      def time_zone_select(method, options = {}, html_options = {})
+      def time_zone_select(method, priority_zones = nil, options = {}, html_options = {})
         render_component(
-          :time_zone_select, @object_name, method,
+          :time_zone_select, @object_name, method, priority_zones,
           objectify_options(options), @default_html_options.merge(html_options)
         )
       end

data/lib/view_component/form/class_names_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # Backport of https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-class_names
+# :nocov:
 module ViewComponent
   module Form
     module ClassNamesHelper
@@ -35,3 +36,4 @@ module ViewComponent
     end
   end
 end
+# :nocov:

data/lib/view_component/form/test_helpers.rb

@@ -7,20 +7,24 @@ require "action_view"
 module ViewComponent
   module Form
     module TestHelpers
-      def form_with(object, options = {})
-        ViewComponent::Form::Builder.new(object_name, object, template, options)
+      def form_with(object, builder: ViewComponent::Form::Builder, **options)
+        builder.new(object_name, object, template, options)
       end
 
       def object_name
         :user
       end
 
-      def template
-        lookup_context = ActionView::LookupContext.new(ActionController::Base.view_paths)
+      if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new("6.1")
+        def template
+          lookup_context = ActionView::LookupContext.new(ActionController::Base.view_paths)
 
-        if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new("6.1")
           ActionView::Base.new(lookup_context, {}, ApplicationController.new)
-        else
+        end
+      else
+        def template
+          lookup_context = ActionView::LookupContext.new(ActionController::Base.view_paths)
+
           ActionView::Base.new(lookup_context, {})
         end
       end

data/lib/view_component/form/version.rb

@@ -2,6 +2,6 @@
 
 module ViewComponent
   module Form
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component-form
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Pantographe
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -89,7 +89,6 @@ files:
 - app/components/view_component/form/color_field_component.rb
 - app/components/view_component/form/date_field_component.rb
 - app/components/view_component/form/date_select_component.rb
-- app/components/view_component/form/datetime_field_component.rb
 - app/components/view_component/form/datetime_local_field_component.rb
 - app/components/view_component/form/datetime_select_component.rb
 - app/components/view_component/form/email_field_component.rb
@@ -130,7 +129,8 @@ metadata:
   changelog_uri: https://github.com/pantographe/view_component-form/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/pantographe/view_component-form
   bug_tracker_uri: https://github.com/pantographe/view_component-form/issues
-post_install_message:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -145,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
-signing_key:
+rubygems_version: 3.2.9
+signing_key: 
 specification_version: 4
 summary: Rails FormBuilder for ViewComponent
 test_files: []

data/app/components/view_component/form/datetime_field_component.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module Form
-    class DatetimeFieldComponent < FieldComponent
-      self.tag_klass = ActionView::Helpers::Tags::DatetimeField
-    end
-  end
-end