Merge pull request #1 from OffgridElectric/ks/merge_upstream

Ks/merge upstream

.circleci/config.yml

@@ -0,0 +1,153 @@
+version: 2.1 # use CircleCI 2.1 instead of CircleCI Classic
+
+x-common:
+  job-common: &job-common
+    working_directory: /home/circleci/project
+    docker:
+      - image: circleci/elixir:1.11
+        environment:
+          MIX_ARCHIVES: /home/circleci/project/.mix/archives
+          MIX_HOME: /home/circleci/project/.mix
+  deploy-common: &deploy-common
+    working_directory: /home/circleci/project
+    docker:
+      - image: circleci/buildpack-deps
+
+x-steps:
+  - &save-deps-cache
+    save_cache:
+      key: v1-deps-cache-{{ .Branch }}-{{ checksum "mix.lock" }}
+      paths: ["deps"]
+  - &restore-deps-cache
+    restore_cache:
+      keys:
+        - v1-deps-cache-{{ .Branch }}-{{ checksum "mix.lock" }}
+  - &save-plt-cache
+    save_cache:
+      key: v1-plt-cache-{{ .Branch }}-{{ checksum ".dialyzer/cache.plt" }}
+      paths: [".dialyzer/cache.plt"]
+  - &restore-plt-cache
+    restore_cache:
+      keys:
+        - v1-plt-cache-{{ .Branch }}-{{ checksum ".dialyzer/cache.plt" }}
+  - &attach-workspace
+    attach_workspace:
+      at: /home/circleci
+
+x-filters:
+  only-pr: &only-pr
+    branches:
+      ignore: /^(master)$/
+  only-master: &only-master
+    branches:
+      only: /^master$/
+
+jobs:
+  setup:
+    <<: *job-common
+    steps:
+      - checkout
+      - *restore-deps-cache
+      - run: 
+          name: Install Hex
+          command: mix local.hex --force --if-missing
+      - run: 
+          name: Install rebar
+          command: mix local.rebar --force --if-missing
+      - run: 
+          name: Install project's deps
+          command: mix deps.get
+      - *save-deps-cache
+      - persist_to_workspace:
+          root: /home/circleci/
+          paths: ["project"]
+
+  build:
+    <<: *job-common
+    steps:
+      - *attach-workspace
+      - run: 
+          name: Build project
+          command: mix compile --warnings-as-errors
+      - persist_to_workspace:
+          root: /home/circleci/
+          paths: ["project/_build"]
+
+  format:
+    <<: *job-common
+    steps:
+      - *attach-workspace
+      - run: 
+          name: Check formatting rules
+          command: mix format --check-formatted
+
+  dialyzer:
+    <<: *job-common
+    steps:
+      - *attach-workspace
+      - run: 
+          name: Dialyzer static analysis
+          command: mix dialyzer
+
+  credo:
+    <<: *job-common
+    steps:
+      - *attach-workspace
+      - run:
+          name: Check coding rules
+          command: mix credo
+
+  test:
+    <<: *job-common
+    steps:
+      - *attach-workspace
+      - run: mix test
+
+workflows:
+  version: 2
+  on-pull-request:
+    jobs:
+      - setup:
+          filters:
+            <<: *only-pr
+      - build:
+          requires:
+            - setup
+          filters:
+            <<: *only-pr
+      - format:
+          requires:
+            - setup
+          filters:
+            <<: *only-pr
+      - credo:
+          requires:
+            - build
+          filters:
+            <<: *only-pr
+      - dialyzer:
+          requires:
+            - build
+          filters:
+            <<: *only-pr
+      - test:
+          requires:
+            - build
+          filters:
+            <<: *only-pr
+
+  on-merge:
+    jobs:
+      - setup:
+          filters:
+            <<: *only-master
+      - build:
+          requires:
+            - setup
+          filters:
+            <<: *only-master
+      - test:
+          requires:
+            - setup
+          filters:
+            <<: *only-master

.credo.exs

