Merge pull request #105 from nobodywasishere/nobody/ameba-and-fixes

Add support for ameba + minor bugfixes

Author: elbywan

.ameba.yml

@@ -0,0 +1,50 @@
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/ParenthesesAroundCondition:
+  Description: Disallows redundant parentheses around control expressions
+  ExcludeTernary: false
+  AllowSafeAssignment: true
+  Enabled: true
+  Severity: Convention
+
+Documentation/DocumentationAdmonition:
+  Enabled: false
+  Severity: Warning
+
+Lint/NotNil:
+  Description: Identifies usage of `not_nil!` calls
+  Excluded:
+    - src/crystalline/analysis/analysis.cr
+    - src/crystalline/result_cache.cr
+    - src/crystalline/workspace.cr
+  Enabled: true
+  Severity: Warning
+
+Naming/BlockParameterName:
+  Enabled: false
+  Severity: Convention
+
+Lint/RedundantStringCoercion:
+  Description: Disallows redundant string conversions in interpolation
+  Enabled: true
+  Severity: Warning
+
+Lint/ShadowingOuterLocalVar:
+  Description:
+    Disallows the usage of the same name as outer local variables for block
+    or proc arguments
+  Excluded:
+    - src/crystalline/ext/compiler.cr
+  Enabled: true
+  Severity: Warning
+
+Naming/QueryBoolMethods:
+  Description: Reports boolean properties without the `?` suffix
+  Enabled: false
+  Severity: Convention
+
+Style/WhileTrue:
+  Description: Disallows while statements with a true literal as condition
+  Enabled: false
+  Severity: Convention

.github/workflows/crystal-ameba.yml

@@ -0,0 +1,48 @@
+name: Crystal Ameba
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "**/*.cr"
+  pull_request:
+    branches:
+      - master
+    paths:
+      - "**/*.cr"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ameba-version: [v1.6.4]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Crystal
+        uses: crystal-lang/install-crystal@v1
+
+      - name: Cache Ameba binary
+        id: cache-ameba
+        uses: actions/cache@v3
+        with:
+          path: bin/ameba
+          key: ${{ runner.os }}-ameba-${{ matrix.ameba-version }}
+
+      - name: Build Ameba
+        if: steps.cache-ameba.outputs.cache-hit != 'true'
+        run: |
+          git clone --branch ${{ matrix.ameba-version }} --single-branch https://github.com/crystal-ameba/ameba.git
+          cd ameba
+          make bin/ameba CRFLAGS='-Dpreview_mt --no-debug'
+          mkdir -p ../bin
+          mv bin/ameba ../bin/ameba
+          cd ..
+          rm -rf ameba
+
+      - name: Run Ameba Linter
+        run: bin/ameba -c .ameba.yml

src/crystalline/analysis/analysis.cr

@@ -51,7 +51,7 @@ module Crystalline::Analysis
       compiler.stderr = dev_null
       compiler.flags = compiler_flags
 
-      if lib_path_override = lib_path
+      if (lib_path_override = lib_path)
         path = Crystal::CrystalPath.default_path_without_lib.split(Process::PATH_DELIMITER)
         path.insert(0, lib_path_override)
         compiler.crystal_path = Crystal::CrystalPath.new(path)
@@ -123,13 +123,13 @@ module Crystalline::Analysis
       LSP::Log.debug { "Class of node at cursor: #{node.class} " }
       locations = begin
         if node.is_a? Crystal::Call
-          if defs = node.target_defs
+          if (defs = node.target_defs)
             defs.compact_map { |d|
               start_location = d.location.try { |loc| loc.expanded_location || loc }.not_nil!
               end_location = d.end_location.try { |loc| loc.expanded_location || loc }.not_nil!
               {start_location, end_location}
             }
-          elsif expanded_macro = node.expanded_macro
+          elsif (expanded_macro = node.expanded_macro)
             start_location = expanded_macro.location.try { |loc| loc.expanded_location || loc }.not_nil!
             end_location = expanded_macro.end_location.try { |loc| loc.expanded_location || loc } || start_location
             [{start_location, end_location}]
@@ -152,18 +152,18 @@ module Crystalline::Analysis
         elsif node.is_a? Crystal::Union
           Utils.locations_from_union(node, nodes)
         elsif node.is_a? Crystal::Var
