YAMLLintBear: Make document-start rule disabled

Disable YAMLLint rule `document-start` by default because
many YAML files have no need for start and end markers, but
user still can enable it by using `document_start=true`
setting.

Closes #923

Author: refeed

bears/yml/YAMLLintBear.py

@@ -1,5 +1,6 @@
 from coalib.bearlib.abstractions.Linter import linter
 from coalib.bears.requirements.PipRequirement import PipRequirement
+import yaml
 
 
 @linter(executable='yamllint',
@@ -9,7 +10,6 @@
 class YAMLLintBear:
     """
     Check yaml code for errors and possible problems.
-
     You can read more about capabilities at
     <http://yamllint.readthedocs.org/en/latest/rules.html>.
     """
@@ -21,6 +21,27 @@ class YAMLLintBear:
     LICENSE = 'AGPL-3.0'
     CAN_DETECT = {'Syntax', 'Formatting'}
 
+    @staticmethod
+    def generate_config(filename, file,
+                        document_start: bool=False):
+        """
+        :param document_start:
+            Use this rule to require or forbid the use of document start
+            marker (---).
+        """
+        yamllint_configs = {
+            'extends': 'default',
+            'rules': {
+                'document-start': {
+                    'present': False
+                 }
+            }
+        }
+        if document_start:
+            yamllint_configs['rules']['document-start']['present'] = True
+
+        return yaml.dump(yamllint_configs)
+
     @staticmethod
     def create_arguments(filename, file, config_file, yamllint_config: str=''):
         """
@@ -29,4 +50,6 @@ def create_arguments(filename, file, config_file, yamllint_config: str=''):
         args = ('-f', 'parsable', filename)
         if yamllint_config:
             args += ('--config=' + yamllint_config,)
+        else:
+            args += ('--config-file=' + config_file,)
         return args

tests/yml/YAMLLintBearTest.py

@@ -18,6 +18,32 @@
 ...
 """
 
+no_start_yml_file = """receipt: Oz-Ware Purchase Invoice
+date: 2012-08-06
+customer:
+    first_name: Dorothy
+    family_name: Gale
+
+items:
+    - part_no: A4786
+      descrip: Water Bucket (Filled)
+      price: 1.47
+      quantity: 4"""
+
+with_start_yml_file = """---
+receipt: Oz-Ware Purchase Invoice
+date: 2012-08-06
+customer:
+    first_name: Dorothy
+    family_name: Gale
+
+items:
+    - part_no: A4786
+      descrip: Water Bucket (Filled)
+      price: 1.47
+      quantity: 4
+..."""
+
 config_file = """
 extends:
     default
@@ -42,3 +68,13 @@
                                           invalid_files=(),
                                           settings={
                                               'yamllint_config': conf_file})
+
+YAMLLintBear3Test = verify_local_bear(YAMLLintBear,
+                                      valid_files=(no_start_yml_file,),
+                                      invalid_files=(with_start_yml_file,))
+
+YAMLLintBear4Test = verify_local_bear(YAMLLintBear,
+                                      valid_files=(with_start_yml_file,),
+                                      invalid_files=(no_start_yml_file,),
+                                      settings={
+                                          'document_start': True})