effective_bootstrap 0.13.2 → 0.13.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecffafbb096f543759ef66fd919f85dbf96acebd446ba522b4427c831b7b5b55
-  data.tar.gz: 9793e72a94792bed35abec120c8346d9c11f170e0323aa06aff49f75650d6d7f
+  metadata.gz: 9cc712dfbfdacf4feb17b2e3dc016f6fdefd3a9fd1935dbdf92425c2b607d99b
+  data.tar.gz: 7cf8df3af6713f5ad519c583374c0e2db10b91ff9eaf14bbebff19b8011da24e
 SHA512:
-  metadata.gz: 7394dc15b00b1e4bc79cd4bdffb220fa093b034dd0dc67beea558e4ae87b6e61c4d5fb37c3c9b9e4934811b0bd420c6e0da427445009b33f881d86b5097c79f0
-  data.tar.gz: ec4c87b103ebd7f621e6304948daeaa3adcf6078b9df9e71c6da1fba9593c98a6a97b882b3602e8b04cef5859d19d64b33d634c34107d18daed61417e0ed6c74
+  metadata.gz: 9b85f3fa66ddcf566a27dff5a60ab3a71a62827d150c440bfede05163016330e5f4189b29dc195d021fa900826654f94dfd479057879905e0f8b3281879168a1
+  data.tar.gz: 227f0c30431c24fff57d42f70d14540de193939d848b9a89bc951633e0eb7c5ac6a4f828394335a92fbada107021e6bba27453a322ee88d18c2d7af4c00de075

data/README.md

