GNOME.org
 

[gnome-builder/wip/gtk4-port] plugins/rubocop: port rubocop plugin to C

commit d56372a3c72e0e7fd9935af952b68c4f7ba617ef
Author: Christian Hergert <chergert redhat com>
Date:   Wed May 25 21:42:25 2022 -0700

    plugins/rubocop: port rubocop plugin to C
    
    Related #1670

 .../rubocop/gbp-rubocop-diagnostic-provider.c      | 194 +++++++++++++++++++++
 .../rubocop/gbp-rubocop-diagnostic-provider.h      |  31 ++++
 src/plugins/rubocop/meson.build                    |  19 +-
 src/plugins/rubocop/rubocop-plugin.c               |  37 ++++
 src/plugins/rubocop/rubocop.gresource.xml          |   6 +
 src/plugins/rubocop/rubocop.plugin                 |  14 +-
 src/plugins/rubocop/rubocop_plugin.py              |  94 ----------
 7 files changed, 286 insertions(+), 109 deletions(-)
---
diff --git a/src/plugins/rubocop/gbp-rubocop-diagnostic-provider.c 
b/src/plugins/rubocop/gbp-rubocop-diagnostic-provider.c
new file mode 100644
index 000000000..496b58c89
--- /dev/null
+++ b/src/plugins/rubocop/gbp-rubocop-diagnostic-provider.c
@@ -0,0 +1,194 @@
+/* gbp-rubocop-diagnostic-provider.c
+ *
+ * Copyright 2021 Jeremy Wilkins <jeb jdwilkins co uk>
+ * Copyright 2022 Veli Tasalı <me velitasali com>
+ * Copyright 2022 Christian Hergert <chergert redhat com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#define G_LOG_DOMAIN "gbp-rubocop-diagnostic-provider"
+
+#include "config.h"
+
+#include <json-glib/json-glib.h>
+
+#include "gbp-rubocop-diagnostic-provider.h"
+
+struct _GbpRubocopDiagnosticProvider
+{
+  IdeDiagnosticTool parent_instance;
+  guint is_stdin : 1;
+};
+
+static void
+gbp_rubocop_diagnostic_provider_configure_launcher (IdeDiagnosticTool     *tool,
+                                                    IdeSubprocessLauncher *launcher,
+                                                    GFile                 *file,
+                                                    GBytes                *contents,
+                                                    const char            *language_id)
+{
+  GbpRubocopDiagnosticProvider *self = (GbpRubocopDiagnosticProvider *)tool;
+
+  g_assert (GBP_IS_RUBOCOP_DIAGNOSTIC_PROVIDER (self));
+  g_assert (IDE_IS_SUBPROCESS_LAUNCHER (launcher));
+  g_assert (G_IS_FILE (file));
+
+  ide_subprocess_launcher_push_args (launcher, IDE_STRV_INIT ("--format", "json"));
+  self->is_stdin = contents != NULL;
+  if (self->is_stdin)
+    ide_subprocess_launcher_push_argv (launcher, "--stdin");
+  ide_subprocess_launcher_push_argv (launcher, g_file_peek_path (file));
+}
+
+static IdeDiagnosticSeverity
+parse_severity (const char *str)
+{
+  if (ide_str_empty0 (str) ||
+      ide_str_equal0 (str, "info") ||
+      ide_str_equal0 (str, "refactor") ||
+      ide_str_equal0 (str, "convention"))
+    return IDE_DIAGNOSTIC_NOTE;
+
+  if (ide_str_equal0 (str, "warning"))
+    return IDE_DIAGNOSTIC_WARNING;
+
+  if (ide_str_equal0 (str, "error"))
+    return IDE_DIAGNOSTIC_ERROR;
+
+  if (ide_str_equal0 (str, "fatal"))
+    return IDE_DIAGNOSTIC_FATAL;
+
+  return IDE_DIAGNOSTIC_NOTE;
+}
+
+static void
+gbp_rubocop_diagnostic_provider_populate_diagnostics (IdeDiagnosticTool *tool,
+                                                      IdeDiagnostics    *diagnostics,
+                                                      GFile             *file,
+                                                      const char        *stdout_buf,
+                                                      const char        *stderr_buf)
+{
+  GbpRubocopDiagnosticProvider *self = (GbpRubocopDiagnosticProvider *)tool;
+  g_autoptr(JsonParser) parser = NULL;
+  g_autoptr(GError) error = NULL;
+  JsonObject *root_obj;
+  JsonNode *root;
+  JsonArray *files;
+
+  g_assert (GBP_IS_RUBOCOP_DIAGNOSTIC_PROVIDER (self));
+  g_assert (IDE_IS_DIAGNOSTICS (diagnostics));
+  g_assert (G_IS_FILE (file));
+
+  if (ide_str_empty0 (stdout_buf))
+    return;
+
+  parser = json_parser_new ();
+
+  if (!json_parser_load_from_data (parser, stdout_buf, -1, &error))
+    {
+      g_debug ("%s", error->message);
+      return;
+    }
+
+
+  if ((root = json_parser_get_root (parser)) &&
+      JSON_NODE_HOLDS_OBJECT (root) &&
+      (root_obj = json_node_get_object (root)) &&
+      (files = json_object_get_array_member (root_obj, "files")))
+    {
+      guint n_files = json_array_get_length (files);
+
+      for (guint i = 0; i < n_files; i++)
+        {
+          JsonObject *item = json_array_get_object_element (files, i);
+          JsonArray *offenses = json_object_get_array_member (item, "offenses");
+          guint n_offenses = json_array_get_length (offenses);
+
+          for (guint j = 0; j < n_offenses; j++)
+            {
+              g_autoptr(IdeDiagnostic) diagnostic = NULL;
+              g_autoptr(IdeLocation) start = NULL;
+              g_autoptr(IdeLocation) end = NULL;
+              g_autofree char *full_message = NULL;
+              JsonObject *offense = json_array_get_object_element (offenses, j);
+              JsonObject *location;
+              IdeDiagnosticSeverity severity;
+              const char *message;
+              guint start_line;
+              guint start_col;
+              guint end_line;
+              guint end_col;
+
+              if (!json_object_has_member (offense, "location"))
+                continue;
+
+              location = json_object_get_object_member (offense, "location");
+
+              if (!json_object_has_member (location, "start_line") ||
+                  !json_object_has_member (location, "start_column"))
+                continue;
+
+              start_line = MAX (json_object_get_int_member (location, "start_line") - 1, 0);
+              start_col = MAX (json_object_get_int_member (location, "start_column") - 1, 0);
+              start = ide_location_new (file, start_line, start_col);
+
+              if (json_object_has_member (location, "last_line"))
+                {
+                  end_line = MAX (json_object_get_int_member (location, "last_line") - 1, 0);
+                  end_col = MAX (json_object_get_int_member (location, "last_column") - 1, 0);
+                  end = ide_location_new (file, end_line, end_col);
+                }
+              else
+                {
+                  end_line = start_line;
+                  end_col = start_col + json_object_get_int_member (location, "length");
+                  end = ide_location_new (file, end_line, end_col);
+                }
+
+              severity = parse_severity (json_object_get_string_member (offense, "severity"));
+              message = json_object_get_string_member (offense, "message");
+
+              if (self->is_stdin)
+                {
+                  const char *cop_name = json_object_get_string_member (offense, "cop_name");
+                  message = full_message = g_strdup_printf ("%s: %s", cop_name, message);
+                }
+
+              diagnostic = ide_diagnostic_new (severity, message, start);
+              ide_diagnostic_take_range (diagnostic, ide_range_new (start, end));
+              ide_diagnostics_add (diagnostics, diagnostic);
+            }
+        }
+    }
+}
+
+G_DEFINE_FINAL_TYPE (GbpRubocopDiagnosticProvider, gbp_rubocop_diagnostic_provider, IDE_TYPE_DIAGNOSTIC_TOOL)
+
+static void
+gbp_rubocop_diagnostic_provider_class_init (GbpRubocopDiagnosticProviderClass *klass)
+{
+  IdeDiagnosticToolClass *diagnostic_tool_class = IDE_DIAGNOSTIC_TOOL_CLASS (klass);
+
+  diagnostic_tool_class->configure_launcher = gbp_rubocop_diagnostic_provider_configure_launcher;
+  diagnostic_tool_class->populate_diagnostics = gbp_rubocop_diagnostic_provider_populate_diagnostics;
+}
+
+static void
+gbp_rubocop_diagnostic_provider_init (GbpRubocopDiagnosticProvider *self)
+{
+  ide_diagnostic_tool_set_program_name (IDE_DIAGNOSTIC_TOOL (self), "rubocop");
+}
diff --git a/src/plugins/rubocop/gbp-rubocop-diagnostic-provider.h 
b/src/plugins/rubocop/gbp-rubocop-diagnostic-provider.h
new file mode 100644
index 000000000..e7b6e5b9a
--- /dev/null
+++ b/src/plugins/rubocop/gbp-rubocop-diagnostic-provider.h
@@ -0,0 +1,31 @@
+/* gbp-rubocop-diagnostic-provider.h
+ *
+ * Copyright 2022 Christian Hergert <chergert redhat com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#pragma once
+
+#include <libide-foundry.h>
+
+G_BEGIN_DECLS
+
+#define GBP_TYPE_RUBOCOP_DIAGNOSTIC_PROVIDER (gbp_rubocop_diagnostic_provider_get_type())
+
+G_DECLARE_FINAL_TYPE (GbpRubocopDiagnosticProvider, gbp_rubocop_diagnostic_provider, GBP, 
RUBOCOP_DIAGNOSTIC_PROVIDER, IdeDiagnosticTool)
+
+G_END_DECLS
diff --git a/src/plugins/rubocop/meson.build b/src/plugins/rubocop/meson.build
index 9dd9c844c..34e726762 100644
--- a/src/plugins/rubocop/meson.build
+++ b/src/plugins/rubocop/meson.build
@@ -1,13 +1,16 @@
 if get_option('plugin_rubocop')
 
-install_data('rubocop_plugin.py', install_dir: plugindir)
-
-configure_file(
-          input: 'rubocop.plugin',
-         output: 'rubocop.plugin',
-  configuration: config_h,
-        install: true,
-    install_dir: plugindir,
+plugins_sources += files([
+  'rubocop-plugin.c',
+  'gbp-rubocop-diagnostic-provider.c',
+])
+
+plugin_rubocop_resources = gnome.compile_resources(
+  'rubocop-resources',
+  'rubocop.gresource.xml',
+  c_name: 'gbp_rubocop',
 )
 
+plugins_sources += plugin_rubocop_resources
+
 endif
diff --git a/src/plugins/rubocop/rubocop-plugin.c b/src/plugins/rubocop/rubocop-plugin.c
new file mode 100644
index 000000000..269c53a63
--- /dev/null
+++ b/src/plugins/rubocop/rubocop-plugin.c
@@ -0,0 +1,37 @@
+/* rubocop-plugin.c
+ *
+ * Copyright 2022 Christian Hergert <chergert redhat com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#define G_LOG_DOMAIN "rubocop-plugin"
+
+#include "config.h"
+
+#include <libpeas/peas.h>
+
+#include <libide-code.h>
+
+#include "gbp-rubocop-diagnostic-provider.h"
+
+_IDE_EXTERN void
+_gbp_rubocop_register_types (PeasObjectModule *module)
+{
+  peas_object_module_register_extension_type (module,
+                                              IDE_TYPE_DIAGNOSTIC_PROVIDER,
+                                              GBP_TYPE_RUBOCOP_DIAGNOSTIC_PROVIDER);
+}
diff --git a/src/plugins/rubocop/rubocop.gresource.xml b/src/plugins/rubocop/rubocop.gresource.xml
new file mode 100644
index 000000000..2e55dcddc
--- /dev/null
+++ b/src/plugins/rubocop/rubocop.gresource.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<gresources>
+  <gresource prefix="/plugins/rubocop">
+    <file>rubocop.plugin</file>
+  </gresource>
+</gresources>
diff --git a/src/plugins/rubocop/rubocop.plugin b/src/plugins/rubocop/rubocop.plugin
index 17dd393f2..5f082173f 100644
--- a/src/plugins/rubocop/rubocop.plugin
+++ b/src/plugins/rubocop/rubocop.plugin
@@ -1,11 +1,11 @@
 [Plugin]
-Authors=Jeremy Wilkins <jeb jdwilkins co uk>
-Copyright=Copyright © 2021 Jeremy Wilkins <jeb jdwilkins co uk>
-Description=Provides Ruby linting using Rubocop
-Loader=python3
-Hidden=true
-Module=rubocop_plugin
-Name=rubocop
+Authors=Jeremy Wilkins <jeb jdwilkins co uk>, Christian Hergert <chergert redhat com>
+Copyright=Copyright © 2021 Jeremy Wilkins <jeb jdwilkins co uk>, Copyright © 2022 Christian Hergert
+Description=Provides linting for Ruby files using Rubocop
+Embedded=_gbp_rubocop_register_types
+Module=rubocop
+Name=Rubocop
+X-Category=diagnostics
 X-Diagnostic-Provider-Languages-Priority=100
 X-Diagnostic-Provider-Languages=ruby
 X-Builder-ABI=@PACKAGE_ABI@
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]