yamllint version 1.12.1

Original implementation was completely broken. Documentation and actual
behavior were different. Numbers and booleans were detected as wrong, as
well as explicit types.

Fixes #136 and #130.

.gitignore

@@ -3,3 +3,4 @@ __pycache__
 /docs/_build
 /dist
 /yamllint.egg-info
+/build

CHANGELOG.rst

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+1.12.1 (2018-10-17)
+-------------------
+
+- Fix the `quoted-strings` rule, broken implementation
+- Fix missing documentation for the `quoted-strings` rule
+
 1.12.0 (2018-10-04)
 -------------------
 

docs/rules.rst

@@ -104,6 +104,11 @@ octal-values
 
 .. automodule:: yamllint.rules.octal_values
 
+quoted-strings
+--------------
+
+.. automodule:: yamllint.rules.quoted_strings
+
 trailing-spaces
 ---------------
 

tests/rules/test_quoted_strings.py

@@ -34,19 +34,19 @@ class QuotedTestCase(RuleTestCase):
     def test_quote_type_any(self):
         conf = 'quoted-strings: {quote-type: any}\n'
         self.check('---\n'
-                   'string1: "foo"\n'
+                   'boolean1: true\n'
-                   'number1: 123\n'                          # fails
+                   'number1: 123\n'
-                   'string2: foo\n'                          # fails
+                   'string1: foo\n'                          # fails
+                   'string2: "foo"\n'
                    'string3: \'bar\'\n'
-                   'string4: !!str genericstring\n'          # fails
+                   'string4: !!str genericstring\n'
-                   'string5: !!str 456\n'                    # fails
+                   'string5: !!str 456\n'
                    'string6: !!str "quotedgenericstring"\n'
                    'binary: !!binary binstring\n'
                    'integer: !!int intstring\n'
-                   'boolean1: !!bool boolstring\n'
+                   'boolean2: !!bool boolstring\n'
-                   'boolean2: !!bool "quotedboolstring"\n',
+                   'boolean3: !!bool "quotedboolstring"\n',
-                   conf, problem1=(3, 10), problem2=(4, 10),
+                   conf, problem=(4, 10))
-                   problem3=(6, 16), problem4=(7, 16))
         self.check('---\n'
                    'multiline string 1: |\n'
                    '  line 1\n'
@@ -65,19 +65,19 @@ class QuotedTestCase(RuleTestCase):
     def test_quote_type_single(self):
         conf = 'quoted-strings: {quote-type: single}\n'
         self.check('---\n'
-                   'string1: "foo"\n'                        # fails
+                   'boolean1: true\n'
-                   'number1: 123\n'                          # fails
+                   'number1: 123\n'
-                   'string2: foo\n'                          # fails
+                   'string1: foo\n'                          # fails
+                   'string2: "foo"\n'                        # fails
                    'string3: \'bar\'\n'
-                   'string4: !!str genericstring\n'          # fails
+                   'string4: !!str genericstring\n'
-                   'string5: !!str 456\n'                    # fails
+                   'string5: !!str 456\n'
-                   'string6: !!str "quotedgenericstring"\n'  # fails
+                   'string6: !!str "quotedgenericstring"\n'
                    'binary: !!binary binstring\n'
                    'integer: !!int intstring\n'
-                   'boolean1: !!bool boolstring\n'
+                   'boolean2: !!bool boolstring\n'
-                   'boolean2: !!bool "quotedboolstring"\n',
+                   'boolean3: !!bool "quotedboolstring"\n',
-                   conf, problem1=(2, 10), problem2=(3, 10), problem3=(4, 10),
+                   conf, problem1=(4, 10), problem2=(5, 10))
-                   problem4=(6, 16), problem5=(7, 16), problem6=(8, 16))
         self.check('---\n'
                    'multiline string 1: |\n'
                    '  line 1\n'
@@ -96,19 +96,19 @@ class QuotedTestCase(RuleTestCase):
     def test_quote_type_double(self):
         conf = 'quoted-strings: {quote-type: double}\n'
         self.check('---\n'
-                   'string1: "foo"\n'
+                   'boolean1: true\n'
-                   'number1: 123\n'                          # fails
+                   'number1: 123\n'
-                   'string2: foo\n'                          # fails
+                   'string1: foo\n'                          # fails
+                   'string2: "foo"\n'
                    'string3: \'bar\'\n'                      # fails
-                   'string4: !!str genericstring\n'          # fails
+                   'string4: !!str genericstring\n'
-                   'string5: !!str 456\n'                    # fails
+                   'string5: !!str 456\n'
                    'string6: !!str "quotedgenericstring"\n'
                    'binary: !!binary binstring\n'
                    'integer: !!int intstring\n'
-                   'boolean1: !!bool boolstring\n'
+                   'boolean2: !!bool boolstring\n'
-                   'boolean2: !!bool "quotedboolstring"\n',
+                   'boolean3: !!bool "quotedboolstring"\n',
-                   conf, problem1=(3, 10), problem2=(4, 10), problem3=(5, 10),
+                   conf, problem1=(4, 10), problem2=(6, 10))
-                   problem4=(6, 16), problem5=(7, 16))
         self.check('---\n'
                    'multiline string 1: |\n'
                    '  line 1\n'

yamllint/__init__.py

@@ -22,7 +22,7 @@ indentation, etc."""
 
 
 APP_NAME = 'yamllint'
-APP_VERSION = '1.12.0'
+APP_VERSION = '1.12.1'
 APP_DESCRIPTION = __doc__
 
 __author__ = u'Adrien Vergé'

yamllint/rules/quoted_strings.py

@@ -16,8 +16,8 @@
 
 """
 Use this rule to forbid any string values that are not quoted.
-You can also enforce the type of the quote used - single or double - using the
+You can also enforce the type of the quote used using the ``quote-type`` option
-``quote-type`` option.
+(``single``, ``double`` or ``any``).
 
 **Note**: Multi-line strings (with ``|`` or ``>``) will not be checked.
 
@@ -51,24 +51,27 @@ CONF = {'quote-type': ('any', 'single', 'double')}
 def check(conf, token, prev, next, nextnext, context):
     quote_type = conf['quote-type']
 
-    if prev and isinstance(prev, yaml.tokens.TagToken):
+    if (isinstance(token, yaml.tokens.ScalarToken) and
-        if prev.value[1] != "str":
+            isinstance(prev, (yaml.ValueToken, yaml.TagToken))):
-            # we ignore generic strings, e.g. somestring: !!str testtest
+        # Ignore explicit types, e.g. !!str testtest or !!int 42
+        if (prev and isinstance(prev, yaml.tokens.TagToken) and
+                prev.value[0] == '!!'):
             return
 
-    if isinstance(token, yaml.tokens.ScalarToken):
+        # Ignore numbers, booleans, etc.
-        if isinstance(prev, yaml.tokens.ValueToken) or \
+        resolver = yaml.resolver.Resolver()
-           isinstance(prev, yaml.tokens.TagToken):
+        if resolver.resolve(yaml.nodes.ScalarNode, token.value,
-            if ((not token.plain) and
+                            (True, False)) != 'tag:yaml.org,2002:str':
-                    ((token.style == "|") or (token.style == ">"))):
+            return
-                # we ignore multi-line strings
-                return
 
-            if ((quote_type == 'single' and token.style != "'") or
+        # Ignore multi-line strings
-                    (quote_type == 'double' and token.style != '"') or
+        if (not token.plain) and (token.style == "|" or token.style == ">"):
-                    (quote_type == 'any' and token.style is None)):
+            return
-                yield LintProblem(
+
-                    token.start_mark.line + 1,
+        if ((quote_type == 'single' and token.style != "'") or
-                    token.start_mark.column + 1,
+                (quote_type == 'double' and token.style != '"') or
-                    "string value is not quoted with %s quotes" % (quote_type)
+                (quote_type == 'any' and token.style is None)):
-                )
+            yield LintProblem(
+                token.start_mark.line + 1,
+                token.start_mark.column + 1,
+                "string value is not quoted with %s quotes" % (quote_type))