[layout] Move layout logic to ruby plugin #2226

captn3m0 · 2022-12-31T17:08:41Z

We enrich the data available to liquid, and avoid complex logic in Liquid this way.

Still WIP, will make columns a bit more modular, with our sane defaults. Will avoid any mass changes to product front-matter in this PR, and retain compatibility for now. We can take those up in a later PR, since that would include schema changes and require more discussion.

Intent is to use the plugin for any complex logic:

Deciding colors of columns
Column ordering
Default values of columns
Template rendering for some columns
Parse out the product description

Output of the above (such as rendered templates, description) should be available to the API directly as well.

We enrich the data available to liquid, and avoid complex logic in Liquid this way.

captn3m0 · 2022-12-31T17:10:50Z

_layouts/product.html

+    field='eol'
+    enabled=page.eolColumn
+    r=r
+  %}

  {% if page.releaseColumn != false %}
  <td {% if diff <= 0 %} class = "txt-linethrough" {% endif %} >      <!-- if the support finished add txt-linethrough class -->


This is currently broken, since diff is unavailable now.

marcwrobel

Looks promising !

_config.yml

marcwrobel · 2023-01-01T10:50:39Z

_config.yml

+      columns:
+        # The spaces before Yes/No
+        # are intentional to avoid the
+        # YAML norway problem


A link to https://www.bram.us/2022/01/11/yaml-the-norway-problem/ could be useful for those who don't know what is the "norway problem" ;)

marcwrobel · 2023-01-01T10:55:41Z

Do you need help on this one @captn3m0 ?

captn3m0 · 2023-01-02T09:37:45Z

I'd like feedback on the schema for the column layouts. For this PR focusing on keeping compatibility, but what will work better for all usecases (including tables in article text)?

Setting default values via _config.yml was helpful, but I'm not happy with the code complexity - it should be simpler to write this in Ruby, not harder.

marcwrobel · 2023-01-02T10:47:15Z

I'd like feedback on the schema for the column layouts. For this PR focusing on keeping compatibility, but what will work better for all usecases (including tables in article text)?

What do you mean by "the schema for the column layouts" ?

Setting default values via _config.yml was helpful, but I'm not happy with the code complexity - it should be simpler to write this in Ruby, not harder.

Unfortunately sometimes complexity cannot be avoided. During my work on #2229 I also took a look at the product template. Here are the things I think that make it more complex :

The "Ends / Ended" prefix in the support / eol column. Because of this there is two calculus to be done : one for the color and the other for the text. This means in the template there are a lot of if / else logic. Because this information is already given to the user by the column title and the color, I have chosen to get rid of it in table.html for the time being (860fb14).
The difference between support and eol when only boolean are used. For support color must be red if the value is false, for eol this is the inverse: it must be green if eol is false (this is the same for discontinued). It would be easier to make something more generic if support was endOfActiveSupport.
The small rendering differences for the Latest column (if the cycle reached EOL the link is not added and the text is striked).

Taken separately those a small things, but it makes it harder to make things more generic (for instance by using table.html to generate the main table).

With this approach, enriched data is only computed once and available both in layouts and in plugins (such as the APIv1 plugin - see #2080). This make things easier in both places. validate.py now checks if releaseLabel is a string. This PR relates to (and conflicts with) #2226.

marcwrobel · 2023-01-04T11:42:14Z

_plugins/eol.rb

+              r['text'][x] = defaults['on-false']['text']
+            elsif r[x].is_a? Date
+              diff = (r[x]-today).to_i
+              # If EOL is after 6 months


Current is ~4 months (I used 120 days in #2229).

marcwrobel · 2023-01-04T11:45:54Z

_plugins/eol.rb

+        page['releases'].each do |r|
+          r['text'] = {}
+          r['colors'] = {}
+          ['eol', 'support'].each do |x|


I am not fan of computing colors in the plugin: colors must also be computed for values other than eol and support such as discontinued or custom columns.

IMHO it will be more reusable if it's implemented in a filter such as in #2229.

With this approach, enriched data is only computed once and available both in layouts and in plugins (such as the APIv1 plugin - see #2080). This make things easier in both places. validate.py now checks if releaseLabel is a string. This PR relates to (and conflicts with) #2226.

marcwrobel · 2023-04-30T18:47:03Z

@captn3m0 should we keep this PR open ?

marcwrobel · 2023-07-02T18:15:17Z

@captn3m0 should we keep this PR open ?

marcwrobel · 2023-07-22T11:45:42Z

Closing the PR, as it doesn't seem likely it will be revived. @captn3m0 feel free to drop the branch if there is nothing useful in it.

[layout] Move layout logic to ruby plugin

2a0f123

We enrich the data available to liquid, and avoid complex logic in Liquid this way.

captn3m0 added the enhancement New feature or request label Dec 31, 2022

captn3m0 self-assigned this Dec 31, 2022

captn3m0 commented Dec 31, 2022

View reviewed changes

captn3m0 mentioned this pull request Dec 31, 2022

Endoflife api/v1 #2080

Open

marcwrobel reviewed Jan 1, 2023

View reviewed changes

marcwrobel mentioned this pull request Jan 1, 2023

Support tags in endoflife.date #2225

Closed

4 tasks

marcwrobel added a commit that referenced this pull request Jan 3, 2023

Add hook for enriching products data (as seen on #2226)

59adcf4

marcwrobel mentioned this pull request Jan 3, 2023

Add ProductDataEnricher plugin to enrich product pages metadata #2239

Merged

marcwrobel reviewed Jan 4, 2023

View reviewed changes

marcwrobel closed this Jul 22, 2023

marcwrobel deleted the layout-cleanup branch December 9, 2024 23:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[layout] Move layout logic to ruby plugin #2226

[layout] Move layout logic to ruby plugin #2226

captn3m0 commented Dec 31, 2022 •

edited

Loading

captn3m0 Dec 31, 2022

marcwrobel left a comment

marcwrobel Jan 1, 2023

marcwrobel commented Jan 1, 2023

captn3m0 commented Jan 2, 2023

marcwrobel commented Jan 2, 2023

marcwrobel Jan 4, 2023

marcwrobel Jan 4, 2023

marcwrobel commented Apr 30, 2023

marcwrobel commented Jul 2, 2023

marcwrobel commented Jul 22, 2023

[layout] Move layout logic to ruby plugin #2226

[layout] Move layout logic to ruby plugin #2226

Conversation

captn3m0 commented Dec 31, 2022 • edited Loading

captn3m0 Dec 31, 2022

Choose a reason for hiding this comment

marcwrobel left a comment

Choose a reason for hiding this comment

marcwrobel Jan 1, 2023

Choose a reason for hiding this comment

marcwrobel commented Jan 1, 2023

captn3m0 commented Jan 2, 2023

marcwrobel commented Jan 2, 2023

marcwrobel Jan 4, 2023

Choose a reason for hiding this comment

marcwrobel Jan 4, 2023

Choose a reason for hiding this comment

marcwrobel commented Apr 30, 2023

marcwrobel commented Jul 2, 2023

marcwrobel commented Jul 22, 2023

captn3m0 commented Dec 31, 2022 •

edited

Loading