Merge pull request #171 from wayofdev/feat/factories

feat!: add laravel factories

Author: lotyp

.env.example

@@ -0,0 +1,17 @@
+# https://docs.docker.com/compose/reference/envvars/#compose_project_name
+# With custom namespace provided, it will be used to prefix all services
+# in Docker network for current project
+COMPOSE_PROJECT_NAME=laravel-cycle-orm-adapter
+
+DB_CONNECTION=pgsql
+DB_HOST=pgsql
+DB_PORT=5432
+
+DB_DATABASE=default
+DB_USERNAME=root
+DB_PASSWORD=password
+
+DB_MYSQL_FORWARD_PORT=13306
+DB_PGSQL_FORWARD_PORT=15432
+
+XDEBUG_MODE=coverage

.github/workflows/ci.yml

@@ -42,18 +42,26 @@ jobs:
         if: steps.cached-composer-dependencies.outputs.cache-hit != 'true'
         run: composer install
 
+      - name: 🛠️ Prepare environment
+        run: |
+          mkdir -p ./.build/php-cs-fixer
+          mkdir -p ./.build/phpstan
+          mkdir -p ./.build/phpunit
+
       - name: 🚨 Run coding standards task
-        run: make cs-diff
+        run: composer cs:diff
         env:
           PHP_CS_FIXER_IGNORE_ENV: true
 
       - name: 🧪 Execute phpunit tests
         env:
           XDEBUG_MODE: coverage
-        run: vendor/bin/phpunit --coverage-clover=coverage.xml
+          DB_CONNECTION: sqlite
+          DB_DATABASE: ":memory:"
+        run: vendor/bin/pest --coverage-clover=coverage.xml
 
       - name: 📝 Run static analysis using phpstan
-        run: make stan
+        run: composer stan:ci
 
       - name: 📤 Upload coverage report to Codecov
         uses: codecov/codecov-action@v3

.gitignore

@@ -1,2 +1,4 @@
 /vendor/
 /.build/
+.env
+coverage.xml

Makefile

@@ -1,13 +1,37 @@
-# leave empty to disable
-# -v - verbose;
-# -vv - more details
-# -vvv - enable connection debugging
-DEBUG_VERBOSITY ?=
+-include .env
 
-DOCKER_CMD =
+# BuildKit enables higher performance docker builds and caching possibility
+# to decrease build times and increase productivity for free.
+# https://docs.docker.com/compose/environment-variables/envvars/
+export DOCKER_BUILDKIT ?= 1
 
-COMPOSER_RUN = $(DOCKER_CMD) composer
+# Binary to use, when executing docker-compose tasks
+DOCKER_COMPOSE ?= docker compose
 
+# Support image with all needed binaries, like envsubst, mkcert, wait4x
+SUPPORT_IMAGE ?= wayofdev/build-deps:alpine-latest
+
+APP_RUNNER ?= $(DOCKER_COMPOSE) run --rm --no-deps app
+APP_COMPOSER ?= $(APP_RUNNER) composer
+
+BUILDER_PARAMS ?= docker run --rm -i \
+	--env-file ./.env \
+	--env COMPOSE_PROJECT_NAME=$(COMPOSE_PROJECT_NAME) \
+	--env COMPOSER_AUTH="$(COMPOSER_AUTH)"
+
+BUILDER ?= $(BUILDER_PARAMS) $(SUPPORT_IMAGE)
+BUILDER_WIRED ?= $(BUILDER_PARAMS) --network project.$(COMPOSE_PROJECT_NAME) $(SUPPORT_IMAGE)
+
+# Shorthand envsubst command, executed through build-deps
+ENVSUBST ?= $(BUILDER) envsubst
+
+EXPORT_VARS = '\
+	$${COMPOSE_PROJECT_NAME} \
+	$${COMPOSER_AUTH}'
+
+
+# Self documenting Makefile code
+# ------------------------------------------------------------------------------------
 ifneq ($(TERM),)
 	BLACK := $(shell tput setaf 0)
 	RED := $(shell tput setaf 1)
@@ -32,6 +56,8 @@ endif
 MAKE_LOGFILE = /tmp/wayofdev-laravel-cycle-orm-adapter.log
 MAKE_CMD_COLOR := $(BLUE)
 
+default: all
+
 help:
 	@echo 'Management commands for package:'
 	@echo 'Usage:'
@@ -45,62 +71,111 @@ help:
 	@echo '    🏢 ${YELLOW}Org                     wayofdev (github.com/wayofdev)${RST}'
 .PHONY: help
 
+.EXPORT_ALL_VARIABLES:
+
+# Default action
+# Defines default command when `make` is executed without additional parameters
+# ------------------------------------------------------------------------------------
 all: install hooks
 .PHONY: all
 
+
+# System Actions
+# ------------------------------------------------------------------------------------
+env: ## Generate .env file from example, use `make env force=true`, to force re-create file
+ifeq ($(FORCE),true)
+	@echo "${YELLOW}Force re-creating .env file from example...${RST}"
+	$(ENVSUBST) $(EXPORT_VARS) < ./.env.example > ./.env
+else ifneq ("$(wildcard ./.env)","")
+	@echo ""
+	@echo "${YELLOW}The .env file already exists! Use FORCE=true to re-create.${RST}"
+else
+	@echo "Creating .env file from example"
+	$(ENVSUBST) $(EXPORT_VARS) < ./.env.example > ./.env
+endif
+.PHONY: env
+
 prepare:
 	mkdir -p .build/php-cs-fixer
 .PHONY: prepare
 
 
