vcfb 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbb45046003eb60f818dab6f8f6840fd2db12448638b6e0bbf037febe7eb1181
-  data.tar.gz: 848611876927e81bb4a7d6aa83e56e4748c65b400e8883a34b97abfc8b994a9c
+  metadata.gz: fd3eb37042a40675e814d4e61c8e0bcf936fccb3c6cd369a414a10673c18a078
+  data.tar.gz: dd354e2c1d69a1741be37082fd0ef42493682aef40359585a81cdded912a844f
 SHA512:
-  metadata.gz: 67b3d105c6dd5f46531bd9662fb0d90b1a7ccaca8d861cb617d1fbb8999eb9a4772a9aa113fa6f1bf6733f6697e1a468247cbab55a113f5de14914e6cc5be079
-  data.tar.gz: c38374b0aa001bbfb897b0587eded3bd085b33f404ca415775f206ef37bd8b0fdc33367bad3c8851754d34bce28f6593a524a13b0a37503237ec58f5c0d2f138
+  metadata.gz: 05e18ffca6448e16faf4f1095ac3a0e37cc4debabafd722a9ef23c842e9003a16db65c62ca15ac2d15817a038d72ff250df860b03af13711717ff95f7192ccb6
+  data.tar.gz: 3eef3ba08063ef5727532272275fd0f4388e571def0d284349f25e1d08ca03ed22099ed12e70e52a73c0c4246dfbaab702676e5b3c07758ddd431a8dad728852

data/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 -
 
+## 2.1.0
+
+- Removed support for Ruby 2.7.
+
+## 2.0.2
+
+- Support for ViewComponent 2.61.0.
+
 ## 2.0.1
 
 - Restore usage of tag options gem if present.

data/README.md

@@ -1,5 +1,7 @@
 # VCFB
 
