Packages

fun_with_flags

0.2.0
1.13.0 1.12.0 1.11.0 1.10.1 1.10.0 1.9.0 1.8.1 1.8.0 1.7.0 1.6.0 1.5.1 1.5.0 1.4.1 1.4.0 1.3.0 1.2.1 1.2.0 1.1.0 1.0.0 0.11.0 0.10.1 0.10.0 0.9.2 0.9.1 0.9.0 0.8.1 0.8.0 0.7.1 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.1 0.1.0 0.0.6 0.0.5 0.0.4 0.0.3 0.0.2 0.0.1

FunWithFlags, a flexible and fast feature toggle library for Elixir.

HexDocs

Current section

Files

Jump to
Readme
42 Versions
2 Dependencies
Dependants
Files
Activity
fun_with_flags lib fun_with_flags.ex
Raw

lib/fun_with_flags.ex 

defmodule FunWithFlags do

  @moduledoc """

  FunWithFlags, the Elixir feature flag library.

  """



  alias FunWithFlags.{Flag, Gate}



  @store FunWithFlags.Config.store_module



  @doc """

  Checks if a flag is enabled.



  ## Examples



      iex> FunWithFlags.enabled?(:new_homepage)

      false

  """

  @spec enabled?(atom) :: boolean

  def enabled?(flag_name) when is_atom(flag_name) do

    Flag.enabled?(@store.lookup(flag_name))

  end







  @doc """

  Enables a feature flag.



  ## Examples



      iex> FunWithFlags.enabled?(:super_shrink_ray)

      false

      iex> FunWithFlags.enable(:super_shrink_ray)

      {:ok, true}

      iex> FunWithFlags.enabled?(:super_shrink_ray)

      true



  """

  @spec enable(atom) :: {:ok, true}

  def enable(flag_name) when is_atom(flag_name) do

    {:ok, flag} = @store.put(flag_name, Gate.new(:boolean, true))

    verify(flag)

  end







  @doc """

  Disables a feature flag.



  ## Examples



      iex> FunWithFlags.enable(:random_koala_gifs)

      iex> FunWithFlags.enabled?(:random_koala_gifs)

      true

      iex> FunWithFlags.disable(:random_koala_gifs)

      {:ok, false}

      iex> FunWithFlags.enabled?(:random_koala_gifs)

      false



  """

  @spec disable(atom) :: {:ok, false}

  def disable(flag_name) when is_atom(flag_name) do

    {:ok, flag} = @store.put(flag_name, Gate.new(:boolean, false))

    verify(flag)

  end





  defp verify(flag) do

    {:ok, Flag.enabled?(flag)}

  end

end