prosereflect 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4932ddc045360d00a528353acb8c741642588d3c0d180e62752d4090f47d28d
-  data.tar.gz: 646f972a327d8a8a735904bc31f64f2778232e077e6b1fcf6e888b1d6452ac25
+  metadata.gz: f5c6ec18ecdd44c7efaba52819b0763d35c829c7af571ef7b423da2863d29caf
+  data.tar.gz: ed3ed8a65bb95e4dbc89a0e96efe4f2dd4a2c57b0cc7210f6296c03a6b8c5d66
 SHA512:
-  metadata.gz: fd539de5ef42d23b9d1cb4ab07a6dc2f6ea0466e02230016b09ce6f6c90dc6ab947ceaa82ee5f0058030cb0fee82484d6a676ad5841b8d6207d45dec717f785a
-  data.tar.gz: 38e6f185405e0dd9fdd56aa9821253442f545aac7944c54e909a6e5c5ee430c7d610caac53d4d32e4de1fd5ebb7b125822e1465ce3d01e8aa745621efaae603e
+  metadata.gz: f736e62b0ef5909c60daebb95b79f29c23be47b76c56edf327adeb4bdf76df1071493def7a5530209cd5a431332f1dfec3a3428453c50c5e3e336873126be238
+  data.tar.gz: 56d78409069b3a61caf41ab36a44494f71b1f2be53e9ef15bd2290fad0eebab31cc3c7a22945b09b05f0dd0f011f65b77f0cc8045fa36230e723750b6796f118

data/.github/workflows/rake.yml

@@ -8,6 +8,10 @@ on:
     tags: [ v* ]
   pull_request:
 
+permissions:
+  contents: write
+  packages: write
+
 jobs:
   rake:
     uses: metanorma/ci/.github/workflows/generic-rake.yml@main

data/.github/workflows/release.yml

@@ -14,6 +14,11 @@ on:
   repository_dispatch:
     types: [ do-release ]
 
+permissions:
+  contents: write
+  packages: write
+  id-token: write
+
 jobs:
   release:
     uses: metanorma/ci/.github/workflows/rubygems-release.yml@main

data/.rubocop.yml

@@ -1 +1,19 @@
-inherit_from: .rubocop_todo.yml
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  - .rubocop_todo.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+
+# local repo-specific modifications
+# ...
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0

data/.rubocop_todo.yml

@@ -1,228 +1,197 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-05-12 01:22:35 UTC using RuboCop version 1.75.5.
+# on 2026-04-13 10:04:56 UTC using RuboCop version 1.86.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Layout/BlockEndNewline:
-  Exclude:
-    - 'bin/extract-ituob-amendments.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowForAlignment.
-Layout/CommentIndentation:
-  Exclude:
-    - 'e118_amendment.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLineAfterGuardClause:
-  Exclude:
-    - 'e118_amendment.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EmptyLineBetweenMethodDefs, EmptyLineBetweenClassDefs, EmptyLineBetweenModuleDefs, DefLikeMacros, AllowAdjacentOneLineDefs, NumberOfEmptyLines.
-Layout/EmptyLineBetweenDefs:
+Gemspec/RequiredRubyVersion:
   Exclude:
-    - 'e118_amendment.rb'
+    - 'prosereflect.gemspec'
 
-# Offense count: 2
+# Offense count: 5
 # This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLines:
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
   Exclude:
-    - 'e118_amendment.rb'
+    - 'spec/prosereflect/schema/conftest.rb'
 
-# Offense count: 2
+# Offense count: 80
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
-Layout/EmptyLinesAroundClassBody:
-  Exclude:
-    - 'e118_amendment.rb'
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Enabled: false
 
-# Offense count: 2
+# Offense count: 5
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Width, AllowedPatterns.
-Layout/IndentationWidth:
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
   Exclude:
-    - 'bin/extract-ituob-amendments.rb'
-    - 'e118_amendment.rb'
+    - 'spec/prosereflect/schema/conftest.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Lint/ScriptPermission:
+# Offense count: 4
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
+Lint/DuplicateBranch:
   Exclude:
-    - 'debug_loading.rb'
+    - 'lib/prosereflect/input/html.rb'
+    - 'lib/prosereflect/schema/attribute.rb'
+    - 'lib/prosereflect/schema/mark.rb'
+    - 'lib/prosereflect/schema/schema_class.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AutoCorrect, ContextCreatingMethods, MethodCreatingMethods.
-Lint/UselessAccessModifier:
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
+# NotImplementedExceptions: NotImplementedError
+Lint/UnusedMethodArgument:
   Exclude:
-    - 'e118_amendment.rb'
+    - 'lib/prosereflect/schema/node.rb'
 
