Merge pull request #165 from noir-cr/hahwul-dev

Add ruby_hanami detector/analyzer (#162)

README.md

@@ -29,6 +29,7 @@
 | Python   | FastAPI         | ✅  | ✅     | ✅    | ✅     | ✅ |
 | Ruby     | Rails           | ✅  | ✅     | ✅    | ✅     | X  |
 | Ruby     | Sinatra         | ✅  | ✅     | ✅    | ✅     | X  |
+| Ruby     | Hanami          | ✅  | ✅     |       |        | X  |
 | Php      |                 | ✅  | ✅     | ✅    | ✅     | X  |
 | Java     | Jsp             | ✅  | ✅     | ✅    | X      | X  |
 | Java     | Armeria         | ✅  | ✅     | X     | X      | X  |

spec/functional_test/fixtures/ruby_hanami/Gemfile

@@ -0,0 +1,31 @@
+source "https://rubygems.org"
+ruby "3.2.2"
+
+gem "hanami", "~> 2.0"
+gem "hanami-router", "~> 2.0"
+gem "hanami-controller", "~> 2.0"
+gem "hanami-validations", "~> 2.0"
+
+gem "dry-types", "~> 1.0", ">= 1.6.1"
+gem "puma"
+gem "rake"
+
+group :development, :test do
+  gem "dotenv"
+end
+
+group :cli, :development do
+  gem "hanami-reloader"
+end
+
+group :cli, :development, :test do
+  gem "hanami-rspec"
+end
+
+group :development do
+  gem "guard-puma", "~> 0.8"
+end
+
+group :test do
+  gem "rack-test"
+end

spec/functional_test/fixtures/ruby_hanami/app/action.rb

@@ -0,0 +1,9 @@
+# auto_register: false
+# frozen_string_literal: true
+
+require "hanami/action"
+
+module Testapp
+  class Action < Hanami::Action
+  end
+end

spec/functional_test/fixtures/ruby_hanami/config/routes.rb

@@ -0,0 +1,12 @@
+module Testapp
+  class Routes < Hanami::Routes
+    root { "Hello from Hanami" }
+
+    get "/books", to: "books.index"
+    get "/books/:id", to: "books.show"
+    get "/books/new", to: "books.new"
+    post "/books", to: "books.create"
+    patch "/books/:id", to: "books.update"
+    delete "/books/:id", to: "books.destroy"
+  end
+end

spec/functional_test/testers/ruby_hanami_spec.cr

@@ -0,0 +1,15 @@
+require "../func_spec.cr"
+
+extected_endpoints = [
+  Endpoint.new("/books", "GET"),
+  Endpoint.new("/books/:id", "GET"),
+  Endpoint.new("/books/new", "GET"),
+  Endpoint.new("/books", "POST"),
+  Endpoint.new("/books/:id", "PATCH"),
+  Endpoint.new("/books/:id", "DELETE"),
+]
+
+FunctionalTester.new("fixtures/ruby_hanami/", {
+  :techs     => 1,
+  :endpoints => 6,
+}, extected_endpoints).test_all

src/analyzer/analyzer.cr

@@ -4,6 +4,7 @@ def initialize_analyzers(logger : NoirLogger)
   analyzers = {} of String => Proc(Hash(Symbol, String), Array(Endpoint))
   analyzers["ruby_rails"] = ->analyzer_rails(Hash(Symbol, String))
   analyzers["ruby_sinatra"] = ->analyzer_sinatra(Hash(Symbol, String))
+  analyzers["ruby_hanami"] = ->analyzer_hanami(Hash(Symbol, String))
   analyzers["java_spring"] = ->analyzer_spring(Hash(Symbol, String))
   analyzers["kotlin_spring"] = ->analyzer_spring(Hash(Symbol, String))
   analyzers["java_armeria"] = ->analyzer_armeria(Hash(Symbol, String))

src/analyzer/analyzers/analyzer_hanami.cr

@@ -0,0 +1,73 @@
+require "../../models/analyzer"
+
+class AnalyzerHanami < Analyzer
+  def analyze
+    # Config Analysis
+    if File.exists?("#{@base_path}/config/routes.rb")
+      File.open("#{@base_path}/config/routes.rb", "r", encoding: "utf-8", invalid: :skip) do |file|
+        last_endpoint = Endpoint.new("", "")
+        file.each_line do |line|
+          endpoint = line_to_endpoint(line)
+          if endpoint.method != ""
+            @result << endpoint
+            last_endpoint = endpoint
+            _ = last_endpoint
+          end
+        end
+      end
+    end
+
+    @result
+  end
+
+  def line_to_endpoint(content : String) : Endpoint
+    content.scan(/get\s+['"](.+?)['"]/) do |match|
+      if match.size > 1
+        return Endpoint.new("#{@url}#{match[1]}", "GET")
+      end
+    end
+
+    content.scan(/post\s+['"](.+?)['"]/) do |match|
+      if match.size > 1
+        return Endpoint.new("#{@url}#{match[1]}", "POST")
+      end
+    end
+
+    content.scan(/put\s+['"](.+?)['"]/) do |match|
+      if match.size > 1
+        return Endpoint.new("#{@url}#{match[1]}", "PUT")
+      end
+    end
+
+    content.scan(/delete\s+['"](.+?)['"]/) do |match|
+      if match.size > 1
+        return Endpoint.new("#{@url}#{match[1]}", "DELETE")
+      end
+    end
+
+    content.scan(/patch\s+['"](.+?)['"]/) do |match|
+      if match.size > 1
+        return Endpoint.new("#{@url}#{match[1]}", "PATCH")
+      end
+    end
+
+    content.scan(/head\s+['"](.+?)['"]/) do |match|
+      if match.size > 1
+        return Endpoint.new("#{@url}#{match[1]}", "HEAD")
+      end
+    end
+
+    content.scan(/options\s+['"](.+?)['"]/) do |match|
+      if match.size > 1
+        return Endpoint.new("#{@url}#{match[1]}", "OPTIONS")
+      end
+    end
+
+    Endpoint.new("", "")
+  end
+end
+
+def analyzer_hanami(options : Hash(Symbol, String))
+  instance = AnalyzerHanami.new(options)
+  instance.analyze
+end

src/detector/detector.cr

@@ -15,7 +15,7 @@ def detect_techs(base_path : String, options : Hash(Symbol, String), logger : No
   defind_detectors([
     DetectorCrystalKemal, DetectorGoEcho, DetectorJavaJsp, DetectorJavaSpring, DetectorJsExpress,
     DetectorPhpPure, DetectorPythonDjango, DetectorPythonFlask, DetectorPythonFastAPI,
-    DetectorRubyRails, DetectorRubySinatra, DetectorOas2, DetectorOas3, DetectorRAML,
+    DetectorRubyRails, DetectorRubySinatra, DetectorRubyHanami, DetectorOas2, DetectorOas3, DetectorRAML,
     DetectorGoGin, DetectorKotlinSpring, DetectorJavaArmeria, DetectorCSharpAspNetMvc,
     DetectorRustAxum,
   ])

src/detector/detectors/ruby_hanami.cr

@@ -0,0 +1,15 @@
+require "../../models/detector"
+
+class DetectorRubyHanami < Detector
+  def detect(filename : String, file_contents : String) : Bool
+    check = file_contents.includes?("gem 'hanami'")
+    check = check || file_contents.includes?("gem \"hanami\"")
+    check = check && filename.includes?("Gemfile")
+
+    check
+  end
+
+  def set_name
+    @name = "ruby_hanami"
+  end
+end

src/techs/techs.cr

@@ -75,6 +75,11 @@ module NoirTechs
       :framework => "Sinatra",
       :similar   => ["sinatra", "ruby-sinatra", "ruby_sinatra"],
     },
+    :ruby_hanami => {
+      :language  => "Ruby",
+      :framework => "Hanami",
+      :similar   => ["hanami", "ruby-hanami", "ruby_hanami"],
+    },
     :rust_axum => {
       :language  => "Rust",
       :framework => "Axum",