Merge 0f9d842 into a318748

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the action will run. Triggers the workflow on push or pull request events on every branch
+on: [push, pull_request]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    strategy:
+      matrix:
+        # Select platform(s)
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        # Select compatible Smalltalk image(s)
+        smalltalk: [Squeak64-trunk, Squeak64-5.3, Squeak64-5.2, Squeak64-5.1]
+    # The type of runner that the job will run on
+    runs-on: ${{ matrix.os }}
+    name: ${{ matrix.smalltalk }} on ${{ matrix.os }}
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      - name: Setup smalltalkCI
+        uses: hpi-swa/setup-smalltalkCI@v1
+        with:
+          smalltalk-version: ${{ matrix.smalltalk }}
+      - name: Test MorphicAPIExplorer
+        run: smalltalkci -s ${{ matrix.smalltalk }}
+        shell: bash
+        timeout-minutes: 15
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/linter.yml

@@ -0,0 +1,24 @@
+name: Linter
+
+# Controls when the action will run. Triggers the workflow on push or pull request events on every branch
+on: [push, pull_request]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    name: Squeak64-5.3 on ubuntu-latest
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      - name: Setup smalltalkCI
+        uses: hpi-swa/setup-smalltalkCI@v1
+        with:
+          smalltalk-version: Squeak64-5.3
+      - name: Test MorphicAPIExplorer
+        run: smalltalkci -s Squeak64-5.3 .linter.ston
+        shell: bash
+        timeout-minutes: 15

.linter.ston

@@ -0,0 +1,14 @@
+SmalltalkCISpec {
+  #preLoading : 'scripts/preLoading.st',
+  #loading : [
+    SCIMetacelloLoadSpec {
+      #baseline : 'MorphicAPIExplorer',
+      #directory : 'packages',
+      #load : 'tests',
+      #platforms : [ #squeak ]
+    }
+  ],
+  #testing : {
+    #classes : [ #MEXLinter ]
+  }
+}

.smalltalk.ston

@@ -1,10 +1,19 @@
 SmalltalkCISpec {
+  #preLoading : 'scripts/preLoading.st',
   #loading : [
     SCIMetacelloLoadSpec {
       #baseline : 'MorphicAPIExplorer',
       #platforms : [ #squeak ],
       #directory : 'packages',
-      #load : [ 'tests' ]
+      #load : 'tests'
     }
-  ]
+  ],
+  #testing : {
+    #exclude : {
+      #classes : [ #MEXLinter ]
+    },
+    #coverage : {
+      #packages : [ 'MorphicAPIExplorer-Core.*' ]
+    }
+  }
 }

README.md

@@ -1,4 +1,4 @@
-# MorphicAPIExplorer [![Build Status](https://travis-ci.org/hpi-swa-teaching/MorphicAPIExplorer.svg?branch=master)](https://travis-ci.org/hpi-swa-teaching/MorphicAPIExplorer)
+# MorphicAPIExplorer ![Build Status](https://github.com/hpi-swa-teaching/MorphicAPIExplorer/workflows/CI/badge.svg?branch=dev)
 
 ## Usage
 When you cloned the repository from GitHub or installed the SAR archive you can simply open up a Workspace and type

packages/BaselineOfMorphicAPIExplorer.package/BaselineOfMorphicAPIExplorer.class/instance/baseline..st

