nidup / architool

Experiments with Akeneo PIM code base, Hexagonal Architecture & Domain-Driven Design

Hi there 👋

I'm nidup, co-founder and chief product officer at Akeneo during the day ☀, Indiehacker during the night 🌖, I love creating products 😍

• 💬 I love discussing product, technology, team work, and business
• 📝 I write articles (from time to time) on my blog
• 💻 I love open source, and I enjoy sharing publically what I learn
• 📚 I like to read, leadership books during the day, Sci-Fi novels during the night
• 🎮 I like to practice gam jams, you can find my games in my repos or play them on ldjam.com
• ✨ I'm a bit addicted to emojis, I use them far too much
• 🐦 You can reach me on Twitter @duponico
• 🏗 You can reach me on IndieHacker @nidup

architool's Issues

Interesting libraries

• http://pipeline.thephpleague.com

FileStorage:

• https://symfony.com/doc/current/components/filesystem.html
• http://flysystem.thephpleague.com/

File:

• http://php.net/manual/fr/spl.files.php
• https://github.com/hoaproject/File
• https://symfony.com/doc/current/components/finder.html

CommandBus:

• http://tactician.thephpleague.com/
• http://docs.simplebus.io/en/latest/

Code generation:

• https://github.com/Ocramius/CodeGenerationUtils
• https://github.com/memio/memio

Reflection:

• https://github.com/Roave/BetterReflection

Add symfony dependency injection component

Symfony framework bundle creates a new application that extends Application class from the component. This new class is used to inject the container into all command.

# file Symfony\Bundle\FrameworkBundle\Console\Application

public function get($name)
{
    $this->registerCommands();

    $command = parent::get($name);

    if ($command instanceof ContainerAwareInterface) {
        $command->setContainer($this->kernel->getContainer());
    }

    return $command;
}

The container should be injected into the Application instead of the a Kernel because we don't need it.

Integration tests / Specs

There are lot of missing specs, we need to add them to avoid some "interesting problem". Plus we don't have any integration tests but we do a lot of thing with file system or git, should we introduce them?

TODO:

• Add missing spec

Command bus

• Find a library (SimpleBus ou Tatician for instance).
• Install and configure a CommandBus library

If we use SimpleBus:

• We should use the Symfony bridge, it provides container extension to registry easily services.
• Update the command, they should be "named"

Introduce configuration file

• a step represent a group of actions
• an action represent a Command you want to handle, we need to specify its class and those arguments.

steps:
    move_akeneo_bundle_component:
        - name: move_folder
          arguments:
            - 'Akeneo/Component'
            - 'Akeneo/Common/Component'
        - name: move_folder
          arguments:
            - 'Akeneo/Component'
            - 'Akeneo/Common/Component'
    create_product_enrichment:
        - name: move_folder
          arguments:
            - 'Pim/Component/Catalog'
            - 'Akeneo/Pim/ProductEnrichment/Domain'
        - name: move_folder
          arguments:
            - 'Pim/Component/Catalog'
            - 'Akeneo/Pim/ProductEnrichment/Domain'

TODO:

• Rework HexagonalizeCommand, it should be able to read the configuration file to create command and sent them to the bus.
• Remove Nidup\Architool\Application\Project

Model actions

Actions

Class

Move a class

• Update the class name space
• Move the class file on file system (it should create folder recursively if it does not exist)
• Update all "use"
• Move the spec (if it exists)
• Rename name space in all other file: service definition, comment, doc, configuration, behat configuration

Rename a class

• Update the class name
• Rename the class file on file system
• Update all "use"
• Rename the spec (if it exists)
• Rename class in all other file: service definition, comment, doc, configuration, behat configuration

File

Move a file

• Move the file on the file system

Copy file

• Copy a file to a destination

Use case:

• I could be difficult to rewrite/split configuration, it could be useful to prepare them and copy the in the PIM.

Folder

Create a new folder

• Create an empty folder

We only need this action if we decide that the file system does not support recursive folder creation. For instance Symfony component support that:

// mkdir() creates a directory recursively. 
$fs->mkdir('/tmp/photos', 0700);

Move a folder

• Move all file to the new folder (it should create folder recursively if it does not exist)
• Move all class to the right name space

if the file is still in the same bundle / folder, it should work for:

• routing
• service declaration

Questions

Dependencies

• autoloading for composer
• Javascript ❓

Test configuration

Where do we put phpspec/behat/phpunit configuration?

• at the root of the application?
• at the root of the "context"

Do we need to manage configuration automatically? For instance those file can be written before the migration and copy/paste at the end of the migration

And Javascript tests?

Javascript stuff

❓