ndr_ui 1.8.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 090dbe1864365cac5df2b73d3ca50b45ac81a254
-  data.tar.gz: ae73d19d763f5de57740b2aa4f5718744d7e3c01
+SHA256:
+  metadata.gz: 7f6bfad43f03dc5e629a49aa08e743ef776aba7c9380c8cd70970374e5cf1044
+  data.tar.gz: aaa1c1a00a40cd5eaa25375e7bb80ffbdb78f12148368e3c3f547fea06c14988
 SHA512:
-  metadata.gz: 9f279abb82c5d964d9f02ccbd1a3e780a0a49f0ad7fabaa20b09f71bb6edb514e577492fe2f0de14c462005e8ce8cc8d7b3cf78ef307aa57bd4389c1a7de2156
-  data.tar.gz: 2061bd700901a6ee9959fe149c25b217a8e0dc32f7e12ce5f09c03e2d33ae9dbea9d0ee23ab6c2e35736296ee518e83ceab254cf9312c8e4e23085838f69bb33
+  metadata.gz: 17ce15798f8f88b4df1ad9bc42ebf77b4f0085d454288ed6b0d8025937147e1a47f118927a441dae51ebaf4d99edbd804586a501071d3a7ee52d0c3a75b835d8
+  data.tar.gz: e68cdaef185e6081d97e7ec3438481d7f27388d39c3785b6d623d521be5506299e80d36328e6e185dfe8a0afdc574fedd9bc0678d72c1b21a37eafd6880058bf

data/app/assets/stylesheets/ndr_ui/datepicker.scss