@@ -697,8 +697,74 @@ The `f.save` is purely a input submit button.
   = f.save 'Save 2'
 ```
 
+## Table Builder
 
+Use `effective_table_with(resource)` to intelligently output a table of attributes for a resource.
 
+In your view:
+
+```
+= effective_table_with(user, only: [:first_name, :last_name])
+```
+
+will output the following html:
+
+```
+<table class='table table-striped table-hover>
+  <tbody>
+    <tr>
+      <td>First Name</td>
+      <td>Peter</td>
+    </tr>
+    <tr>
+      <td>Last Name</td>
+      <td>Pan</td>
+    </tr>
+  </tbody>
+</table>
+```
+
+You can pass `only:` and `except:` to specify which attributes to display.
+
+To override the content of just one row:
+
+```
+= effective_table_with(user) do |f|
+  = f.content_for :first_name, label: 'Cool First Name' do
+    %strong= f.object.first_name
+```
+
+will generate the html:
+
+`<tr><td>Cool First Name</td><td><strong>Peter</strong></td></tr>`
+
+### Work with existing forms
+
+The table builder is intended to display based off your existing forms.
+
+Any `effective_form_with` or `_fields` partial will work to define the attributes displayed and the order they are displayed.
+
+A check_box will be rendered as a boolean, text areas use simple_format, f.show_if and f.hide_if logic work.
+
+If you use `f.text_field :first_name, label: 'Cool First Name'` in your form, it will flow through to the table.
+
+To render a table based off an existing `effective_form_with`:
+
+```
+= effective_table_with(user) do |f|
+  = render('users/form', user: user)
+```
+
+or just the fields partial
+
+```
+= effective_table_with(user, only: [:first_name, :last_name]) do |f|
+  = render('users/fields_demographics', f: f)
+```
+
+You can specify `only:` and `except:` and use `f.content_for` to override a row in all these use cases.
+
+All values flow through to i18n and can be overriden, same as the form labels, in the locale .yml file.
 
 ## License
 

data/app/helpers/effective_form_builder_helper.rb

@@ -2,6 +2,9 @@
 
 module EffectiveFormBuilderHelper
   def effective_form_with(**options, &block)
+    # This allows us to call effective_form_with inside an effective_table_with and just get the fields
+    return @_effective_table_builder.capture(&block) if @_effective_table_builder
+
     # Compute the default ID
     subject = Array(options[:model] || options[:scope]).last
     class_name = (options[:scope] || subject.class.name.parameterize.underscore)

data/app/helpers/effective_table_builder_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module EffectiveTableBuilderHelper
+
+  def effective_table_with(resource, options = {}, &block)
+    builder = Effective::TableBuilder.new(resource, self, options)
+    builder.render(&block)
+  end
+
+end

data/app/models/effective/table_builder.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module Effective
+  class TableBuilder
+    FILTER_PARAMETERS = [:password, :password_confirmation, :created_at, :updated_at]
+
+    attr_accessor :object, :template, :options
+
+    # A Hash of :first_name => "<tr><td>First Name</td><td>Bob</td></tr>"
+    attr_accessor :rows
+    attr_accessor :content_fors
+
+    delegate :content_tag, to: :template
+
+    def initialize(object, template, options = {}, &block)
+      raise('resource must be an ActiveRecord::Base') unless object.is_a?(ActiveRecord::Base)
+
+      @object = object
+      @template = template
+      @options = options
+
+      @rows = {}
+      @content_fors = {}
+    end
+
+    def render(&block)
+      # This runs the form partial over this table builder
+      capture(&block) if block_given?
+
+      # Build from the resource if we didn't do anything in the block
+      build_resource_rows if rows.blank?
+
+      only = Array(options[:only])
+      except = Array(options[:except])
+      filtered = filter_parameters
+
+      content = rows.merge(content_fors)
+      content = content.slice(*only) if only.present?
+      content = content.except(*except) if except.present?
+      content = content.except(*filtered) if filtered.present?
+
+      content_tag(:table, class: options.fetch(:class, 'table table-striped table-hover')) do
+        content_tag(:tbody, content.values.join.html_safe)
+      end
+    end
+
+    def capture(&block)
+      begin
+        template.instance_variable_set(:@_effective_table_builder, self)
+        template.capture(self, &block)
+      ensure
+        template.instance_variable_set(:@_effective_table_builder, nil)
+      end
+    end
+
+    def build_resource_rows
+      Effective::Resource.new(object).klass_attributes(sort: true).each do |name, options|
+        case options.first
+        when :boolean
+          boolean_row(name)
+        when :text
+          text_area(name)
+        when :string
+          (name.to_s.include?('email') && value(name).to_s.include?('@')) ? email_field(name) : text_field(name)
+        else default_row(name)
+        end
+      end
+    end
+
+    def filter_parameters
+      FILTER_PARAMETERS + Array(object.class.try(:filter_parameters)) + Array(Rails.application.config.filter_parameters)
+    end
+
+    def human_attribute_name(name)
+      if object.respond_to?(:human_attribute_name)
+        object.human_attribute_name(name)
+      else
+        (name.to_s.split('.').last.to_s.titleize || '')
+      end
+    end
+
+    def value(name)
+      object.send(name)
+    end
+
+    # Call default_row for any form field
+    def method_missing(method, *args, **kwargs, &block)
+      default_row(args[0], **kwargs, &block)
+    end
+
+    # Assign the <tr><td>...</td></tr> to the @rows Hash
+    def default_row(name, options = {}, &block)
+      rows[name] = TableRow.new(name, options, builder: self).to_html
+    end
+
+    def boolean_row(name, options = {})
+      rows[name] = TableRows::Boolean.new(name, options, builder: self).to_html
+    end
+    alias_method :check_box, :boolean_row
+
+    def collection_row(name, collection, options = {}, &block)
+      rows[name] = if [true, false].include?(value(name))
+        TableRows::Boolean.new(name, options, builder: self).to_html
+      else
+        TableRows::Collection.new(name, collection, options, builder: self).to_html
+      end
+    end
+    alias_method :select, :collection_row
+    alias_method :checks, :collection_row
+    alias_method :radios, :collection_row
+
+    def email_field(name, options = {})
+      rows[name] = TableRows::EmailField.new(name, options, builder: self).to_html
+    end
+    alias_method :email_cc_field, :email_field
+
+    def file_field(name, options = {})
+      rows[name] = TableRows::FileField.new(name, options, builder: self).to_html
+    end
+
+    def form_group(name = nil, options = {}, &block)
+      # Nothing to do
+    end
+
+    def hidden_field(name = nil, options = {})
+      # Nothing to do
+    end
+
+    def search_field(name, options = {})
+      # Nothing to do
+    end
+
+    def password_field(name, options = {})
+      # Nothing to do
+    end
+
+    def effective_address(name, options = {})
+      rows[name] = TableRows::EffectiveAddress.new(name, options, builder: self).to_html
+    end
+
+    def percent_field(name, options = {})
+      rows[name] = TableRows::PercentField.new(name, options, builder: self).to_html
+    end
+
+    def price_field(name, options = {})
+      rows[name] = TableRows::PriceField.new(name, options, builder: self).to_html
+    end
+
+    def save(name, options = {})
+      # Nothing to do
+    end
+
+    def submit(name, options = {}, &block)
+      # Nothing to do
+    end
+
+    def text_area(name, options = {})
+      rows[name] = TableRows::TextArea.new(name, options, builder: self).to_html
+    end
+
+    def url_field(name, options = {})
+      rows[name] = TableRows::UrlField.new(name, options, builder: self).to_html
+    end
+
+    def content_for(name, options = {}, &block)
+      content_fors[name] = TableRows::ContentFor.new(name, options, builder: self).to_html(&block)
+    end
+
+    # Logics
+    def hide_if(name, selected, &block)
+      template.capture(self, &block) unless value(name) == selected
+    end
+
+    def show_if(name, selected, &block)
+      template.capture(self, &block) if value(name) == selected
+    end
+
+    def show_if_any(name, options, &block)
+      template.capture(self, &block) if Array(options).include?(value(name))
+    end
+
+    # Has Many
+    def has_many(name, collection = nil, options = {}, &block)
+      raise('unsupported')
+    end
+
+    def fields_for(name, object, options = {}, &block)
+      builder = TableBuilder.new(object, template, options.merge(prefix: human_attribute_name(name)))
+      builder.render(&block)
+      builder.rows.each { |child, content| rows["#{name}_#{child}".to_sym] = content }
+    end
+    alias_method :effective_fields_for, :fields_for
+
+  end
+end

data/app/models/effective/table_row.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Effective
+  class TableRow
+    attr_accessor :name, :options, :builder, :template
+
+    delegate :object, to: :builder
+    delegate :capture, :content_tag, :image_tag, :link_to, :mail_to, :icon, to: :@template
+
+    # So this takes in the options for an entire form group.
+    def initialize(name, options, builder:)
+      @builder = builder
+      @template = builder.template
+
+      @name = name
+      @options = options
+    end
+
+    # Intended for override
+    def content
+      value
+    end
+
+    # Render method
+    def to_html(&block)
+      content_tag(:tr) do
+        content_tag(:td, label) + content_tag(:td, content.presence || '-')
+      end
+    end
+
+    # Humanized label or the label from form
+    def label
+      text = options[:label] || builder.human_attribute_name(name)
+      prefix = builder.options[:prefix]
+
+      [*prefix, text].join(': ')
+    end
+
+    # Value from resource
+    def value
+      options[:value] || builder.value(name)
+    end
+
+  end
+end

data/app/models/effective/table_rows/boolean.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Effective
+  module TableRows
+    class Boolean < Effective::TableRow
+
+      def content
+        if value
+          template.badge('YES')
+        else
+          template.badge('NO', class: 'badge badge-light')
+        end
+      end
+
+    end
+  end
+end

data/app/models/effective/table_rows/collection.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Effective
+  module TableRows
+    class Collection < Effective::TableRow
+
+      def initialize(name, collection, options, builder:)
+        @collection = collection
+        super(name, options, builder: builder)
+      end
+
+    end
+  end
+end

data/app/models/effective/table_rows/content_for.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Effective
+  module TableRows
+    class ContentFor < Effective::TableRow
+
+      def to_html(&block)
+        content_tag(:tr) do
+          content_tag(:td, label) + content_tag(:td, template.capture(&block))
+        end
+      end
+
+    end
+  end
+end

data/app/models/effective/table_rows/effective_address.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Effective
+  module TableRows
+    class EffectiveAddress < Effective::TableRow
+
+      def content
+        value.to_html if value.present?
+      end
+
+    end
+  end
+end

data/app/models/effective/table_rows/email_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Effective
+  module TableRows
+    class EmailField < Effective::TableRow
+
+      def content
+        value.to_s.include?('@') ? template.mail_to(value) : value.presence
+      end
+
+    end
+  end
+end

data/app/models/effective/table_rows/file_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Effective
+  module TableRows
+    class FileField < Effective::TableRow
+
+      def content
+        raise('todo')
+      end
+
+    end
+  end
+end

data/app/models/effective/table_rows/percent_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Effective
+  module TableRows
+    class PercentField < Effective::TableRow
+
+      def content
+        template.number_to_percent(value) if value.present?
+      end
+
+    end
+  end
+end

data/app/models/effective/table_rows/price_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Effective
+  module TableRows
+    class PercentField < Effective::TableRow
+
+      def content
+        template.price_to_currency(value) if value.present?
+      end
+
+    end
+  end
+end

data/app/models/effective/table_rows/text_area.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Effective
+  module TableRows
+    class TextArea < Effective::TableRow
+
+      def content
+        template.simple_format(value) if value.present?
+      end
+
+    end
+  end
+end

data/app/models/effective/table_rows/url_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Effective
+  module TableRows
+    class PercentField < Effective::TableRow
+
+      def content
+        template.link_to(value) if value.present?
+      end
+
+    end
+  end
+end

data/lib/effective_bootstrap/version.rb

@@ -1,3 +1,3 @@
 module EffectiveBootstrap
-  VERSION = '0.13.2'.freeze
+  VERSION = '0.13.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.13.3
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -647,6 +647,7 @@ files:
 - app/helpers/effective_editor_helper.rb
 - app/helpers/effective_form_builder_helper.rb
 - app/helpers/effective_icons_helper.rb
+- app/helpers/effective_table_builder_helper.rb
 - app/models/effective/form_builder.rb
 - app/models/effective/form_input.rb
 - app/models/effective/form_inputs/article_editor.rb
@@ -693,6 +694,18 @@ files:
 - app/models/effective/form_logics/hide_if.rb
 - app/models/effective/form_logics/show_if.rb
 - app/models/effective/form_logics/show_if_any.rb
+- app/models/effective/table_builder.rb
+- app/models/effective/table_row.rb
+- app/models/effective/table_rows/boolean.rb
+- app/models/effective/table_rows/collection.rb
+- app/models/effective/table_rows/content_for.rb
+- app/models/effective/table_rows/effective_address.rb
+- app/models/effective/table_rows/email_field.rb
+- app/models/effective/table_rows/file_field.rb
+- app/models/effective/table_rows/percent_field.rb
+- app/models/effective/table_rows/price_field.rb
+- app/models/effective/table_rows/text_area.rb
+- app/models/effective/table_rows/url_field.rb
 - app/views/action_text/attachables/_content_attachment.html.erb
 - app/views/action_text/attachables/content_attachments/_horizontal_rule.html.erb
 - app/views/effective/style_guide/__fields.html.haml