line-message-builder 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bbeb0eeec944a0886b6e6dec3b171c88182c0097ad31c03cc16d7270f1eb471
-  data.tar.gz: 8f08afeab2e40b152e8e4218b00f03f725be5f3cfa70b687ebaf20e7d1dd2d7e
+  metadata.gz: 8051ec09aa3f71ec93dc5cbe685610fd6fe6d5c4a3b086f5b5ddbef6b98e7c3c
+  data.tar.gz: cd043754cc232ed8b4e8cec6751413bf2f87e9cd3ea4b23f521346cb1ca7a86d
 SHA512:
-  metadata.gz: 0afd2ab03e4bbe7df364ebc27764380e48b9fd00a0a78ba345655f9227b7ff1cac00831024fd4ca923d2df1fb195c7e3c4947e6290f530a3466d002b325af4f3
-  data.tar.gz: 91455d81ccc9d6aa646e5a5851ad55baa19e89d4c427b4c9e4fa951676f6cf5d6e8005983d5a76610c05ced666a353d06f54ef7020516ad67250000cb4379ba7
+  metadata.gz: 4d951b1938f6a27ad366e5b4f08e1de7496c5d130ac95e40d4f15c2ca86a928a19a5cfb46184d958dae6afd664dfa68d4c50a2d7e00c172445e42205e3987abc
+  data.tar.gz: 802c37d5e9d2beb7f641046bf8223e9a4fc26290b5e9f1a5a07b1754027509b1b2b63952be93622908674d14321fe9c4cceea770aaf2d56684caaa94b1bb7d69

data/.release-please-manifest.json

@@ -1 +1 @@
-{".":"0.4.0"}
+{".":"0.5.0"}

data/.rspec

@@ -1,3 +1,5 @@
 --format documentation
