prosemirror 0.0.1 → 0.1.0

data/lib/prosemirror/text_serializer.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Prosemirror
+  # Extracts the text of a document, as ProseMirror's `textBetween` and Tiptap's `getText` do:
+  # textblocks and leaf blocks with text are separated by `block_separator`,
+  # and leaf nodes such as hard breaks are replaced by their `leaf_text`.
+  class TextSerializer
+    def initialize(schema, block_separator: "\n\n")
+      @schema = schema
+      @block_separator = block_separator
+    end
+
+    def call(root)
+      text = +""
+      first = true
+
+      root.descendants do |node|
+        node_type = @schema.node_type(node.type)
+        node_text = text_of(node, node_type)
+
+        if separated?(node_type, node_text)
+          text << @block_separator unless first
+          first = false
+        end
+        text << node_text
+      end
+
+      text
+    end
+
+    private
+
+    def text_of(node, node_type)
+      return node.text if node.text?
+      return "" unless node_type&.leaf?
+
+      node_type.text_for(node)
+    end
+
+    def separated?(node_type, node_text)
+      return false unless node_type&.block?
+
+      node_type.leaf? ? !node_text.empty? : @schema.textblock?(node_type)
+    end
+  end
+end

data/lib/prosemirror/type_definition.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Prosemirror
+  # Class-level declarations shared by node types and mark types.
+  module TypeDefinition
+    # The name of the type, as a snake_case Symbol. It defaults to the class name (`BulletList` → `:bullet_list`),
+    # and subclasses of a concrete type keep its name.
+    def type_name(name = nil)
+      return @type_name = Naming.snake(name).to_sym if name
+
+      @type_name ||= concrete_superclass&.type_name || derived_type_name
+    end
+
+    # Other names accepted on input for this type, such as `:strong` for `:bold`.
+    def aliases(*names)
+      return @aliases = names.map { |n| Naming.snake(n).to_sym } unless names.empty?
+
+      inherited_setting(:@aliases, [])
+    end
+
+    # Declare an attribute. Same as Literal's `prop`, with two options:
+    # - `json:` the attribute name in JSON, when it differs from the property name (`"textAlign"`);
+    # - `aliases:` other JSON names accepted on input (`["order"]`).
+    def prop(name, type, kind = :keyword, json: nil, aliases: [], **, &)
+      attribute_names[name] = {json: (json || name).to_s, aliases: aliases.map(&:to_s)}.freeze
+      super(name, type, kind, **, &)
+    end
+
+    def attribute_names
+      @attribute_names ||= concrete_superclass ? concrete_superclass.attribute_names.dup : {}
+    end
+
+    # Build valid attributes from JSON attributes (a Hash with String or Symbol keys).
+    # Invalid values are converted when the meaning is clear, or replaced by their default.
+    # Returns nil when a required attribute is missing or invalid.
+    def build_attrs(given, report:)
+      given = given.is_a?(Hash) ? given.transform_keys(&:to_s) : {}
+
+      literal_properties.each_with_object({}) do |property, attrs|
+        json_name = attribute_names.dig(property.name, :json)
+        key = attribute_key(given, attribute_names.fetch(property.name))
+
+        if key
+          value = coerce_attribute(property, given[key])
+          next attrs[property.name] = value if property.type === value
+
+          report.call("invalid attribute #{json_name}: #{given[key].inspect}")
+        elsif !optional_attribute?(property)
+          report.call("missing attribute #{json_name}")
+        end
+        return nil unless optional_attribute?(property)
+
+        attrs[property.name] = default_attribute(property)
+      end
+    end
+
+    # The JSON attributes this type doesn't declare, with String keys, so that `to_h` gives them back.
+    def unknown_attrs(given)
+      return {} unless given.is_a?(Hash)
+
+      known = attribute_names.values.flat_map do |names|
+        [names[:json], *names[:aliases]].flat_map { |name| [name, Naming.snake(name), Naming.camel(name)] }
+      end
+      given.transform_keys(&:to_s).except(*known)
+    end
+
+    # Attributes as JSON, with their JSON names.
+    def serialize_attrs(attrs)
+      attrs.to_h { |name, value| [attribute_names.dig(name, :json) || name.to_s, value] }
+    end
+
+    def base_type?
+      false
+    end
+
+    private
+
+    def concrete_superclass
+      superclass unless superclass.base_type?
+    end
+
+    def derived_type_name
+      raise ArgumentError, "anonymous types need a type_name" if name.nil?
+
+      Naming.snake(name.split("::").last).to_sym
+    end
+
+    def inherited_setting(ivar, default)
+      return instance_variable_get(ivar) if instance_variable_defined?(ivar)
+      return default if superclass.base_type?
+
+      superclass.send(:inherited_setting, ivar, default)
+    end
+
+    def attribute_key(given, names)
+      [names[:json], *names[:aliases]].each do |name|
+        [name, Naming.snake(name), Naming.camel(name)].each do |candidate|
+          return candidate if given.key?(candidate)
+        end
+      end
+      nil
+    end
+
+    def coerce_attribute(property, value)
+      property.coercion ? property.coerce(value, context: self) : value
+    rescue
+      value
+    end
+
+    def optional_attribute?(property)
+      # Checks whether the Literal type accepts nil, so `.nil?` would be wrong here.
+      property.default? || property.type === nil # standard:disable Style/NilComparison
+    end
+
+    def default_attribute(property)
+      property.default? ? property.default_value(self) : nil
+    end
+  end
+end

