Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 108 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@

# Created by https://www.gitignore.io/api/gradle,jetbrains+all
# Edit at https://www.gitignore.io/?templates=gradle,jetbrains+all

### JetBrains+all ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf

# Generated files
.idea/**/contentModel.xml

# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml

# Gradle
.idea/**/gradle.xml
.idea/**/libraries

# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated, and may cause churn. Uncomment if using
# auto-import.
# .idea/modules.xml
# .idea/*.iml
# .idea/modules

# CMake
cmake-build-*/

# Mongo Explorer plugin
.idea/**/mongoSettings.xml

# File-based project format
*.iws

# IntelliJ
out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Cursive Clojure plugin
.idea/replstate.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Editor-based Rest Client
.idea/httpRequests

# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser

### JetBrains+all Patch ###
# Ignores the whole .idea folder and all .iml files
# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360

.idea/

# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023

*.iml
modules.xml
.idea/misc.xml
*.ipr

# Sonarlint plugin
.idea/sonarlint

### Gradle ###
.gradle
build/

# Ignore Gradle GUI config
gradle-app.setting

# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
!gradle-wrapper.jar

# Cache of project
.gradletasknamecache

# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
# gradle/wrapper/gradle-wrapper.properties

### Gradle Patch ###
**/build/

# End of https://www.gitignore.io/api/gradle,jetbrains+all
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
language: java
jdk:
- openjdk9
- oraclejdk9
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# CLI
## Обоснования выбора библиотеки argparse4j
В качестве библиотеки парсинга аргументов рассматривал:
- Apache common CLI
- JSAP
- argparse4j

Из приведенных выше, apache common CLI предоставлял самый мощный, но громозкий интерфейс настройки парсинга, который в этой задаче не был необходим.

JSAP достаточно давно не обновлялся, что насторожило меня.

argparse4j имеет наиболее похожий интерфес со знакомым argparse из python. И, несмотря на то, что имеет достаточно мало "звезд" на github, команда достаточно активно обрабатыват Issue.

Поэтому я остановился на argparse4j.

### Сборка проекта:
Для сборки проекта используется [gradle](https://docs.gradle.org/current/userguide/installation.html).

Сборка проекта происходит с помощью команды:
```$bash
gradle build
```
Данная команда создаст ZIP и TAR архивы со всем необходимым для запуска в `build/distributions`.

## Основные компоненты системы:
- IToken - представление токена команды в системе
- Parser - модуль обработки строкового представления команды и перевода его в список IToken
- Context - объект, служащий для хранения текущего состояния системы (текущие переменные, флаг завершения программы)
- Executor - модуль выполнения команды по списку токенов

## Описание работы
Команда разбивается на токены с помощью компоненты Parser, каждый токен умеет выводить свое строковое представление. Так, например, токен переменная возвращает значение переменной в качестве значения.
Затем, полученный список токенов передается в модуль Executor, который исполняет команду,
на каждом шаге работы запоминая результат работы последней исполненной команды. Результат последнего шага исполнения является результатом исполнения всей команды.

#### Схема выполнения команды:
![Схема работы](images/schema.png)

18 changes: 18 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
group 'ru.ifmo'
version '1.0-SNAPSHOT'

apply plugin: 'java'
apply plugin: 'application'

sourceCompatibility = 1.9

repositories {
mavenCentral()
}

dependencies {
implementation group: 'net.sourceforge.argparse4j', name: 'argparse4j', version: '0.8.1'
testCompile group: 'junit', name: 'junit', version: '4.12'
}

mainClassName = 'ru.ifmo.cli_application.CLI'
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
6 changes: 6 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#Mon Feb 25 07:13:53 MSK 2019
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-all.zip
172 changes: 172 additions & 0 deletions gradlew

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading