https://github.com/let-robots-reign/go_hw1

https://github.com/let-robots-reign/go_hw1

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/let-robots-reign/go_hw1
• Owner: let-robots-reign
• Created: 2021-02-22T16:33:43.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-10T22:50:15.000Z (over 4 years ago)
• Last Synced: 2025-01-13T08:12:35.648Z (10 months ago)
• Size: 31.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Домашнее задание 1

## Дисклеймер

Это задание состоит из 2х частей, которые нужно сдавать вместе.

Отдельно первая часть, как и отдельно вторая часть, не оценивается

как половина задания.

Задачи включают в себя как написание функциональности, так и её

тестирование.

Все домашние задания должны выполняться в приватных репозиториях.

## Часть 1. Uniq

Нужно реализовать утилиту для поиска уникальных строк. Сама

утилита имеет набор параметров, которые необходимо поддержать.

### Параметры

`-с` - подсчитать количество встречаний строки во входных данных.

Вывести это число перед строкой отделив пробелом.

`-d` - вывести только те строки, которые повторились во входных данных.

`-u` - вывести только те строки, которые не повторились во входных данных.

`-f num_fields` - не учитывать первые `num_fields` полей в строке.

Полем в строке является непустой набор символов отделённый пробелом.

`-s num_chars` - не учитывать первые `num_chars` символов в строке.

При использовании вместе с параметром `-f` учитываются первые символы

после `num_fields` полей (не учитывая пробел-разделитель после

последнего поля).

`-i` - не учитывать регистр букв.

### Использование

`uniq [-c | -d | -u] [-i] [-f num] [-s chars] [input_file [output_file]]`

1. Все параметры опциональны. Поведения утилиты без параметров --

   простой вывод уникальных строк из входных данных.

2. Параметры c, d, u взаимозаменяемы. Необходимо учитывать,

   что параллельно эти параметры не имеют никакого смысла. При

   передаче одного вместе с другим нужно отобразить пользователю

   правильное использование утилиты

3. Если не передан input_file, то входным потоком считать stdin

4. Если не передан output_file, то выходным потоком считать stdout

### Пример работы

    Без параметров

```bash

$cat input.txt

I love music.

I love music.

I love music.

I love music of Kartik.

I love music of Kartik.

Thanks.

$cat input.txt | go run uniq.go

I love music.

I love music of Kartik.

Thanks.

```

    С параметром input_file

```bash

$cat input.txt

I love music.

I love music.

I love music.

I love music of Kartik.

I love music of Kartik.

Thanks.

$go run uniq.go input.txt

I love music.

I love music of Kartik.

Thanks.

```

    С параметрами input_file и output_file

```bash

$cat input.txt

I love music.

I love music.

I love music.

I love music of Kartik.

I love music of Kartik.

Thanks.

$go run uniq.go input.txt output.txt

$cat output.txt

I love music.

I love music of Kartik.

Thanks.

```

    С параметром -c

```bash

$cat input.txt

I love music.

I love music.

I love music.

I love music of Kartik.

I love music of Kartik.

Thanks.

$cat input.txt | go run uniq.go -c

3 I love music.

1 

2 I love music of Kartik.

1 Thanks.

```

    С параметром -d

```bash

$cat input.txt

I love music.

I love music.

I love music.

I love music of Kartik.

I love music of Kartik.

Thanks.

$cat input.txt | go run uniq.go -d

I love music.

I love music of Kartik.

```

    С параметром -u

```bash

$cat input.txt

I love music.

I love music.

I love music.

I love music of Kartik.

I love music of Kartik.

Thanks.

$cat input.txt | go run uniq.go -d

Thanks.

```

    С параметром -i

```bash

$cat input.txt

I LOVE MUSIC.

I love music.

I LoVe MuSiC.

I love MuSIC of Kartik.

I love music of kartik.

Thanks.

$cat input.txt | go run uniq.go -i

I LOVE MUSIC.

I love MuSIC of Kartik.

Thanks.

```

    С параметром -f num

```bash

$cat input.txt

We love music.

I love music.

They love music.

I love music of Kartik.

We love music of Kartik.

Thanks.

$cat input.txt | go run uniq.go -f 1

We love music.

I love music of Kartik.

Thanks.

```

    С параметром -s num

```bash

$cat input.txt

I love music.

A love music.

C love music.

I love music of Kartik.

We love music of Kartik.

Thanks.

$cat input.txt | go run uniq.go -s 1

I love music.

I love music of Kartik.

We love music of Kartik.

Thanks.

```

### Тестирование

Нужно протестировать поведение написанной функциональности

с различными параметрами. Для тестирования нужно написать unit-тесты

на эту функциональность. Тесты нужны как для успешных случаев,

так и для неуспешных. Примеры с тестами мы будем показывать ещё на

следующих лекциях, но сейчас можно посмотреть в [шестом примере первой лекции](https://github.com/go-park-mail-ru/lectures/blob/master/1-basics/6_is_sorted/sorted/sorted_test.go).

### Материалы в помощь

В `1-basics/readme.md` есть список книг по го, а так же по всем частым и нужным операциям, там вы можете найти многие примеры кода, которые вам пригодятся.

Материалы в помощь:

* https://habrahabr.ru/post/306914/ - пакет io

* https://golang.org/pkg/sort/

* https://golang.org/pkg/io/

* https://golang.org/pkg/io/ioutil/

* https://godoc.org/flag - пакет для флагов

* https://godoc.org/github.com/stretchr/testify - удобный набор

  пакетов для тестирования

* https://golang.org/pkg/bufio/#Scanner - удобный способ прочитать

  линии из потока данных

### Best practices

1. Уникализация может понадобиться не только как утилита, но

   и как часть более крупной логики. Для этого саму функцию

   уникализации можно вынести в отдельный пакет. Поскольку

   более крупная логика не всегда связана с чтением аргументов

   и данных из файла или stdin, то на вход этой функции нужно

   передавать слайс строк и аргументы.

2. Как файл, так и stdin удовлетворяет интерфейсу io.Reader.

   Поэтому логику по чтению можно сделать универсальной. Аналогично

   и с записью -- io.Writer

3. Множество параметров, которые вдобавок и опциональны, лучше

   передавать структурой (например Options). Так проще расширять

   функциональность, а внешнему пользователю функции(не всей утилиты)

   будет проще передать правильные аргументы внутрь.

4. Для написания однотипных тестовых случаев используется

   [табличное тестирование](https://github.com/golang/go/wiki/TableDrivenTests). Получается, что можно написать две функции

   тестов: успешные тестовые случаи и неуспешные тестовые случаи.

5. Для сравнения ожидаемого и действительного можно использовать

   пакет [require](https://godoc.org/github.com/stretchr/testify/require).

   Кроме простых сравнений на равенство пакет предоставляет много

   других ассертов.

6. Тесты не должны зависеть от внешних ресурсов. Не нужно читать

   файлы внутри теста. Так же не нужно тестировать передачу параметров

   при вызове утилиты. Никакого внешнего взаимодействия. Тестирование

   функции должно быть построено на том, что мы передаём некоторые

   входные данные в функцию и сравниваем ответ функции с ожидаемыми

   выходными данными.

## Часть 2. Calc

Нужно написать калькулятор, умеющий вычислять выражение, подаваемое на STDIN.

Достаточно реализовать сложение, вычитание, умножение, деление и поддержку скобок.

Тут также нужны тесты:) Тестами нужно покрыть все операции.

### Пример работы

```bash

    $ go run calc.go "(1+2)-3"

    0

    $ go run calc.go "(1+2)*3"

    9

```