-# Offense count: 5
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+# Offense count: 34
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
-  Max: 98
+  Exclude:
+    - 'lib/prosereflect/input/html.rb'
+    - 'lib/prosereflect/node.rb'
+    - 'lib/prosereflect/output/html.rb'
+    - 'lib/prosereflect/parser.rb'
+    - 'lib/prosereflect/schema/fragment.rb'
+    - 'lib/prosereflect/schema/mark_type.rb'
+    - 'lib/prosereflect/schema/node.rb'
+    - 'lib/prosereflect/schema/node_type.rb'
+    - 'lib/prosereflect/schema/schema_class.rb'
+    - 'spec/support/matchers.rb'
 
-# Offense count: 23
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 201
+# Offense count: 1
+# Configuration parameters: CountBlocks, CountModifierForms.
+Metrics/BlockNesting:
+  Max: 4
 
-# Offense count: 4
-# Configuration parameters: AllowedMethods, AllowedPatterns.
+# Offense count: 30
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
-  Max: 30
-
-# Offense count: 6
+  Exclude:
+    - 'lib/prosereflect/code_block.rb'
+    - 'lib/prosereflect/input/html.rb'
+    - 'lib/prosereflect/node.rb'
+    - 'lib/prosereflect/output/html.rb'
+    - 'lib/prosereflect/parser.rb'
+    - 'lib/prosereflect/schema/attribute.rb'
+    - 'lib/prosereflect/schema/fragment.rb'
+    - 'lib/prosereflect/schema/mark_type.rb'
+    - 'lib/prosereflect/schema/node.rb'
+    - 'lib/prosereflect/schema/node_type.rb'
+    - 'lib/prosereflect/schema/schema_class.rb'
+    - 'spec/support/matchers.rb'
+
+# Offense count: 45
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 47
+  Max: 84
 
-# Offense count: 3
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/PerceivedComplexity:
-  Max: 32
+# Offense count: 2
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 8
 
-# Offense count: 9
-# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
-# SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: TLS1_1, TLS1_2, capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
-Naming/VariableNumber:
+# Offense count: 30
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
   Exclude:
-    - 'e118_entry.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# AllowedMethods: lambda, proc, it
-Style/BlockDelimiters:
-  Exclude:
-    - 'bin/extract-ituob-amendments.rb'
-
-# Offense count: 11
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'e118_amendment.rb'
-    - 'e118_entry.rb'
-    - 'lib/prosereflect/document.rb'
-    - 'lib/prosereflect/hard_break.rb'
+    - 'lib/prosereflect/code_block.rb'
+    - 'lib/prosereflect/input/html.rb'
     - 'lib/prosereflect/node.rb'
-    - 'lib/prosereflect/paragraph.rb'
+    - 'lib/prosereflect/output/html.rb'
     - 'lib/prosereflect/parser.rb'
-    - 'lib/prosereflect/table.rb'
-    - 'lib/prosereflect/table_cell.rb'
-    - 'lib/prosereflect/table_row.rb'
-    - 'lib/prosereflect/text.rb'
+    - 'lib/prosereflect/schema/fragment.rb'
+    - 'lib/prosereflect/schema/mark_type.rb'
+    - 'lib/prosereflect/schema/node.rb'
+    - 'lib/prosereflect/schema/node_type.rb'
+    - 'lib/prosereflect/schema/schema_class.rb'
+    - 'spec/support/matchers.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
+# Offense count: 4
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
   Exclude:
-    - '**/*.arb'
-    - 'bin/extract-ituob-amendments.rb'
+    - 'lib/prosereflect/schema/fragment.rb'
+    - 'lib/prosereflect/schema/node.rb'
 
-# Offense count: 7
-# This cop supports safe autocorrection (--autocorrect).
-Style/IfUnlessModifier:
-  Exclude:
-    - 'e118_amendment.rb'
-    - 'e118_entry.rb'
+# Offense count: 6
+# Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
+# AllowedMethods: call
+# WaywardPredicates: infinite?, nonzero?
+Naming/PredicateMethod:
+  Exclude:
+    - 'lib/prosereflect/schema/attribute.rb'
+    - 'lib/prosereflect/schema/node.rb'
+
+# Offense count: 12
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros, UseSorbetSigs.
+# NamePrefix: is_, has_, have_, does_
+# ForbiddenPrefixes: is_, has_, have_, does_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicatePrefix:
+  Exclude:
+    - 'lib/prosereflect/schema/mark.rb'
+    - 'lib/prosereflect/schema/mark_type.rb'
+    - 'lib/prosereflect/schema/node.rb'
+    - 'lib/prosereflect/schema/node_type.rb'
 
 # Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, MinBodyLength, AllowConsecutiveConditionals.
-# SupportedStyles: skip_modifier_ifs, always
-Style/Next:
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
   Exclude:
-    - 'e118_amendment.rb'
+    - 'lib/prosereflect/input/html.rb'
 
-# Offense count: 9
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
-# SupportedStyles: predicate, comparison
-Style/NumericPredicate:
+# Offense count: 7
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
   Exclude:
