Module: SvgConform

Defined in:
lib/svg_conform/validation_issue.rb,
lib/svg_conform.rb,
lib/svg_conform/cli.rb,
lib/svg_conform/fixer.rb,
lib/svg_conform/profile.rb,
lib/svg_conform/version.rb,
lib/svg_conform/document.rb,
lib/svg_conform/profiles.rb,
lib/svg_conform/constants.rb,
lib/svg_conform/css_color.rb,
lib/svg_conform/validator.rb,
lib/svg_conform/references.rb,
lib/svg_conform/errors/base.rb,
lib/svg_conform/batch_report.rb,
lib/svg_conform/node_helpers.rb,
lib/svg_conform/remediations.rb,
lib/svg_conform/requirements.rb,
lib/svg_conform/sax_document.rb,
lib/svg_conform/element_proxy.rb,
lib/svg_conform/commands/check.rb,
lib/svg_conform/quality_report.rb,
lib/svg_conform/commands/quality.rb,
lib/svg_conform/profile_compiler.rb,
lib/svg_conform/commands/profiles.rb,
lib/svg_conform/commands/svgcheck.rb,
lib/svg_conform/document_analyzer.rb,
lib/svg_conform/external_checkers.rb,
lib/svg_conform/report_comparator.rb,
lib/svg_conform/validation_result.rb,
lib/svg_conform/conformance_report.rb,
lib/svg_conform/node_index_builder.rb,
lib/svg_conform/remediation_engine.rb,
lib/svg_conform/remediation_result.rb,
lib/svg_conform/remediation_runner.rb,
lib/svg_conform/validation_context.rb,
lib/svg_conform/semantic_comparator.rb,
lib/svg_conform/classification_cache.rb,
lib/svg_conform/compatibility_analyzer.rb,
lib/svg_conform/image_quality_analyzer.rb,
lib/svg_conform/sax_validation_handler.rb,
lib/svg_conform/errors/validation_issue.rb,
lib/svg_conform/errors/validation_notice.rb,
lib/svg_conform/references/id_definition.rb,
lib/svg_conform/validation/error_tracker.rb,
lib/svg_conform/commands/svgcheck_compare.rb,
lib/svg_conform/references/base_reference.rb,
lib/svg_conform/commands/svgcheck_generate.rb,
lib/svg_conform/external_checkers/svgcheck.rb,
lib/svg_conform/validation/node_id_manager.rb,
lib/svg_conform/validation/tracker_factory.rb,
lib/svg_conform/compatibility/file_processor.rb,
lib/svg_conform/quality_metrics/configuration.rb,
lib/svg_conform/quality_metrics/feature_flags.rb,
lib/svg_conform/quality_metrics/quality_score.rb,
lib/svg_conform/references/reference_manifest.rb,
lib/svg_conform/remediations/base_remediation.rb,
lib/svg_conform/remediations/font_remediation.rb,
lib/svg_conform/requirements/base_requirement.rb,
lib/svg_conform/compatibility/analysis_context.rb,
lib/svg_conform/compatibility/report_formatter.rb,
lib/svg_conform/quality_metrics/error_analyzer.rb,
lib/svg_conform/quality_metrics/quality_result.rb,
lib/svg_conform/remediations/color_remediation.rb,
lib/svg_conform/requirements/style_requirement.rb,
lib/svg_conform/commands/svgcheck_compatibility.rb,
lib/svg_conform/compatibility/comparison_result.rb,
lib/svg_conform/compatibility/pattern_discovery.rb,
lib/svg_conform/compatibility/validity_analysis.rb,
lib/svg_conform/quality_metrics/error_breakdown.rb,
lib/svg_conform/references/reference_classifier.rb,
lib/svg_conform/interfaces/requirement_interface.rb,
lib/svg_conform/quality_metrics/feature_detector.rb,
lib/svg_conform/remediations/viewbox_remediation.rb,
lib/svg_conform/compatibility/svg_analysis_engine.rb,
lib/svg_conform/compatibility/xml_analysis_engine.rb,
lib/svg_conform/external_checkers/svgcheck/parser.rb,
lib/svg_conform/quality_metrics/complexity_metrics.rb,
lib/svg_conform/quality_metrics/quality_calculator.rb,
lib/svg_conform/remediations/namespace_remediation.rb,
lib/svg_conform/requirements/namespace_requirement.rb,
lib/svg_conform/compatibility/compatibility_analyzer.rb,
lib/svg_conform/requirements/font_family_requirement.rb,
lib/svg_conform/quality_metrics/complexity_calculator.rb,
lib/svg_conform/requirements/id_reference_requirement.rb,
lib/svg_conform/requirements/text_as_path_requirement.rb,
lib/svg_conform/requirements/id_collection_requirement.rb,
lib/svg_conform/remediations/font_embedding_remediation.rb,
lib/svg_conform/requirements/element_requirement_config.rb,
lib/svg_conform/quality_metrics/quality_report_formatter.rb,
lib/svg_conform/remediations/image_embedding_remediation.rb,
lib/svg_conform/remediations/no_external_css_remediation.rb,
lib/svg_conform/remediations/style_promotion_remediation.rb,
lib/svg_conform/requirements/link_validation_requirement.rb,
lib/svg_conform/requirements/no_external_css_requirement.rb,
lib/svg_conform/requirements/style_promotion_requirement.rb,
lib/svg_conform/validation/structural_invalidity_tracker.rb,
lib/svg_conform/requirements/allowed_elements_requirement.rb,
lib/svg_conform/requirements/viewbox_required_requirement.rb,
lib/svg_conform/requirements/forbidden_content_requirement.rb,
lib/svg_conform/requirements/no_external_fonts_requirement.rb,
lib/svg_conform/external_checkers/svgcheck/output_generator.rb,
lib/svg_conform/external_checkers/svgcheck/report_generator.rb,
lib/svg_conform/requirements/color_restrictions_requirement.rb,
lib/svg_conform/requirements/no_external_images_requirement.rb,
lib/svg_conform/external_checkers/svgcheck/report_comparator.rb,
lib/svg_conform/remediations/namespace_attribute_remediation.rb,
lib/svg_conform/requirements/namespace_attributes_requirement.rb,
lib/svg_conform/external_checkers/svgcheck/validation_pipeline.rb,
lib/svg_conform/remediations/invalid_id_references_remediation.rb,
lib/svg_conform/requirements/invalid_id_references_requirement.rb,
lib/svg_conform/external_checkers/svgcheck/compatibility_engine.rb,
sig/svg_conform.rbs