-          if definition = context[node.to_s]?
+          if (definition = context[node.to_s]?)
             _, location = definition
             [{location, location}] if location
           end
         elsif node.is_a? Crystal::InstanceVar
-          if ivar = context["self"]?.try &.[0].try &.lookup_instance_var? node.name
-            if location = ivar.location
+          if (ivar = context["self"]?.try &.[0].try &.lookup_instance_var? node.name)
+            if (location = ivar.location)
               [{location, location}]
             end
           end
         elsif node.is_a? Crystal::ClassVar
-          if cvar = context["self"]?.try &.[0].try &.all_class_vars[node.name]? # lookup_raw_class_var? node.name
+          if (cvar = context["self"]?.try &.[0].try &.all_class_vars[node.name]?) # lookup_raw_class_var? node.name
             if (location = cvar.location)
               [{location, location}]
             end

src/crystalline/analysis/cursor_visitor.cr

@@ -75,7 +75,7 @@ module Crystalline::Analysis
     end
 
     def visit(node)
-      if node_location = node.location
+      if (node_location = node.location)
         node_end_location = nearest_end_location(node)
 
         if @top_level

src/crystalline/analysis/symbols_visitor.cr

@@ -21,7 +21,7 @@ module Crystalline::Analysis
       (@parent_symbol.try(&.children) || @symbols) << symbol
     end
 
-    private def with_parent(symbol : LSP::DocumentSymbol)
+    private def with_parent(symbol : LSP::DocumentSymbol, &)
       append_symbol(symbol)
       old_parent = @parent_symbol
       @parent_symbol = symbol
@@ -91,7 +91,7 @@ module Crystalline::Analysis
     end
 
     def visit(node : Crystal::Arg)
-      if (@parent_symbol.try &.kind.enum?)
+      if @parent_symbol.try &.kind.enum?
         symbol = create_symbol_from_node(node, :enum_member)
         append_symbol(symbol)
       end

src/crystalline/broken_source_fixer.cr

@@ -65,7 +65,7 @@ class Crystalline::BrokenSourceFixer
       end
     end
 
-    while line_info = stack.pop?
+    while (line_info = stack.pop?)
       lines[-1] = "#{lines[-1]}; #{closing_keyword(line_info)}"
     end
 
@@ -142,7 +142,7 @@ class Crystalline::BrokenSourceFixer
     keyword : String?,
     closing_keyword : String?,
     last_info : LineInfo,
-    line : String
+    line : String,
   )
     # If the indent is less than the opening one it's definitely wrong.
     if indent < last_info.indent

src/crystalline/controller.cr

@@ -21,7 +21,7 @@ class Crystalline::Controller
     # Compile the workspace at once.
     spawn same_thread: true do
       workspace.projects.each do |p|
-        if entry_point = p.entry_point?
+        if (entry_point = p.entry_point?)
           workspace.compile(@server, entry_point)
         end
       end

src/crystalline/ext/compiler.cr

@@ -18,7 +18,7 @@ module Crystal
   class SemanticVisitor < Visitor
     # Make it possible to visit in-memory.
     def visit(node : Require)
-      if expanded = node.expanded
+      if (expanded = node.expanded)
         expanded.accept self
         return false
       end
@@ -103,7 +103,7 @@ module Crystal
     # Will not raise if the semantic analysis fails.
     def error_tolerant_semantic(node : ASTNode, cleanup = true) : ASTNode
       node, processor = top_level_semantic(node)
-      error_tolerant = true
+      @error_tolerant = true
       error_stack.clear
 
       begin

src/crystalline/project.cr

@@ -75,7 +75,6 @@ class Crystalline::Project
   # Finds the path-wise distance to the given file URI. If the file URI is not a
   # dependency of this workspace's entry point, returns nil.
   def distance_to_dependency(file_uri : URI) : Int32?
-    file_path = file_uri.decoded_path
     relative = Path[file_uri.decoded_path].relative_to?(root_uri.decoded_path)
 
     # If we can't get a relative path, give it the maximum distance possible, so

src/crystalline/text_document.cr

@@ -25,9 +25,7 @@ class Crystalline::TextDocument
     @inner_contents.size
   end
 
-  alias ContentChange = {contents: String, range: LSP::Range?}
-
-  def update_contents(content_changes = Array(ContentChange), version : Number? = nil)
+  def update_contents(content_changes : Array({String, LSP::Range?}), version : Number? = nil)
     content_changes.each { |change|
       update_contents(*change, version: version)
     }