├── gradle.properties ├── settings.gradle.kts ├── .idea ├── .gitignore ├── vcs.xml ├── misc.xml ├── csv-plugin.xml ├── gradle.xml └── codeStyles ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── src └── main │ └── kotlin │ ├── interactor │ ├── CostOfLivingDataSource.kt │ ├── GetCityHasCheapestInternetConnectionInteractor.kt │ └── GetHighestSalaryAverageCititesNamesInteractor.kt │ ├── model │ ├── CarsPrices.kt │ ├── MealsPrices.kt │ ├── ClothesPrices.kt │ ├── FoodPrices.kt │ ├── FruitAndVegetablesPrices.kt │ ├── DrinksPrices.kt │ ├── TransportationsPrices.kt │ ├── RealEstatesPrices.kt │ ├── ServicesPrices.kt │ └── CityEntity.kt │ ├── dataSource │ ├── CsvDataSource.kt │ └── utils │ │ ├── ColumnIndex.kt │ │ └── CsvParser.kt │ └── Main.kt ├── .gitignore ├── gradlew.bat ├── README.md ├── gradlew └── LICENSE /gradle.properties: -------------------------------------------------------------------------------- 1 | kotlin.code.style=official 2 | -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | 2 | rootProject.name = "Cost-of-living-app" 3 | 4 | -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TheChance101/cost-of-living/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /src/main/kotlin/interactor/CostOfLivingDataSource.kt: -------------------------------------------------------------------------------- 1 | package interactor 2 | 3 | import model.CityEntity 4 | 5 | interface CostOfLivingDataSource { 6 | fun getAllCitiesData(): List 7 | } -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /src/main/kotlin/model/CarsPrices.kt: -------------------------------------------------------------------------------- 1 | package model 2 | 3 | data class CarsPrices( 4 | val volkswagenGolf_1_4_90kwTrendLineOrEquivalentNewCar: Float?, 5 | val toyotaCorollaSedan_1_6l_97kwComfortOrEquivalentNewCar: Float?, 6 | ) 7 | -------------------------------------------------------------------------------- /src/main/kotlin/model/MealsPrices.kt: -------------------------------------------------------------------------------- 1 | package model 2 | 3 | data class MealsPrices( 4 | val mealInexpensiveRestaurant: Float?, 5 | val mealFor2PeopleMidRangeRestaurant: Float?, 6 | val mealAtMcDonaldSOrEquivalent: Float?, 7 | ) -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists -------------------------------------------------------------------------------- /src/main/kotlin/model/ClothesPrices.kt: -------------------------------------------------------------------------------- 1 | package model 2 | 3 | data class ClothesPrices( 4 | val onePairOfJeansLevis50oneOrSimilar: Float?, 5 | val oneSummerDressInAChainStoreZaraHAndM: Float?, 6 | val onePairOfNikeRunningShoesMidRange: Float?, 7 | val onePairOfMenLeatherBusinessShoes: Float?, 8 | ) 9 | -------------------------------------------------------------------------------- /src/main/kotlin/model/FoodPrices.kt: -------------------------------------------------------------------------------- 1 | package model 2 | 3 | data class FoodPrices( 4 | val loafOfFreshWhiteBread500g: Float?, 5 | val riceWhite1kg: Float?, 6 | val eggsRegular12: Float?, 7 | val localCheese1kg: Float?, 8 | val chickenFillets1kg: Float?, 9 | val beefRound1kgOrEquivalentBackLegRedMeat: Float?, 10 | ) 11 | -------------------------------------------------------------------------------- /src/main/kotlin/model/FruitAndVegetablesPrices.kt: -------------------------------------------------------------------------------- 1 | package model 2 | 3 | data class FruitAndVegetablesPrices( 4 | val apples1kg: Float?, 5 | val banana1kg: Float?, 6 | val oranges1kg: Float?, 7 | val tomato1kg: Float?, 8 | val potato1kg: Float?, 9 | val onion1kg: Float?, 10 | val lettuceOneHead: Float?, 11 | ) 12 | -------------------------------------------------------------------------------- /src/main/kotlin/model/DrinksPrices.kt: -------------------------------------------------------------------------------- 1 | package model 2 | 3 | data class DrinksPrices( 4 | val cappuccinoRegularInRestaurants: Float?, 5 | val cokePepsiAThirdOfLiterBottleInRestaurants: Float?, 6 | val waterAThirdOfLiterBottleInRestaurants: Float?, 7 | val milkRegularOneLiter: Float?, 8 | val waterOneAndHalfLiterBottleAtTheMarket: Float?, 9 | ) 10 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /src/main/kotlin/interactor/GetCityHasCheapestInternetConnectionInteractor.kt: -------------------------------------------------------------------------------- 1 | package interactor 2 | 3 | import model.CityEntity 4 | 5 | class GetCityHasCheapestInternetConnectionInteractor( 6 | private val dataSource: CostOfLivingDataSource, 7 | ) { 8 | 9 | fun execute(): CityEntity{ 10 | throw Throwable("Not Implemented yet") 11 | } 12 | 13 | 14 | 15 | } -------------------------------------------------------------------------------- /src/main/kotlin/model/TransportationsPrices.kt: -------------------------------------------------------------------------------- 1 | package model 2 | 3 | data class TransportationsPrices( 4 | val oneWayTicketLocalTransport: Float?, 5 | val monthlyPassRegularPrice: Float?, 6 | val taxiStartNormalTariff: Float?, 7 | val taxi1kmNormalTariff: Float?, 8 | val taxi1hourWaitingNormalTariff: Float?, 9 | val gasolineOneLiter: Float?, 10 | ) 11 | -------------------------------------------------------------------------------- /src/main/kotlin/model/RealEstatesPrices.kt: -------------------------------------------------------------------------------- 1 | package model 2 | 3 | data class RealEstatesPrices( 4 | val apartmentOneBedroomInCityCentre: Float?, 5 | val apartmentOneBedroomOutsideOfCentre: Float?, 6 | val apartment3BedroomsInCityCentre: Float?, 7 | val apartment3BedroomsOutsideOfCentre: Float?, 8 | val pricePerSquareMeterToBuyApartmentInCityCentre: Float?, 9 | val pricePerSquareMeterToBuyApartmentOutsideOfCentre: Float?, 10 | ) 11 | -------------------------------------------------------------------------------- /.idea/csv-plugin.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 15 | 16 | -------------------------------------------------------------------------------- /src/main/kotlin/model/ServicesPrices.kt: -------------------------------------------------------------------------------- 1 | package model 2 | 3 | data class ServicesPrices( 4 | val basicElectricityHeatingCoolingWaterGarbageFor85m2Apartment: Float?, 5 | val oneMinOfPrepaidMobileTariffLocalNoDiscountsOrPlans: Float?, 6 | val internet60MbpsOrMoreUnlimitedDataCableAdsl: Float?, 7 | val fitnessClubMonthlyFeeForOneAdult: Float?, 8 | val tennisCourtRentOneHourOnWeekend: Float?, 9 | val cinemaInternationalReleaseOneSeat: Float?, 10 | val preschoolOrKindergartenFullDayPrivateMonthlyForOneChild: Float?, 11 | val internationalPrimarySchoolYearlyForOneChild: Float?, 12 | ) 13 | -------------------------------------------------------------------------------- /src/main/kotlin/model/CityEntity.kt: -------------------------------------------------------------------------------- 1 | package model 2 | 3 | data class CityEntity( 4 | val cityName: String, 5 | val country: String, 6 | val mealsPrices: MealsPrices, 7 | val drinksPrices: DrinksPrices, 8 | val fruitAndVegetablesPrices: FruitAndVegetablesPrices, 9 | val foodPrices: FoodPrices, 10 | val servicesPrices: ServicesPrices, 11 | val clothesPrices: ClothesPrices, 12 | val transportationsPrices: TransportationsPrices, 13 | val carsPrices: CarsPrices, 14 | val realEstatesPrices: RealEstatesPrices, 15 | val averageMonthlyNetSalaryAfterTax: Float?, 16 | val dataQuality: Boolean, 17 | ) 18 | -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 16 | 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | build/ 3 | !gradle/wrapper/gradle-wrapper.jar 4 | !**/src/main/**/build/ 5 | !**/src/test/**/build/ 6 | 7 | ### IntelliJ IDEA ### 8 | .idea/modules.xml 9 | .idea/jarRepositories.xml 10 | .idea/compiler.xml 11 | .idea/libraries/ 12 | *.iws 13 | *.iml 14 | *.ipr 15 | out/ 16 | !**/src/main/**/out/ 17 | !**/src/test/**/out/ 18 | 19 | ### Eclipse ### 20 | .apt_generated 21 | .classpath 22 | .factorypath 23 | .project 24 | .settings 25 | .springBeans 26 | .sts4-cache 27 | bin/ 28 | !**/src/main/**/bin/ 29 | !**/src/test/**/bin/ 30 | 31 | ### NetBeans ### 32 | /nbproject/private/ 33 | /nbbuild/ 34 | /dist/ 35 | /nbdist/ 36 | /.nb-gradle/ 37 | 38 | ### VS Code ### 39 | .vscode/ 40 | 41 | ### Mac OS ### 42 | .DS_Store -------------------------------------------------------------------------------- /src/main/kotlin/interactor/GetHighestSalaryAverageCititesNamesInteractor.kt: -------------------------------------------------------------------------------- 1 | package interactor 2 | 3 | import model.CityEntity 4 | 5 | class GetHighestSalaryAverageCititesNamesInteractor( 6 | private val dataSource: CostOfLivingDataSource, 7 | ) { 8 | 9 | fun execute(limit: Int): List { 10 | return dataSource 11 | .getAllCitiesData() 12 | .filter(::excludeNullSalariesAndLowQualityData) 13 | .sortedByDescending { it.averageMonthlyNetSalaryAfterTax } 14 | .take(limit) 15 | .map { it.cityName } 16 | } 17 | 18 | private fun excludeNullSalariesAndLowQualityData(city: CityEntity): Boolean { 19 | return city.averageMonthlyNetSalaryAfterTax != null && city.dataQuality 20 | } 21 | 22 | } -------------------------------------------------------------------------------- /src/main/kotlin/dataSource/CsvDataSource.kt: -------------------------------------------------------------------------------- 1 | package dataSource 2 | 3 | import dataSource.utils.CsvParser 4 | import interactor.CostOfLivingDataSource 5 | import model.CityEntity 6 | import java.io.File 7 | import java.io.IOException 8 | 9 | class CsvDataSource(private val parser: CsvParser): CostOfLivingDataSource { 10 | 11 | override fun getAllCitiesData(): List { 12 | return getCsvFile().readLines().map { csvLine -> 13 | parser.parseLine(csvLine) 14 | } 15 | } 16 | 17 | private fun getCsvFile(): File { 18 | val costOfLivingCsvFile = File(FILE_NAME) 19 | if (costOfLivingCsvFile.exists()) { 20 | return costOfLivingCsvFile 21 | } 22 | throw IOException("File Not Found") 23 | } 24 | 25 | companion object { 26 | private const val FILE_NAME = "costOfLiving.csv" 27 | } 28 | 29 | } -------------------------------------------------------------------------------- /src/main/kotlin/Main.kt: -------------------------------------------------------------------------------- 1 | import dataSource.CsvDataSource 2 | import dataSource.utils.CsvParser 3 | import interactor.CostOfLivingDataSource 4 | import interactor.GetCityHasCheapestInternetConnectionInteractor 5 | import interactor.GetHighestSalaryAverageCititesNamesInteractor 6 | 7 | fun main() { 8 | val csvParser = CsvParser() 9 | val dataSource: CostOfLivingDataSource = CsvDataSource(csvParser) 10 | 11 | val getHighestSalaryAverageCities = GetHighestSalaryAverageCititesNamesInteractor(dataSource) 12 | println(getHighestSalaryAverageCities.execute(limit = 10)) 13 | printSeparationLine() 14 | 15 | val getCityHasCheapestInternetConnectionInteractor = GetCityHasCheapestInternetConnectionInteractor(dataSource) 16 | println(getCityHasCheapestInternetConnectionInteractor.execute()) 17 | 18 | } 19 | private fun printSeparationLine(){ 20 | print("\n_______________________________\n") 21 | } 22 | 23 | -------------------------------------------------------------------------------- /.idea/codeStyles: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 17 | 18 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /src/main/kotlin/dataSource/utils/ColumnIndex.kt: -------------------------------------------------------------------------------- 1 | package dataSource.utils 2 | 3 | object ColumnIndex { 4 | const val CITY = 0 5 | const val COUNTRY = 1 6 | const val MEAL_INEXPENSIVE_RESTAURANT = 2 7 | const val MEAL_FOR_2_PEOPLE_MID_RANGE_RESTAURANT = 3 8 | const val MEAL_AT_MC_DONALD_S_OR_EQUIVALENT = 4 9 | const val DOMESTIC_BEER_HALF_LITER_DRAUGHT_IN_RESTAURANTS = 5 10 | const val IMPORTED_BEER_A_THIRD_OF_LITER_BOTTLE_IN_RESTAURANTS = 6 11 | const val CAPPUCCINO_REGULAR_IN_RESTAURANTS = 7 12 | const val COKE_PEPSI_A_THIRD_OF_LITER_BOTTLE_IN_RESTAURANTS = 8 13 | const val WATER_A_THIRD_OF_LITER_BOTTLE_IN_RESTAURANTS = 9 14 | const val MILK_REGULAR_ONE_LITER = 10 15 | const val LOAF_OF_FRESH_WHITE_BREAD_500G = 11 16 | const val RICE_WHITE_1KG = 12 17 | const val EGGS_REGULAR_12 = 13 18 | const val LOCAL_CHEESE_1KG = 14 19 | const val CHICKEN_FILLETS_1KG = 15 20 | const val BEEF_ROUND_1KG_OR_EQUIVALENT_BACK_LEG_RED_MEAT = 16 21 | const val APPLES_1KG = 17 22 | const val BANANA_1KG = 18 23 | const val ORANGES_1KG = 19 24 | const val TOMATO_1KG = 20 25 | const val POTATO_1KG = 21 26 | const val ONION_1KG = 22 27 | const val LETTUCE_ONE_HEAD = 23 28 | const val WATER_ONE_AND_HALF_LITER_BOTTLE_AT_THE_MARKET = 24 29 | const val BOTTLE_OF_WINE_MID_RANGE_AT_THE_MARKET = 25 30 | const val DOMESTIC_BEER_HALF_LITER_BOTTLE_AT_THE_MARKET = 26 31 | const val IMPORTED_BEER_A_THIRD_OF_LITER_BOTTLE_AT_THE_MARKET = 27 32 | const val CIGARETTES_20_PACK_MARLBORO = 28 33 | const val ONE_WAY_TICKET_LOCAL_TRANSPORT = 29 34 | const val MONTHLY_PASS_REGULAR_PRICE = 30 35 | const val TAXI_START_NORMAL_TARIFF = 31 36 | const val TAXI_1KM_NORMAL_TARIFF = 32 37 | const val TAXI_1HOUR_WAITING_NORMAL_TARIFF = 33 38 | const val GASOLINE_ONE_LITER = 34 39 | const val VOLKSWAGEN_GOLF_1_4_90KW_TREND_LINE_OR_EQUIVALENT_NEW_CAR = 35 40 | const val TOYOTA_COROLLA_SEDAN_1_6L_97KW_COMFORT_OR_EQUIVALENT_NEW_CAR = 36 41 | const val BASIC_ELECTRICITY_HEATING_COOLING_WATER_GARBAGE_FOR_85M2_APARTMENT = 37 42 | const val ONE_MIN_OF_PREPAID_MOBILE_TARIFF_LOCAL_NO_DISCOUNTS_OR_PLANS = 38 43 | const val INTERNET_60_MBPS_OR_MORE_UNLIMITED_DATA_CABLE_ADSL = 39 44 | const val FITNESS_CLUB_MONTHLY_FEE_FOR_ONE_ADULT = 40 45 | const val TENNIS_COURT_RENT_ONE_HOUR_ON_WEEKEND = 41 46 | const val CINEMA_INTERNATIONAL_RELEASE_ONE_SEAT = 42 47 | const val PRESCHOOL_OR_KINDERGARTEN_FULL_DAY_PRIVATE_MONTHLY_FOR_ONE_CHILD = 43 48 | const val INTERNATIONAL_PRIMARY_SCHOOL_YEARLY_FOR_ONE_CHILD = 44 49 | const val ONE_PAIR_OF_JEANS_LEVIS_50ONE_OR_SIMILAR = 45 50 | const val ONE_SUMMER_DRESS_IN_A_CHAIN_STORE_ZARA_H_AND_M = 46 51 | const val ONE_PAIR_OF_NIKE_RUNNING_SHOES_MID_RANGE = 47 52 | const val ONE_PAIR_OF_MEN_LEATHER_BUSINESS_SHOES = 48 53 | const val APARTMENT_ONE_BEDROOM_IN_CITY_CENTRE = 49 54 | const val APARTMENT_ONE_BEDROOM_OUTSIDE_OF_CENTRE = 50 55 | const val APARTMENT_3_BEDROOMS_IN_CITY_CENTRE = 51 56 | const val APARTMENT_3_BEDROOMS_OUTSIDE_OF_CENTRE = 52 57 | const val PRICE_PER_SQUARE_METER_TO_BUY_APARTMENT_IN_CITY_CENTRE = 53 58 | const val PRICE_PER_SQUARE_METER_TO_BUY_APARTMENT_OUTSIDE_OF_CENTRE = 54 59 | const val AVERAGE_MONTHLY_NET_SALARY_AFTER_TAX = 55 60 | const val MORTGAGE_INTEREST_RATE_IN_PERCENTAGE_YEARLY_FOR_20_YEARS_FIXED_RATE = 56 61 | const val DATA_QUALITY = 57 62 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Cost of living 2 | Week 2 Task at @ The Chance plus 2023 3 | 4 | - As a team Leader fork this repository into your personal github account then add all of your teammates as a contributors 5 | - Using the provided parsed data csv data set 6 | > note: all the prices in the data set is in USD $ 7 | - Use Test Driven Development approach 8 | - Try your best to keep your functions pure and have no side effect 9 | - Write a readable code with a meaningful names. 10 | - Try to make all function reusable by avoid hardcoding the values and pass them to the function 11 | - Follow the Recommended Git Flow approch in branch naming 12 | 13 | here is a sample how to **GetHighestSalaryAverageCititesNamesInteractor** 14 | ``` 15 | class GetHighestSalaryAverageCititesNamesInteractor( 16 | private val dataSource: CostOfLivingDataSource, 17 | ) { 18 | 19 | fun execute(limit: Int): List { 20 | return dataSource 21 | .getAllCitiesData() 22 | .filter(::excludeNullSalariesAndLowQualityData) 23 | .sortedByDescending { it.averageMonthlyNetSalaryAfterTax } 24 | .take(limit) 25 | .map { it.cityName } 26 | } 27 | 28 | private fun excludeNullSalariesAndLowQualityData(city: CityEntity): Boolean { 29 | return city.averageMonthlyNetSalaryAfterTax != null && city.dataQuality 30 | } 31 | 32 | } 33 | ``` 34 | 35 | > Be aware from requirements description if we said a function return cities name that mean it should return `List` but if we said a function return cities that mean `List` 36 | 37 | > Note: the dataQulaity property which is boolean take 2 values if it is `true` that mean the data qulaity is high and if it is `false` thats mean the data quality for this city is low. 38 | 39 | > Note: there is no data set in the world is totaly clean, be aware of missing field don't use them for calculations! 40 | 41 | - Add Interactors classes to achive all required features described below 42 | 43 | 1. Complete `GetCityHasCheapestInternetConnectionInteractor` make this interactor return the city has the cheapest internet connection with 60 Mbps speed keep in mind if the internet price is 10$ but the average of salary is 50$ that doesn't mean the internet is cheap cause it is 20% of your salary, but if the internet price is 40$ but the salary average is 2000$ that mean you are paying only 2% of your salary for 60 Mbps internet connection. 44 | 2. find the name of 10 cities that the average of fruit and vegetables prices have the lowest cost compraing to the slaries that paid in those cities. 45 | 3. search for salaries in country: your should enter a country name (upper case or lower case or mixed all input should be accepted) then if the country name is correct the function will return a List of pairs each pair have city name and salray average for this city, please avoid low qulaity data. if the country name was wrong the function should throw an Exception. 46 | 4. find the city that has the highest different that you should pay for renting an apartment between city center and outside city center, keep in mind the data set has two different type of apartments. use high qulaity data only 47 | 5. There is a 2 youth girl and boy care about fashion alot and they have alot of money so they don't care about getting a job, help them to find the top 5 cities name they should visit to get the clothes from famous brands for most suitable prices. 48 | 6. There is a guy who **hate the crowd and love the nature** and he hate to pay for renting appartments all of his life, he decied to work in 1 full time job + 1 part time job, he pay all the money he get from the part time job for living and eating and all his needs, and save all the money that he get from the full time job to buy 100 meter apartment, find the top 10 cities names that he can buy this apartment faster, and how many year is needed to buy each apartment for each city, the expected return type is a list of pairs each pair is city name and the years needed to buy the apartment in float or double, this guy is serious so please avoid the low qulaity data. 49 | 7. A monkey lover guy how has a lot of monkeys to care about them, he have a group of city that he plan to live there, witre a function that take `vararg's` cities and return a sorted list of cities names sorted by cheapest banan prices. 50 | 8. A startup company consist of 10 employees achived a huge success and gained a lot of money, the owner decied to invite all the employees for a dinner in any city they like in the world, there is two guys have two different suggestions the first one suggest to go the city that has the most expensive meals, and the second one decied to go the city that has the cheapest meal prices, keep in mind this startup located in north america and they are searching in USA, Canda, and Mexcio only, then the manger decied to go a city that their meals price are excatly between the both suggestions. create all needed functions inside the interactor to find the city that match manager expectations. 51 | 9. Find the top 10 countires name in the world that enforce high taxes on carbonated drinks like coke, so the price are the highest there, let your function return a list of pairs each pair has country name and the average prices for those drinks for this country, use high quality data only! 52 | 10. A family consist of father and mother and 2 kids that only there father has a full time job, they need an apartment with 3 room, the father use a bike to go to his job he don't like cars and he is highly paid so his monthly salary is 2x of the average of the city he could work in. the family consume 15 KG of white bread, 1 KG of cheese, 4 KG of red meet beaf, 10 KG of chicken fillets, and 2 KG of rice per month, and have a limit of 250$ payment for the other type of needs, ignoring taxes, find the most suitable city in the world that they can have more savings per month. 53 | -------------------------------------------------------------------------------- /src/main/kotlin/dataSource/utils/CsvParser.kt: -------------------------------------------------------------------------------- 1 | package dataSource.utils 2 | 3 | import model.* 4 | 5 | class CsvParser { 6 | 7 | fun parseLine(csvLine: String): CityEntity{ 8 | val tokenizedList: List = csvLine.split(",") 9 | return CityEntity( 10 | cityName = tokenizedList[ColumnIndex.CITY], 11 | country = tokenizedList[ColumnIndex.COUNTRY], 12 | mealsPrices = constructMealsPricesFromTokens(tokenizedList), 13 | drinksPrices = constructDrinksPricesFromTokens(tokenizedList), 14 | fruitAndVegetablesPrices = constructFruitAndVegetablesPricesFromTokens(tokenizedList), 15 | foodPrices = constructFoodPricesFromTokens(tokenizedList), 16 | servicesPrices = constructServicesPricesFromTokens(tokenizedList), 17 | clothesPrices = constructClothesPricesFromTokens(tokenizedList), 18 | transportationsPrices = constructTransportationsPricesFromTokens(tokenizedList), 19 | carsPrices = constructCarsPricesFromTokens(tokenizedList), 20 | realEstatesPrices = constructRealStatesPricesFromTokens(tokenizedList), 21 | averageMonthlyNetSalaryAfterTax = tokenizedList[ColumnIndex.AVERAGE_MONTHLY_NET_SALARY_AFTER_TAX].toFloatOrNull(), 22 | dataQuality = tokenizedList[ColumnIndex.DATA_QUALITY].toIntOrNull() == 1, 23 | ) 24 | } 25 | 26 | private fun constructMealsPricesFromTokens(tokenizedList: List): MealsPrices{ 27 | return MealsPrices( 28 | mealAtMcDonaldSOrEquivalent = tokenizedList.getFloat(ColumnIndex.MEAL_AT_MC_DONALD_S_OR_EQUIVALENT), 29 | mealInexpensiveRestaurant = tokenizedList.getFloat(ColumnIndex.MEAL_INEXPENSIVE_RESTAURANT), 30 | mealFor2PeopleMidRangeRestaurant = tokenizedList.getFloat(ColumnIndex.MEAL_FOR_2_PEOPLE_MID_RANGE_RESTAURANT), 31 | ) 32 | } 33 | 34 | private fun constructDrinksPricesFromTokens(tokenizedList: List): DrinksPrices{ 35 | return DrinksPrices( 36 | cappuccinoRegularInRestaurants = tokenizedList.getFloat(ColumnIndex.CAPPUCCINO_REGULAR_IN_RESTAURANTS), 37 | cokePepsiAThirdOfLiterBottleInRestaurants = tokenizedList.getFloat(ColumnIndex.COKE_PEPSI_A_THIRD_OF_LITER_BOTTLE_IN_RESTAURANTS), 38 | milkRegularOneLiter = tokenizedList.getFloat(ColumnIndex.MILK_REGULAR_ONE_LITER), 39 | waterAThirdOfLiterBottleInRestaurants = tokenizedList.getFloat(ColumnIndex.WATER_A_THIRD_OF_LITER_BOTTLE_IN_RESTAURANTS), 40 | waterOneAndHalfLiterBottleAtTheMarket = tokenizedList.getFloat(ColumnIndex.WATER_ONE_AND_HALF_LITER_BOTTLE_AT_THE_MARKET), 41 | ) 42 | } 43 | 44 | private fun constructFruitAndVegetablesPricesFromTokens(tokenizedList: List): FruitAndVegetablesPrices{ 45 | return FruitAndVegetablesPrices( 46 | apples1kg = tokenizedList.getFloat(ColumnIndex.APPLES_1KG), 47 | banana1kg = tokenizedList.getFloat(ColumnIndex.BANANA_1KG), 48 | oranges1kg = tokenizedList.getFloat(ColumnIndex.ORANGES_1KG), 49 | tomato1kg = tokenizedList.getFloat(ColumnIndex.TOMATO_1KG), 50 | onion1kg = tokenizedList.getFloat(ColumnIndex.ONION_1KG), 51 | potato1kg = tokenizedList.getFloat(ColumnIndex.POTATO_1KG), 52 | lettuceOneHead = tokenizedList.getFloat(ColumnIndex.LETTUCE_ONE_HEAD) 53 | ) 54 | } 55 | 56 | private fun constructFoodPricesFromTokens(tokenizedList: List): FoodPrices{ 57 | return FoodPrices( 58 | loafOfFreshWhiteBread500g = tokenizedList.getFloat(ColumnIndex.LOAF_OF_FRESH_WHITE_BREAD_500G), 59 | riceWhite1kg = tokenizedList.getFloat(ColumnIndex.RICE_WHITE_1KG), 60 | eggsRegular12 = tokenizedList.getFloat(ColumnIndex.EGGS_REGULAR_12), 61 | localCheese1kg = tokenizedList.getFloat(ColumnIndex.LOCAL_CHEESE_1KG), 62 | chickenFillets1kg = tokenizedList.getFloat(ColumnIndex.CHICKEN_FILLETS_1KG), 63 | beefRound1kgOrEquivalentBackLegRedMeat = tokenizedList.getFloat(ColumnIndex.BEEF_ROUND_1KG_OR_EQUIVALENT_BACK_LEG_RED_MEAT), 64 | ) 65 | } 66 | 67 | private fun constructServicesPricesFromTokens(tokenizedList: List): ServicesPrices{ 68 | return ServicesPrices( 69 | basicElectricityHeatingCoolingWaterGarbageFor85m2Apartment = tokenizedList.getFloat(ColumnIndex.BASIC_ELECTRICITY_HEATING_COOLING_WATER_GARBAGE_FOR_85M2_APARTMENT), 70 | cinemaInternationalReleaseOneSeat = tokenizedList.getFloat(ColumnIndex.CINEMA_INTERNATIONAL_RELEASE_ONE_SEAT), 71 | internet60MbpsOrMoreUnlimitedDataCableAdsl = tokenizedList.getFloat(ColumnIndex.INTERNET_60_MBPS_OR_MORE_UNLIMITED_DATA_CABLE_ADSL), 72 | fitnessClubMonthlyFeeForOneAdult = tokenizedList.getFloat(ColumnIndex.FITNESS_CLUB_MONTHLY_FEE_FOR_ONE_ADULT), 73 | tennisCourtRentOneHourOnWeekend = tokenizedList.getFloat(ColumnIndex.TENNIS_COURT_RENT_ONE_HOUR_ON_WEEKEND), 74 | oneMinOfPrepaidMobileTariffLocalNoDiscountsOrPlans = tokenizedList.getFloat(ColumnIndex.ONE_MIN_OF_PREPAID_MOBILE_TARIFF_LOCAL_NO_DISCOUNTS_OR_PLANS), 75 | internationalPrimarySchoolYearlyForOneChild = tokenizedList.getFloat(ColumnIndex.INTERNATIONAL_PRIMARY_SCHOOL_YEARLY_FOR_ONE_CHILD), 76 | preschoolOrKindergartenFullDayPrivateMonthlyForOneChild = tokenizedList.getFloat(ColumnIndex.PRESCHOOL_OR_KINDERGARTEN_FULL_DAY_PRIVATE_MONTHLY_FOR_ONE_CHILD), 77 | ) 78 | } 79 | 80 | private fun constructClothesPricesFromTokens(tokenizedList: List): ClothesPrices{ 81 | return ClothesPrices( 82 | onePairOfJeansLevis50oneOrSimilar = tokenizedList.getFloat(ColumnIndex.ONE_PAIR_OF_JEANS_LEVIS_50ONE_OR_SIMILAR), 83 | oneSummerDressInAChainStoreZaraHAndM = tokenizedList.getFloat(ColumnIndex.ONE_SUMMER_DRESS_IN_A_CHAIN_STORE_ZARA_H_AND_M), 84 | onePairOfNikeRunningShoesMidRange = tokenizedList.getFloat(ColumnIndex.ONE_PAIR_OF_NIKE_RUNNING_SHOES_MID_RANGE), 85 | onePairOfMenLeatherBusinessShoes = tokenizedList.getFloat(ColumnIndex.ONE_PAIR_OF_MEN_LEATHER_BUSINESS_SHOES), 86 | ) 87 | } 88 | 89 | private fun constructTransportationsPricesFromTokens(tokenizedList: List): TransportationsPrices{ 90 | return TransportationsPrices( 91 | gasolineOneLiter = tokenizedList.getFloat(ColumnIndex.GASOLINE_ONE_LITER), 92 | taxi1hourWaitingNormalTariff = tokenizedList.getFloat(ColumnIndex.TAXI_1HOUR_WAITING_NORMAL_TARIFF), 93 | taxi1kmNormalTariff = tokenizedList.getFloat(ColumnIndex.TAXI_1KM_NORMAL_TARIFF), 94 | monthlyPassRegularPrice = tokenizedList.getFloat(ColumnIndex.MONTHLY_PASS_REGULAR_PRICE), 95 | oneWayTicketLocalTransport = tokenizedList.getFloat(ColumnIndex.ONE_WAY_TICKET_LOCAL_TRANSPORT), 96 | taxiStartNormalTariff = tokenizedList.getFloat(ColumnIndex.TAXI_START_NORMAL_TARIFF) 97 | ) 98 | } 99 | 100 | private fun constructCarsPricesFromTokens(tokenizedList: List): CarsPrices{ 101 | return CarsPrices( 102 | volkswagenGolf_1_4_90kwTrendLineOrEquivalentNewCar = tokenizedList.getFloat(ColumnIndex.VOLKSWAGEN_GOLF_1_4_90KW_TREND_LINE_OR_EQUIVALENT_NEW_CAR), 103 | toyotaCorollaSedan_1_6l_97kwComfortOrEquivalentNewCar = tokenizedList.getFloat(ColumnIndex.TOYOTA_COROLLA_SEDAN_1_6L_97KW_COMFORT_OR_EQUIVALENT_NEW_CAR), 104 | ) 105 | } 106 | 107 | private fun constructRealStatesPricesFromTokens(tokenizedList: List): RealEstatesPrices{ 108 | return RealEstatesPrices( 109 | apartmentOneBedroomInCityCentre = tokenizedList.getFloat(ColumnIndex.APARTMENT_ONE_BEDROOM_IN_CITY_CENTRE), 110 | apartmentOneBedroomOutsideOfCentre = tokenizedList.getFloat(ColumnIndex.APARTMENT_ONE_BEDROOM_OUTSIDE_OF_CENTRE), 111 | apartment3BedroomsInCityCentre = tokenizedList.getFloat(ColumnIndex.APARTMENT_3_BEDROOMS_IN_CITY_CENTRE), 112 | apartment3BedroomsOutsideOfCentre = tokenizedList.getFloat(ColumnIndex.APARTMENT_3_BEDROOMS_OUTSIDE_OF_CENTRE), 113 | pricePerSquareMeterToBuyApartmentInCityCentre = tokenizedList.getFloat(ColumnIndex.PRICE_PER_SQUARE_METER_TO_BUY_APARTMENT_IN_CITY_CENTRE), 114 | pricePerSquareMeterToBuyApartmentOutsideOfCentre = tokenizedList.getFloat(ColumnIndex.PRICE_PER_SQUARE_METER_TO_BUY_APARTMENT_OUTSIDE_OF_CENTRE), 115 | ) 116 | } 117 | 118 | private fun List.getFloat(index: Int): Float?{ 119 | return this[index].toFloatOrNull() 120 | } 121 | } -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Use "xargs" to parse quoted args. 209 | # 210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 211 | # 212 | # In Bash we could simply go: 213 | # 214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 215 | # set -- "${ARGS[@]}" "$@" 216 | # 217 | # but POSIX shell has neither arrays nor command substitution, so instead we 218 | # post-process each arg (as a line of input to sed) to backslash-escape any 219 | # character that might be a shell metacharacter, then use eval to reverse 220 | # that process (while maintaining the separation between arguments), and wrap 221 | # the whole thing up as a single "set" statement. 222 | # 223 | # This will of course break if any of these variables contains a newline or 224 | # an unmatched quote. 225 | # 226 | 227 | eval "set -- $( 228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 229 | xargs -n1 | 230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 231 | tr '\n' ' ' 232 | )" '"$@"' 233 | 234 | exec "$JAVACMD" "$@" 235 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------