tag_attrs could be kinder about mis-formed attributes

[BrucePerens]

Sometimes when I write Lucky pages, my head is in HTML space. If I write a mis-formed attribute like:

  para id="main-content"

I end up seeing a lot of macro cybercrud rather than a concise and helpful report. I think the code in

lucky/src/lucky/tags/base_tags.cr

Line 252 in 4cb2108

private def build_tag_attrs(options)

could be modified to complain if it is processing something other than a tuple.

[jwoertink]

That's interesting because in crystal, an assignment returns the value of the value... so I'm surprised that doesn't return para (id = "main-content").... 🤔

But you area right, if we can make the error better, we need to.

[BrucePerens]

Well, this is what it emits:

crystal build --threads 40 --progress --error-trace src/mysite.cr
In src/mysite.cr:1:1                   

 1 | require "./start_server"
     ^
Error: while requiring "./start_server"


In src/start_server.cr:16:12

 16 | app_server.listen
                 ^-----
Error: instantiating 'AppServer#listen()'


In src/app_server.cr:30:12

 30 | server.listen
             ^-----
Error: instantiating 'HTTP::Server#listen()'


In /usr/share/crystal/src/http/server.cr:457:9

 457 | loop do
       ^---
Error: instantiating 'loop()'


In /usr/share/crystal/src/http/server.cr:457:9

 457 | loop do
       ^---
Error: instantiating 'loop()'


In /usr/share/crystal/src/http/server.cr:468:13

 468 | spawn handle_client(_io)
       ^
Error: expanding macro


There was a problem expanding macro 'spawn'

Called macro defined in /usr/share/crystal/src/concurrent.cr:99:1

 99 | macro spawn(call, *, name = nil, same_thread = false, &block)

Which expanded to:

 >  1 |   
 >  2 | 
 >  3 |   
 >  4 |     ->(
 >  5 |       
 >  6 |         __arg0 : typeof(_io),
 >  7 |       
 >  8 |       
 >  9 |       ) {
 > 10 |       spawn(name: nil, same_thread: false) do
 > 11 |         handle_client(
 > 12 |           
 > 13 |             __arg0,
 > 14 |           
 > 15 |           
 > 16 |         )
 > 17 |       end
 > 18 |       }.call(
 > 19 |         
 > 20 |           _io,
 > 21 |         
 > 22 |         
 > 23 |       )
 > 24 |   
Error: instantiating 'handle_client(IO+)'


In /usr/share/crystal/src/http/server.cr:515:16

 515 | @processor.process(io, io)
                  ^------
Error: instantiating 'HTTP::Server::RequestProcessor#process(IO+, IO+)'


In /usr/share/crystal/src/http/server/request_processor.cr:50:13

 50 | Log.with_context do
          ^-----------
Error: instantiating 'Log#with_context()'


In /usr/share/crystal/src/log/main.cr:119:16

 119 | self.class.with_context(**kwargs) do
                  ^-----------
Error: instantiating 'Log.class#with_context(NamedTuple())'


In /usr/share/crystal/src/log/main.cr:119:16

 119 | self.class.with_context(**kwargs) do
                  ^-----------
Error: instantiating 'Log.class#with_context(NamedTuple())'


In /usr/share/crystal/src/http/server/request_processor.cr:50:13

 50 | Log.with_context do
          ^-----------
Error: instantiating 'Log#with_context()'


In /usr/share/crystal/src/http/server/request_processor.cr:51:20

 51 | @handler.call(context)
               ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In src/handlers/unslash_path_handler.cr:8:7

 8 | call_next(context)
     ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handlers/compress_handler.cr:12:5

 12 | {% if flag?(:without_zlib) %}
      ^
Error: expanding macro


There was a problem expanding macro 'macro_139955531821728'

Called macro defined in /usr/share/crystal/src/http/server/handlers/compress_handler.cr:12:5

 12 | {% if flag?(:without_zlib) %}

Which expanded to:

 > 1 | 
 > 2 |       context.response.output = CompressIO.new(context.response.output, context)
 > 3 |       call_next(context)
 > 4 |     
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handlers/error_handler.cr:17:7

 17 | call_next(context)
      ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handlers/log_handler.cr:15:7

 15 | call_next(context)
      ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In lib/lucky/src/charms/static_file_handler.cr:5:5

 5 | super(context)
     ^----
