tag_options 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5fb04a9c092cabe732ee9a7807861f8a2587b22e9221836d42bf9c2400856be
-  data.tar.gz: 229782a164b543562f6f988a7afb486c26715d55f825862bd4a32b0dfd33e42c
+  metadata.gz: 83e261e9adfa9aeb2c3dff7ea1a96feef6b879643232d84135739204bbac2eb1
+  data.tar.gz: 4f5017d33651e2274f6a28200c402e840ec044c5c33e9458f73720177cbf6cc1
 SHA512:
-  metadata.gz: 484238573bfd185df2f607efff78d33258c2dbbeff55498ebf1d5d39e9610e374676d8e0a0ebafc32b39bf942717c21e843290d724b3f3ec129a5936ccaf7bb7
-  data.tar.gz: 5705a6389364ef3d5761e77b96d41dec2ac225f7deaefcf3995a462221f09aaf65037c3f38b7f838d42021731d1ed82630e0393326f4e023201c87755a599b16
+  metadata.gz: abd1baed79e11a1ecbf6bef278a4d607400e2aaedbe5b3d6d62b9b7480ff2acb4b47091f476c199cffd40ead699be7edcb18f4e5f4e68d90e2fc16e35618c073
+  data.tar.gz: 3606249e0673f84f8f00a407c2fe9f73eea3286e1309f10fca238ca906ff3aef8da4e20114eba04e097622317ba5cf74c534f032cb3367e8b2936ec94dac977d

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
-## [0.9.0] - 2021-11-03
+## [0.9.0] - 2021-11-04
 
 - Initial release
+
+## [0.9.1] - 2021-11-08
+
+- Implement property handling

data/README.md

