feat: add initializer for root_config with version and filesystems parameters

Makefile

@@ -11,7 +11,7 @@ prepare:
 	shards install
 
 build:
-	shards build --error-trace -Dpreview_mt
+	shards build --progress --error-trace -Dpreview_mt
 	@echo SUCCESS
 
 watch: 

spec/commands/mapping_create_spec.cr

@@ -3,5 +3,11 @@ require "../../src/commands/mapping_create"
 
 describe GX::Commands::MappingCreate do
   context "Initialization" do
+    it "initializes with a mock FileSystemManager and RootConfig" do
+      config = GX::Config.new
+      root_config = GX::Models::RootConfig.new
+      command = GX::Commands::MappingCreate.new(config)
+      command.should be_a(GX::Commands::MappingCreate)
+    end
   end
 end

spec/commands/mapping_edit_spec.cr

@@ -3,5 +3,10 @@ require "../../src/commands/mapping_edit"
 
 describe GX::Commands::MappingEdit do
   context "Initialization" do
+    it "initializes with a mock FileSystemManager" do
+      config = GX::Config.new
+      command = GX::Commands::MappingEdit.new(config)
+      command.should be_a(GX::Commands::MappingEdit)
+    end
   end
 end

spec/commands/mapping_list_spec.cr

@@ -1,7 +1,108 @@
+
 require "../spec_helper"
 require "../../src/commands/mapping_list"
+require "../../src/models/gocryptfs_config"
+require "../../src/models/sshfs_config"
+require "../../src/models/httpdirfs_config"
 
 describe GX::Commands::MappingList do
   context "Initialization" do
+    it "initializes with a mock FileSystemManager and RootConfig" do
+      config = GX::Config.new
+      root_config = GX::Models::RootConfig.new
+      command = GX::Commands::MappingList.new(config)
+      command.should be_a(GX::Commands::MappingList)
+    end
+  end
+
+  context "Functioning" do
+    it "lists mappings when there are no filesystems" do
+      config = GX::Config.new
+      root_config = GX::Models::RootConfig.new
+      command = GX::Commands::MappingList.new(config)
+
+      output = capture_output do
+        command.execute
+      end
+
+      output.should include("TYPE")
+      output.should include("NAME")
+      output.should include("MOUNTED")
+    end
+
+    it "lists mappings when there are multiple filesystems" do
+      config = GX::Config.new
+      root_config = GX::Models::RootConfig.new
+
+      gocryptfs_config = GX::Models::GoCryptFSConfig.new(
+        GX::Parsers::Options::MappingCreateOptions.new(
+          type: "gocryptfs",
+          name: "test_gocryptfs",
+          encrypted_path: "/encrypted/path"
+        )
+      )
+      sshfs_config = GX::Models::SshFSConfig.new(
+        GX::Parsers::Options::MappingCreateOptions.new(
+          type: "sshfs",
+          name: "test_sshfs",
+          remote_user: "user",
+          remote_host: "host",
+          remote_path: "/remote/path"
+        )
+      )
+      httpdirfs_config = GX::Models::HttpDirFSConfig.new(
+        GX::Parsers::Options::MappingCreateOptions.new(
+          type: "httpdirfs",
+          name: "test_httpdirfs",
+          url: "http://example.com"
+        )
+      )
+
+      root_config.add_filesystem(gocryptfs_config)
+      root_config.add_filesystem(sshfs_config)
+      root_config.add_filesystem(httpdirfs_config)
+
+      command = GX::Commands::MappingList.new(config)
+
+      output = capture_output do
+        command.execute
+      end
+
+      output.should include("gocryptfs")
+      output.should include("test_gocryptfs")
+      output.should include("false")
+
+      output.should include("sshfs")
+      output.should include("test_sshfs")
+      output.should include("false")
+
+      output.should include("httpdirfs")
+      output.should include("test_httpdirfs")
+      output.should include("false")
+    end
+
+    it "ensures the output format is correct" do
+      config = GX::Config.new
+      root_config = GX::Models::RootConfig.new
+      config.instance_variable_set("@root", root_config)
+
+      gocryptfs_config = GX::Models::GoCryptFSConfig.new(
+        GX::Parsers::Options::MappingCreateOptions.new(
+          type: "gocryptfs",
+          name: "test_gocryptfs",
+          encrypted_path: "/encrypted/path"
+        )
+      )
+      root_config.add_filesystem(gocryptfs_config)
+
+      command = GX::Commands::MappingList.new(config)
+
+      output = capture_output do
+        command.execute
+      end
+
+      output.should match(/TYPE\s+NAME\s+MOUNTED/)
+      output.should match(/gocryptfs\s+test_gocryptfs\s+false/)
+    end
   end
 end

