nfg_ui 0.9.8.15

data/lib/nfg_ui/components/traits/typeface.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Traits
+      # Access to pre-designed Alert traits
+      module Typeface
+        TRAITS = %i[body
+                    caption
+                    heading
+                    subheading
+                    title
+                    muted
+                    truncate].freeze
+
+        def body_trait
+          self.as = body_tag
+        end
+
+        # TODO: this was a tricky one and needs specs (as well as other traits need this spec)
+        # Write a spec that tests that the typeface is ACTUALLY a caption
+        # this was identified earlier as not happening because we'd set the as option
+        # but it wasn't spitting out the caption css_class...
+        # after some exploring it turned out the component didn't understand that it
+        # was actually a caption... it just looked like one.
+        def caption_trait
+          self.as = caption_tag
+          options[:caption] = body
+        end
+
+        def heading_trait
+          self.as = heading_tag
+          options[:heading] = body
+        end
+
+        def subheading_trait
+          self.as = subheading_tag
+          options[:subheading] = body
+        end
+
+        def title_trait
+          self.as = title_tag
+          options[:title] = body
+        end
+
+        # Add the css class 'text-truncate' to a typeface component
+        def truncate_trait
+          options[:class] = [options.try(:[], :class), 'text-truncate'].join(' ').squish
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/traits/vertical.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Traits
+      # Access to pre-designed theme traits
+      module Vertical
+        TRAITS = %i[vertical].freeze
+
+        def vertical_trait
+          options[:vertical] = true
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/traits.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    # Centralizes and autoloads traits for design system components
+    # Trait modules must have the same name as the component they represent.
+    # This provides autoloading of traits.
+    module Traits
+      TRAIT_MODULES = %i[Active
+                         Alert
+                         Alignment
+                         Button
+                         ButtonGroup
+                         Card
+                         Collapse
+                         Disable
+                         DisableWith
+                         Dismiss
+                         DropdownToggle
+                         Icon
+                         ListGroup
+                         Muted
+                         Nav
+                         Navbar
+                         NavItem
+                         PageHeader
+                         Pill
+                         ProgressBar
+                         Remote
+                         Size
+                         Step
+                         SlatItem
+                         Theme
+                         Typeface
+                         Vertical].freeze
+
+      extend ActiveSupport::Autoload
+      TRAIT_MODULES.each { |trait_module| autoload trait_module }
+
+      REGISTERED_TRAITS = TRAIT_MODULES.collect { |trait| "NfgUi::Components::Traits::#{trait}::TRAITS".constantize }.reject(&:empty?).flatten
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/browser_detectable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Utilities
+      # Add browser detection to the desired component
+      module BrowserDetectable
+        require 'browser'
+
+        def browser
+          Browser.new(user_agent: view_context.request.env['HTTP_USER_AGENT'])
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/confirmable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Utilities
+      # Allows components to be setup to accept method: options
+      module Confirmable
+        def confirm
+          options.fetch(:confirm, nil)
+        end
+
+        def data
+          confirm ? super.merge!(confirm: confirm) : super
+        end
+
+        private
+
+        def non_html_attribute_options
+          super.push(:confirm)
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/describable.rb

@@ -0,0 +1,22 @@
+module NfgUi
+  module Components
+    module Utilities
+      # Allows components to be setup to accept icons
+      module Describable
+        def describe
+          options.fetch(:describe, nil)
+        end
+
+        def data
+          describe ? super.merge!(describe: describe) : super
+        end
+
+        private
+
+        def non_html_attribute_options
+          super.push(:describe)
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/disable_withable.rb

@@ -0,0 +1,26 @@
+module NfgUi
+  module Components
+    module Utilities
+      # Allows components to be setup to utilize disable_with
+      module DisableWithable
+        def data
+          disable_with ? super.merge!(disable_with: disable_with) : super
+        end
+
+        def disable_with
+          options.fetch(:disable_with, nil)
+        end
+
+        private
+
+        def default_disable_with
+          @default_disable_with ||= view_context.ui.nfg(:icon, :loader, text: 'Saving...')
+        end
+
+        def non_html_attribute_options
+          super.push(:disable_with)
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/emailable.rb

