playbook_ui 8.3.0 → 9.2.0

data/{app/pb_kits/playbook/pb_form/form_builder → lib/playbook/forms/builder}/form_field_builder.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Playbook
-  module PbForm
-    module FormBuilder
+  module Forms
+    class Builder
       class FormFieldBuilder < Module
         def initialize(method_name, kit_name:)
           define_method method_name do |name, props: {}, **options, &block|

data/lib/playbook/forms/builder/select_field.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Playbook
+  module Forms
+    class Builder
+      def select(name, choices = nil, options = {}, html_options = {}, props: {}, &block)
+        props[:label] = @template.label(@object_name, name) if props[:label] == true
+        options[:skip_default_ids] = false unless options.has_key?(:skip_default_ids)
+        options[:prompt] = props[:blank_selection] || ""
+        html_options[:required] = "required" if props[:required]
+        input = super(name, choices, options, html_options, &block)
+
+        @template.pb_rails("select", props: props) do
+          input
+        end
+      end
+    end
+  end
+end

data/lib/playbook/forms/builder/typeahead_field.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Playbook
+  module Forms
+    class Builder
+      def typeahead(name, _options = {}, _html_options = {}, props: {})
+        props[:name] = name
+        @template.pb_rails("typeahead", props: props)
+      end
+    end
+  end
+end

data/lib/playbook/pb_forms_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Playbook
+  module PbFormsHelper
+    # Renders a pb form with ::Playbook::Forms::Builder, that can render
+    # Playbook kits in the most railsie way.
+    #
+    # I.e.:
+    #
+    #   pb_form_with model: @user do |f|
+    #     f.text_field :name
+    #   end
+    #
+    # The form can also validate the fields, and trigger the validation automatically:
+    #
+    # I.e.:
+    #
+    #   pb_form_with model: @user, validate: true do |f|
+    #     f.text_field :name, required: true
+    #   end
+    #
+    # @param data [Hash] hash of data attributes
+    # @param validate [Boolean] whether validation should be triggered or not
+    # @see [#form_with] for other options
+    def pb_form_with(data: {}, validate: false, **kwargs, &block)
+      data = data.merge("pb-form-validation" => validate)
+      classname = ["pb-form", kwargs[:class]].join(" ")
+      options = kwargs.merge(
+        class: classname,
+        data: data,
+        builder: ::Playbook::Forms::Builder
+      )
+
+      content_for(:pb_js, javascript_tag(<<~JS))
+        window.addEventListener("DOMContentLoaded", function() { PbFormValidation.start() })
+      JS
+
+      form_with(**options, &block)
+    end
+  end
+end

data/lib/playbook/pb_kit_helper.rb

@@ -2,6 +2,8 @@
 
 module Playbook
   module PbKitHelper
+    include ::Playbook::PbFormsHelper
+
     def pb_rails(kit_name, props: {}, &block)
       kit = Playbook::KitResolver.resolve(kit_name.to_s)
       render_component kit.new(props, &block), &block

data/lib/playbook/props/base.rb

@@ -20,7 +20,7 @@ module Playbook
       end
 
       def validate!(input_value)
-        warn("#{kit} Kit: The prop '#{name}' is deprecated and will be removed in a future release!") if deprecated #TODO: add some color for pop
+        warn("#{kit} Kit: The prop '#{name}' is deprecated and will be removed in a future release!") if deprecated && input_value #TODO: add some color for pop
 
         raise(Playbook::Props::Error, "#{kit} prop '#{name}' of type #{inspect.class} is required and needs a value") if required && input_value.nil?
 

data/lib/playbook/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Playbook
-  VERSION = "8.3.0"
+  VERSION = "9.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playbook_ui
 version: !ruby/object:Gem::Version
-  version: 8.3.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Power UX
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -75,128 +75,128 @@ dependencies:
   name: react-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.15.0
+        version: '3.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.15.0
+        version: '3.15'
 - !ruby/object:Gem::Dependency
   name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: slim-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.3
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.3
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.23.2
+        version: '2.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.23.2
+        version: '2.23'
 - !ruby/object:Gem::Dependency
   name: webpacker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.2
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.2
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: webpacker-react
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: better_errors
   requirement: !ruby/object:Gem::Requirement
@@ -302,39 +302,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.8.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec-html-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
-  name: simple_form
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.1
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.1
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: spring
   requirement: !ruby/object:Gem::Requirement
@@ -999,24 +993,9 @@ files:
 - app/pb_kits/playbook/pb_form/docs/_form_form_with.html.erb
 - app/pb_kits/playbook/pb_form/docs/_form_form_with_validate.html.erb
 - app/pb_kits/playbook/pb_form/docs/_form_form_with_validate.md
-- app/pb_kits/playbook/pb_form/docs/_form_simple_form.html.erb
-- app/pb_kits/playbook/pb_form/docs/_form_simple_form_validate.html.erb
-- app/pb_kits/playbook/pb_form/docs/_form_simple_form_validate.md
 - app/pb_kits/playbook/pb_form/docs/example.yml
 - app/pb_kits/playbook/pb_form/form.rb