Overview

Backward compatibility: re-export error classes at top level

Defined Under Namespace

Modules: Commands, Compatibility, Constants, Errors, ExternalCheckers, Interfaces, NodeHelpers, Profiles, QualityMetrics, References, Remediations, Requirements, Validation Classes: BatchReport, ClassificationCache, Cli, CompatibilityAnalyzer, ConformanceIssue, ConformanceReport, CssColor, Document, DocumentAnalyzer, ElementProxy, Error, FileResult, Fixer, ImageQualityAnalyzer, IssueSummary, NodeIndexBuilder, ParseError, Profile, ProfileCompiler, ProfileError, RemediationEngine, RemediationResult, RemediationRunResult, RemediationRunner, ReportComparator, RuleError, SaxAttribute, SaxDocument, SaxValidationHandler, SemanticComparator, SvgQualityBatchReport, SvgQualityReport, TerminalTheme, ValidationContext, ValidationError, ValidationResult, Validator

Constant Summary collapse

VERSION =

Returns:

"0.2.2"
ValidationIssue =

Aliases for backward compatibility These classes are now defined in SvgConform::Errors

Errors::ValidationIssue
ValidationNotice = 
Errors::ValidationNotice

Class Method Summary collapse

Class Method Details

.validate(svg_content, profile: :svg_1_2_rfc, **options) ⇒ Object

Validate SVG content with the specified profile



77
78
79
 
# File 'lib/svg_conform.rb', line 77

def self.validate(svg_content, profile: :svg_1_2_rfc, **options)
  validator.validate(svg_content, profile: profile, **options)
end

.validate_file(file_path, profile: :svg_1_2_rfc, **options) ⇒ Object

Validate a file with the specified profile



72
73
74
 
# File 'lib/svg_conform.rb', line 72

def self.validate_file(file_path, profile: :svg_1_2_rfc, **options)
  validator.validate_file(file_path, profile: profile, **options)
end

.validator ⇒ Object

Convenience method to create a new validator



67
68
69
 
# File 'lib/svg_conform.rb', line 67

def self.validator
  Validator.new
end