prosereflect 0.1.0

data/spec/support/shared_examples.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'a parsable format' do |format|
+  it "parses #{format} content correctly" do
+    document = case format
+               when :yaml
+                 Prosereflect::Parser.parse_document(YAML.safe_load(file_content))
+               when :json
+                 Prosereflect::Parser.parse_document(JSON.parse(file_content))
+               end
+
+    expect(document).to be_a(Prosereflect::Document)
+    expect(document.content).not_to be_empty
+  end
+
+  it "maintains structure after #{format} round-trip" do
+    # Parse the original content
+    original_data = case format
+                    when :yaml
+                      YAML.safe_load(file_content)
+                    when :json
+                      JSON.parse(file_content)
+                    end
+
+    # Create a document from the data
+    document = Prosereflect::Parser.parse_document(original_data)
+
+    # Convert back to the original format
+    round_trip_data = case format
+                      when :yaml
+                        YAML.safe_load(document.to_yaml)
+                      when :json
+                        JSON.parse(document.to_json)
+                      end
+
+    # Compare the structures
+    case format
+    when :yaml
+      expect(round_trip_data).to be_equivalent_yaml(original_data)
+    when :json
+      expect(round_trip_data).to be_equivalent_json(original_data)
+    end
+  end
+end
+
+RSpec.shared_examples 'a document with tables' do
+  it 'contains at least one table' do
+    document = case file_content
+               when String
+                 if file_content.strip.start_with?('{')
+                   Prosereflect::Parser.parse_document(JSON.parse(file_content))
+                 else
+                   Prosereflect::Parser.parse_document(YAML.safe_load(file_content))
+                 end
+               else
+                 Prosereflect::Parser.parse_document(file_content)
+               end
+
+    expect(document.tables.size).to be > 0
+  end
+
+  it 'has tables with rows and cells' do
+    document = case file_content
+               when String
+                 if file_content.strip.start_with?('{')
+                   Prosereflect::Parser.parse_document(JSON.parse(file_content))
+                 else
+                   Prosereflect::Parser.parse_document(YAML.safe_load(file_content))
+                 end
+               else
+                 Prosereflect::Parser.parse_document(file_content)
+               end
+
+    table = document.tables.first
+    expect(table.rows.size).to be > 0
+    expect(table.rows.first.cells.size).to be > 0
+  end
+end
+
+RSpec.shared_examples 'document traversal' do
+  it 'can find nodes by type' do
+    document = case file_content
+               when String
+                 if file_content.strip.start_with?('{')
+                   Prosereflect::Parser.parse_document(JSON.parse(file_content))
+                 else
+                   Prosereflect::Parser.parse_document(YAML.safe_load(file_content))
+                 end
+               else
+                 Prosereflect::Parser.parse_document(file_content)
+               end
+
+    expect(document.find_all('table').size).to be > 0
+    expect(document.find_all('paragraph').size).to be >= 0
+    expect(document.find_all('text').size).to be > 0
+  end
+end
+
+RSpec.shared_examples 'text content extraction' do
+  it 'extracts text content from nodes' do
+    document = case file_content
+               when String
+                 if file_content.strip.start_with?('{')
+                   Prosereflect::Parser.parse_document(JSON.parse(file_content))
+                 else
+                   Prosereflect::Parser.parse_document(YAML.safe_load(file_content))
+                 end
+               else
+                 Prosereflect::Parser.parse_document(file_content)
+               end
+
+    # Get text from the first paragraph or table cell that contains text
+    text_container = document.find_first('paragraph') || document.find_first('table_cell')
+
+    if text_container
+      expect(text_container.text_content).to be_a(String)
+      expect(text_container.text_content).not_to be_empty if text_container.find_first('text')
+    end
+  end
+end
+
+RSpec.shared_examples 'document creation' do
+  it 'creates an empty document' do
+    document = Prosereflect::Document.create
+    expect(document).to be_a(Prosereflect::Document)
+    expect(document.type).to eq('doc')
+    expect(document.content).to eq([])
+  end
+
+  it 'creates a document with attributes' do
+    attrs = { 'version' => '1.0' }
+    document = Prosereflect::Document.create(attrs)
+    expect(document.attrs).to eq(attrs)
+  end
+
+  it 'adds paragraphs to a document' do
+    document = Prosereflect::Document.create
+    paragraph = document.add_paragraph('Test paragraph')
+
+    expect(document.content.size).to eq(1)
+    expect(paragraph).to be_a(Prosereflect::Paragraph)
+    expect(paragraph.text_content).to eq('Test paragraph')
+  end
+
+  it 'adds tables to a document' do
+    document = Prosereflect::Document.create
+    table = document.add_table
+
+    expect(document.content.size).to eq(1)
+    expect(table).to be_a(Prosereflect::Table)
+  end
+end
+
+# Helper for parsing any format of content
+RSpec.shared_examples 'format parsing' do
+  let(:document) do
+    case file_content
+    when String
+      if file_content.strip.start_with?('{')
+        Prosereflect::Parser.parse_document(JSON.parse(file_content))
+      else
+        Prosereflect::Parser.parse_document(YAML.safe_load(file_content))
+      end
+    else
+      Prosereflect::Parser.parse_document(file_content)
+    end
+  end
+end
+
+RSpec.shared_examples 'format round-trip' do |format|
+  it "maintains document structure after #{format} round-trip" do
+    # Create a rich document
+    document = Prosereflect::Document.create
+
+    # Add paragraph with formatted text
+    para = document.add_paragraph('Plain text')
+    para.add_text(' bold text', [{ 'type' => 'bold' }])
+    para.add_hard_break
+    para.add_text('After line break', [{ 'type' => 'italic' }])
+
+    # Add a table
+    table = document.add_table
+    table.add_header(['Header 1', 'Header 2', 'Header 3'])
+    table.add_row(%w[R1C1 R1C2 R1C3])
+    table.add_row(%w[R2C1 R2C2 R2C3])
+
+    # Add another paragraph
+    document.add_paragraph('Concluding paragraph')
+
+    # Convert to specified format and back
+    parsed_doc = round_trip_conversion(document, format)
+
+    # Verify structure is maintained
+    expect(parsed_doc.paragraphs.size).to eq(document.paragraphs.size)
+    expect(parsed_doc.tables.size).to eq(document.tables.size)
+    expect(parsed_doc.find_all('hard_break').size).to eq(document.find_all('hard_break').size)
+
+    # Verify table structure
+    table_in_parsed = parsed_doc.first_table
+    expect(table_in_parsed.rows.size).to eq(document.first_table.rows.size)
+    expect(table_in_parsed.header_row.cells.size).to eq(document.first_table.header_row.cells.size)
+  end
+
+  def round_trip_conversion(doc, format)
+    case format
+    when :yaml
+      yaml = doc.to_yaml
+      parsed = Prosereflect::Parser.parse_document(YAML.safe_load(yaml))
+      # Compare structures
+      expect(YAML.safe_load(parsed.to_yaml)).to be_equivalent_yaml(YAML.safe_load(doc.to_yaml))
+      parsed
+    when :json
+      json = doc.to_json
+      parsed = Prosereflect::Parser.parse_document(JSON.parse(json))
+      # Compare structures
+      expect(JSON.parse(parsed.to_json)).to be_equivalent_json(JSON.parse(doc.to_json))
+      parsed
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: prosereflect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description:
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.adoc
+- Rakefile
+- debug_loading.rb
+- lib/prosereflect.rb
+- lib/prosereflect/document.rb
+- lib/prosereflect/hard_break.rb
+- lib/prosereflect/node.rb
+- lib/prosereflect/paragraph.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/version.rb
+- prosereflect.gemspec
+- sig/prosemirror.rbs
+- spec/fixtures/ituob-1000/ituob-1000-DP.json
+- spec/fixtures/ituob-1000/ituob-1000-DP.yaml
+- spec/fixtures/ituob-1000/ituob-1000-E118_IIN.json
+- spec/fixtures/ituob-1000/ituob-1000-E118_IIN.yaml
+- spec/fixtures/ituob-1000/ituob-1000-E164_ACN.json
+- spec/fixtures/ituob-1000/ituob-1000-E164_ACN.yaml
+- spec/fixtures/ituob-1000/ituob-1000-E212_MNC.json
+- spec/fixtures/ituob-1000/ituob-1000-E212_MNC.yaml
+- spec/fixtures/ituob-1000/ituob-1000-F32_TDI.json
+- spec/fixtures/ituob-1000/ituob-1000-F32_TDI.yaml
+- spec/fixtures/ituob-1000/ituob-1000-M1400_ICC.json
+- spec/fixtures/ituob-1000/ituob-1000-M1400_ICC.yaml
+- spec/fixtures/ituob-1000/ituob-1000-NNP.json
+- spec/fixtures/ituob-1000/ituob-1000-NNP.yaml
+- spec/fixtures/ituob-1000/ituob-1000-Q708_ISPC.json
+- spec/fixtures/ituob-1000/ituob-1000-Q708_ISPC.yaml
+- spec/fixtures/ituob-1000/ituob-1000-Q708_SANC.json
+- spec/fixtures/ituob-1000/ituob-1000-Q708_SANC.yaml
+- spec/fixtures/ituob-1000/ituob-1000-R_SP_LM.V.json
+- spec/fixtures/ituob-1000/ituob-1000-R_SP_LM.V.yaml
+- spec/fixtures/ituob-1000/ituob-1000-T35_NA.json
+- spec/fixtures/ituob-1000/ituob-1000-T35_NA.yaml
+- spec/fixtures/ituob-1001/ituob-1001-DP.json
+- spec/fixtures/ituob-1001/ituob-1001-DP.yaml
+- spec/fixtures/ituob-1001/ituob-1001-E118_IIN.json
+- spec/fixtures/ituob-1001/ituob-1001-E118_IIN.yaml
+- spec/fixtures/ituob-1001/ituob-1001-E164_ACN.json
+- spec/fixtures/ituob-1001/ituob-1001-E164_ACN.yaml
+- spec/fixtures/ituob-1001/ituob-1001-E164_CC.json
+- spec/fixtures/ituob-1001/ituob-1001-E164_CC.yaml
+- spec/fixtures/ituob-1001/ituob-1001-E212_MNC.json
+- spec/fixtures/ituob-1001/ituob-1001-E212_MNC.yaml
+- spec/fixtures/ituob-1001/ituob-1001-NNP.json
+- spec/fixtures/ituob-1001/ituob-1001-NNP.yaml
+- spec/fixtures/ituob-1001/ituob-1001-Q708_ISPC.json
+- spec/fixtures/ituob-1001/ituob-1001-Q708_ISPC.yaml
+- spec/prosereflect/document_spec.rb
+- spec/prosereflect/hard_break_spec.rb
+- spec/prosereflect/node_spec.rb
+- spec/prosereflect/paragraph_spec.rb
+- spec/prosereflect/parser_spec.rb
+- spec/prosereflect/table_cell_spec.rb
+- spec/prosereflect/table_row_spec.rb
+- spec/prosereflect/table_spec.rb
+- spec/prosereflect/text_spec.rb
+- spec/prosereflect/version_spec.rb
+- spec/prosereflect_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/metanorma/prosereflect
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/metanorma/prosereflect
+  source_code_uri: https://github.com/metanorma/prosereflect
+  bug_tracker_uri: https://github.com/metanorma/prosereflect/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby model accessor for prosereflect document trees.
+test_files: []