mjml-rb 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9cdaa07e2f84c880f1c3a4ae1594a32ec0d49436d6bf2fe83ee7d1738628fdf
-  data.tar.gz: 4b8576742cd05906ad3bf2bf8ef184dcf0eb6e4a7a7a19ca701e7a84c5ad3939
+  metadata.gz: 3b8ae00ad7838acf9020b38b585a90fbf86981d234e813da8f9d45d52421dd1a
+  data.tar.gz: b6723a5a59e85e6db01ae7bcb8e8b185c6cbd5253fccd195f93aa6158fa08361
 SHA512:
-  metadata.gz: 10f9d9c51871108519184113747abbee99c6c9b58e4f9a95161756296c4c97b64bf136cf969980ad99b00eb12ba505871a6efaa6b5ec1524f1ec14375e9030a1
-  data.tar.gz: f2af62cc6cb8f43f6fbd4e7aa6feb20ec7326b1069c52ee46d807ce7d4e134b3f1b931a03dc78c03108328621c322764ab70b14bf3d6e84c52940661ad6d2c09
+  metadata.gz: d7ad920fbb9996b3bdb4f0321420121695ebf3124ce466e19059b38f72add99284f8208fd2d985313b0e217762f5676ed669cb438cbaec6b68685366e43186c8
+  data.tar.gz: 853ffaae0d6889dc630837b73856204bc68d42c8eb7a01dc125c6629a2b9b0258a6fc73a22855e553f1c34a2b2d4876a04e76598e8e0f3be5c5bd6e99ef99fe1

data/Gemfile

@@ -2,4 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "minitest", group: :test
+group :test, :development do
+  gem "minitest"
+  gem "rake"
+end

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/mjml-rb.svg)](https://badge.fury.io/rb/mjml-rb)
+
 # MJML Ruby Implementation
 
 > **Note:** This is an unofficial Ruby port of the MJML email framework,

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.test_files = FileList["test/test_*.rb"]
+  t.warning = false
+end
+
+task default: :test

data/lib/mjml-rb/cli.rb

@@ -52,6 +52,10 @@ module MjmlRb
       @stderr.puts("\nCommand line error:")
       @stderr.puts(e.message)
       1
+    rescue ConfigFile::ConfigError => e
+      @stderr.puts("\nConfiguration error:")
+      @stderr.puts(e.message)
+      1
     rescue OptionParser::ParseError => e
       @stderr.puts(e.message)
       1
@@ -194,7 +198,10 @@ module MjmlRb
     end
 
     def emit_results(processed, output_mode, options)
-      processed.each { |item| emit_errors(item[:compiled], item[:file]) }
+      processed.each do |item|
+        emit_warnings(item[:compiled], item[:file])
+        emit_errors(item[:compiled], item[:file])
+      end
 
       invalid = processed.any? { |item| !item[:compiled].errors.empty? }
       if options[:validate].any? && invalid
@@ -213,6 +220,14 @@ module MjmlRb
       invalid ? 2 : 0
     end
 
+    def emit_warnings(result, file)
+      return if result.warnings.empty?
+      result.warnings.each do |warning|
+        prefix = file ? "File: #{file}\n" : ""
+        @stderr.puts("WARNING: #{prefix}#{warning[:formatted_message] || warning[:message]}")
+      end
+    end
+
     def emit_errors(result, file)
       return if result.errors.empty?
       result.errors.each do |error|

data/lib/mjml-rb/compiler.rb

@@ -17,8 +17,17 @@ module MjmlRb
       actual_path: "."
     }.freeze
 
+    # Additional option keys accepted by the renderer but not in DEFAULT_OPTIONS.
+    EXTRA_VALID_KEYS = %i[lang dir fonts printerSupport].freeze
+
+    VALID_OPTION_KEYS = (DEFAULT_OPTIONS.keys + EXTRA_VALID_KEYS).freeze
+
+    VALID_VALIDATION_LEVELS = %w[soft strict skip].freeze
+
     def initialize(options = {})
