Flatten DeltaCode.deltas field

[steven-esser]

Once we have the basics of scoring (#52), we can move on to flattening the deltas field of DeltaCode. This means moving on a dictionary of lists to just a single list of Delta objects.

Prior to output or perhaps prior to assignment, we will want to sort this list by Delta.score to preserve order and/or cull entries we do not need (if a user specifies --all for instance)

[johnmhoran]

@MaJuRG Making my way through the flattening process. Re DeltaCode.to_dict(), is it accurate to say that we . . .

• . . . want to convert DeltaCode.to_dict() so that it returns a single list of Delta objects instead of an OrderedDict of Delta objects keyed by added, removed etc.?
• . . . need to change the method name to, e.g., DeltaCode.to_list()?
• . . . could sort by Delta.score inside this method before returning the list?

[steven-esser]

@johnmhoran We do not care about to_dict or to_list.

We want to change the Deltacode.deltas field to a list of Delta objects instead of a dictionary as it currently is

[johnmhoran]

@MaJuRG I've already done that. My question is, what do we want to do with the current method, DeltaCode.to_dict()?

[steven-esser]

It is not needed anymore in that case. We will need to replace code paths that use the old dict structure (few, mostly output related) and all code that calls Deltacode.to_dict() (many,mostly in tests).

[johnmhoran]

Thanks.

[johnmhoran]

@MaJuRG FYI I'm replacing tests that use DeltaCode.to_dict() with equivalent tests where possible. For example, I've replaced test_DeltaCode_to_dict_simple_file_added() with this:

    def test_DeltaCode_counts_simple_file_added(self):
        new_scan = self.get_test_loc('deltacode/new_added1.json')
        old_scan = self.get_test_loc('deltacode/old_added1.json')

        options = OrderedDict([
            ('--all-delta-types', False)
        ])

        deltacode = DeltaCode(new_scan, old_scan, options)

        assert (len([d.to_dict() for d in deltacode.deltas if d.category == 'added']) +
                len([d.to_dict() for d in deltacode.deltas if d.category == 'removed']) +
                len([d.to_dict() for d in deltacode.deltas if d.category == 'moved']) +
                len([d.to_dict() for d in deltacode.deltas if d.category == 'modified']) +
                len([d.to_dict() for d in deltacode.deltas if d.category == 'unmodified'])) == 9

        assert len([d.to_dict() for d in deltacode.deltas if d.category == 'added']) == 1
        assert len([d.to_dict() for d in deltacode.deltas if d.category == 'removed']) == 0
        assert len([d.to_dict() for d in deltacode.deltas if d.category == 'moved']) == 0
        assert len([d.to_dict() for d in deltacode.deltas if d.category == 'modified']) == 0
        assert len([d.to_dict() for d in deltacode.deltas if d.category == 'unmodified']) == 8

[steven-esser]

@johnmhoran A better option may be to simply re-write get_stats() and use that for for the tests.

[steven-esser]

to avoid massive duplications. Code of similar logic could be used in an updated get_stats()

[johnmhoran]

Thanks @MaJuRG . Coincidentally, I've already rewritten get_stats:

    def get_stats(self):
        """
        Given a list of Delta objects, return a 'counts' dictionary keyed by
        category -- i.e., the keys of the determine_delta() OrderedDict of
        Delta objects -- that contains the count as a value for each category.
        """
        added, modified, moved, removed, unmodified = 0, 0, 0, 0, 0

        # added = len(self.deltas['added'])
        # modified = len(self.deltas['modified'])
        # moved = len(self.deltas['moved'])
        # removed = len(self.deltas['removed'])
        # unmodified = len(self.deltas['unmodified'])

        added = len([i for i in self.deltas if i.category == 'added'])
        modified = len([i for i in self.deltas if i.category == 'modified'])
        moved = len([i for i in self.deltas if i.category == 'moved'])
        removed = len([i for i in self.deltas if i.category == 'removed'])
        unmodified = len([i for i in self.deltas if i.category == 'unmodified'])