Address issue #611

http URLs can now be used as a ruleset location and it will be fetched automatically.

Author: daveshanley

cmd/build_results.go

@@ -1,11 +1,14 @@
 package cmd
 
 import (
+	"context"
+	"fmt"
 	"github.com/daveshanley/vacuum/model"
 	"github.com/daveshanley/vacuum/motor"
 	"github.com/daveshanley/vacuum/rulesets"
 	"github.com/pterm/pterm"
 	"os"
+	"strings"
 	"time"
 )
 
@@ -60,13 +63,26 @@ func BuildResultsWithDocCheckSkip(
 	// and see if it's valid. If so - let's go!
 	if rulesetFlag != "" {
 
-		rsBytes, rsErr := os.ReadFile(rulesetFlag)
-		if rsErr != nil {
-			return nil, nil, rsErr
-		}
-		selectedRS, rsErr = BuildRuleSetFromUserSuppliedSet(rsBytes, defaultRuleSets)
-		if rsErr != nil {
-			return nil, nil, rsErr
+		if strings.HasPrefix(rulesetFlag, "http") {
+			// Handle remote ruleset URL
+			if !remote {
+				return nil, nil, fmt.Errorf("remote ruleset specified but remote flag is disabled (use --remote=true or -u=true)")
+			}
+			downloadedRS, rsErr := rulesets.DownloadRemoteRuleSet(context.Background(), rulesetFlag)
+			if rsErr != nil {
+				return nil, nil, rsErr
+			}
+			selectedRS = defaultRuleSets.GenerateRuleSetFromSuppliedRuleSet(downloadedRS)
+		} else {
+			// Handle local ruleset file
+			rsBytes, rsErr := os.ReadFile(rulesetFlag)
+			if rsErr != nil {
+				return nil, nil, rsErr
+			}
+			selectedRS, rsErr = BuildRuleSetFromUserSuppliedSet(rsBytes, defaultRuleSets)
+			if rsErr != nil {
+				return nil, nil, rsErr
+			}
 		}
 	}
 

cmd/language_server.go

@@ -12,7 +12,6 @@ import (
 	"github.com/spf13/cobra"
 	"io"
 	"log/slog"
-	"os"
 )
 
 func GetLanguageServerCommand() *cobra.Command {
@@ -60,12 +59,9 @@ IDE and start linting your OpenAPI documents in real-time.`,
 			}
 
 			if rulesetFlag != "" {
-				rsBytes, rsErr := os.ReadFile(rulesetFlag)
-				if rsErr != nil {
-					return rsErr
-				}
-
-				selectedRS, rsErr = BuildRuleSetFromUserSuppliedSet(rsBytes, defaultRuleSets)
+				remoteFlag, _ := cmd.Flags().GetBool("remote")
+				var rsErr error
+				selectedRS, rsErr = BuildRuleSetFromUserSuppliedLocation(rulesetFlag, defaultRuleSets, remoteFlag)
 				if rsErr != nil {
 					return rsErr
 				}

cmd/lint.go

@@ -180,17 +180,13 @@ func GetLintCommand() *cobra.Command {
 			// and see if it's valid. If so - let's go!
 			if rulesetFlag != "" {
 
-				rsBytes, rsErr := os.ReadFile(rulesetFlag)
+				var rsErr error
+				selectedRS, rsErr = BuildRuleSetFromUserSuppliedLocation(rulesetFlag, defaultRuleSets, remoteFlag)
 				if rsErr != nil {
-					pterm.Error.Printf("Unable to read ruleset file '%s': %s\n", rulesetFlag, rsErr.Error())
+					pterm.Error.Printf("Unable to load ruleset '%s': %s\n", rulesetFlag, rsErr.Error())
 					pterm.Println()
 					return rsErr
 				}
-
-				selectedRS, rsErr = BuildRuleSetFromUserSuppliedSet(rsBytes, defaultRuleSets)
-				if rsErr != nil {
-					return rsErr
-				}
 			}
 
 			var printLock sync.Mutex

cmd/shared_functions.go

@@ -4,16 +4,20 @@
 package cmd
 
 import (
+	"context"
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
 	"github.com/daveshanley/vacuum/plugin"
 	"github.com/daveshanley/vacuum/rulesets"
 	"github.com/dustin/go-humanize"
 	"github.com/pb33f/libopenapi/index"
 	"github.com/pterm/pterm"
+	"os"
+	"strings"
 	"time"
 )
 
+
 // BuildRuleSetFromUserSuppliedSet creates a ready to run ruleset, augmented or provided by a user
 // configured ruleset. This ruleset could be lifted directly from a Spectral configuration.
 func BuildRuleSetFromUserSuppliedSet(rsBytes []byte, rs rulesets.RuleSets) (*rulesets.RuleSet, error) {
@@ -29,6 +33,28 @@ func BuildRuleSetFromUserSuppliedSet(rsBytes []byte, rs rulesets.RuleSets) (*rul
 	return rs.GenerateRuleSetFromSuppliedRuleSet(userRS), nil
 }
 
+// BuildRuleSetFromUserSuppliedLocation creates a ready to run ruleset from a location (file path or URL)
+func BuildRuleSetFromUserSuppliedLocation(rulesetFlag string, rs rulesets.RuleSets, remote bool) (*rulesets.RuleSet, error) {
+	if strings.HasPrefix(rulesetFlag, "http") {
+		// Handle remote ruleset URL directly
+		if !remote {
+			return nil, fmt.Errorf("remote ruleset specified but remote flag is disabled (use --remote=true or -u=true)")
+		}
+		downloadedRS, rsErr := rulesets.DownloadRemoteRuleSet(context.Background(), rulesetFlag)
+		if rsErr != nil {
+			return nil, rsErr
+		}
+		return rs.GenerateRuleSetFromSuppliedRuleSet(downloadedRS), nil
+	} else {
+		// Handle local ruleset file
+		rsBytes, rsErr := os.ReadFile(rulesetFlag)
+		if rsErr != nil {
+			return nil, rsErr
+		}
+		return BuildRuleSetFromUserSuppliedSet(rsBytes, rs)
+	}
+}
+
 // RenderTimeAndFiles  will render out the time taken to process a specification, and the size of the file in kb.
 // it will also render out how many files were processed.
 func RenderTimeAndFiles(timeFlag bool, duration time.Duration, fileSize int64, totalFiles int) {

cmd/spectral_report.go

@@ -136,16 +136,13 @@ func GetSpectralReportCommand() *cobra.Command {
 			if rulesetFlag != "" {
 
 				customFunctions, _ = LoadCustomFunctions(functionsFlag, true)
-				rsBytes, rsErr := os.ReadFile(rulesetFlag)
+				var rsErr error
+				selectedRS, rsErr = BuildRuleSetFromUserSuppliedLocation(rulesetFlag, defaultRuleSets, remoteFlag)
 				if rsErr != nil {
-					pterm.Error.Printf("Unable to read ruleset file '%s': %s\n", rulesetFlag, rsErr.Error())
+					pterm.Error.Printf("Unable to load ruleset '%s': %s\n", rulesetFlag, rsErr.Error())
 					pterm.Println()
 					return rsErr
 				}
-				selectedRS, rsErr = BuildRuleSetFromUserSuppliedSet(rsBytes, defaultRuleSets)
-				if rsErr != nil {
-					return rsErr
-				}
 			}
 
 			if !stdIn && !stdOut {

cmd/vacuum_report.go

@@ -153,16 +153,13 @@ func GetVacuumReportCommand() *cobra.Command {
 
 				customFunctions, _ = LoadCustomFunctions(functionsFlag, true)
 
-				rsBytes, rsErr := os.ReadFile(rulesetFlag)
+				var rsErr error
+				selectedRS, rsErr = BuildRuleSetFromUserSuppliedLocation(rulesetFlag, defaultRuleSets, remoteFlag)
 				if rsErr != nil {
-					pterm.Error.Printf("Unable to read ruleset file '%s': %s\n", rulesetFlag, rsErr.Error())
+					pterm.Error.Printf("Unable to load ruleset '%s': %s\n", rulesetFlag, rsErr.Error())
 					pterm.Println()
 					return rsErr
 				}
-				selectedRS, rsErr = BuildRuleSetFromUserSuppliedSet(rsBytes, defaultRuleSets)
-				if rsErr != nil {
-					return rsErr
-				}
 			}
 
 			if !stdIn && !stdOut {