herb 0.9.5 → 0.9.7

data/templates/template.rb

@@ -449,6 +449,337 @@ module Herb
       end
     end
 
+    def self.escape_string(string)
+      string.to_s.gsub(/["\\]/) do |char|
+        case char
+        when "\\" then "\\\\"
+        when '"'  then '\\"'
+        else char
+        end
+      end
+    end
+
+    class HelperArgument
+      attr_reader :name, :position, :type, :optional, :default, :splat, :description
+
+      def initialize(config)
+        @name = config.fetch("name")
+        @position = config.fetch("position")
+        @type = Array(config.fetch("type"))
+        @optional = config.fetch("optional", false)
+        @default = config.fetch("default", nil)
+        @splat = config.fetch("splat", false)
+        @description = config.fetch("description", "")
+      end
+
+      def type_display
+        @type.join(" | ")
+      end
+
+      def escaped_description
+        Template.escape_string(@description)
+      end
+
+      def escaped_default
+        @default ? Template.escape_string(@default) : nil
+      end
+    end
+
+    class HelperOption
+      attr_reader :name, :type, :maps_to, :description
+
+      def initialize(config)
+        @name = config.fetch("name")
+        @type = Array(config.fetch("type"))
+        @maps_to = config.fetch("maps_to", nil)
+        @description = config.fetch("description", "")
+      end
+
+      def type_display
+        @type.join(" | ")
+      end
+
+      def escaped_description
+        Template.escape_string(@description)
+      end
+    end
+
+    class HelperImplicitAttribute
+      attr_reader :name, :source, :source_with_block, :wrapper, :skip_wrapping_for,
+                  :wrapper_quotes_arg
+
+      def initialize(config)
+        @name = config.fetch("name")
+        @source = config.fetch("source")
+        @source_with_block = config.fetch("source_with_block", nil)
+        @wrapper = config.fetch("wrapper")
+        @wrapper_quotes_arg = config.fetch("wrapper_quotes_arg", false)
+        @skip_wrapping_for = config.fetch("skip_wrapping_for", [])
+      end
+    end
+
+    class HelperContent
+      attr_reader :source, :arg_position, :skip_if_hash, :to_s_suffix_when_single
+
+      def initialize(config)
+        @source = config.fetch("source")
+        @arg_position = config.fetch("arg_position", nil)
+        @skip_if_hash = config.fetch("skip_if_hash", false)
+        @to_s_suffix_when_single = config.fetch("to_s_suffix_when_single", false)
+      end
+
+      def null?
+        false
+      end
+
+      def first_arg?
+        @source == "first_arg"
+      end
+
+      def block_or_arg?
+        @source == "block_or_arg"
+      end
+    end
+
+    class HelperSpecialBehavior
+      attr_reader :type, :config
+
+      def initialize(config)
+        if config.is_a?(String)
+          @type = config
+          @config = {}
+        else
+          @type = config.fetch("type")
+          @config = config
+        end
+      end
+
+      def implied_attribute?
+        @type == "implied_attribute"
+      end
+
+      def wrap_body?
+        @type == "wrap_body"
+      end
+
+      def multiple_elements?
+        @type == "multiple_elements"
+      end
+
+      def size_to_dimensions?
+        @type == "size_to_dimensions"
+      end
+
+      def remove_non_html_options?
+        @type == "remove_non_html_options"
+      end
+
+      def [](key)
+        @config[key.to_s]
+      end
+
+      def to_s
+        @type
+      end
+    end
+
+    class HelperTagInfo
+      attr_reader :name, :is_void, :preferred, :detect_style, :implicit_attribute
+
+      def initialize(config)
+        @name = config.fetch("name")
+        @is_void = config.fetch("is_void", false)
+        @preferred = config.fetch("preferred", false)
+        @detect_style = config.fetch("detect_style", nil)
+
+        implicit_config = config.fetch("implicit_attribute", nil)
+        @implicit_attribute = implicit_config ? HelperImplicitAttribute.new(implicit_config) : nil
+      end
+
+      def preferred?
+        @preferred
+      end
+
+      def implicit_attribute?
+        !@implicit_attribute.nil?
+      end
+
+      def call_name_detect?
+        @detect_style == "call_name"
+      end
+
+      def receiver_call_detect?
+        @detect_style == "receiver_call"
+      end
+    end
+
+    class HelperType
+      attr_reader :name, :source, :gem, :output, :visibility, :supports_block,
+                  :supported, :description, :signature, :documentation_url, :tag,
+                  :content, :attributes_arg, :attributes_arg_with_block,
+                  :transform_style, :custom_transform,
+                  :arguments, :options, :special_behaviors, :aliases
+
+      def initialize(config)
+        @name = config.fetch("name")
+        @source = config.fetch("source")
+        @gem = config.fetch("gem")
+        @output = config.fetch("output", "html")
+        @visibility = config.fetch("visibility", "public")
+        @supports_block = config.fetch("supports_block", false)
+        @supported = config.fetch("supported", false)
+        @description = config.fetch("description", "").strip
+        @signature = config.fetch("signature")
+        @documentation_url = config.fetch("documentation_url")
+
+        tag_config = config.fetch("tag", nil)
+        @tag = tag_config ? HelperTagInfo.new(tag_config) : nil
+
+        content_config = config.fetch("content", nil)
+        @content = content_config ? HelperContent.new(content_config) : nil
+
+        @attributes_arg = config.fetch("attributes_arg", nil)
+        @attributes_arg_with_block = config.fetch("attributes_arg_with_block", nil)
+        @transform_style = config.fetch("transform_style", "generic")
+        @custom_transform = config.fetch("custom_transform", nil)
+
+        @arguments = (config.fetch("arguments", []) || []).map { |arg| HelperArgument.new(arg) }
+        @options = (config.fetch("options", []) || []).map { |opt| HelperOption.new(opt) }
+
+        raw_behaviors = config.fetch("special_behaviors", []) || []
+        @special_behaviors = raw_behaviors.map { |b| HelperSpecialBehavior.new(b) }
+        @aliases = config.fetch("aliases", []) || []
+      end
+
+      def tag_name
+        @tag&.name
+      end
+
+      def void?
+        @tag&.is_void || false
+      end
+
+      def preferred_for_tag
+        @tag&.preferred || false
+      end
+
+      def detect_style
+        @tag&.detect_style
+      end
+
+      def implicit_attribute
+        @tag&.implicit_attribute
+      end
+
+      # "ActionView::Helpers::UrlHelper#link_to" => "UrlHelper"
+      def module_name
+        source.split("#").first.split("::").last
+      end
+
+      # "ActionView::Helpers::UrlHelper#link_to" => "url_helper"
+      def module_key
+        module_name.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
+      end
+
+      # "link_to" => "link_to", "current_page?" => "current_page_p", "uncacheable!" => "uncacheable_bang"
+      def safe_name
+        name.gsub("?", "_p").gsub("!", "_bang")
+      end
+
+      # "link_to" => "LINK_TO", "current_page?" => "CURRENT_PAGE_P", "content_for?" => "CONTENT_FOR_P"
+      def constant_name
+        safe_name.upcase
+      end
+
+      # "link_to" => "LinkTo", "current_page?" => "CurrentPage"
+      def camel_case_name
+        safe_name.split("_").map(&:capitalize).join
+      end
+
+      # "link_to" => "linkTo", "current_page?" => "currentPage"
+      def lower_camel_case_name
+        parts = safe_name.split("_")
+
+        parts.first + parts[1..].map(&:capitalize).join
+      end
+
+      def escaped_description
+        Template.escape_string(@description)
+      end
+
+      def escaped_signature
+        Template.escape_string(@signature)
+      end
+
+      def public?
+        @visibility == "public"
+      end
+
+      def internal?
+        @visibility == "internal"
+      end
+
+      def tag?
+        !@tag.nil?
+      end
+
+      def preferred_for_tag?
+        @tag&.preferred || false
+      end
+
+      def supported?
+        @supported
+      end
+
+      def static_tag_name?
+        !tag_name.nil?
+      end
+
+      def implicit_attribute?
+        !implicit_attribute.nil?
+      end
+
+      def call_name_detect?
+        @tag&.call_name_detect? || false
+      end
+
+      def receiver_call_detect?
+        @tag&.receiver_call_detect? || false
+      end
+
+      def html_output?
+        @output == "html"
+      end
+
+      def text_output?
+        @output == "text"
+      end
+
+      def url_output?
+        @output == "url"
+      end
+
+      def boolean_output?
+        @output == "boolean"
+      end
+
+      def void_output?
+        @output == "void"
+      end
+
+      def content?
+        !@content.nil?
+      end
+
+      def generic_transform?
+        @transform_style == "generic"
+      end
+
+      def custom_transform?
+        @transform_style == "custom"
+      end
+    end
+
     class PrintfMessageTemplate
       MAX_STRING_SIZE = 128
 
@@ -541,7 +872,7 @@ module Herb
                         )
                       end
 
-      rendered_template = read_template(template_path.to_s).result_with_hash({ nodes: nodes, errors: errors, union_kinds: union_kinds })
+      rendered_template = read_template(template_path.to_s).result_with_hash({ nodes: nodes, errors: errors, union_kinds: union_kinds, helpers: helpers })
       content = heading_for(name, template_file) + rendered_template
 
       check_gitignore(name)
@@ -604,6 +935,12 @@ module Herb
       (config.dig("errors", "types") || []).map { |node| ErrorType.new(node) }
     end
 
+    def self.helpers
+      Dir.glob("config/action_view_helpers/**/*.yml").map do |file|
+        HelperType.new(YAML.load_file(file))
+      end
+    end
+
     def self.config
       YAML.load_file("config.yml")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: herb
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.7
 platform: ruby
 authors:
 - Marco Roth
@@ -35,6 +35,7 @@ files:
 - ext/herb/nodes.h
 - herb.gemspec
 - lib/herb.rb
+- lib/herb/action_view/helper_registry.rb
 - lib/herb/ast.rb
 - lib/herb/ast/erb_content_node.rb
 - lib/herb/ast/helpers.rb
@@ -72,6 +73,7 @@ files:
 - lib/herb/visitor.rb
 - lib/herb/warnings.rb
 - sig/herb.rbs
+- sig/herb/action_view/helper_registry.rbs
 - sig/herb/ast.rbs
 - sig/herb/ast/erb_content_node.rbs
 - sig/herb/ast/helpers.rbs
@@ -112,13 +114,14 @@ files:
 - sig/serialized_ast_errors.rbs
 - sig/serialized_ast_nodes.rbs
 - src/analyze/action_view/attribute_extraction_helpers.c
-- src/analyze/action_view/content_tag.c
+- src/analyze/action_view/generated_handlers.c
+- src/analyze/action_view/generated_handlers.h
+- src/analyze/action_view/helper_registry.c
 - src/analyze/action_view/image_tag.c
 - src/analyze/action_view/javascript_include_tag.c
 - src/analyze/action_view/javascript_tag.c
 - src/analyze/action_view/link_to.c
 - src/analyze/action_view/registry.c
-- src/analyze/action_view/tag.c
 - src/analyze/action_view/tag_helper_node_builders.c
 - src/analyze/action_view/tag_helpers.c
 - src/analyze/action_view/turbo_frame_tag.c
@@ -132,9 +135,11 @@ files:
 - src/analyze/invalid_structures.c
 - src/analyze/missing_end.c
 - src/analyze/parse_errors.c
+- src/analyze/postfix_conditionals.c
 - src/analyze/prism_annotate.c
 - src/analyze/render_nodes.c
 - src/analyze/strict_locals.c
+- src/analyze/ternary_conditionals.c
 - src/analyze/transform.c
 - src/ast/ast_node.c
 - src/ast/ast_nodes.c
@@ -144,6 +149,7 @@ files:
 - src/extract.c
 - src/herb.c
 - src/include/analyze/action_view/attribute_extraction_helpers.h
+- src/include/analyze/action_view/helper_registry.h
 - src/include/analyze/action_view/tag_helper_handler.h
 - src/include/analyze/action_view/tag_helper_node_builders.h
 - src/include/analyze/action_view/tag_helpers.h
@@ -155,9 +161,11 @@ files:
 - src/include/analyze/control_type.h
 - src/include/analyze/helpers.h
 - src/include/analyze/invalid_structures.h
+- src/include/analyze/postfix_conditionals.h
 - src/include/analyze/prism_annotate.h
 - src/include/analyze/render_nodes.h
 - src/include/analyze/strict_locals.h
+- src/include/analyze/ternary_conditionals.h
 - src/include/ast/ast_node.h
 - src/include/ast/ast_nodes.h
 - src/include/ast/ast_pretty_print.h
@@ -236,9 +244,11 @@ files:
 - templates/java/nodes.c.erb
 - templates/java/nodes.h.erb
 - templates/java/org/herb/ast/Errors.java.erb
+- templates/java/org/herb/ast/HelperRegistry.java.erb
 - templates/java/org/herb/ast/NodeVisitor.java.erb
 - templates/java/org/herb/ast/Nodes.java.erb
 - templates/java/org/herb/ast/Visitor.java.erb
+- templates/javascript/packages/core/src/action-view-helpers.ts.erb
 - templates/javascript/packages/core/src/errors.ts.erb
 - templates/javascript/packages/core/src/node-type-guards.ts.erb
 - templates/javascript/packages/core/src/nodes.ts.erb
@@ -247,9 +257,11 @@ files:
 - templates/javascript/packages/node/extension/error_helpers.h.erb
 - templates/javascript/packages/node/extension/nodes.cpp.erb
 - templates/javascript/packages/node/extension/nodes.h.erb
+- templates/lib/herb/action_view/helper_registry.rb.erb
 - templates/lib/herb/ast/nodes.rb.erb
 - templates/lib/herb/errors.rb.erb
 - templates/lib/herb/visitor.rb.erb
+- templates/rust/src/action_view_helpers.rs.erb
 - templates/rust/src/ast/nodes.rs.erb
 - templates/rust/src/errors.rs.erb
 - templates/rust/src/nodes.rs.erb
@@ -257,11 +269,15 @@ files:
 - templates/rust/src/visitor.rs.erb
 - templates/sig/serialized_ast_errors.rbs.erb
 - templates/sig/serialized_ast_nodes.rbs.erb
+- templates/src/analyze/action_view/generated_handlers.c.erb
+- templates/src/analyze/action_view/generated_handlers.h.erb
+- templates/src/analyze/action_view/helper_registry.c.erb
 - templates/src/analyze/missing_end.c.erb
 - templates/src/analyze/transform.c.erb
 - templates/src/ast/ast_nodes.c.erb
 - templates/src/ast/ast_pretty_print.c.erb
 - templates/src/errors.c.erb
+- templates/src/include/analyze/action_view/helper_registry.h.erb
 - templates/src/include/ast/ast_nodes.h.erb
 - templates/src/include/ast/ast_pretty_print.h.erb
 - templates/src/include/errors.h.erb

data/src/analyze/action_view/content_tag.c

@@ -1,78 +0,0 @@
-#include "../../include/analyze/action_view/tag_helper_handler.h"
-
-#include <prism.h>
-#include <stdbool.h>
-#include <stdlib.h>
-#include <string.h>
-
-bool detect_content_tag(pm_call_node_t* call_node, pm_parser_t* parser) {
-  if (!call_node || !call_node->name) { return false; }
-
-  pm_constant_t* constant = pm_constant_pool_id_to_constant(&parser->constant_pool, call_node->name);
-  return constant && constant->length == 11 && strncmp((const char*) constant->start, "content_tag", 11) == 0;
-}
-
-char* extract_content_tag_name(pm_call_node_t* call_node, pm_parser_t* parser, hb_allocator_T* allocator) {
-  (void) parser;
-
-  if (!call_node || !call_node->arguments) { return NULL; }
-
-  pm_arguments_node_t* arguments = call_node->arguments;
-  if (!arguments->arguments.size) { return NULL; }
-
-  pm_node_t* first_argument = arguments->arguments.nodes[0];
-
-  if (first_argument->type == PM_STRING_NODE) {
-    pm_string_node_t* string_node = (pm_string_node_t*) first_argument;
-    size_t length = pm_string_length(&string_node->unescaped);
-    return hb_allocator_strndup(allocator, (const char*) pm_string_source(&string_node->unescaped), length);
-  } else if (first_argument->type == PM_SYMBOL_NODE) {
-    pm_symbol_node_t* symbol_node = (pm_symbol_node_t*) first_argument;
-    size_t length = pm_string_length(&symbol_node->unescaped);
-    return hb_allocator_strndup(allocator, (const char*) pm_string_source(&symbol_node->unescaped), length);
-  }
-
-  return NULL;
-}
-
-char* extract_content_tag_content(pm_call_node_t* call_node, pm_parser_t* parser, hb_allocator_T* allocator) {
-  (void) parser;
-
-  if (!call_node) { return NULL; }
-
-  char* block_content = extract_inline_block_content(call_node, allocator);
-  if (block_content) { return block_content; }
-
-  if (call_node->arguments) {
-    pm_arguments_node_t* arguments = call_node->arguments;
-
-    if (arguments->arguments.size >= 2) {
-      pm_node_t* second_argument = arguments->arguments.nodes[1];
-
-      if (second_argument->type != PM_KEYWORD_HASH_NODE) {
-        if (second_argument->type == PM_STRING_NODE) {
-          pm_string_node_t* string_node = (pm_string_node_t*) second_argument;
-          size_t length = pm_string_length(&string_node->unescaped);
-          return hb_allocator_strndup(allocator, (const char*) pm_string_source(&string_node->unescaped), length);
-        }
-
-        size_t source_length = second_argument->location.end - second_argument->location.start;
-        return hb_allocator_strndup(allocator, (const char*) second_argument->location.start, source_length);
-      }
-    }
-  }
-
-  return NULL;
-}
-
-bool content_tag_supports_block(void) {
-  return true;
-}
-
-const tag_helper_handler_T content_tag_handler = { .name = "content_tag",
-                                                   .source =
-                                                     HB_STRING_LITERAL("ActionView::Helpers::TagHelper#content_tag"),
-                                                   .detect = detect_content_tag,
-                                                   .extract_tag_name = extract_content_tag_name,
-                                                   .extract_content = extract_content_tag_content,
-                                                   .supports_block = content_tag_supports_block };

data/src/analyze/action_view/tag.c

@@ -1,87 +0,0 @@
-#include "../../include/analyze/action_view/tag_helper_handler.h"
-#include "../../include/util/ruby_util.h"
-
-#include <prism.h>
-#include <stdbool.h>
-#include <stdlib.h>
-#include <string.h>
-
-bool detect_tag_dot(pm_call_node_t* call_node, pm_parser_t* parser) {
-  if (!call_node || !call_node->receiver) { return false; }
-  if (call_node->receiver->type != PM_CALL_NODE) { return false; }
-
-  pm_call_node_t* receiver_node = (pm_call_node_t*) call_node->receiver;
-  if (!receiver_node->name) { return false; }
-
-  pm_constant_t* constant = pm_constant_pool_id_to_constant(&parser->constant_pool, receiver_node->name);
-
-  return constant && constant->length == 3 && strncmp((const char*) constant->start, "tag", 3) == 0;
-}
-
-char* extract_tag_dot_name(pm_call_node_t* call_node, pm_parser_t* parser, hb_allocator_T* allocator) {
-  if (!call_node || !call_node->name) { return NULL; }
-
-  pm_constant_t* constant = pm_constant_pool_id_to_constant(&parser->constant_pool, call_node->name);
-  if (!constant) { return NULL; }
-
-  if (is_ruby_introspection_method(hb_string_from_data((const char*) constant->start, constant->length))) {
-    return NULL;
-  }
-
-  char* name = hb_allocator_strndup(allocator, (const char*) constant->start, constant->length);
-
-  for (size_t i = 0; i < constant->length && name[i] != '\0'; i++) {
-    if (name[i] == '_') { name[i] = '-'; }
-  }
-
-  return name;
-}
-
-// TODO: this should probably be an array of nodes
-char* extract_tag_dot_content(pm_call_node_t* call_node, pm_parser_t* parser, hb_allocator_T* allocator) {
-  if (!call_node) { return NULL; }
-
-  if (call_node->name) {
-    pm_constant_t* constant = pm_constant_pool_id_to_constant(&parser->constant_pool, call_node->name);
-
-    if (constant
-        && is_ruby_introspection_method(hb_string_from_data((const char*) constant->start, constant->length))) {
-      return NULL;
-    }
-  }
-
-  char* block_content = extract_inline_block_content(call_node, allocator);
-  if (block_content) { return block_content; }
-
-  if (call_node->arguments) {
-    pm_arguments_node_t* arguments = call_node->arguments;
-
-    if (arguments->arguments.size) {
-      pm_node_t* first_argument = arguments->arguments.nodes[0];
-
-      if (first_argument->type == PM_KEYWORD_HASH_NODE) { return NULL; }
-
-      if (first_argument->type == PM_STRING_NODE) {
-        pm_string_node_t* string_node = (pm_string_node_t*) first_argument;
-        size_t length = pm_string_length(&string_node->unescaped);
-        return hb_allocator_strndup(allocator, (const char*) pm_string_source(&string_node->unescaped), length);
-      }
-
-      size_t source_length = first_argument->location.end - first_argument->location.start;
-      return hb_allocator_strndup(allocator, (const char*) first_argument->location.start, source_length);
-    }
-  }
-
-  return NULL;
-}
-
-bool tag_dot_supports_block(void) {
-  return true;
-}
-
-const tag_helper_handler_T tag_dot_handler = { .name = "tag",
-                                               .source = HB_STRING_LITERAL("ActionView::Helpers::TagHelper#tag"),
-                                               .detect = detect_tag_dot,
-                                               .extract_tag_name = extract_tag_dot_name,
-                                               .extract_content = extract_tag_dot_content,
-                                               .supports_block = tag_dot_supports_block };