mjml-rb 0.2.1

data/lib/mjml-rb/validator.rb

@@ -0,0 +1,187 @@
+require_relative "dependencies"
+require_relative "parser"
+
+module MjmlRb
+  class Validator
+    GLOBAL_ALLOWED_ATTRIBUTES = %w[css-class mj-class].freeze
+
+    REQUIRED_BY_TAG = {
+      "mj-image" => %w[src],
+      "mj-font" => %w[name href],
+      "mj-include" => %w[path]
+    }.freeze
+
+    def initialize(parser: Parser.new)
+      @parser = parser
+    end
+
+    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"
+
+      errors = []
+      errors << error("Missing <mj-body>", tag_name: "mjml") unless root.element_children.any? { |c| c.tag_name == "mj-body" }
+      walk(root, errors)
+      errors
+    rescue Parser::ParseError => e
+      [error(e.message, line: e.line)]
+    end
+
+    private
+
+    def parse_ast(mjml, options)
+      @parser.parse(
+        mjml,
+        keep_comments: options.fetch(:keep_comments, false),
+        preprocessors: options.fetch(:preprocessors, []),
+        ignore_includes: options.fetch(:ignore_includes, false),
+        file_path: options.fetch(:file_path, "."),
+        actual_path: options.fetch(:actual_path, ".")
+      )
+    end
+
+    def walk(node, errors)
+      return unless node.element?
+
+      validate_allowed_children(node, errors)
+      validate_required_attributes(node, errors)
+      validate_supported_attributes(node, errors)
+      validate_attribute_types(node, errors)
+
+      node.element_children.each { |child| walk(child, errors) }
+    end
+
+    def validate_allowed_children(node, errors)
+      allowed = Dependencies::RULES[node.tag_name]
+      return unless allowed
+
+      node.element_children.each do |child|
+        next if allowed_child?(child.tag_name, allowed)
+
+        errors << error(
+          "Element <#{child.tag_name}> is not allowed inside <#{node.tag_name}>",
+          tag_name: child.tag_name
+        )
+      end
+    end
+
+    def validate_required_attributes(node, errors)
+      required = REQUIRED_BY_TAG[node.tag_name] || []
+      required.each do |attr|
+        next if node.attributes.key?(attr)
+
+        errors << error("Attribute `#{attr}` is required for <#{node.tag_name}>", tag_name: node.tag_name)
+      end
+    end
+
+    def validate_supported_attributes(node, errors)
+      allowed_attributes = allowed_attributes_for(node.tag_name)
+      return if allowed_attributes.empty?
+
+      node.attributes.each_key do |attribute_name|
+        next if allowed_attributes.key?(attribute_name)
+        next if GLOBAL_ALLOWED_ATTRIBUTES.include?(attribute_name)
+
+        errors << error("Attribute `#{attribute_name}` is not allowed for <#{node.tag_name}>", tag_name: node.tag_name)
+      end
+    end
+
+    def validate_attribute_types(node, errors)
+      allowed_attributes = allowed_attributes_for(node.tag_name)
+      return if allowed_attributes.empty?
+
+      node.attributes.each do |attribute_name, attribute_value|
+        next if GLOBAL_ALLOWED_ATTRIBUTES.include?(attribute_name)
+
+        expected_type = allowed_attributes[attribute_name]
+        next unless expected_type
+        next if valid_attribute_value?(attribute_value, expected_type)
+
+        errors << error(
+          "Attribute `#{attribute_name}` on <#{node.tag_name}> has invalid value `#{attribute_value}` for type `#{expected_type}`",
+          tag_name: node.tag_name
+        )
+      end
+    end
+
+    def allowed_attributes_for(tag_name)
+      component_class = component_class_for_tag(tag_name)
+      return {} unless component_class
+
+      if component_class.respond_to?(:allowed_attributes_for)
+        component_class.allowed_attributes_for(tag_name)
+      else
+        component_class.allowed_attributes
+      end
+    end
+
+    def component_class_for_tag(tag_name)
+      MjmlRb::Components.constants.filter_map do |name|
+        value = MjmlRb::Components.const_get(name)
+        value if value.is_a?(Class) && value < MjmlRb::Components::Base
+      rescue NameError
+        nil
+      end.find { |klass| klass.tags.include?(tag_name) }
+    end
+
+    def valid_attribute_value?(value, expected_type)
+      return true if value.nil?
+
+      case expected_type
+      when "string"
+        true
+      when "color"
+        color?(value)
+      when /\Aenum\((.+)\)\z/
+        Regexp.last_match(1).split(",").map(&:strip).include?(value)
+      when /\Aunit\((.+)\)(?:\{(\d+),(\d+)\})?\z/
+        units = Regexp.last_match(1).split(",").map(&:strip)
+        min_count = Regexp.last_match(2)&.to_i || 1
+        max_count = Regexp.last_match(3)&.to_i || 1
+        unit_values?(value, units, min_count: min_count, max_count: max_count)
+      else
+        true
+      end
+    end
+
+    def color?(value)
+      value.match?(/\A#[0-9a-fA-F]{3,8}\z/) ||
+        value.match?(/\Argb[a]?\([^)]+\)\z/i) ||
+        value.match?(/\Ahsl[a]?\([^)]+\)\z/i) ||
+        value.match?(/\A[a-z]+\z/i)
+    end
+
+    def unit_values?(value, units, min_count:, max_count:)
+      parts = value.to_s.strip.split(/\s+/)
+      return false if parts.empty? || parts.size < min_count || parts.size > max_count
+
+      parts.all? { |part| unit_value?(part, units) }
+    end
+
+    def unit_value?(value, units)
+      return true if value.match?(/\A0(?:\.0+)?\z/)
+
+      units.any? do |unit|
+        value.match?(/\A-?\d+(?:\.\d+)?#{Regexp.escape(unit)}\z/)
+      end
+    end
+
+    def allowed_child?(tag_name, allowed_patterns)
+      allowed_patterns.any? do |pattern|
+        case pattern
+        when Regexp then pattern.match?(tag_name)
+        else pattern == tag_name
+        end
+      end
+    end
+
+    def error(message, line: nil, tag_name: nil)
+      {
+        line: line,
+        message: message,
+        tag_name: tag_name,
+        formatted_message: message
+      }
+    end
+  end
+end

data/lib/mjml-rb/version.rb

@@ -0,0 +1,3 @@
+module MjmlRb
+  VERSION = "0.2.1".freeze
+end

data/lib/mjml-rb.rb

@@ -0,0 +1,30 @@
+require_relative "mjml-rb/version"
+require_relative "mjml-rb/result"
+require_relative "mjml-rb/ast_node"
+require_relative "mjml-rb/dependencies"
+require_relative "mjml-rb/parser"
+require_relative "mjml-rb/renderer"
+require_relative "mjml-rb/compiler"
+require_relative "mjml-rb/validator"
+require_relative "mjml-rb/migrator"
+require_relative "mjml-rb/cli"
+
+module MjmlRb
+  # Print an experimental warning once at load time unless suppressed.
+  # Suppress by setting the environment variable MJML_RB_NO_WARN=1.
+  warn <<~WARNING unless ENV["MJML_RB_NO_WARN"] == "1"
+    WARNING: mjml-rb #{VERSION} is EXPERIMENTAL software.
+    It is an unofficial Ruby port of MJML, not affiliated with or endorsed by
+    the MJML team. Output may differ from the reference npm renderer. Not all
+    components are fully implemented. Use in production at your own risk.
+    Set MJML_RB_NO_WARN=1 to suppress this message.
+  WARNING
+
+  class << self
+    def mjml2html(mjml, options = {})
+      Compiler.new(options).compile(mjml).to_h
+    end
+
+    alias to_html mjml2html
+  end
+end

data/mjml-rb.gemspec

@@ -0,0 +1,23 @@
+require_relative "lib/mjml-rb/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mjml-rb"
+  spec.version = MjmlRb::VERSION
+  spec.authors = ["Andrei Andriichuk"]
+  spec.email = ["andreiandriichuk@gmail.com"]
+
+  spec.summary = "Ruby implementation of the MJML toolchain"
+  spec.description = "Ruby-first MJML compiler API and CLI with compatibility-focused behavior."
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.homepage = "https://github.com/faraquet/mjml-rails"
+  spec.files = Dir.chdir(__dir__) do
+    Dir.glob("{bin,lib}/**/*") + ["Gemfile", "LICENSE", "mjml-rb.gemspec", "README.md"]
+  end
+  spec.bindir = "bin"
+  spec.executables = ["mjml"]
+  spec.require_paths = ["lib"]
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "rexml"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: mjml-rb
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Andrei Andriichuk
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: rexml
+  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'
+description: Ruby-first MJML compiler API and CLI with compatibility-focused behavior.
+email:
+- andreiandriichuk@gmail.com
+executables:
+- mjml
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- bin/mjml
+- lib/mjml-rb.rb
+- lib/mjml-rb/ast_node.rb
+- lib/mjml-rb/cli.rb
+- lib/mjml-rb/compiler.rb
+- lib/mjml-rb/components/accordion.rb
+- lib/mjml-rb/components/base.rb
+- lib/mjml-rb/components/body.rb
+- lib/mjml-rb/components/breakpoint.rb
+- lib/mjml-rb/components/button.rb
+- lib/mjml-rb/components/column.rb
+- lib/mjml-rb/components/divider.rb
+- lib/mjml-rb/components/hero.rb
+- lib/mjml-rb/components/html_attributes.rb
+- lib/mjml-rb/components/image.rb
+- lib/mjml-rb/components/navbar.rb
+- lib/mjml-rb/components/section.rb
+- lib/mjml-rb/components/social.rb
+- lib/mjml-rb/components/spacer.rb
+- lib/mjml-rb/components/table.rb
+- lib/mjml-rb/components/text.rb
+- lib/mjml-rb/dependencies.rb
+- lib/mjml-rb/migrator.rb
+- lib/mjml-rb/parser.rb
+- lib/mjml-rb/renderer.rb
+- lib/mjml-rb/result.rb
+- lib/mjml-rb/validator.rb
+- lib/mjml-rb/version.rb
+- mjml-rb.gemspec
+homepage: https://github.com/faraquet/mjml-rails
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Ruby implementation of the MJML toolchain
+test_files: []