src/cli.cr

@@ -30,13 +30,22 @@ module GX
         Parsers::RootParser.new.build(parser, breadcrumbs, @config)
       end
       pparser.parse(args)
+    rescue e : OptionParser::MissingOption
+      STDERR.puts "ERROR: #{e.message}".colorize(:red)
+      exit(1)
     end
 
     def run
       command = CommandFactory.create_command(@config, @config.mode)
       abort("ERROR: unknown command for mode #{@config.mode}") if command.nil?
 
-      command.try &.execute
+      command.execute
+    rescue e : ArgumentError
+      STDERR.puts "ERROR: #{e.message}".colorize(:red)
+      exit(1)
+    rescue e : Exception
+      STDERR.puts "ERROR: #{e.message}".colorize(:red)
+      exit(1)
     end
   end
 end

src/commands/config_init.cr

@@ -18,7 +18,7 @@ module GX::Commands
       # Override the configuration path if provided
       puts "Configuration file path: #{config_file_path}"
       puts "Configuration file path: #{@config.path}"
-      pp @config
+      # pp @config
       @config.path.try do |path|
         config_file_path = path
         config_dir = File.dirname(path)

src/commands/global_tui.cr

@@ -17,10 +17,9 @@ module GX::Commands
     end
 
     def execute
-      filesystem = @file_system_manager.choose_filesystem
       raise Models::InvalidFilesystemError.new("Invalid filesystem") if filesystem.nil?
       @file_system_manager.mount_or_umount(filesystem)
-      @file_system_manager.auto_open(filesystem) if filesystem.mounted? && @config.auto_open
+      @file_system_manager.auto_open(filesystem) if filesystem.mounted? && @config.auto_open?
     end
 
     def self.handles_mode

src/commands/global_version.cr

@@ -8,7 +8,7 @@ require "../config"
 
 module GX::Commands
   class GlobalVersion < AbstractCommand
-    def initialize(config : GX::Config) # FIXME
+    def initialize(config : GX::Config)
     end
 
     def execute

src/commands/mapping_create.cr

@@ -4,60 +4,55 @@
 # Copyright © 2024 Glenn Y. Rolland <glenux@glenux.net>
 
 require "./abstract_command"
+require "../models/filesystem_factory"
 
 module GX::Commands
   class MappingCreate < AbstractCommand
-    def initialize(@config : GX::Config) # FIXME
+    def initialize(@config : GX::Config)
       @config.load_from_env
       @config.load_from_file
+      @config.save_to_file
     end
 
     def execute
-      # FIXME: verify that filesystem is valid or return an error
-
-      # Assuming create_args is passed to this command with necessary details
-      create_args = @config.create_args
+      # Assuming mapping_create_options is passed to this command with necessary details
+      create_options = @config.mapping_create_options
 
       # Validate required arguments
-      if create_args[:name].empty? || create_args[:path].empty?
-        raise ArgumentError.new("Name and path are required to create a mapping.")
+      if create_options.nil?
+        raise ArgumentError.new("Mapping create options are required")
+      end
+      if create_options.name.nil? || create_options.name.try &.empty?
+        raise ArgumentError.new("Name is required to create a mapping.")
+      end
+      if create_options.type.nil? || create_options.type.try &.empty?
+        raise ArgumentError.new("Type is required to create a mapping.")
       end
 
       # Create the appropriate filesystem config based on the type
