logifix

Logifix

O Logifix é uma ferramenta baseada em dados para corrigir automaticamente violações de análise estática no código-fonte Java. O Logifix pode ser usado para corrigir violações de análise estática para analisadores estáticos como Sonarqube, PMD ou Spotbugs, mas também para modernizar o código legado ou mesmo para aplicar automaticamente regras personalizadas específicas à sua base de código.

Demonstração

Demo.MP4

Começando

1. Instale

Os binários pré-construídos e sem dependência são fornecidos para os sistemas MacOS e Linux baseados em 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

macos

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. Corra

• Execute logifix path/to/your/project em seu terminal, execute logifix --help para obter ajuda

O que é logifix?

O Logifix é um sistema de reescrita guiado por análise para o código-fonte Java. Isso significa que você define (ou usa as análises predefinidas) e transformações que trabalham juntas para melhorar seu código. As análises e transformações são escritas no Datalog de Idiomas baseado em lógica altamente declarativo e são combinadas e encadeadas automaticamente pelo mecanismo de reescrita.

Características

Raciocínio equacional inteligente

O Logifix é mais do que um sistema de pesquisa e substituição. Ele realiza reescritas em várias etapas e pode obter um raciocínio equacional inteligente, construindo pontos de articulação no gráfico de reescrita.

Velocidade

O Logifix é implementado em um dialeto de dados de alto desempenho que é sintetizado em código C ++ multithread. É muito paralelo, mesmo quando trabalha em um único arquivo e geralmente analisa grandes projetos de milhares de arquivos em alguns segundos no hardware moderno. Se o seu projeto demorar a analisá -lo, é considerado um bug e você deve registrar um relatório de bug.

Mergeability

O Logifix é projetado para produzir patches semelhantes a humanos que estão prontos para Merge por design sem a necessidade de modificações manuais.

Exemplos

Aqui estão alguns exemplos de patches gerados pelo Logifix.

Corrija a iteração ineficiente sobre o 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 o código usando o 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 o código usando o mapa :: 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() + "}");
  }

Simplifique o código usando fluxos

  @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());
  } 

Perguntas frequentes

Onde posso encontrar as transformações predefinidas?

Consulte Docs/Predefined-Transformations.MD ou o código-fonte SRC/Regras.

Posso criar minhas próprias transformações?

Sim! Consulte Docs/Creation-Your-Out-Transformations.MD.

Como faço para construir a partir da fonte?

Consulte Docs/Building.MD.

Projetos relacionados

Se você achar este projeto interessante, não deixe de conferir isso também:

• Souffle -Lang/Souffle - o compilador de dados usado pelo Logifix
• Egraphs -Good/Egg - Uma bela biblioteca para saturação de igualdade eficiente de sistemas de reescrita
• Comby-Tools/Comby-Uma ferramenta leve de pesquisa e substituição baseada em AST