@@ -31,12 +31,14 @@ Would render:
 ## Table of Contents
 
 - [Installation](#installation)
+- [Configuration](#configuration)
 - [General Usage](#general-usage)
   - [combine_with!](#combinewith)
   - [override!](#override)
 - [Conditional Usage](#conditional-usage)
 - [Development](#development)
 - [Contributing](#contributing)
+- [To Do](#to-do)
 - [License](#license)
 
 ## Installation
@@ -53,6 +55,14 @@ And then execute:
 bundle install
 ```
 
+## Configuration
+
+Generate an initializer to customize the default configuration:
+
+```sh
+rails generate arc_options:install
+```
+
 ## General Usage
 
 Initialize a `TagOptions::Hash` directly or by passing an existing `Hash`.

data/lib/generators/tag_options/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Creates a new initializer containing the default settings of the gem.
+
+Examples:
+  `rails generate tag_options:install`
+
+    Creates the following:
+
+      Initializer:  config/tag_options.rb

data/lib/generators/tag_options/install/install_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TagOptions
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def copy_initializer
+      copy_file 'tag_options.rb', 'config/initializers/tag_options.rb'
+    end
+  end
+end

data/lib/generators/tag_options/install/templates/tag_options.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+TagOptions.configure do |config|
+  # fallback_property_handler
+  #
+  # Defines the default behavior of how values are treated on HTML properties. `TagOptions::PropertyHandler::Generic`
+  # allows for multiple, unique, values seperated by spaces.
+  config.fallback_property_handler = 'TagOptions::PropertyHandler::Generic'
+
+  # property_handlers
+  #
+  # Allows of the custom handling of HTML properties that match the defined property handler. Properties are handled by
+  # the first matching property handler.
+  config.property_handlers = [
+    'TagOptions::PropertyHandler::Singular',
+    'TagOptions::PropertyHandler::Style'
+  ]
+end

data/lib/tag_options/configuration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module TagOptions
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= TagOptions::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_writer :fallback_property_handler, :property_handlers
+
+    def fallback_property_handler
+      @fallback_property_handler ||= 'TagOptions::PropertyHandler::Generic'
+    end
+
+    def property_handlers
+      @property_handlers ||= [
+        'TagOptions::PropertyHandler::Singular',
+        'TagOptions::PropertyHandler::Style'
+      ]
+    end
+  end
+end

data/lib/tag_options/hash.rb

@@ -2,49 +2,50 @@
 
 require 'active_support/core_ext/string'
 require 'forwardable'
+require 'tag_options/property_handler/resolve_value'
 
 module TagOptions
   class Hash
     extend Forwardable
 
-    def_delegators :@data, :inspect, :to_s, :stringify_keys, :<, :<=, :==, :>, :>=
+    def_delegators :@data, :inspect, :to_h, :to_hash, :to_s, :stringify_keys, :<, :<=, :==, :>, :>=
 
     # Hashes passed into the initializer are automatically flattened, with nested keys seperated by dashes. For example,
     # `data: { controller: 'dropdown' }`` becomes `'data-controller': 'dropdown'`.
     def initialize(hash={})
       @data = {}
-      flatten_hash(hash).each do |key, value|
-        self[key] = value
+      flatten_hash(hash).each do |property, value|
+        self[property] = value
       end
     end
 
     # []
-    # Underscores in a key name is automatically coverted to dashes. Keys can be specified as strings or symbols, both
-    # return the same value.
-    def [](key)
-      @data[normalize_key(key)]
+    # Underscores in a property name is automatically coverted to dashes. Properties can be specified as strings or
+    # symbols, both return the same value.
+    def [](property)
+      @data[normalize_property(property)]
     end
 
     # []=
-    # Hashes assigned to a key are automatically flatten, with nested keys seperated by dashes. Underscores in a key
-    # name is automatically converted to dashes. Keys can be specified as strings or symbols, both will assign the value
-    # to the same key.
-    def []=(key, value)
+    # Hashes assigned to a property are automatically flatten, with nested keys seperated by dashes. Underscores in a
+    # property name are automatically converted to dashes. Propertiess can be specified as strings or symbols, both will
+    # assign the value to the same property.
+    def []=(property, value)
       if value.is_a?(::Hash)
-        flatten_hash({ key => value }).each do |flat_key, flat_value|
-          @data[normalize_key(flat_key)] = flat_value
+        flatten_hash({ property => value }).each do |flat_property, flat_value|
+          store(flat_property, flat_value)
         end
       else
-        @data[normalize_key(key)] = value
+        store(property, value)
       end
     end
 
     # combine_with!
     # Allows you to combine values with multiple HTML attributes in one operation. Passed keys should be the HTML
-    # attributes to combine the values with. The values can be passed as single value (e.g. `class: 'flex'`) or as an
+    # property to combine the values with. The values can be specified as single string (e.g. `class: 'flex'`) or as an
     # argument array (e.g. `class: ['flex', 'mt-2', 'flex-col':  layout_column?]`). Hashes in an argument array have
     # their keys combined only their value is true. Nested keys will automatically be flattened and combine with the
-    # associated key (e.g. `data: { controller: 'dropdown' }` would be combined with `data-controller`).
+    # associated property (e.g. `data: { controller: 'dropdown' }` would be combined with `data-controller`).
     #
     #   #combine_with!(
     #     class: ['flex', 'mt-2', 'flex-col': layout_column?],
@@ -58,18 +59,18 @@ module TagOptions
     # attribute is converted to dashes, for example: `combine_with_data_controller!` will result in the argument array
     # being combined with existing values in `data-controller`.
     def combine_with!(hash={})
-      flatten_hash(hash).each do |key, args|
-        self[key] = combine_values(self[key], *args)
+      flatten_hash(hash).each do |property, args|
+        store(property, self[property], *args)
       end
       self
     end
 
     # override!
-    # Allows you to override values on multiple HTML attributes in one operation. Passed keys should be the HTML
-    # attributes to override the values of. The values can be passed as single string (e.g. `class: 'flex'`) or as an
+    # Allows you to override values on multiple HTML properties in one operation. Passed keys should be the HTML
+    # properties to override the values of. The values can be passed as single string (e.g. `class: 'flex'`) or as an
     # argument array (e.g. `class: ['flex', 'mt-2', 'flex-col':  layout_column?]`). Hashes in an argument array have
     # their keys added only if their value is true. Nested keys will automatically be flattened and override the value
-    # at the associated key (e.g. `data: { controller: 'dropdown' }` would override values at `data-controller`).
+    # at the associated property (e.g. `data: { controller: 'dropdown' }` would override values at `data-controller`).
     #
     #   #override!(
     #     class: ['flex', 'mt-2', 'flex-col': layout_column?],
@@ -83,35 +84,26 @@ module TagOptions
     # attribute is automatically nested, for example `override_data_controller!` will result in the argument array
     # overriding the existing values in `data-controller`.
     def override!(hash={})
-      flatten_hash(hash).each do |key, args|
-        self[key] = combine_values(*args)
+      flatten_hash(hash).each do |property, args|
+        store(property, *args)
       end
       self
     end
 
-    def to_h
-      @data.transform_values { |value| value.is_a?(::TagOptions::Hash) ? value.to_h : value }
-    end
-    alias to_hash to_h
-
   private
 
     def action_matcher
-      /\A(?<action>combine_with|override)_(?<key>.*)!\z/
-    end
-
-    def combine_values(*values, **conditions)
-      [*values, *resolve_conditions(conditions.to_h)].map { |v| v.to_s.split }.flatten.compact.uniq.join(' ')
+      /\A(?<action>combine_with|override)_(?<property>.*)!\z/
     end
 
     def flatten_hash(hash)
-      hash.each_with_object({}) do |(key, value), result|
+      hash.each_with_object({}) do |(property, value), result|
         if value.is_a?(::Hash)
-          flatten_hash(value).map do |nested_key, nested_value|
-            result["#{key}-#{nested_key}".to_sym] = nested_value
+          flatten_hash(value).map do |nested_property, nested_value|
+            result["#{property}-#{nested_property}".to_sym] = nested_value
           end
         else
-          result[key] = value
+          result[property] = value
         end
       end
     end
@@ -119,18 +111,24 @@ module TagOptions
     def method_missing(method_name, *args, &block)
       match_data = action_matcher.match(method_name.to_s)
       if match_data
-        public_send("#{match_data['action']}!", { match_data['key'] => args }, &block)
+        public_send("#{match_data['action']}!", { match_data['property'] => args }, &block)
       else
         super
       end
     end
 
-    def normalize_key(key)
-      key.to_s.downcase.dasherize.to_sym
+    def store(property, *values, **conditions)
+      property = normalize_property(property)
+      value = resolve_value(property, *values, **conditions)
+      value.empty? ? @data.delete(property) : @data[property] = value
+    end
+
+    def resolve_value(property, *values, **conditions)
+      TagOptions::PropertyHandler::ResolveValue.call(property, *values, **conditions)
     end
 
-    def resolve_conditions(conditions)
-      conditions.select { |_key, value| value }.keys
+    def normalize_property(property)
+      property.to_s.downcase.dasherize.to_sym
     end
 
     def respond_to_missing?(method_name, include_private=false)

data/lib/tag_options/property_handler/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module TagOptions
+  module PropertyHandler
+    class Base
+      attr_reader :values, :conditions
+
+      def initialize(*values, **conditions)
+        @values = values
+        @conditions = conditions
+      end
+
+      def self.call(...)
+        new(...).call
+      end
+
+      def self.handler_for?(property_name)
+        self::MATCHER.match?(property_name.to_s)
+      end
+
+    private
+
+      def combine_values(*values, **conditions)
+        resolve_uniq_values(*values, **conditions).join(' ')
+      end
+
+      def resolve_uniq_values(*values, **conditions)
+        [*values, *resolve_conditions(conditions)].map { |v| v.to_s.split }.flatten.compact.uniq
+      end
+
+      def resolve_conditions(conditions)
+        conditions.select { |_key, value| value }.keys
+      end
+    end
+  end
+end

data/lib/tag_options/property_handler/generic.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'tag_options/property_handler/base'
+
+module TagOptions
+  module PropertyHandler
+    class Generic < Base
+      MATCHER = /\A.*\z/.freeze
+
+      def call
+        combine_values(*values, **conditions)
+      end
+    end
+  end
+end

data/lib/tag_options/property_handler/resolve_value.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'tag_options/configuration'
+
+module TagOptions
+  module PropertyHandler
+    class ResolveValue
+      attr_reader :property
+
+      def initialize(property)
+        @property = property
+      end
+
+      def call(...)
+        handler.call(...)
+      end
+
+      def self.call(property, *values, **conditions)
+        new(property).call(*values, **conditions)
+      end
+
+    private
+
+      def handler
+        TagOptions.configuration.property_handlers.each do |handler_string|
+          handler = handler_string.constantize
+          return handler if handler.handler_for?(property)
+        end
+        TagOptions.configuration.fallback_property_handler.constantize
+      end
+    end
+  end
+end

data/lib/tag_options/property_handler/singular.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'tag_options/property_handler/base'
+
+module TagOptions
+  module PropertyHandler
+    class Singular < Base
+      MATCHER = /\Aid|role|aria-.+\z/.freeze
+
+      def call
+        resolve_uniq_values(*values, **conditions).last.to_s
+      end
+    end
+  end
+end

data/lib/tag_options/property_handler/style.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'tag_options/property_handler/base'
+
+module TagOptions
+  module PropertyHandler
+    class Style < Base
+      MATCHER = /\Astyle\z/.freeze
+
+      def call
+        styles.map { |p, v| "#{p}: #{v};" }.join(' ')
+      end
+
+    private
+
+      def styles
+        styles_from_values.merge(styles_from_conditions)
+      end
+
+      def styles_from_values
+        style_hash_from(values)
+      end
+
+      def styles_from_conditions
+        style_hash_from(resolve_conditions(conditions))
+      end
+
+      def style_hash_from(strings)
+        {}.tap do |result|
+          Array(strings).each do |string|
+            string.to_s.split(';').compact.each do |property_value_pair|
+              property, value = property_value_pair.split(':')
+              next unless property && value
+
+              result[property.strip.downcase.to_sym] = value.strip
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tag_options/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TagOptions
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/lib/tag_options.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require 'tag_options/property_handler/base'
+require 'tag_options/property_handler/generic'
+require 'tag_options/property_handler/resolve_value'
+require 'tag_options/property_handler/singular'
+require 'tag_options/property_handler/style'
+require 'tag_options/configuration'
 require 'tag_options/hash'
 require 'tag_options/railtie'
 require 'tag_options/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tag_options
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Alex Monroe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -161,8 +161,17 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- lib/generators/tag_options/install/USAGE
+- lib/generators/tag_options/install/install_generator.rb
+- lib/generators/tag_options/install/templates/tag_options.rb
 - lib/tag_options.rb
+- lib/tag_options/configuration.rb
 - lib/tag_options/hash.rb
+- lib/tag_options/property_handler/base.rb
+- lib/tag_options/property_handler/generic.rb
+- lib/tag_options/property_handler/resolve_value.rb
+- lib/tag_options/property_handler/singular.rb
+- lib/tag_options/property_handler/style.rb
 - lib/tag_options/railtie.rb
 - lib/tag_options/version.rb
 homepage: https://github.com/wamonroe/tag_options