@@ -5,10 +5,39 @@ baseline: spec
 		for: #'common'
 		do: [
 			spec
+				"requirements for SwaLint"
+				project: 'RefactoringBrowser' with: [
+					spec
+						className: 'ConfigurationOfRefactoringBrowser';
+						versionString: #'stable';
+						loads: #('Core' );
+						repository: 'http://www.squeaksource.com/MetacelloRepository' ];
+				"SwaLint setup"
+				package: 'SwaLint-Preferences' with: [
+					spec
+						file: 'SwaLint-Preferences-cypress.1';
+						repository: 'github://hpi-swa-teaching/SwaLint:main/packages'];
+				package: 'SwaLint-Core' with: [
+					spec
+						file: 'SwaLint-Core-cypress.1';
+						repository: 'github://hpi-swa-teaching/SwaLint:main/packages';
+						requires: #('RefactoringBrowser' 'SwaLint-Preferences')];
+				package: 'SwaLint-PlugIns' with: [
+					spec
+						file: 'SwaLint-PlugIns-cypress.1';
+						repository: 'github://hpi-swa-teaching/SwaLint:main/packages';
+						requires: 'SwaLint-Core'];
+
+				postLoadDoIt: #postLoad;
+
+				"MorphicAPIExplorer setup"
 				package: 'MorphicAPIExplorer-Core';
-				package: 'MorphicAPIExplorer-Tests' with: [spec requires: #('MorphicAPIExplorer-Core')];
+				package: 'MorphicAPIExplorer-Tests' with: [
+					spec
+						requires: #('MorphicAPIExplorer-Core' 'SwaLint-Core' 'SwaLint-PlugIns')];
 				yourself.
+
 			spec
 				group: 'default' with: #('MorphicAPIExplorer-Core');
 				group: 'tests' with: #('MorphicAPIExplorer-Tests')];
-				yourself
+				yourself

packages/BaselineOfMorphicAPIExplorer.package/BaselineOfMorphicAPIExplorer.class/instance/postLoad.st

@@ -0,0 +1,4 @@
+baseline
+postLoad
+
+	(Smalltalk globals at: #SwaLint) perform: #install

packages/BaselineOfMorphicAPIExplorer.package/BaselineOfMorphicAPIExplorer.class/methodProperties.json

@@ -2,4 +2,5 @@
 	"class" : {
 		 },
 	"instance" : {
-		"baseline:" : "pre 4/10/2019 16:41" } }
+		"baseline:" : "pre 4/10/2019 16:41",
+		"postLoad" : " 6/14/2021 12:22:11" } }

packages/MorphicAPIExplorer-Core.package/MEXMethod.class/instance/splitMethodOnParameters.st

@@ -1,4 +1,4 @@
 creation
 splitMethodOnParameters
 
-	^ self name findTokens: #:
+	^ self name findTokens: $:

packages/MorphicAPIExplorer-Core.package/MEXMethod.class/methodProperties.json

@@ -19,7 +19,7 @@
 		"parameterOf:" : "jb 7/18/2019 18:21",
 		"parameters" : "lk 6/21/2019 18:18",
 		"parameters:" : "lk 6/21/2019 18:18",
-		"splitMethodOnParameters" : "jb 7/18/2019 17:46",
+		"splitMethodOnParameters" : "SC 6/14/2021 17:53",
 		"subItems" : "TB 6/1/2021 17:54",
 		"subMethods" : "FFN 5/20/2019 15:21",
 		"subMethods:" : "FFN 5/20/2019 16:06" } }

packages/MorphicAPIExplorer-Core.package/MEXToolExplorationView.class/instance/fillMorphBox.st

@@ -3,7 +3,7 @@ fillMorphBox
 
 	| button gap iconMorph |
 	gap := 0.
