Merge pull request #248 from inaka/euen.238.https_as_default

[Close #238] change https protocol as default for deps rule
inaka · Jul 3, 2015 · 9c5bc00 · 9c5bc00
2 parents ed33601 + dd361e6
commit 9c5bc00
Show file tree

Hide file tree

Showing 7 changed files with 91 additions and 21 deletions.
diff --git a/config/elvis-test.config b/config/elvis-test.config
@@ -32,12 +32,12 @@
       #{dirs => ["."],
         filter => "Makefile",
         rules => [{elvis_project, no_deps_master_erlang_mk, #{ignore => []}},
-                  {elvis_project, git_for_deps_erlang_mk, #{ignore => []}}]
+                  {elvis_project, protocol_for_deps_erlang_mk, #{ignore => []}}]
        },
       #{dirs => ["."],
         filter => "rebar.config",
         rules => [{elvis_project, no_deps_master_rebar, #{ignore => []}},
-                  {elvis_project, git_for_deps_rebar, #{ignore => []}}]
+                  {elvis_project, protocol_for_deps_rebar, #{ignore => []}}]
        },
       #{dirs => ["."],
         filter => "elvis.config",

diff --git a/config/elvis.config b/config/elvis.config
@@ -34,12 +34,12 @@
       #{dirs => ["."],
         filter => "Makefile",
         rules => [{elvis_project, no_deps_master_erlang_mk, #{ignore => []}},
-                  {elvis_project, git_for_deps_erlang_mk, #{ignore => []}}]
+                  {elvis_project, protocol_for_deps_erlang_mk, #{ignore => []}}]
        },
       #{dirs => ["."],
         filter => "rebar.config",
         rules => [{elvis_project, no_deps_master_rebar, #{ignore => []}},
-                  {elvis_project, git_for_deps_rebar, #{ignore => []}}]
+                  {elvis_project, protocol_for_deps_rebar, #{ignore => []}}]
        },
       #{dirs => ["."],
         filter => "elvis.config",

diff --git a/config/old/elvis-test-rule-config-list.config b/config/old/elvis-test-rule-config-list.config
@@ -29,13 +29,13 @@
        },
       #{dirs => ["."],
         filter => "Makefile",
-        rules => [{elvis_project, no_deps_master_erlang_mk, #{ignore => []}},
-                  {elvis_project, git_for_deps_erlang_mk, #{ignore => []}}]
+        rules => [{elvis_project, no_deps_master_erlang_mk, []},
+                  {elvis_project, protocol_for_deps_erlang_mk, []}]
        },
       #{dirs => ["."],
         filter => "rebar.config",
-        rules => [{elvis_project, no_deps_master_rebar, #{ignore => []}},
-                  {elvis_project, git_for_deps_rebar, #{ignore => []}}]
+        rules => [{elvis_project, no_deps_master_rebar, []},
+                  {elvis_project, protocol_for_deps_rebar, []}]
        },
       #{dirs => ["."],
         filter => "elvis.config",

diff --git a/config/test.config b/config/test.config
@@ -33,12 +33,12 @@
       #{dirs => ["."],
         filter => "Makefile",
         rules => [{elvis_project, no_deps_master_erlang_mk, #{ignore => []}},
-                  {elvis_project, git_for_deps_erlang_mk, #{ignore => []}}]
+                  {elvis_project, protocol_for_deps_erlang_mk, #{ignore => []}}]
        },
       #{dirs => ["."],
         filter => "rebar.config",
         rules => [{elvis_project, no_deps_master_rebar, #{ignore => []}},
-                  {elvis_project, git_for_deps_rebar, #{ignore => []}}]
+                  {elvis_project, protocol_for_deps_rebar, #{ignore => []}}]
        },
       #{dirs => ["."],
         filter => "elvis.config",

diff --git a/elvis.config b/elvis.config
@@ -34,12 +34,12 @@
       #{dirs => ["."],
         filter => "Makefile",
         rules => [{elvis_project, no_deps_master_erlang_mk, #{ignore => []}},
-                  {elvis_project, git_for_deps_erlang_mk, #{ignore => []}}]
+                  {elvis_project, protocol_for_deps_erlang_mk, #{ignore => []}}]
        },
       #{dirs => ["."],
         filter => "rebar.config",
         rules => [{elvis_project, no_deps_master_rebar, #{ignore => []}},
-                  {elvis_project, git_for_deps_rebar, #{ignore => []}}]
+                  {elvis_project, protocol_for_deps_rebar, #{ignore => []}}]
        },
       #{dirs => ["."],
         filter => "elvis.config",

diff --git a/src/elvis_project.erl b/src/elvis_project.erl
@@ -3,7 +3,9 @@
 -export([
          no_deps_master_erlang_mk/3,
          no_deps_master_rebar/3,
+         protocol_for_deps_erlang_mk/3,
          git_for_deps_erlang_mk/3,
+         protocol_for_deps_rebar/3,
          git_for_deps_rebar/3,
          old_configuration_format/3
         ]).
@@ -26,15 +28,25 @@
 %% Rules
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
--type git_for_deps_erlang_mk_config() :: #{ignore => [module()]}.
+-type protocol_for_deps_erlang_mk_config() :: #{ignore => [module()]}.
 
+%% Deprecated
 -spec git_for_deps_erlang_mk(elvis_config:config(),
                              elvis_file:file(),
-                             git_for_deps_erlang_mk_config()) ->
+                             protocol_for_deps_erlang_mk_config()) ->
     [elvis_result:item()].
-git_for_deps_erlang_mk(_Config, Target, RuleConfig) ->
+git_for_deps_erlang_mk(Config, Target, RuleConfig) ->
+    elvis_utils:error_prn("This rule has been deprecated please use "
+                          "'protocol_for_deps_erlang_mk'."),
+    protocol_for_deps_erlang_mk(Config, Target, RuleConfig).
+
+-spec protocol_for_deps_erlang_mk(elvis_config:config(),
+                             elvis_file:file(),
+                             protocol_for_deps_erlang_mk_config()) ->
+    [elvis_result:item()].
+protocol_for_deps_erlang_mk(_Config, Target, RuleConfig) ->
     IgnoreDeps = maps:get(ignore, RuleConfig, []),
-    Regex = maps:get(regex, RuleConfig, "git://.*"),
+    Regex = maps:get(regex, RuleConfig, "https://.*"),
     Deps = get_erlang_mk_deps(Target),
     BadDeps = lists:filter(fun(Dep) -> is_erlang_mk_not_git_dep(Dep, Regex) end,
                            Deps),
@@ -43,13 +55,22 @@ git_for_deps_erlang_mk(_Config, Target, RuleConfig) ->
             erlang_mk_dep_to_result(Line, ?DEP_NO_GIT, {IgnoreDeps, Regex})
         end, BadDeps).
 
--type git_for_deps_rebar_config() :: #{ignore => [module()]}.
+-type protocol_for_deps_rebar_config() :: #{ignore => [module()]}.
 
 -spec git_for_deps_rebar(elvis_config:config(),
                          elvis_file:file(),
-                         git_for_deps_rebar_config()) ->
+                         protocol_for_deps_rebar_config()) ->
+    [elvis_result:item()].
+git_for_deps_rebar(Config, Target, RuleConfig) ->
+    elvis_utils:error_prn("This rule has been deprecated please use "
+                          "'protocol_for_deps_rebar'."),
+    protocol_for_deps_rebar(Config, Target, RuleConfig).
+
+-spec protocol_for_deps_rebar(elvis_config:config(),
+                         elvis_file:file(),
+                         protocol_for_deps_rebar_config()) ->
     [elvis_result:item()].
-git_for_deps_rebar(_Config, Target, RuleConfig) ->
+protocol_for_deps_rebar(_Config, Target, RuleConfig) ->
     IgnoreDeps = maps:get(ignore, RuleConfig, []),
     Regex = maps:get(regex, RuleConfig, "git://.*"),
     Deps = get_rebar_deps(Target),

diff --git a/test/project_SUITE.erl b/test/project_SUITE.erl
@@ -10,7 +10,9 @@
          verify_no_deps_master_erlang_mk/1,
          verify_no_deps_master_rebar/1,
          verify_git_for_deps_erlang_mk/1,
+         verify_protocol_for_deps_erlang_mk/1,
          verify_git_for_deps_rebar/1,
+         verify_protocol_for_deps_rebar/1,
          verify_old_config_format/1
         ]).
 
@@ -93,10 +95,11 @@ verify_git_for_deps_erlang_mk(_Config) ->
     Filename = "Makefile.fail",
     {ok, File} = elvis_test_utils:find_file(SrcDirs, Filename),
 
-    [_, _, _] = elvis_project:git_for_deps_erlang_mk(ElvisConfig, File, #{}),
+    [_, _, _, _, _, _] =
+        elvis_project:git_for_deps_erlang_mk(ElvisConfig, File, #{}),
 
     RuleConfig =  #{ignore => [sync]},
-    [_, _] = elvis_project:git_for_deps_erlang_mk(ElvisConfig,
+    [_, _, _, _, _] = elvis_project:git_for_deps_erlang_mk(ElvisConfig,
                                                   File,
                                                   RuleConfig),
 
@@ -110,6 +113,32 @@ verify_git_for_deps_erlang_mk(_Config) ->
                                                            File,
                                                            RuleConfig2).
 
+-spec verify_protocol_for_deps_erlang_mk(config()) -> any().
+verify_protocol_for_deps_erlang_mk(_Config) ->
+    ElvisConfig = elvis_config:default(),
+    SrcDirs = elvis_config:dirs(ElvisConfig),
+
+    Filename = "Makefile.fail",
+    {ok, File} = elvis_test_utils:find_file(SrcDirs, Filename),
+
+    [_, _, _, _, _, _] =
+        elvis_project:protocol_for_deps_erlang_mk(ElvisConfig, File, #{}),
+
+    RuleConfig =  #{ignore => [sync]},
+    [_, _, _, _, _] = elvis_project:protocol_for_deps_erlang_mk(ElvisConfig,
+                                                  File,
+                                                  RuleConfig),
+
+    RuleConfig1 = #{ignore => [sync, meck], regex => "git://.*"},
+    [_] = elvis_project:protocol_for_deps_erlang_mk(ElvisConfig,
+                                               File,
+                                               RuleConfig1),
+
+    RuleConfig2 = #{ignore => [sync], regex => "https://.*"},
+    [_, _, _, _, _] = elvis_project:protocol_for_deps_erlang_mk(ElvisConfig,
+                                                           File,
+                                                           RuleConfig2).
+
 -spec verify_git_for_deps_rebar(config()) -> any().
 verify_git_for_deps_rebar(_Config) ->
     ElvisConfig = elvis_config:default(),
@@ -130,6 +159,26 @@ verify_git_for_deps_rebar(_Config) ->
     [_, _, _, _] =
         elvis_project:git_for_deps_rebar(ElvisConfig, File, RuleConfig2).
 
+-spec verify_protocol_for_deps_rebar(config()) -> any().
+verify_protocol_for_deps_rebar(_Config) ->
+    ElvisConfig = elvis_config:default(),
+    SrcDirs = elvis_config:dirs(ElvisConfig),
+
+    Filename = "rebar.config.fail",
+    {ok, File} = elvis_test_utils:find_file(SrcDirs, Filename),
+
+    [_, _] = elvis_project:protocol_for_deps_rebar(ElvisConfig, File, #{}),
+
+    RuleConfig =  #{ignore => [getopt]},
+    [_] = elvis_project:protocol_for_deps_rebar(ElvisConfig, File, RuleConfig),
+
+    RuleConfig1 =  #{ignore => [getopt, lager]},
+    [] = elvis_project:protocol_for_deps_rebar(ElvisConfig, File, RuleConfig1),
+
+    RuleConfig2 =  #{ignore => [meck], regex => "git@.*"},
+    [_, _, _, _] =
+        elvis_project:protocol_for_deps_rebar(ElvisConfig, File, RuleConfig2).
+
 -spec verify_old_config_format(config()) -> any().
 verify_old_config_format(_Config) ->
     ElvisConfig = elvis_config:default(),