@@ -0,0 +1,189 @@
+# This file contains the configuration for Credo and you are probably reading
+# this after creating it with `mix credo.gen.config`.
+#
+# If you find anything wrong or unclear in this file, please report an
+# issue on GitHub: https://github.com/rrrene/credo/issues
+#
+%{
+  #
+  # You can have as many configs as you like in the `configs:` field.
+  configs: [
+    %{
+      #
+      # Run any config using `mix credo -C <name>`. If no config name is given
+      # "default" is used.
+      #
+      name: "default",
+      #
+      # These are the files included in the analysis:
+      files: %{
+        #
+        # You can give explicit globs or simply directories.
+        # In the latter case `**/*.{ex,exs}` will be used.
+        #
+        included: [
+          "lib/",
+          "src/",
+          "test/",
+          "web/",
+          "apps/*/lib/",
+          "apps/*/src/",
+          "apps/*/test/",
+          "apps/*/web/"
+        ],
+        excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
+      },
+      #
+      # Load and configure plugins here:
+      #
+      plugins: [],
+      #
+      # If you create your own checks, you must specify the source files for
+      # them here, so they can be loaded by Credo before running the analysis.
+      #
+      requires: [],
+      #
+      # If you want to enforce a style guide and need a more traditional linting
+      # experience, you can change `strict` to `true` below:
+      #
+      strict: false,
+      #
+      # To modify the timeout for parsing files, change this value:
+      #
+      parse_timeout: 5000,
+      #
+      # If you want to use uncolored output by default, you can change `color`
+      # to `false` below:
+      #
+      color: true,
+      #
+      # You can customize the parameters of any check by adding a second element
+      # to the tuple.
+      #
+      # To disable a check put `false` as second element:
+      #
+      #     {Credo.Check.Design.DuplicatedCode, false}
+      #
+      checks: [
+        #
+        ## 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
+        #
+        # You can customize the priority of any check
+        # Priority values are: `low, normal, high, higher`
+        #
+        {Credo.Check.Design.AliasUsage,
+         [priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]},
+        # You can also customize the exit_status of each check.
+        # If you don't want TODO comments to cause `mix credo` to fail, just
+        # set this value to 0 (zero).
+        #
+        {Credo.Check.Design.TagTODO, [exit_status: 2]},
+        {Credo.Check.Design.TagFIXME, []},
+
+        #
+        ## Readability Checks
+        #
+        {Credo.Check.Readability.AliasOrder, []},
+        {Credo.Check.Readability.FunctionNames, []},
+        {Credo.Check.Readability.LargeNumbers, []},
+        {Credo.Check.Readability.MaxLineLength, [priority: :low, 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, []},
+        {Credo.Check.Readability.Semicolons, []},
+        {Credo.Check.Readability.SpaceAfterCommas, []},
+        {Credo.Check.Readability.StringSigils, []},
+        {Credo.Check.Readability.TrailingBlankLine, []},
+        {Credo.Check.Readability.TrailingWhiteSpace, []},
+        {Credo.Check.Readability.UnnecessaryAliasExpansion, []},
+        {Credo.Check.Readability.VariableNames, []},
+
+        #
+        ## Refactoring Opportunities
+        #
+        {Credo.Check.Refactor.CondStatements, []},
+        {Credo.Check.Refactor.CyclomaticComplexity, []},
+        {Credo.Check.Refactor.FunctionArity, []},
+        {Credo.Check.Refactor.LongQuoteBlocks, []},
+        # {Credo.Check.Refactor.MapInto, []},
+        {Credo.Check.Refactor.MatchInCondition, []},
+        {Credo.Check.Refactor.NegatedConditionsInUnless, []},
+        {Credo.Check.Refactor.NegatedConditionsWithElse, []},
+        {Credo.Check.Refactor.Nesting, []},
+        {Credo.Check.Refactor.UnlessWithElse, []},
+        {Credo.Check.Refactor.WithClauses, []},
+
+        #
+        ## Warnings
+        #
+        {Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
+        {Credo.Check.Warning.BoolOperationOnSameValues, []},
+        {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
+        {Credo.Check.Warning.IExPry, []},
+        {Credo.Check.Warning.IoInspect, []},
+        # {Credo.Check.Warning.LazyLogging, []},
+        {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, []},
+
+        #
+        # Checks scheduled for next check update (opt-in for now, just replace `false` with `[]`)
+
+        #
+        # Controversial and experimental checks (opt-in, just replace `false` with `[]`)
+        #
+        {Credo.Check.Consistency.MultiAliasImportRequireUse, false},
+        {Credo.Check.Consistency.UnusedVariableNames, false},
+        {Credo.Check.Design.DuplicatedCode, false},
+        {Credo.Check.Readability.AliasAs, false},
+        {Credo.Check.Readability.BlockPipe, false},
+        {Credo.Check.Readability.ImplTrue, false},
+        {Credo.Check.Readability.MultiAlias, false},
+        {Credo.Check.Readability.SeparateAliasRequire, false},
+        {Credo.Check.Readability.SinglePipe, false},
+        {Credo.Check.Readability.Specs, false},
+        {Credo.Check.Readability.StrictModuleLayout, false},
+        {Credo.Check.Readability.WithCustomTaggedTuple, false},
+        {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, false},
+        {Credo.Check.Refactor.VariableRebinding, false},
+        {Credo.Check.Warning.LeakyEnvironment, false},
+        {Credo.Check.Warning.MapGetUnsafePass, false},
+        {Credo.Check.Warning.UnsafeToAtom, false}
+
+        #
+        # Custom checks can be created using `mix credo.gen.check`.
+        #
+      ]
+    }
+  ]
+}

.dialyzer/ignore.exs

@@ -0,0 +1 @@
+[]

.gitignore

@@ -22,3 +22,5 @@ erl_crash.dump
 # Ignore package tarball (built via "mix hex.build").
 coap-*.tar
 
+*.plt
+*.plt.hash

LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2018-2020 Tony Pitale
+Copyright (c) 2019-2020 John Giffin
+Copyright (c) 2020 Jean Parpaillon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.