describe_sample_path() - Code Metrics - Inspection of "Enable Appveyor to test Windows compatiblity" - jacebrowning/memegen - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#194)

by Jace

created 2016-04-21 23:25 UTC

describe_sample_path() A

↳ Parent: describe_template()

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
cc	3
dl	0
loc	9
rs	9.6666

# pylint: disable=unused-variable,expression-not-assigned,misplaced-comparison-constant,singleton-comparison
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

from pathlib import Path
from unittest.mock import patch, Mock

import pytest
from expecter import expect
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

from memegen.domain import Template


def describe_template():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def it_supports_comparison():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        t1 = Template('abc', "A Thing")

        t2 = Template('def')

        t3 = Template('def', "Do This")


        assert t1 != t2
        assert t2 == t3
        assert t1 < t3

    def describe_get_path():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        @patch('pathlib.Path.is_file', Mock(return_value=True))
        def it_returns_default_when_no_style(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.get_path()) == Path("abc/default.png")

        @patch('pathlib.Path.is_file', Mock(return_value=True))
        def it_returns_alternate_when_style_provided(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.get_path('Custom')) == Path("abc/custom.png")

        @patch('pathlib.Path.is_file', Mock(return_value=True))
        def it_returns_default_when_style_is_none(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.get_path(None)) == Path("abc/default.png")

        @patch('pathlib.Path.is_file', Mock(return_value=False))
        def it_considers_urls_valid_styles(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            url = "http://example.com"
            path = Path("/tmp/a9b9f04336ce0181a08e774e01113b31")
            expect(template.get_path(url)) == path

        @patch('pathlib.Path.is_file', Mock(return_value=True))
        def it_caches_file_downloads(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            url = "http://this/will/be/ignored"
            path = Path("/tmp/d888710f0697650eb68fc9dcbb976d4c")
            expect(template.get_path(url)) == path

        def it_handles_bad_urls(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.get_path("http://invalid")) == None

    def describe_path():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        def is_returned_when_file_exists(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            template.root = "my_root"

            with patch('pathlib.Path.is_file', Mock(return_value=True)):
                path = template.path

            expect(path) == Path("my_root/abc/default.png")

        def is_none_when_no_file(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            template.root = "my_root"

            with patch('pathlib.Path.is_file', Mock(return_value=False)):
                path = template.path

            expect(path) == None

    def describe_default_path():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        def is_based_on_lines(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.default_path) == "foo/bar"

        def is_underscore_when_no_lines(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            template.lines = []

            expect(template.default_path) == "_"

    def describe_styles():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        @patch('os.listdir', Mock(return_value=[]))
        def is_empty_when_no_alternate_images(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.styles) == []

        @patch('os.listdir', Mock(return_value=['foo.jpg', 'bar.png']))
        def is_filesnames_of_alternate_images(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.styles) == ['bar', 'foo']

    def describe_sample_path():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        def is_based_on_lines(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.sample_path) == "foo/bar"

        def is_placeholder_when_no_lines(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            template.lines = []

            expect(template.sample_path) == "your-text/goes-here"

    def describe_match():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        def it_returns_none_when_no_match(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.match("")) == (0, None)

        def it_returns_the_best_matching_result(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            template.compile_regexes([r"(\w*)/?(abc)", r"(\w*)/?(def)"])

            expect(template.match("_/def")) == (0.42, "_/def")

    def describe_validate_meta():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        def with_no_name(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            template.name = None

            expect(template.validate_meta()) == False

        def with_no_default_image(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.validate_meta()) == False

        def with_nonalphanumberic_name(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            template.name = "'ABC' Meme"

            expect(template.validate_meta()) == False

    def describe_validate_link():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        def with_bad_link(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            mock_response = Mock()
            mock_response.status_code = 404

            with patch('requests.get', Mock(return_value=mock_response)):
                template.link = "example.com/fake"

                expect(template.validate_link()) == False

        @patch('pathlib.Path.is_file', Mock(return_value=True))
        def with_cached_valid_link(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            template.link = "already_cached_site.com"

            expect(template.validate_link()) == True

    def describe_validate_size():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        @pytest.mark.parametrize('dimensions,valid', [
            ((Template.MIN_WIDTH, Template.MIN_HEIGHT), True),
            ((Template.MIN_WIDTH - 1, Template.MIN_HEIGHT), False),
            ((Template.MIN_WIDTH, Template.MIN_HEIGHT - 1), False),
            ((Template.MIN_WIDTH - 1, Template.MIN_HEIGHT - 1), False),
        ])
        @patch('PIL.Image.open')
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        def with_various_dimenions(mock_open, template, dimensions, valid):
            mock_img = Mock()
            mock_img.size = dimensions
            mock_open.return_value = mock_img

            expect(template.validate_size()) == valid

    def describe_validate_regexes():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        def with_missing_split(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            template.compile_regexes([".*"])

            expect(template.validate_regexes()) == False

    def describe_validate():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        def with_no_validators(template):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(template.validate([])) == True

        def with_all_passing_validators(template):
            """Verify a template is valid if all validators pass."""
            mock_validators = [lambda: True]

            expect(template.validate(validators=mock_validators)) == True

        def with_one_failing_validator(template):
            """Verify a template is invalid if any validators fail."""
            mock_validators = [lambda: False]

            expect(template.validate(validators=mock_validators)) == False


Pull Request — master (#194)

describe_sample_path() A

Complexity

Size

Duplication

1. Missing Dependencies

2. Missing init.py files

1			# pylint: disable=unused-variable,expression-not-assigned,misplaced-comparison-constant,singleton-comparison
			0 ignored issues – show introduced 2016-04-02 23:21 UTC by Report Bug Copy Issue Report Bad option value 'misplaced-comparison-constant' Loading history... introduced 2016-04-02 23:21 UTC by Report Bug Copy Issue Report Bad option value 'singleton-comparison' Loading history... introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report Locally disabling unused-variable (W0612) Loading history... introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report Locally disabling expression-not-assigned (W0106) Loading history... Coding Style introduced 2015-11-29 01:37 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2
3			from pathlib import Path
4			from unittest.mock import patch, Mock
5
6			import pytest
7			from expecter import expect
			0 ignored issues – show Configuration introduced 2015-12-08 02:55 UTC by Report Bug Copy Issue Report The import `expecter` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
8
9			from memegen.domain import Template
10
11
12			def describe_template():
			0 ignored issues – show Coding Style introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
13
14			def it_supports_comparison():
			0 ignored issues – show Coding Style introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
15			t1 = Template('abc', "A Thing")
			0 ignored issues – show Coding Style Naming introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report The name `t1` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
16			t2 = Template('def')
			0 ignored issues – show Coding Style Naming introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report The name `t2` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
17			t3 = Template('def', "Do This")
			0 ignored issues – show Coding Style Naming introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report The name `t3` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
18
19			assert t1 != t2
20			assert t2 == t3
21			assert t1 < t3
22
23			def describe_get_path():
			0 ignored issues – show Coding Style introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
24
25			@patch('pathlib.Path.is_file', Mock(return_value=True))
26			def it_returns_default_when_no_style(template):
			0 ignored issues – show Coding Style Naming introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report The name `it_returns_default_when_no_style` does not conform to the function naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history... Coding Style introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
27			expect(template.get_path()) == Path("abc/default.png")
28
29			@patch('pathlib.Path.is_file', Mock(return_value=True))
30			def it_returns_alternate_when_style_provided(template):
			0 ignored issues – show Coding Style Naming introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report The name `it_returns_alternate_when_style_provided` does not conform to the function naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history... Coding Style introduced 2016-04-21 23:29 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...

jacebrowning / memegen

Pull Request — master (#194)

describe_sample_path() A

Complexity

Size

Duplication

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files