jeanpaulruiz/magento-extension-base

A starting point for a Magento module, including Composer & Unit testing configuration

Base Magento Extension

Pre-configured repository for building a Magento extension. Provides Composer configuration and common Composer dependencies.

Setup

First, create a repository for your extension, then run the following commands:

$ git clone https://github.com/AydinHassan/magento-extension-base your-ext-name
$ cd your-ext-name
$ php build.php

Follow the instructions and that's it!, an initial commit will be made for your and your remote added. You can then run git push whenever you are ready.

Module Structure

After following the setup the module created will have the following structure.

├── LICENSE
├── README.md
├── app
│   ├── code
│   │   └── community
│   │       └── AydinHassan
│   │           └── Parrot
│   │               ├── Block
│   │               ├── Helper
│   │               ├── Model
│   │               ├── controllers
│   │               ├── etc
│   │               │   └── config.xml
│   │               └── sql
│   │                   └── aydinhassan_parrot_setup
│   ├── design
│   │   ├── adminhtml
│   │   │   └── default
│   │   │       └── default
│   │   │           ├── layout
│   │   │           │   └── aydinhassan
│   │   │           └── template
│   │   │               └── aydinhassan
│   │   │                   └── parrot
│   │   └── frontend
│   │       └── base
│   │           └── default
│   │               ├── layout
│   │               │   └── aydinhassan
│   │               └── template
│   │                   └── aydinhassan
│   │                       └── parrot
│   └── etc
│       └── modules
│           └── AydinHassan_Parrot.xml
├── composer.json
├── composer.lock
├── phpunit.xml
├── skin
│   └── frontend
│       └── base
│           └── default
│               └── js
│                   └── aydinhassan
│                       └── parrot
└── test
    ├── bootstrap.php
    └── parrot
        └── DemoTest.php

Unit Tests

We are using Aspect Mock which uses Go! AOP to be able to create test doubles for static method calls. This is required due to Magento relying heavily on static calls to the Mage class.

Unit tests should be a core part of any project so it's recommended to read up on Aspect Mock and keep your project up to date as it is still in Alpha!