moosetechnology/GitProjectHealth | Build 13919072139 | src/GitLabHealth-Model-Analysis/GitMetricExporter.class.st | Coveralls

22

GitMetricExporter class >> demoPeriod [

×

23

×

24

        ^ self new

×

25

                  addAPeriodFrom: '01 march 2023' to: '31 may 2023';

×

26

                  addAPeriodFrom: '01 december 2023' to: '29 february 2024';

×

27

                  addAPeriodFrom: '01 march 2024' to: '31 may 2024'

×

28

×

31

GitMetricExporter >> addAPeriodFrom: since to: until [

×

32

×

33

        runningPeriods add: {

×

34

                        (#since -> since asDate).

×

35

                        (#until -> until asDate) } asDictionary.

×

36

×

37

        ^runningPeriods

×

38

×

41

GitMetricExporter >> addEntitiesFromUserNames: userNames [

×

42

        "import all the project since a certain time"

×

43

×

44

        self

×

45

                deprecated: 'Use #setupAnalysesForUsersWithNames instead'

×

46

                on: '03 Sept 2024'

×

47

in:

×

48

                'Pharo-11.0.0+build.726.sha.aece1b5473acf3830a0e082c1bc3a15d4ff3522b (64 Bit)'.

×

49

×

50

        'Import all projects from the Git repository' recordInfo.

×

51

        projectCache := projectCache ifNil: [

×

52

                                glhImporter importProjectsSince: sinceTimeLimit ].

×

53

×

54

        "then collect the project in which the user has be seen commited"

×

55

        entities addAll: (userNames collect: [ :username |

×

56

                         | projects  i size |

×

57

                         projects := self

×

58

                                             findParticipationOfCommitAuthorNamed: username

×

59

                                             amongProjects: projectCache.

×

60

×

61

                        "metrics := GitMetric4User new.

×

62

                         metrics

×

63

                                 glhImporter: glhImporter;

×

64

                                 jiraImporter: jiraImporter;

×

65

                                 findUserNamed: username."

×

66

×

67

×

68

×

69

                         i := 0.

×

70

                         size := projects size.

×

71

                         metrics itsProjects: (projects collect: [ :p |

×

72

                                          (' ' join: {

×

73

                                                           'complete import of project:'.

×

74

                                                           p name printString.

×

75

                                                           '['.

×

76

                                                           (i := i + 1) printString.

×

77

                                                           '/'.

×

78

                                                           size.

×

79

                                                           ']' }) recordInfo.

×

80

×

81

                                          p id -> (glhImporter completeImportProject: p) ]) asDictionary.

×

82

×

83

                         metrics ]).

×

84

×

85

        ^ self

×

86

×

89

GitMetricExporter >> addEntitiesFromUserNamesAndProjects: usersWithProjects [

×

90

×

91

        self

×

92

                deprecated: 'Use #setupAnalysesForUsersWithNames instead'

×

93

                on: '03 Sept 2024'

×

94

in:

×

95

                'Pharo-11.0.0+build.726.sha.aece1b5473acf3830a0e082c1bc3a15d4ff3522b (64 Bit)'.

×

96

×

97

        entities addAll: (usersWithProjects associations collect: [ :assoc |

×

98

                         | username projects  |

×

99

                         username := assoc key.

×

100

                         projects := assoc value.

×

101

×

102

                        " metrics := GitMetric4User new.

×

103

                         metrics

×

104

                                 glhImporter: glhImporter;

×

105

                                 jiraImporter: jiraImporter;

×

106

                                 findUserNamed: username.

×

107

                         metrics loadProjectsFromIds: projects."

×

108

×

109

                         username ]).

×

110

×

111

        ^ self

×

112

×

115

GitMetricExporter >> constructFilePathFor: runningOver andEntities: entitiesName [

×

116

×

117

        | file |

×

118

        file := (FileLocator home

×

119

×

120

                         ('GitlabHealth-' , label printString , '-'

×

121

                          , runningOver printString , '-' , entitiesName printString

×

122

                          , '-'

×

123

                          , (DateAndTime now printString replaceAll: $: with: $-)

×

124

                          , '.csv')) asFileReference.

×

125

        ^ file

×

126

×

129

GitMetricExporter >> csvMetricsFor: metricCollection at: date [

×

130

×

131

        | csvMetrics |

×

132

        csvMetrics := metricCollection collect: [ :metric |

×

133

                              metric new description , ' - ' , date asString

×

134

                              -> [ :groupAnalyses |

×

135

                                      | analysis |

×

136

                                      analysis := self

×

137

                                                          getAnalysisWithDate: date

×

138

                                                          from: groupAnalyses.

×

139

                                      analysis

×

140

                                              ifNil: [ nil ]

×

141

                                              ifNotNil: [ analysis metrics at: metric new name ] ] ].

×

142

×

143

        ^ csvMetrics asOrderedDictionary

×

144

×

147

GitMetricExporter >> entities: aCollection [

×

148

        entities := aCollection

×

149

×

152

GitMetricExporter >> exportFor: usersWithProjects [

×

153

×

154

        self

×

155

                deprecated: 'Use #exportInCSV instead'

×

156

                on: '03 Sept 2024'

×

157

in:

×

158

                'Pharo-11.0.0+build.726.sha.aece1b5473acf3830a0e082c1bc3a15d4ff3522b (64 Bit)'.

×

159

×

160

        self exportFor: usersWithProjects over: {

×

161

                        Date.

×

162

                        Week.

×

163

                        Month.

×

164

                        Year }

×

165

×

168

GitMetricExporter >> exportFor: usersWithProjects over: aCollectionOfDateWeekMonthOrYear [

×

169

×

170

        self

×

171

                deprecated: 'Use #exportInCSV instead'

×

172

                on: '03 Sept 2024'

×

173

in:

×

174

                'Pharo-11.0.0+build.726.sha.aece1b5473acf3830a0e082c1bc3a15d4ff3522b (64 Bit)'.

×

175

×

176

        entities ifNil: [

×

177

                self addEntitiesFromUserNamesAndProjects: usersWithProjects ].

×

178

×

179

        self exportFor: aCollectionOfDateWeekMonthOrYear

×

180

×

183

GitMetricExporter >> exportInCSV [

×

184

×

185

        self exportUserAnalysesInCSV.

×

186

        self exportProjectAnalysesInCSV.

×

187

×

190

GitMetricExporter >> exportInDB: repository [

×

191

×

192

        repository enableSingleton.

×

193

        analyses do: [ :analysis | analysis save ]

×

194

×

197

GitMetricExporter >> exportInS3: bucketName accessKey: accessKey secretKey: secretKey region: region [

×

198

×

199

        | s3 bucket ston date fileName |

×

200

        AWSS3Config default

×

201

                accessKeyId: accessKey;

×

202

                secretKey: secretKey;

×

203

                regionName: region.

×

204

×

205

        s3 := AWSS3 new.

×

206

        bucket := s3 bucketNamed: bucketName.

×

207

×

208

        ston := STON toString: analyses.

×

209

×

210

        date := Date today asString copyReplaceAll: ' ' asString with: '-'.

×

211

        fileName := ('-' join: {

×

212

                                     'analyse'.

×

213

                                     label.

×

214

                                     over asString.

×

215

                                     date }) , '.ston'.

×

216

×

217

        bucket atKey: fileName putObject: ston

×

218

×

221

GitMetricExporter >> exportProjectAnalysesInCSV [

×

222

×

223

        | exportBrowserModel groupedByOver group groupOver groupByName periods csvMetrics file |

×

224

        exportBrowserModel := MiExportModel new.

×

225

×

226

        groupedByOver := self projectAnalyses groupedBy: #over.

×

227

×

228

        groupedByOver associations do: [ :groupAssociation |

×

229

                group := groupAssociation value.

×

230

                groupOver := groupAssociation key.

×

231

×

232

×

233

                groupByName := group groupedBy: #projectName.

×

234

                exportBrowserModel entitiesList: groupByName.

×

235

×

236

                exportBrowserModel removeColumnForQueryNamed: #Type.

×

237

                exportBrowserModel removeColumnForQueryNamed: #Name.

×

238

×

239

                exportBrowserModel

×

240

                        addColumnForQuery: [ :groupAnalyses |

×

241

                        (groupAnalyses at: 1) projectName ]

×

242

                        withName: #'Project name'.

×

243

×

244

                periods := (group groupedBy: #period) keys.

×

245

×

246

                periods do: [ :period |

×

247

                        csvMetrics := self

×

248

                                              csvMetricsFor: self projectMetrics

×

249

                                              at: (period at: #since).

×

250

×

251

×

252

                        csvMetrics associations do: [ :association |

×

253

                                exportBrowserModel

×

254

                                        addColumnForQuery: association value

×

255

                                        withName: association key ] ].

×

256

×

257

                file := self constructFilePathFor: groupOver andEntities: 'projects'.

×

258

                file writeStreamDo: [ :aStream |

×

259

                        exportBrowserModel writeCSVOn: aStream ] ]

×

260

×

263

GitMetricExporter >> exportUserAnalysesInCSV [

×

264

×

265

        | exportBrowserModel groupedByOver group groupOver groupByName periods csvMetrics file |

×

266

        exportBrowserModel := MiExportModel new.

×

267

        groupedByOver := self userAnalyses groupedBy: #over.

×

268

×

269

        groupedByOver associations do: [ :groupAssociation |

×

270

                group := groupAssociation value.

×

271

                groupOver := groupAssociation key.

×

272

×

273

                groupByName := group groupedBy: #username.

×

274

                exportBrowserModel entitiesList: groupByName.

×

275

                exportBrowserModel removeColumnForQueryNamed: #Type.

×

276

                exportBrowserModel removeColumnForQueryNamed: #Name.

×

277

×

278

                exportBrowserModel

×

279

                        addColumnForQuery: [ :groupAnalyses |

×

280

                        (groupAnalyses at: 1) username ]

×

281

                        withName: #'User name'.

×

282

×

283

                exportBrowserModel

×

284

                        addColumnForQuery: [ :groupAnalyses | (groupAnalyses at: 1) email ]

×

285

                        withName: #'User email'.

×

286

×

287

                periods := (group groupedBy: #period) keys.

×

288

                periods do: [ :period |

×

289

                        csvMetrics := self

×

290

                                              csvMetricsFor: self userMetrics

×

291

                                              at: (period at: #since).

×

292

                        csvMetrics associations do: [ :association |

×

293

                                exportBrowserModel

×

294

                                        addColumnForQuery: association value

×

295

                                        withName: association key ] ].

×

296

×

297

×

298

                file := self

×

299

                                constructFilePathFor: groupOver

×

300

                                andEntities: 'users'.

×

301

×

302

                file writeStreamDo: [ :aStream |

×

303

                        exportBrowserModel writeCSVOn: aStream ] ]

×

304

×

307

GitMetricExporter >> findParticipationOfCommitAuthorNamed: username amongProjects: aCollectionOfProjects [

×

308

×

309

        | response itsProjects i size params |

×

310

        i := 1.

×

311

        size := aCollectionOfProjects size.

×

312

        itsProjects := aCollectionOfProjects select: [ :project |

×

313

                               (' ' join: {

×

314

                                                'search'.

×

315

                                                username printString.

×

316

                                                'in Project:'.

×

317

                                                project name printString.

×

318

                                                '['.

×

319

                                                (i := i + 1) printString.

×

320

                                                '/'.

×

321

                                                size.

×

322

                                                ']' }) recordInfo.

×

323

×

324

                                                        params := {

×

325

                                                                #author -> username.

×

326

                                                                #since -> '01 january 2023' asDate asDateAndTime asString.

×

327

                                                                #until -> Date today asDateAndTime asString

×

328

                                                        } asDictionary.

×

329

                               response := glhImporter repoApi commits getAllInProject: project id withParams: params.

×

330

                               response := (response collect: [ :commitsJson | glhImporter parseCommitsResult: commitsJson]) flattened.

×

331

                               response isNotEmpty

×

332

].

×

333

×

334

        ^ itsProjects

×

335

×

338

GitMetricExporter >> findProjectsOfUser: aCollection [

×

339

        self shouldBeImplemented.

×

340

×

343

GitMetricExporter >> generateAnalysesOver: aDateWeekMonthOrYear [

×

344

×

345

        analyses := OrderedCollection new.

×

346

        runningPeriods do: [ :period |

×

347

                analyses addAll: (self

×

348

                                 generateUsersAnalysesDuringPeriod: period

×

349

                                 over: aDateWeekMonthOrYear).

×

350

×

351

                analyses addAll: (self

×

352

                                 generateProjectsAnalysesDuringPeriod: period

×

353

                                 over: aDateWeekMonthOrYear) ].

×

354

×

355

        ^ analyses

×

356

×

359

GitMetricExporter >> generateProjectsAnalysesDuringPeriod: period over: aDateWeekMonthOrYear [

×

360

×

361

        ^self projectEntities collect: [ :project |

×

362

                | projectAnalysisReport |

×

363

                projectAnalysisReport := ProjectAnalysisReport new

×

364

                        projectName: project name;

×

365

                        period: period;

×

366

                        over: aDateWeekMonthOrYear.

×

367

×

368

×

369

                  self projectMetrics do: [ :metric |

×

370

                                |newMetric result|

×

371

                           newMetric := metric new

×

372

                                               glhImporter: glhImporter;

×

373

                                               jiraImporter: jiraImporter;

×

374

                                               setPeriodSince: (period at: #since)

×

375

                                               until: (period at: #until);

×

376

                                               over: aDateWeekMonthOrYear;

×

377

                                               project: project.

×

378

×

379

×

380

                          result := newMetric calculate.

×

381

                          projectAnalysisReport metrics at: newMetric name put: result ].

×

382

×

383

                        projectAnalysisReport]

×

384

×

387

GitMetricExporter >> generateUsersAnalysesDuringPeriod: period over: aDateWeekMonthOrYear [

×

388

×

389

        | userAnalysisReport newMetric result |

×

390

        ^ self userEntities collect: [ :user |

×

391

                  userAnalysisReport := UserAnalysisReport new

×

392

                                                username: user name;

×

393

                                                                                        email: (user email ifNil: [ user public_email]);

×

394

                                                period: period;

×

395

                                                over: aDateWeekMonthOrYear.

×

396

×

397

                  self userMetrics do: [ :metric |

×

398

                          newMetric := metric new

×

399

                                               glhImporter: glhImporter;

×

400

                                               jiraImporter: jiraImporter;

×

401

                                               setPeriodSince: (period at: #since)

×

402

                                               until: (period at: #until);

×

403

                                               over: aDateWeekMonthOrYear;

×

404

                                               user: user;

×

405

                                               emailDomain: emailDomain.

×

406

×

407

×

408

                          result := newMetric calculate.

×

409

                          userAnalysisReport metrics at: newMetric name put: result ].

×

410

×

411

                  userAnalysisReport ]

×

412

×

415

GitMetricExporter >> getAnalysisWithDate: date from: analysisCollection [

×

416

×

417

        ^analysisCollection

×

418

                detect: [ :groupAnalysis | (groupAnalysis period at: #since) = date ]

×

419

                ifNone: [ nil ]

×

420

×

423

GitMetricExporter >> glhImporter: anImporter [

×

424

×

425

        glhImporter := anImporter withInitialCommits: false; yourself.

×

426

×

429

GitMetricExporter >> importAnalysesFromS3: bucketName accessKey: accessKey secretKey: secretKey region: region [

×

430

×

431

        | s3 bucket xmlObjects contentElements filesContent |

×

432

        AWSS3Config default

×

433

                accessKeyId: accessKey;

×

434

                secretKey: secretKey;

×

435

                regionName: region.

×

436

×

437

        s3 := AWSS3 new.

×

438

        bucket := s3 bucketNamed: bucketName.

×

439

        xmlObjects := bucket listObjects.

×

440

        contentElements := xmlObjects root elementsSelect: [ :element |

×

441

                                   element isNamed: 'Contents' ].

×

442

×

443

        filesContent := contentElements collect: [ :contentElement |

×

444

                                | keyValue |

×

445

                                keyValue := contentElement contentStringAt: 'Key'.

×

446

                                bucket getObject: keyValue ].

×

447

×

448

        ^ analyses := (filesContent collect: [ :file | STON fromString: file ])

×

449

                              flattened

×

450

×

453

GitMetricExporter >> initialize [

×

454

×

455

        entities := OrderedCollection new.

×

456

        "set up the minimal date from which we are looking for the commits a particular user in projects"

×

457

        sinceTimeLimit := '2024-01-01' asDate asDateAndTime.

×

458

        runningPeriods := OrderedCollection new.

×

459

        maxCommitWindow := 3.

×

460

        over := Date.

×

461

×

462

        analyses := OrderedCollection new.

×

463

×

464

        "User Metrics"

×

465

        metrics := {

×

466

                           CodeAdditionMetric.

×

467

                           CodeDeletionMetric.

×

468

                           CommentContributionMetric.

×

469

                           CommitFrequencyMetric.

×

470

                           CodeChurnMetric.

×

471

                           DelayUntilFirstChurnMetric.

×

472

                           TimeBetweenCommitMetric.

×

473

                           ContributedProjectMetric.

×

474

                           CodeAdditionByMRMetric.

×

475

                           CodeDeletionByMRMetric.

×

476

                           MergeRequestDurationMetric.

×

477

                           OpenedMergeRequestMetric.

×

478

                           ClosedMergeRequestMetric.

×

479

                           MergedMergeRequestMetric.

×

480

                           SelfMergedUnderAMinuteMergeRequestMetric.

×

481

                           ClosedTicketsMetric.

×

482

                           JiraTimeMRTimeDifferenceMetric.

×

483

                           CommitsNumberByJiraTicketsMetric.

×

484

                           CommitsLinkWithTicketMetric.

×

485

×

486

                           "ProjectMetric subclasses"

×

487

                           ClosedMergeRequestProjectMetric.

×

488

                           CommitFrequencyProjectMetric.

×

489

                           CreatedMergeRequestProjectMetric.

×

490

                           MergedMergeRequestProjectMetric.

×

491

                           ClosedMergeRequestDurationProjectMetric.

×

492

                           MergedMergeRequestDurationProjectMetric.

×

493

                           OpenedMergeRequestDurationProjectMetric.

×

494

                           ContributorsProjectMetric.

×

495

                           AutoCodeReviewCommitFrequencyProjectMetric.

×

496

                           CodeAdditionByMergeRequestProjectMetric.

×

NEW

497

×

NEW

498

                           CodeDeletionDuringAndByMergeRequestProjectMetric.

×

499

                           CodeAdditionDuringAndByMergeRequestProjectMetric.

×

500

                           CodeDeletionByMergeRequestProjectMetric.

×

NEW

501

                           CodeChurnOnCommitsProjectMetric.

×

NEW

502

                           SelfMergedUnderAMinuteMergeRequestProjectMetric.

×

503

                                            JiraTimeMRTimeDifferenceProjectMetric.

×

504

}.

×

505

×

506

        self flag:

×

507

                'Futur updates should considers loading metrics directly from subclasses instead of manual selection inside the initialize'

×

UNCOV

508

        "metrics addAll: ProjectMetric subclasses."

×

UNCOV

509

×

512

GitMetricExporter >> jiraImporter: anObject [

×

513

×

UNCOV

514

        jiraImporter := anObject

×

UNCOV

515

×

518

GitMetricExporter >> label: aString [

×

UNCOV

519

        label := aString

×

UNCOV

520

×

523

GitMetricExporter >> maxCommitWindow: anInteger [

×

UNCOV

524

        maxCommitWindow := anInteger abs

×

UNCOV

525

×

528

GitMetricExporter >> metrics [

×

529

×

UNCOV

530

        ^ metrics

×

UNCOV

531

×

534

GitMetricExporter >> metrics: anObject [

×

535

×

UNCOV

536

        metrics := anObject

×

UNCOV

537

×

540

GitMetricExporter >> onlyImportProjectsOfGroup: groupId [

×

541

×

542

        | group |

×

543

        group := glhImporter importGroup: groupId.

×

UNCOV

544

        projectCache := group toScope: GLHProject

×

UNCOV

545

×

548

GitMetricExporter >> projectAnalyses [

×

549

×

UNCOV

550

        ^ analyses select: [ :analysis | analysis class = ProjectAnalysisReport ]

×

UNCOV

551

×

554

GitMetricExporter >> projectEntities [

×

555

×

UNCOV

556

        ^ entities select: [ :entity | entity class = GLHProject ]

×

UNCOV

557

×

560

GitMetricExporter >> projectMetrics [

×

561

×

UNCOV

562

        ^ metrics select: [ :metric | metric inheritsFrom: ProjectMetric ]

×

UNCOV

563

×

566

GitMetricExporter >> setupAnalysisForProjectsWithIds: projectIds [

×

567

×

568

        | projects |

×

569

        projects := glhImporter importProjects: projectIds.

×

570

×

UNCOV

571

        entities addAll: projects

×

UNCOV

572

×

575

GitMetricExporter >> setupAnalysisForUsersWithNames: userNames [

×

576

        "import all the project since a certain time"

×

577

×

578

        | users |

×

579

        users := userNames collect: [ :username |

×

580

                         glhImporter importUserByUsername: username ].

×

581

×

582

        glhImporter userCatalogue ifNotNil: [

×

583

                glhImporter userCatalogue scrapeAuthorNamesForUsers: users ].

×

584

×

585

        users do: [ :user |

×

586

                | projects |

×

587

                projects := glhImporter importContributedProjectsOfUser: user.

×

588

×

589

                projects do: [ :project |

×

590

                        glhImporter completeImportProject: project ] ].

×

591

×

592

        entities addAll: users.

×

593

×

UNCOV

594

        ^ self

×

UNCOV

595

×

598

GitMetricExporter >> userAnalyses [

×

599

×

UNCOV

600

        ^ analyses select: [ :analysis | analysis class = UserAnalysisReport ]

×

UNCOV

601

×

604

GitMetricExporter >> userEntities [

×

605

×

UNCOV

606

        ^ entities select: [ :entity | entity class = GLHUser ]

×

UNCOV

607

×

610

GitMetricExporter >> userMetrics [

×

611

×

UNCOV

612

        ^ metrics select: [ :metric | metric inheritsFrom: UserMetric ]

×

UNCOV

613

×

616

GitMetricExporter >> withEmailDomain: anEmailDomain [

×

617

×

618

        "define the email domain of your Git user. Usefull to link them between service (i.e. Jira)"

×

UNCOV

619

        emailDomain := anEmailDomain

×

UNCOV

620

×

moosetechnology / GitProjectHealth / 13919072139

Source File
Press 'n' to go to next uncovered line, 'b' for previous

1	Class {
2	#name : #GitMetricExporter,
3	#superclass : #Object,
4	#instVars : [
5	'glhImporter',
6	'jiraImporter',
7	'label',
8	'entities',
9	'projectCache',
10	'sinceTimeLimit',
11	'runningPeriods',
12	'maxCommitWindow',
13	'over',
14	'emailDomain',
15	'metrics',
16	'analyses'
17	],
18	#category : #'GitLabHealth-Model-Analysis'
19	}
20
21	{ #category : #'as yet unclassified' }
22	GitMetricExporter class >> demoPeriod [	×
23		×
24	^ self new	×
25	addAPeriodFrom: '01 march 2023' to: '31 may 2023';	×
26	addAPeriodFrom: '01 december 2023' to: '29 february 2024';	×
27	addAPeriodFrom: '01 march 2024' to: '31 may 2024'	×
28	]	×
29
30	{ #category : #adding }
31	GitMetricExporter >> addAPeriodFrom: since to: until [	×
32		×
33	runningPeriods add: {	×
34	(#since -> since asDate).	×
35	(#until -> until asDate) } asDictionary.	×
36		×
37	^runningPeriods	×
38	]	×
39
40	{ #category : #adding }
41	GitMetricExporter >> addEntitiesFromUserNames: userNames [	×
42	"import all the project since a certain time"	×
43		×
44	self	×
45	deprecated: 'Use #setupAnalysesForUsersWithNames instead'	×
46	on: '03 Sept 2024'	×
47	in:	×
48	'Pharo-11.0.0+build.726.sha.aece1b5473acf3830a0e082c1bc3a15d4ff3522b (64 Bit)'.	×
49		×
50	'Import all projects from the Git repository' recordInfo.	×
51	projectCache := projectCache ifNil: [	×
52	glhImporter importProjectsSince: sinceTimeLimit ].	×
53		×
54	"then collect the project in which the user has be seen commited"	×
55	entities addAll: (userNames collect: [ :username \|	×
56	\| projects i size \|	×
57	projects := self	×
58	findParticipationOfCommitAuthorNamed: username	×
59	amongProjects: projectCache.	×
60		×
61	"metrics := GitMetric4User new.	×
62	metrics	×
63	glhImporter: glhImporter;	×
64	jiraImporter: jiraImporter;	×
65	findUserNamed: username."	×
66		×
67		×
68		×
69	i := 0.	×
70	size := projects size.	×
71	metrics itsProjects: (projects collect: [ :p \|	×
72	(' ' join: {	×
73	'complete import of project:'.	×
74	p name printString.	×
75	'['.	×
76	(i := i + 1) printString.	×
77	'/'.	×
78	size.	×
79	']' }) recordInfo.	×
80		×
81	p id -> (glhImporter completeImportProject: p) ]) asDictionary.	×
82		×
83	metrics ]).	×
84		×
85	^ self	×
86	]	×
87
88	{ #category : #adding }
89	GitMetricExporter >> addEntitiesFromUserNamesAndProjects: usersWithProjects [	×
90		×
91	self	×
92	deprecated: 'Use #setupAnalysesForUsersWithNames instead'	×
93	on: '03 Sept 2024'	×
94	in:	×
95	'Pharo-11.0.0+build.726.sha.aece1b5473acf3830a0e082c1bc3a15d4ff3522b (64 Bit)'.	×
96		×
97	entities addAll: (usersWithProjects associations collect: [ :assoc \|	×
98	\| username projects \|	×
99	username := assoc key.	×
100	projects := assoc value.	×
101		×
102	" metrics := GitMetric4User new.	×
103	metrics	×
104	glhImporter: glhImporter;	×
105	jiraImporter: jiraImporter;	×
106	findUserNamed: username.	×
107	metrics loadProjectsFromIds: projects."	×
108		×
109	username ]).	×
110		×
111	^ self	×
112	]	×
113
114	{ #category : #utilities }
115	GitMetricExporter >> constructFilePathFor: runningOver andEntities: entitiesName [	×
116		×
117	\| file \|	×
118	file := (FileLocator home	×
119	/	×
120	('GitlabHealth-' , label printString , '-'	×
121	, runningOver printString , '-' , entitiesName printString	×
122	, '-'	×
123	, (DateAndTime now printString replaceAll: $: with: $-)	×
124	, '.csv')) asFileReference.	×
125	^ file	×
126	]	×
127
128	{ #category : #exporting }
129	GitMetricExporter >> csvMetricsFor: metricCollection at: date [	×
130		×
131	\| csvMetrics \|	×
132	csvMetrics := metricCollection collect: [ :metric \|	×
133	metric new description , ' - ' , date asString	×
134	-> [ :groupAnalyses \|	×
135	\| analysis \|	×
136	analysis := self	×
137	getAnalysisWithDate: date	×
138	from: groupAnalyses.	×
139	analysis	×
140	ifNil: [ nil ]	×
141	ifNotNil: [ analysis metrics at: metric new name ] ] ].	×
142		×
143	^ csvMetrics asOrderedDictionary	×
144	]	×
145
146	{ #category : #accessing }
147	GitMetricExporter >> entities: aCollection [	×
148	entities := aCollection	×
149	]	×
150
151	{ #category : #exporting }
152	GitMetricExporter >> exportFor: usersWithProjects [	×
153		×
154	self	×
155	deprecated: 'Use #exportInCSV instead'	×
156	on: '03 Sept 2024'	×
157	in:	×
158	'Pharo-11.0.0+build.726.sha.aece1b5473acf3830a0e082c1bc3a15d4ff3522b (64 Bit)'.	×
159		×
160	self exportFor: usersWithProjects over: {	×
161	Date.	×
162	Week.	×
163	Month.	×
164	Year }	×
165	]	×
166
167	{ #category : #exporting }
168	GitMetricExporter >> exportFor: usersWithProjects over: aCollectionOfDateWeekMonthOrYear [	×
169		×
170	self	×
171	deprecated: 'Use #exportInCSV instead'	×
172	on: '03 Sept 2024'	×
173	in:	×
174	'Pharo-11.0.0+build.726.sha.aece1b5473acf3830a0e082c1bc3a15d4ff3522b (64 Bit)'.	×
175		×
176	entities ifNil: [	×
177	self addEntitiesFromUserNamesAndProjects: usersWithProjects ].	×
178		×
179	self exportFor: aCollectionOfDateWeekMonthOrYear	×
180	]	×
181
182	{ #category : #exporting }
183	GitMetricExporter >> exportInCSV [	×
184		×
185	self exportUserAnalysesInCSV.	×
186	self exportProjectAnalysesInCSV.	×
187	]	×
188
189	{ #category : #exporting }
190	GitMetricExporter >> exportInDB: repository [	×
191		×
192	repository enableSingleton.	×
193	analyses do: [ :analysis \| analysis save ]	×
194	]	×
195
196	{ #category : #exporting }
197	GitMetricExporter >> exportInS3: bucketName accessKey: accessKey secretKey: secretKey region: region [	×
198		×
199	\| s3 bucket ston date fileName \|	×
200	AWSS3Config default	×
201	accessKeyId: accessKey;	×
202	secretKey: secretKey;	×
203	regionName: region.	×
204		×
205	s3 := AWSS3 new.	×
206	bucket := s3 bucketNamed: bucketName.	×
207		×
208	ston := STON toString: analyses.	×
209		×
210	date := Date today asString copyReplaceAll: ' ' asString with: '-'.	×
211	fileName := ('-' join: {	×
212	'analyse'.	×
213	label.	×
214	over asString.	×
215	date }) , '.ston'.	×
216		×
217	bucket atKey: fileName putObject: ston	×
218	]	×
219
220	{ #category : #exporting }
221	GitMetricExporter >> exportProjectAnalysesInCSV [	×
222		×
223	\| exportBrowserModel groupedByOver group groupOver groupByName periods csvMetrics file \|	×
224	exportBrowserModel := MiExportModel new.	×
225		×
226	groupedByOver := self projectAnalyses groupedBy: #over.	×
227		×
228	groupedByOver associations do: [ :groupAssociation \|	×
229	group := groupAssociation value.	×
230	groupOver := groupAssociation key.	×
231		×
232		×
233	groupByName := group groupedBy: #projectName.	×
234	exportBrowserModel entitiesList: groupByName.	×
235		×
236	exportBrowserModel removeColumnForQueryNamed: #Type.	×
237	exportBrowserModel removeColumnForQueryNamed: #Name.	×
238		×
239	exportBrowserModel	×
240	addColumnForQuery: [ :groupAnalyses \|	×
241	(groupAnalyses at: 1) projectName ]	×
242	withName: #'Project name'.	×
243		×
244	periods := (group groupedBy: #period) keys.	×
245		×
246	periods do: [ :period \|	×
247	csvMetrics := self	×
248	csvMetricsFor: self projectMetrics	×
249	at: (period at: #since).	×
250		×
251		×
252	csvMetrics associations do: [ :association \|	×
253	exportBrowserModel	×
254	addColumnForQuery: association value	×
255	withName: association key ] ].	×
256		×
257	file := self constructFilePathFor: groupOver andEntities: 'projects'.	×
258	file writeStreamDo: [ :aStream \|	×
259	exportBrowserModel writeCSVOn: aStream ] ]	×
260	]	×
261
262	{ #category : #exporting }
263	GitMetricExporter >> exportUserAnalysesInCSV [	×
264		×
265	\| exportBrowserModel groupedByOver group groupOver groupByName periods csvMetrics file \|	×
266	exportBrowserModel := MiExportModel new.	×
267	groupedByOver := self userAnalyses groupedBy: #over.	×
268		×
269	groupedByOver associations do: [ :groupAssociation \|	×
270	group := groupAssociation value.	×
271	groupOver := groupAssociation key.	×
272		×
273	groupByName := group groupedBy: #username.	×
274	exportBrowserModel entitiesList: groupByName.	×
275	exportBrowserModel removeColumnForQueryNamed: #Type.	×
276	exportBrowserModel removeColumnForQueryNamed: #Name.	×
277		×
278	exportBrowserModel	×
279	addColumnForQuery: [ :groupAnalyses \|	×
280	(groupAnalyses at: 1) username ]	×
281	withName: #'User name'.	×
282		×
283	exportBrowserModel	×
284	addColumnForQuery: [ :groupAnalyses \| (groupAnalyses at: 1) email ]	×
285	withName: #'User email'.	×
286		×
287	periods := (group groupedBy: #period) keys.	×
288	periods do: [ :period \|	×
289	csvMetrics := self	×
290	csvMetricsFor: self userMetrics	×
291	at: (period at: #since).	×
292	csvMetrics associations do: [ :association \|	×
293	exportBrowserModel	×
294	addColumnForQuery: association value	×
295	withName: association key ] ].	×
296		×
297		×
298	file := self	×
299	constructFilePathFor: groupOver	×
300	andEntities: 'users'.	×
301		×
302	file writeStreamDo: [ :aStream \|	×
303	exportBrowserModel writeCSVOn: aStream ] ]	×
304	]	×
305
306	{ #category : #projects }
307	GitMetricExporter >> findParticipationOfCommitAuthorNamed: username amongProjects: aCollectionOfProjects [	×
308		×
309	\| response itsProjects i size params \|	×
310	i := 1.	×
311	size := aCollectionOfProjects size.	×
312	itsProjects := aCollectionOfProjects select: [ :project \|	×
313	(' ' join: {	×
314	'search'.	×
315	username printString.	×
316	'in Project:'.	×
317	project name printString.	×
318	'['.	×
319	(i := i + 1) printString.	×
320	'/'.	×
321	size.	×
322	']' }) recordInfo.	×
323		×
324	params := {	×
325	#author -> username.	×
326	#since -> '01 january 2023' asDate asDateAndTime asString.	×
327	#until -> Date today asDateAndTime asString	×
328	} asDictionary.	×
329	response := glhImporter repoApi commits getAllInProject: project id withParams: params.	×
330	response := (response collect: [ :commitsJson \| glhImporter parseCommitsResult: commitsJson]) flattened.	×
331	response isNotEmpty	×
332	].	×
333		×
334	^ itsProjects	×
335	]	×
336
337	{ #category : #projects }
338	GitMetricExporter >> findProjectsOfUser: aCollection [	×
339	self shouldBeImplemented.	×
340	]	×
341
342	{ #category : #analysis }
343	GitMetricExporter >> generateAnalysesOver: aDateWeekMonthOrYear [	×
344		×
345	analyses := OrderedCollection new.	×
346	runningPeriods do: [ :period \|	×
347	analyses addAll: (self	×
348	generateUsersAnalysesDuringPeriod: period	×
349	over: aDateWeekMonthOrYear).	×
350		×
351	analyses addAll: (self	×
352	generateProjectsAnalysesDuringPeriod: period	×
353	over: aDateWeekMonthOrYear) ].	×
354		×
355	^ analyses	×
356	]	×
357
358	{ #category : #analysis }
359	GitMetricExporter >> generateProjectsAnalysesDuringPeriod: period over: aDateWeekMonthOrYear [	×
360		×
361	^self projectEntities collect: [ :project \|	×
362	\| projectAnalysisReport \|	×
363	projectAnalysisReport := ProjectAnalysisReport new	×
364	projectName: project name;	×
365	period: period;	×
366	over: aDateWeekMonthOrYear.	×
367		×
368		×
369	self projectMetrics do: [ :metric \|	×
370	\|newMetric result\|	×
371	newMetric := metric new	×
372	glhImporter: glhImporter;	×
373	jiraImporter: jiraImporter;	×
374	setPeriodSince: (period at: #since)	×
375	until: (period at: #until);	×
376	over: aDateWeekMonthOrYear;	×
377	project: project.	×
378		×
379		×
380	result := newMetric calculate.	×
381	projectAnalysisReport metrics at: newMetric name put: result ].	×
382		×
383	projectAnalysisReport]	×
384	]	×
385
386	{ #category : #analysis }
387	GitMetricExporter >> generateUsersAnalysesDuringPeriod: period over: aDateWeekMonthOrYear [	×
388		×
389	\| userAnalysisReport newMetric result \|	×
390	^ self userEntities collect: [ :user \|	×
391	userAnalysisReport := UserAnalysisReport new	×
392	username: user name;	×
393	email: (user email ifNil: [ user public_email]);	×
394	period: period;	×
395	over: aDateWeekMonthOrYear.	×
396		×
397	self userMetrics do: [ :metric \|	×
398	newMetric := metric new	×
399	glhImporter: glhImporter;	×
400	jiraImporter: jiraImporter;	×
401	setPeriodSince: (period at: #since)	×
402	until: (period at: #until);	×
403	over: aDateWeekMonthOrYear;	×
404	user: user;	×
405	emailDomain: emailDomain.	×
406		×
407		×
408	result := newMetric calculate.	×
409	userAnalysisReport metrics at: newMetric name put: result ].	×
410		×
411	userAnalysisReport ]	×
412	]	×
413
414	{ #category : #utilities }
415	GitMetricExporter >> getAnalysisWithDate: date from: analysisCollection [	×
416		×
417	^analysisCollection	×
418	detect: [ :groupAnalysis \| (groupAnalysis period at: #since) = date ]	×
419	ifNone: [ nil ]	×
420	]	×
421
422	{ #category : #accessing }
423	GitMetricExporter >> glhImporter: anImporter [	×
424		×
425	glhImporter := anImporter withInitialCommits: false; yourself.	×
426	]	×
427
428	{ #category : #adding }
429	GitMetricExporter >> importAnalysesFromS3: bucketName accessKey: accessKey secretKey: secretKey region: region [	×
430		×
431	\| s3 bucket xmlObjects contentElements filesContent \|	×
432	AWSS3Config default	×
433	accessKeyId: accessKey;	×
434	secretKey: secretKey;	×
435	regionName: region.	×
436		×
437	s3 := AWSS3 new.	×
438	bucket := s3 bucketNamed: bucketName.	×
439	xmlObjects := bucket listObjects.	×
440	contentElements := xmlObjects root elementsSelect: [ :element \|	×
441	element isNamed: 'Contents' ].	×
442		×
443	filesContent := contentElements collect: [ :contentElement \|	×
444	\| keyValue \|	×
445	keyValue := contentElement contentStringAt: 'Key'.	×
446	bucket getObject: keyValue ].	×
447		×
448	^ analyses := (filesContent collect: [ :file \| STON fromString: file ])	×
449	flattened	×
450	]	×
451
452	{ #category : #initialization }
453	GitMetricExporter >> initialize [	×
454		×
455	entities := OrderedCollection new.	×
456	"set up the minimal date from which we are looking for the commits a particular user in projects"	×
457	sinceTimeLimit := '2024-01-01' asDate asDateAndTime.	×
458	runningPeriods := OrderedCollection new.	×
459	maxCommitWindow := 3.	×
460	over := Date.	×
461		×
462	analyses := OrderedCollection new.	×
463		×
464	"User Metrics"	×
465	metrics := {	×
466	CodeAdditionMetric.	×
467	CodeDeletionMetric.	×
468	CommentContributionMetric.	×
469	CommitFrequencyMetric.	×
470	CodeChurnMetric.	×
471	DelayUntilFirstChurnMetric.	×
472	TimeBetweenCommitMetric.	×
473	ContributedProjectMetric.	×
474	CodeAdditionByMRMetric.	×
475	CodeDeletionByMRMetric.	×
476	MergeRequestDurationMetric.	×
477	OpenedMergeRequestMetric.	×
478	ClosedMergeRequestMetric.	×
479	MergedMergeRequestMetric.	×
480	SelfMergedUnderAMinuteMergeRequestMetric.	×
481	ClosedTicketsMetric.	×
482	JiraTimeMRTimeDifferenceMetric.	×
483	CommitsNumberByJiraTicketsMetric.	×
484	CommitsLinkWithTicketMetric.	×
485		×
486	"ProjectMetric subclasses"	×
487	ClosedMergeRequestProjectMetric.	×
488	CommitFrequencyProjectMetric.	×
489	CreatedMergeRequestProjectMetric.	×
490	MergedMergeRequestProjectMetric.	×
491	ClosedMergeRequestDurationProjectMetric.	×
492	MergedMergeRequestDurationProjectMetric.	×
493	OpenedMergeRequestDurationProjectMetric.	×
494	ContributorsProjectMetric.	×
495	AutoCodeReviewCommitFrequencyProjectMetric.	×
496	CodeAdditionByMergeRequestProjectMetric.	×
NEW 497		×
NEW 498	CodeDeletionDuringAndByMergeRequestProjectMetric.	×
499	CodeAdditionDuringAndByMergeRequestProjectMetric.	×
500	CodeDeletionByMergeRequestProjectMetric.	×
NEW 501	CodeChurnOnCommitsProjectMetric.	×
NEW 502	SelfMergedUnderAMinuteMergeRequestProjectMetric.	×
503	JiraTimeMRTimeDifferenceProjectMetric.	×
504	}.	×
505		×
506	self flag:	×
507	'Futur updates should considers loading metrics directly from subclasses instead of manual selection inside the initialize'	×
UNCOV 508	"metrics addAll: ProjectMetric subclasses."	×
UNCOV 509	]	×
510
511	{ #category : #accessing }
512	GitMetricExporter >> jiraImporter: anObject [	×
513		×
UNCOV 514	jiraImporter := anObject	×
UNCOV 515	]	×
516
517	{ #category : #accessing }
518	GitMetricExporter >> label: aString [	×
UNCOV 519	label := aString	×
UNCOV 520	]	×
521
522	{ #category : #accessing }
523	GitMetricExporter >> maxCommitWindow: anInteger [	×
UNCOV 524	maxCommitWindow := anInteger abs	×
UNCOV 525	]	×
526
527	{ #category : #accessing }
528	GitMetricExporter >> metrics [	×
529		×
UNCOV 530	^ metrics	×
UNCOV 531	]	×
532
533	{ #category : #accessing }
534	GitMetricExporter >> metrics: anObject [	×
535		×
UNCOV 536	metrics := anObject	×
UNCOV 537	]	×
538
539	{ #category : #adding }
540	GitMetricExporter >> onlyImportProjectsOfGroup: groupId [	×
541		×
542	\| group \|	×
543	group := glhImporter importGroup: groupId.	×
UNCOV 544	projectCache := group toScope: GLHProject	×
UNCOV 545	]	×
546
547	{ #category : #accessing }
548	GitMetricExporter >> projectAnalyses [	×
549		×
UNCOV 550	^ analyses select: [ :analysis \| analysis class = ProjectAnalysisReport ]	×
UNCOV 551	]	×
552
553	{ #category : #accessing }
554	GitMetricExporter >> projectEntities [	×
555		×
UNCOV 556	^ entities select: [ :entity \| entity class = GLHProject ]	×
UNCOV 557	]	×
558
559	{ #category : #accessing }
560	GitMetricExporter >> projectMetrics [	×
561		×
UNCOV 562	^ metrics select: [ :metric \| metric inheritsFrom: ProjectMetric ]	×
UNCOV 563	]	×
564
565	{ #category : #setup }
566	GitMetricExporter >> setupAnalysisForProjectsWithIds: projectIds [	×
567		×
568	\| projects \|	×
569	projects := glhImporter importProjects: projectIds.	×
570		×
UNCOV 571	entities addAll: projects	×
UNCOV 572	]	×
573
574	{ #category : #setup }
575	GitMetricExporter >> setupAnalysisForUsersWithNames: userNames [	×
576	"import all the project since a certain time"	×
577		×
578	\| users \|	×
579	users := userNames collect: [ :username \|	×
580	glhImporter importUserByUsername: username ].	×
581		×
582	glhImporter userCatalogue ifNotNil: [	×
583	glhImporter userCatalogue scrapeAuthorNamesForUsers: users ].	×
584		×
585	users do: [ :user \|	×
586	\| projects \|	×
587	projects := glhImporter importContributedProjectsOfUser: user.	×
588		×
589	projects do: [ :project \|	×
590	glhImporter completeImportProject: project ] ].	×
591		×
592	entities addAll: users.	×
593		×
UNCOV 594	^ self	×
UNCOV 595	]	×
596
597	{ #category : #accessing }
598	GitMetricExporter >> userAnalyses [	×
599		×
UNCOV 600	^ analyses select: [ :analysis \| analysis class = UserAnalysisReport ]	×
UNCOV 601	]	×
602
603	{ #category : #accessing }
604	GitMetricExporter >> userEntities [	×
605		×
UNCOV 606	^ entities select: [ :entity \| entity class = GLHUser ]	×
UNCOV 607	]	×
608
609	{ #category : #accessing }
610	GitMetricExporter >> userMetrics [	×
611		×
UNCOV 612	^ metrics select: [ :metric \| metric inheritsFrom: UserMetric ]	×
UNCOV 613	]	×
614
615	{ #category : #setup }
616	GitMetricExporter >> withEmailDomain: anEmailDomain [	×
617		×
618	"define the email domain of your Git user. Usefull to link them between service (i.e. Jira)"	×
UNCOV 619	emailDomain := anEmailDomain	×
UNCOV 620	]	×

moosetechnology / GitProjectHealth / 13919072139

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous