spark-component 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 707be6971c26fd122f03a9da00e0396b2b6cb5eaac221ce27a94a884e865b2db
-  data.tar.gz: 375416e9a317b550911aaabf4509cb6eb8e827aa8b39bad7987808cb452c0829
+  metadata.gz: 1be4ebc3a6ecf66978f87558cbc83f349fcf41e15b4aff6aa9e5609d88b12a5f
+  data.tar.gz: 4a94a2bf74570d0f9cc7b531bb4d815c2e068c92162390d9da08e0885f3e6576
 SHA512:
-  metadata.gz: 870ddc6e2e84950a12f59525294f00f8968f9e75ce52631fc9a029d4a51cd7f80cd911e69372c060a13c08dfae13567634d6f12469da5e62755c7d2dfb5f16c3
-  data.tar.gz: 483b152823ed0f681257b826451747c4aa2e26497e350bb30231ea6fd593a7f9ff5971093ed6a7b2c6807590f31e37a9bfbb9033721dd242f4d90f66cc474f95
+  metadata.gz: 699b6ed45fd2c908648bdd7a78c09dcb916e1289e414181dbc0efef84b766eae81dd1694511e3ef499e0ae1b9ccb500e3e0154d9ffbd5695847436bd8e59557e
+  data.tar.gz: f588d817b0a446b3dff251c0b8687c6c712131aa50f9d652e0a63199b4a2a1f08ecc06d34678fc6072c28d7c8b966758e30e01568f72b54637376b6f8e826cf3

data/.github/workflows/ruby.yml

@@ -18,3 +18,7 @@ jobs:
         gem install bundler
         bundle install --jobs 4 --retry 3
         bundle exec rake
+    - name: Rubocop checks
+      uses: gimenete/rubocop-action@1.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop.yml

@@ -1,8 +1,8 @@
 AllCops:
   TargetRubyVersion: 2.6.3
 
-Metrics/LineLength:
-  Max: 120
+Layout/LineLength:
+  Max: 100
 
 Metrics/MethodLength:
   Max: 20

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v1.1.0 - 2020-01-10
+
+- New: Class method `attribute_default_group` makes it easy to set defaults for multiple attributes based on a single component argument. It's great for theming, where setting `theme: :notice` can set attributes for color, layout, etc.
+- New: Class methods `tag_attribute`, `data_attribute`, and `aria_attribute` make it easy to sync component arguments to tag_attrs object.
+
 # v1.0.1 - 2020-01-08
 
 - Fix: added `deep_compact` to Attr and TagAttr to ensure that `nil` or `empty?` objects are ignored.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spark-component (1.0.1)
