bump ameba 1.6.4 (#33)

DMarinhoCodacy · web-flow · commit 35da27de2e27 · 2025-03-28T10:57:56.000Z
* bump ameba 1.6.4
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,13 +1,13 @@
 version: 2.1
 
 orbs:
-  codacy: codacy/base@10.8.0
-  codacy_plugins_test: codacy/plugins-test@1.1.1
+  codacy: codacy/base@12.1.5
+  codacy_plugins_test: codacy/plugins-test@2.0.11
 
 jobs:
   unit_test:
     docker: # run the steps with Docker
-      - image: crystallang/crystal:1.8.2
+      - image: crystallang/crystal:1.15
     working_directory: ~/workdir
     steps:
       - attach_workspace:
diff --git a/.dockerignore b/.dockerignore
@@ -2,4 +2,5 @@
 bin
 lib
 spec
-**/.DS_Store
+**/.DS_Store
+.idea/
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 /.shards/
 *.dwarf
 .DS_Store
+.idea/
diff --git a/Dockerfile b/Dockerfile
@@ -1,10 +1,10 @@
-FROM crystallang/crystal:1.10.1-alpine as builder
+FROM crystallang/crystal:1.15-alpine as builder
 WORKDIR /tmp/build
 COPY . /tmp/build
-RUN shards build --production
+RUN shards build --production --release -Dpreview_mt
 
 # To test on M1 macs use: --platform=linux/amd64
-FROM alpine:3.18
+FROM alpine:3.21
 RUN apk add yaml pcre2 gc libevent libgcc
 COPY docs /docs
 COPY --from=builder /tmp/build/bin/codacy-ameba /opt/app/
diff --git a/docs/description/Documentation_Documentation.md b/docs/description/Documentation_Documentation.md
@@ -4,7 +4,7 @@ modules, classes, enums, methods and macros.
 YAML configuration example:
 
 ```
-Lint/Documentation:
+Documentation/Documentation:
   Enabled: true
   IgnoreClasses: false
   IgnoreModules: true
diff --git a/docs/description/Documentation_DocumentationAdmonition.md b/docs/description/Documentation_DocumentationAdmonition.md
@@ -0,0 +1,33 @@
+A rule that reports documentation admonitions.
+
+Optionally, these can fail at an appropriate time.
+
+```
+def get_user(id)
+  # TODO(2024-04-24) Fix this hack when the database migration is complete
+  if id < 1_000_000
+    v1_api_call(id)
+  else
+    v2_api_call(id)
+  end
+end
+```
+
+`TODO` comments are used to remind yourself of source code related things.
+
+The premise here is that `TODO` should be dealt with in the near future
+and are therefore reported by Ameba.
+
+`FIXME` comments are used to indicate places where source code needs fixing.
+
+The premise here is that `FIXME` should indeed be fixed as soon as possible
+and are therefore reported by Ameba.
+
+YAML configuration example:
+
+```
+Documentation/DocumentationAdmonition:
+  Enabled: true
+  Admonitions: [TODO, FIXME, BUG]
+  Timezone: UTC
+```
diff --git a/docs/description/Lint_NotNilAfterNoBang.md b/docs/description/Lint_NotNilAfterNoBang.md
@@ -1,16 +1,16 @@
-This rule is used to identify usage of `index/rindex/find` calls
+This rule is used to identify usage of `index/rindex/find/match` calls
 followed by a call to `not_nil!`.
 
 For example, this is considered a code smell:
 
 ```
-%w[Alice Bob].find(&.match(/^A./)).not_nil!
+%w[Alice Bob].find(&.chars.any?(&.in?('o', 'b'))).not_nil!
 ```
 
 And can be written as this:
 
 ```
-%w[Alice Bob].find!(&.match(/^A./))
+%w[Alice Bob].find!(&.chars.any?(&.in?('o', 'b')))
 ```
 
 YAML configuration example:
diff --git a/docs/description/Lint_PercentArrays.md b/docs/description/Lint_PercentArrays.md
@@ -3,15 +3,15 @@ A rule that disallows some unwanted symbols in percent array literals.
 For example, this is usually written by mistake:
 
 ```
-%i(:one, :two)
-%w("one", "two")
+%i[:one, :two]
+%w["one", "two"]
 ```
 
 And the expected example is:
 
 ```
-%i(one two)
-%w(one two)
+%i[one two]
+%w[one two]
 ```
 
 YAML configuration example:
diff --git a/docs/description/Lint_SpecFilename.md b/docs/description/Lint_SpecFilename.md
@@ -0,0 +1,10 @@
+A rule that enforces spec filenames to have `_spec` suffix.
+
+YAML configuration example:
+
+```
+Lint/SpecFilename:
+  Enabled: true
+  IgnoredDirs: [spec/support spec/fixtures spec/data]
+  IgnoredFilenames: [spec_helper]
+```
diff --git a/docs/description/Lint_Typos.md b/docs/description/Lint_Typos.md
@@ -0,0 +1,13 @@
+A rule that reports typos found in source files.
+
+NOTE: Needs [typos](https://github.com/crate-ci/typos) CLI tool.
+NOTE: See the chapter on [false positives](https://github.com/crate-ci/typos#false-positives).
+
+YAML configuration example:
+
+```
+Lint/Typos:
+  Enabled: true
+  BinPath: ~
+  FailOnError: false
+```
diff --git a/docs/description/Lint_UselessAssign.md b/docs/description/Lint_UselessAssign.md
@@ -23,4 +23,5 @@ YAML configuration example:
 ```
 Lint/UselessAssign:
   Enabled: true
+  ExcludeTypeDeclarations: false
 ```
diff --git a/docs/description/Naming_AccessorMethodName.md b/docs/description/Naming_AccessorMethodName.md
@@ -0,0 +1,36 @@
+A rule that makes sure that accessor methods are named properly.
+
+Favour this:
+
+```
+class Foo
+  def user
+    @user
+  end
+
+  def user=(value)
+    @user = value
+  end
+end
+```
+
+Over this:
+
+```
+class Foo
+  def get_user
+    @user
+  end
+
+  def set_user(value)
+    @user = value
+  end
+end
+```
+
+YAML configuration example:
+
+```
+Naming/AccessorMethodName:
+  Enabled: true
+```
diff --git a/docs/description/Naming_AsciiIdentifiers.md b/docs/description/Naming_AsciiIdentifiers.md
@@ -0,0 +1,23 @@
+A rule that reports non-ascii characters in identifiers.
+
+Favour this:
+
+```
+class BigAwesomeWolf
+end
+```
+
+Over this:
+
+```
+class BigAwesome🐺
+end
+```
+
+YAML configuration example:
+
+```
+Naming/AsciiIdentifiers:
+  Enabled: true
+  IgnoreSymbols: false
+```
diff --git a/docs/description/Naming_BinaryOperatorParameterName.md b/docs/description/Naming_BinaryOperatorParameterName.md
@@ -0,0 +1,28 @@
+A rule that enforces that certain binary operator methods have
+their sole parameter named `other`.
+
+For example, this is considered valid:
+
+```
+class Money
+  def +(other)
+  end
+end
+```
+
+And this is invalid parameter name:
+
+```
+class Money
+  def +(amount)
+  end
+end
+```
+
+YAML configuration example:
+
+```
+Naming/BinaryOperatorParameterName:
+  Enabled: true
+  ExcludedOperators: ["[]", "[]?", "[]=", "<<", ">>", "=~", "!~"]
+```
diff --git a/docs/description/Naming_BlockParameterName.md b/docs/description/Naming_BlockParameterName.md
@@ -0,0 +1,24 @@
+A rule that reports non-descriptive block parameter names.
+
+Favour this:
+
+```
+tokens.each { |token| token.last_accessed_at = Time.utc }
+```
+
+Over this:
+
+```
+tokens.each { |t| t.last_accessed_at = Time.utc }
+```
+
+YAML configuration example:
+
+```
+Naming/BlockParameterName:
+  Enabled: true
+  MinNameLength: 3
+  AllowNamesEndingInNumbers: true
+  AllowedNames: [e, i, j, k, v, x, y, ex, io, ws, op, tx, id, ip, k1, k2, v1, v2]
+  ForbiddenNames: []
+```
diff --git a/docs/description/Naming_ConstantNames.md b/docs/description/Naming_ConstantNames.md
@@ -17,6 +17,6 @@ Wrong_NAME = 2
 YAML configuration example:
 
 ```
-Style/ConstantNames:
+Naming/ConstantNames:
   Enabled: true
 ```
diff --git a/docs/description/Naming_Filename.md b/docs/description/Naming_Filename.md
@@ -0,0 +1,8 @@
+A rule that enforces file names to be in underscored case.
+
+YAML configuration example:
+
+```
+Naming/Filename:
+  Enabled: true
+```
diff --git a/docs/description/Naming_MethodNames.md b/docs/description/Naming_MethodNames.md
@@ -33,6 +33,6 @@ end
 YAML configuration example:
 
 ```
-Style/MethodNames:
+Naming/MethodNames:
   Enabled: true
 ```
diff --git a/docs/description/Naming_PredicateName.md b/docs/description/Naming_PredicateName.md
@@ -19,6 +19,6 @@ end
 YAML configuration example:
 
 ```
-Style/PredicateName:
+Naming/PredicateName:
   Enabled: true
 ```
diff --git a/docs/description/Naming_QueryBoolMethods.md b/docs/description/Naming_QueryBoolMethods.md
@@ -22,6 +22,6 @@ end
 YAML configuration example:
 
 ```
-Style/QueryBoolMethods:
+Naming/QueryBoolMethods:
   Enabled: true
 ```
diff --git a/docs/description/Naming_RescuedExceptionsVariableName.md b/docs/description/Naming_RescuedExceptionsVariableName.md
@@ -0,0 +1,25 @@
+A rule that makes sure that rescued exceptions variables are named as expected.
+
+For example, these are considered valid:
+
+    def foo
+      # potentially raising computations
+    rescue e
+      Log.error(exception: e) { "Error" }
+    end
+
+And these are invalid variable names:
+
+    def foo
+      # potentially raising computations
+    rescue wtf
+      Log.error(exception: wtf) { "Error" }
+    end
+
+YAML configuration example:
+
+```
+Naming/RescuedExceptionsVariableName:
+  Enabled: true
+  AllowedNames: [e, ex, exception, error]
+```
diff --git a/docs/description/Naming_TypeNames.md b/docs/description/Naming_TypeNames.md
@@ -47,6 +47,6 @@ end
 YAML configuration example:
 
 ```
-Style/TypeNames:
+Naming/TypeNames:
   Enabled: true
 ```
diff --git a/docs/description/Naming_VariableNames.md b/docs/description/Naming_VariableNames.md
@@ -18,6 +18,6 @@ wrong_Name = 2
 YAML configuration example:
 
 ```
-Style/VariableNames:
+Naming/VariableNames:
   Enabled: true
 ```
diff --git a/docs/description/description.json b/docs/description/description.json
diff --git a/docs/patterns.json b/docs/patterns.json
diff --git a/docs/tests/Style_ConstantNames.cr b/docs/tests/Style_ConstantNames.cr
diff --git a/docs/tests/Style_MethodNames.cr b/docs/tests/Style_MethodNames.cr
diff --git a/docs/tests/Style_PredicateName.cr b/docs/tests/Style_PredicateName.cr
diff --git a/docs/tests/Style_TypeNames.cr b/docs/tests/Style_TypeNames.cr
diff --git a/docs/tests/Style_VariableNames.cr b/docs/tests/Style_VariableNames.cr
diff --git a/shard.lock b/shard.lock
diff --git a/shard.yml b/shard.yml
