README

Table of contents:

• Description
• Installation
• Development setup
• Contributing
• Versioning

Description

OpenEuropa Corporate Blocks is a Drupal module built to contain European Commission corporate blocks.

This currently contains:

• The European Commission footer: ships with a set of links and references that must be present on all European Commission sites.
• The European Union footer: ships with a set of links and references that must be present on all European Union sites.

Both footer blocks will received the proper styling when used in conjunction with the OpenEuropa Theme component, version 2.x.

Site specific footer links

The OpenEuropa Corporate Blocks also allows site builders to display a set of site specific links in the footer. Such links can be of two types:

• Generic links, such as a contact or legal disclaimer link. Generic links can be managed at the following page: /admin/config/footer_link_general
• Social media footer links, such as a link to a Facebook page or a Twitter account. Social media footer links can be managed at the following page: /admin/config/footer_link_social

Site specific links can be managed by roles having the Administer site specific footer links permission.

Installation

The recommended way of installing the OpenEuropa Corporate Blocks module is via Composer.

composer require openeuropa/oe_corporate_blocks

It is strongly recommended to use the provisioned Docker image for Virtuoso that contains already the OP vocabularies. To do this, add the image to your docker-compose.yml file:

  sparql:
    image: openeuropa/triple-store-dev
    environment:
    - SPARQL_UPDATE=true
    - DBA_PASSWORD=dba
    ports:
      - "8890:8890"

Otherwise, make sure you have the triple store instance running and have imported the "Corporate body" vocabulary.

Next, if you are using the Task Runner to set up your site, add the runner.yml configuration for connecting to the triple store. Under the drupal key:

  sparql:
    host: "sparql"
    port: "8890"

Still in the runner.yml, add the instruction to create the Drupal settings for connecting to the triple store. Under the drupal.settings.databases key:

  sparql_default:
    default:
      prefix: ""
      host: ${drupal.sparql.host}
      port: ${drupal.sparql.port}
      namespace: 'Drupal\Driver\Database\sparql'
      driver: 'sparql'

Then you can proceed with the regular Task Runner commands for setting up the site.

Otherwise, ensure that in your site's setting.php file you have the connection information to your own triple store instance:

$databases["sparql_default"] = array(
  'default' => array(
    'prefix' => '',
    'host' => 'your-triple-store-host',
    'port' => '8890',
    'namespace' => 'Drupal\\sparql_entity_storage\\Driver\\Database\\sparql',
    'driver' => 'sparql'
  )
);

Enable the module

In order to enable the module in your project run:

./vendor/bin/drush en oe_corporate_blocks

Development setup

You can build the development site by running the following steps:

• Install the Composer dependencies:

composer install

A post command hook (drupal:site-setup) is triggered automatically after composer install. This will symlink the module in the proper directory within the test site and perform token substitution in test configuration files such as behat.yml.dist.

Please note: project files and directories are symlinked within the test site by using the OpenEuropa Task Runner's Drupal project symlink command.

If you add a new file or directory in the root of the project, you need to re-run drupal:site-setup in order to make sure they are be correctly symlinked.

If you don't want to re-run a full site setup for that, you can simply run:

$ ./vendor/bin/run drupal:symlink-project

• Install test site by running:

$ ./vendor/bin/run drupal:site-install

The development site web root should be available in the build directory.

Using Docker Compose

Alternatively, you can build a development site using Docker and Docker Compose with the provided configuration.

Docker provides the necessary services and tools such as a web server and a database server to get the site running, regardless of your local host configuration.

Requirements:

• Docker
• Docker Compose

Configuration

By default, Docker Compose reads two files, a docker-compose.yml and an optional docker-compose.override.yml file. By convention, the docker-compose.yml contains your base configuration and it's provided by default. The override file, as its name implies, can contain configuration overrides for existing services or entirely new services. If a service is defined in both files, Docker Compose merges the configurations.

Find more information on Docker Compose extension mechanism on the official Docker Compose documentation.

Usage

To start, run:

docker-compose up

It's advised to not daemonize docker-compose so you can turn it off (CTRL+C) quickly when you're done working. However, if you'd like to daemonize it, you have to add the flag -d:

docker-compose up -d

Then:

docker-compose exec web composer install
docker-compose exec web ./vendor/bin/run drupal:site-install

Using default configuration, the development site files should be available in the build directory and the development site should be available at: http://127.0.0.1:8080/build.

Running the tests

To run the grumphp checks:

docker-compose exec web ./vendor/bin/grumphp run

To run the phpunit tests:

docker-compose exec web ./vendor/bin/phpunit

To run the behat tests:

docker-compose exec web ./vendor/bin/behat

Upgrade from 1.x to 2.x

Site Switcher block has been removed.

Contributing

Please read the full documentation for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the available versions, see the tags on this repository.