rails_bootstrap_form 0.1.0 → 0.2.0

data/demo/db/seeds.rb

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+::Country::DEFAULT_OPTIONS.each do |country|
+  ::Country.find_or_create_by(name: country)
+end
+
+::Fruit::DEFAULT_OPTIONS.each do |fruit|
+  ::Fruit.find_or_create_by(name: fruit)
+end
+
+::Skill::DEFAULT_OPTIONS.each do |skill|
+  ::Skill.find_or_create_by(name: skill)
+end

data/lib/generators/rails_bootstrap_form/install_generator.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+require "rails/generators"
+
+module RailsBootstrapForm
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "This generator creates an initializer file for configuration of RailsBootstrapForm"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_initializer_file
+        template "install.rb", initializer_path
+      end
+
+      private
+
+      def initializer_path
+        File.join("config/initializers", "rails_bootstrap_form.rb")
+      end
+    end
+  end
+end

data/lib/generators/rails_bootstrap_form/templates/install.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+# Be sure to restart your server when you modify this file.
+
+RailsBootstrapForm.configure do |config|
+  # to make forms non-compliant with W3C.
+  config.default_form_attributes = {role: "form", novalidate: true}
+end

data/lib/rails_bootstrap_form/action_view_extensions/bootstrap_form_helper.rb

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module ActionViewExtensions
+    # This module creates `RailsBootstrapForm` wrappers around the default form_with
+    # and form_for methods.
+    #
+    # Example:
+    #
+    #   bootstrap_form_for @user do |f|
+    #     f.text_field :name
+    #   end
+    #
+    # Example:
+    #
+    #   bootstrap_form_with model: @user do |f|
+    #     f.text_field :name
+    #   end
+    #
+    module BootstrapFormHelper
+      def bootstrap_form_for(record, options = {}, &block)
+        options.reverse_merge!(builder: RailsBootstrapForm::BootstrapFormBuilder)
+
+        supress_form_field_errors do
+          form_for(record, options, &block)
+        end
+      end
+
+      def bootstrap_form_with(options = {}, &block)
+        options.reverse_merge!(builder: RailsBootstrapForm::BootstrapFormBuilder)
+
+        supress_form_field_errors do
+          form_with(**options, &block)
+        end
+      end
+
+      def supress_form_field_errors
+        original_proc = ActionView::Base.field_error_proc
+        ActionView::Base.field_error_proc = RailsBootstrapForm.field_error_proc
+        yield
+      ensure
+        ActionView::Base.field_error_proc = original_proc
+      end
+
+      private :supress_form_field_errors
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_view) do
+  include RailsBootstrapForm::ActionViewExtensions::BootstrapFormHelper
+end

data/lib/rails_bootstrap_form/bootstrap_form_builder.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  class BootstrapFormBuilder < ActionView::Helpers::FormBuilder
+    delegate :capture, :concat, :tag, to: :@template
+
+    attr_accessor :bootstrap_form_options
+
+    def initialize(object_name, object, template, options)
+      @bootstrap_form_options = RailsBootstrapForm::BootstrapFormOptions.new(options.delete(:bootstrap_form))
+      apply_default_form_options(options)
+      super(object_name, object, template, options)
+    end
+
+    def apply_default_form_options(options)
+      options[:html] ||= {}
+      options[:html].reverse_merge!(RailsBootstrapForm.config.default_form_attributes)
+    end
+
+    private :apply_default_form_options
+  end
+end

data/lib/rails_bootstrap_form/bootstrap_form_options.rb

@@ -0,0 +1,71 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  # Container for bootstrap specific form builder options. It controls options
+  # that define form layout, grid sizing, and few other configurable options.
+  # They are passed-in into form builder helper and field helpers via
+  # `:bootstrap_form` option.
+  #
+  # For example:
+  #
+  #   bootstrap_form_with model: @user, bootstrap_form: {layout: :inline} do |f|
+  #      f.text_field :email, bootstrap_form: {label: {text: "Your email"}}
+  #   end
+  #
+  class BootstrapFormOptions
+
+    # Controls form and field layout. It can be "vertical, "horizontal", or "inline".
+    # It can also be "floating" if field should have floating labels.
+    attr_accessor :layout
+
+    def initialize(options = {})
+      set_defaults
+      set_bootstrap_form_options(options)
+    end
+
+    def horizontal?
+      @layout.to_s == "horizontal"
+    end
+
+    def inline?
+      @layout.to_s == "inline"
+    end
+
+    def vertical?
+      @layout.to_s == "vertical"
+    end
+
+    def floating?
+      @layout.to_s == "floating"
+    end
+
+    # This will return a copy of `BootstrapFormOptions` object with new options set
+    # that don't affect original object. This way we can have options specific
+    # to a given form field. For example, we can change grid just for one field:
+    #
+    #   bootstrap_form_with model: @user do |f|
+    #     f.text_field :email, bootstrap_form: {label_col_class: "col-md-6", control_col_class: "col-md-6"}
+    #     f.password_field :password
+    #   end
+    #
+    def scoped(options = {})
+      scope = clone
+      scope.set_bootstrap_form_options(options)
+      scope
+    end
+
+    def set_bootstrap_form_options(options)
+      options.is_a?(Hash) && options.each do |key, value|
+        public_send("#{key}=", value)
+      end
+    end
+
+    def set_defaults
+      @layout = "vertical"
+    end
+
+    private :set_defaults
+  end
+end