+# Docker Actions
+# ------------------------------------------------------------------------------------
+up: # Creates and starts containers, defined in docker-compose and override file
+	$(DOCKER_COMPOSE) up --remove-orphans -d
+.PHONY: up
+
+down: # Stops and removes containers of this project
+	$(DOCKER_COMPOSE) down --remove-orphans --volumes
+.PHONY: down
+
+restart: down up ## Runs down and up commands
+.PHONY: restart
+
+clean: ## Stops containers if required and removes from system
+	$(DOCKER_COMPOSE) rm --force --stop
+.PHONY: clean
+
+ps: ## List running project containers
+	$(DOCKER_COMPOSE) ps
+.PHONY: ps
+
+logs: ## Show project docker logs with follow up mode enabled
+	$(DOCKER_COMPOSE) logs -f
+.PHONY: logs
+
+pull: ## Pull and update docker images in this project
+	$(DOCKER_COMPOSE) pull
+.PHONY: pull
+
+ssh: ## Login inside running docker container
+	$(APP_RUNNER) sh
+.PHONY: ssh
+
+
 # Composer
 # ------------------------------------------------------------------------------------
 install: ## Installs composer dependencies
-	$(COMPOSER_RUN) install
+	$(APP_COMPOSER) install
 .PHONY: install
 
 update: ## Updates composer dependencies by running composer update command
-	$(COMPOSER_RUN) update
+	$(APP_COMPOSER) update
 .PHONY: update
 
 
-# Testing
+# Code Quality, Git, Linting, Testing
 # ------------------------------------------------------------------------------------
-cs-diff: prepare ## Runs php-cs-fixer in dry-run mode and shows diff which will by applied
-	$(COMPOSER_RUN) cs-diff
-.PHONY: cs-diff
+hooks: ## Install git hooks from pre-commit-config
+	pre-commit install
+	pre-commit autoupdate
+.PHONY: hooks
+
+lint-yaml: ## Lints yaml files inside project
+	yamllint .
+.PHONY: lint-yaml
+
+lint-php: prepare ## Fixes code to follow coding standards using php-cs-fixer
+	$(APP_COMPOSER) cs:fix
+.PHONY: lint-php
 
-cs-fix: prepare ## Fixes code to follow coding standards using php-cs-fixer
-	$(COMPOSER_RUN) cs-fix
-.PHONY: cs-fix
+lint-diff: prepare ## Runs php-cs-fixer in dry-run mode and shows diff which will by applied
+	$(APP_COMPOSER) cs:diff
+.PHONY: lint-diff
 
-stan: ## Runs phpstan – static analysis tool
-	$(COMPOSER_RUN) stan
-.PHONY: stan
+lint-stan: ## Runs phpstan – static analysis tool
+	$(APP_COMPOSER) stan
+.PHONY: lint-stan
 
-stan-ci:
-	$(COMPOSER_RUN) stan-ci
-.PHONY: stan-ci
+lint-stan-ci:
+	$(APP_COMPOSER) stan:ci
+.PHONY: lint-stan-ci
 
 test: ## Run project php-unit and pest tests
-	XDEBUG_MODE=coverage $(COMPOSER_RUN) test
+	$(APP_COMPOSER) test
 .PHONY: test
 
 test-cc: ## Run project php-unit and pest tests in coverage mode and build report
-	$(COMPOSER_RUN) test-cc
+	$(APP_COMPOSER) test:cc
 .PHONY: test-cc
-
-
-# Yaml Actions
-# ------------------------------------------------------------------------------------
-lint: ## Lints yaml files inside project
-	yamllint .
-.PHONY: lint
-
-
-# Git Actions
-# ------------------------------------------------------------------------------------
-hooks: ## Install git hooks from pre-commit-config
-	pre-commit install
-	pre-commit autoupdate
-.PHONY: hooks

composer.json

@@ -26,6 +26,7 @@
         "illuminate/console": "^10.9",
         "illuminate/contracts": "^10.9",
         "illuminate/support": "^10.9",
+        "laminas/laminas-hydrator": "^4.14",
         "spiral/attributes": "^3.1",
         "symfony/console": "^6.2"
     },
@@ -64,12 +65,12 @@
         }
     },
     "scripts": {
-        "cs-fix": "php vendor/bin/php-cs-fixer fix -v",
-        "cs-diff": "php vendor/bin/php-cs-fixer fix --dry-run -v --diff",
+        "cs:fix": "php vendor/bin/php-cs-fixer fix -v",
+        "cs:diff": "php vendor/bin/php-cs-fixer fix --dry-run -v --diff",
         "test": "php vendor/bin/pest",
-        "test-cc": "php vendor/bin/pest --coverage",
+        "test:cc": "php vendor/bin/pest --coverage",
         "stan": "php vendor/bin/phpstan analyse --memory-limit=256M",
-        "stan-ci": "php vendor/bin/phpstan analyse --error-format=github",
+        "stan:ci": "php vendor/bin/phpstan analyse --error-format=github",
         "post-autoload-dump": [
             "@php vendor/bin/testbench package:discover --ansi"
         ]