block-kit 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e870bbe818fc81700e8112f99de5ddad4c27340d6e0cebc89d536f63e2a90123
-  data.tar.gz: 786f5df43117cf99fdcdf5a31886a5618bd5f19a6c360978906c6aa24033d32d
+  metadata.gz: b66e1897645e7673dc805967bf49b12ac5e122df9dd36d6bdc1eac77934eaf0d
+  data.tar.gz: cbbfa5ba5211f551c8fb614f734b5591fd6b2623ac9a3b40c515999778fdc9db
 SHA512:
-  metadata.gz: 551382789b7591dd7041236cc4504d8defe7e94b087ed7107eae2f3c77520bb7e92360256e2f9d597bf133c864d47b361b479d28cf153e6b415034b5275df08c
-  data.tar.gz: 854d019c85780c5242915319bf86a583b74c8f6ea0fc3aaa2dae2315255c36fe0ec0c86edcd85cbbcd564b5540a9e5504215ce4ea7126ea33d202cc7a1f0933d
+  metadata.gz: 3f3814f0b9701db69348f0437189fa92e86f7104f9748cb3bb276f20febbffb3d5ce3dff0b60bc800ba2ebd7ae1241963a18079092f1b3ece394e3282abe192a
+  data.tar.gz: 402c7b4b27743fb33a1e9241f6a310578cd2ad712be33551212caf98f4b01fa3d589732988e761e16409467aad4df6612371e64e7c7374b4d3716e64a7cba3f2

data/README.md

@@ -18,7 +18,7 @@ gem install block-kit
 
 ## Usage
 
