bears/c_languages: Add ArtisticStyleBear #1882

yash-nisar · 2017-07-03T06:22:24Z

Closes #388

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

I read the commit guidelines and I've followed
them.
I ran coala over my code locally. (All commits have to pass
individually. It is not sufficient to have "fixup commits" on your PR,
our bot will still report the issues for the previous commit.) You will
likely receive a lot of bot comments and build failures if coala does not
pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

pick up any PR at https://coala.io/review
review it (check https://coala.io/reviewing for more info)
if you are sure that it needs work, use cobot mark wip <URL> to get it out
of the review queue.

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

gitmate-bot · 2017-07-03T06:23:22Z

.ci/deps.sh

+  tar xf ~/astyle.tar.gz -C ~/
+  cd ~/astyle/build/gcc
+  make
+fi


Line contains following spacing inconsistencies:

No newline at EOF.

SpaceConsistencyBear, severity NORMAL, section ci.

The issue can be fixed by applying the following patch:

--- a/.ci/deps.sh +++ b/.ci/deps.sh @@ -62,4 +62,4 @@ tar xf ~/astyle.tar.gz -C ~/ cd ~/astyle/build/gcc make -fi+fi

yash-nisar · 2017-07-04T09:17:13Z

bears/c_languages/ArtisticStyleBear.py

+                         break_one_line_headers: bool=False,
+                         add_braces_to_one_line_conditionals: bool=False,
+                         remove_braces_from_one_line_conditionals: bool=False,
+                         remove_comment_prefix: bool=True):


Custom config file argument missing, see http://astyle.sourceforge.net/astyle.html#_Options_File

hm there's --options, or what do you mean?

I mean I have to provide an argument called as astyle_config_file, will do it in the review iteration. 😉

another PR :)

AsnelChristian · 2017-07-04T09:35:07Z

bears/c_languages/ArtisticStyleBear.py

+                         attach_braces_to_namespace: bool=True,
+                         attach_braces_to_class: bool=True,
+                         attach_braces_to_inline: bool=True,
+                         attach_braces_to_extern: bool=False,


settings' names usually start with either allow, prohibit or use would you follow that convention ? this is super important as it is part of settings unification

@yash-nisar bump again :)

Fixed. 👍

AsnelChristian · 2017-07-04T09:39:37Z

bears/c_languages/ArtisticStyleBear.py

+                    bar()
+                    return 1; }
+                else
+                    return 0; }


can you shorten this... maybe providing us the list of all ppossible values for this settting along with fewer examples and more tests would do the trick.

I actually don't have something against this longer documentation, but we definitely need some header line that summarizes the possible values and their meanings in a few sentences 👍

AsnelChristian · 2017-07-04T09:41:06Z

bears/c_languages/ArtisticStyleBear.py

+                    return 0; }
+
+        :param use_spaces:
+            In the following examples, q space is indicated with a . (dot), a


q -> q; . -> .

missing documentation ion this parameter, (and this shoulb be said after the doc)

Addressed 👍

AsnelChristian · 2017-07-04T09:45:48Z

bears/c_languages/ArtisticStyleBear.py

+                ........bar();
+                }
+
+            For example: If set to ``True``, spaces will be used for


If True spaces will be used.
Example:: (should be a code if not example is not needed

AsnelChristian · 2017-07-04T09:47:42Z

bears/c_languages/ArtisticStyleBear.py

+            For example: If set to ``True``, spaces will be used for
+            indentation.
+            For example: If set to ``False``, tabs will be used for
+            indentation, and spaces for continuation line alignment as below::


AsnelChristian · 2017-07-04T09:49:03Z

bears/c_languages/ArtisticStyleBear.py

+                }
+
+        :param indent_size:
+            Specifies the number of spaces per indent.


Number of spaces per indentation level use the same docs as in the other bears

Addressed 👍

yash-nisar · 2017-07-06T06:53:50Z

@Makman2 Please have a look when you're free 😉

yash-nisar · 2017-07-06T11:33:22Z

Can you help me out with the appveyor build failure ? @Makman2

yash-nisar · 2017-07-06T15:15:34Z

An uncached CircleCI build passes whereas a cached build fails. Note that TravisCI builds pass.

