nfg_ui 0.9.24.3 → 0.9.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb7cf85aae07648d3c7ee2131ffef86a7a3a3895338c3da54b8a92d77511fc1
-  data.tar.gz: 7e4f35065081bfb343c817768bf60a55c3a9cc378ab136152608f27b21eaea26
+  metadata.gz: 255605aaf79082c250a38e2021f2cef46d06c90bca81af9912574ac62d110ecb
+  data.tar.gz: 21a793d0674e7bb9f4aacac84617f57ab118ffe2cf923ff341a2ca61db0fb688
 SHA512:
-  metadata.gz: b84c1e2c619990fce3e695fd493ea05cb7e1216e851d0493686049707d3b0576e84617646b7bfd896b286aa46638bd98907216b029d0e84136ee6f32c9b447df
-  data.tar.gz: 48be56ae1accf774edb14031b782498f88692b0502bc018776786363409da125c7c204f578e7e684a5177a9a1fcf1d6aea9b9d0f506290243496d047cd411e41
+  metadata.gz: 44bf230b5ee51da2b00f3bd8bf2e0410bf67d80310887f15c0978a74beccd4c3dbfcf59b96bbae0b77909c42bcc31a1df82a8499366f262b9e822d6a9a9d1da3
+  data.tar.gz: a827a15667b221b27e064897d7de30ba8142a36f1cb5962be21c30ffdc4880a3ae50735b72fab76e5626d353258d4a0e1e9e47897b0dd6d2ce12c554cab8134c

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

@@ -5,12 +5,14 @@ module NfgUi
     module Traits
       # Access to pre-designed Alert traits
       module Alert
+        include NfgUi::Components::Utilities::Traits::TraitUtilities
+
         TRAITS = %i[tip].freeze
 
         def tip_trait
-          options[:icon] = NfgUi::DEFAULT_TIP_ICON
-          options[:theme] = NfgUi::DEFAULT_TIP_THEME
-          options[:dismissible] = false
+          maybe_update_option(:icon, value: NfgUi::DEFAULT_TIP_ICON)
+          maybe_update_option(:theme, value: NfgUi::DEFAULT_TIP_THEME)
+          maybe_update_option(:dismissible, value: false)
         end
       end
     end

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

@@ -5,6 +5,8 @@ module NfgUi
     module Traits
       # Access to pre-designed Icon traits
       module Icon
+        include NfgUi::Components::Utilities::Traits::TraitUtilities
+
         TRAITS = %i[loader tip].freeze
 
         def loader_trait
@@ -15,11 +17,12 @@ module NfgUi
         # Usage:
         # ui.nfg :icon, :tip, tooltip: 'The tip'
         def tip_trait
-          options[:icon] = NfgUi::DEFAULT_TIP_ICON
-          options[:theme] = NfgUi::DEFAULT_TIP_THEME
+          maybe_update_option(:icon, value: NfgUi::DEFAULT_TIP_ICON)
+
+          maybe_update_option(:theme, value: NfgUi::DEFAULT_TIP_THEME)
 
           if options[:text].present?
-            options[:right] = true
+            maybe_update_option(:right, value: true)
             options[:class] += ' fa-fw'
           end
         end

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

@@ -5,12 +5,13 @@ module NfgUi
     module Traits
       # Access to pre-designed traits
       module Navbar
+        include NfgUi::Components::Utilities::Traits::TraitUtilities
+
         TRAITS = %i[white].freeze
 
         def white_trait
-          options[:light] = true
-          # options[:class] += ' bg-white'
-          options[:theme] = :white
+          maybe_update_option(:light, value: true)
+          maybe_update_option(:theme, value: :white)
         end
       end
     end

data/lib/nfg_ui/components/utilities/traits/trait_utilities.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module NfgUi
+  module Components
+    module Utilities
+      module Traits
+        module TraitUtilities
+          private
+
+          # As a practice, traits are designed to help not rule.
+          #
+          # Leveraging this method to conditionally overwrite values in the options hash
+          # ensures that users of the gem are able to use
+          # traits and further customize them on the fly.
+          #
+          # Example:
+          # An example trait adjusts an icon and the theme.
+          # Gem user wants to customize the theme in a unique setting
+          # = ui.nfg :icon, :tip, theme: :danger
+          #
+          # Without using this #maybe_update_option method, `theme: :danger`
+          # would be ignored (and thus overwritten) by by the :tip trait
+          #
+          # Thus, when using this method, the :tip trait would first check if :theme option is present _before_
+          # setting the established trait's options[:theme] value.
+          #
+          # It may not always be necessary or appropriate to use this method. For example,
+          # Some traits modify only one value in options, and if that trait is being overwritten by a supplied option,
+          # it defeats the purpose of the trait.
+          #
+          # Example where method usage is not necessary:
+          # def active_trait
+          #   options[:active] = true
+          # end
+          #
+          # Overall, trait creation doctrine really
+          # prefers usage of this method.
+          #
+          #
+          # Example Usage:
+          #
+          # def white_trait
+          #   maybe_update_option(:light, value: true)
+          #   maybe_update_option(:theme, value: :white)
+          # end
+          def maybe_update_option(option_key, value:)
+            return if options[option_key].present?
+            options[option_key] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nfg_ui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NfgUi
-  VERSION = '0.9.24.3'
+  VERSION = '0.9.25'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nfg_ui
 version: !ruby/object:Gem::Version
-  version: 0.9.24.3
+  version: 0.9.25
 platform: ruby
 authors:
 - Jonathan Roehm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2019-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap
@@ -749,6 +749,7 @@ files:
 - lib/nfg_ui/components/utilities/resource_themeable.rb
 - lib/nfg_ui/components/utilities/titleable.rb
 - lib/nfg_ui/components/utilities/traitable.rb
+- lib/nfg_ui/components/utilities/traits/trait_utilities.rb
 - lib/nfg_ui/components/utilities/vertically_alignable.rb
 - lib/nfg_ui/engine.rb
 - lib/nfg_ui/ui/base.rb