vcfb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d279e150ad43b12161abe30108b84e3e4dc37f03b9fb2ee39245875e671e573
+  data.tar.gz: ba88556e3028d56d89d3359aaf006163fab1ae4f1665cd3e094b97175258918b
+SHA512:
+  metadata.gz: d0cc8de0c202e26745ec4442b8006681749717580c136769e9789ec308fc1efb76ca2f158fadba091ebf43a990f3532ae3bee6679c795c6da0f1c7f0dfb96dc7
+  data.tar.gz: 97a1b2840265b7b6fd773fa46e9bd45a77f929f5d25d157f1f92a4540bb98afe5013db3f3ec844b198c8b6382841926dc0872bd4cb0a9825a67219c3731eee14

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## Main
+
+-
+
+## 1.0.0
+
+- Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Alex Monroe
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# VCFB
+
+> FormBuilder for Rails using ViewComponent
+
+VCFB provides a `FormBuilder` for use with
+[ViewComponent](https://viewcomponent.org/). It was inspired by
+[ViewComponent::Form](https://github.com/pantographe/view_component-form), but
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "vcfb"
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+## Usage
+
+Generate a set components to use with VCFB::FormBuilder
+
+```sh
+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`.
+
+To generate components in a different namespace, use the `--namespace` option
+
+```sh
+rails generate vcfb:components --namespace inline_form
+```
+
+This will generate all the components under `module InlineForm`. To make use of
+these namespaced components, create a custom `FormBuilder` in your application
+inheriting from `VCFB::FormBuilder`.
+
+```ruby
+class InlineFormBuilder < VCFB::FormBuilder
+  self.namespace = "inline_form"
+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`.
+
+```ruby
+<%= form_with model: @author, builder: VCFB::FormBuilder do |form| %>
+  <%= form.label :name %>
+  <%= form.text_field :name %>
+<% end %>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/rspec` to run the tests. You can also 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
+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/wamonroe/vcfb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/generators/vcfb/components/USAGE.md

@@ -0,0 +1,74 @@
+Description:
+Creates a set of form components for use with VCFB::FormBuilder. You can
+optionally pass a namespace (defaults to "form") that the components will be
+generated under.
+
+Examples:
+`rails generate vcfb:components [--namespace NAMESPACE]`
+
+        Creates the following ViewComponents:
+
+            app/components/form/button/component.html.erb
+            app/components/form/button/component.rb
+            app/components/form/check_box/component.html.erb
+            app/components/form/check_box/component.rb
+            app/components/form/collection_check_boxes/component.html.erb
+            app/components/form/collection_check_boxes/component.rb
+            app/components/form/collection_radio_buttons/component.html.erb
+            app/components/form/collection_radio_buttons/component.rb
+            app/components/form/collection_select/component.html.erb
+            app/components/form/collection_select/component.rb
+            app/components/form/color_field/component.html.erb
+            app/components/form/color_field/component.rb
+            app/components/form/date_field/component.html.erb
+            app/components/form/date_field/component.rb
+            app/components/form/date_select/component.html.erb
+            app/components/form/date_select/component.rb
+            app/components/form/datetime_field/component.html.erb
+            app/components/form/datetime_field/component.rb
+            app/components/form/datetime_select/component.html.erb
+            app/components/form/datetime_select/component.rb
+            app/components/form/email_field/component.html.erb
+            app/components/form/email_field/component.rb
+            app/components/form/file_field/component.html.erb
+            app/components/form/file_field/component.rb
+            app/components/form/grouped_collection_select/component.html.erb
+            app/components/form/grouped_collection_select/component.rb
+            app/components/form/label/component.html.erb
+            app/components/form/label/component.rb
+            app/components/form/month_field/component.html.erb
+            app/components/form/month_field/component.rb
+            app/components/form/number_field/component.html.erb
+            app/components/form/number_field/component.rb
+            app/components/form/password_field/component.html.erb
+            app/components/form/password_field/component.rb
+            app/components/form/radio_button/component.html.erb
+            app/components/form/radio_button/component.rb
+            app/components/form/range_field/component.html.erb
+            app/components/form/range_field/component.rb
+            app/components/form/rich_text_area/component.html.erb
+            app/components/form/rich_text_area/component.rb
+            app/components/form/search_field/component.html.erb
+            app/components/form/search_field/component.rb
+            app/components/form/select/component.html.erb
+            app/components/form/select/component.rb
+            app/components/form/submit/component.html.erb
+            app/components/form/submit/component.rb
+            app/components/form/telephone_field/component.html.erb
+            app/components/form/telephone_field/component.rb
+            app/components/form/text_area/component.html.erb
+            app/components/form/text_area/component.rb
+            app/components/form/text_field/component.html.erb
+            app/components/form/text_field/component.rb
+            app/components/form/time_field/component.html.erb
+            app/components/form/time_field/component.rb
+            app/components/form/time_select/component.html.erb
+            app/components/form/time_select/component.rb
+            app/components/form/time_zone_select/component.html.erb
+            app/components/form/time_zone_select/component.rb
+            app/components/form/url_field/component.html.erb
+            app/components/form/url_field/component.rb
+            app/components/form/week_field/component.html.erb
+            app/components/form/week_field/component.rb
+            app/components/form/weekday_select/component.html.erb
+            app/components/form/weekday_select/component.rb"

data/lib/generators/vcfb/components/components_generator.rb

@@ -0,0 +1,172 @@
+require "active_support/core_ext/string/inflections"
+require "rails/generators/base"
+
+module Vcfb
+  class ComponentsGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    class_option :namespace, type: :string, default: "form"
+
+    def create_button_component
+      directory "button", "#{destination}/button"
+    end
+
+    def create_check_box_component
+      directory "check_box", "#{destination}/check_box"
+    end
+
+    def create_collection_check_boxes_component
+      directory "collection_check_boxes", "#{destination}/collection_check_boxes"
+    end
+
+    def create_collection_radio_buttons_component
+      directory "collection_radio_buttons", "#{destination}/collection_radio_buttons"
+    end
+
+    def create_collection_select_component
+      directory "collection_select", "#{destination}/collection_select"
+    end
+
+    def create_color_field_component
+      directory "color_field", "#{destination}/color_field"
+    end
+
+    def create_date_field_component
+      directory "date_field", "#{destination}/date_field"
+    end
+
+    def create_date_select_component
+      directory "date_select", "#{destination}/date_select"
+    end
+
+    def create_datetime_field_component
+      directory "datetime_field", "#{destination}/datetime_field"
+    end
+
+    def create_datetime_select_component
+      directory "datetime_select", "#{destination}/datetime_select"
+    end
+
+    def create_email_field_component
+      directory "email_field", "#{destination}/email_field"
+    end
+
+    def create_file_field_component
+      directory "file_field", "#{destination}/file_field"
+    end
+
+    def create_grouped_collection_select_component
+      directory "grouped_collection_select", "#{destination}/grouped_collection_select"
+    end
+
+    def create_label_component
+      directory "label", "#{destination}/label"
+    end
+
+    def create_month_field_component
+      directory "month_field", "#{destination}/month_field"
+    end
+
+    def create_number_field_component
+      directory "number_field", "#{destination}/number_field"
+    end
+
+    def create_password_field_component
+      directory "password_field", "#{destination}/password_field"
+    end
+
+    def create_radio_button_component
+      directory "radio_button", "#{destination}/radio_button"
+    end
+
+    def create_range_field_component
+      directory "range_field", "#{destination}/range_field"
+    end
+
+    def create_rich_text_area_component
+      directory "rich_text_area", "#{destination}/rich_text_area"
+    end
+
+    def create_search_field_component
+      directory "search_field", "#{destination}/search_field"
+    end
+
+    def create_select_component
+      directory "select", "#{destination}/select"
+    end
+
+    def create_submit_component
+      directory "submit", "#{destination}/submit"
+    end
+
+    def create_telephone_field_component
+      directory "telephone_field", "#{destination}/telephone_field"
+    end
+
+    def create_text_area_component
+      directory "text_area", "#{destination}/text_area"
+    end
+
+    def create_text_field_component
+      directory "text_field", "#{destination}/text_field"
+    end
+
+    def create_time_field_component
+      directory "time_field", "#{destination}/time_field"
+    end
+
+    def create_time_select_component
+      directory "time_select", "#{destination}/time_select"
+    end
+
+    def create_time_zone_select_component
+      directory "time_zone_select", "#{destination}/time_zone_select"
+    end
+
+    def create_url_field_component
+      directory "url_field", "#{destination}/url_field"
+    end
+
+    def create_week_field_component
+      directory "week_field", "#{destination}/week_field"
+    end
+
+    if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new("7.0")
+      def create_weekday_select_component
+        directory "weekday_select", "#{destination}/weekday_select"
+      end
+    end
+
+    private
+
+    def destination
+      if options[:skip_namespace]
+        "app/components"
+      else
+        "app/components/#{options[:namespace]}"
+      end
+    end
+
+    def module_namespacing(&block)
+      content = capture(&block)
+      content = wrap_with_namespace(content) unless options[:skip_namespace]
+      concat(content)
+    end
+
+    def wrap_with_namespace(content)
+      result = ""
+      indent = 0
+      namespace_parts = options[:namespace].split("/")
+      namespace_parts.each do |module_name|
+        result += indent("module #{module_name.camelize}\n", indent)
+        indent += 2
+      end
+      result += indent(content, indent)
+      namespace_parts.size.times do
+        indent -= 2
+        result += indent("end\n", indent)
+      end
+      result
+    end
+  end
+end

data/lib/generators/vcfb/components/templates/button/component.html.erb

@@ -0,0 +1,3 @@
+<%= form_element @options do %>
+  <%= content || @text %>
+<% end %>

data/lib/generators/vcfb/components/templates/button/component.rb.tt

@@ -0,0 +1,17 @@
+<% module_namespacing do -%>
+module Button
+  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
+    include VCFB::ActsAsFormComponent
+
+    def initialize(form, text = nil, options = {})
+      @form = form
+      @text = text
+      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
+    end
+
+    def form_element(options = {}, &block)
+      button_tag(options, &block)
+    end
+  end
+end
+<% end -%>

data/lib/generators/vcfb/components/templates/check_box/component.html.erb

@@ -0,0 +1 @@
+<%= form_element @options %>

data/lib/generators/vcfb/components/templates/check_box/component.rb.tt

@@ -0,0 +1,19 @@
+<% module_namespacing do -%>
+module CheckBox
+  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
+    include VCFB::ActsAsFormComponent
+
+    def initialize(form, method, options = {}, checked_value = "1", unchecked_value = "0")
+      @form = form
+      @method = method
+      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
+      @checked_value = checked_value
+      @unchecked_value = unchecked_value
+    end
+
+    def form_element(options = {})
+      check_box(@form.object_name, @method, options, @checked_value, @unchecked_value)
+    end
+  end
+end
+<% end -%>

data/lib/generators/vcfb/components/templates/collection_check_boxes/check_box/component.html.erb

@@ -0,0 +1 @@
+<%= form_element @options %>

data/lib/generators/vcfb/components/templates/collection_check_boxes/check_box/component.rb.tt

@@ -0,0 +1,21 @@
+<% module_namespacing do -%>
+module CollectionCheckBoxes
+  module CheckBox
+    class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
+      include VCFB::ActsAsFormComponent
+
+      def initialize(form, method, options = {}, checked_value = "1", unchecked_value = "0")
+        @form = form
+        @method = method
+        @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
+        @checked_value = checked_value
+        @unchecked_value = unchecked_value
+      end
+
+      def form_element(options = {})
+        check_box(@form.object_name, @method, options, @checked_value, @unchecked_value)
+      end
+    end
+  end
+end
+<% end -%>

data/lib/generators/vcfb/components/templates/collection_check_boxes/component.html.erb

@@ -0,0 +1,3 @@
+<%= form_element @options, @html_options do |builder| %>
+  <%= content(builder) %>
+<% end %>

data/lib/generators/vcfb/components/templates/collection_check_boxes/component.rb.tt

@@ -0,0 +1,29 @@
+<% module_namespacing do -%>
+module CollectionCheckBoxes
+  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
+    include VCFB::ActsAsFormCollectionComponent
+
+    def initialize(form, method, collection, value_method, text_method, options = {}, html_options = {})
+      @form = form
+      @method = method
+      @collection = collection
+      @value_method = value_method
+      @text_method = text_method
+      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
+      @html_options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(html_options)" : "html_options" %>
+    end
+
+    def form_element(options = {}, html_options = {}, &block)
+      collection_check_boxes(@form.object_name, @method, @collection, @value_method, @text_method, options, html_options) do |builder|
+        block&.call(builder)
+      end
+    end
+
+    private
+
+    def default_content(builder)
+      builder.check_box + builder.label
+    end
+  end
+end
+<% end -%>

data/lib/generators/vcfb/components/templates/collection_check_boxes/label/component.html.erb

@@ -0,0 +1,3 @@
+<%= form_element @options do %>
+  <%= content.presence || @text %>
+<% end %>

data/lib/generators/vcfb/components/templates/collection_check_boxes/label/component.rb.tt

@@ -0,0 +1,21 @@
+<% module_namespacing do -%>
+module CollectionCheckBoxes
+  module Label
+    class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
+      include VCFB::ActsAsFormLabelComponent
+
+      def initialize(form, method, text = nil, options = {})
+        @form = form
+        @method = method
+        @text = text
+        @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
+      end
+
+      def form_element(options = {}, &block)
+        @text = capture(&block) if block
+        label(@form.object_name, @method, @text, options)
+      end
+    end
+  end
+end
+<% end -%>

data/lib/generators/vcfb/components/templates/collection_radio_buttons/component.html.erb

@@ -0,0 +1,3 @@
+<%= form_element @options, @html_options do |builder| %>
+  <%= content(builder) %>
+<% end %>

data/lib/generators/vcfb/components/templates/collection_radio_buttons/component.rb.tt

@@ -0,0 +1,29 @@
+<% module_namespacing do -%>
+module CollectionRadioButtons
+  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
+    include VCFB::ActsAsFormCollectionComponent
+
+    def initialize(form, method, collection, value_method, text_method, options = {}, html_options = {})
+      @form = form
+      @method = method
+      @collection = collection
+      @value_method = value_method
+      @text_method = text_method
+      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
+      @html_options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(html_options)" : "html_options" %>
+    end
+
+    def form_element(options = {}, html_options = {}, &block)
+      collection_radio_buttons(@form.object_name, @method, @collection, @value_method, @text_method, options, html_options) do |builder|
+        block&.call(builder)
+      end
+    end
+
+    private
+
+    def default_content(builder)
+      builder.radio_button + builder.label
+    end
+  end
+end
+<% end -%>

data/lib/generators/vcfb/components/templates/collection_radio_buttons/label/component.html.erb

@@ -0,0 +1,3 @@
+<%= form_element @options do %>
+  <%= content.presence || @text %>
+<% end %>

data/lib/generators/vcfb/components/templates/collection_radio_buttons/label/component.rb.tt

@@ -0,0 +1,21 @@
+<% module_namespacing do -%>
+module CollectionRadioButtons
+  module Label
+    class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
+      include VCFB::ActsAsFormLabelComponent
+
+      def initialize(form, method, text = nil, options = {})
+        @form = form
+        @method = method
+        @text = text
+        @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
+      end
+
+      def form_element(options = {}, &block)
+        @text = capture(&block) if block
+        label(@form.object_name, @method, @text, options)
+      end
+    end
+  end
+end
+<% end -%>

data/lib/generators/vcfb/components/templates/collection_radio_buttons/radio_button/component.html.erb

@@ -0,0 +1 @@
+<%= form_element @options %>

data/lib/generators/vcfb/components/templates/collection_radio_buttons/radio_button/component.rb.tt

@@ -0,0 +1,20 @@
+<% module_namespacing do -%>
+module CollectionRadioButtons
+  module RadioButton
+    class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
+      include VCFB::ActsAsFormComponent
+
+      def initialize(form, method, value, options = {})
+        @form = form
+        @method = method
+        @value = value
+        @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
+      end
+
+      def form_element(options = {})
+        radio_button(@form.object_name, @method, @value, options)
+      end
+    end
+  end
+end
+<% end -%>

data/lib/generators/vcfb/components/templates/collection_select/component.html.erb

@@ -0,0 +1 @@
+<%= form_element @options, @html_options %>

data/lib/generators/vcfb/components/templates/collection_select/component.rb.tt

@@ -0,0 +1,21 @@
+<% module_namespacing do -%>
+module CollectionSelect
+  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
+    include VCFB::ActsAsFormCollectionComponent
+
+    def initialize(form, method, collection, value_method, text_method, options = {}, html_options = {})
+      @form = form
+      @method = method
+      @collection = collection
+      @value_method = value_method
+      @text_method = text_method
+      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
+      @html_options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(html_options)" : "html_options" %>
+    end
+
+    def form_element(options = {}, html_options = {})
+      collection_select(@form.object_name, @method, @collection, @value_method, @text_method, options, html_options)
+    end
+  end
+end
+<% end -%>

data/lib/generators/vcfb/components/templates/color_field/component.html.erb

@@ -0,0 +1 @@
+<%= form_element @options %>

data/lib/generators/vcfb/components/templates/color_field/component.rb.tt

@@ -0,0 +1,17 @@
+<% module_namespacing do -%>
+module ColorField
+  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
+    include VCFB::ActsAsFormComponent
+
+    def initialize(form, method, options = {})
+      @form = form
+      @method = method
+      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
+    end
+
+    def form_element(options = {})
+      color_field(@form.object_name, @method, options)
+    end
+  end
+end
+<% end -%>

data/lib/generators/vcfb/components/templates/date_field/component.html.erb

@@ -0,0 +1 @@
+<%= form_element @options %>