-      filesystem_config = case create_args[:type]
-      when "gocryptfs"
-        GX::Models::GocryptfsConfig.new(
-          name: create_args[:name],
-          path: create_args[:path],
-          encrypted_path: create_args[:encrypted_path]
-        )
-      when "sshfs"
-        GX::Models::SshfsConfig.new(
-          name: create_args[:name],
-          path: create_args[:path],
-          remote_user: create_args[:remote_user],
-          remote_host: create_args[:remote_host],
-          remote_path: create_args[:remote_path],
-          remote_port: create_args[:remote_port]
-        )
-      when "httpdirfs"
-        GX::Models::HttpdirfsConfig.new(
-          name: create_args[:name],
-          path: create_args[:path],
-          url: create_args[:url]
-        )
-      else
-        raise ArgumentError.new("Unsupported mapping type: #{create_args[:type]}")
-      end
+      filesystem_config = GX::Models::FilesystemFactory.build(create_options)
 
       # Append the new filesystem config to the root config
-      @config.root.try &.filesystems << filesystem_config
+      @config.root.try do |root|
+        root.filesystems ||= [] of GX::Models::AbstractFilesystemConfig
+        root.filesystems << filesystem_config
+        root.file_system_manager.mount_or_umount(filesystem_config)
+      end
 
-      puts "Mapping '#{create_args[:name]}' created and added to configuration successfully."
+      puts "Mapping '#{create_options.name}' created and added to configuration successfully."
     end
 
     def self.handles_mode
       GX::Types::Mode::MappingCreate
     end
+
+
+    # validate create_options.PARAMETER and display error with description if
+    # missing
+    macro option_check(create_options, parameter, description)
+      if create_options.{{ parameter.id }}.nil? || create_options.{{ parameter.id }}.try &.empty?
+        raise ArgumentError.new("Parameter for " + {{description}} + " is required")
+      end
+    end
   end
 end

src/commands/mapping_delete.cr

@@ -7,11 +7,11 @@ require "./abstract_command"
 
 module GX::Commands
   class MappingDelete < AbstractCommand
-    def initialize(config : GX::Config) # FIXME
+    def initialize(config : GX::Config)
     end
 
     def execute
-      # FIXME: implement
+      # TODO: implement
     end
 
     def self.handles_mode

src/commands/mapping_edit.cr

@@ -7,11 +7,11 @@ require "./abstract_command"
 
 module GX::Commands
   class MappingEdit < AbstractCommand
-    def initialize(config : GX::Config) # FIXME
+    def initialize(config : GX::Config)
     end
 
     def execute
-      # FIXME: implement
+      # TODO: implement
     end
 
     def self.handles_mode

src/commands/mapping_list.cr

@@ -12,7 +12,6 @@ module GX::Commands
     def initialize(@config : GX::Config)
       @config.load_from_env
       @config.load_from_file
-      @file_system_manager = FileSystemManager.new(@config)
     end
 
     def execute

src/commands/mapping_mount.cr

@@ -13,14 +13,13 @@ module GX::Commands
     def initialize(@config : GX::Config)
       @config.load_from_env
       @config.load_from_file
-      @file_system_manager = FileSystemManager.new(@config)
     end
 
     def execute
-      filesystem = @file_system_manager.choose_filesystem
+      filesystem = @config.root.try &.file_system_manager.choose_filesystem
       raise Models::InvalidFilesystemError.new("Invalid filesystem") if filesystem.nil?
       filesystem.mount
-      @file_system_manager.auto_open(filesystem) if filesystem.mounted? && @config.auto_open
+      @file_system_manager.auto_open(filesystem) if filesystem.mounted? && @config.auto_open?
     end
 
     def self.handles_mode

src/commands/mapping_umount.cr

@@ -13,11 +13,10 @@ module GX::Commands
     def initialize(@config : GX::Config)
       @config.load_from_env
       @config.load_from_file
-      @file_system_manager = FileSystemManager.new(@config)
     end
 
     def execute
-      filesystem = @file_system_manager.choose_filesystem
+      filesystem = @config.root.try &.file_system_manager.choose_filesystem
       raise Models::InvalidFilesystemError.new("Invalid filesystem") if filesystem.nil?
       filesystem.umount
     end

