feat: add ci

MikaAK · Jul 26, 2024 · 1166151 · 1166151
1 parent 3b7e129
commit 1166151
Show file tree

Hide file tree

Showing 13 changed files with 273 additions and 22 deletions.
diff --git a/.github/workflows/coveralls.yml b/.github/workflows/coveralls.yml
@@ -0,0 +1,31 @@
+name: Coveralls
+
+on: push
+
+jobs:
+  coveralls:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v4
+        with:
+          path: |
+            deps
+            _build
+          key: ${{ runner.os }}-mix-coveralls-${{ hashFiles('**/mix.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-mix-coveralls-
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: 25.1.2
+          elixir-version: 1.14.2
+
+      - run: mix deps.get
+
+      - run: MIX_ENV=test mix coveralls.json
+
+      - name: Upload to codecov.io
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
diff --git a/.github/workflows/credo.yml b/.github/workflows/credo.yml
@@ -0,0 +1,23 @@
+name: Credo
+
+on: push
+
+jobs:
+  credo:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v4
+        with:
+          path: |
+            deps
+            _build
+          key: ${{ runner.os }}-mix-credo-${{ hashFiles('**/mix.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-mix-credo-
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: 25.1.2
+          elixir-version: 1.14.2
+      - run: mix deps.get
+      - run: mix credo
diff --git a/.github/workflows/dialyzer.yml b/.github/workflows/dialyzer.yml
@@ -0,0 +1,25 @@
+name: Dialyzer
+
+on: push
+
+jobs:
+  dialyzer:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v4
+        with:
+          path: |
+            deps
+            _build
+            dialyzer
+          key: ${{ runner.os }}-mix-dialyzer-${{ hashFiles('**/mix.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-mix-dialyzer-
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: 25.1.2
+          elixir-version: 1.14.2
+      - run: mix deps.get
+      - run: mix dialyzer
+
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,13 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 20%
+        threshold: 0%
+        base: auto
+    patch:
+      default:
+        target: 60%
+        threshold: 2%
+        base: auto
+
diff --git a/credo.ex b/credo.ex
@@ -0,0 +1,133 @@
+allowed_imports = [
+  [:Ecto]
+]
+
+%{
+  configs: [
+    %{
+      name: "default",
+      files: %{
+        included: [
+          "lib/",
+          "src/",
+          "test/",
+          "web/",
+          "apps/*/lib/",
+          "apps/*/src/",
+          "apps/*/test/",
+          "apps/*/web/"
+        ],
+        excluded: [~r"_build/", ~r"deps/"]
+      },
+      plugins: [],
+      requires: ["deps/blitz_credo/lib/blitz_credo/"],
+      strict: true,
+      parse_timeout: 10000,
+      color: true,
+      checks: [
+
+        # BlitzCredoChecks
+
+        {BlitzCredoChecks.SetWarningsAsErrorsInTest, false},
+        {BlitzCredoChecks.DocsBeforeSpecs, []},
+        {BlitzCredoChecks.DoctestIndent, []},
+        {BlitzCredoChecks.NoAsyncFalse, []},
+        {BlitzCredoChecks.NoDSLParentheses, []},
+        {BlitzCredoChecks.NoIsBitstring, []},
+        {BlitzCredoChecks.StrictComparison, []},
+        {BlitzCredoChecks.LowercaseTestNames, []},
+        {BlitzCredoChecks.ImproperImport, allowed_modules: allowed_imports},
+
+        # Consistency Checks
+        {Credo.Check.Consistency.ExceptionNames, []},
+        {Credo.Check.Consistency.LineEndings, []},
+        {Credo.Check.Consistency.ParameterPatternMatching, []},
+        {Credo.Check.Consistency.SpaceAroundOperators, []},
+        {Credo.Check.Consistency.SpaceInParentheses, []},
+        {Credo.Check.Consistency.TabsOrSpaces, []},
+
+        # Design Checks
+        {Credo.Check.Design.AliasUsage, false},
+
+        # No outstanding TODOs
+        {Credo.Check.Design.TagTODO, []},
+        {Credo.Check.Design.TagFIXME, []},
+
+        # # Readability Checks
+        {Credo.Check.Readability.AliasOrder, false},
+        {Credo.Check.Readability.FunctionNames, []},
+        {Credo.Check.Readability.LargeNumbers, []},
+        {Credo.Check.Readability.MaxLineLength, [max_length: 120]},
+        {Credo.Check.Readability.ModuleAttributeNames, []},
+        {Credo.Check.Readability.ModuleDoc, false},
+        {Credo.Check.Readability.ModuleNames, []},
+        {Credo.Check.Readability.ParenthesesInCondition, []},
+        {Credo.Check.Readability.ParenthesesOnZeroArityDefs, []},
+        {Credo.Check.Readability.PredicateFunctionNames, []},
+        {Credo.Check.Readability.PreferImplicitTry, []},
+        {Credo.Check.Readability.RedundantBlankLines, false},
+        {Credo.Check.Readability.Semicolons, []},
+        {Credo.Check.Readability.SpaceAfterCommas, false},
+        {Credo.Check.Readability.StringSigils, []},
+        {Credo.Check.Readability.TrailingBlankLine, false},
+        {Credo.Check.Readability.TrailingWhiteSpace, false},
+        {Credo.Check.Readability.UnnecessaryAliasExpansion, []},
+        {Credo.Check.Readability.VariableNames, []},
+        #
+        # Refactoring Opportunities
+        {Credo.Check.Refactor.CondStatements, []},
+        {Credo.Check.Refactor.CyclomaticComplexity, false},
+        {Credo.Check.Refactor.FunctionArity, []},
+        {Credo.Check.Refactor.LongQuoteBlocks, false},
+        {Credo.Check.Refactor.MapInto, false},
+        {Credo.Check.Refactor.MatchInCondition, []},
+        {Credo.Check.Refactor.NegatedConditionsInUnless, []},
+        {Credo.Check.Refactor.NegatedConditionsWithElse, []},
+        {Credo.Check.Refactor.Nesting, false},
+        {Credo.Check.Refactor.UnlessWithElse, []},
+        {Credo.Check.Refactor.WithClauses, []},
+
+        # Warnings
+        {Credo.Check.Warning.BoolOperationOnSameValues, []},
+        {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
+        {Credo.Check.Warning.IExPry, []},
+        {Credo.Check.Warning.IoInspect, []},
+        {Credo.Check.Warning.LazyLogging, false},
+        {Credo.Check.Warning.MixEnv, false},
+        {Credo.Check.Warning.OperationOnSameValues, []},
+        {Credo.Check.Warning.OperationWithConstantResult, []},
+        {Credo.Check.Warning.RaiseInsideRescue, []},
+        {Credo.Check.Warning.UnusedEnumOperation, []},
+        {Credo.Check.Warning.UnusedFileOperation, []},
+        {Credo.Check.Warning.UnusedKeywordOperation, []},
+        {Credo.Check.Warning.UnusedListOperation, []},
+        {Credo.Check.Warning.UnusedPathOperation, []},
+        {Credo.Check.Warning.UnusedRegexOperation, []},
+        {Credo.Check.Warning.UnusedStringOperation, []},
+        {Credo.Check.Warning.UnusedTupleOperation, []},
+        {Credo.Check.Warning.UnsafeExec, []},
+
+        # Controversial and experimental checks
+        {Credo.Check.Readability.StrictModuleLayout, false},
+        {Credo.Check.Consistency.MultiAliasImportRequireUse, false},
+        {Credo.Check.Consistency.UnusedVariableNames, false},
+        {Credo.Check.Design.DuplicatedCode, false},
+        {Credo.Check.Readability.AliasAs, false},
+        {Credo.Check.Readability.MultiAlias, false},
+        {Credo.Check.Readability.Specs, false},
+        {Credo.Check.Readability.SinglePipe, []},
+        {Credo.Check.Readability.WithCustomTaggedTuple, []},
+        {Credo.Check.Refactor.ABCSize, false},
+        {Credo.Check.Refactor.AppendSingleItem, false},
+        {Credo.Check.Refactor.DoubleBooleanNegation, false},
+        {Credo.Check.Refactor.ModuleDependencies, false},
+        {Credo.Check.Refactor.NegatedIsNil, false},
+        {Credo.Check.Refactor.PipeChainStart, []},
+        {Credo.Check.Refactor.VariableRebinding, false},
+        {Credo.Check.Warning.LeakyEnvironment, false},
+        {Credo.Check.Warning.MapGetUnsafePass, false},
+        {Credo.Check.Warning.UnsafeToAtom, false}
+      ]
+    }
+  ]
+}
diff --git a/lib/actions.ex b/lib/actions.ex
@@ -318,9 +318,7 @@ defmodule EctoShorts.Actions do
 
 
   def update(schema, schema_data, updates, opts) do
-    with {:ok, schema_data} <- repo!(opts).update(schema.changeset(schema_data, updates), opts) do
-      {:ok, schema_data}
-    end
+    repo!(opts).update(schema.changeset(schema_data, updates), opts)
   end
 
   @doc """

diff --git a/lib/common_changes.ex b/lib/common_changes.ex
@@ -2,7 +2,7 @@ defmodule EctoShorts.CommonChanges do
   @moduledoc """
   This module is responsible for determining put/cast assoc as well as creating and updating model relations
   """
-  import Logger, only: [warn: 1]
+  require Logger
 
   import Ecto.Changeset, only: [
     get_field: 2,
@@ -108,7 +108,7 @@ defmodule EctoShorts.CommonChanges do
         |> elem(1)
         |> Map.get(:queryable)
     else
-      warn "Changeset relationship for CommonChanges.put_or_cast_assoc #{key} was not found"
+      Logger.warning("Changeset relationship for CommonChanges.put_or_cast_assoc #{key} was not found")
 
       changeset
     end

diff --git a/lib/config.ex b/lib/config.ex
@@ -1,4 +1,6 @@
 defmodule EctoShorts.Config do
+  @moduledoc false
+
   @app :ecto_shorts
 
   def repo do

diff --git a/mix.exs b/mix.exs
@@ -5,15 +5,25 @@ defmodule EctoShorts.MixProject do
     [
       app: :ecto_shorts,
       version: "2.3.0",
-      elixir: "~> 1.7",
+      elixir: "~> 1.11",
       start_permanent: Mix.env() == :prod,
       deps: deps(),
       description: "Helper tools for making ecto interactions more pleasant and shorter",
       docs: docs(),
       package: package(),
+      elixirc_paths: elixirc_paths(Mix.env()),
+      test_coverage: [tool: ExCoveralls],
+
       preferred_cli_env: [
-        dialyzer: :test
-        ],
+        coveralls: :test,
+        doctor: :test,
+        coverage: :test,
+        dialyzer: :test,
+        "coveralls.lcov": :test,
+        "coveralls.json": :test,
+        "coveralls.html": :test
+      ],
+
       dialyzer: [
         plt_add_apps: [:ex_unit, :mix],
         plt_ignore_apps: [:ecto_shorts],
@@ -36,11 +46,17 @@ defmodule EctoShorts.MixProject do
     [
       {:ecto_sql, "~> 3.10"},
       {:error_message, "~> 0.1"},
+
+      {:credo, ">= 0.0.0", only: [:dev, :test]},
+      {:excoveralls, ">= 0.0.0", only: [:dev, :test]},
       {:ex_doc, ">= 0.0.0", only: :dev},
       {:dialyxir, "~> 1.1", only: :test, runtime: false}
     ]
   end
 
+  defp elixirc_paths(:test), do: ["lib", "test/support"]
+  defp elixirc_paths(_), do: ["lib"]
+
   defp package do
     [
       maintainers: ["Mika Kalathil"],