has_dom_attrs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 803cfad840b103564000efceae798dc50b5cbbf444e2ae63e84a09a1c311a4eb
+  data.tar.gz: '0093ccd0bebf0f0bd4c584304327bf5c67cec5bf76cdc89c41daaa915e2000c1'
+SHA512:
+  metadata.gz: d23685a4f676cd252678c90be4e972f9a6235d87f52f8ff1b48551c24407a2975a483c97802df3e201e8a569dd70c23d9083ee2467d815695c539829748b199b
+  data.tar.gz: 896d9e5bd69c15ee1dee4986539bebe6e1ef4e512bd8828d47a715ce653abb3622669b8883c80ad3283bb356e1b246a716fdb35b1ce919ccc8a82c0b5c1f896e

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+AllCops:
+  TargetRubyVersion: 3.1

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in has_dom_attrs.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Tomáš Celizna
+
+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,91 @@
+# HasDomAttrs
+
+[![HasDomAttrs](https://github.com/tomasc/has_dom_attrs/actions/workflows/ruby.yml/badge.svg)](https://github.com/tomasc/has_dom_attrs/actions/workflows/ruby.yml)
+
+Helper methods for dealing with html element attributes.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add has_dom_attrs
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install has_dom_attrs
+
+## Usage
+
+Include `HasDomAttrs` in your class:
+
+```ruby
+class Component
+  include HasDomAttrs
+end
+```
+
+This makes your component respond to `dom_attrs`, which returns a hash of class, data,
+aria, and style attributes, that can be passed to Rails tag helpers.
+
+```ruby
+component = Component.new
+tag.div "Hello world", **component.dom_attrs
+```
+
+You can define attributes using class methods:
+
+```ruby
+class DetailsComponent
+  include HasDomAttrs
+
+  has_dom_attr :open
+
+  attr_reader :open
+
+  def initialize(open: false)
+    @open = open
+  end
+end
+```
+
+```ruby
+component = Component.new(open: true)
+component.dom_attrs
+# => { open: "true" }
+```
+
+Likewise you can set classes, data, and aria attributes:
+
+```ruby
+class ModalComponent
+  include HasDomAttrs
+
+  has_dom_attr :open
+  has_dom_class -> { "modal--width_#{width}" }
+  has_dom_aria :aria_modal, if: :open
+  has_dom_data :width
+
+  attr_reader :open
+
+  def initialize(open: false, width: :m)
+    @open = open
+    @width = width
+  end
+end
+```
+
+```ruby
+component = ModalComponent.new(open: true, width: :l)
+component.dom_attrs
+# => { open: "true", class: "modal--width_l", aria: { modal: true }, data: { width: "l" } }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/[USERNAME]/has_dom_attrs.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/has_dom_attrs.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/has_dom_attrs/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "has_dom_attrs"
+  spec.version = HasDomAttrs::VERSION
+  spec.authors = ["Tomas Celizna", "Asger Behncke Jacobsen"]
+  spec.email = ["tomas.celizna@gmail.com", "a@asgerbehnckejacobsen.dk"]
+
+  spec.summary = "Helper methods for dealing with html element attributes."
+  spec.description = "Helper methods for dealing with html element attributes."
+  spec.homepage = "https://github.com/tomasc/has_dom_attrs"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/tomasc/has_dom_attrs/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_development_dependency "lefthook"
+  spec.add_development_dependency "rubocop-rails_config"
+end

data/lefthook.yml

@@ -0,0 +1,5 @@
+pre-commit:
+  parallel: true
+  commands:
+    rubocop:
+      run: bundle exec rubocop {staged_files} -A --display-cop-names --extra-details --force-exclusion

data/lib/has_dom_attrs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HasDomAttrs
+  VERSION = "0.1.0"
+end

data/lib/has_dom_attrs.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative "has_dom_attrs/version"
+
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/string/inflections"
+
+module HasDomAttrs
+  class << self
+    def included(base)
+      base.extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def has_dom_attr(name, value = nil, **options)
+      prepend___has_dom___method(:dom_attrs, name, value, **options)
+    end
+
+    def has_dom_aria(name, value = nil, **options)
+      prepend___has_dom___method(:dom_aria, name, value, **options)
+    end
+
+    def has_dom_data(name, value = nil, **options)
+      prepend___has_dom___method(:dom_data, name, value, **options)
+    end
+
+    def has_dom_class(value, **options)
+      prepend(
+        Module.new do
+          define_method :dom_classes do
+            cond = options[:if] || options[:unless]
+            cond_value = case cond
+                         when Proc then instance_exec(&cond)
+                         when Symbol, String then send(cond)
+            end
+
+            if cond && options.key?(:if)
+              return super() unless cond_value
+            end
+
+            if cond && options.key?(:unless)
+              return super() if cond_value
+            end
+
+            super().tap do |classes|
+              classes << case value
+                         when Proc then instance_exec(&value)
+                         when Symbol then send(value)
+                         else value
+              end
+            end
+          end
+        end
+      )
+    end
+
+    private
+      def prepend___has_dom___method(method_name, name, value = nil, **options)
+        prepend(
+          Module.new do
+            define_method method_name do
+              cond = options[:if] || options[:unless]
+              cond_value = case cond
+                           when Proc then instance_exec(&cond)
+                           when Symbol, String then send(cond)
+              end
+
+              if cond && options.key?(:if)
+                return super() unless cond_value
+              end
+
+              if cond && options.key?(:unless)
+                return super() if cond_value
+              end
+
+              super().tap do |data|
+                data[name] = case value
+                             when Proc then instance_exec(&value)
+                             when Symbol, String then send(value)
+                             else send(name)
+                end
+              end
+            end
+          end
+        )
+      end
+  end
+
+  def dom_attrs
+    {
+      aria: dom_aria,
+      class: dom_classes,
+      data: dom_data,
+      style: dom_style
+    }.reject { |_, v| v.nil? || v.empty? }
+      .deep_stringify_keys
+      .deep_transform_keys(&:dasherize)
+  end
+
+  def dom_classes
+    []
+  end
+
+  def dom_aria
+    {}
+  end
+
+  def dom_data
+    {}
+  end
+
+  def dom_style
+    nil
+  end
+end

data/sig/has_dom_attrs.rbs

@@ -0,0 +1,4 @@
+module HasDomAttrs
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: has_dom_attrs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Celizna
+- Asger Behncke Jacobsen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  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-rails_config
+  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'
+description: Helper methods for dealing with html element attributes.
+email:
+- tomas.celizna@gmail.com
+- a@asgerbehnckejacobsen.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- has_dom_attrs.gemspec
+- lefthook.yml
+- lib/has_dom_attrs.rb
+- lib/has_dom_attrs/version.rb
+- sig/has_dom_attrs.rbs
+homepage: https://github.com/tomasc/has_dom_attrs
+licenses: []
+metadata:
+  homepage_uri: https://github.com/tomasc/has_dom_attrs
+  source_code_uri: https://github.com/tomasc/has_dom_attrs
+  changelog_uri: https://github.com/tomasc/has_dom_attrs/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Helper methods for dealing with html element attributes.
+test_files: []