src/config.cr

@@ -27,20 +27,20 @@ module GX
     record AddArgs, name : String, path : String
     record DelArgs, name : String
 
-    # getter filesystems : Array(Models::AbstractFilesystemConfig)
     getter home_dir : String
     getter root : Models::RootConfig?
 
-    property verbose : Bool
+    property? verbose : Bool
     property mode : Types::Mode
     property path : String?
     property args : AddArgs.class | DelArgs.class | NoArgs.class
-    property auto_open : Bool
+    property? auto_open : Bool
 
-    # FIXME: refactor and remove these parts from here
-    property help_options : Parsers::Options::HelpOptions?
+    # TODO: refactor and remove these parts from here
     property config_init_options : Parsers::Options::ConfigInitOptions?
     property config_options : Parsers::Options::ConfigOptions?
+    property help_options : Parsers::Options::HelpOptions?
+    property mapping_create_options : Parsers::Options::MappingCreateOptions?
     property mapping_create_options : Parsers::Options::MappingCreateOptions?
 
     def initialize
@@ -102,7 +102,12 @@ module GX
       file_data = File.read(config_path)
       file_patched = Crinja.render(file_data, {"env" => ENV.to_h})
 
+      begin
         root = Models::RootConfig.from_yaml(file_patched)
+      rescue ex : YAML::ParseException
+        STDERR.puts "Error parsing configuration file: #{ex.message}".colorize(:red)
+        exit(1)
+      end
 
       mount_point_base_safe = root.global.mount_point_base
       raise Models::InvalidMountpointError.new("Invalid global mount point") if mount_point_base_safe.nil?
@@ -115,5 +120,15 @@ module GX
       end
       @root = root
     end
+
+    def save_to_file
+      return if @path.nil?
+      if @path
+        File.write(@path.to_s, @root.to_yaml)
+      else
+        Log.error { "Configuration path is nil, cannot save configuration." }
+      end
+      Log.info { "Configuration saved to #{@path}" }
+    end
   end
 end

src/file_storage.cr

@@ -10,4 +10,3 @@ class FileStorage
 
   bake_folder "../static"
 end
-

src/file_system_manager.cr

@@ -42,10 +42,10 @@ module GX
     end
 
     def auto_open(filesystem)
-      # FIXME: detect xdg-open and use it if possible
-      # FIXME: detect mailcap and use it if no xdg-open found
-      # FIXME: support user-defined command in configuration
-      # FIXME: detect graphical environment
+      # TODO: detect xdg-open and use it if possible
+      # TODO: detect mailcap and use it if no xdg-open found
+      # TODO: support user-defined command in configuration
+      # TODO: detect graphical environment
 
       mount_point_safe = filesystem.mount_point
       raise Models::InvalidMountpointError.new("Invalid filesystem") if mount_point_safe.nil?
@@ -111,7 +111,7 @@ module GX
         }
       end
 
-      # # FIXME: feat: allow to sort by name or by filesystem
+      # FIXME: feat: allow to sort by name or by filesystem
       sorted_values = names_display.values.sort_by!(&.[:filesystem].name)
       result_filesystem_name = Utils::Fzf.run(sorted_values.map(&.[:ansi_name])).strip
       selected_filesystem = names_display[result_filesystem_name][:filesystem]

src/models/abstract_filesystem_config.cr

@@ -15,6 +15,15 @@ module GX::Models
   abstract class AbstractFilesystemConfig
     include YAML::Serializable
     # include YAML::Serializable::Strict
