logifix

Logifix

Logifix es una herramienta basada en datos para corregir automáticamente las violaciones de análisis estático en el código fuente de Java. LOGIFIX se puede utilizar para corregir violaciones de análisis estáticos para analizadores estáticos como Sonarqube, PMD o Spotbugs, pero también para modernizar el código heredado o incluso para hacer cumplir automáticamente las reglas personalizadas específicas para su base de código.

Manifestación

demo.mp4

Empezando

1. Instalar

Se proporcionan binarios previos y sin dependencia para los sistemas Linux basados ​​en MacOS y Linux basados ​​en GNU.

Ubuntu/Debian

curl -L https://github.com/lyxell/logifix/releases/latest/download/logifix-x86_64-linux-gnu.gz | gunzip -c - > /tmp/logifix
chmod +x /tmp/logifix
sudo mv /tmp/logifix /usr/local/bin

macosa

curl -L https://github.com/lyxell/logifix/releases/latest/download/logifix-x86_64-macos.gz | gunzip -c - > /tmp/logifix
chmod +x /tmp/logifix
sudo mv /tmp/logifix /usr/local/bin

2. Corre

• Ejecute logifix path/to/your/project en su terminal, ejecute logifix --help para obtener ayuda

¿Qué es logifix?

Logifix es un sistema de reescritura guiada por análisis para el código fuente Java. Esto significa que define (o usa los análisis y transformaciones predefinidas) que todos trabajan juntos para mejorar su código. Los análisis y transformaciones se escriben en el altamente declarativo DataLog de lenguaje lógico y son combinados y encadenados automáticamente por el motor de reescritura.

Características

Razonamiento equitativo inteligente

Logifix es más que un sistema de búsqueda y reemplazo. Realiza reescrituras en múltiples pasos y puede lograr un razonamiento equitativo inteligente al construir puntos de articulación en el gráfico de reescritura.

Velocidad

LOGIFIX se implementa en un dialecto de datos de alto rendimiento que se sintetiza en un código C ++ multiproceso. Está muy paralelo incluso cuando se trabaja en un solo archivo y generalmente analiza grandes proyectos de miles de archivos en unos pocos segundos en el hardware moderno. Si su proyecto tarda en analizar, se considera un error y debe presentar un informe de error.

Mierda

Logifix está diseñado para producir parches de forma humana que están listos para la fusión por diseño sin requerir modificaciones manuales.

Ejemplos

Aquí hay algunos ejemplos de parches generados por Logifix.

Arreglar la iteración ineficiente sobre el mapa#Keyset

  public static void sign(String token, Map<String, String> params) {
      List<String> list = new ArrayList();
      String tokenClientSlat = "";
-     for (String key : params.keySet()) {
+     for (Map.Entry<String, String> entry : params.entrySet()) {
+         String key = entry.getKey();
          if (key.equals("token_client_salt")) {
-             tokenClientSlat = params.get(key);
+             tokenClientSlat = entry.getValue();
          }
-         String paramString = key + "=" + params.get(key);
+         String paramString = key + "=" + entry.getValue();
          list.add(paramString);
      }
      Collections.sort(list);

Simplifique el código usando Try-With-Resources

          continue;
      } 
-     try {
-         JarFile nextJarFile = new JarFile(absNextFile);
-         try {
-             Attributes attrs = getMainAttrs(nextJarFile);
-             Set<Extension> newExtensions = getReferencedExtensions(attrs);
-             result.addAll(newExtensions);
-             filesToProcess.addAll(extensionsToFiles(newExtensions));
-         } finally {
-             nextJarFile.close();
-         }
+     try (JarFile nextJarFile = new JarFile(absNextFile)) {
+         Attributes attrs = getMainAttrs(nextJarFile);
+         Set<Extension> newExtensions = getReferencedExtensions(attrs);
+         result.addAll(newExtensions);
+         filesToProcess.addAll(extensionsToFiles(newExtensions));
      } catch (Exception e) {
          invalidLibPaths.append(nextFile.getPath()).append(" ");
      }

Simplifique el código usando map :: Computeifabsent

  private final Map<Class<?>, String> requestQueueNameCache = new ConcurrentHashMap<>();
     
  public String getRequestQueueName(Class<?> remoteInterface) {
-     String str = requestQueueNameCache.get(remoteInterface);
-     if (str == null) {
-         str = "{" + name + ":" + remoteInterface.getName() + "}";
-         requestQueueNameCache.put(remoteInterface, str);
-     }
-     return str;
+     return requestQueueNameCache.computeIfAbsent(remoteInterface, k -> "{" + name + ":" + k.getName() + "}");
  }

Simplificar el código usando transmisiones

  @Override
  public List<SpoonFile> getAllJavaFiles() {
-     List<SpoonFile> result = new ArrayList<>();
-
-     for (SpoonFile f : getAllFiles()) {
-         if (f.isJava()) {
-             result.add(f);
-         }
-     }
-
-     return result;
+     return getAllFiles().stream().filter(SpoonFile::isJava).collect(Collectors.toList());
  } 

Preguntas frecuentes

¿Dónde puedo encontrar las transformaciones predefinidas?

Consulte Docs/Transformaciones predefinidas.md o el código fuente SRC/Reglas.

¿Puedo crear mis propias transformaciones?

¡Sí! Ver Docs/Creación de tu propia Trayformations.md.

¿Cómo construyo desde la fuente?

Ver docs/edificio.md.

Proyectos relacionados

Si encuentra interesante este proyecto, asegúrese de verlos también:

• Souffle -Lang/Souffle: el compilador de datos utilizado por logifix
• Egraphs -Good/Egg: una buena biblioteca para la saturación de igualdad eficiente de los sistemas de reescritura
• Comby-Tools/Comby: una herramienta de búsqueda y reemplazo basada en AST de peso ligero