chore: release version v0.4.0

.drone.yml

@@ -363,17 +363,17 @@ steps:
     refs:
       include:
       - refs/tags/v*
-    depends_on:
-    - build artifacts
-    environment:
-      MIX_ENV: test
-      HEX_HOME: /drone/src/.hex
-      MIX_HOME: /drone/src/.mix
-      REBAR_BASE_DIR: /drone/src/.rebar3
-      ASDF_DATA_DIR: /drone/src/.asdf
-      ASDF_DIR: /root/.asdf
-      HEX_API_KEY:
-        from_secret: HEX_API_KEY
-    commands:
-      - . $ASDF_DIR/asdf.sh
-      - mix hex.publish --yes
+  depends_on:
+  - build artifacts
+  environment:
+    MIX_ENV: test
+    HEX_HOME: /drone/src/.hex
+    MIX_HOME: /drone/src/.mix
+    REBAR_BASE_DIR: /drone/src/.rebar3
+    ASDF_DATA_DIR: /drone/src/.asdf
+    ASDF_DIR: /root/.asdf
+    HEX_API_KEY:
+      from_secret: HEX_API_KEY
+  commands:
+    - . $ASDF_DIR/asdf.sh
+    - mix hex.publish --yes

CHANGELOG.md

@@ -5,6 +5,15 @@ See [Conventional Commits](Https://conventionalcommits.org) for commit guideline
 
 <!-- changelog -->
 
+## [v0.4.0](https://code.harton.nz/james/smokestack/compare/v0.3.1...v0.4.0) (2023-09-19)
+
+
+
+
+### Features:
+
+* add template for constant values
+
 ## [v0.3.1](https://code.harton.nz/james/smokestack/compare/v0.3.0...v0.3.1) (2023-09-09)
 
 

README.md

@@ -32,20 +32,18 @@ end
 
 ## Installation
 
-Smokestack is not yet ready to be published to [Hex](https://hex.pm) so in the
-mean time if you want to try it you need to add a git-based dependency:
+Smokestack is available on [Hex](https://hex.pm/packages/smokestack) you can
+add it directly to your `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:smokestack, git: "https://code.harton.nz/cinder/cinder", tag: "v0.1.0"}
+    {:smokestack, "~> 0.3"},
   ]
 end
 ```
 
-Since the package hasn't been published, there are no docs available on 
-[HexDocs](https://hexdocs.pm/), but you can access the latest version 
-[here](https://docs.harton.nz/james/smokestack).
+Documentation for the latest release is available on [HexDocs](http://hexdocs.pm/smokestack).
 
 ## Github Mirror
 

lib/smokestack.ex

@@ -26,6 +26,14 @@ defmodule Smokestack do
   end
   ```
 
+  ## Templates
+
+  Each attribute uses a template to generate a value when building a factory.  
+  Templates can be anything that implements the `Smokestack.Template` protocol.
+  This protocol is automatically implemented for functions with arities zero
+  through two - meaning you can just drop in your own functions - or use one of
+  the built-in helpers from `Smokestack.Dsl.Template`.
+
   ## Variants
 
   Sometimes you need to make slightly different factories to build a resource

lib/smokestack/dsl/template.ex

@@ -17,6 +17,13 @@ defmodule Smokestack.Dsl.Template do
   def choose(options, mapper \\ nil) when is_mapper(mapper),
     do: %Template.Choose{options: options, mapper: mapper}
 
+  @doc """
+  Select a constant value
+  """
+  @spec constant(element, mapper) :: Template.t()
+  def constant(value, mapper \\ nil) when is_mapper(mapper),
+    do: %Template.Constant{value: value, mapper: mapper}
+
   @doc """
   Cycle sequentially between a list of options.
   """

lib/smokestack/template/constant.ex

@@ -0,0 +1,16 @@
+defmodule Smokestack.Template.Constant do
+  @moduledoc false
+  defstruct value: nil, mapper: nil
+
+  @type t :: %__MODULE__{value: any, mapper: Smokestack.Template.mapper()}
+
+  defimpl Smokestack.Template do
+    def init(constant), do: constant
+
+    def generate(constant, _, _) when is_function(constant.mapper, 1),
+      do: constant.mapper(constant.value)
+
+    def generate(constant, _, _),
+      do: constant.value
+  end
+end

mix.exs

@@ -1,7 +1,7 @@
 defmodule Smokestack.MixProject do
   use Mix.Project
 
-  @version "0.3.1"
+  @version "0.4.0"
 
   @moduledoc """
   Test factories for Ash resources.
@@ -21,7 +21,10 @@ defmodule Smokestack.MixProject do
       source_url: "https://code.harton.nz/james/smokestack",
       homepage_url: "https://code.harton.nz/james/smokestack",
       aliases: aliases(),
-      dialyzer: [plt_add_apps: [:faker]]
+      dialyzer: [plt_add_apps: [:faker]],
+      docs: [
+        main: "Smokestack"
+      ]
     ]
   end
 

test/smokestack/template/constant.exs

@@ -0,0 +1,31 @@
+defmodule Smokestack.Template.ChooseTest do
+  @moduledoc false
+  use ExUnit.Case, async: true
+  alias Smokestack.{Template, Template.Constant}
+
+  describe "Smokestack.Template.init/1" do
+    test "it doesn't do anything" do
+      constant = %Constant{value: 1, mapper: &Function.identity/1}
+
+      assert ^constant = Template.init(constant)
+    end
+  end
+
+  describe "Smokestack.Template.generate/3" do
+    test "it returns the same value" do
+      value =
+        %Constant{value: 1}
+        |> Template.generate(nil, nil)
+
+      assert value == 1
+    end
+
+    test "it can map the chosen value" do
+      value =
+        %Constant{value: 1, mapper: &(&1 * 3)}
+        |> Template.generate(nil, nil)
+
+      assert value == 3
+    end
+  end
+end