Update config and add example and diagram

- Update elvis.config
- Add dialyzer config
- Fix up .dir-locals.el (mostly wrt flycheck paths)

Author: yurrriq

.dir-locals.el

@@ -1,9 +1,15 @@
-((nil         . ((indent-tabs-mode             . nil)
-                 (fill-column                  . 80)
-                 (eval                         . (turn-on-fci-mode))))
- (erlang-mode . ((flycheck-erlang-include-path . ("../include"
-                                                  "../../include"
-                                                  "../../../include"))
-                 (flycheck-erlang-library-path . ("../../../_build/default/lib/elli_cache"
-                                                  "../../../_build/default/lib/elli_cache/ebin"))
-                 (erlang-indent-level          . 4))))
+((nil
+  . ((indent-tabs-mode . nil)
+     (fill-column      . 80)
+     (eval             . (turn-on-fci-mode))))
+ (erlang-mode
+  . ((erlang-indent-level . 4)
+     (flycheck-erlang-include-path
+      . ("../include"
+         "../_build/default/lib"
+         "../_build/test/lib"))
+     (flycheck-erlang-library-path
+      . ("../_build/default/lib/elli_cache"
+         "../_build/default/lib/elli_cache/ebin"
+         "../_build/default/lib/erlando"
+         "../_build/default/lib/erlando/ebin")))))

elvis.config

@@ -7,30 +7,16 @@
                  "src"
                 ],
         filter => "*.erl",
-        rules => [
-                  {elvis_style, line_length,
-                   #{limit => 80, skip_comments => false}},
-                  {elvis_style, invalid_dynamic_call,
-                   #{ignore => [
-                               ]}},
-                  {elvis_style, god_modules, #{limit => 25}}
-                 ],
         ruleset => erl_files
        },
       #{dirs => [
-                 "test/eunit"
+                 "test"
                 ],
         filter => "*.erl",
         rules => [
-                  {elvis_style, line_length,
-                   #{limit => 90}},
-                  {elvis_style, invalid_dynamic_call,
-                   #{ignore => [
-                               ]}},
-                  {elvis_style, god_modules, #{limit => 40}},
                   %% looks like eunit generates underscored vars
-                  {elvis_style, variable_naming_convention, #{regex => "^([A-Z_][0-9a-zA-Z_]*)$"}},
-                  {elvis_style, dont_repeat_yourself, #{min_complexity => 200}}
+                  {elvis_style, variable_naming_convention,
+                   #{regex => "^([A-Z_][0-9a-zA-Z_]*)$"}}
                  ],
         ruleset => erl_files
        },

priv/example.escript

@@ -0,0 +1,14 @@
+#!/usr/bin/env escript
+%% -*- erlang -*-
+
+main(_) ->
+    code:ensure_loaded(example_cache),
+    Config = [
+              {mods, [
+                      {elli_example_callback, []},
+                      {elli_middleware_cache, [{mod, example_cache}]}
+                     ]}
+             ],
+    {ok, _Pid} = elli:start_link([{callback, elli_middleware},
+                                  {callback_args, Config},
+                                  {port, 3000}]).

priv/rfc7232.dot

@@ -0,0 +1,56 @@
+digraph RFC7232 {
+  label="RFC 7232, Section 6. Precedence";
+  // compound=true;
+
+  step1 [label="If-Match"];
+  sect3_1 [label="Section 3.1"];
+
+  step2 [label="If-Unmodified-Since"];
+  sect3_4 [label="Section 3.4"];
+
+  step3 [label="If-None-Match"];
+
+  step4 [label="If-Modified-Since"];
+
+  step5 [label="Range ∧ If-Range"];
+
+  206;
+  304;
+  412;
+  Res;
+
+  subgraph cluster1 {
+    label="Step 1";
+    step1 -> step3 [color=green];
+    step1 -> sect3_1 [color=red];
+    step1 -> step2 [style=dashed];
+  }
+
+  subgraph cluster2 {
+    label="Step 2";
+    step2 -> step3 [color=green, style=dashed];
+    step2 -> sect3_4 [color=red];
+  }
+
+  subgraph cluster3 {
+    label="Step 3";
+    step3 -> step5 [color=green];
+    step3 -> 304 [color=red, label="GET ∨ HEAD"];
+    step3 -> 412 [color=red, label="_Method"];
+    step3 -> step4 [style=dashed];
+  }
+
+  subgraph cluster4 {
+    label="Step 4";
+    step4 -> step5 [style=dashed, label="_Method"];
+    step4 -> step5 [color=green, label="GET ∨ HEAD"];
+    step4 -> 304 [color=red, label="GET ∨ HEAD"];
+  }
+
+  subgraph cluster5 {
+    label="Step 5";
+    step5 -> 206 [color=green];
+    step5 -> Res [color=red, label="GET"];
+    step5 -> Res [style=dashed, label="_Method"];
+  }
+}

priv/rfc7232.png

@@ -38,3 +38,7 @@
 
 {coveralls_coverdata, "_build/test/cover/eunit.coverdata"}.
 {coveralls_service_name, "travis-ci"}.
+
+{dialyzer,
+ %% TODO: underspecs, specdiffs
+ [{warnings, [no_contracts, unmatched_returns, error_handling]}]}.

rebar.config

@@ -0,0 +1,11 @@
+-module(example_cache).
+-behaviour(elli_cache).
+-export([get_modified/2, get_size/2]).
+
+get_modified(_Req, _Args) ->
+    %% calendar:universal_time().
+    {{2016,11,15},{0,31,7}}.
+
+get_size(_Req, _Args) ->
+    %% rand:uniform(65536).
+    42.