@@ -0,0 +1,44 @@
+module NfgUi
+  module Components
+    module Utilities
+      module Emailable      
+        def spacer(size)
+          # Used in situations where you're utilizing a spacer value based on 12, ex:
+          # %spacer{ size: spacer(:double) } is the same as %spacer{ size: "24" }
+          case size
+          when :quarter then spacer_base / 4
+          when :half then spacer_base / 2
+          when :base then spacer_base
+          when :base_half then spacer_base * 1.5
+          when :double then spacer_base * 2
+          when :double_half then spacer_base * 2.5
+          when :triple then spacer_base * 3
+          when :triple_half then spacer_base * 3.5
+          when :quadruple then spacer_base * 4
+          when :quadruple_half then spacer_base * 4.5
+          else
+            size # allows for backup scenarios like %spacer{ size: spacer(120) }
+          end
+        end
+
+        def theme_color(theme_color)
+
+          # Centralizes theme color utilization (like spacer), ex:
+          # = render "product_content", theme_color: theme_color(:primary)
+          case theme_color
+          when :primary then "primary"
+          when :success then "success"
+          when :warning then "warning"
+          when :alert then "alert"
+          end
+        end
+
+        private
+
+        def spacer_base
+          12
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/iconable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Utilities
+      # Allows components to be setup to accept icons
+      module Iconable
+        def icon
+          options.fetch(:icon, nil)
+        end
+
+        private
+
+        def non_html_attribute_options
+          super.push(:icon, :text)
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/left_iconable.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Utilities
+      # Allows components to be setup to accept left icons
+      # Pass in a text value to identify the correct icon to be placed
+      # on the left side of the component.
+      module LeftIconable
+        def left_icon
+          options.fetch(:left_icon, nil)
+        end
+
+        private
+
+        def non_html_attribute_options
+          super.push(:left_icon)
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/methodable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Utilities
+      # Allows components to be setup to accept method: options
+      module Methodable
+        def method
+          options.fetch(:method, nil)
+        end
+
+        def data
+          send(:method) ? super.merge!(method: send(:method)) : super
+        end
+
+        private
+
+        def non_html_attribute_options
+          super.push(:method)
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/renderable.rb

@@ -0,0 +1,24 @@
+module NfgUi
+  module Components
+    module Utilities
+      # Allows us to skip -if statements in our code and directly
+      # setup a render_if / render_unless right on the component.
+      module Renderable
+        def render_if
+          options.fetch(:render_if, nil)
+        end
+
+        def render_unless
+          options.fetch(:render_unless, nil)
+        end
+
+        private
+
+        def non_html_attribute_options
+          super.push(:render_if,
+                     :render_unless)
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/resource_themeable.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Utilities
+      # The library of dedicated theme resources in Evo & DMS
+      module ResourceThemeable
+        # attr_reader :view_context
+
+        def resource_theme_color(object = nil)
+          resource_theme_name = resource_theme_name(object)
+          case resource_theme_name
+          when 'Project'
+            'primary'
+          when 'Campaign'
+            'primary'
+          else
+            'primary'
+          end
+        end
+
+        def resource_theme_name(object = nil)
+          if object.present?
+            if object.is_a?(String)
+              object
+            elsif object.is_a?(Class)
+              object.name
+            else
+              object.class.name
+            end
+          else
+            controller_name.split('/').last.classify
+          end
+        end
+
+        def resource_theme_icon(object = nil)
+          case resource_theme_name(object)
+          when 'Project'
+            'bullhorn'
+          when 'Campaign'
+            'bullhorn'
+          else
+            'heart-o'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/titleable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Utilities
+      # Allows NFG design system components to utilize the :title option
+      module Titleable
+        def title
+          options.fetch(:title, nil)
+        end
+
+        private
+
+        def non_html_attribute_options
+          super.push(:title)
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/traitable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Utilities
+      # Manages trait system
+      module Traitable
+        include NfgUi::Components::Traits
+
+        def utility_initialize
+          super
+          initialize_traits
+        end
+
+        def traits
+          options[:traits] || []
+        end
+
+        private
+
+        def initialize_traits
+          return unless traits.any?
+
+          traits.each do |trait|
+            next unless NfgUi::Components::Traits::REGISTERED_TRAITS.include?(trait)
+            send("#{trait}_trait")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities/vertically_alignable.rb

@@ -0,0 +1,31 @@
+module NfgUi
+  module Components
+    module Utilities
+      module VerticallyAlignable
+        # Can also pass in responsive variations
+        # align_items: :sm_center
+        def align_items
+          options.fetch(:align_items, nil)
+        end
+
+        def align_self
+          options.fetch(:align_self, nil)
+        end
+
+        private
+
+        def css_classes
+          [
+            super,
+            ("d-flex align-items-#{align_items.to_s.dasherize}" if align_items),
+            ("d-flex align-self-#{align_self.to_s.dasherize}" if align_self)
+          ].join(' ').squish
+        end
+
+        def non_html_attribute_options
+          super.push(:align_items)
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/components/utilities.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    # Autoloads utilities unique for NFG design system components
+    module Utilities
+      extend ActiveSupport::Autoload
+      autoload :BrowserDetectable
+      autoload :Confirmable
+      autoload :Describable
+      autoload :DisableWithable
+      autoload :Emailable
+      autoload :Iconable
+      autoload :Methodable
+      autoload :Titleable
+      autoload :Traitable
+      autoload :Renderable
+      autoload :ResourceThemeable
+      autoload :VerticallyAlignable
+    end
+  end
+end

