markly 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3121bb14bcb09883bfb84879b6b69e28d47e3781f0bcd6225737734040ac2ec5
-  data.tar.gz: 2f47e7add1ee43c03e7b75b45e5f2c7ec2c322cac842aa5f5bdb8e539fbca8d5
+  metadata.gz: 770b81ed57426a591eaa4335ad913df94f61017e08f5e19872766e59ec3d33db
+  data.tar.gz: 45f5295c1fae1747c841a85b8f17f1442d47ad91194a38874e1313e8c95313f4
 SHA512:
-  metadata.gz: 6da8e6ef6f672489b7bcd4b6e378c86d3240e4b3f9d67aaba26bbe5414a363c4a071be3695bca85bb9658c0213cf1e59d32edb389b5ec8a0aebd9689a8245ff7
-  data.tar.gz: ce28eac1fcca2c0dfc6e637ca937e16ffbb211d4d64c596f3869b56860fb04227b20065c86a5d335cb8d11cdd49c1e924a09b0caa0b515e404e123420ed39e7d
+  metadata.gz: 75bdb5b83d6ca7685fb659d27f45bfaaefe1241f306ec21281bbbd5906612663c8e4ba7ad3abf59069ff6501c72933c6770d09176dd119de946e5baea0b826ff
+  data.tar.gz: 0c0aa153efcbbb7914a805e52bf80fdda4bdc5d1ddb0352f7bb00c334f2730d8cd342a19fa273082c07597c16166c666b8f86be66a197729f902e0539903af8f

data/ext/markly/markly.c