Makman2 · 2017-07-10T14:53:13Z

bears/c_languages/ArtisticStyleBear.py

+            args.append(indent + '=' + str(indent_size))
+        for k, v in rules_map.items():
+            if v:
+                args.append(k)


can be shortened:

args += (k for k, v in rules_map.items() if v) # don't use [] to prevent creating a intermediate list.

Makman2 · 2017-07-10T15:00:01Z

bears/c_languages/ArtisticStyleBear.py

+        else:
+            indent = '--indent=tab'
+        if indent is not None:
+            args.append(indent + '=' + str(indent_size))


maybe create another dict for these value-parameters?

settings_map = {'--indent': None if use_spaces is None else 'spaces' is use_spaces else 'tab'} # <-- maybe you can beautify the if else expression a bit ;D # You could also add `--style` args += (k for k, v in settings_map.items() if v) # or: if v is not None, not sure what's better now

Makman2 · 2017-07-10T15:07:18Z

.ci/deps.sh

+  wget "https://downloads.sourceforge.net/project/astyle/astyle/astyle%203.0.1/astyle_3.0.1_linux.tar.gz?r=&ts=1499017588&use_mirror=excellmedia" -O ~/astyle.tar.gz
+  tar -xvzf ~/astyle.tar.gz -C ~/
+  cd ~/astyle/build/gcc
+  make


it's not shipped prebuilt? :O

It is shipped prebuilt but the version spec is low i.e. 2.03-1, see https://packages.ubuntu.com/trusty/astyle.

Our CI also uses trusty for which we would have to install the version 2.03-1, which is pretty old IMO. For installing the latest version, building it is the only method.

ah kk, but I meant when you download the tar.gz file, aren't there some precompiled binaries inside?

Nope, the ...bin folder is generated once we build it.

Makman2 · 2017-07-10T15:11:59Z

.ci/deps.sh

+if [ ! -e ~/astyle/build/gcc/bin/astyle ]; then
+  wget "https://downloads.sourceforge.net/project/astyle/astyle/astyle%203.0.1/astyle_3.0.1_linux.tar.gz?r=&ts=1499017588&use_mirror=excellmedia" -O ~/astyle.tar.gz
+  tar -xvzf ~/astyle.tar.gz -C ~/
+  cd ~/astyle/build/gcc


after making astyle you should step out again into the previous working directory to prevent weird errors for coming installations. Or use the -C/--directory flag of make.

Makman2 · 2017-07-10T15:15:39Z

bears/c_languages/ArtisticStyleBear.py