-- app/pb_kits/playbook/pb_form/form_builder.rb
-- app/pb_kits/playbook/pb_form/form_builder/action_area.rb
-- app/pb_kits/playbook/pb_form/form_builder/checkbox_field.rb
-- app/pb_kits/playbook/pb_form/form_builder/collection_select_field.rb
-- app/pb_kits/playbook/pb_form/form_builder/date_picker_field.rb
-- app/pb_kits/playbook/pb_form/form_builder/form_field_builder.rb
-- app/pb_kits/playbook/pb_form/form_builder/select_field.rb
-- app/pb_kits/playbook/pb_form/form_builder/typeahead_field.rb
-- app/pb_kits/playbook/pb_form/form_with.html.erb
-- app/pb_kits/playbook/pb_form/form_with.rb
 - app/pb_kits/playbook/pb_form/pb_form_validation.js
-- app/pb_kits/playbook/pb_form/simple_form.html.erb
-- app/pb_kits/playbook/pb_form/simple_form.rb
 - app/pb_kits/playbook/pb_form_group/_form_group.jsx
 - app/pb_kits/playbook/pb_form_group/_form_group.scss
 - app/pb_kits/playbook/pb_form_group/docs/_form_group_button.html.erb
@@ -2074,12 +2053,22 @@ files:
 - lib/playbook.rb
 - lib/playbook/classnames.rb
 - lib/playbook/engine.rb
+- lib/playbook/forms.rb
+- lib/playbook/forms/builder.rb
+- lib/playbook/forms/builder/action_area.rb
+- lib/playbook/forms/builder/checkbox_field.rb
+- lib/playbook/forms/builder/collection_select_field.rb
+- lib/playbook/forms/builder/date_picker_field.rb
+- lib/playbook/forms/builder/form_field_builder.rb
+- lib/playbook/forms/builder/select_field.rb
+- lib/playbook/forms/builder/typeahead_field.rb
 - lib/playbook/kit_base.rb
 - lib/playbook/kit_resolver.rb
 - lib/playbook/markdown.rb
 - lib/playbook/markdown/helper.rb
 - lib/playbook/markdown/template_handler.rb
 - lib/playbook/pb_doc_helper.rb
+- lib/playbook/pb_forms_helper.rb
 - lib/playbook/pb_kit_helper.rb
 - lib/playbook/props.rb
 - lib/playbook/props/array.rb

data/app/pb_kits/playbook/pb_form/docs/_form_simple_form.html.erb

@@ -1,60 +0,0 @@
-<%
-  require "simple_form" unless defined?(SimpleForm)
-  require "active_model/railtie" unless defined?(ActiveModel)
-
-  example_form_model = Class.new do
-    include ::ActiveModel::Model
-    attr_accessor :example_text_field,
-    :example_phone_field,
-    :example_email_field,
-    :example_number_field,
-    :example_search_field,
-    :example_password_field,
-    :example_url_field,
-    :example_text_area,
-    :example_select_field,
-    :example_collection_select_field,
-    :example_checkbox_field,
-    :example_date_picker_field_1
-
-
-    def self.model_name
-      ActiveModel::Name.new(self, nil, "ExampleFormModel")
-    end
-  end
-%>
-
-<%
-  example_collection = [
-    OpenStruct.new(name: "Alabama", value: 1),
-    OpenStruct.new(name: "Alaska", value: 2),
-    OpenStruct.new(name: "Arizona", value: 3),
-    OpenStruct.new(name: "Arkansas", value: 4),
-    OpenStruct.new(name: "California", value: 5),
-    OpenStruct.new(name: "Colorado", value: 6),
-    OpenStruct.new(name: "Connecticut", value: 7),
-    OpenStruct.new(name: "Delaware", value: 8),
-    OpenStruct.new(name: "Florida", value: 9),
-    OpenStruct.new(name: "Georgia", value: 10),
-  ]
-%>
-
-<%= pb_rails("form/simple_form", props: { options: { model: example_form_model.new, url: "", method: :get } }) do |form| %>
-  <%= form.input :example_text_field, as: :string %>
-  <%= form.input :example_phone_field, as: :tel %>
-  <%= form.input :example_email_field, as: :email %>
-  <%= form.input :example_number_field, as: :integer %>
-  <%= form.input :example_search_field, as: :search %>
-  <%= form.input :example_password_field, as: :password %>
-  <%= form.input :example_url_field, as: :url %>
-  <%= form.input :example_text_area, as: :text %>
-  <%= form.select :example_select_field, [["Yes", 1], ["No", 2]], props: { label: true } %>
-  <%= form.collection_select :example_collection_select_field, example_collection, :value, :name, props: { label: true } %>
-  <%= form.check_box :example_checkbox_field, props: { text: "Example Checkbox", label: true } %>
-  <%= form.date_picker :example_date_picker_field_1, props: { label: true } %>
-
-  <%= form.actions do |action| %>
-    <%= action.submit %>
-    <%= action.button props: { type: "reset", text: "Cancel", variant: "secondary" } %>
-  <% end %>
-<% end %>