ivysochyn/textiv

textiv's Issues

GUI

Description:

As a user, I can use the application via the user interface .

Acceptance criteria:

To be negotiated later with the Product Owner

String inversion

Description:

As a user, I can invert a string with case-sensitive characters at specific positions (inverse).

Acceptance criteria:

• Preservation of uppercase and lowercase positions: MirEk -> KerIm.
• String inversion
• Support for all characters UTF-8

Parallel tasks:

1. Writing function documentation (javadoc)
2. Creating unit tests

Number to words

Description:

As a user I can convert numbers into text in English.

Acceptance criteria:

• conversion of integers up to 1000
• conversion of floating point numbers to hundredths

Example:

Deposit 100 zloty -> deposit one hundred zloty

Parallel tasks:

1. Writing function documentation (javadoc)
2. Creating unit tests

Add javadoc generation

Add javadoc compilation to pom.xml file and update CI with new artifact containing generated docs.

Code analyzability (execution logging)

Description:

The program uses the SL4J library to log execution at the DEBUG and INFO level

Continuous integration

Description:

A continuous integration environment has been configured and the lead has access to it (CI server responds to changes in the code repository and starts the build process)

Create initial UML diagram

Description

The task is to create an initial UML diagram describing relations of transformers with controller.

Expanding/collapsing abbreviations

Description:

Jako użytkownik mogę rozwinąć wybrane skróty do pełnych znaków i odwrotnie mogę zamienić wybrane (zdefiniowane wcześniej) słowa na skróty.

Acceptance criteria:

1. Expanding

• for example -> e.g.
• doctor -> dr.
• et cetera -> etc.
• Works size-independent.

2.Collapsing

• prof -> professor
• dr. -> doctor
• i.e. -> id est
• etc. -> et cetera
• math. -> mathematics
• It preserves the case of letters

Parallel tasks:

1. Writing function documentation (javadoc)
2. Creating unit tests

Add mapping for handling POST requests containing JSON

Duplicate elimination

Description:

As a user I can eliminate repeated words in the immediate vicinity.

Acceptance criteria:

• Convert two repeated words into one: do do -> do.
• Conversion of any number of repeated words: do do do-> do.
• Converting all repetitions within a text: do do po po -> do po.
• Works correctly for all characters UTF-8

Parallel tasks:

1. Writing function documentation (javadoc)
2. Creating unit tests

UML diagram update

Description

Updating UML diagrams, due to significant changes in the program

Implement decorator design pattern

Description:

The implementation used the suggested design pattern in the proposed scope: TextTransformer - Decorator used to dynamically create the transform object.

Update the readme

Update the Readme.md with instructions on how to build, run and use the product. The images are welcome.

REST API

Description:

As an application developer, I can call the transformation remotely via REST so that I can integrate the tool into my other applications

Acceptance criteria:

• Input in the form of text and a transformation sequence (name)
• Input and output in JSON format
• The REST API allows you to run any currently implemented transformation and transformation sequence

Retrospective

Description:

• Corrective actions from the retrospective of the previous sprint were written down
• The implementation of the corrective actions was monitored (e.g. tasks appeared in the sprint backlog)

Add initial project architecture

Description

Take the initial project architecture from ekursy and place it in the git repository

Refactor code to add text transformer interface

Description

Add java interface to our program to match the design pattern .

Fix typos

Description:

As a user I can detect and fix spelling errors in text .

Acceptance criteria:

1. Correction of spelling errors :

• acceept -> accept.
• thier -> their
• untill -> until
• diffrent -> different

Parallel tasks:

1. Writing function documentation (javadoc)
2. Creating unit tests

Configured Github Issues

Description:

An environment has been configured to manage the product registry and the sprint registry:

Product registry:

• The product registry was entered into the management tool.
• Prioritised the product registry.

Sprint registry:

• Transferred product registry elements to be completed in the sprint to the sprint registry.
• Tasks were added to the individual product elements to be realised in the sprint

Add format checker to the compilation and CI flow

The task is to add a code style format checker to the code building flow.

Case change

Description:

As a user I can change the case of letters - set of three transformations (upper, lower, capitalize)

Acceptance criteria

1. Changing the case of letters - set of three transformations (upper, lower, capitalize)

• upper - all letters capitalized: upper -> UPPER .
• lower - all letters to lower case: lower -> lower.
• capitalize - first letter in each word to uppercase: capitalize text -> Capitalize Text.

2. Support for letters from the English alphabet (UTF-8)

Parallel tasks:

1. Writing function documentation (javadoc)
2. Creating unit tests

Application builds

The application builds itself automatically (compilation, creation of a package for distribution - e.g. jar).

Increment and pom.xml file

Description:

The code specifying the product increment is tagged in the repository (tag = version number) and the corresponding version in pom.xml

Add tests

Add some missing unit tests to the function :

• EscapeCharactersTextTransformer

• InversionTextTransformer

Add moke tests to the function:

• CreateTextTransformer

Escape characters into LaTex form.

Description:

As a user, I can convert text to a Latex-supported format (special characters).

Acceptance criteria:

• & -> \&
• $ -> \$

Example:

John Smith & Sons -> John Smith \& Sons.

Parallel tasks:

1. Writing function documentation (javadoc)
2. Creating unit tests

Fix num2word transformer

The transformer returns the output instead of passing it to further transformers.