-      @options = DEFAULT_OPTIONS.merge(symbolize_keys(options))
+      normalized = symbolize_keys(options)
+      validate_options!(normalized)
+      @options = DEFAULT_OPTIONS.merge(normalized)
       @parser = Parser.new
       @validator = Validator.new(parser: @parser)
       @renderer = Renderer.new
@@ -29,7 +38,16 @@ module MjmlRb
     end
 
     def compile(mjml, options = {})
-      merged = @options.merge(symbolize_keys(options))
+      normalized = symbolize_keys(options)
+      validate_options!(normalized)
+      merged = @options.merge(normalized)
+
+      do_compile(mjml, merged)
+    end
+
+    private
+
+    def do_compile(mjml, merged)
       ast = @parser.parse(
         mjml,
         keep_comments: merged[:keep_comments],
@@ -39,26 +57,43 @@ module MjmlRb
         actual_path: merged[:actual_path]
       )
 
-      validation_errors = validate_if_needed(ast, merged)
-      return Result.new(errors: validation_errors) if strict_validation_failed?(merged, validation_errors)
+      include_issues = format_include_errors(@parser.include_errors)
+      validation = validate_if_needed(ast, merged)
+      include_validation = classify_include_issues(include_issues, merged)
+
+      all_errors = validation[:errors] + include_validation[:errors]
+      all_warnings = validation[:warnings] + include_validation[:warnings]
+
+      return Result.new(errors: all_errors, warnings: all_warnings) if strict_validation_failed?(merged, all_errors)
 
       html = @renderer.render(ast, merged)