@@ -41,11 +41,15 @@ static VALUE sym_right;
 static VALUE sym_center;
 
 static void rb_Markly_Node_free(void *data) {
-	// It's important that the `free` function does not inspect the node data, as it may be part of a tree that was already freed.
-	cmark_node *node = (cmark_node*)data;
-	
-	if (cmark_node_parent(node) == NULL) {
-		cmark_node_free(node);
+	// If a parent of this node is already freed, `rb_Markly_Node_freed` will ensure all the nodes are nullified.
+	if (data) {
+		cmark_node *node = (cmark_node*)data;
+		
+		if (cmark_node_parent(node) == NULL) {
+			cmark_node_free(node);
+		} else {
+			cmark_node_set_user_data(node, NULL);
+		}
 	}
 }
 
@@ -79,6 +83,12 @@ static const rb_data_type_t rb_Markly_Node_Type = {
 	.flags = RUBY_TYPED_FREE_IMMEDIATELY,
 };
 
+static void rb_Markly_Node_freed(cmark_mem *mem, void *user_data) {
+	VALUE self = (VALUE)user_data;
+	
+	RTYPEDDATA_DATA(self) = NULL;
+}
+
 static VALUE rb_Markly_Node_wrap(cmark_node *node) {
 	if (node == NULL)
 		return Qnil;
@@ -91,6 +101,7 @@ static VALUE rb_Markly_Node_wrap(cmark_node *node) {
 	
 	VALUE self = TypedData_Wrap_Struct(rb_Markly_Node, &rb_Markly_Node_Type, node);
 	cmark_node_set_user_data(node, (void *)self);
+	cmark_node_set_user_data_free_func(node, rb_Markly_Node_freed);
 	
 	return self;
 }
@@ -121,16 +132,6 @@ static const rb_data_type_t rb_Markly_Parser_Type = {
 	.flags = RUBY_TYPED_FREE_IMMEDIATELY,
 };
 
-static VALUE rb_Markly_Parser_root(VALUE self) {
-	cmark_parser *parser = NULL;
-	
-	TypedData_Get_Struct(self, cmark_parser, &rb_Markly_Parser_Type, parser);
-	
-	assert(parser != NULL);
-	
-	return rb_Markly_Node_wrap(parser->root);
-}
-
 static VALUE rb_Markly_Parser_alloc(VALUE self) {
 	return TypedData_Wrap_Struct(self, &rb_Markly_Parser_Type, NULL);
 }
@@ -262,6 +263,21 @@ static VALUE rb_node_new(VALUE self, VALUE type) {
   return rb_Markly_Node_wrap(node);
 }
 
+static VALUE rb_node_replace(VALUE self, VALUE other) {
+	cmark_node *current_node = NULL, *replacement_node = NULL;
+	
+	TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, current_node);
+	TypedData_Get_Struct(other, cmark_node, &rb_Markly_Node_Type, replacement_node);
+	
+	int result = cmark_node_replace(current_node, replacement_node);
+	
+	if (result == 0) {
+		rb_raise(rb_Markly_Error, "could not replace node");
+	}
+	
+	return other;
+}
+
 static VALUE encode_utf8_string(const char *c_string) {
   VALUE string = rb_str_new2(c_string);
   int enc = rb_enc_find_index("UTF-8");
@@ -315,10 +331,10 @@ static VALUE rb_node_set_string_content(VALUE self, VALUE s) {
  * Returns a {Symbol} representing the node's type.
  */
 static VALUE rb_node_get_type(VALUE self) {
-  int node_type;
-  cmark_node *node;
-  VALUE symbol;
-  const char *s;
+  int node_type = 0;
+  cmark_node *node = NULL;
+  VALUE symbol = NULL;
+  const char *s = NULL;
 
   TypedData_Get_Struct(self, cmark_node, &rb_Markly_Node_Type, node);
 
@@ -1178,10 +1194,12 @@ __attribute__((visibility("default"))) void Init_markly() {
 	rb_define_method(rb_Markly_Parser, "initialize", rb_Markly_Parser_initialize, 1);
 	rb_define_method(rb_Markly_Parser, "enable", rb_Markly_Parser_enable, 1);
 	rb_define_method(rb_Markly_Parser, "parse", rb_Markly_Parser_parse, 1);
-	rb_define_method(rb_Markly_Parser, "root", rb_Markly_Parser_root, 0);
 	
   rb_Markly_Node = rb_define_class_under(rb_Markly, "Node", rb_cObject);
   rb_define_singleton_method(rb_Markly_Node, "new", rb_node_new, 1);
+
+	rb_define_method(rb_Markly_Node, "replace", rb_node_replace, 1);
+
   rb_define_method(rb_Markly_Node, "string_content", rb_node_get_string_content, 0);
   rb_define_method(rb_Markly_Node, "string_content=", rb_node_set_string_content, 1);
   rb_define_method(rb_Markly_Node, "type", rb_node_get_type, 0);

data/lib/markly/node.rb

@@ -39,6 +39,8 @@ module Markly
       _render_commonmark(flags, width).force_encoding('utf-8')
     end
 
+    alias to_markdown to_commonmark
+
     # Public: Convert the node to a plain text string.
     #
     # options - A {Symbol} or {Array of Symbol}s indicating the render options

data/lib/markly/renderer/html_renderer.rb

@@ -1,15 +1,31 @@
 # frozen_string_literal: true
 
+require 'cgi'
+
 module Markly
-  class HtmlRenderer < Renderer
+  class HTMLRenderer < Renderer
+    def initialize(ids: false, **options)
+      super(**options)
+      
+      @ids = ids
+    end
+    
     def document(_)
       super
       out("</ol>\n</section>\n") if @written_footnote_ix
     end
 
+    def id_for(node)
+      if @ids
+        id = node.to_plaintext.chomp.downcase.gsub(/\s+/, '-')
+        
+        return " id=\"#{CGI.escape_html id}\""
+      end
+    end
+
     def header(node)
       block do
-        out('<h', node.header_level, "#{source_position(node)}>", :children,
+        out('<h', node.header_level, "#{id_for(node)}#{source_position(node)}>", :children,
             '</h', node.header_level, '>')
       end
     end
@@ -249,4 +265,7 @@ module Markly
       node.tasklist_item_checked?
     end
   end
+  
+  # Legacy.
+  HtmlRenderer = HTMLRenderer
 end

data/lib/markly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Markly
-  VERSION = '0.1.0'
+	VERSION = '0.4.0'
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: markly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Garen Torikian
 - Ashe Connor
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -26,34 +26,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-modernize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -96,8 +68,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
-email: 
+description:
+email:
 executables:
 - markly
 extensions:
@@ -178,7 +150,7 @@ files:
 - ext/markly/xml.c
 - lib/markly.rb
 - lib/markly/flags.rb
-- lib/markly/markly.so
+- lib/markly/markly.bundle
 - lib/markly/node.rb
 - lib/markly/node/inspect.rb
 - lib/markly/renderer.rb
@@ -189,7 +161,7 @@ licenses:
 - MIT
 metadata:
   funding_uri: https://github.com/sponsors/ioquatix/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -205,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: CommonMark parser and renderer. Written in C, wrapped in Ruby.
 test_files: []