# plug_ribbon

[![Build Status](https://travis-ci.org/stnly/plug_ribbon.svg?branch=master)](https://travis-ci.org/stnly/plug_ribbon)
[![Hex Version](https://img.shields.io/hexpm/v/plug_ribbon.svg)](https://hex.pm/packages/plug_ribbon)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

This [Plug](https://github.com/elixir-lang/plug) module injects a ribbon to your web application in the configured environment.

Used to differentiate between environments.

![](priv/static/screenshot.png)

## Motivation

Inspired by [rack-dev-mark](https://github.com/dtaniwaki/rack-dev-mark)

## Setup

To use plug_ribbon in your projects, edit your `mix.exs` file and add plug_ribbon as a dependency:

```elixir
defp deps do
  [
    {:plug_ribbon, "~> 0.2.0"}
  ]
end
```

## Usage

This plug should be one of the last ones in your pipeline.

Add the plug and specify a list of environment atoms that you want the ribbon to be shown.

```elixir
defmodule MyPhoenixApp.Router do
  use MyPhoenixApp.Web, :router

  pipeline :browser do
    plug :accepts, ["html"]
    plug :fetch_session
    plug :fetch_flash
    plug :protect_from_forgery
    plug Plug.Ribbon, [:dev, :staging, :test]
  end

  pipeline :api do
    plug :accepts, ["json"]
  end

  scope "/", MyPhoenixApp do
    pipe_through :browser # Use the default browser stack

    get "/", PageController, :index
  end

  # Other scopes may use custom stacks.
  # scope "/api", Observes do
  #   pipe_through :api
  # end
end
```

After you are done, run `mix deps.get` in your shell to fetch the dependencies.

The ribbon will display a label with your current environment in capital letters.
`Mix.env |> Atom.to_string |> String.upcase`

## Testing

```bash
$ mix test
```

## License

See the [LICENSE](LICENSE) file for more information.