gueils / belugas-php Goto Github PK

belugas-php is an engine for detecting application features for PHP projects based on static analysis, in other words belugas-php engine can detect the language, framework and database your PHP application is using.

This engine works as command line interface on your local machine of a Docker container:

• Why?
• What is a feature?
• Installation
• Usage
• Contributing
• Credits

belugas-php is part of the Whales ecosystem: A set of tools to automatically dockerize your applications.

A feature is an application attribute detected during the static analysis. This analysis is the act of derivating data from code such as programming language, frameworks, service dependencies and so on. See here for a list of attributes this engine currently supports.

A feature has the following format:

{
  "type":"feature",
  "name":"PHP",
  "version":"5.6.30",
  "description":"The application uses PHP",
  "content":"",
  "categories":["Language"],
  "cue_locations":[""],
  "engines":["belugasd","belugas-php"]
}

Where:

• type: Will always be a feature.
• name: This is the name of the language, framework or database that is being used in the application.
• version: The detected version of the feature. This one is optional
• description: A string explaining the feature that was detected.
• content: A markdown snippet describing the feature, including deeper explanations and links to other resources. This one is optional
• categories: Features are associated with one or more categories, for now we're only handling three diferent categories: Framework, Language & Database
• cue_locations: An array of Location objects representing the places in the source code that provide evidence of the detected feature. This one is optional
• engines: An array of engine names that detected the feature, or refined the data detected by the previous engines.

Currently belugas-php can detect the following PHP frameworks:

• CodeIgniter
• CakePHP
• Laravel
• Yii
• Zend

And the following databases:

• MySQL
• PostgreSQL
• SQLite

We detect this features following Composer guideliness, so make sure it's included in your project.

The Belugas PHP CLI is distributed and run as a Docker image, so you only need to have Docker installed and running on your machine.

Fire up your terminal and run:

docker pull gueils/belugas-php:development

And that's it!

Here's where the magic begins, first of all in your terminal go to the project directory you want to analyze:

cd code/path_to_project/

And then just execute the following command:

docker run \
  --interactive --tty --rm \
  --volume "$PWD":/code \
  gueils/belugas-php:development

And voilá! The terminal will stream a json output for each of the features detected in the following format:

{
  "type":"feature",
  "name":"posgresql",
  "version":"9.5",
  "description":"The application uses PGSQL",
  "categories":["Database"],
  "content": "",
  "cue_locations":[""],
   "engines":["belugas","belugas-php"]
}
{
  "type":"feature",
  "name":"PHP",
  "version":"5.6.30",
  "description":"The application uses PHP",
  "content":"",
  "categories":["Language"],
  "cue_locations":[""],
  "engines":["belugasd","belugas-php"]
}
{
  "type":"feature",
  "name":"laravel",
  "version":"5.1",
  "description":"The application uses LARAVEL",
  "content":"",
  "categories":["Framework"],
  "cue_locations":[""],
  "engines":["belugas","belugas-php"]
}

Everyone is freely to collaborate, just make sure you follow our code of conduct. Thank you contributors!

Find a bug and don't know how to fix it? Have trouble following the documentation or have a question about the project? Then by all means, please create an issue.

Just please make sure you check existing issues to see if what you're running into has been addressed already.

That's great! Just follow this steps:

1. Create a separate branch for your edits
2. Make sure your changes doesn't break the project by running your changes against current specs. We love tests! so it'll be even better if you create new ones when needed
3. Open your pull request against master

Once you've created a pull request, mainteners will chime in to review your proposed changes and to merged it if everything is right 🎉

That's great also! We already have some open issues for you to dive in.

See LICENSE

Belugas-PHP is maintained by Icalia Labs