@@ -1,4 +1,4 @@
-@import "bootstrap-datepicker-1.6.0-dist/css/bootstrap-datepicker3";
+@import "bootstrap-datepicker-1.6.0-dist/css/bootstrap-datepicker3.css";
 
 // Ensure date picker renders over the static nav
 .datepicker {

data/app/builders/ndr_ui/bootstrap/datepicker.rb

@@ -42,15 +42,16 @@ module NdrUi
         data = { provide: 'datepicker' }
         data[:'date-end-date'] = '0d' if options.delete(:no_future)
 
-        html = text_field_without_inline_errors(method, options)
-        return html if readonly?
+        html   = text_field_without_inline_errors(method, options)
+        errors = inline_errors_and_warnings(method)
+        return html + errors if readonly?
 
         @template.content_tag(:div, class: 'input-group date', data: data) do
           html +
             @template.content_tag(:span,
                                   @template.bootstrap_icon_tag(:calendar),
                                   'aria-hidden': 'true', class: 'input-group-addon')
-        end + inline_errors_and_warnings(method)
+        end + errors
       end
     end
   end

data/app/builders/ndr_ui/bootstrap/error_and_warning_alert_boxes.rb

@@ -0,0 +1,157 @@
+module NdrUi
+  module Bootstrap
+    # This mixin provides standard error and warning boxes. A translated heading is needed
+    # for base and other error and warning messages.
+    #
+    # The overall error alertbox heading uses:
+    #
+    # en:
+    #   errors:
+    #     alertbox:
+    #       heading: "%{reason} prevented this record from being saved."
+    #
+    # Where reason is the number of errors e.g. "1 error" or "3 errors"
+    #
+    # For :base errors use the following heading translations:
+    #
+    # en:
+    #   errors:
+    #     alertbox:
+    #       base:
+    #         readonly: "Overall errors:"
+    #         editing: "Overall errors:"
+    #
+    # If there is no difference in the readonly/editing messages then you can use
+    #
+    # en:
+    #   errors:
+    #     alertbox:
+    #       base: "Overall errors:"
+    #
+    # For all other non-base errors use the following heading translations:
+    #
+    # en:
+    #   errors:
+    #     alertbox:
+    #       other:
+    #         readonly: "Specific errors:"
+    #         editing: "Specific errors (click on labels!):"
+    #
+    # The pattern is exactly the same for warnings:
+    #
+    # The overall warning alertbox heading uses:
+    #
+    # en:
+    #   warnings:
+    #     alertbox:
+    #       heading: "%{reason} prevented this record from being saved."
+    #
+    # Where reason is the number of warnings e.g. "1 warning" or "3 warnings"
+    #
+    # For :base warnings use the following heading translations:
+    #
+    # en:
+    #   warnings:
+    #     alertbox:
+    #       base:
+    #         readonly: "Overall warnings:"
+    #         editing: "Overall warnings:"
+    #
+    # If there is no difference in the readonly/editing messages then you can use
+    #
+    # en:
+    #   warnings:
+    #     alertbox:
+    #       base: "Overall errors:"
+    #
+    # For all other non-base errors use the following heading translations:
+    #
+    # en:
+    #   warnings:
+    #     alertbox:
+    #       other:
+    #         readonly: "Specific warnings:"
+    #         editing: "Specific warnings (click on labels!):"
+    #
+    module ErrorAndWarningAlertBoxes
+      SAFE_BLANK_STRING = ERB::Util.html_escape('').freeze
+
+      # Map issue types to Boostrap alert styles
+      ALERT_BOX_TYPE = { errors: :danger, warnings: :warning }.freeze
+
+      def error_and_warning_alert_boxes
+        error_alert_box + warning_alert_box
+      end
+
+      def error_alert_box
+        issue_alert_box(:errors)
+      end
+
+      def warning_alert_box
+        issue_alert_box(:warnings)
+      end
+
+      def issue_alert_box(type)
+        raise ArgumentError unless [:errors, :warnings].include?(type)
+        return SAFE_BLANK_STRING unless object && object.respond_to?(type) && object.send(type).any?
+
+        issues = object.send(type).to_hash
+        @template.bootstrap_alert_tag(ALERT_BOX_TYPE[type]) do
+          alertbox_heading(type, issues) +
+            base_issues(type, issues[:base]) +
+            non_base_issues(type, issues.except(:base))
+        end
+      end
+
+      def base_issues(type, messages)
+        issue_wrapper(type, :base, messages) do |message|
+          message
+        end
+      end
+
+      def non_base_issues(type, messages)
+        issue_wrapper(type, :other, messages) do |attribute, errors|
+          readonly_friendly_label(attribute) + ' ' + errors.to_sentence
+        end
+      end
+
+      # This wraps the issues in a paragraph and puts them into an unordered list
+      def issue_wrapper(type, name, messages, &block)
+        return SAFE_BLANK_STRING if messages.blank?
+
+        @template.content_tag(:p) do
+          wrapper_heading(type, name) +
+            @template.content_tag(:ul) do
+              list_items = messages.map(&block).map { |item| @template.content_tag(:li, item) }
+              @template.safe_join(list_items)
+            end
+        end
+      end
+
+      private
+
+      # This returns the attribute human name in plain text if the form is readonly
+      def readonly_friendly_label(attribute)
+        return object.class.human_attribute_name(attribute) if readonly?
+        label(attribute)
+      end
+
+      # This looks up the overall alertbox heading
+      def alertbox_heading(type, issues)
+        reason = @template.pluralize(issues.count, type.to_s.singularize)
+        ERB::Util.html_escape(
+          I18n.t("#{type}.alertbox.heading", reason: reason)
+        )
+      end
+
+      # This method lookups up the translation falling back to the default one where necessary
+      def wrapper_heading(type, name)
+        ERB::Util.html_escape(
+          I18n.t(readonly? ? 'readonly' : 'editing',
+                 default: :'.',
+                 scope: "#{type}.alertbox.#{name}")
+        )
+      end
+    end
+  end
+end

data/app/builders/ndr_ui/bootstrap/inline_errors_and_warnings.rb

@@ -43,10 +43,12 @@ module NdrUi
       private
 
       def inline_errors_and_warnings(method)
-        HelpBlock.new(object_name, method, @template, options).render do
+        HelpBlock.new(object_name, method, @template, objectify_options(options)).render do
           ''.html_safe.tap do |buffer|
-            errors = @template.safe_join(object.errors[method], @template.tag(:br))
-            buffer << @template.content_tag(:span, errors, class: 'text-danger')
+            if object_supports_warnings?
+              errors = @template.safe_join(object.errors[method], @template.tag(:br))
+              buffer << @template.content_tag(:span, errors, class: 'text-danger')
+            end
 
             if object_supports_warnings?
               warnings = @template.safe_join(object.warnings[method], @template.tag(:br))
@@ -56,6 +58,10 @@ module NdrUi
         end
       end
 
+      def object_supports_errors?
+        object.respond_to?(:errors) && object.errors.respond_to?(:[])
+      end
+
       def object_supports_warnings?
         object.respond_to?(:warnings) && object.warnings.respond_to?(:[])
       end

data/app/builders/ndr_ui/bootstrap/input_group_addons.rb

@@ -0,0 +1,31 @@
+module NdrUi
+  module Bootstrap
+    # Provides form builder method for Bootstrap input-group-addon
+    module InputGroupAddons
+      # Identical signature to ActionView::Helpers::FormBuilder#text_field, but adds
+      # <tt>:prepend</tt> and <tt>:append</tt> options to prepend and append text to
+      # the text_field. Would typically be used for units (centigrays, mm, etc).
+      # This implementation adds the associated bootstrap styling to the add-ons.
+      def text_field(method, options = {})
+        options = options.stringify_keys
+        prepend = options.delete('prepend')
+        append = options.delete('append')
+
+        return super if prepend.blank? && append.blank?
+        div_content = []
+
+        unless prepend.blank?
+          div_content << @template.content_tag(:span, prepend, class: 'input-group-addon')
+        end
+
+        div_content << text_field_without_inline_errors(method, options)
+
+        unless append.blank?
+          div_content << @template.content_tag(:span, append, class: 'input-group-addon')
+        end
+
+        @template.content_tag(:div, @template.safe_join(div_content), class: 'input-group')
+      end
+    end
+  end
+end

data/app/builders/ndr_ui/bootstrap/label_tooltips.rb

@@ -0,0 +1,61 @@
+module NdrUi
+  module Bootstrap
+    # This extension adds I18n based tooltips to form labels.
+    module LabelTooltips
+      # Generates a form label tag and appends a question_tooltip if an appropriate translation
+      # is found in the locale file. Tooltip translation can be overriden by passing the :tooltip
+      # option with the desired text.
+      #
+      # The content for a label_tag is sourced from either the passed block, the passed text or
+      # the tag builder's underlying translations, in that order. We inject our own block
+      # that recreates that same logic whilst tacking on our tooltip, so that form.label continues
+      # to work as one might expect from reading the documentation.
+      # See the source code for ActionView::Helpers::Tags::Label for more.
+      #
+      # QUESTION: Parameterise the tooltip so we're not just bound to a question_tooltip ?
+      def label(method, text = nil, **options, &block)
+        tooltip_text = options.delete(:tooltip)
+
+        super(method, text, options) do |builder|
+          output = block ? block.call : text
+          output ||= builder.translation
+
+          tooltip = question_tooltip(method, tooltip_text)
+
+          @template.safe_join([output, tooltip].compact, ' ')
+        end
+      end
+
+      private
+
+      def question_tooltip(method, text = nil)
+        # Suppress a tooltip if you really want/need to...
+        return if text == false
+        text ||= translate_tooltip(method)
+        return unless text.is_a?(String)
+        return if text =~ /translation missing/
+
+        @template.content_tag(:span, title: text.strip, class: 'question-tooltip') do
+          @template.bootstrap_icon_tag('question-sign')
+        end
+      end
+
+      # QUESTION: Should this be a method on a model (e.g. Model.attribute_tooltip) similar to
+      # Model.human_attribute_name, or is it irrelevant/overkill?
+      def translate_tooltip(attribute)
+        scope        = 'tooltips'
+        search_paths = ["#{scope}.#{attribute}"]
+
+        @object.class.lookup_ancestors.map do |ancestor|
+          search_paths.unshift("#{scope}.#{ancestor.model_name.i18n_key}.#{attribute}")
+        end
+
+        search_paths.unshift("#{scope}.#{@object.class.model_name.i18n_key}.#{attribute}")
+
+        search_paths.map!(&:to_sym)
+
+        @template.t(search_paths.shift, default: search_paths)
+      end
+    end
+  end
+end

data/app/builders/ndr_ui/bootstrap/readonly.rb

@@ -9,14 +9,15 @@ module NdrUi
     module Readonly
       def self.included(base)
         # These have different signatures, or aren't affected by `readonly`:
-        needs_custom = [:radio_button, :file_field] + base.field_helpers_from_form_options_helper
         not_affected = [:label, :fields_for]
+        needs_custom = [:radio_button, :file_field, :hidden_field] +
+                       base.field_helpers_from_form_options_helper
 
         (base.field_helpers - needs_custom - not_affected).each do |selector|
           class_eval <<-END, __FILE__, __LINE__ + 1
             def #{selector}(method, options = {}, *rest)
               return super unless readonly?
-              readonly_value = options.fetch(:readonly_value, object.send(method))
+              readonly_value = options.symbolize_keys.fetch(:readonly_value, object.send(method))
               @template.content_tag(:p, readonly_value, class: 'form-control-static')
             end
           END
@@ -26,7 +27,7 @@ module NdrUi
           class_eval <<-END, __FILE__, __LINE__ + 1
             def #{selector}(method, _something, options = {}, *rest)
               return super unless readonly?
-              readonly_value = options.fetch(:readonly_value, object.send(method))
+              readonly_value = options.symbolize_keys.fetch(:readonly_value, object.send(method))
               @template.content_tag(:p, readonly_value, class: 'form-control-static')
             end
           END
@@ -36,7 +37,7 @@ module NdrUi
           class_eval <<-END, __FILE__, __LINE__ + 1
             def #{selector}(method, collection, value_method, text_method, options = {}, *rest)
               return super unless readonly?
-              readonly_value = options.fetch(:readonly_value, object.send(method))
+              readonly_value = options.symbolize_keys.fetch(:readonly_value, object.send(method))
               @template.content_tag(:p, readonly_value, class: 'form-control-static')
             end
           END
@@ -46,23 +47,28 @@ module NdrUi
           # grouped_collection_select takes many other arguments
           def grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
             return super unless readonly?
-            readonly_value = options.fetch(:readonly_value, object.send(method))
+            readonly_value = options.symbolize_keys.fetch(:readonly_value, object.send(method))
             @template.content_tag(:p, readonly_value, class: 'form-control-static')
           end
 
           # radio_button takes another intermediate argument:
           def radio_button(method, tag_value, options = {})
             return super unless readonly?
-            readonly_value = options.fetch(:readonly_value, object.send(method))
+            readonly_value = options.symbolize_keys.fetch(:readonly_value, object.send(method))
             @template.content_tag(:p, readonly_value, class: 'form-control-static')
           end
 
           # For file_field, the readonly value defaults to nil:
           def file_field(method, options = {})
             return super unless readonly?
-            readonly_value = options[:readonly_value]
+            readonly_value = options.symbolize_keys[:readonly_value]
             @template.content_tag(:p, readonly_value, class: 'form-control-static')
           end
+
+          # Hidden fields should be suppressed when the form is readonly:
+          def hidden_field(*)
+            super unless readonly?
+          end
         END
 
         class_eval <<-END, __FILE__, __LINE__ + 1

data/app/builders/ndr_ui/bootstrap_builder.rb

@@ -19,8 +19,11 @@ module NdrUi
     include CssHelper
     include ::NdrUi::Bootstrap::FormControlClass
     include ::NdrUi::Bootstrap::Readonly
+    include ::NdrUi::Bootstrap::InputGroupAddons
     include ::NdrUi::Bootstrap::InlineErrorsAndWarnings
     include ::NdrUi::Bootstrap::Datepicker
+    include ::NdrUi::Bootstrap::ErrorAndWarningAlertBoxes
+    include ::NdrUi::Bootstrap::LabelTooltips
 
     attr_accessor :horizontal_mode
 
@@ -67,8 +70,10 @@ module NdrUi
 
         label_classes = ['control-label']
         label_classes << "col-md-#{label_columns}" if horizontal_mode
+        label_options = {class: label_classes.join(' ')}
+        label_options[:tooltip] = options.delete(:tooltip)
         label_html = if methods.present?
-                       label(methods.first, text, class: label_classes.join(' '))
+                       label(methods.first, text, label_options)
                      else
                        @template.content_tag(:span, text, class: label_classes.join(' '))
                      end

data/app/helpers/ndr_ui/bootstrap/breadcrumbs_helper.rb

@@ -0,0 +1,40 @@
+module NdrUi
+  module Bootstrap
+    # This mixin provides Bootstrap breadcrumbs helper methods
+    module BreadcrumbsHelper
+      # Creates bootstrap breadcrumbs.
+      #
+      # ==== Signatures
+      #
+      #   bootstrap_breadcrumbs(breadcrumbs)
+      #
+      # ==== Examples
+      #
+      #   <%= bootstrap_breadcrumbs([
+      #     bootstrap_breadcrumb("Fruits", "#fruits")
+      #   ]) %>
+      #   # => <ol class="breadcrumb">
+      #          <li class="active"><a href="#fruits">Fruits</a></li>
+      #        </ol>
+      def bootstrap_breadcrumbs(breadcrumbs)
+        content_tag('ol', safe_join(breadcrumbs), class: 'breadcrumb')
+      end
+
+      # Creates a bootstrap breadcrumb.
+      #
+      # ==== Signatures
+      #
+      #   bootstrap_breadcrumb(title, linkto, active = false)
+      #
+      # ==== Examples
+      #
+      #   <%= bootstrap_breadcrumb("Fruits", "#fruits", true) %>
+      #   # => <li class="active"><a href="#fruits">Fruits</a></li>
+      def bootstrap_breadcrumb(title, linkto, active = false)
+        content_tag('li',
+                    link_to(title, linkto),
+                    active ? { class: 'active' } : {})
+      end
+    end
+  end
+end