Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove duplicate code that generates s-forms from s-pipes scrips and document it #33

Open
2 tasks
blcham opened this issue Aug 22, 2023 · 1 comment
Open
2 tasks

Comments

@blcham
Copy link
Contributor

blcham commented Aug 22, 2023

When implementing #26 we found out duplicated code alternative implementation of cz.cvut.spipes.transform.Transformer.

A/C:

  • we should document how spipes2s-forms Transformer.script2form transformation works (just include/modify diagram Figure 26: Module configuration form generation in 2018-Doroshenko-Yan-thesis.pdf into the s-pipes/s-forms-modulepipes-forms folder)
  • There should not be a duplicate implementation of transformation (the other one is in s-pipes-editor) -- it should be removed either from s-pipes or from s-pipes-editor
  • Revise differences in Transformer implementations.

Tasks

Preview Give feedback
@kostobog
Copy link
Contributor

kostobog commented Aug 30, 2023

Overview of relevant changes between new and old implementations

  1. (old implementation) cz.cvut.spipes.transform.TransformerImpl in s-pipes-forms module in cvut-kbss/s-pipes
  2. (new implementation) og_spipes.service.FormService.OwnTransformer in cvut-kbss/s-pipes-editor

Overview of Functional Changes

  • form2Script - contains functional changes

    • + Documentation comment on method
    • + Log message
    • + add parenthesis in lambda
    • * changes in implementation - ~34 lines, + ~40 lines
  • functionToForm - contains functional changes

    • * changes in implementation - 4 lines +6 lines
  • + handleFormUpdate added in new implementation

    • 2 usages in form2script (total usages 2)
  • isSupportedAnon - no functional changes, not used in new implementation

Overview of Non Functional Changes

  • + Log messages
  • + using inline package for s-pipes-forms Vocabulary class
  • + commented new code
  • * formatting
  • + Documentation comment on method
  • + add parenthesis in lambda

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants