MooseRuleEngine 1.2.0

README.md

@@ -148,6 +148,8 @@ initialize
 - `analyse`: Takes an `MREFile` and returns a collection of `MREViolation`.
 - `fix`: Takes an `MREViolation` and returns a collection of `MREFix`.
 
+A rule must also specify the file extensions it supports. To help with common languages, MooseRuleEngine provides traits such as `TJavaRule` for Java files and `TTypescriptRule` for TypeScript files.
+
 ### Helper
 
 Helpers are classes injected into rules to assist in writing them. They are useful for interacting with external systems like SonarQube or LLMs.
@@ -200,4 +202,4 @@ llmApi := LLMAPI chat.
 llmApi host: '<llm_host>'.
 llmApi apiKey: '<llm_api_key>'.
 llmHelper := MRELLMHelper new llmApi: llmApi.
-```
+```

src/BaselineOfMooseRuleEngine/BaselineOfMooseRuleEngine.class.st

@@ -21,34 +21,35 @@ BaselineOfMooseRuleEngine >> defineDependencies: spec [
 	spec
 		baseline: 'Mocketry'
 		with: [ spec repository: 'github://dionisiydk/Mocketry' ].
-		
+
 	spec
 		baseline: 'LLMAPI'
 		with: [ spec repository: 'github://Evref-BL/Pharo-LLMAPI:main/src' ].
-		
-	spec 
-	baseline: 'SonarqubePharoAPI'
+
+	spec
+		baseline: 'SonarqubePharoAPI'
 		with: [
-			spec repository: 'github://Evref-BL/Sonarqube-Pharo-API:develop' ].
+		spec repository: 'github://Evref-BL/Sonarqube-Pharo-API:develop' ].
 
 	spec baseline: 'FASTJava' with: [
 		spec
 			repository: 'github://moosetechnology/FAST-Java:v3/src';
-			loads: #( 'smacc' ) ].	
-
+			loads: #( 'smacc' ) ]
 ]
 
 { #category : 'groups' }
 BaselineOfMooseRuleEngine >> defineGroups: spec [
+
+
 ]
 
 { #category : 'packages' }
 BaselineOfMooseRuleEngine >> definePackages: spec [
 
 	spec
 		package: 'MooseRuleEngine'
-		with: [ spec requires: #( 'LLMAPI' 'SonarqubePharoAPI' 'FASTJava' ) ].
+		with: [ spec requires: #( 'LLMAPI' 'SonarqubePharoAPI' ) ].
 	spec
 		package: 'MooseRuleEngine-Tests'
-		with: [ spec requires: #( 'MooseRuleEngine' 'Mocketry' ) ]
+		with: [ spec requires: #( 'MooseRuleEngine' 'Mocketry' 'FASTJava' ) ]
 ]

src/MooseRuleEngine-Tests/MRERuleTest.class.st

@@ -8,6 +8,18 @@ Class {
 	#package : 'MooseRuleEngine-Tests'
 }
 
+{ #category : 'tests' }
+MRERuleTest >> testDoesNotApplyWithoutSupportedExtensions [
+
+	| rule file |
+	rule := MRERule new.
+	file := MREFile new
+		        path: 'test.java';
+		        content: 'content'.
+
+	self deny: (rule appliesToFile: file)
+]
+
 { #category : 'tests' }
 MRERuleTest >> testGetHelper [
 

src/MooseRuleEngine-Tests/MooseRuleEngineTest.class.st

@@ -71,6 +71,44 @@ MooseRuleEngineTest >> testDetectAndFix [
 	self assert: result size equals: 1
 ]
 
+{ #category : 'tests' }
+MooseRuleEngineTest >> testDetectIgnoresUnsupportedFiles [
+
+	| violations |
+	ruleEngine rules: { rule1 }.
+	ruleEngine files: {
+			file1.
+			file2 }.
+
+	violations := ruleEngine detect.
+
+	self assert: violations size equals: 1.
+	self assert: violations first rule equals: rule1
+]
+
+{ #category : 'tests' }
+MooseRuleEngineTest >> testDetectMixedRuleTypes [
+
+	| javaRule violations |
+	javaRule := RuleMockJava new.
+	ruleEngine rules: {
+			rule1.
+			javaRule }.
+	ruleEngine files: {
+			file1.
+			file2 }.
+
+	violations := ruleEngine detect.
+
+	self assert: violations size equals: 2.
+	self
+		assertCollection:
+		(violations collect: [ :violation | violation rule ])
+		hasSameElements: {
+				rule1.
+				javaRule }
+]
+
 { #category : 'tests' }
 MooseRuleEngineTest >> testDetectWithoutFiles [
 

src/MooseRuleEngine-Tests/RuleMock1.class.st

@@ -20,3 +20,9 @@ RuleMock1 >> fix: violation [
 	fix := MREFix new.
 	^ { fix }
 ]
+
+{ #category : 'accessing' }
+RuleMock1 >> supportedExtensions [
+
+	^ #( 'ts' )
+]

src/MooseRuleEngine-Tests/RuleMockJava.class.st

@@ -0,0 +1,12 @@
+Class {
+	#name : 'RuleMockJava',
+	#superclass : 'RuleMock1',
+	#category : 'MooseRuleEngine-Tests',
+	#package : 'MooseRuleEngine-Tests'
+}
+
+{ #category : 'accessing' }
+RuleMockJava >> supportedExtensions [
+
+	^ #( 'java' )
+]

src/MooseRuleEngine/MRERule.class.st

@@ -18,6 +18,13 @@ MRERule >> analyse: file [
 	^self subclassResponsibility 
 ]
 
+{ #category : 'testing' }
+MRERule >> appliesToFile: file [
+
+	^ self supportedExtensions includes:
+		  file path asFileReference extension asLowercase
+]
+
 { #category : 'accessing' }
 MRERule >> description [
 
@@ -87,3 +94,9 @@ MRERule >> name: anObject [
 
 	name := anObject
 ]
+
+{ #category : 'accessing' }
+MRERule >> supportedExtensions [
+
+	^ #(  )
+]

src/MooseRuleEngine/MooseRuleEngine.class.st

@@ -19,13 +19,13 @@ MooseRuleEngine >> addHelper: helper [
 
 { #category : 'as yet unclassified' }
 MooseRuleEngine >> detect [
+
 	| violations |
 	violations := rules collect: [ :rule |
-		files collect: [ :file | rule analyse: file ].
-	].
+		              (files select: [ :file | rule appliesToFile: file ])
+			              collect: [ :file | rule analyse: file ] ].
 
-	^ violations flattened 
-
+	^ violations flattened
 ]
 
 { #category : 'as yet unclassified' }

src/MooseRuleEngine/TJavaRule.trait.st

@@ -0,0 +1,11 @@
+Trait {
+	#name : 'TJavaRule',
+	#category : 'MooseRuleEngine',
+	#package : 'MooseRuleEngine'
+}
+
+{ #category : 'accessing' }
+TJavaRule >> supportedExtensions [
+
+	^ #( 'java' )
+]

src/MooseRuleEngine/TTypescriptRule.trait.st

@@ -0,0 +1,11 @@
+Trait {
+	#name : 'TTypescriptRule',
+	#category : 'MooseRuleEngine',
+	#package : 'MooseRuleEngine'
+}
+
+{ #category : 'accessing' }
+TTypescriptRule >> supportedExtensions [
+
+	^ #( 'ts' )
+]

src/MooseRuleEngine/TYAMLRule.trait.st

@@ -0,0 +1,11 @@
+Trait {
+	#name : 'TYAMLRule',
+	#category : 'MooseRuleEngine',
+	#package : 'MooseRuleEngine'
+}
+
+{ #category : 'accessing' }
+TYAMLRule >> supportedExtensions [
+
+	^ #( 'yaml' 'yml' )
+]