-    - 'spec/**/*'
-    - 'e118_amendment.rb'
-    - 'e118_entry.rb'
-    - 'lib/prosereflect/table.rb'
+    - 'spec/prosereflect/parser_spec.rb'
+    - 'spec/prosereflect/schema/conftest.rb'
+    - 'spec/support/shared_examples.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/ParallelAssignment:
-  Exclude:
-    - 'e118_amendment.rb'
+# Offense count: 142
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 134
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantSelf:
-  Exclude:
-    - 'e118_amendment.rb'
+# Offense count: 73
+RSpec/MultipleExpectations:
+  Max: 8
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, explicit
-Style/RescueStandardError:
-  Exclude:
-    - 'bin/extract-ituob-amendments.rb'
-
-# Offense count: 4
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
-# AllowedMethods: present?, blank?, presence, try, try!
-Style/SafeNavigation:
-  Exclude:
-    - 'e118_amendment.rb'
+# Offense count: 7
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 4
 
-# Offense count: 1
+# Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
-Style/SlicingWithRange:
+Style/IdenticalConditionalBranches:
   Exclude:
-    - 'lib/prosereflect/table.rb'
+    - 'lib/prosereflect/schema/mark.rb'
 
-# Offense count: 38
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'bin/console'
-    - 'bin/extract-ituob-amendments.rb'
-    - 'lib/prosereflect.rb'
-    - 'lib/prosereflect/version.rb'
-    - 'prosereflect.gemspec'
-
-# Offense count: 7
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/ZeroLengthPredicate:
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
+Style/TrailingCommaInArguments:
   Exclude:
-    - 'e118_amendment.rb'
-    - 'e118_entry.rb'
+    - 'spec/prosereflect/schema/conftest.rb'
 
-# Offense count: 6
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 153
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
+Style/TrailingCommaInHashLiteral:
+  Exclude:
+    - 'spec/prosereflect/schema/conftest.rb'

data/CLAUDE.md

@@ -0,0 +1,78 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+`prosereflect` is a Ruby gem for parsing, manipulating, and traversing ProseMirror rich text editor document trees. It provides a Ruby object model over ProseMirror's JSON/YAML format with HTML import/export capabilities.
+
+## Commands
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests and linting
+rake
+
+# Run tests only
+rake spec
+
+# Run a specific spec file
+rspec spec/prosereflect/parser_spec.rb
+
+# Run a specific test
+rspec spec/prosereflect/parser_spec.rb:42
+
+# Run linting only
+rake rubocop
+```
+
+## Architecture
+
+### Core Classes
+
+- **Node** (`lib/prosereflect/node.rb`) - Base class for all document elements, extends `Lutaml::Model::Serializable`. All node types inherit `type`, `attrs`, `marks`, and `content` attributes.
+- **Document** (`lib/prosereflect/document.rb`) - Top-level container, extends Node. Provides convenience methods like `tables`, `paragraphs`, `find_first`, `find_all`, `find_children`.
+- **Parser** (`lib/prosereflect/parser.rb`) - Converts ProseMirror JSON/YAML hash structure into Node objects via `parse_document`.
+
+### Node Hierarchy
+
+All node types inherit from Node and define a `PM_TYPE` constant matching ProseMirror's type strings:
+- Block nodes: `Document`, `Paragraph`, `Heading`, `Table`, `TableRow`, `TableCell`, `TableHeader`, `BulletList`, `OrderedList`, `ListItem`, `Blockquote`, `CodeBlockWrapper`, `CodeBlock`, `HorizontalRule`, `Image`, `HardBreak`
+- Text nodes: `Text` with `Mark` collections (Bold, Italic, Code, Link, Strike, Subscript, Superscript, Underline)
+- Special: `User` for @mentions
+
+### HTML Conversion
+
+- **Input::Html** (`lib/prosereflect/input/html.rb`) - Parses HTML strings into Document using Nokogiri
+- **Output::Html** (`lib/prosereflect/output/html.rb`) - Converts Document back to HTML using Nokogiri::HTML::Builder
+
+### Serialization
+
+Uses `lutaml-model` for attribute serialization. The `key_value` block defines how Ruby attributes map to ProseMirror JSON keys. Override `to_h` methods handle special cases for attrs/marks serialization.
+
+### Key Dependencies
+
+- `lutaml-model` (~> 0.8) - Serialization framework
+- `nokogiri` (~> 1.18) - HTML parsing/generation
+
+## Superseding prosemirror-py
+
+This library aims to be a full superset of the Python [prosemirror-py](https://github.com/metanorma/prosemirror-py). See `TODO.py-audit/` for detailed feature gap analysis and implementation plans to achieve complete compliance and schema validation parity.
+
+## Data Model Pattern
+
+```ruby
+class SomeNode < Node
+  PM_TYPE = 'some_node'
+
+  attribute :custom_attr, :string
+
+  key_value do
+    map 'type', to: :type, render_default: true
+    map 'attrs', to: :attrs
+    map 'content', to: :content
+  end
+end
+```

data/Gemfile

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in prosereflect.gemspec
 gemspec
 
-gem 'rake'
-gem 'rspec'
-gem 'rubocop'
+gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"