data/lib/nfg_ui/engine.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module NfgUi
+  class Engine < ::Rails::Engine
+    isolate_namespace NfgUi
+
+    config.autoload_paths << Engine.root.join("lib")
+
+    # Ensures that the config/nfg_ui_manifest.js file is compiled
+    # which, in turn, ensures that all of the non-autoloaded assets
+    # are pre-compiled for the host-app's consumption.
+    #
+    # If you need to add unique assets to be precompiled
+    # (new folders -- e.g.: 'font' -- within the assets directory)
+    # update / add to the "links" found on the manifest file.
+    #
+    # Font assets example:
+    # on app/assets/config/nfg_ui_manifest.js
+    #
+    # //= link_tree '../font/nfg_ui'
+    #
+    # See manifest here: app/assets/config/nfg_ui_manifest.js
+    #
+    # Learn more about using the sprockets `link`ing mechanisms:
+    # https://github.com/rails/sprockets#link
+    #
+    # Utilize engine initializer method:
+    initializer 'nfg_ui.assets.precompile' do |app|
+      app.config.assets.precompile << "#{Engine.root.join('app', 'assets', 'config')}/nfg_ui_manifest.js"
+    end
+
+    config.to_prepare do
+      ActiveSupport.on_load :action_controller do
+        helper NfgUi::ApplicationHelper
+        helper NfgUi::Components::ResourceThemesHelper
+        helper NfgUi::Components::TooltipHelper
+        helper NfgUi::Components::EmailHelpers
+      end
+
+      ActiveSupport.on_load :action_mailer do
+        helper NfgUi::Components::EmailHelpers
+      end
+    end
+  end
+end

data/lib/nfg_ui/ui/base.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module UI
+    # The base component building class for namespaced
+    # components (bootstrap vs network_for_good / nfg)
+    class Base
+      attr_accessor :view_context
+
+      def initialize(view_context)
+        self.view_context = view_context
+      end
+
+      def bootstrap(component_name = nil, *traits, **options, &block)
+        NfgUi::UI::Bootstrap.new(view_context, component_name, *traits, **options, &block).render_component
+      end
+
+      def nfg(component_name = nil, *traits, **options, &block)
+        return unless render_nfg_component?(options)
+        NfgUi::UI::NetworkForGood.new(view_context, component_name, *traits, **options, &block).render_component
+      end
+
+      private
+
+      def render_nfg_component?(options)
+        return true unless options.key?(:render_if) || options.key?(:render_unless)
+        if options.key?(:render_if)
+          options[:render_if]
+        else
+          !options[:render_unless]
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/ui/bootstrap.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module UI
+    # The class that yields the component for the view
+    class Bootstrap
+      include NfgUi::UI::Utilities::Initializer
+
+      attr_accessor :view_context
+      # attr_reader :component_name_folder
+
+      def initialize(view_context, component_name = nil, *traits, **options, &block)
+        self.view_context = view_context
+        initializer(component_name, *traits, **options, &block)
+        # @component_name_folder = component.component_family.to_s.pluralize if component.component_family.present?
+        # raise component.send(:component_family).inspect
+      end
+
+      private
+
+      def component_name_folder
+        # component.component_family.to_s.pluralize if component.component_family.present?
+        component.component_family.to_s.pluralize
+        # ''
+      end
+
+      def group
+        'bootstrap'
+      end
+
+      def grouping_folder
+        'bootstrap'
+      end
+
+      def ancestry_string
+        "NfgUi::Bootstrap::Components::#{class_name}"
+      end
+
+      def components_within_group(*)
+        NfgUi::BOOTSTRAP_COMPONENT_NAMES
+      end
+    end
+  end
+end

data/lib/nfg_ui/ui/network_for_good.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module UI
+    class NetworkForGood
+      include NfgUi::UI::Utilities::Initializer
+      
+      attr_accessor :view_context
+
+      def initialize(view_context, component_name = nil, *traits, **options, &block)
+        self.view_context = view_context
+        initializer(component_name, *traits, **options, &block)
+      end
+
+      private
+
+      def component_name_folder
+        component_family.present? ? component_family.to_s.pluralize : component_name.to_s.pluralize
+      end
+
+      def group
+        NfgUi::GROUPING_NAMES.each do |grouping|
+          return grouping.to_s.camelize if components_within_group(grouping: grouping).include?(component_name)
+        end
+      end
+
+      def grouping_folder
+        folder_name = ''
+        NfgUi::GROUPING_NAMES.each do |grouping|
+          next unless components_within_group(grouping: grouping).include?(component_name)
+          folder_name = grouping.to_s
+        end
+        folder_name
+      end
+
+      def ancestry_string
+        "NfgUi::Components::
+         #{nested_class_name_string}::
+         #{class_name}".tr(" \t\r\n", '')
+      end
+
+      def nested_class_name_string
+        NfgUi::GROUPING_NAMES.each do |grouping|
+          next unless components_within_group(grouping: grouping).include?(component_name)
+          return grouping.to_s.camelize
+        end
+      end
+
+      def components_within_group(grouping:)
+        "NfgUi::#{grouping.to_s.singularize.upcase}_COMPONENT_NAMES".constantize
+      end
+    end
+  end
+end