CPPLintBear.py: Add check_invalid_config test #1165

SarthakNijhawan · 2016-12-18T11:10:50Z

CPPlintbear supports only use of spaces with indent_size = 2, according
to the CPPLint style-guide ,previously no check was present.

Fixes #896

gitmate-bot · 2016-12-18T11:11:06Z

Thanks for your contribution!

Reviewing pull requests take really a lot of time and we're all volunteers. Please make sure you go through the following check list and complete them all before pinging someone for a review.

I have rebased properly. Please see this for a tutorial.
I have gone through the commit guidelines and I've followed them:
I have followed the guidelines for the commit shortlog.
I have followed the guidelines for the commit body.
I have included the issue URL.
I have used the Fixes keyword if the commit fixes a real bug and the Closes keyword if it adds a feature/enhancement. See more here.
I have run all the tests and they all pass. That includes that all CI (below) is green - if GitMate issues appear you will have to amend your commits, pushing new commits on top is not sufficient!

As you learn things over your Pull Request please help others on the chat and on PRs to get their stuff right as well!

SarthakNijhawan · 2016-12-18T11:12:02Z

@jayvdb I have created the pull request .. please take a look ...and suggest the necessary ... 😃
and @Mixih here I have created another .... pls have a look .. Thnks for the help though .. 😄

AsnelChristian · 2016-12-18T13:16:54Z

bears/c_languages/CPPLintBear.py

-                         cpplint_include: typed_list(str)=()):
+                         cpplint_include: typed_list(str)=(),
+                         indent_size: int=2,
+                         use_spaces: bool=2):


bool = True

Oh sorry ...yea ....True , my bad ! 😛

AsnelChristian · 2016-12-18T13:18:22Z

bears/c_languages/CPPLintBear.py

@@ -2,6 +2,10 @@
 from coalib.bears.requirements.PipRequirement import PipRequirement
 from coalib.settings.Setting import typed_list

+def check_invalid_config(use_spaces, indent_size):
+    if not use_spaces or indent_size != 2:
+        return False


wait... does this mean that indent_size cannot be changed ?, then why do we need it 😅

No the issue demanded it #896 .... thats why I did the very way ..

@AsnelChristian We need to verify that the user has not changed it from indent_size=2. If they did, the bear will not honour their configuration , and the user should be informed.

AsnelChristian · 2016-12-18T13:22:43Z

bears/c_languages/CPPLintBear.py

        """
        :param max_line_length: Maximum number of characters for a line.
        :param cpplint_ignore:  List of checkers to ignore.
        :param cpplint_include: List of checkers to explicitly enable.
+        :param use_spaces: Bool value whether to use spaces or not.


True if spaces are to be used instead i think that is what is used almost everywhere
maybe you should use that for consistency...
and also align the param docs ( the should start at the same column)

Ok , i'll change that ...

AsnelChristian · 2016-12-18T13:23:53Z

bears/c_languages/CPPLintBear.py

        """
+        if not check_invalid_config(use_spaces, indent_size):
+            raise ValueError("CPPLint doesn\'t support indent_size != 2 or "
+ +                             "not using spaces.")


really i don't see the point of having this setting if the user cannot customize it... what do you think @SarthakNijhawan ?

Mixih · 2016-12-20T15:57:46Z

Disable your circle builds as they don't have the right number of containers...

Mixih

Also builds are failing because the bear doesn't complain when bad indent options are passed.

Mixih · 2016-12-20T18:21:11Z

Please disable your circle building

SarthakNijhawan · 2016-12-21T05:28:17Z

@Mixih Done!

jayvdb · 2016-12-22T02:38:31Z

bears/c_languages/CPPLintBear.py

        """
        :param max_line_length: Maximum number of characters for a line.
        :param cpplint_ignore:  List of checkers to ignore.
        :param cpplint_include: List of checkers to explicitly enable.
+        :param use_spaces:      True if spaces are to be used instead.


This will be used in documentation. It should say that the only acceptable value is True. Likewise for indent_size.

Ok, I'll change it.

sils · 2017-01-03T11:59:34Z

Adds is the wrong tense, Add

gitmate-bot · 2017-01-10T16:39:08Z