README

Introduction

Lightweight Symfony Demo Application for the Spreadsheet Translator functionality. This demo brings a command that takes a Google Drive spreadsheet and creates translation files per locale in YAML format.

Installation

composer create-project samuelvi/translator-symfony-demo-googledrive-to-yml

This will install the demo application into your computer.

Configuration

Before running the demo, configure your Google Drive spreadsheet URL in config/packages/atico_spreadsheet_translator.yaml:

atico_spreadsheet_translator:
    frontend:
        provider:
            name: 'google_drive'
            source_resource: 'https://docs.google.com/spreadsheets/d/YOUR_SPREADSHEET_ID/edit#gid=0'
        exporter:
            format: 'yml'
            prefix: 'demo_'
            destination_folder: '%kernel.project_dir%/translations'
        shared:
            default_locale: 'en'
            name_separator: '_'

Important: Make sure your Google Spreadsheet is publicly accessible for the provider to download it.

Running the demo

Type in your terminal:

bin/console atico:demo:translator --sheet-name=common --book-name=frontend

This command will generate the translation files that will be stored into the translations/ folder.

The generated files will be:

  translations
     │  demo_common.en_GB.yml
     │  demo_common.es_ES.yml
     │  demo_common.fr_FR.yml

demo_common.en_GB.yml will contain:

homepage:
    title: >
        Secured Spreadsheet translator
    subtitle: >
        Translator of web pages from secured spreadsheet

Notes

composer.json includes the following Spreadsheet Translator dependencies:

  "samuelvi/spreadsheet-translator-core": "^8.0",
  "samuelvi/spreadsheet-translator-symfony-bundle": "^8.0",
  "samuelvi/spreadsheet-translator-provider-googledrive": "^8.0",
  "samuelvi/spreadsheet-translator-reader-xlsx": "^8.0",
  "samuelvi/spreadsheet-translator-exporter-yml": "^8.0"

Symfony Bundle:

Symfony Bundle

Symfony Demos:

Requirements

PHP >=8.4
Symfony >=7.0

Development

Code Quality with Rector

This project uses Rector to maintain PHP 8.4 compliance and code quality standards.

Run Rector to check for potential improvements:

vendor/rector/rector/bin/rector process --dry-run

Apply Rector changes:

vendor/rector/rector/bin/rector process

The rector configuration (rector.php) includes:

PHP 8.4 compliance rules (LevelSetList::UP_TO_PHP_84)
Code quality improvements
Dead code removal
Type declaration enhancements
Symfony 7.0 best practices
Doctrine code quality rules
Annotations to attributes conversion

Example output:

1 file has been changed by Rector

Contributing

We welcome contributions to this project, including pull requests and issues (and discussions on existing issues).

If you'd like to contribute code but aren't sure what, the issues list is a good place to start. If you're a first-time code contributor, you may find Github's guide to forking projects helpful.

All contributors (whether contributing code, involved in issue discussions, or involved in any other way) must abide by our code of conduct.

License

Spreadsheet Translator Symfony Bundle is licensed under the MIT License. See the LICENSE file for full details.

samuelvi / translator-symfony-demo-googledrive-to-yml

Maintainers

Details