prosemirror 0.1.0 → 0.2.0

data/lib/prosemirror/type_definition.rb

@@ -18,14 +18,34 @@ module Prosemirror
       inherited_setting(:@aliases, [])
     end
 
-    # Declare an attribute. Same as Literal's `prop`, with two options:
+    # Declare an attribute. Same as Literal's `prop`, with these 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
+    # - `aliases:` other JSON names accepted on input (`["order"]`);
+    # - `parse_html:` a block reading the attribute from an HTML element, when importing HTML. By default,
+    #   the HTML attribute with the JSON name is read.
+    def prop(name, type, kind = :keyword, json: nil, aliases: [], parse_html: nil, **, &)
+      attribute_names[name] = {json: (json || name).to_s, aliases: aliases.map(&:to_s), parse_html:}.freeze
       super(name, type, kind, **, &)
     end
 
+    # Declare how to recognize this type in HTML. See ParseRule for the options. The block, if given, is the
+    # rule's `get_attrs`. A subclass that declares rules replaces the rules of its parent.
+    def parse_html(tag: nil, style: nil, **options, &get_attrs)
+      (@parse_rules ||= []) << ParseRule.new(type: self, tag:, style:, get_attrs:, **options)
+    end
+
+    def parse_rules
+      inherited_setting(:@parse_rules, [])
+    end
+
+    # The attributes read from an HTML element, by JSON name, without the missing ones.
+    def attrs_from_html(element)
+      attribute_names.each_value.with_object({}) do |names, attrs|
+        value = names[:parse_html] ? names[:parse_html].call(element) : element[names[:json]]
+        attrs[names[:json]] = value unless value.nil?
+      end
+    end
+
     def attribute_names
       @attribute_names ||= concrete_superclass ? concrete_superclass.attribute_names.dup : {}
     end
@@ -54,6 +74,16 @@ module Prosemirror
       end
     end
 
+    # Whether an attribute has no default, so that a node of this type can't be created empty.
+    def required_attrs?
+      literal_properties.any? { |property| !optional_attribute?(property) }
+    end
+
+    # The attributes of a node of this type created empty: the defaults.
+    def default_attrs
+      build_attrs({}, report: ->(_) {})
+    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)

data/lib/prosemirror/version.rb

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

data/lib/prosemirror.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
+# Phlex 2.4.1 checks attribute values against Date without loading it. Remove once a release includes the fix:
+# https://github.com/yippee-fun/phlex/issues/974
+require "date"
 require "json"
 require "literal"
 require "phlex"
 require "zeitwerk"
 
 loader = Zeitwerk::Loader.for_gem
-loader.inflector.inflect("html_renderer" => "HTMLRenderer", "json_parser" => "JSONParser")
+loader.inflector.inflect(
+  "html" => "HTML", "html_parser" => "HTMLParser", "html_renderer" => "HTMLRenderer", "json_parser" => "JSONParser"
+)
 loader.setup
 
 # Render ProseMirror and Tiptap documents.
@@ -35,5 +40,10 @@ module Prosemirror
     def parse(json, schema: self.schema)
       schema.parse(json)
     end
+
+    # Build a document from HTML, with the schema's parse rules. Needs the `herb` gem.
+    def from_html(html, schema: self.schema)
+      schema.parse_html(html)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prosemirror
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hans Lemuet
@@ -64,14 +64,25 @@ files:
 - LICENSE.txt
 - README.md
 - ROADMAP.md
+- TYPES.md
 - lib/prosemirror.rb
 - lib/prosemirror/coerce.rb
 - lib/prosemirror/content_expression.rb
+- lib/prosemirror/content_match.rb
 - lib/prosemirror/document.rb
+- lib/prosemirror/html/builder.rb
+- lib/prosemirror/html/element.rb
+- lib/prosemirror/html/entities.rb
+- lib/prosemirror/html/entities.txt
+- lib/prosemirror/html/selector.rb
+- lib/prosemirror/html/splitter.rb
+- lib/prosemirror/html/text.rb
+- lib/prosemirror/html_parser.rb
 - lib/prosemirror/html_renderer.rb
 - lib/prosemirror/json_parser.rb
 - lib/prosemirror/mark.rb
 - lib/prosemirror/mark_type.rb
+- lib/prosemirror/marks/basic/code.rb
 - lib/prosemirror/marks/basic/em.rb
 - lib/prosemirror/marks/basic/link.rb
 - lib/prosemirror/marks/basic/strong.rb
@@ -106,6 +117,7 @@ files:
 - lib/prosemirror/nodes/table_header.rb
 - lib/prosemirror/nodes/table_row.rb
 - lib/prosemirror/nodes/text.rb
+- lib/prosemirror/parse_rule.rb
 - lib/prosemirror/rendering.rb
 - lib/prosemirror/schema.rb
 - lib/prosemirror/text_serializer.rb