data/lib/prosemirror/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prosemirror
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/prosemirror.rb

@@ -1,8 +1,39 @@
 # frozen_string_literal: true
 
-require_relative "prosemirror/version"
+require "json"
+require "literal"
+require "phlex"
+require "zeitwerk"
 
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect("html_renderer" => "HTMLRenderer", "json_parser" => "JSONParser")
+loader.setup
+
+# Render ProseMirror and Tiptap documents.
 module Prosemirror
   class Error < StandardError; end
-  # Your code goes here...
+
+  # Raised in strict mode, and passed to `on_invalid`, when a document doesn't match its schema.
+  class InvalidDocument < Error
+    attr_reader :path
+
+    def initialize(message, path: nil)
+      @path = path
+      super(path ? "#{path}: #{message}" : message)
+    end
+  end
+
+  class << self
+    attr_writer :schema
+
+    # The schema used when none is given. Defaults to `Schema.tiptap`.
+    def schema
+      @schema ||= Schema.tiptap
+    end
+
+    # Build a document from ProseMirror JSON, given as a Hash or a String.
+    def parse(json, schema: self.schema)
+      schema.parse(json)
+    end
+  end
 end

metadata

@@ -1,38 +1,124 @@
 --- !ruby/object:Gem::Specification
 name: prosemirror
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Hans Lemuet
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-03 00:00:00.000000000 Z
-dependencies: []
-description:
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: literal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: phlex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Render ProseMirror and Tiptap JSON documents to safe HTML or plain text,
+  with typed attributes and custom node types.
 email:
 - hans@etamin.studio
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
+- COOKBOOK.md
+- LICENSE.txt
 - README.md
-- Rakefile
+- ROADMAP.md
 - lib/prosemirror.rb
+- lib/prosemirror/coerce.rb
+- lib/prosemirror/content_expression.rb
+- lib/prosemirror/document.rb
+- lib/prosemirror/html_renderer.rb
+- lib/prosemirror/json_parser.rb
+- lib/prosemirror/mark.rb
+- lib/prosemirror/mark_type.rb
+- lib/prosemirror/marks/basic/em.rb
+- lib/prosemirror/marks/basic/link.rb
+- lib/prosemirror/marks/basic/strong.rb
+- lib/prosemirror/marks/bold.rb
+- lib/prosemirror/marks/code.rb
+- lib/prosemirror/marks/highlight.rb
+- lib/prosemirror/marks/italic.rb
+- lib/prosemirror/marks/link.rb
+- lib/prosemirror/marks/strike.rb
+- lib/prosemirror/marks/subscript.rb
+- lib/prosemirror/marks/superscript.rb
+- lib/prosemirror/marks/underline.rb
+- lib/prosemirror/naming.rb
+- lib/prosemirror/node.rb
+- lib/prosemirror/node_type.rb
+- lib/prosemirror/nodes/basic/code_block.rb
+- lib/prosemirror/nodes/basic/image.rb
+- lib/prosemirror/nodes/basic/ordered_list.rb
+- lib/prosemirror/nodes/blockquote.rb
+- lib/prosemirror/nodes/bullet_list.rb
+- lib/prosemirror/nodes/code_block.rb
+- lib/prosemirror/nodes/doc.rb
+- lib/prosemirror/nodes/hard_break.rb
+- lib/prosemirror/nodes/heading.rb
+- lib/prosemirror/nodes/horizontal_rule.rb
+- lib/prosemirror/nodes/image.rb
+- lib/prosemirror/nodes/list_item.rb
+- lib/prosemirror/nodes/ordered_list.rb
+- lib/prosemirror/nodes/paragraph.rb
+- lib/prosemirror/nodes/table.rb
+- lib/prosemirror/nodes/table_cell.rb
+- lib/prosemirror/nodes/table_header.rb
+- lib/prosemirror/nodes/table_row.rb
+- lib/prosemirror/nodes/text.rb
+- lib/prosemirror/rendering.rb
+- lib/prosemirror/schema.rb
+- lib/prosemirror/text_serializer.rb
+- lib/prosemirror/type_definition.rb
 - lib/prosemirror/version.rb
-- prosemirror.gemspec
 - sig/prosemirror.rbs
 homepage: https://github.com/etaminstudio/prosemirror
-licenses: []
+licenses:
+- MIT
 metadata:
-  homepage_uri: https://github.com/etaminstudio/prosemirror
   source_code_uri: https://github.com/etaminstudio/prosemirror
   changelog_uri: https://github.com/etaminstudio/prosemirror/blob/main/CHANGELOG.md
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -40,15 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
-summary: Convert HTML to ProseMirror JSON and back.
+summary: Render ProseMirror and Tiptap documents to HTML and text.
 test_files: []

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in prosemirror.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "minitest", "~> 5.0"
-
-gem "rubocop", "~> 1.21"

data/Rakefile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]

data/prosemirror.gemspec

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/prosemirror/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "prosemirror"
-  spec.version = Prosemirror::VERSION
-  spec.authors = ["Hans Lemuet"]
-  spec.email = ["hans@etamin.studio"]
-
-  spec.summary = "Convert HTML to ProseMirror JSON and back."
-  spec.homepage = "https://github.com/etaminstudio/prosemirror"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/etaminstudio/prosemirror"
-  spec.metadata["changelog_uri"] = "https://github.com/etaminstudio/prosemirror/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end