+--format RspecJunitFormatter
+--out junit.xml
 --color
 --require spec_helper

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [0.5.0](https://github.com/elct9620/line-message-builder/compare/v0.4.0...v0.5.0) (2025-04-07)
+
+
+### Features
+
+* Add Actionable module for flex components with message and postback actions ([9ac4b4a](https://github.com/elct9620/line-message-builder/commit/9ac4b4af591450e8f1925814b5a57e893ffa15db))
+* Add enum validator for flex text alignment options ([540c58d](https://github.com/elct9620/line-message-builder/commit/540c58d94731adfe91d30e006bb0ee6714755006))
+* Add justify_content and align_items options to Flex Box builder ([6c2015f](https://github.com/elct9620/line-message-builder/commit/6c2015f0a75a0f541cb52fef647e0bff1a245a28))
+* Add layout validation for flex box with enum validator ([b1ecba1](https://github.com/elct9620/line-message-builder/commit/b1ecba160db03f94aaebc83b82158e75292c94eb))
+* Add margin support for flex components in Line message builder ([36043b8](https://github.com/elct9620/line-message-builder/commit/36043b8d7390cb13d60174759fc5906a70aa2507))
+* Add offset positioning support for flex message components ([1e28336](https://github.com/elct9620/line-message-builder/commit/1e2833656083aa72b0cfffccd5636e80ae41ccc9))
+* Add padding support for flex box components with validation ([9dcd9d2](https://github.com/elct9620/line-message-builder/commit/9dcd9d20a48aed023440a2abe24e8b44eea8b425))
+* Add padding support for Line Flex buttons with validation ([ca25a11](https://github.com/elct9620/line-message-builder/commit/ca25a1192c0d611ae064f935fc9335640d123b2d))
+* Add SimpleCov Cobertura formatter for CI coverage reporting ([bb5bfc8](https://github.com/elct9620/line-message-builder/commit/bb5bfc8344c1b448e61a2857aa36e1f6b5ce0425))
+* Add validator for spacing option in flex box builder ([06e7b98](https://github.com/elct9620/line-message-builder/commit/06e7b9805f8243c51faaf9c13c264ffb1f35091c))
+* Add vertical positioning support for Flex message components ([f9ce97b](https://github.com/elct9620/line-message-builder/commit/f9ce97b666cabe47717cdd916722121372cb9bf0))
+
+
+### Bug Fixes
+
+* Correct indentation in GitHub Actions workflow file ([1c1cd2d](https://github.com/elct9620/line-message-builder/commit/1c1cd2dfe2e48bd937a04ac25f7b2b772e02e1a6))
+
 ## [0.4.0](https://github.com/elct9620/line-message-builder/compare/v0.3.0...v0.4.0) (2025-04-06)
 
 

data/README.md

@@ -1,7 +1,16 @@
 # LINE Message Builder
 
+[![.github/workflows/main.yml](https://github.com/elct9620/line-message-builder/actions/workflows/main.yml/badge.svg)](https://github.com/elct9620/line-message-builder/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/elct9620/line-message-builder/graph/badge.svg?token=9TJTSRIL0X)](https://codecov.io/gh/elct9620/line-message-builder)
+
 Build LINE messages using DSL (Domain Specific Language) in Ruby.
 
+## Features
+
+- Build LINE messages using DSL
+- Validation of properties
+- RSpec matchers for testing
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/line/message/builder/actions/message.rb

@@ -6,26 +6,23 @@ module Line
       module Actions
         # The Message class is used to build message actions for quick replies.
         class Message < Line::Message::Builder::Base
-          def initialize(text, label: nil, context: nil, &)
-            @text = text
-            @label = label
-
-            super(context: context, &)
-          end
+          attr_reader :text
 
-          def label(label)
-            @label = label
-          end
+          option :label, default: nil
 
-          def text(text)
+          def initialize(text, context: nil, **options, &)
             @text = text
+
+            super(context: context, **options, &)
           end
 
           def to_h
+            raise RequiredError, "text is required" if text.nil?
+
             {
               type: "message",
-              label: @label,
-              text: @text
+              label: label,
+              text: text
             }.compact
           end
         end

data/lib/line/message/builder/actions/postback.rb

@@ -6,32 +6,25 @@ module Line
       module Actions
         # The Postback class is used to build postback actions for quick replies.
         class Postback < Line::Message::Builder::Base
-          def initialize(data, label: nil, display_text: nil, context: nil, &)
-            @data = data
-            @label = label
-            @display_text = display_text
-
-            super(context: context, &)
-          end
+          attr_reader :data
 
-          def label(label)
-            @label = label
-          end
+          option :label, default: nil
+          option :display_text, default: nil
 
-          def data(data)
+          def initialize(data, context: nil, **options, &)
             @data = data
-          end
 
-          def display_text(display_text)
-            @display_text = display_text
+            super(context: context, **options, &)
           end
 
           def to_h
+            raise RequiredError, "data is required" if data.nil?
+
             {
               type: "postback",
-              label: @label,
-              data: @data,
-              displayText: @display_text
+              label: label,
+              data: data,
+              displayText: display_text
             }.compact
           end
         end

data/lib/line/message/builder/base.rb

@@ -18,13 +18,14 @@ module Line
             @options ||= []
           end
 
-          def option(name, default: nil)
+          def option(name, default: nil, validator: nil)
             options << name
 
             define_method name do |*args|
               if args.empty?
                 instance_variable_get("@#{name}") || default
               else
+                validator&.valid!(args.first)
                 instance_variable_set("@#{name}", args.first)
               end
             end
@@ -38,7 +39,7 @@ module Line
           @quick_reply = nil
 
           self.class.options.each do |option|
-            instance_variable_set("@#{option}", options[option]) if options.key?(option)
+            send(option, options[option]) if options.key?(option)
           end
 
           instance_eval(&block) if ::Kernel.block_given?

data/lib/line/message/builder/flex/actionable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    module Builder
+      module Flex
+        # The action DSL for flex components.
+        module Actionable
+          def self.included(base)
+            base.attr_reader :action
+          end
+
+          def message(text, **options, &)
+            @action = Actions::Message.new(text, context: context, **options, &)
+          end
+
+          def postback(data, **options, &)
+            @action = Actions::Postback.new(data, context: context, **options, &)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/message/builder/flex/box.rb

@@ -6,10 +6,23 @@ module Line
       module Flex
         # The box is a component for the Flex message.
         class Box < Line::Message::Builder::Base
+          include Actionable
+          include Position::Padding
+          include Position::Margin
+          include Position::Offset
+
           attr_reader :contents
 
-          option :layout, default: :horizontal
-          option :spacing, default: nil
+          option :layout, default: :horizontal, validator: Validators::Enum.new(
+            :horizontal, :vertical, :baseline
+          )
+          option :justify_content, default: nil, validator: Validators::Enum.new(
+            :flex_start, :center, :flex_end, :space_between, :space_around, :space_evenly
+          )
+          option :align_items, default: nil, validator: Validators::Enum.new(
+            :flex_start, :center, :flex_end
+          )
+          option :spacing, default: nil, validator: Validators::Size.new
           option :flex, default: nil
 
           def initialize(context: nil, **options, &)
@@ -34,16 +47,33 @@ module Line
             @contents << Flex::Image.new(url, context: context, **options, &)
           end
 
-          def to_h
+          def to_h # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
             raise RequiredError, "layout is required" if layout.nil?
-            raise RequiredError, "contents is required" if contents.empty?
 
             {
               type: "box",
               layout: layout,
+              # Position
+              justifyContent: justify_content,
+              alignItems: align_items,
               spacing: spacing,
+              # Position::Padding
+              paddingAll: padding,
+              paddingTop: padding_top,
+              paddingBottom: padding_bottom,
+              paddingStart: padding_start,
+              paddingEnd: padding_end,
+              # Position::Margin
+              margin: margin,
+              # Position::Offset
+              position: position,
+              offsetTop: offset_top,
+              offsetBottom: offset_bottom,
+              offsetStart: offset_start,
+              offsetEnd: offset_end,
               flex: flex,
-              contents: contents.map(&:to_h)
+              contents: contents.map(&:to_h),
+              action: action&.to_h
             }.compact
           end
         end

data/lib/line/message/builder/flex/button.rb

@@ -6,35 +6,39 @@ module Line
       module Flex
         # The button is a component of the Flex message.
         class Button < Line::Message::Builder::Base
-          attr_reader :action
+          include Actionable
+          include Position::Vertical
+          include Position::Padding
+          include Position::Margin
+          include Position::Offset
 
           option :flex, default: nil
-          option :margin, default: nil
           option :style, default: :link
           option :height, default: :md
 
-          def initialize(context: nil, **options, &)
-            @action = nil
-
-            super
-          end
-
-          def message(text, label:, display_text: nil, &)
-            @action = Actions::Message.new(text, label: label, display_text: display_text, &)
-          end
-
-          def postback(data, label: nil, display_text: nil, &)
-            @action = Actions::Postback.new(data, label: label, display_text: display_text, &)
-          end
-
-          def to_h
+          def to_h # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
             raise RequiredError, "action is required" if action.nil?
 
             {
               type: "button",
               action: action.to_h,
-              flex: flex,
+              # Position
+              grivity: gravity,
+              # Position::Padding
+              paddingAll: padding,
+              paddingTop: padding_top,
+              paddingBottom: padding_bottom,
+              paddingStart: padding_start,
+              paddingEnd: padding_end,
+              # Position::Margin
               margin: margin,
+              # Position::Offset
+              position: position,
+              offsetTop: offset_top,
+              offsetBottom: offset_bottom,
+              offsetStart: offset_start,
+              offsetEnd: offset_end,
+              flex: flex,
               style: style,
               height: height
             }.compact

data/lib/line/message/builder/flex/image.rb

@@ -6,14 +6,18 @@ module Line
       module Flex
         # The image is a component for the Flex message.
         class Image < Line::Message::Builder::Base
+          include Actionable
+          include Position::Horizontal
+          include Position::Vertical
+          include Position::Margin
+          include Position::Offset
+
           attr_reader :url
 
           option :size, default: nil
           option :aspect_ratio, default: nil
           option :aspect_mode, default: nil
           option :flex, default: nil
-          option :margin, default: nil
-          option :align, default: nil
 
           def initialize(url, context: nil, **options, &)
             @url = url
@@ -21,18 +25,28 @@ module Line
             super(context: context, **options, &)
           end
 
-          def to_h # rubocop:disable Metrics/MethodLength
+          def to_h # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
             raise RequiredError, "url is required" if url.nil?
 
             {
               type: "image",
               url: url,
+              # Position
+              align: align,
+              gravity: gravity,
+              # Position::Margin
+              margin: margin,
+              # Position::Offset
+              position: position,
+              offsetTop: offset_top,
+              offsetBottom: offset_bottom,
+              offsetStart: offset_start,
+              offsetEnd: offset_end,
               size: size,
               flex: flex,
-              margin: margin,
-              align: align,
               aspectRatio: aspect_ratio,
-              aspectMode: aspect_mode
+              aspectMode: aspect_mode,
+              action: action&.to_h
             }.compact
           end
         end

data/lib/line/message/builder/flex/position.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    module Builder
+      module Flex
+        module Position
+          # The horizontal provides "align" options for flex components.
+          module Horizontal
+            def self.included(base)
+              base.option :align,
+                          default: :nil,
+                          validator: Validators::Enum.new(
+                            :start, :center, :end
+                          )
+            end
+          end
+
+          # The vertical provides "gatvity" options for flex components.
+          module Vertical
+            def self.included(base)
+              base.option :gravity,
+                          default: :nil,
+                          validator: Validators::Enum.new(
+                            :top, :center, :bottom
+                          )
+            end
+          end
+
+          # The padding provides "padding" options for flex components.
+          module Padding
+            def self.included(base)
+              %i[padding padding_top padding_bottom padding_start padding_end].each do |option|
+                base.option option,
+                            default: :nil,
+                            validator: Validators::PercentageSize.new
+              end
+            end
+          end
+
+          # The margin provides "margin" options for flex components.
+          module Margin
+            def self.included(base)
+              base.option :margin,
+                          default: :nil,
+                          validator: Validators::Size.new
+            end
+          end
+
+          # The offset provides "offset" options for flex components.
+          module Offset
+            def self.included(base)
+              base.option :position,
+                          default: :nil,
+                          validator: Validators::Enum.new(:absolute, :relative)
+
+              %i[offset_top offset_bottom offset_start offset_end].each do |option|
+                base.option option,
+                            default: :nil,
+                            validator: Validators::Size.new
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/message/builder/flex/text.rb

@@ -6,15 +6,19 @@ module Line
       module Flex
         # The text is a component of the Flex message.
         class Text < Line::Message::Builder::Base
+          include Actionable
+          include Position::Horizontal
+          include Position::Vertical
+          include Position::Margin
+          include Position::Offset
+
           attr_reader :text
 
           option :size, default: nil
           option :wrap, default: false
           option :line_spacing, default: nil
           option :color, default: nil
-          option :align, default: nil
           option :flex, default: nil
-          option :margin, default: nil
 
           def initialize(text, context: nil, **options, &)
             @text = text
@@ -26,19 +30,29 @@ module Line
             @wrap = true
           end
 
-          def to_h # rubocop:disable Metrics/MethodLength
+          def to_h # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
             raise RequiredError, "text is required" if text.nil?
 
             {
               type: "text",
               text: text,
+              # Position
+              align: align,
+              gravity: gravity,
+              # Position::Margin
+              margin: margin,
+              # Position::Offset
+              position: position,
+              offsetTop: offset_top,
+              offsetBottom: offset_bottom,
+              offsetStart: offset_start,
+              offsetEnd: offset_end,
               wrap: wrap,
               lineSpacing: line_spacing,
               color: color,
               size: size,
-              align: align,
-              margin: margin,
-              flex: flex
+              flex: flex,
+              action: action&.to_h
             }.compact
           end
         end

data/lib/line/message/builder/flex.rb

@@ -6,6 +6,8 @@ module Line
       # The Flex module allows to build Flex messages.
       module Flex
         require_relative "flex/builder"
+        require_relative "flex/actionable"
+        require_relative "flex/position"
 
         # Container
         require_relative "flex/bubble"

data/lib/line/message/builder/validators/enum.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    module Builder
+      module Validators
+        # Validate values against a set of allowed values.
+        class Enum
+          attr_reader :allowed_values
+
+          def initialize(*allowed_values)
+            @allowed_values = allowed_values
+          end
+
+          def valid!(value)
+            return if allowed_values.include?(value.to_sym)
+
+            raise ValidationError, "Invalid value: #{value}. Allowed values are: #{allowed_values.join(", ")}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/message/builder/validators/size.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    module Builder
+      module Validators
+        # Validate size values for LINE messages.
+        class Size
+          KEYWORDS = %i[none xs sm md lg xl xxl].freeze
+
+          def valid?(value)
+            is_keyword = KEYWORDS.include?(value.to_sym)
+            is_pixels = value.end_with?("px")
+            is_keyword || is_pixels
+          end
+
+          def valid!(value)
+            return if valid?(value)
+
+            raise ValidationError,
+                  "Invalid value: #{value}. Allowed values are: #{KEYWORDS.join(", ")} or a pixel value (e.g., '100px')"
+          end
+        end
+
+        # Validate size values with percentage.
+        class PercentageSize < Size
+          def valid!(value)
+            is_percentage = value.end_with?("%")
+            return if is_percentage || valid?(value)
+
+            raise ValidationError,
+                  "Invalid value: #{value}. Allowed values are: #{KEYWORDS.join(", ")}, " \
+                  "a pixel value (e.g., '100px'), or a percentage (e.g., '50%')"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/message/builder/validators.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    module Builder
+      # :nodoc:
+      module Validators
+        require_relative "validators/enum"
+        require_relative "validators/size"
+      end
+    end
+  end
+end

data/lib/line/message/builder/version.rb

@@ -3,7 +3,7 @@
 module Line
   module Message
     module Builder
-      VERSION = "0.4.0"
+      VERSION = "0.5.0"
     end
   end
 end

data/lib/line/message/builder.rb

@@ -8,8 +8,10 @@ module Line
     module Builder
       class Error < StandardError; end
       class RequiredError < Error; end
+      class ValidationError < Error; end
 
       require_relative "builder/base"
+      require_relative "builder/validators"
       require_relative "builder/actions"
       require_relative "builder/quick_reply"
       require_relative "builder/container"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: line-message-builder
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Aotokitsuruya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-06 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies: []
 description: The LINE Messaging API message builder.
 email:
@@ -32,14 +32,19 @@ files:
 - lib/line/message/builder/base.rb
 - lib/line/message/builder/container.rb
 - lib/line/message/builder/flex.rb
+- lib/line/message/builder/flex/actionable.rb
 - lib/line/message/builder/flex/box.rb
 - lib/line/message/builder/flex/bubble.rb
 - lib/line/message/builder/flex/builder.rb
 - lib/line/message/builder/flex/button.rb
 - lib/line/message/builder/flex/image.rb
+- lib/line/message/builder/flex/position.rb
 - lib/line/message/builder/flex/text.rb
 - lib/line/message/builder/quick_reply.rb
 - lib/line/message/builder/text.rb
+- lib/line/message/builder/validators.rb
+- lib/line/message/builder/validators/enum.rb
+- lib/line/message/builder/validators/size.rb
 - lib/line/message/builder/version.rb
 - lib/line/message/rspec.rb
 - lib/line/message/rspec/matchers.rb