Merge lp:~diego-biurrun/bzr-text-checker/dos-linebreaks into lp:bzr-text-checker

[Diego Biurrun]

I stumbled across this plugin and extended it to cover DOS linebreaks, which are things that I like to avoid getting added to non-Windows projects.

I tested this branch, it works and performs as expected. However, this is my very first stab at hacking Python and was done as a quick hack by using copy and paste with (hopefully) appropriate changes. Please review it thoroughly.

[Marius Kruger (amanica)]

Thanks for the patch, I'll look at it soon.
I'd like to add a test and make sure the configuration key names are
consistent with the core line-end filtering options before merging.

[Diego Biurrun (diego-biurrun)]

... ping ...

Could you look at this patch again and merge it or tell me what to fix please?

[Marius Kruger (amanica)]

I'm approving this since I did merge it into trunk for completeness, but I changed the workings quite a bit afterwards. The rule options are now more generic and is more like the core eol rules:
check_eol={ignore|warn|fail}
check_eol_type={crlf|lf} (fails if a line doesn't match)
I also added tests.
Any comments/suggestions welcome.
I intend to add some more minor features and release 0.4 .

review: Approve

[Marius Kruger (amanica)]

btw. thanks for the ping again, sorry for the delay, I'm just a bit busy

=== modified file 'text_checker.py'
--- text_checker.py	2009-05-04 22:10:53 +0000
+++ text_checker.py	2010-12-13 14:45:14 +0000
@@ -41,6 +41,7 @@
         self.tabs = {}
         self.long_lines = {}
         self.no_newline_at_eof = []
+        self.dos_linebreaks = {}
         self.problems = {'warn':[], 'fail':[]}
 
     def _reset_actions(self):
@@ -50,6 +51,7 @@
         self.no_newline_at_eof_action = 'ignore'
         self.long_lines_action = 'ignore'
         self.long_line_length = DEFAULT_LONGLINE_LENGTH
+        self.dos_linebreaks_action = 'ignore'
 
     def _push_file_line(self, dict_, fname, line_no):
         if fname not in dict_:
@@ -77,7 +79,7 @@
         self._reset_actions()
         rules_seq = tuple(tree.iter_search_rules((path,),
             pref_names=('trailing_whitespace', 'tabs', 'newline_at_eof',
-                'long_lines', 'long_line_length'), **kwargs))[0]
+                'long_lines', 'long_line_length', 'dos_linebreaks'), **kwargs))[0]
         if len(rules_seq) >= 3:
             self._set_action_val(rules_seq, 0, 'trailing_whitespace_action')
             self._set_action_val(rules_seq, 1, 'tabs_action')
@@ -85,6 +87,7 @@
             self._set_action_val(rules_seq, 3, 'long_lines_action')
             self._set_action_val(rules_seq, 4, 'long_line_length',
                 convertion_function=int)
+            self._set_action_val(rules_seq, 5, 'dos_linebreaks_action')
         return len(rules_seq) >= 3
 
     def check_coding_style(self, old_filename, oldlines, new_filename,
@@ -105,6 +108,8 @@
                     line)
                 if '\t' in line:
                     self._push_file_line(self.tabs, new_filename, line_no)
+                if '\r' in line:
+                    self._push_file_line(self.dos_linebreaks, new_filename, line_no)
                 if trailing_ws_match:
                     line_content = trailing_ws_match.group(1)
                     has_trailing_whitespace = bool(trailing_ws_match.group(3))
@@ -154,6 +159,12 @@
                 "newline at the end:"
                '\n    %s'
                % ('\n    '.join(self.no_newline_at_eof)))
+        if self.dos_linebreaks:
+            self._append_problem(self.dos_linebreaks_action,
+                self._format_message(self.dos_linebreaks,
+                    'DOS linebreaks was found in the following files:'
+                )
+            )
         if _text_check_warn_only:
            self.problems['warn'].extend(self.problems['fail'])
            self.problems['fail'] = []