+[![Test](https://github.com/wamonroe/vcfb/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/wamonroe/vcfb/actions/workflows/test.yml)
+
 > FormBuilder for Rails using ViewComponent
 
 VCFB provides a `FormBuilder` for use with
@@ -9,8 +11,16 @@ with the goal to make it easy to apply styling and other formatting within a
 component's `.html.erb` file (rather than in Ruby code).
 
 To further support this goal, if the application includes the
-[TagOptions](https://github.com/wamonroe/tag_options) gem, the `vcfb:components`
-will make use of it when saving `options` and `html_options` hashes.
+[TagOptions](https://github.com/wamonroe/tag_options) gem, `VCFB` will make use
+of it when initializing `@options` and `@html_options` hashes.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Getting Started](#getting-started)
+- [Settings](#settings)
+- [Styling Components with TagOptions](#styling-components-with-tagoptions)
+- [Development](#development)
 
 ## Installation
 
@@ -26,7 +36,7 @@ And then execute:
 bundle install
 ```
 
-## Usage
+## Getting Started
 
 Generate a set components to use with VCFB::FormBuilder
 
@@ -35,8 +45,14 @@ rails generate vcfb:components
 ```
 
 The generator will install view components for ALL of the form elements
-supported by the version of Rails installed. By default, all of the components
-will be namespaced in `module Form`.
+supported by the version of Rails installed, including a component to generate
+the form itself. By default, all of the components will be namespaced in `module Form`.
+
+`VCFB::FormBuilder` with its default set of components renders form elements
+functionaly identical to the the built-in Rails tag helpers. If, however, you
+don't need or want to render certain form elements using a component it is safe
+to delete the unused ones. `VCFB::FormBuilder` will fall back to rendering using
+the built-in Rails tag helpers if a component for that element doesn't exist.
 
 To generate components in a different namespace, use the `--namespace` option
 
@@ -54,17 +70,29 @@ class InlineFormBuilder < VCFB::FormBuilder
 end
 ```
 
-To render forms using the generated components, sepecify `VCFB::FormBuilder` or
-a class that inherits from it when using `form_with` or `form_for`.
+To render forms using the generated components, use the included
+`component_form_with` helper.
 
-```ruby
-<%= form_with model: @author, builder: VCFB::FormBuilder do |form| %>
+```erb
+<%= component_form_with model: @author do |form| %>
   <%= form.label :name %>
   <%= form.text_field :name %>
 <% end %>
 ```
 
-Generated components support `before_initialize`, `after_initialization`, and `around_initialize` callbacks to minimize the need to override the initlialize methods.
+If using a custom form builder inheriting from `VCFB::FormBuilder`, pass the
+`:builder` option to `component_form_with`.
+
+```erb
+<%= component_form_with model: @author, builder: InlineFormBuilder do |form| %>
+  <%= form.label :name %>
+  <%= form.text_field :name %>
+<% end %>
+```
+
+Generated components support `before_initialize`, `after_initialization`, and
+`around_initialize` callbacks to minimize the need to override the initlialize
+methods.
 
 ```ruby
 module Form
@@ -80,6 +108,8 @@ module Form
 end
 ```
 
+## Settings
+
 By default, components will inherit from `ApplicationComponent` if it exists or
 `ViewComponent::Base` if it does not. If you wish to change this behavior,
 generate an initializer and specify the `parent_component`.
@@ -94,6 +124,43 @@ VCFB.configure do |config|
 end
 ```
 
+## Styling Components with TagOptions
+
+> The examples below use `TagOptions::Hash` to make it easy to manipulate
+> options passed to generate the form elements. See
+> [TagOptions](https://github.com/wamonroe/tag_options) for more information
+> about the options available.
+
+For form elements, `VCFB` provides a `form_element` helper that will render
+the field, select, button, etc.
+
+The `button`, `check_box`, `label`, `radio_buton`, `rich_text_area`, `submit`,
+`text_area` and all the `*_field` elements are styled using only an `@options`
+hash.
+
+```erb
+<%# app/components/form/text_field/component.html.erb %>
+<%= form_element @options.at(:class).combine!("shadow-sm block border-gray-300 rounded-md") %>
+```
+
+The `collection_check_boxes`, `collection_radio_buttons`, `select`, and all of
+the `*_select` elements have an `@options`, but are styled with an
+`@html_options` hash.
+
+```erb
+<%# app/components/form/select/component.html.erb %>
+<%= form_element @options, @html_options.at(:class).combine!("shadow-sm block border-gray-300 rounded-md") %>
+```
+
+The main form element is rendered with a `form_tag` helper and is styled with an `@options` hash.
+
+```erb
+<%# app/components/form/component.html.erb %>
+<%= form_tag @options.at(:class).combine!("mt-8 space-y-6") do |form| %>
+  <%= content %>
+<% end %>
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
@@ -102,7 +169,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 - `bin/console` for an interactive prompt that will allow you to experiment
 - `bin/rubocop` to run RuboCop to check the code style and formatting
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
+To build this gem on your local machine, run `bundle exec rake build`. 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

data/lib/vcfb/component/base.rb

@@ -22,6 +22,19 @@ module VCFB
       def collection_radio_buttons(object, method, collection, value_method, text_method, options = {}, html_options = {}, &block)
         VCFB::Tags::CollectionRadioButtons.new(object, method, self, collection, value_method, text_method, options, html_options).render(&block)
       end
+
+      private
+
+      def deobjectify_options!(options)
+        if instance_variable_defined?(:@form)
+          keys = @form.send(:objectify_options, {}).keys
+          options.extract!(*keys)
+        elsif defined?(TagOptions::Hash)
+          TagOptions::Hash.new
+        else
+          {}
+        end
+      end
     end
   end
 end

data/lib/vcfb/component/base_collection.rb

@@ -4,6 +4,8 @@ module VCFB
       private
 
       def content
+        return unless instance_variable_defined?(:@builder)
+
         @__vc_content = if @view_context && @__vc_render_in_block
           view_context.capture(@builder, &@__vc_render_in_block)
         else

data/lib/vcfb/component/form.rb

@@ -8,7 +8,6 @@ module VCFB
           @url = url
           @format = format
           @options = defined?(TagOptions::Hash) ? TagOptions::Hash.new(options) : options
-          @form = nil
         end
       end
 
@@ -30,6 +29,8 @@ module VCFB
       # Override #content and #get_slot from ViewComponent so that we can yield
       # the form element (and not the component).
       def content
+        return unless instance_variable_defined?(:@form)
+
         if @view_context && @__vc_render_in_block
           @__vc_content = view_context.capture(@form, &@__vc_render_in_block)
         end

data/lib/vcfb/form_builder.rb

@@ -2,6 +2,8 @@ module VCFB
   class FormBuilder < ::ActionView::Helpers::FormBuilder
     class_attribute :namespace, instance_writer: false, default: "form"
 
+    delegate :resolve_component_class, to: "self.class"
+
     attr_reader :object, :object_name, :template
     attr_accessor :form_component
 
@@ -13,7 +15,7 @@ module VCFB
     # FORM COMPONENT
 
     def self.form_component_class
-      "#{namespace}/component".camelize.constantize
+      resolve_component_class
     end
 
     def self.form_component_defined?
@@ -22,6 +24,10 @@ module VCFB
       false
     end
 
+    def self.resolve_component_class(form_element = nil)
+      VCFB::Resolver.call(namespace, form_element)
+    end
+
     # SIMPLE FIELDS
 
     SIMPLE_FIELDS = %i[color_field date_field datetime_field email_field month_field number_field password_field
@@ -204,10 +210,6 @@ module VCFB
       end
     end
 
-    def resolve_component_class(form_element)
-      VCFB::Resolver.call(namespace, form_element)
-    end
-
     # SUPPORT FORM COMPONENT SLOTS
 
     def method_missing(method_name, *args, **opts, &block)

data/lib/vcfb/version.rb

@@ -1,3 +1,3 @@
 module VCFB
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vcfb
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Alex Monroe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 2023-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,7 +39,7 @@ dependencies:
         version: '2.35'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,80 +49,24 @@ dependencies:
         version: '2.35'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: combustion
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 description: FormBuilder for Rails using ViewComponent
 email:
-- alex.monroe@cofense.com
+- alex@monroepost.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -272,14 +216,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: FormBuilder for Rails using ViewComponent