Changeset 74

Timestamp:

06/23/06 10:36:26 (7 years ago)

Author:

mk

Message:

Improved scores for documentation and installability indices.
Fixed handling of duplicates in IndexRequiredFiles?.

Files:

• branches/mk/cheesecake/cheesecake_index.py (modified) (7 diffs)
• branches/mk/tests/unit/test_cheese_files.py (modified) (1 diff)

branches/mk/cheesecake/cheesecake_index.py

@@ -354 +354 @@
-
-################################################################################
+## Index that computes scores based on files and directories.
+################################################################################
+
+class OneOf(object):
+    def __init__(self, *possibilities):
+        self.possibilities = possibilities
+    def __str__(self):
+        return 'one of %s' % (self.possibilities,)
+
+def WithOptionalExt(name, extensions):
+    """Handy way of writing Cheese rules for files with extensions.
+
+    Instead of writing:
+        >>> one_of = OneOf('readme', 'readme.html', 'readme.txt')
+
+    Write this:
+        >>> opt_ext = WithOptionalExt('readme', ['html', 'txt'])
+
+    It means the same! (representation have a meaning)
+        >>> str(one_of) == str(opt_ext)
+        True
+    """
+    possibilities = [name]
+    possibilities.extend(map(lambda x: name + '.' + x, extensions))
+
+    return OneOf(*possibilities)
+
+def Doc(name):
+    return WithOptionalExt(name, ['html', 'txt'])
+
+class FilesIndex(Index):
+    _used_rules = []
+
+    def _compute_from_rules(self, files_list, package_dir, files_rules):
+        self._used_rules = []
+        files_count = 0
+        value = 0
+
+        for filename in files_list:
+            if not is_empty(os.path.join(package_dir, filename)):
+                score = self.get_score(os.path.basename(filename), files_rules)
+                if score != 0:
+                    value += score
+                    files_count += 1
+
+        return files_count, value
+
+    def get_score(self, name, specs):
+        for entry, value in specs.iteritems():
+            if self.match_filename(name, entry):
+                self.cheesecake.log.debug("%d points entry found: %s (%s)" % \
+                                          (value, name, entry))
+                return value
+
+        return 0
+
+    def match_filename(self, name, rule):
+        """Check if `name` matches given `rule`.
+        """
+        def equal(x, y):
+            x_root, x_ext = os.path.splitext(x)
+            y_root, y_ext = os.path.splitext(y.lower())
+            if x_root in [y_root.lower(), y_root.upper(), y_root.capitalize()] \
+                   and x_ext in [y_ext.lower(), y_ext.upper()]:
+                return True
+            return False
+
+        if rule in self._used_rules:
+            return False
+
+        if isinstance(rule, basestring):
+            if equal(name, rule):
+                self._used_rules.append(rule)
+                return True
+        elif isinstance(rule, OneOf):
+            for poss in rule.possibilities:
+                if self.match_filename(name, poss):
+                    self._used_rules.append(rule)
+                    return True
+
+        return False
+
+################################################################################
-## Installability index.
-################################################################################
@@ -393 +476 @@
-            self.details += " as expected"
-            self.value = self.max_value
+
+        return self.value
+
+class IndexSetupPy(FilesIndex):
+    name = "setup.py"
+    max_value = 25
+
+    files_rules = {
+        'setup.py': 25,
+    }
+
+    def compute(self, files_list, package_dir):
+        setup_py_found, self.value = self._compute_from_rules(files_list, package_dir, self.files_rules)
+
+        if setup_py_found:
+            self.details = "setup.py found"
+        else:
+            self.details = "setup.py not found"
-
-        return self.value
@@ -459 +560 @@
-        IndexUnpack(),
-        IndexUnpackDir(),
+        IndexSetupPy(),
-        IndexInstall(),
-        IndexGeneratedFiles(),
@@ -467 +569 @@
-################################################################################
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-    cheese_files = {
-
-
-
+
+
+
+
+
-
-        Doc('authors'): 10,
-        Doc('announce'): 10,
-        Doc('changelog'): 10,
-        Doc('faq'): 10,
-        Doc('install'): 10,
-        Doc('news'): 10,
-        Doc('thanks'): 10,
@@ -534 +585 @@
-
-    cheese_dirs = {
-
-
-
-
+
+
+
+
+
-    }
-
@@ -543 +595 @@
-
-    def compute(self, files_list, dirs_list, package_dir):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
-        self.details = "%d files and %d required directories found" % \
-ectorie
+
-
-        return self.value
-
-    def get_score(self, name, specs):
-        for entry, value in specs.iteritems():
-            if match_filename(name, entry):
-                self.cheesecake.log.debug("%d points entry found: %s (%s)" % \
-                                          (value, name, entry))
-                return value
-
-        return 0
-
-    def reset_rules(self, rules):
-        if isinstance(rules, basestring):
-            pass
-        elif isiterable(rules):
-            for rule in rules:
-                self.reset_rules(rule)
-        elif isinstance(rules, OneOf):
-            rules.used = False
-            self.reset_rules(rules.possibilities)
-
-class IndexDocstrings(Index):
@@ -611 +630 @@
-
-        # Scale the result.
-
+
+
+
+
+
+
+
+
-
-        self.details = "found %d/%d=%.2f%% objects with formatted docstrings" %\

branches/mk/tests/unit/test_cheese_files.py

@@ -45 +45 @@
-        empty_filenames = ['Readme', 'INSTALL', 'setup.py']
-        self._do_it(empty_filenames, self.create_empty_files, False)
+
+
+class TestDoubleFiles(MockupCheesecakeTest):
+    def test_double_files(self):
+        filenames = ['Readme', 'README.txt']
+
+        self.create_files(self.prefix_with_package_name(filenames))
+        self.cheesecake.walk_pkg()
+        self.cheesecake.compute_cheesecake_index()
+
+        loglines = ''.join(readlines_from_file(self._mock_logfile))
+
+        # Make sure that README was counted only once.
+        assert cheesefile_in_log('Readme', loglines)
+        assert not cheesefile_in_log('README.txt', loglines)