Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://qafoolabs.github.io/php-refactoring-browser/

A command line refactoring tool for PHP
https://qafoolabs.github.io/php-refactoring-browser/

Last synced: about 2 months ago
JSON representation

A command line refactoring tool for PHP

Lists

README 

        
# PHP Refactoring Browser



    Note: This software is under development and in alpha state. Refactorings

    do not contain all necessary pre-conditions and might mess up your code.

    Check the diffs carefully before applying the patches.



[![Build Status](https://travis-ci.org/QafooLabs/php-refactoring-browser.png)](https://travis-ci.org/QafooLabs/php-refactoring-browser)



Automatic Refactorings for PHP Code by generating diffs that describe

the refactorings steps. To prevent simple mistakes during refactorings, an automated tool

is a great.



See a [screenshot of extract-method in action](docs/extract_method.png).



The library is standing on the shoulder of giants, using multiple existing libraries:



* [PHP Parser](https://github.com/nikic/PHP-Parser) by Nikic

* [PHP Token Reflection](https://github.com/Andrewsville/PHP-Token-Reflection) from Ondřej Nešpor



Based on data from these sources the Refactoring Browser consists of two distinct components:



* ``Patches`` allows to build patches based on change operations on a file.

* ``Refactoring`` contains the actual Refactoring domain and adapters to third party libraries.

* ``Collections`` adds some collection semantics on top of PHP arrays. Currently contains a Set type.



## Install & Basic Usage



[Download PHAR](https://github.com/QafooLabs/php-refactoring-browser/releases)



The refactoring browser is used with:



    php refactor.phar  ...



It outputs a diff to the screen and you can apply it to your code by piping it to ``patch -p1``:



    php refactor.phar  ... | patch -p1



### Editor Plugins



There are third-party plugins available for using PHP refactorings within

different text editors.  These separately maintained projects can be found at

the links below:



* vim : https://github.com/vim-php/vim-php-refactoring

* emacs : https://github.com/keelerm84/php-refactor-mode.el



## Why?



Users of PHPStorm (or Netbeans) might wonder why this project exists, all the

refactorings are available in this IDE. We feel there are several reasons to have

such a tool in PHP natively:



* We are VIM users and don't want to use an IDE for refactorings. Also we

  are independent of an IDE and users of any (non PHP Storm) editor can now

  benefit from the practice of automated refactorings.

* The non-existence of a simple refactoring tool leads to programmers not

  refactoring "just to be safe". This hurts long time maintainability of code.

  Refactoring is one of the most important steps during development and just come easy.

* Generating patches for refactorings before applying them allows to easily

  verify the operation yourself or sending it to a colleague.

* The libraries (see above) to build such a tool are available, so why not do it.

* The project is an academic of sorts as well, as you can see in the Design Goals

  we try to be very strict about the Ports and Adapters architecture and a Domain

  Driven Design.



## Refactorings



### Extract Method



Extract a range of lines into a new method and call this method from the original

location:



    php refactor.phar extract-method   



This refactoring automatically detects all necessary inputs and outputs from the

function and generates the argument list and return statement accordingly.



### Rename Local Variable



Rename a local variable from one to another name:



    php refactor.phar rename-local-variable    



### Convert Local to Instance Variable



Converts a local variable into an instance variable, creates the property and renames

all the occurrences in the selected method to use the instance variable:



    php refactor.phar convert-local-to-instance-variable   



### Rename Class and Namespaces



Batch Operation to rename classes and namespaces by syncing class-names (IS-state)

to filesystem names (SHOULD-state) based on the assumption of PSR-0.



Fix class and namespace names to correspond to the current filesystem layout,

given that the project uses PSR-0. This means you can use this tool to

rename classes and namespaces by renaming folders and files and then applying

the command to fix class and namespaces.



    php refactor.phar fix-class-names 



### Optimize use statements



Optimizes the use of Fully qualified names in a file so that FQN is imported with 

"use" at the top of the file and the FQN is replaced with its classname.



All other use statements will be untouched, only new ones will be added.



    php refactor.phar optimize-use 



## Roadmap



Not prioritized.



Integration:



* Vim Plugin to apply refactorings from within Vim.



List of Refactorings to implement:



* Extract Method (Prototype Done)

* Rename Local Variable (Prototype Done)

* Optimize use statements (Done)

* Convert Local Variable to Instance Variable (Prototype Done)

* Rename Class PSR-0 aware (Done)

* Rename Namespace PSR-0 aware (Done)

* Convert Magic Value to Constant

* Rename Method

    * Private Methods Only first

* Rename Instance Variable

    * Private Variables Only First

* Extract Interface



## Internals



### Design Goals



* Be independent of third-party libraries and any Type Inference Engine (PDepend, PHP Analyzer) via Ports+Adapters

* Apply Domain-Driven-Design and find suitable Bounded Contexts and Ubiquitous Language within them

* Avoid primitive obsession by introducing value objects for useful constructs in the domain