Error: instantiating 'super(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handlers/static_file_handler.cr:34:9

 34 | call_next(context)
      ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handlers/static_file_handler.cr:34:9

 34 | call_next(context)
      ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handlers/websocket_handler.cr:25:14

 25 | return call_next context
             ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In lib/lucky/src/lucky/error_handler.cr:14:5

 14 | call_next(context)
      ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In lib/lucky/src/lucky/force_ssl_handler.cr:37:7

 37 | call_next(context)
      ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In lib/lucky/src/lucky/http_method_override_handler.cr:11:5

 11 | call_next(context)
      ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In lib/lucky/src/lucky/log_handler.cr:29:7

 29 | call_next(context)
      ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In lib/lucky/src/lucky/remote_ip_handler.cr:15:5

 15 | call_next(context)
      ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In lib/lucky/src/lucky/request_id_handler.cr:24:5

 24 | call_next(context)
      ^--------
Error: instantiating 'call_next(HTTP::Server::Context)'


In /usr/share/crystal/src/http/server/handler.cr:28:20

 28 | next_handler.call(context)
                   ^---
Error: instantiating '(HTTP::Handler | Proc(HTTP::Server::Context, Nil))#call(HTTP::Server::Context)'


In lib/lucky/src/lucky/route_handler.cr:10:52

 10 | handler.payload.new(context, handler.params).perform_action
                                                   ^-------------
Error: instantiating 'Lucky::Action+#perform_action()'


In lib/lucky/src/lucky/renderable.cr:136:16

 136 | response = call
                  ^---
Error: instantiating 'call()'


In src/actions/hierarchy/view.cr:123:3

 123 | present_404(request.path)
      ^----------
Error: instantiating 'present_404(String)'


In src/actions/present/404.cr:5:7

 5 | html ::Page::Present::JumpBack, from: get_from(context) || "/#{ctx.language_tag}", static: false
     ^
Error: expanding macro


There was a problem expanding macro 'html'

Called macro defined in lib/lucky/src/lucky/renderable.cr:46:3

 46 | macro html(page_class = nil, _with_status_code = 200, **assigns)

Which expanded to:

 >  1 |     
 >  2 |     validate_page_class!(::Page::Present::JumpBack)
 >  3 | 
 >  4 |     # Found in Action::Hierarchy::View
 >  5 |     view = ::Page::Present::JumpBack.new(
 >  6 |       context: context,
 >  7 |       
 >  8 |         from: (get_from(context)) || "/#{ctx.language_tag}",
 >  9 |       
 > 10 |         static: false,
 > 11 |       
 > 12 |       
 > 13 |         ctx: ctx,
 > 14 |       
 > 15 |     )
 > 16 |     Lucky::TextResponse.new(
 > 17 |       context,
 > 18 |       "text/html",
 > 19 |       view.perform_render,
 > 20 |       status: 200,
 > 21 |       debug_message: log_message(view),
 > 22 |       enable_cookies: enable_cookies?
 > 23 |     )
 > 24 |   
Error: instantiating 'Page::Present::JumpBack#perform_render()'


In lib/lucky/src/lucky/html_builder.cr:27:5

 27 | render
      ^-----
Error: instantiating 'render()'


In src/pages/mysite_bare_layout.cr:14:5

 14 | body do
      ^---
Error: instantiating 'body()'


In src/pages/mysite_bare_layout.cr:14:5

 14 | body do
      ^---
Error: instantiating 'body()'


In src/pages/mysite_bare_layout.cr:15:7

 15 | content
      ^------
Error: instantiating 'content()'


In src/pages/present/jump_back.cr:11:5

 11 | para id= "main-content" do
      ^---
Error: instantiating 'para(String)'


There was a problem expanding macro 'macro_139956070943360'

Called macro defined in lib/lucky/src/lucky/tags/base_tags.cr:203:3

 203 | {% for name, tag in RENAMED_TAGS %}

Which expanded to:

 > 1 | 
 > 2 |     generate_tag_methods(method_name: para, tag: "p")
 > 3 |   
 > 4 |     generate_tag_methods(method_name: select_tag, tag: "select")
 > 5 |   
Error: expanding macro


There was a problem expanding macro 'generate_tag_methods'

Called macro defined in lib/lucky/src/lucky/tags/base_tags.cr:106:3

 106 | macro generate_tag_methods(method_name, tag)