data/lib/rails_bootstrap_form/configuration.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  class Configuration
+    # Default HTML attributes which will applied to all forms build
+    # using RailsBootstrapForm.
+    def default_form_attributes=(attributes)
+      case attributes
+      when nil
+        @default_form_attributes = {}
+      when Hash
+        @default_form_attributes = attributes
+      else
+        raise ArgumentError, "Unsupported default_form_attributes #{attributes.inspect}"
+      end
+    end
+
+    def default_form_attributes
+      return @default_form_attributes if defined?(@default_form_attributes)
+
+      {}
+    end
+  end
+end

data/lib/rails_bootstrap_form/version.rb

@@ -3,6 +3,6 @@
 # -*- warn_indent: true -*-
 
 module RailsBootstrapForm
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
   REQUIRED_RAILS_VERSION = "~> 7.0".freeze
 end

data/lib/rails_bootstrap_form.rb

@@ -4,19 +4,38 @@
 
 require "action_view"
 require "action_pack"
+require "rails_bootstrap_form/action_view_extensions/bootstrap_form_helper"
 
 module RailsBootstrapForm
   extend ActiveSupport::Autoload
 
   eager_autoload do
-
+    autoload :Configuration
+    autoload :BootstrapFormOptions
+    autoload :BootstrapFormBuilder
   end
 
   class << self
     def eager_load!
       super
     end
+
+    def config
+      @config ||= RailsBootstrapForm::Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+
+  # Override `field_error_proc` to suppress errors coming from user defined
+  # `field_error_proc`.
+  mattr_accessor :field_error_proc
+  @@field_error_proc = proc do |html_tag, _instance_tag|
+    html_tag
   end
+
 end
 
 require "rails_bootstrap_form/engine" if defined?(Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Harshal LADHE (shivam091)
@@ -40,9 +40,74 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/stylesheets/rails_bootstrap_form.css
+- demo/.byebug_history
+- demo/.ruby-version
+- demo/Rakefile
+- demo/app/assets/config/manifest.js
+- demo/app/assets/stylesheets/application.scss
+- demo/app/channels/application_cable/channel.rb
+- demo/app/channels/application_cable/connection.rb
+- demo/app/controllers/application_controller.rb
+- demo/app/controllers/users_controller.rb
+- demo/app/helpers/application_helper.rb
+- demo/app/jobs/application_job.rb
+- demo/app/mailers/application_mailer.rb
+- demo/app/models/address.rb
+- demo/app/models/application_record.rb
+- demo/app/models/country.rb
+- demo/app/models/fruit.rb
+- demo/app/models/skill.rb
+- demo/app/models/user.rb
+- demo/app/models/user_skill.rb
+- demo/app/views/layouts/application.html.erb
+- demo/app/views/users/_form.html.erb
+- demo/app/views/users/_form_without_bootstrap_helpers.html.erb
+- demo/app/views/users/_vertical_form.html.erb
+- demo/app/views/users/edit.html.erb
+- demo/app/views/users/index.html.erb
+- demo/app/views/users/new.html.erb
+- demo/bin/bundle
+- demo/bin/rails
+- demo/bin/rake
+- demo/bin/setup
+- demo/config.ru
+- demo/config/application.rb
+- demo/config/boot.rb
+- demo/config/cable.yml
+- demo/config/database.yml
+- demo/config/environment.rb
+- demo/config/environments/development.rb
+- demo/config/environments/production.rb
+- demo/config/environments/test.rb
+- demo/config/initializers/assets.rb
+- demo/config/initializers/content_security_policy.rb
+- demo/config/initializers/filter_parameter_logging.rb
+- demo/config/initializers/inflections.rb
+- demo/config/initializers/permissions_policy.rb
+- demo/config/initializers/rails_bootstrap_form.rb
+- demo/config/locales/en.rb
+- demo/config/puma.rb
+- demo/config/routes.rb
+- demo/config/storage.yml
+- demo/db/migrate/20230514054308_create_countries.rb
+- demo/db/migrate/20230514054851_create_fruits.rb
+- demo/db/migrate/20230514055237_create_users.rb
+- demo/db/migrate/20230514055840_create_addresses.rb
+- demo/db/migrate/20230514060556_create_skills.rb
+- demo/db/migrate/20230514061100_create_user_skills.rb
+- demo/db/schema.rb
+- demo/db/seeds.rb
+- demo/public/favicon.ico
 - gemfiles/7.0.gemfile
 - gemfiles/common.gemfile
+- lib/generators/rails_bootstrap_form/install_generator.rb
+- lib/generators/rails_bootstrap_form/templates/install.rb
 - lib/rails_bootstrap_form.rb
+- lib/rails_bootstrap_form/action_view_extensions/bootstrap_form_helper.rb
+- lib/rails_bootstrap_form/bootstrap_form_builder.rb
+- lib/rails_bootstrap_form/bootstrap_form_options.rb
+- lib/rails_bootstrap_form/configuration.rb
 - lib/rails_bootstrap_form/engine.rb
 - lib/rails_bootstrap_form/version.rb
 - sig/rails_bootstrap_form.rbs