+    @@subs = [] of AbstractFilesystemConfig.class
+
+    macro inherited
+      @@subs << {{@type.name.id}}
+    end
+
+    def self.subs
+      @@subs
+    end
 
     use_yaml_discriminator "type", {
       gocryptfs: GoCryptFSConfig,

src/models/filesystem_factory.cr

@@ -0,0 +1,21 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# SPDX-FileCopyrightText: 2024 Glenn Y. Rolland <glenux@glenux.net>
+# Copyright © 2024 Glenn Y. Rolland <glenux@glenux.net>
+
+module GX::Models
+  class FilesystemFactory
+    def self.build(create_options)
+      case create_options.type
+      when "gocryptfs"
+        GoCryptFSConfig.new(create_options)
+      when "sshfs"
+        SshFSConfig.new(create_options)
+      when "httpdirfs"
+        HttpDirFSConfig.new(create_options)
+      else
+        raise ArgumentError.new("Unsupported mapping type: #{create_options.type}")
+      end
+    end
+  end
+end

src/models/gocryptfs_config.cr

@@ -13,6 +13,11 @@ module GX::Models
 
     include Concerns::Base
 
+    def initialize(create_options)
+      @name = create_options.name.as(String)
+      @encrypted_path = create_options.encrypted_path.as(String)
+    end
+
     def _mounted_prefix
       "#{encrypted_path}"
     end
@@ -34,5 +39,6 @@ module GX::Models
       )
       process.wait
     end
+    def self.name ; "gocryptfs" ; end
   end
 end

src/models/httpdirfs_config.cr

@@ -13,6 +13,11 @@ module GX::Models
 
     include Concerns::Base
 
+    def initialize(create_options)
+      @name = create_options.name.as(String)
+      @url = create_options.url.as(String)
+    end
+
     def _mounted_prefix
       "httpdirfs"
     end
@@ -34,5 +39,6 @@ module GX::Models
       )
       process.wait
     end
+    def self.name ; "httpdirfs" ; end
   end
 end

src/models/root_config.cr

@@ -36,5 +36,12 @@ module GX::Models
 
     @[YAML::Field(key: "filesystems")]
     getter filesystems : Array(AbstractFilesystemConfig)
+    setter filesystems
+
+    def initialize(version = "1.0.0", global = GlobalConfig.new, filesystems = [] of AbstractFilesystemConfig)
+      @version = version
+      @global = global
+      @filesystems = filesystems
+    end
   end
 end

src/models/sshfs_config.cr

@@ -16,6 +16,14 @@ module GX::Models
 
     include Concerns::Base
 
+    def initialize(create_options)
+      @name = create_options.name.as(String)
+      @remote_user = create_options.remote_user.as(String)
+      @remote_host = create_options.remote_host.as(String)
+      @remote_path = create_options.remote_path.as(String)
+      @remote_port = create_options.remote_port.as(String)
+    end
+
     def _mounted_prefix
       "#{@remote_user}@#{@remote_host}:#{@remote_path}"
     end
@@ -41,5 +49,6 @@ module GX::Models
       )
       process.wait
     end
+    def self.name ; "sshfs" ; end
   end
 end

src/parsers/mapping_parser.cr

@@ -10,7 +10,6 @@ module GX::Parsers
   class MappingParser < AbstractParser
     def build(parser, ancestors, config)
       breadcrumbs = ancestors + "mapping"
-      create_args = {name: "", path: ""}
       delete_args = {name: ""}
       mount_args = {name: ""}
       umount_args = {name: ""}
@@ -29,35 +28,53 @@ module GX::Parsers
 
       parser.on("create", "Create mapping") do
         config.mode = Types::Mode::MappingCreate
-        # pp parser
+        config.mode = Types::Mode::MappingCreate
+        config.mapping_create_options = Parsers::Options::MappingCreateOptions.new
+
         parser.banner = Utils.usage_line(breadcrumbs + "create", "Create mapping", true)
         parser.separator("\nCreate options")
 
         parser.on("-t", "--type TYPE", "Set filesystem type") do |type|
-          create_args = create_args.merge({type: type})
+          config.mapping_create_options.try do |opts|
+            opts.type = type
+          end
+        end
+        parser.on("-n", "--name NAME", "Set mapping name") do |name|
+          config.mapping_create_options.try do |opts|
+            opts.name = name
           end
-        parser.on("-n", "--name", "Set mapping name") do |name|
-          create_args = create_args.merge({name: name})
         end
 
         # Filesystem specific
         parser.on("--encrypted-path PATH", "Set encrypted path (for gocryptfs)") do |path|