+    """
+
+    LANGUAGES = {'C', 'C++', 'Objective-C', 'C#', 'Java'}
+    REQUIREMENTS = {DistributionRequirement(apt_get='astyle')}


astyle is also available for dnf in Fedora 26 :)

yash-nisar · 2017-07-11T09:33:38Z

@Makman2 How do the changes look now ?

Makman2 · 2017-07-11T10:04:58Z

@yash-nisar your tests fail :O

Makman2 · 2017-07-11T10:10:02Z

bears/c_languages/ArtisticStyleBear.py

+            '--remove-brackets': remove_braces_from_one_line_conditionals,
+            '--remove-comment-prefix': remove_comment_prefix
+        }
+        args = ('--suffix=none', '--dry-run')


use a list, that's faster to append to

Makman2 · 2017-07-11T10:10:15Z

bears/c_languages/ArtisticStyleBear.py

+        if use_spaces is True:
+            args += (''.join(('-s', str(indent_size))),)
+        elif use_spaces is False:
+            args += (''.join(('-t', str(indent_size))),)


why not using another dict for this kind of parameters like I suggested before?

Makman2 · 2017-07-11T10:11:11Z

bears/c_languages/ArtisticStyleBear.py

+            args += (''.join(('-t', str(indent_size))),)
+        for k, v in rules_map.items():
+            if v:
+                args += (k,)


like said before, can be shortened:

args += (k for k, v in rules_map.items() if v)

Awesome 👍

Makman2 · 2017-07-11T12:30:24Z

bears/c_languages/ArtisticStyleBear.py

+        }
+        args = ['--suffix=none', '--dry-run']
+        if bracket_style:
+            args += (''.join(('--style=', bracket_style)),)


use args.append, makes the command shorter

and I don't think you need to use join for just two values, I think this is easier and better to read ;)

args.append('--style=' + bracket_style)

gitmate-bot · 2017-07-19T14:56:54Z

bears/c_languages/ArtisticStyleBear.py

+                        return 0;
+                }
+
+            For example: ``Banner`` style uses attached, indented braces. Switch


Line is longer than allowed. (80 > 79)

LineLengthBear, severity NORMAL, section linelength.

gitmate-bot · 2017-07-19T14:56:56Z

bears/c_languages/ArtisticStyleBear.py

+                        return 0;
+                }
+
+            For example: ``Whitesmith`` style uses broken, indented braces. Switch


Line is longer than allowed. (82 > 79)

LineLengthBear, severity NORMAL, section linelength.

gitmate-bot · 2017-07-19T14:56:57Z

bears/c_languages/ArtisticStyleBear.py

+                        return 0;
+                }
+
+            For example: ``Banner`` style uses attached, indented braces. Switch


E501 line too long (80 > 79 characters)'

PycodestyleBear (E501), severity NORMAL, section autopep8.

gitmate-bot · 2017-07-19T14:56:58Z

bears/c_languages/ArtisticStyleBear.py

+                        return 0;
+                }
+
+            For example: ``Whitesmith`` style uses broken, indented braces. Switch


E501 line too long (82 > 79 characters)'

PycodestyleBear (E501), severity NORMAL, section autopep8.

Makman2 · 2017-07-20T00:42:48Z

.ci/deps.sh

@@ -55,3 +55,11 @@ if [ ! -e ~/phpmd/phpmd ]; then
  sudo chmod +x phpmd.phar
  sudo mv phpmd.phar ~/phpmd/phpmd
 fi
+
+# astyle installation
+if [ ! -e ~/astyle/build/gcc/bin/astyle ]; then


as you don't seem to cache at all currently, you don't need the if ;)

yash-nisar · 2017-07-20T06:58:08Z

@Makman2 Did you notice that the tests have passed and we have no idea why ? 😛

yash-nisar · 2017-07-20T06:58:31Z

They pass whenever they want to. 😛

AsnelChristian · 2017-07-20T19:26:12Z

bears/c_languages/ArtisticStyleBear.py

+            Possible values are ``allman, java, kr, stroustrup, whitesmith,
+            vtk, banner, gnu, linux, horstmann, google, mozilla, pico and
+            lisp.``
+            For example: Allman style uses braces that are broken from the


``Allman style``

Hm not sure, then rather

``allman`` style

to refer to the actual keyword/parameter

See #1882 (comment). Referring to the actual keyword/parameter may cause problems in some cases like Kernighan & Ritchie. The actual keyword is referred to as kr so replacing Kernighan & Ritchie with kr may make it difficult for users to understand the style name.

AsnelChristian · 2017-07-20T19:35:30Z

aren't they passing locally ?

Nosferatul · 2017-07-20T22:40:34Z

@yash-nisar why the tests have passed because of your tests, right?

Makman2 · 2017-07-20T22:40:56Z

@AsnelChristian we had strange caching problems. Cached runs just didn't pass, although everything seemed to be set up correctly (we did the same like for other applications). However we will file an issue to implement caching again, so we can at least get something merged.

yash-nisar · 2017-07-21T07:39:49Z

Updated with the required changes @Makman2 @AsnelChristian

yash-nisar · 2017-07-21T07:40:18Z

Lets see if the tests pass on CI, if they don't I'll remove the if condition in deps.sh.

yash-nisar · 2017-07-21T08:41:25Z

Bam ✨ The problem is now gone 👍 @Makman2

Closes coala#388

Makman2 · 2017-07-21T13:34:54Z

bears/c_languages/ArtisticStyleBear.py

+                         break_one_line_headers: bool=False,
+                         require_braces_at_one_line_conditionals: bool=False,
+                         prohibit_braces_from_one_line_conditionals:
+                         bool=False,


~~indent by 4 spaces~~

this is invalid PEP8 it seems

Makman2 · 2017-07-21T13:41:27Z

ack 65d6304

Makman2 · 2017-07-21T14:10:33Z

ack 65d6304

Makman2 · 2017-07-21T14:11:17Z

@rultor merge

rultor · 2017-07-21T14:12:25Z

@rultor merge

@Makman2 OK, I'll try to merge now. You can check the progress of the merge here

rultor · 2017-07-21T14:14:39Z

@rultor merge

@Makman2 Done! FYI, the full log is here (took me 2min)

gitmate-bot added process/pending review size/XXL review carefully! labels Jul 3, 2017

gitmate-bot reviewed Jul 3, 2017

View reviewed changes

yash-nisar force-pushed the astyle-bear branch from 5d23efb to 77a20cd Compare July 3, 2017 06:23

yash-nisar commented Jul 4, 2017

View reviewed changes

AsnelChristian requested changes Jul 4, 2017

View reviewed changes

yash-nisar force-pushed the astyle-bear branch from 77a20cd to f484e9b Compare July 5, 2017 14:37

yash-nisar force-pushed the astyle-bear branch 5 times, most recently from dd81188 to 0678801 Compare July 6, 2017 10:40

Makman2 reviewed Jul 10, 2017

View reviewed changes

yash-nisar force-pushed the astyle-bear branch from 0678801 to 2f74f8a Compare July 11, 2017 09:32

Makman2 reviewed Jul 11, 2017

View reviewed changes

yash-nisar force-pushed the astyle-bear branch from 2f74f8a to aaaae51 Compare July 11, 2017 11:44

Makman2 reviewed Jul 11, 2017

View reviewed changes

yash-nisar force-pushed the astyle-bear branch from aaaae51 to 5b27735 Compare July 11, 2017 12:46

gitmate-bot added the process/pending review label Jul 19, 2017

gitmate-bot reviewed Jul 19, 2017

View reviewed changes

yash-nisar force-pushed the astyle-bear branch from 87fd993 to 8b58180 Compare July 19, 2017 15:01

Makman2 reviewed Jul 20, 2017

View reviewed changes

AsnelChristian reviewed Jul 20, 2017

View reviewed changes

yash-nisar force-pushed the astyle-bear branch from 8b58180 to f4c7789 Compare July 21, 2017 07:39

yash-nisar force-pushed the astyle-bear branch from f4c7789 to 19e5337 Compare July 21, 2017 08:11

bears/c_languages: Add ArtisticStyleBear

65d6304

Closes coala#388

yash-nisar force-pushed the astyle-bear branch from 19e5337 to 65d6304 Compare July 21, 2017 13:24

Makman2 reviewed Jul 21, 2017

View reviewed changes

Makman2 added process/approved and removed process/pending review labels Jul 21, 2017

rultor merged commit 65d6304 into coala:master Jul 21, 2017

yash-nisar deleted the astyle-bear branch July 21, 2017 14:14

bears/c_languages: Add ArtisticStyleBear #1882

bears/c_languages: Add ArtisticStyleBear #1882

Conversation

yash-nisar commented Jul 3, 2017

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Makman2 Jul 10, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yash-nisar commented Jul 6, 2017

yash-nisar commented Jul 6, 2017

yash-nisar commented Jul 6, 2017

Makman2 Jul 10, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yash-nisar commented Jul 11, 2017

Makman2 commented Jul 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yash-nisar commented Jul 20, 2017

yash-nisar commented Jul 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AsnelChristian commented Jul 20, 2017

Nosferatul commented Jul 20, 2017

Makman2 commented Jul 20, 2017 • edited Loading

yash-nisar commented Jul 21, 2017

yash-nisar commented Jul 21, 2017

yash-nisar commented Jul 21, 2017

Makman2 Jul 21, 2017 • edited Loading

Choose a reason for hiding this comment

Makman2 commented Jul 21, 2017

Makman2 commented Jul 21, 2017

Makman2 commented Jul 21, 2017

rultor commented Jul 21, 2017

rultor commented Jul 21, 2017

Makman2 Jul 10, 2017 •

edited

Loading

Makman2 Jul 10, 2017 •

edited

Loading

yash-nisar commented Jul 20, 2017 •

edited

Loading

Makman2 commented Jul 20, 2017 •

edited

Loading

Makman2 Jul 21, 2017 •

edited

Loading