Function parse_spec

src/packagedcode/spec.py:136–178

Return a mapping of data parsed from a podspec/gemspec/Pofile/Gemfile file at ``location``. Use ``package_type`` a Package URL type for dependencies. dependencies is a list of DependentPackage.

(location, package_type)

def parse_spec(location, package_type):
    """
    Return a mapping of data parsed from a podspec/gemspec/Pofile/Gemfile file
    at ``location``. Use ``package_type`` a Package URL type for dependencies.
    dependencies is a list of DependentPackage.
    """
    spec_data = {}
    with open(location) as spec:
        content = spec.read()

    lines = content.splitlines()
    for line in lines:
        line = pre_process(line)

        for attribute_name, parser in PARSER_BY_NAME.items():
            parsed = parser(line=line)
            if parsed:
                spec_data[attribute_name] = parsed

    # description can be in single or multi-lines
    # There are many different ways to write description.
    # we reparse for multline
    description = spec_data.get("description")
    if description:
        if '<<-' in description:
            # a Ruby multiline text
            spec_data['description'] = get_multiline_description(
                description_start=description,
                lines=lines,
            )
        else:
            # a single quoted description
            spec_data['description'] = get_cleaned_string(description)

    # We avoid reloading twice the file but we are still parsing twice: need to
    # merge all in gemfileparser or write a better parser.
    spec_data['dependencies'] = list(get_dependent_packages(
        lines=lines,
        location=location,
        package_type=package_type,
    ))

    return spec_data


def get_dependent_packages(lines, location, package_type):