-          create_args = create_args.merge({encrypted_path: path})
+          config.mapping_create_options.try do |opts|
+            opts.encrypted_path = path
+          end
         end
         parser.on("--remote-user USER", "Set SSH user (for sshfs)") do |user|
-          create_args = create_args.merge({remote_user: user})
+          config.mapping_create_options.try do |opts|
+            opts.remote_user = user
+          end
         end
         parser.on("--remote-host HOST", "Set SSH host (for sshfs)") do |host|
-          create_args = create_args.merge({remote_host: host})
+          config.mapping_create_options.try do |opts|
+            opts.remote_host = host
+          end
         end
         parser.on("--source-path PATH", "Set remote path (for sshfs)") do |path|
-          create_args = create_args.merge({remote_path: path})
+          config.mapping_create_options.try do |opts|
+            opts.remote_path = path
+          end
         end
         parser.on("--remote-port PORT", "Set SSH port (for sshfs)") do |port|
-          create_args = create_args.merge({remote_port: port})
+          config.mapping_create_options.try do |opts|
+            opts.remote_port = port
+          end
         end
         parser.on("--url URL", "Set URL (for httpdirfs)") do |url|
-          create_args = create_args.merge({url: url})
+          config.mapping_create_options.try do |opts|
+            opts.url = url
+          end
         end
 
         parser.separator(Utils.help_line(breadcrumbs + "create"))
@@ -67,13 +84,19 @@ module GX::Parsers
         config.mode = Types::Mode::MappingEdit
 
         parser.on("--remote-user USER", "Set SSH user") do |user|
-          create_args = create_args.merge({remote_user: user})
+          config.mapping_create_options.try do |opts|
+            opts.remote_user = user
+          end
         end
         parser.on("--remote-host HOST", "Set SSH host") do |host|
-          create_args = create_args.merge({remote_host: host})
+          config.mapping_create_options.try do |opts|
+            opts.remote_host = host
+          end
         end
         parser.on("--source-path PATH", "Set remote path") do |path|
-          create_args = create_args.merge({remote_path: path})
+          config.mapping_create_options.try do |opts|
+            opts.remote_path = path
+          end
         end
 
         parser.separator(Utils.help_line(breadcrumbs + "edit"))

src/parsers/options/mapping_create_options.cr

@@ -0,0 +1,19 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# SPDX-FileCopyrightText: 2024 Glenn Y. Rolland <glenux@glenux.net>
+# Copyright © 2024 Glenn Y. Rolland <glenux@glenux.net>
+
+require "option_parser"
+
+module GX::Parsers::Options
+  class MappingCreateOptions
+    property type : String?
+    property name : String?
+    property encrypted_path : String?
+    property remote_user : String?
+    property remote_host : String?
+    property remote_path : String?
+    property remote_port : String?
+    property url : String?
+  end
+end

src/parsers/options/mapping_delete_options.cr

@@ -0,0 +1,12 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# SPDX-FileCopyrightText: 2024 Glenn Y. Rolland <glenux@glenux.net>
+# Copyright © 2024 Glenn Y. Rolland <glenux@glenux.net>
+
+require "option_parser"
+
+module GX::Parsers::Options
+  class MappingDeleteOptions
+    # Add your options here
+  end
+end

src/parsers/options/mapping_mount_options.cr

@@ -0,0 +1,12 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# SPDX-FileCopyrightText: 2024 Glenn Y. Rolland <glenux@glenux.net>
+# Copyright © 2024 Glenn Y. Rolland <glenux@glenux.net>
+
+require "option_parser"
+
+module GX::Parsers::Options
+  class MappingMountOptions
+    # Add your options here
+  end
+end

src/parsers/options/mapping_umount_options.cr

@@ -0,0 +1,12 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# SPDX-FileCopyrightText: 2024 Glenn Y. Rolland <glenux@glenux.net>
+# Copyright © 2024 Glenn Y. Rolland <glenux@glenux.net>
+
+require "option_parser"
+
+module GX::Parsers::Options
+  class MappingUmountOptions
+    # Add your options here
+  end
+end