adding in core files and adding two more checklists

Author: smorin

.gitignore

@@ -22,3 +22,16 @@ erl_crash.dump
 # Ignore package tarball (built via "mix hex.build").
 ex_macro_inspect-*.tar
 
+# Ignore distilery releases
+/_release
+
+# Ignore benchmarks
+/_benchmarks
+
+/db
+/deps
+/*.ez
+/docs
+
+# Ignore vs-code project files
+/.vs

README.md

@@ -37,9 +37,9 @@ end
   * [x] deployment package          - erlang release with distillery
   * [x] phx configuration 4 package - config.exs setup with aliases
     * [x] distillery config         - update config/prod.exs with "config :phoenix, :serve_endpoints, true"
-  * [ ] logging                     - elixir logging
   * [x] benchmarking setup          - elixir benchee setup
   * [x] load testing setup          - elixir wrk
+  * [ ] logging                     - elixir logging TODO: Add example logging and checklist
 
 ## setup README checklist
 * [ ] create README
@@ -147,6 +147,7 @@ end
 - [ ] check no git dependencies
 - [ ] run: `mix hex.publish`
 - [ ] if first publish update references to hexdocs in readme and mix.exs
+- [ ] test published package
 
 ```
   defp package() do
@@ -162,6 +163,67 @@ end
   end
 ```
 
+# deployment package checklist
+* [ ] add to deps `{:distillery, "~> 1.5", runtime: false}`
+* [ ] setup by running `mix release.init`
+* [ ] create bin/version_check.exs
+* [ ] test package `make package package-run`
+
+# version_check.exs
+```
+try do
+    # if no args submitted and exception is raised
+    if hd(System.argv()) =~ ~r{^(\d+\.)(\d+\.)(\d+)$} do
+    System.stop(0)
+    else
+    System.stop(1)
+    end
+rescue
+    # if exception it's a invalid version
+    _ -> System.stop(1)
+end
+
+# Believe the receive block prevents the race condition so 
+# that halt will work correctly
+receive do
+  {:hello, msg} -> msg
+after
+  10_000 -> "nothing after 1s"
+end
+```
+
+## benchmarking setup checklist
+* [ ] add to deps `{:benchee, "~> 0.11", only: :dev}`,
+* [ ] add to deps `{:benchee_html, "~> 0.4", only: :dev}`,
+* [ ] create `benchmarks/sample.exs` see below
+* [ ] test `make run-benchmarks`
+# sample.exs
+```
+# https://github.com/PragTob/benchee
+
+
+map_fun = fn(i) -> i + 1 end
+inputs = %{
+  "Small (1 Thousand)"    => Enum.to_list(1..1_000),
+  "Middle (100 Thousand)" => Enum.to_list(1..100_000),
+  "Big (10 Million)"      => Enum.to_list(1..10_000_000),
+}
+
+Benchee.run %{
+    "flat_map"    => fn(_) -> 1+1 end,
+    "map.flatten" => fn(list) -> list |> IO.inspect |> Enum.map(map_fun) |> List.flatten end
+}, time: 15, warmup: 5, inputs: inputs, formatters: [
+    Benchee.Formatters.HTML,
+    Benchee.Formatters.Console
+  ],
+  formatter_options: [html: [file: "_benchmarks/sample.html"]]
+```
+
+## load testing setup checklist
+* [ ] install wrk `brew install wrk`
+* [ ] test `IP=127.0.0.1 PORT=8080 URLPATH=hello/world make load-test`
+
+
 Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
 and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
 be found at [https://hexdocs.pm/ex_macro_inspect](https://hexdocs.pm/ex_macro_inspect).

benchmarks/sample.exs

@@ -0,0 +1,18 @@
+# https://github.com/PragTob/benchee
+
+
+map_fun = fn(i) -> i + 1 end
+inputs = %{
+  "Small (1 Thousand)"    => Enum.to_list(1..1_000),
+  "Middle (100 Thousand)" => Enum.to_list(1..100_000),
+  "Big (10 Million)"      => Enum.to_list(1..10_000_000),
+}
+
+Benchee.run %{
+    "flat_map"    => fn(_) -> 1+1 end,
+    "map.flatten" => fn(list) -> list |> IO.inspect |> Enum.map(map_fun) |> List.flatten end
+}, time: 15, warmup: 5, inputs: inputs, formatters: [
+    Benchee.Formatters.HTML,
+    Benchee.Formatters.Console
+  ],
+  formatter_options: [html: [file: "_benchmarks/sample.html"]]

bin/basedir.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"; echo $SCRIPT_DIR
+ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"; echo $ROOT_DIR

bin/version_check.exs

@@ -0,0 +1,19 @@
+try do
+    # if no args submitted and exception is raised
+    if hd(System.argv()) =~ ~r{^(\d+\.)(\d+\.)(\d+)$} do
+    System.stop(0)
+    else
+    System.stop(1)
+    end
+rescue
+    # if exception it's a invalid version
+    _ -> System.stop(1)
+end
+
+# Believe the receive block prevents the race condition so 
+# that halt will work correctly
+receive do
+  {:hello, msg} -> msg
+after
+  10_000 -> "nothing after 1s"
+end

makefile

@@ -2,6 +2,9 @@
 
 .PHONY: help clean
 
+# Copyright Steve Morin 2015
+# https://github.com/smorin
+
 ### make help - is self documenting
 # Use double # to make a command self documenting
 
@@ -190,16 +193,12 @@ run-benchmarks: ## run all benchmarks using benchee
 
 # Reference: https://github.com/wg/wrk
 # Reference: https://github.com/tsenart/vegeta # alternate load testing framework
-load-test-error: wrk ## run a load test with wrk
-	@echo makefile:load-test
-	wrk --threads 12 --connections 400 --duration 30s --latency --timeout 30s http://$${IP:-127.0.0.1}:$${PORT:-4000}/v1/100/color.pnnnng
-
 load-test: wrk ## run a load test with wrk
 	@echo makefile:load-test
-	wrk --threads 12 --connections 400 --duration 30s --latency --timeout 30s http://$${IP:-127.0.0.1}:$${PORT:-4000}/v1/100/color.jpg
+	wrk --threads 12 --connections 400 --duration 30s --latency --timeout 30s http://$${IP:-127.0.0.1}:$${PORT:-4000}/$${URLPATH:-}
 
-get-pixel:
-	curl --request GET "http://$${IP:-127.0.0.1}:$${PORT:-4000}/v1/100/color.jpg"
+get:
+	curl --request GET "http://$${IP:-127.0.0.1}:$${PORT:-4000}/$${URLPATH:-}"
 
 wrk:
 	@echo makefile:wrk

mix.exs

@@ -35,7 +35,10 @@ defmodule ExMacroInspect.MixProject do
       {:credo, "~> 0.9.1", only: [:dev, :test], runtime: false},
       {:dialyxir, "~> 1.0.0-rc.2", only: [:dev], runtime: false},
       {:ex_doc, "~> 0.16", only: :dev, runtime: false},
-      {:excoveralls, "~> 0.8", only: [:dev, :test]}
+      {:excoveralls, "~> 0.8", only: [:dev, :test]},
+      {:distillery, "~> 1.5", runtime: false},
+      {:benchee, "~> 0.11", only: :dev},
+      {:benchee_html, "~> 0.4", only: :dev}
       # {:dep_from_hexpm, "~> 0.3.0"},
       # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"},
     ]
@@ -76,10 +79,12 @@ defmodule ExMacroInspect.MixProject do
       name: "ex_macro_inspect",
       organization: "hexpm",
       # These are the default files included in the package
-      files: ["lib", "mix.exs", "README*",  "LICENSE*"],
+      files: ["lib", "mix.exs", "README*", "LICENSE*"],
       licenses: ["GNU 3.0"],
-      links: %{"GitHub" => "https://github.com/smorin/ExMacroInspect", "HexDocs" => "https://hexdocs.pm/ex_macro_inspect/"}
+      links: %{
+        "GitHub" => "https://github.com/smorin/ExMacroInspect",
+        "HexDocs" => "https://hexdocs.pm/ex_macro_inspect/"
+      }
     ]
   end
-
 end

mix.lock

@@ -1,8 +1,13 @@
 %{
+  "benchee": {:hex, :benchee, "0.13.1", "bd93ca05be78bcb6159c7176230efeda2f724f7ffd485515175ca411dff4893e", [:mix], [{:deep_merge, "~> 0.1", [hex: :deep_merge, repo: "hexpm", optional: false]}], "hexpm"},
+  "benchee_html": {:hex, :benchee_html, "0.5.0", "1354ba8005f979c177561fe08b83cafbae43f3046e8a6cf209132b8967b6db17", [:mix], [{:benchee, "~> 0.12", [hex: :benchee, repo: "hexpm", optional: false]}, {:benchee_json, "~> 0.5", [hex: :benchee_json, repo: "hexpm", optional: false]}], "hexpm"},
+  "benchee_json": {:hex, :benchee_json, "0.5.0", "75878fd9944093ced03e9c214e6e1429da147de43e2f4a4cbc4377294ed5d029", [:mix], [{:benchee, "~> 0.12", [hex: :benchee, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm"},
   "bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], [], "hexpm"},
   "certifi": {:hex, :certifi, "2.3.1", "d0f424232390bf47d82da8478022301c561cf6445b5b5fb6a84d49a9e76d2639", [:rebar3], [{:parse_trans, "3.2.0", [hex: :parse_trans, repo: "hexpm", optional: false]}], "hexpm"},
   "credo": {:hex, :credo, "0.9.3", "76fa3e9e497ab282e0cf64b98a624aa11da702854c52c82db1bf24e54ab7c97a", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:poison, ">= 0.0.0", [hex: :poison, repo: "hexpm", optional: false]}], "hexpm"},
+  "deep_merge": {:hex, :deep_merge, "0.1.1", "c27866a7524a337b6a039eeb8dd4f17d458fd40fbbcb8c54661b71a22fffe846", [:mix], [], "hexpm"},
   "dialyxir": {:hex, :dialyxir, "1.0.0-rc.3", "774306f84973fc3f1e2e8743eeaa5f5d29b117f3916e5de74c075c02f1b8ef55", [:mix], [], "hexpm"},
+  "distillery": {:hex, :distillery, "1.5.3", "b2f4fc34ec71ab4f1202a796f9290e068883b042319aa8c9aa45377ecac8597a", [:mix], [], "hexpm"},
   "earmark": {:hex, :earmark, "1.2.5", "4d21980d5d2862a2e13ec3c49ad9ad783ffc7ca5769cf6ff891a4553fbaae761", [:mix], [], "hexpm"},
   "ex_doc": {:hex, :ex_doc, "0.18.4", "4406b8891cecf1352f49975c6d554e62e4341ceb41b9338949077b0d4a97b949", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"},
   "excoveralls": {:hex, :excoveralls, "0.9.1", "14fd20fac51ab98d8e79615814cc9811888d2d7b28e85aa90ff2e30dcf3191d6", [:mix], [{:hackney, ">= 0.12.0", [hex: :hackney, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm"},

rel/config.exs

@@ -0,0 +1,53 @@
+# Import all plugins from `rel/plugins`
+# They can then be used by adding `plugin MyPlugin` to
+# either an environment, or release definition, where
+# `MyPlugin` is the name of the plugin module.
+Path.join(["rel", "plugins", "*.exs"])
+|> Path.wildcard()
+|> Enum.map(&Code.eval_file(&1))
+
+use Mix.Releases.Config,
+    # This sets the default release built by `mix release`
+    default_release: :default,
+    # This sets the default environment used by `mix release`
+    default_environment: Mix.env()
+
+# For a full list of config options for both releases
+# and environments, visit https://hexdocs.pm/distillery/configuration.html
+
+
+# You may define one or more environments in this file,
+# an environment's settings will override those of a release
+# when building in that environment, this combination of release
+# and environment configuration is called a profile
+
+environment :dev do
+  # If you are running Phoenix, you should make sure that
+  # server: true is set and the code reloader is disabled,
+  # even in dev mode.
+  # It is recommended that you build with MIX_ENV=prod and pass
+  # the --env flag to Distillery explicitly if you want to use
+  # dev mode.
+  set dev_mode: true
+  set include_erts: false
+  set cookie: :"H.~A(,*ly@Z:_sJra000zI/SCtj3(rj$[WRP{)iA?U48E*3cwWYyq@GSt^L/bBvV"
+end
+
+environment :prod do
+  set include_erts: true
+  set include_src: false
+  set cookie: :"_h6OSuK?=R~72V;EpP4~GSQy|gQM8wlGV]6wXcuHD@u{8`0ij?O=aC^90Xnd$Vjb"
+end
+
+# You may define one or more releases in this file.
+# If you have not set a default release, or selected one
+# when running `mix release`, the first release in the file
+# will be used by default
+
+release :ex_macro_inspect do
+  set version: current_version(:ex_macro_inspect)
+  set applications: [
+    :runtime_tools
+  ]
+end
+