-	self defaultMorphs keysInOrder do: [:each |
+	self defaultMorphs keysSortedSafely do: [:each |
 		iconMorph := (self evaluateMethodsForMorph: each).
 		button := SimpleButtonMorph new
 			label: '';

packages/MorphicAPIExplorer-Core.package/MEXToolExplorationView.class/methodProperties.json

@@ -35,7 +35,7 @@
 		"defaultMorphs:" : "SH 5/20/2021 13:30",
 		"evaluateCode:" : "jb 7/24/2019 14:09",
 		"evaluateMethodsForMorph:" : "SH 5/20/2021 17:28",
-		"fillMorphBox" : "TB 6/7/2021 12:10",
+		"fillMorphBox" : "SC 6/14/2021 17:08",
 		"getSelectionFor:" : "FFN 6/19/2019 16:18",
 		"initialize" : "SH 5/20/2021 14:13",
 		"methodList" : "FFN 6/5/2019 23:02",

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/README.md

@@ -0,0 +1,4 @@
+I'm the class that is used to test the package 'MorphicAPIExplorer-Core' with the linting rules provided by SwaLint and in accordance with the coding standards. Apart from being your typical linter class for squeak, I don't offer any other functionality.
+
+Instance Variables
+	classes:		A Collection of classes that are supposed to be checked by the linting rules

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/class/mexCorePackage.st

@@ -0,0 +1,4 @@
+packages
+mexCorePackage
+
+	^ self namedPackage: 'MorphicAPIExplorer-Core'

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/class/mexTestsPackage.st

@@ -0,0 +1,4 @@
+packages
+mexTestsPackage
+
+	^ self namedPackage: 'MorphicAPIExplorer-Tests'

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/class/namedPackage..st

@@ -0,0 +1,4 @@
+packages
+namedPackage: aString
+
+	^ PackageOrganizer default packageNamed: aString ifAbsent: [self error: aString , ' package is missing']

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/assertAll.areBelowThreshold..st

@@ -0,0 +1,4 @@
+testing-utils
+assertAll: aCollectionOfNumbers areBelowThreshold: aNumber
+
+	self assert: (aCollectionOfNumbers allSatisfy: [:each | each < aNumber])

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/assertAll.areEqualTo..st

@@ -0,0 +1,4 @@
+testing-utils
+assertAll: aCollectionOfObjects areEqualTo: anObject
+
+	self assert: (aCollectionOfObjects allSatisfy: [:each | each = anObject])

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/assertAll.areOverThreshold..st

@@ -0,0 +1,4 @@
+testing-utils
+assertAll: aCollectionOfNumbers areOverThreshold: aNumber
+
+	self assert: (aCollectionOfNumbers allSatisfy: [:each | each > aNumber])

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/assertAllAreFalse..st

@@ -0,0 +1,4 @@
+testing-utils
+assertAllAreFalse: aCollectionOfBooleans
+
+	self assertAll: aCollectionOfBooleans areEqualTo: false

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/assertAllAreZero..st

@@ -0,0 +1,4 @@
+testing-utils
+assertAllAreZero: aCollectionOfNumbers
+
+	self assertAll: aCollectionOfNumbers areEqualTo: 0

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestBrainMethod.st

@@ -0,0 +1,5 @@
+test-for-disharmonies
+brokenTestBrainMethod
+	"wrong SL Type"
+
+	self assertAllAreFalse: (self runLinterRule: #brainMethod:)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestDispersedCoupling.st

@@ -0,0 +1,5 @@
+test-for-disharmonies
+brokenTestDispersedCoupling
+	"wrong SL Type"
+
+	self assertAllAreFalse: (self runLinterRule: #dispersedCoupling:)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestFeatureEnvy.st

@@ -0,0 +1,5 @@
+test-for-disharmonies
+brokenTestFeatureEnvy
+	"wrong SL Type"
+
+	self assertAllAreFalse: (self runLinterRule: #featureEnvy:)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestInstanceVariablesNotReadAndWritten.st

@@ -0,0 +1,5 @@
+test-unnecessary-code
+brokenTestInstanceVariablesNotReadAndWritten
+	"literally broken"
+
+	self assertAllAreZero: (self runLinterRule: #smallLintOnlyReadOrWrittenVariable)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestIntensiveCoupling.st

@@ -0,0 +1,5 @@
+test-for-disharmonies
+brokenTestIntensiveCoupling
+	"wrong SL Type"
+
+	self assertAllAreFalse: (self runLinterRule: #intensiveCoupling:)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestLiteralValues.st

@@ -0,0 +1,5 @@
+test-for-spelling
+brokenTestLiteralValues
+	"literally inherently broken"
+
+	self assertAllAreZero: (self runLinterRule: #smallLintLiteralValuesSpelling)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestMethodSelectors.st

@@ -0,0 +1,5 @@
+test-for-spelling
+brokenTestMethodSelectors
+	"literally inherently broken"
+
+	self assertAllAreZero: (self runLinterRule: #smallLintMethodSelectorsSpelling)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestNamespaceSimulation.st

@@ -0,0 +1,5 @@
+test-for-coding-styles
+brokenTestNamespaceSimulation
+	"wrong SL Type"
+
+	self assertAllAreZero: (self runLinterRule: #namespaceSimulation:)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestShotgunSurgery.st

@@ -0,0 +1,5 @@
+test-for-disharmonies
+brokenTestShotgunSurgery
+	"wrong SL Type"
+
+	self assertAllAreFalse: (self runLinterRule: #shotgunSurgery:)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestSignificantDuplication.st

@@ -0,0 +1,5 @@
+test-for-disharmonies
+brokenTestSignificantDuplication
+	"wrong SL Type"
+
+	self assertAllAreFalse: (self runLinterRule: #significantDuplication:)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenTestTraditionBreaker.st

@@ -0,0 +1,5 @@
+test-for-disharmonies
+brokenTestTraditionBreaker
+	"literally doesn't work"
+
+	self assertAllAreFalse: (self runLinterRule: #traditionBreaker:)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/brokenVariableIsOnlyAssignedALiteralValue.st

@@ -0,0 +1,4 @@
+test-for-miscellaneous
+brokenVariableIsOnlyAssignedALiteralValue
+
+	self assertAllAreZero: (self runLinterRule: #smallLintVariableAssignedLiteral)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/classes..st

@@ -0,0 +1,4 @@
+accessing
+classes: aCollection
+
+	classes := aCollection

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/classes.st

@@ -0,0 +1,4 @@
+accessing
+classes
+
+	^ classes

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/defaultTimeout.st

@@ -0,0 +1,4 @@
+test-for-spelling
+defaultTimeout
+
+	^ 30 "seconds"

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/dontTestClassComments.st

@@ -0,0 +1,5 @@
+test-for-spelling
+dontTestClassComments
+	"triggers even when we can't find any spelling mistakes so we're taking it out"
+
+	self assertAllAreZero: (self runLinterRule: #smallLintClassCommentsSpelling)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/dontTestExcessiveNumberOfArguments.st

@@ -0,0 +1,5 @@
+test-for-miscellaneous
+dontTestExcessiveNumberOfArguments
+	"This triggers for the buildButtonWith:label:action:help:enabled: method, which does have many names, but only because buttons have so many properties."
+
+	self assertAllAreZero: (self runLinterRule: #smallLintExcessiveArguments)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/dontTestExcessiveNumberOfMethods.st

@@ -0,0 +1,5 @@
+test-for-miscellaneous
+dontTestExcessiveNumberOfMethods
+	"Turns out, the CRLinter has quite a big number of statements."
+
+	self assertAllAreZero: (self runLinterRule: #smallLintExcessiveMethods)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/dontTestLawOfDemeter.st

@@ -0,0 +1,5 @@
+test-for-intention-revealing
+dontTestLawOfDemeter
+	"Incorrectly triggers when chaining multiple collection protocol methods."
+
+	self assertAllAreZero: (self runLinterRule: #lawOfDemeterRule:)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/dontTestLongMethods.st

@@ -0,0 +1,5 @@
+test-for-coding-styles
+dontTestLongMethods
+	"this one sucks because we can't really do something about it"
+
+	self assertAllAreZero: (self runLinterRule: #longMethods:)

packages/MorphicAPIExplorer-Tests.package/MEXLinter.class/instance/dontTestLongMethodsOnlyStatements.st

@@ -0,0 +1,5 @@
+test-for-coding-styles
+dontTestLongMethodsOnlyStatements
+	"Some methods, like testSetItemSelectionAtTo have more than 10 statements and that's fine."
+
+	self assertAllAreZero: (self runLinterRule: #longMethod:)