tag_options 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5fb04a9c092cabe732ee9a7807861f8a2587b22e9221836d42bf9c2400856be
+  data.tar.gz: 229782a164b543562f6f988a7afb486c26715d55f825862bd4a32b0dfd33e42c
+SHA512:
+  metadata.gz: 484238573bfd185df2f607efff78d33258c2dbbeff55498ebf1d5d39e9610e374676d8e0a0ebafc32b39bf942717c21e843290d724b3f3ec129a5936ccaf7bb7
+  data.tar.gz: 5705a6389364ef3d5761e77b96d41dec2ac225f7deaefcf3995a462221f09aaf65037c3f38b7f838d42021731d1ed82630e0393326f4e023201c87755a599b16

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [Unreleased]
+
+## [0.9.0] - 2021-11-03
+
+- Initial release

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Alex Monroe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,175 @@
+# Tag Options
+
+Simple library for manipulating options passed to the Rails `tag`, `content_tag`, and other tag helpers.
+
+This library provides a simple class to make authoring resuable helpers and [View Components](https://viewcomponent.org)
+easier when you want to allow for the input of attributes on HTML elements, but also need to add/set your own.
+
+`TagOptions::Hash` is an object that normalizes the options passed to Rails helper, while providing helpful methods
+to manipulate the values of HTML attributes:
+
+```ruby
+def external_link_to(name, url, options={})
+  options = TagOptions::Hash.new(options)
+  options.combine_with_class!('external-link')
+  link_to(name, url, options)
+end
+```
+
+Called with:
+
+```ruby
+external_link_to('Example', 'https://example.com', class: 'ml-2')
+```
+
+Would render:
+
+```html
+<a href="https://example.com" class="ml-2 external-link">Example</a>
+```
+
+## Table of Contents
+
+- [Installation](#installation)
+- [General Usage](#general-usage)
+  - [combine_with!](#combinewith)
+  - [override!](#override)
+- [Conditional Usage](#conditional-usage)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tag_options'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+## General Usage
+
+Initialize a `TagOptions::Hash` directly or by passing an existing `Hash`.
+
+```ruby
+TagOptions::Hash.new
+=> {}
+
+hash = {class: 'flex'}
+TagOptions::Hash.new(hash)
+=> {:class=>"flex"}
+```
+
+### combine_with!
+
+Combine HTML attributes with an existing `TagOptions::Hash` using `combine_with!`
+
+```ruby
+options = TagOptions::Hash.new(class: 'flex')
+options.combine_with!(class: 'mt-1')
+=> {:class=>"flex mt-1"}
+```
+
+Values can also be specified as arrays.
+
+```ruby
+options = TagOptions::Hash.new(class: 'flex')
+options.combine_with!(class: ['mt-1', 'mx-2'])
+=> {:class=>"flex mt-1 mx-2"}
+```
+
+HTML attributes are only added if they don't already exist.
+
+```ruby
+options = TagOptions::Hash.new(class: 'flex')
+options.combine_with!(class: 'flex flex-col')
+=> {:class=>"flex flex-col"}
+```
+
+You can also combine multiple HTML attributes in one operation.
+
+```ruby
+options = TagOptions::Hash.new(class: 'flex')
+options.combine_with!(class: 'mt-1', 'data-controller': 'dropdown')
+=> {:class=>"flex mt-1", :"data-controller"=>"dropdown"}
+```
+
+Dash seperated HTML attributes, such as `data-controller` can also be specified as nested hashes.
+
+```ruby
+options = TagOptions::Hash.new(class: 'flex')
+options.combine_with!(class: 'mt-1', data: { controller: 'dropdown' })
+=> {:class=>"flex mt-1", :"data-controller"=>"dropdown"}
+```
+
+Dash seperated HTML attributes can also be specified using underscores.
+
+```ruby
+options = TagOptions::Hash.new(class: 'flex')
+options.combine_with!(class: 'mt-1', data_controller: 'dropdown')
+=> {:class=>"flex mt-1", :"data-controller"=>"dropdown"}
+```
+
+For ease of use, you can also combine values into a single HTML attribute using `combine_with_<attribute>!`, where
+`<attribute>` is the name of the HTML attribute. Dash seperated HTML attributes should be specified using underscores.
+
+```ruby
+options = TagOptions::Hash.new(class: 'flex')
+options.combine_with_class! 'mt-1'
+options.combine_with_data_controller! 'dropdown'
+=> {:class=>"flex mt-1", :"data-controller"=>"dropdown"}
+```
+
+### override!
+
+The method `override!` functions nearly the same as `combine_with!` with all same usage patterns, including ease of
+use methods, such as `override_class!`. The major difference is that the override methods will not combine specified
+values with existing values. Any specified values will override any existing values.
+
+## Conditional Usage
+
+Both the `combine_with!` and `override!` allow for values to be conditionally added to HTML attributes using an argument
+array. Where the values are added unconditionally and key/value pairs have their key added _IF_ the value is true.
+
+```ruby
+# assuming `centered?` returns `true`
+options = TagOptions::Hash.new(class: 'flex')
+options.combine_with!(class: ['mt-1', 'mx-auto': centered?, 'mx-2': !centered?])
+=> {:class=>"flex mt-1 mx-auto"}
+```
+
+The syntax of the `combine_with_<attribute>!` and `override_<attribute>!` ease of use method allow for values and
+conditional values to be combined more naturally using a more typical argument pattern.
+
+```ruby
+# assuming `centered?` returns `true`
+options = TagOptions::Hash.new(class: 'flex')
+options.combine_with_class!('mt-1', 'mx-auto': centered?, 'mx-2': !centered?)
+=> {:class=>"flex mt-1 mx-auto"}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can
+also run:
+
+- `bin/console` for an interactive prompt that will allow you to experiment
+- `bin/rubocop` to run RuboCop to check the code style and formatting
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wamonroe/tag_options.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/tag_options/hash.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string'
+require 'forwardable'
+
+module TagOptions
+  class Hash
+    extend Forwardable
+
+    def_delegators :@data, :inspect, :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
+      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)]
+    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)
+      if value.is_a?(::Hash)
+        flatten_hash({ key => value }).each do |flat_key, flat_value|
+          @data[normalize_key(flat_key)] = flat_value
+        end
+      else
+        @data[normalize_key(key)] = 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
+    # 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`).
+    #
+    #   #combine_with!(
+    #     class: ['flex', 'mt-2', 'flex-col': layout_column?],
+    #     data: {
+    #       controller: ['dropdown', 'navbar': navbar?]
+    #     }
+    #   )
+    #
+    # TagOptions::Hash also responses to combine_with_<name>!, where `<name>` is the name of the HTML attribute to
+    # combine the passed argument array with. If `<name>` is specified with a value containing underscores, the HTML
+    # 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)
+      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
+    # 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`).
+    #
+    #   #override!(
+    #     class: ['flex', 'mt-2', 'flex-col': layout_column?],
+    #     data: {
+    #       controller: ['dropdown', 'navbar': navbar?]
+    #     }
+    #   )
+    #
+    # TagOptions::Hash also responses to override_<name>!, where `<name>` is the name of the HTML attribute to override
+    # the passed argument array on. If `<name>` is specified with a value containing underscores, the resulting HTML
+    # 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)
+      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(' ')
+    end
+
+    def flatten_hash(hash)
+      hash.each_with_object({}) do |(key, value), result|
+        if value.is_a?(::Hash)
+          flatten_hash(value).map do |nested_key, nested_value|
+            result["#{key}-#{nested_key}".to_sym] = nested_value
+          end
+        else
+          result[key] = value
+        end
+      end
+    end
+
+    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)
+      else
+        super
+      end
+    end
+
+    def normalize_key(key)
+      key.to_s.downcase.dasherize.to_sym
+    end
+
+    def resolve_conditions(conditions)
+      conditions.select { |_key, value| value }.keys
+    end
+
+    def respond_to_missing?(method_name, include_private=false)
+      action_matcher.match?(method_name.to_s) || super
+    end
+  end
+end

data/lib/tag_options/railtie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module TagOptions
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/tag_options/version.rb

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

data/lib/tag_options.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'tag_options/hash'
+require 'tag_options/railtie'
+require 'tag_options/version'

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: tag_options
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Alex Monroe
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description: Simple library for manipulating options passed to various Rails tag helpers.
+email:
+- alex@monroepost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tag_options.rb
+- lib/tag_options/hash.rb
+- lib/tag_options/railtie.rb
+- lib/tag_options/version.rb
+homepage: https://github.com/wamonroe/tag_options
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wamonroe/tag_options
+  source_code_uri: https://github.com/wamonroe/tag_options
+  changelog_uri: https://github.com/wamonroe/tag_options/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Simple library for manipulating options passed to various Rails tag helpers.
+test_files: []