-      result = Result.new(
+      Result.new(
         html: post_process(html, merged),
-        errors: validation_errors,
-        warnings: []
+        errors: all_errors,
+        warnings: all_warnings
       )
-      result
     rescue Parser::ParseError => e
       Result.new(errors: [format_error(e.message, line: e.line)])
     rescue StandardError => e
       Result.new(errors: [format_error(e.message)])
     end
 
-    private
+    def validate_options!(options)
+      unknown = options.keys - VALID_OPTION_KEYS
+      unless unknown.empty?
+        raise ArgumentError, "Unknown option(s): #{unknown.join(', ')}. Valid options are: #{VALID_OPTION_KEYS.join(', ')}"
+      end
+
+      if options.key?(:validation_level)
+        level = options[:validation_level].to_s
+        unless VALID_VALIDATION_LEVELS.include?(level)
+          raise ArgumentError, "Invalid validation_level: #{level.inspect}. Must be one of: #{VALID_VALIDATION_LEVELS.join(', ')}"
+        end
+      end
+    end
 
     def validate_if_needed(ast, options)
-      return [] if options[:validation_level].to_s == "skip"
+      return { errors: [], warnings: [] } if options[:validation_level].to_s == "skip"
       @validator.validate(ast, options)
     end
 
@@ -98,6 +133,23 @@ module MjmlRb
       end
     end
 
+    def format_include_errors(include_errors)
+      Array(include_errors).map do |ie|
+        format_error(ie[:message], line: ie[:line])
+      end
+    end
+
+    def classify_include_issues(issues, options)
+      return { errors: [], warnings: [] } if issues.empty?
+
+      level = options[:validation_level].to_s
+      if level == "strict"
+        { errors: issues, warnings: [] }
+      else
+        { errors: [], warnings: issues }
+      end
+    end
+
     def format_error(message, line: nil)
       {
         line: line,

data/lib/mjml-rb/components/base.rb

@@ -1,6 +1,9 @@
+require_relative "css_helpers"
+
 module MjmlRb
   module Components
     class Base
+      include CssHelpers
       class << self
         def tags
           const_defined?(:TAGS) ? const_get(:TAGS) : []

data/lib/mjml-rb/components/button.rb

@@ -173,21 +173,6 @@ module MjmlRb
         "#{result.to_i}px"
       end
 
-      def shorthand_value(parts, side)
-        case parts.length
-        when 1 then parts[0]
-        when 2, 3 then parts[1]
-        when 4 then side == :left ? parts[3] : parts[1]
-        else "0"
-        end
-      end
-
-      def parse_border_width(border_str)
-        return 0 if border_str.nil? || border_str.strip == "none"
-
-        m = border_str.match(/(\d+(?:\.\d+)?)\s*px/)
-        m ? m[1].to_f : 0
-      end
     end
   end
 end

data/lib/mjml-rb/components/css_helpers.rb

@@ -0,0 +1,33 @@
+module MjmlRb
+  module Components
+    # Shared CSS utility methods used by multiple components.
+    # Extracted from Button, Image, Divider, and Section to eliminate
+    # duplicated logic.
+    module CssHelpers
+      # Extracts a value from a CSS shorthand property (padding, margin).
+      # Follows CSS shorthand rules:
+      #   1 value  → all sides
+      #   2 values → vertical | horizontal
+      #   3 values → top | horizontal | bottom
+      #   4 values → top | right | bottom | left
+      def shorthand_value(parts, side)
+        case parts.length
+        when 1 then parts[0]
+        when 2, 3 then parts[1]
+        when 4 then side == :left ? parts[3] : parts[1]
+        else "0"
+        end
+      end
+
+      # Extracts the numeric border width (in px) from a CSS border shorthand
+      # string like "2px solid #000". Returns a Float for sub-pixel values,
+      # or 0 when the border is nil, empty, "none", or has no px unit.
+      def parse_border_width(border_str)
+        return 0 if border_str.nil? || border_str.to_s.strip.empty? || border_str.to_s.strip == "none"
+
+        match = border_str.to_s.match(/(\d+(?:\.\d+)?)\s*px/)
+        match ? match[1].to_f : 0
+      end
+    end
+  end
+end

data/lib/mjml-rb/components/divider.rb

@@ -112,15 +112,6 @@ module MjmlRb
         end
       end
 
-      def shorthand_value(parts, side)
-        case parts.length
-        when 1 then parts[0]
-        when 2, 3 then parts[1]
-        when 4 then side == :left ? parts[3] : parts[1]
-        else "0"
-        end
-      end
-
       def outlook_block(align, style, width)
         # Strip trailing px for the HTML width attribute
         width_int = width.to_i.to_s

data/lib/mjml-rb/components/image.rb

@@ -202,15 +202,6 @@ module MjmlRb
         end
       end
 
-      def shorthand_value(parts, side)
-        case parts.length
-        when 1 then parts[0]
-        when 2, 3 then parts[1]
-        when 4 then side == :left ? parts[3] : parts[1]
-        else "0"
-        end
-      end
-
       def make_lower_breakpoint(breakpoint)
         matched = breakpoint.to_s.match(/[0-9]+/)
         return breakpoint if matched.nil?

data/lib/mjml-rb/components/section.rb

@@ -80,12 +80,6 @@ module MjmlRb
         value.to_s.to_i
       end
 
-      def parse_border_width(border_str)
-        return 0 if border_str.nil? || border_str.to_s.strip.empty? || border_str.to_s.strip == "none"
-
-        border_str =~ /(\d+(?:\.\d+)?)\s*px/ ? $1.to_i : 0
-      end
-
       def parse_padding_value(str)
         return 0 if str.nil? || str.to_s.strip.empty?
 

data/lib/mjml-rb/config_file.rb

@@ -4,6 +4,15 @@ module MjmlRb
   class ConfigFile
     DEFAULT_NAME = ".mjmlrc"
 
+    class ConfigError < StandardError
+      attr_reader :path
+
+      def initialize(message, path:)
+        @path = path
+        super(message)
+      end
+    end
+
     def self.load(dir = Dir.pwd)
       path = File.join(dir, DEFAULT_NAME)
       return {} unless File.exist?(path)
@@ -27,8 +36,7 @@ module MjmlRb
 
       config
     rescue JSON::ParserError => e
-      warn "WARNING: Failed to parse #{path}: #{e.message}"
-      {}
+      raise ConfigError.new("Failed to parse #{path}: #{e.message}", path: path)
     end
   end
 end

data/lib/mjml-rb/parser.rb

@@ -35,7 +35,12 @@ module MjmlRb
       end
     end
 
+    # Errors collected during include expansion (missing files, etc.)
+    # Read after calling #parse to retrieve non-fatal include issues.
+    attr_reader :include_errors
+
     def parse(mjml, options = {})
+      @include_errors = []
       opts = normalize_options(options)
       xml = apply_preprocessors(mjml.to_s, opts[:preprocessors])
       xml = wrap_ending_tags_in_cdata(xml)
@@ -93,12 +98,12 @@ module MjmlRb
         include_content = resolved_path ? File.read(resolved_path) : nil
 
         if include_content.nil?
-          # Collect error as an mj-raw comment node instead of raising
           display_path = resolved_path || File.expand_path(path_attr, options[:file_path].to_s)
-          error_comment = "<!-- mj-include fails to read file : #{path_attr} at #{display_path} -->"
-          error_node = Element.new("mj-raw")
-          error_node.add(CData.new(error_comment))
-          parent.insert_before(include_node, error_node)
+          @include_errors << {
+            message: "mj-include fails to read file : #{path_attr} at #{display_path}",
+            tag_name: "mj-include",
+            file: display_path
+          }
           parent.delete(include_node)
           next
         end

data/lib/mjml-rb/validator.rb

@@ -17,18 +17,31 @@ module MjmlRb
 
     def validate(mjml_or_ast, options = {})
       root = mjml_or_ast.is_a?(AstNode) ? mjml_or_ast : parse_ast(mjml_or_ast, options)
-      return [error("Root element must be <mjml>", tag_name: root&.tag_name)] unless root&.tag_name == "mjml"
+      unless root&.tag_name == "mjml"
+        return { errors: [error("Root element must be <mjml>", tag_name: root&.tag_name)], warnings: [] }
+      end
 
-      errors = []
-      errors << error("Missing <mj-body>", tag_name: "mjml") unless root.element_children.any? { |c| c.tag_name == "mj-body" }
-      walk(root, errors)
-      errors
+      issues = []
+      issues << error("Missing <mj-body>", tag_name: "mjml") unless root.element_children.any? { |c| c.tag_name == "mj-body" }
+      walk(root, issues)
+      classify_issues(issues, options)
     rescue Parser::ParseError => e
-      [error(e.message, line: e.line)]
+      { errors: [error(e.message, line: e.line)], warnings: [] }
     end
 
     private
 
+    # In "soft" mode validation issues are non-blocking warnings;
+    # in "strict" mode they are blocking errors.
+    def classify_issues(issues, options)
+      level = options.fetch(:validation_level, "soft").to_s
+      if level == "strict"
+        { errors: issues, warnings: [] }
+      else
+        { errors: [], warnings: issues }
+      end
+    end
+
     def parse_ast(mjml, options)
       @parser.parse(
         mjml,

data/lib/mjml-rb/version.rb

@@ -1,3 +1,3 @@
 module MjmlRb
-  VERSION = "0.4.0".freeze
+  VERSION = "0.4.1".freeze
 end

data/mjml-rb.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
 
   spec.homepage = "https://github.com/faraquet/mjml-rb"
   spec.files = Dir.chdir(__dir__) do
-    Dir.glob("{bin,lib}/**/*") + ["Gemfile", "LICENSE", "mjml-rb.gemspec", "README.md"]
+    Dir.glob("{bin,lib}/**/*") + ["Gemfile", "LICENSE", "Rakefile", "mjml-rb.gemspec", "README.md"]
   end
   spec.bindir = "bin"
   spec.executables = ["mjml"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Andrei Andriichuk
@@ -48,6 +48,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - bin/mjml
 - lib/mjml-rb.rb
 - lib/mjml-rb/ast_node.rb
@@ -63,6 +64,7 @@ files:
 - lib/mjml-rb/components/carousel.rb
 - lib/mjml-rb/components/carousel_image.rb
 - lib/mjml-rb/components/column.rb
+- lib/mjml-rb/components/css_helpers.rb
 - lib/mjml-rb/components/divider.rb
 - lib/mjml-rb/components/group.rb
 - lib/mjml-rb/components/head.rb