+    spark-component (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -91,7 +91,7 @@ GEM
     nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
     parallel (1.19.1)
-    parser (2.6.5.0)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -130,10 +130,10 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
-    rubocop (0.77.0)
+    rubocop (0.79.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)

data/lib/spark/component/attr.rb

@@ -38,9 +38,9 @@ module Spark
       end
 
       def deep_compact(hash)
-        hash.select do |key, val|
+        hash.reject do |_key, val|
           val = deep_compact(val) if val.is_a?(Hash)
-          !(val.nil? || val.respond_to?(:empty?) && val.empty?)
+          (val.nil? || val.respond_to?(:empty?) && val.empty?)
         end
       end
 

data/lib/spark/component/attribute.rb

@@ -43,13 +43,7 @@ require "spark/component/tag_attr"
 #
 module Spark
   module Component
-    BASE_ATTRIBUTES = {
-      id: nil,
-      class: nil,
-      data: {},
-      aria: {},
-      html: {}
-    }.freeze
+    BASE_ATTRIBUTES = %i[id class data aria html].freeze
 
     module Attribute
       # All components and elements will support these attributes
@@ -66,6 +60,11 @@ module Spark
       def initialize_attributes(attrs = nil)
         attrs ||= {}
 
+        # Filter out attributes which aren't defined by class method
+        attrs.select! { |key, _value| self.class.attributes.keys.include?(key) }
+
+        initialize_attribute_default_groups(attrs)
+
         self.class.attributes.each do |name, default|
           default = (!default.nil? ? default : nil)
           value = attrs[name].nil? ? default : attrs[name]
@@ -76,6 +75,28 @@ module Spark
         end
       end
 
+      def initialize_attribute_default_groups(attrs)
+        self.class.attribute_default_groups.each do |group, group_options|
+          # Determine what group name is set for this attribute.
+          name = attrs[group] || self.class.attributes[group]
+
+          # Get defaults to set from group name
+          defaults = group_options[name]
+
+          next unless defaults
+          unless defaults.is_a?(Hash)
+            raise("In argument group `:#{name}`, value `#{defaults}` must be a hash.")
+          end
+
+          defaults.each do |key, value|
+            if attrs[key].nil?
+              attrs[key] = value
+              instance_variable_set(:"@#{key}", value)
+            end
+          end
+        end
+      end
+
       def attribute(name)
         attributes[name]
       end
@@ -108,12 +129,17 @@ module Spark
         end
       end
 
-      # Initialize tag attributes from BASE_ATTRIBUTES
+      # Initialize tag attributes
       #
-      # If a component or element has arguments defined as base attributes
-      # they will automatically be added to the tag_attrs
+      # If a component or element defines tag_attributes, aria_attributes, or data_attributes
+      # Automatically assign add arguments to tag_attrs
       def tag_attrs
-        @tag_attrs ||= TagAttr.new.add attr_hash(*BASE_ATTRIBUTES.keys)
+        return @tag_attrs if @tag_attrs
+
+        @tag_attrs = TagAttr.new.add(attr_hash(*self.class.tag_attributes))
+        @tag_attrs.add(aria: attr_hash(*self.class.aria_attributes))
+        @tag_attrs.add(data: attr_hash(*self.class.data_attributes))
+        @tag_attrs
       end
 
       # Easy reference a tag's classname
@@ -142,7 +168,10 @@ module Spark
 
       module ClassMethods
         def attributes
-          @attributes ||= Spark::Component::BASE_ATTRIBUTES.dup
+          # Set attributes default to a hash using keys defined by BASE_ATTRIBUTES
+          @attributes ||= Spark::Component::BASE_ATTRIBUTES.each_with_object({}) do |val, obj|
+            obj[val] = nil
+          end
         end
 
         # Sets attributes, accepts an array of keys, pass a hash to set default values
@@ -177,7 +206,9 @@ module Spark
           name = :"attribute_#{name}"
 
           if (choices = options.delete(:choices))
-            supported_choices = choices.map { |c| c.is_a?(String) ? c.to_sym : c.to_s }.concat(choices)
+            supported_choices = choices.map do |c|
+              c.is_a?(String) ? c.to_sym : c.to_s
+            end.concat(choices)
 
             choices = choices.map(&:inspect).to_sentence(last_word_connector: ", or ")
             message = "\"%<value>s\" is not valid. Options include: #{choices}."
@@ -188,6 +219,57 @@ module Spark
           validates(name, options)
         end
 
+        # Store attributes to be added to tag_attrs
+        def tag_attributes
+          @tag_attributes ||= BASE_ATTRIBUTES.dup
+        end
+
+        # Store attributes to be added to tag_attrs aria
+        def aria_attributes
+          @aria_attributes ||= []
+        end
+
+        # Store attributes to be added to tag_attrs data
+        def data_attributes
+          @data_attributes ||= []
+        end
+
+        # Add attribute(s) and automatically add to tag_attr
+        def tag_attribute(*args)
+          attr_object = hash_from_args(*args)
+
+          if (aria_object = attr_object.delete(:aria))
+            attribute(aria_object)
+            aria_attributes.concat(aria_object.keys)
+          end
+
+          if (data_object = attr_object.delete(:data))
+            attribute(data_object)
+            data_attributes.concat(data_object.keys)
+          end
+
+          attribute(attr_object)
+          tag_attributes.concat(attr_object.keys)
+        end
+
+        # Add attribute(s) and automatically add to tag_attr's aria hash
+        def aria_attribute(*args)
+          tag_attribute(aria: hash_from_args(*args))
+        end
+
+        # Add attribute(s) and automatically add to tag_attr's data hash
+        def data_attribute(*args)
+          tag_attribute(data: hash_from_args(*args))
+        end
+
+        def attribute_default_group(object)
+          attribute_default_groups.merge!(object)
+        end
+
+        def attribute_default_groups
+          @attribute_default_groups ||= {}
+        end
+
         private
 
         # Store attributes and define methods for validation
@@ -200,6 +282,14 @@ module Spark
             instance_variable_get(:"@#{name}")
           end
         end
+
+        # Convert mixed arguments to a hash
+        # Example: (:a, :b, c: true) => { a: nil, b: nil, c: true }
+        def hash_from_args(*args)
+          args.each_with_object({}) do |arg, obj|
+            arg.is_a?(Hash) ? obj.merge!(arg) : obj[arg] = nil
+          end
+        end
       end
     end
   end

data/lib/spark/component/element.rb

@@ -200,7 +200,7 @@ module Spark
 
         private
 
-        # If an element extends a component, extend that component's class and include the necessary modules
+        # If an element extends a component, extend that class and include necessary modules
         def extend_class(component, &config)
           base = Class.new(component || Spark::Component::Element::Base, &config)
           define_model_name(base) if defined?(ActiveModel)
@@ -211,12 +211,15 @@ module Spark
           base.define_singleton_method(:source_component) { component }
 
           # Override component when used as an element
-          base.include(Spark::Component::Integration::Element) if defined?(Spark::Component::Integration)
+          if defined?(Spark::Component::Integration)
+            base.include(Spark::Component::Integration::Element)
+          end
 
           base
         end
 
-        # ActiveModel validations require a model_name. This helps connect new classes to their proper model names.
+        # ActiveModel validations require a model_name.
+        # This connects new classes to their proper model names.
         def define_model_name(klass)
           klass.define_singleton_method(:model_name) do
             # try the current class, the parent class, or default to Spark::Component

data/lib/spark/component/version.rb

@@ -2,6 +2,6 @@
 
 module Spark
   module Component
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spark-component
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview-component