-Blocks can be built individually or as a surface or collection of blocks, which each block able to initialize with a simple Hash or attributes or via a block-based DSL. For example, each of the following declarations would result in the same `section` block:
+Blocks can be built individually or as a surface or collection of blocks, which each block able to initialize with a simple Hash of attributes or via a block-based DSL. For example, each of the following declarations would result in the same `section` block:
 
 ```ruby
 require "block-kit"
@@ -180,4 +180,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Block::Kit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/davidcelis/block-kit/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the project's codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/davidcelis/block-kit/blob/main/CODE_OF_CONDUCT.md).
+
+## Acknowledgements
+
+Special thanks to [FireHydrant](https://firehydrant.com) for allowing me to build the initial version on the job (and therefore sponsoring the project)!

data/lib/block-kit.rb

@@ -0,0 +1 @@
+require_relative "block_kit"

data/lib/block_kit/base.rb

@@ -29,8 +29,8 @@ module BlockKit
       attribute_fixers[:base] << {name: method_name, dangerous: dangerous}
     end
 
-    def self.inherited(base)
-      base.attribute_fixers = attribute_fixers.dup
+    def self.inherited(subclass)
+      subclass.attribute_fixers = attribute_fixers.deep_dup
     end
 
     def initialize(attributes = {})

data/lib/block_kit/composition/option.rb

@@ -25,6 +25,10 @@ module BlockKit
       validates :description, presence: true, length: {maximum: MAX_DESCRIPTION_LENGTH}, allow_nil: true
       fixes :description, truncate: {maximum: MAX_DESCRIPTION_LENGTH}, null_value: [:blank]
 
+      def self.inherited(subclass)
+        subclass.attribute_fixers = attribute_fixers.deep_dup
+      end
+
       def initial?
         !!initial
       end

data/lib/block_kit/composition/text.rb

@@ -11,6 +11,10 @@ module BlockKit
 
       delegate :blank?, :present?, to: :text
 
+      def self.inherited(subclass)
+        subclass.attribute_fixers = attribute_fixers.deep_dup
+      end
+
       def length
         text&.length || 0
       end

data/lib/block_kit/elements/base.rb

@@ -9,6 +9,10 @@ module BlockKit
       validates :action_id, presence: true, length: {maximum: MAX_ACTION_ID_LENGTH}, allow_nil: true
       fixes :action_id, truncate: {maximum: MAX_ACTION_ID_LENGTH, dangerous: true, omission: ""}, null_value: {error_types: [:blank]}
 
+      def self.inherited(subclass)
+        subclass.attribute_fixers = attribute_fixers.deep_dup
+      end
+
       def initialize(attributes = {})
         raise NotImplementedError, "#{self.class} is an abstract class and can't be instantiated." if instance_of?(Base)
 

data/lib/block_kit/elements/base_button.rb

@@ -27,6 +27,10 @@ module BlockKit
       validates :accessibility_label, presence: true, length: {maximum: MAX_ACCESSIBILITY_LABEL_LENGTH}, allow_nil: true
       fixes :accessibility_label, truncate: {maximum: MAX_ACCESSIBILITY_LABEL_LENGTH}, null_value: {error_types: [:blank]}
 
+      def self.inherited(subclass)
+        subclass.attribute_fixers = attribute_fixers.deep_dup
+      end
+
       def initialize(attributes = {})
         raise NotImplementedError, "#{self.class} is an abstract class and can't be instantiated." if instance_of?(BaseButton)
 

data/lib/block_kit/elements/multi_select.rb

@@ -7,6 +7,10 @@ module BlockKit
       validates :max_selected_items, presence: true, numericality: {only_integer: true, greater_than: 0}, allow_nil: true
       fixes :max_selected_items, null_value: {error_types: [:greater_than]}
 
+      def self.inherited(subclass)
+        subclass.attribute_fixers = attribute_fixers.deep_dup
+      end
+
       def initialize(attributes = {})
         raise NotImplementedError, "#{self.class} is an abstract class and can't be instantiated." if instance_of?(MultiSelect)
 

data/lib/block_kit/elements/select.rb

@@ -8,6 +8,10 @@ module BlockKit
       include Concerns::HasPlaceholder
       include Concerns::PlainTextEmojiAssignment.new(:placeholder)
 
+      def self.inherited(subclass)
+        subclass.attribute_fixers = attribute_fixers.deep_dup
+      end
+
       def initialize(attributes = {})
         raise NotImplementedError, "#{self.class} is an abstract class and can't be instantiated." if instance_of?(Select)
 

data/lib/block_kit/layout/base.rb

@@ -9,6 +9,10 @@ module BlockKit
       validates :block_id, presence: true, length: {maximum: MAX_BLOCK_ID_LENGTH}, allow_nil: true
       fixes :block_id, truncate: {maximum: MAX_BLOCK_ID_LENGTH, dangerous: true, omission: ""}, null_value: {error_types: [:blank]}
 
+      def self.inherited(subclass)
+        subclass.attribute_fixers = attribute_fixers.deep_dup
+      end
+
       def initialize(attributes = {})
         raise NotImplementedError, "#{self.class} is an abstract class and can't be instantiated." if instance_of?(Base)
 

data/lib/block_kit/surfaces/base.rb

@@ -45,6 +45,10 @@ module BlockKit
       dsl_method :blocks, as: :section, type: Layout::Section
       dsl_method :blocks, as: :video, type: Layout::Video, required_fields: [:alt_text, :title, :thumbnail_url, :video_url], yields: false
 
+      def self.inherited(subclass)
+        subclass.attribute_fixers = attribute_fixers.deep_dup
+      end
+
       def initialize(attributes = {})
         raise NotImplementedError, "#{self.class} is an abstract class and can't be instantiated." if instance_of?(Base)
 

data/lib/block_kit/surfaces/modal.rb

@@ -50,7 +50,9 @@ module BlockKit
       fixes :close, truncate: {maximum: MAX_BUTTON_LENGTH}, null_value: {error_types: [:blank]}
 
       validates :submit, presence: true, length: {maximum: MAX_BUTTON_LENGTH}, allow_nil: true
+      validate :submit_present_if_contains_input
       fixes :submit, truncate: {maximum: MAX_BUTTON_LENGTH}, null_value: {error_types: [:blank]}
+      fix :add_default_submit_button
 
       def initialize(attributes = {})
         attributes = attributes.with_indifferent_access
@@ -69,6 +71,20 @@ module BlockKit
           submit_disabled: submit_disabled
         ).compact
       end
+
+      private
+
+      def submit_present_if_contains_input
+        errors.add(:submit, "can't be blank when blocks contain input elements") if contains_input? && submit.blank?
+      end
+
+      def add_default_submit_button
+        self.submit = "Submit" if contains_input? && submit.blank?
+      end
+
+      def contains_input?
+        blocks.any? { |block| block.is_a?(Layout::Input) }
+      end
     end
   end
 end

data/lib/block_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlockKit
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: block-kit
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - David Celis
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -50,6 +50,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/block-kit.rb
 - lib/block_kit.rb
 - lib/block_kit/base.rb
 - lib/block_kit/blocks.rb
@@ -71,7 +72,6 @@ files:
 - lib/block_kit/concerns/confirmable.rb
 - lib/block_kit/concerns/conversation_selection.rb
 - lib/block_kit/concerns/dispatchable.rb
-- lib/block_kit/concerns/dsl_generation.rb
 - lib/block_kit/concerns/external.rb
 - lib/block_kit/concerns/focusable_on_load.rb
 - lib/block_kit/concerns/has_initial_option.rb
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.6
 specification_version: 4
 summary: A powerful DSL-based library for Slack's Block Kit framework.
 test_files: []

data/lib/block_kit/concerns/dsl_generation.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module BlockKit
-  module Concerns
-    module DSLGeneration
-      extend ActiveSupport::Concern
-
-      class_methods do
-        private
-
-        def dsl_method(attribute, as: nil, type: nil, required_fields: [], mutually_exclusive_fields: [], yields: true)
-          type ||= attribute_types[attribute.to_s]
-          type = Types::Generic.of_type(type) if type.is_a?(Class) && type < BlockKit::Base
-          raise ArgumentError, "attribute #{attribute} does not exist" if type.instance_of?(ActiveModel::Type::Value)
-
-          is_array_attribute = false
-
-          if type.instance_of?(Types::Array)
-            is_array_attribute = true
-            type = type.item_type
-          end
-
-          is_array_attribute ||= attribute_types[attribute.to_s].type == :array
-
-          fields = type.block_class.attribute_names.map(&:to_sym)
-          plain_text_fields = type.block_class.attribute_types.select { |_, v| v.respond_to?(:block_class) && v.block_class == Composition::PlainText }.keys.map(&:to_sym)
-
-          define_method(as || attribute) do |args = {}, &block|
-            args = args.symbolize_keys
-
-            # Return the existing attribute if no args or block are passed and we're not in a custom-named method
-            return super() if args.blank? && block.nil? && as.nil?
-
-            if (missing_required_fields = (required_fields - args.keys)) && missing_required_fields.any?
-              message = "missing keyword#{"s" if missing_required_fields.size > 1}: #{missing_required_fields.map(&:inspect).join(", ")}"
-              raise ArgumentError, message
-            end
-
-            unknown_fields = (args.keys - fields)
-            unknown_fields.delete(:emoji) if plain_text_fields.any?
-
-            if unknown_fields.any?
-              message = "unknown keyword#{"s" if unknown_fields.size > 1}: #{unknown_fields.map(&:inspect).join(", ")}"
-              raise ArgumentError, message
-            end
-
-            mutually_exclusive = mutually_exclusive_fields & args.keys
-            if mutually_exclusive.length > 1
-              message = "mutually exclusive keywords: #{mutually_exclusive.map(&:inspect).join(", ")}"
-              raise ArgumentError, message
-            end
-
-            new_value = if is_array_attribute
-              public_send(:"#{attribute}=", []) if public_send(attribute).nil?
-              public_send(attribute) << type.cast(args)
-              public_send(attribute).last
-            else
-              public_send(:"#{attribute}=", type.cast(args))
-              public_send(attribute)
-            end
-
-            plain_text_fields.each do |field|
-              next unless args.key?(field)
-
-              new_value.public_send(field).emoji = args[:emoji] if args.key?(:emoji)
-            end
-
-            block&.call(new_value) if yields
-
-            self
-          end
-        end
-      end
-    end
-  end
-end