Changeset View
Changeset View
Standalone View
Standalone View
swh/indexer/metadata_dictionary/ruby.py
- This file was added.
| # Copyright (C) 2018-2019 The Software Heritage developers | |||||
| # See the AUTHORS file at the top-level directory of this distribution | |||||
| # License: GNU General Public License version 3, or any later version | |||||
| # See top-level LICENSE file for more information | |||||
| import ast | |||||
| import itertools | |||||
| import re | |||||
| from swh.indexer.codemeta import CROSSWALK_TABLE | |||||
| from .base import DictMapping | |||||
| class GemspecMapping(DictMapping): | |||||
| name = 'gemspec' | |||||
| mapping = CROSSWALK_TABLE['Ruby Gem'] | |||||
| string_fields = ['name', 'version', 'description', 'summary', 'email'] | |||||
| _re_spec_new = re.compile(r'.*Gem::Specification.new +(do|\{) +\|.*\|.*') | |||||
| _re_spec_entry = re.compile(r'\s*\w+\.(?P<key>\w+)\s*=\s*(?P<expr>.*)') | |||||
| @classmethod | |||||
| def detect_metadata_files(cls, file_entries): | |||||
| for entry in file_entries: | |||||
| if entry['name'].endswith(b'.gemspec'): | |||||
| return [entry['sha1']] | |||||
| return [] | |||||
| def translate(self, raw_content): | |||||
| try: | |||||
| raw_content = raw_content.decode() | |||||
| except UnicodeDecodeError: | |||||
| self.log.warning('Error unidecoding from %s', self.log_suffix) | |||||
| return | |||||
| # Skip lines before 'Gem::Specification.new' | |||||
| lines = itertools.dropwhile( | |||||
| lambda x: not self._re_spec_new.match(x), | |||||
| raw_content.split('\n')) | |||||
| try: | |||||
| next(lines) # Consume 'Gem::Specification.new' | |||||
| except StopIteration: | |||||
| self.log.warning('Could not find Gem::Specification in %s', | |||||
| self.log_suffix) | |||||
| return | |||||
| content_dict = {} | |||||
| for line in lines: | |||||
| match = self._re_spec_entry.match(line) | |||||
| if match: | |||||
| value = self.eval_ruby_expression(match.group('expr')) | |||||
| if value: | |||||
| content_dict[match.group('key')] = value | |||||
| return self._translate_dict(content_dict) | |||||
| def eval_ruby_expression(self, expr): | |||||
| """Very simple evaluator of Ruby expressions. | |||||
| >>> GemspecMapping().eval_ruby_expression('"Foo bar"') | |||||
| 'Foo bar' | |||||
| >>> GemspecMapping().eval_ruby_expression("'Foo bar'") | |||||
| 'Foo bar' | |||||
| >>> GemspecMapping().eval_ruby_expression("['Foo', 'bar']") | |||||
| ['Foo', 'bar'] | |||||
| >>> GemspecMapping().eval_ruby_expression("'Foo bar'.freeze") | |||||
| 'Foo bar' | |||||
| >>> GemspecMapping().eval_ruby_expression( \ | |||||
| "['Foo'.freeze, 'bar'.freeze]") | |||||
| ['Foo', 'bar'] | |||||
| """ | |||||
| def evaluator(node): | |||||
| if isinstance(node, ast.Str): | |||||
| return node.s | |||||
| elif isinstance(node, ast.List): | |||||
| res = [] | |||||
| for element in node.elts: | |||||
| val = evaluator(element) | |||||
| if not val: | |||||
| return | |||||
| res.append(val) | |||||
| return res | |||||
| expr = expr.replace('.freeze', '') | |||||
| try: | |||||
| # We're parsing Ruby expressions here, but Python's | |||||
| # ast.parse works for very simple Ruby expressions | |||||
| # (mainly strings delimited with " or ', and lists | |||||
| # of such strings). | |||||
| tree = ast.parse(expr, mode='eval') | |||||
| except (SyntaxError, ValueError): | |||||
| return | |||||
| if isinstance(tree, ast.Expression): | |||||
| return evaluator(tree.body) | |||||
| def normalize_homepage(self, s): | |||||
| if isinstance(s, str): | |||||
| return {"@id": s} | |||||
| def normalize_license(self, s): | |||||
| if isinstance(s, str): | |||||
| return [{"@id": "https://spdx.org/licenses/" + s}] | |||||
| def normalize_licenses(self, licenses): | |||||
| if isinstance(licenses, list): | |||||
| return [{"@id": "https://spdx.org/licenses/" + license} | |||||
| for license in licenses | |||||
| if isinstance(license, str)] | |||||
| def normalize_author(self, author): | |||||
| if isinstance(author, str): | |||||
| return {"@list": [author]} | |||||
| def normalize_authors(self, authors): | |||||
| if isinstance(authors, list): | |||||
| return {"@list": [author for author in authors | |||||
| if isinstance(author, str)]} | |||||