Merge branch 'main' into witchcrafters#45-curried-constructor

.envrc

@@ -0,0 +1 @@
+eval "$(lorri direnv)"

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,85 @@
+# Code of Conduct
+
+## 1. Purpose
+
+A primary goal of Witchcrafters is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+
+This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
+
+We invite all those who participate in Witchcrafters to help us create safe and positive experiences for everyone.
+
+## 2. Open Source Citizenship
+
+A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
+
+Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
+
+If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.
+
+## 3. Expected Behavior
+
+The following behaviors are expected and requested of all community members:
+
+*   Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
+*   Exercise consideration and respect in your speech and actions.
+*   Attempt collaboration before conflict.
+*   Refrain from demeaning, discriminatory, or harassing behavior and speech.
+*   Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
+*   Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
+
+## 4. Unacceptable Behavior
+
+The following behaviors are considered harassment and are unacceptable within our community:
+
+*   Violence, threats of violence or violent language directed against another person.
+*   Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
+*   Posting or displaying sexually explicit or violent material.
+*   Posting or threatening to post other people’s personally identifying information ("doxing").
+*   Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+*   Inappropriate photography or recording.
+*   Inappropriate physical contact. You should have someone’s consent before touching them.
+*   Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
+*   Deliberate intimidation, stalking or following (online or in person).
+*   Advocating for, or encouraging, any of the above behavior.
+*   Sustained disruption of community events, including talks and presentations.
+
+## 5. Consequences of Unacceptable Behavior
+
+Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately.
+
+If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
+
+## 6. Reporting Guidelines
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. [email protected].
+
+
+
+Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
+
+## 7. Addressing Grievances
+
+If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the maintainers with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
+
+
+
+## 8. Scope
+
+We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues–online and in-person–as well as in all one-on-one communications pertaining to community business.
+
+This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members.
+
+## 9. Contact info
+
+[email protected]
+
+## 10. License and attribution
+
+This Code of Conduct is distributed under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
+
+Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
+
+Retrieved on November 22, 2016 from [http://citizencodeofconduct.org/](http://citizencodeofconduct.org/)
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,40 @@
+A similar PR may already be submitted!
+Please search among the [Pull request](../) before creating one.
+
+Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:
+
+For more information, see the `CONTRIBUTING` guide.
+
+
+## Summary
+<!-- Summary of the PR -->
+
+This PR fixes/implements the following **bugs/features**
+
+* [ ] Bug 1
+* [ ] Bug 2
+* [ ] Feature 1
+* [ ] Feature 2
+* [ ] Breaking changes
+
+<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
+
+Explain the **motivation** for making this change. What existing problem does the pull request solve?
+
+<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
+
+## Test plan (required)
+
+Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
+
+<!-- Make sure tests pass on Circle CI. -->
+
+
+## Closing issues
+
+<!-- Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
+Fixes #
+
+## After Merge
+* [ ] Does this change invalidate any docs or tutorials? _If so ensure the changes needed are either made or recorded_
+* [ ] Does this change require a release to be made? Is so please create and deploy the release

.github/workflows/ci.yaml

@@ -0,0 +1,21 @@
+on:
+  push:         { "branches": [ "main" ] }
+  pull_request: { "branches": [ "main" ] }
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
+    strategy:
+      matrix:
+        otp: ['23.0']
+        elixir: ['1.11.3']
+    steps:
+      - uses: actions/checkout@v2
+      - uses: erlef/setup-elixir@v1
+        with:
+          otp-version: ${{matrix.otp}}
+          elixir-version: ${{matrix.elixir}}
+      - run: MIX_ENV=test mix deps.get
+      - run: MIX_ENV=test mix test
+      - run: MIX_ENV=test mix credo --strict

.github/workflows/greetings.yml

@@ -0,0 +1,13 @@
+name: Greetings
+
+on: [pull_request, issues]
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/first-interaction@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        issue-message: 'Thank you for submitting an issue! It means a lot that you took the time -- it helps us be better 🙏'
+        pr-message: "Thank you for submitting a PR 🎉 It's very appreciated!"

mix.exs

@@ -8,7 +8,7 @@ defmodule Algae.Mixfile do
       deps: deps(),
 
       # Versions
-      version: "1.2.4",
+      version: "1.2.5",
       elixir: "~> 1.9",
 
       # Docs
@@ -23,20 +23,24 @@ defmodule Algae.Mixfile do
 
   defp aliases do
     [
-      quality: ["test", "credo --strict"]
+      quality: [
+          "test",
+          "credo --strict"
+        ]
     ]
   end
 
   defp deps do
     [
-      {:credo, "~> 1.1", only: [:dev, :test]},
-      {:dialyxir, "~> 0.5", only: :dev},
-      {:earmark, "~> 1.4.0", only: :dev},
-      {:ex_doc, "~> 0.21.2", only: :dev},
-      {:inch_ex, "~> 2.0", only: [:dev, :docs, :test]},
-      {:quark, "~> 2.3"},
-      {:type_class, "~> 1.2"},
-      {:witchcraft, "~> 1.0"}
+      {:credo,       "~> 1.5",  only: [:dev, :test],        runtime: false},
+      {:inch_ex,     "~> 2.0",  only: [:dev, :docs, :test], runtime: false},
+      {:dialyxir,    "~> 1.1",  only: :dev,                 runtime: false},
+      {:earmark,     "~> 1.4",  only: :dev,                 runtime: false},
+      {:ex_doc,      "~> 0.23", only: :dev,                 runtime: false},
+
+      {:quark,       "~> 2.2"},
+      {:type_class,  "~> 1.2"},
+      {:witchcraft,  "~> 1.0"},
     ]
   end
 
@@ -51,7 +55,7 @@ defmodule Algae.Mixfile do
 
   defp package do
     [
-      licenses: ["MIT"],
+      licenses: ["Apache-2.0"],
       links: %{"GitHub" => "https://github.com/witchcrafters/algae"},
       maintainers: ["Brooklyn Zelenka", "Steven Vandevelde"]
     ]

nix/commands.nix

@@ -0,0 +1,87 @@
+{ pkgs, unstable, ... }:
+  let
+    bash    = "${pkgs.bash}/bin/bash";
+    figlet  = "${pkgs.figlet}/bin/figlet";
+    lolcat  = "${pkgs.lolcat}/bin/lolcat";
+    mix     = "${unstable.elixir}/bin/mix";
+
+    cmd = description: script:
+      { inherit description;
+        inherit script;
+      };
+
+    command = {name, script, description ? "<No description given>"}:
+      let
+        package =
+          pkgs.writeScriptBin name ''
+            #!${bash}
+            echo "⚙️  Running ${name}..."
+            ${script}
+          '';
+
+        bin = "${package}/bin/${name}";
+      in
+         { package     = package;
+           description = description;
+           bin         = bin;
+         };
+
+    commands = defs:
+      let
+        names =
+          builtins.attrNames defs;
+
+        helper =
+          let
+            lengths = map builtins.stringLength names;
+            maxLen  = builtins.foldl' (acc: x: if x > acc then x else acc) 0 lengths;
+            maxPad  =
+              let
+                go = acc:
+                  if builtins.stringLength acc >= maxLen
+                  then acc
+                  else go (" " + acc);
+              in
+                go "";
+
+            folder = acc: name:
+              let
+                nameLen = builtins.stringLength name;
+                padLen  = maxLen - nameLen;
+                padding = builtins.substring 0 padLen maxPad;
+              in
+                acc + " && echo '${name} ${padding}| ${(builtins.getAttr name defs).description}'";
+
+            lines =
+              builtins.foldl' folder "echo ''" names;
+
+          in
+            pkgs.writeScriptBin "helpme" ''
+              #!${pkgs.stdenv.shell}
+              ${pkgs.figlet}/bin/figlet "Commands" | ${pkgs.lolcat}/bin/lolcat
+              ${toString lines}
+            '';
+
+        mapper = name:
+          let
+            element =
+              builtins.getAttr name defs;
+
+            task = command {
+              inherit name;
+              description = element.description;
+              script      = element.script;
+            };
+          in
+            task.package;
+
+        packages =
+          map mapper names;
+
+      in
+        [helper] ++ packages;
+
+  in
+    commands {
+      quality = cmd "Run all tests, linters, and so on" "MIX_ENV=test ${mix} quality";
+    }

nix/sources.json

@@ -0,0 +1,50 @@
+{
+    "darwin": {
+        "branch": "nixpkgs-20.09-darwin",
+        "description": "Nix Packages collection",
+        "homepage": "",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "e716ddfac4be879ffbae75c3914a538dd5d4d12e",
+        "sha256": "0c2090sz4nvd1bqa9bfz3b6mj0q8b7v4jzgsykn2hf291l3h94d6",
+        "type": "tarball",
+        "url": "https://github.com/NixOS/nixpkgs/archive/e716ddfac4be879ffbae75c3914a538dd5d4d12e.tar.gz",
+        "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
+    },
+    "niv": {
+        "branch": "master",
+        "description": "Easy dependency management for Nix projects",
+        "homepage": "https://github.com/nmattia/niv",
+        "owner": "nmattia",
+        "repo": "niv",
+        "rev": "af958e8057f345ee1aca714c1247ef3ba1c15f5e",
+        "sha256": "1qjavxabbrsh73yck5dcq8jggvh3r2jkbr6b5nlz5d9yrqm9255n",
+        "type": "tarball",
+        "url": "https://github.com/nmattia/niv/archive/af958e8057f345ee1aca714c1247ef3ba1c15f5e.tar.gz",
+        "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
+    },
+    "nixpkgs": {
+        "branch": "nixos-20.09",
+        "description": "Nix Packages collection",
+        "homepage": "",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "60b18a066e8ce5dd21ebff5324345d3586a67ad9",
+        "sha256": "1cr7r16vb4nxifykhak8awspdpr775kafrl7p6asgwicsng7giya",
+        "type": "tarball",
+        "url": "https://github.com/NixOS/nixpkgs/archive/60b18a066e8ce5dd21ebff5324345d3586a67ad9.tar.gz",
+        "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
+    },
+    "unstable": {
+        "branch": "nixpkgs-unstable",
+        "description": "Nix Packages collection",
+        "homepage": null,
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "c5147860e23ed75ce9d40298c66b416c00be1167",
+        "sha256": "104mw4rfbzyrfkxq468dlk38drrjx92dgyvkazgci67a6cx3n6nx",
+        "type": "tarball",
+        "url": "https://github.com/NixOS/nixpkgs/archive/c5147860e23ed75ce9d40298c66b416c00be1167.tar.gz",
+        "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
+    }
+}