Which expanded to:

 >  1 |     # Generates a `<para></para>` tag.
 >  2 |     #
 >  3 |     # * The *content* argument is either a `String`, or any type that has included `Lucky::AllowedInTags`. This is the content that goes inside of the tag.
 >  4 |     # * The *options* argument is a `Hash(String, String)` of any HTML attribute that has a key/value like `class`, `id`, `type`, etc...
 >  5 |     # * The *attrs* argument is an `Array(Symbol)` for specifying [Boolean Attributes](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#boolean-attributes) such as `required`, `disabled`, `autofocus`, etc...
 >  6 |     #
 >  7 |     # ```
 >  8 |     # para("Sample", {"class" => "cls-1 red"}, [:required]) #=> <para class="cls-1 red" required>Sample</para>
 >  9 |     # ```
 > 10 |     def para(
 > 11 |         content : Lucky::AllowedInTags | String = "",
 > 12 |         options = EMPTY_HTML_ATTRS,
 > 13 |         attrs : Array(Symbol) = [] of Symbol,
 > 14 |         **other_options
 > 15 |       ) : Nil
 > 16 |       boolean_attrs = build_boolean_attrs(attrs)
 > 17 |       merged_options = merge_options(other_options, options)
 > 18 |       tag_attrs = build_tag_attrs(merged_options)
 > 19 |       view << "<p" << tag_attrs << boolean_attrs << ">" << HTML.escape(content.to_s) << "</p>"
 > 20 |     end
 > 21 | 
 > 22 |     def para(content : Lucky::AllowedInTags | String) : Nil
 > 23 |       view << "<p>" << HTML.escape(content.to_s) << "</p>"
 > 24 |     end
 > 25 | 
 > 26 |     def para(
 > 27 |         content : Nil,
 > 28 |         options = EMPTY_HTML_ATTRS,
 > 29 |         attrs : Array(Symbol) = [] of Symbol,
 > 30 |         **other_options
 > 31 |       ) : Nil
 > 32 |       {%
 > 33 |         raise <<-ERROR
 > 34 |           HTML tags content must be a String or Lucky::AllowedInTags object, not nil.
 > 35 | 
 > 36 |           Try this...
 > 37 | 
 > 38 |             if value = some_nilable_value
 > 39 |               para(value, class: "header")
 > 40 |             end
 > 41 | 
 > 42 |           ERROR
 > 43 |           %}
 > 44 |     end
 > 45 | 
 > 46 |     def para(
 > 47 |         content : Time,
 > 48 |         options = EMPTY_HTML_ATTRS,
 > 49 |         attrs : Array(Symbol) = [] of Symbol,
 > 50 |         **other_options
 > 51 |       ) : Nil
 > 52 |       {%
 > 53 |         raise <<-ERROR
 > 54 |           HTML tags content must be a String or Lucky::AllowedInTags object.
 > 55 |           para received a Time object which has an ambiguous display format.
 > 56 | 
 > 57 |           Try this...
 > 58 | 
 > 59 |             para(current_time.to_s("%F"), html_opts)
 > 60 | 
 > 61 |           ERROR
 > 62 |           %}
 > 63 |     end
 > 64 | 
 > 65 |     def para(options, **other_options) : Nil
 > 66 |       para("", options, **other_options)
 > 67 |     end
 > 68 | 
 > 69 |     def para(options = EMPTY_HTML_ATTRS, **other_options, &block) : Nil
 > 70 |       merged_options = merge_options(other_options, options)
 > 71 |       tag_attrs = build_tag_attrs(merged_options)
 > 72 |       view << "<p" << tag_attrs << ">"
 > 73 |       check_tag_content!(yield)
 > 74 |       view << "</p>"
 > 75 |     end
 > 76 | 
 > 77 |     def para(attrs : Array(Symbol), options = EMPTY_HTML_ATTRS, **other_options, &block) : Nil
 > 78 |       boolean_attrs = build_boolean_attrs(attrs)
 > 79 |       merged_options = merge_options(other_options, options)
 > 80 |       tag_attrs = build_tag_attrs(merged_options)
 > 81 |       view << "<p" << tag_attrs << boolean_attrs << ">"
 > 82 |       check_tag_content!(yield)
 > 83 |       view << "</p>"
 > 84 |     end
 > 85 | 
 > 86 |     def para(&block) : Nil
 > 87 |       view << "<p>"
 > 88 |       check_tag_content!(yield)
 > 89 |       view << "</p>"
 > 90 |     end
 > 91 |   
Error: instantiating 'merge_options(NamedTuple(), String)'


In lib/lucky/src/lucky/tags/base_tags.cr:276:15

 276 | tag_attrs.each do |key, value|
                 ^---
Error: undefined method 'each' for String

String trace:

  lib/lucky/src/lucky/tags/base_tags.cr:276

        tag_attrs.each do |key, value|


  lib/lucky/src/lucky/tags/base_tags.cr:274

      private def merge_options(html_options, tag_attrs)

make: *** [Makefile:54: build] Error 1