Merge pull request 'feat: add support for sshfs option (-o) in config' (#51) from feature/50-add-support-for-sshfs-options into develop

Reviewed-on: #51

.code_preloader.yml

@@ -8,20 +8,15 @@
 
 # List of patterns to ignore during preloading
 ignore_list:
-  - ^bin/
-  - ^\.code_preloader.yml
-  - ^doc/
-  - ^\.drone.yml
   - ^\.git/
-  - ^\.gitattributes
-  - ^\.gitignore
   - ^lib.*
-  - ^LICENSES/
+  - ^doc/
+  - ^bin/
   - ^_prompts/
   - ^\.reuse/
-  - ^scripts/
+  - ^LICENSES/
-  - ^\.tool-versions
   - ^\.vagrant/
+  - ^scripts/
 
 # Path to the output file (if null, output to STDOUT)
 output_path: null

Makefile

@@ -24,7 +24,7 @@ test:
 install:
 	install \
 		-m 755 \
-		bin/mfm \
+		bin/code-preloader \
 		$(PREFIX)/bin
 
 .PHONY: spec test build all prepare install

README.md

@@ -14,8 +14,6 @@
 > version of our project, please visit our primary repository at:
 > <https://code.apps.glenux.net/glenux/mfm>.
 
-<!-- hello -->
-
 # Minimalist Fuse Manager (MFM)
 
 MFM is a Crystal-lang CLI designed to streamline the management of various FUSE filesystems, such as sshfs, gocryptfs, httpdirfs, and more. Through its user-friendly interface, users can effortlessly mount and unmount filesystems, get real-time filesystem status, and handle errors proficiently.
@@ -46,23 +44,18 @@ To build from source, you'll also need:
 For Debian/Ubuntu you can use the following command:
 
 ```shell-session
-$ sudo apt-get update && sudo apt-get install libpcre3-dev libevent-2.1-dev make
+$ sudo apt-get update && sudo apt-get install libpcre3-dev libevent-2.1-dev
 ```
 
 ## Installation
 
 ### 1. From Source
 
-To get started with MFM, ensure that you have the prerequisites installed on your system (see above).
+1. Clone or download the source code.
-
+2. Navigate to the source directory.
-Then follow these steps to install:
+3. Run `shards install` to fetch dependencies.
-
+4. Compile using `shards build`.
-    git clone https://code.apps.glenux.net/glenux/mfm
+5. The compiled binary will be in the `bin` directory.
-    cd mfm
-    make prepare
-    make build
-    sudo make install                 # either to install system-wide
-    make install PREFIX=$HOME/.local  # or to install as a user
 
 ### 2. Binary Download
 

shard.lock

@@ -4,10 +4,6 @@ shards:
     git: https://github.com/crystal-ameba/ameba.git
     version: 1.6.1
 
-  baked_file_system:
-    git: https://github.com/schovi/baked_file_system.git
-    version: 0.10.0
-
   crinja:
     git: https://github.com/straight-shoota/crinja.git
     version: 0.8.1

shard.yml

@@ -26,9 +26,6 @@ dependencies:
     github: hugopl/version_from_shard
   tablo:
     github: hutou/tablo
-  baked_file_system:
-    github: schovi/baked_file_system
-    version: 0.10.0
 
 development_dependencies:
   ameba:

src/commands/completion_autodetect.cr

@@ -1,17 +0,0 @@
-require "./abstract_command"
-
-module GX::Commands
-  class CompletionAutodetect < AbstractCommand
-    def initialize(@config : GX::Config)
-    end
-
-    def execute
-      STDERR.puts "FIXME: Completion auto-detection isn't implemented yet. Please select one of the following: --bash or --zsh"
-      exit(0)
-    end
-
-    def self.handles_mode
-      GX::Types::Mode::CompletionAutodetect
-    end
-  end
-end

src/commands/completion_bash.cr

@@ -1,17 +0,0 @@
-require "./abstract_command"
-
-module GX::Commands
-  class CompletionBash < AbstractCommand
-    def initialize(@config : GX::Config)
-    end
-
-    def execute
-      completion_bash = FileStorage.get("completion.bash")
-      STDOUT.puts completion_bash.gets_to_end
-    end
-
-    def self.handles_mode
-      GX::Types::Mode::CompletionBash
-    end
-  end
-end

src/commands/completion_zsh.cr

@@ -1,17 +0,0 @@
-require "./abstract_command"
-
-module GX::Commands
-  class CompletionZsh < AbstractCommand
-    def initialize(@config : GX::Config)
-    end
-
-    def execute
-      completion_bash = FileStorage.get("completion.zsh")
-      STDOUT.puts completion_bash.gets_to_end
-    end
-
-    def self.handles_mode
-      GX::Types::Mode::CompletionZsh
-    end
-  end
-end

src/commands/config_init.cr

@@ -1,36 +1,11 @@
 require "./abstract_command"
-require "../file_storage"
 
 module GX::Commands
   class ConfigInit < AbstractCommand
-    def initialize(@config : GX::Config)
+    def initialize(config : GX::Config) # FIXME
     end
 
     def execute
-      config_dir = File.join(@config.home_dir, ".config", "mfm")
-      config_file_path = File.join(config_dir, "config.yml")
-
-      # Guard condition to exit if the configuration file already exists
-      if File.exists?(config_file_path)
-        puts "Configuration file already exists at #{config_file_path}. No action taken."
-        return
-      end
-
-      puts "Creating initial configuration file at #{config_file_path}"
-
-      # Ensure the configuration directory exists
-      FileUtils.mkdir_p(config_dir)
-
-      # Read the default configuration content from the baked file storage
-      default_config_content = FileStorage.get("sample.mfm.yaml")
-
-      # Write the default configuration to the target path
-      File.write(config_file_path, default_config_content)
-
-      puts "Configuration file created successfully."
-    rescue ex
-      STDERR.puts "Error creating the configuration file: #{ex.message}"
-      exit(1)
     end
 
     def self.handles_mode

src/commands/global_completion.cr

@@ -0,0 +1,15 @@
+require "./abstract_command"
+
+module GX::Commands
+  class GlobalCompletion < AbstractCommand
+    def initialize(@config : GX::Config)
+    end
+
+    def execute
+    end
+
+    def self.handles_mode
+      GX::Types::Mode::GlobalConfig
+    end
+  end
+end

src/commands/global_config.cr

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

src/commands/global_help.cr

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

src/commands/mapping_mount.cr

@@ -5,7 +5,7 @@ module GX::Commands
   class MappingMount < AbstractCommand
     @file_system_manager : FileSystemManager
 
-    def initialize(@config : GX::Config)
+    def initialize(@config : GX::Config) # FIXME
       @config.load_from_env
       @config.load_from_file
       @file_system_manager = FileSystemManager.new(@config)

src/commands/mapping_umount.cr

@@ -5,7 +5,7 @@ module GX::Commands
   class MappingUmount < AbstractCommand
     @file_system_manager : FileSystemManager
 
-    def initialize(@config : GX::Config)
+    def initialize(@config : GX::Config) # FIXME
       @config.load_from_env
       @config.load_from_file
       @file_system_manager = FileSystemManager.new(@config)

src/file_storage.cr

@@ -1,8 +0,0 @@
-require "baked_file_system"
-
-class FileStorage
-  extend BakedFileSystem
-
-  bake_folder "../static"
-end
-

src/file_system_manager.cr

@@ -89,9 +89,7 @@ module GX
     end
 
     def choose_filesystem
-      names_display = {} of String => NamedTuple(
+      names_display = {} of String => NamedTuple(filesystem: Models::AbstractFilesystemConfig, ansi_name: String)
-        filesystem: Models::AbstractFilesystemConfig,
-        ansi_name: String)
 
       config_root = @config.root
       return if config_root.nil?
@@ -116,16 +114,16 @@ module GX
       end
 
       # # FIXME: feat: allow to sort by name or by filesystem
-      sorted_values = names_display.values.sort_by!(&.[:filesystem].name)
+      sorted_values = names_display.values.sort_by { |item| item[:filesystem].name }
       result_filesystem_name = Utils::Fzf.run(sorted_values.map(&.[:ansi_name])).strip
       selected_filesystem = names_display[result_filesystem_name][:filesystem]
       puts ">> #{selected_filesystem.name}".colorize(:yellow)
 
       if !selected_filesystem
-        STDERR.puts "Mapping not found: #{selected_filesystem}.".colorize(:red)
+        STDERR.puts "Vault not found: #{selected_filesystem}.".colorize(:red)
         return
       end
-      selected_filesystem
+      return selected_filesystem
     end
 
     private def generate_display_name(filesystem : Models::AbstractFilesystemConfig) : String
@@ -138,7 +136,7 @@ module GX
       if ENV["DISPLAY"]? || ENV["WAYLAND_DISPLAY"]?
         return true
       end
-      false
+      return false
     end
   end
 end

src/main.cr

@@ -22,7 +22,7 @@ struct BaseFormat < Log::StaticFormatter
 end
 
 Log.setup do |config|
-  backend = Log::IOBackend.new(io: STDERR, formatter: BaseFormat)
+  backend = Log::IOBackend.new(formatter: BaseFormat)
   config.bind "*", Log::Severity::Info, backend
 
   if ENV["LOG_LEVEL"]?
@@ -31,6 +31,6 @@ Log.setup do |config|
   end
 end
 
-app = GX::Cli.new
+cli = GX::Cli.new
-app.parse_command_line(ARGV)
+cli.parse_command_line(ARGV)
-app.run
+cli.run

src/models/concerns/base.cr

@@ -31,7 +31,7 @@ module GX::Models::Concerns
       end
     end
 
-    def _mount_wrapper(&) : Nil
+    def _mount_wrapper(&block) : Nil
       mount_point_safe = mount_point
       return if mount_point_safe.nil?
 
@@ -46,7 +46,7 @@ module GX::Models::Concerns
       if result_status.success?
         puts "Models #{name} is now available on #{mount_point_safe}".colorize(:green)
       else
-        puts "Error mounting the mapping".colorize(:red)
+        puts "Error mounting the vault".colorize(:red)
         return
       end
     end

src/models/gocryptfs_config.cr

@@ -32,7 +32,7 @@ module GX::Models
         output: STDOUT,
         error: STDERR
       )
-      process.wait
+      return process.wait
     end
   end
 end

src/models/httpdirfs_config.cr

@@ -32,7 +32,7 @@ module GX::Models
         output: STDOUT,
         error: STDERR
       )
-      process.wait
+      return process.wait
     end
   end
 end

src/models/sshfs_config.cr

@@ -13,6 +13,7 @@ module GX::Models
     getter remote_user : String = ""
     getter remote_host : String = ""
     getter remote_port : String = "22"
+    getter options : Array(String) = [] of String
 
     include Concerns::Base
 
@@ -28,18 +29,25 @@ module GX::Models
       mount_point_safe = @mount_point
       raise InvalidMountpointError.new("Invalid mount point") if mount_point_safe.nil?
 
+      options = [] of String
+      # merge sshfs options
+      @options.each do |option|
+        options.push("-o", option)
+      end
+      options.push("-p", remote_port)
+      options.push(
+        "#{@remote_user}@#{@remote_host}:#{@remote_path}",
+          mount_point_safe
+      )
       process = Process.new(
         "sshfs",
-        [
+        options,
-          "-p", remote_port,
-          "#{@remote_user}@#{@remote_host}:#{@remote_path}",
-          mount_point_safe,
-        ],
         input: STDIN,
         output: STDOUT,
         error: STDERR
       )
-      process.wait
+      return process.wait
     end
   end
 end
+

src/parsers/completion_parser.cr

@@ -4,7 +4,6 @@ module GX::Parsers
   class CompletionParser < AbstractParser
     def build(parser, ancestors, config)
       breadcrumbs = ancestors + "completion"
-      # config.mode = Types::Mode::CompletionAutodetect
 
       parser.banner = Utils.usage_line(
         breadcrumbs,
@@ -13,13 +12,11 @@ module GX::Parsers
       )
       parser.separator("\nCompletion commands:")
 
-      parser.on("--bash", "Generate bash completion") do |_|
+      parser.on("--bash", "Generate bash completion") do |flag|
-        config.mode = Types::Mode::CompletionBash
         Log.info { "Set bash completion" }
       end
 
-      parser.on("--zsh", "Generate zsh completion") do |_|
+      parser.on("--zsh", "Generate zsh completion") do |flag|
-        config.mode = Types::Mode::CompletionZsh
         Log.info { "Set zsh completion" }
       end
 

src/parsers/config_parser.cr

@@ -23,7 +23,7 @@ module GX::Parsers
         parser.banner = Utils.usage_line(breadcrumbs + "init", "Create initial mfm configuration")
         parser.separator("\nInit options")
 
-        parser.on("-p", "--path", "Set mapping encrypted path") do |path|
+        parser.on("-p", "--path", "Set vault encrypted path") do |path|
           config.config_init_options.try do |opts|
             opts.path = path
           end

src/parsers/mapping_parser.cr

@@ -5,10 +5,8 @@ module GX::Parsers
   class MappingParser < AbstractParser
     def build(parser, ancestors, config)
       breadcrumbs = ancestors + "mapping"
-      create_args = {name: "", path: ""}
+      add_args = {name: "", path: ""}
       delete_args = {name: ""}
-      mount_args = {name: ""}
-      umount_args = {name: ""}
 
       parser.banner = Utils.usage_line(
         breadcrumbs,
@@ -20,94 +18,50 @@ module GX::Parsers
       parser.on("list", "List mappings") do
         config.mode = Types::Mode::MappingList
         parser.separator(Utils.help_line(breadcrumbs + "list"))
+        # abort("FIXME: Not implemented")
       end
 
       parser.on("create", "Create mapping") do
         config.mode = Types::Mode::MappingCreate
-        # pp parser
+
+        pp parser
         parser.banner = Utils.usage_line(breadcrumbs + "create", "Create mapping", true)
         parser.separator("\nCreate options")
 
-        parser.on("-t", "--type TYPE", "Set filesystem type") do |type|
+        parser.on("-n", "--name", "Set vault name") do |name|
-          create_args = create_args.merge({type: type})
+          add_args = add_args.merge({name: name})
         end
-        parser.on("-n", "--name", "Set mapping name") do |name|
+        parser.on("-p", "--path", "Set vault encrypted path") do |path|
-          create_args = create_args.merge({name: name})
+          add_args = add_args.merge({path: path})
         end
-
-        # Filesystem specific
-        parser.on("--encrypted-path PATH", "Set encrypted path (for gocryptfs)") do |path|
-          encrypted_path = path
-        end
-        parser.on("--remote-user USER", "Set SSH user (for sshfs)") do |user|
-          create_args = create_args.merge({remote_user: user})
-        end
-        parser.on("--remote-host HOST", "Set SSH host (for sshfs)") do |host|
-          create_args = create_args.merge({remote_host: host})
-        end
-        parser.on("--source-path PATH", "Set remote path (for sshfs)") do |path|
-          create_args = create_args.merge({remote_path: path})
-        end
-        parser.on("--remote-port PORT", "Set SSH port (for sshfs)") do |port|
-          create_args = create_args.merge({remote_port: port})
-        end
-        parser.on("--url URL", "Set URL (for httpdirfs)") do |url|
-          create_args = create_args.merge({url: url})
-        end
-
         parser.separator(Utils.help_line(breadcrumbs + "create"))
       end
 
-      parser.on("edit", "Edit configuration") do |_|
+      parser.on("edit", "Edit configuration") do |flag|
         config.mode = Types::Mode::MappingEdit
-
-        parser.on("--remote-user USER", "Set SSH user") do |user|
-          create_args = create_args.merge({remote_user: user})
-        end
-        parser.on("--remote-host HOST", "Set SSH host") do |host|
-          create_args = create_args.merge({remote_host: host})
-        end
-        parser.on("--source-path PATH", "Set remote path") do |path|
-          create_args = create_args.merge({remote_path: path})
-        end
-
         parser.separator(Utils.help_line(breadcrumbs + "edit"))
         # abort("FIXME: Not implemented")
       end
 
-      parser.on("mount", "Mount mapping") do |_|
+      parser.on("mount", "Mount mapping") do |flag|
         config.mode = Types::Mode::MappingMount
-
-        parser.banner = Utils.usage_line(breadcrumbs + "mount", "mount mapping", true)
-        parser.separator("\nMount options")
-
-        parser.on("-n", "--name", "Set mapping name") do |name|
-          mount_args = mount_args.merge({name: name})
-        end
-
         parser.separator(Utils.help_line(breadcrumbs + "mount"))
+        # abort("FIXME: Not implemented")
       end
 
-      parser.on("umount", "Umount mapping") do |_|
+      parser.on("umount", "Umount mapping") do |flag|
         config.mode = Types::Mode::MappingUmount
-
-        parser.banner = Utils.usage_line(breadcrumbs + "umount", "umount mapping", true)
-        parser.separator("\nUmount options")
-
-        parser.on("-n", "--name", "Set mapping name") do |name|
-          umount_args = umount_args.merge({name: name})
-        end
-
         parser.separator(Utils.help_line(breadcrumbs + "umount"))
+        # abort("FIXME: Not implemented")
       end
 
       parser.on("delete", "Delete mapping") do
         config.mode = Types::Mode::MappingDelete
 
-        parser.banner = Utils.usage_line(breadcrumbs + "delete", "delete mapping", true)
+        parser.banner = Utils.usage_line(breadcrumbs + "delete", "Delete mapping", true)
-        parser.separator("\ndelete options")
+        parser.separator("\nDelete options")
 
-        parser.on("-n", "--name", "Set mapping name") do |name|
+        parser.on("-n", "--name", "Set vault name") do |name|
           delete_args = delete_args.merge({name: name})
         end
         parser.separator(Utils.help_line(breadcrumbs + "delete"))

src/parsers/root_parser.cr

@@ -21,24 +21,24 @@ module GX::Parsers
         config.path = path
       end
 
-      parser.on("-v", "--verbose", "Set more verbosity") do |_|
+      parser.on("-v", "--verbose", "Set more verbosity") do |flag|
         Log.info { "Verbosity enabled" }
         config.verbose = true
       end
 
-      parser.on("-o", "--open", "Automatically open directory after mount") do |_|
+      parser.on("-o", "--open", "Automatically open directory after mount") do |flag|
         Log.info { "Auto-open enabled" }
         config.auto_open = true
       end
 
-      parser.on("--version", "Show version") do |_|
+      parser.on("--version", "Show version") do |flag|
         config.mode = Types::Mode::GlobalVersion
       end
 
-      parser.on("-h", "--help", "Show this help") do |_|
+      parser.on("-h", "--help", "Show this help") do |flag|
         config.mode = Types::Mode::GlobalHelp
         config.help_options = Parsers::Options::HelpOptions.new
-        config.help_options.try(&.parser_snapshot=(parser.dup))
+        config.help_options.try { |opts| opts.parser_snapshot = parser.dup }
       end
 
       parser.separator("\nGlobal commands:")
@@ -46,7 +46,7 @@ module GX::Parsers
       parser.on("config", "Manage configuration file") do
         config.mode = Types::Mode::GlobalHelp
         config.help_options = Parsers::Options::HelpOptions.new
-        config.help_options.try(&.parser_snapshot=(parser.dup))
+        config.help_options.try { |opts| opts.parser_snapshot = parser.dup }
 
         # config.command = Commands::Config.new(config)
         Parsers::ConfigParser.new.build(parser, breadcrumbs, config)
@@ -59,7 +59,7 @@ module GX::Parsers
       parser.on("mapping", "Manage mappings") do
         config.mode = Types::Mode::GlobalHelp
         config.help_options = Parsers::Options::HelpOptions.new
-        config.help_options.try(&.parser_snapshot=(parser.dup))
+        config.help_options.try { |opts| opts.parser_snapshot = parser.dup }
 
         Parsers::MappingParser.new.build(parser, breadcrumbs, config)
       end
@@ -69,10 +69,7 @@ module GX::Parsers
       # end
 
       parser.on("completion", "Manage completion") do
-        config.mode = Types::Mode::GlobalHelp
+        config.mode = Types::Mode::GlobalCompletion
-        config.help_options = Parsers::Options::HelpOptions.new
-        config.help_options.try(&.parser_snapshot=(parser.dup))
-
         Parsers::CompletionParser.new.build(parser, breadcrumbs, config)
       end
 

src/types/modes.cr

@@ -4,15 +4,11 @@ module GX::Types
 
     GlobalVersion
     GlobalHelp
-    # GlobalCompletion
+    GlobalCompletion
     GlobalTui
     GlobalConfig
     GlobalMapping
 
-    CompletionBash
-    CompletionZsh
-    CompletionAutodetect
-
     ConfigInit
 
     MappingCreate

src/utils/breadcrumbs.cr

@@ -4,12 +4,12 @@ module GX::Utils
       @ancestors = base
     end
 
-    def +(other : String)
+    def +(elem : String)
-      BreadCrumbs.new(@ancestors + [other])
+      b = BreadCrumbs.new(@ancestors + [elem])
     end
 
-    def to_s(io : IO)
+    def to_s
-      io << @ancestors.join(" ")
+      @ancestors.join(" ")
     end
 
     def to_a

src/utils/parser_lines.cr

@@ -3,7 +3,7 @@ require "./breadcrumbs"
 module GX::Utils
   def self.usage_line(breadcrumbs : BreadCrumbs, description : String, has_commands : Bool = false)
     [
-      "Usage: #{breadcrumbs}#{has_commands ? " [commands]" : ""} [options]",
+      "Usage: #{breadcrumbs.to_s}#{has_commands ? " [commands]" : ""} [options]",
       "",
       description,
       "",
@@ -12,6 +12,6 @@ module GX::Utils
   end
 
   def self.help_line(breadcrumbs : BreadCrumbs)
-    "\nRun '#{breadcrumbs} COMMAND --help' for more information on a command."
+    "\nRun '#{breadcrumbs.to_s} COMMAND --help' for more information on a command."
   end
 end

static/completion.zsh

@@ -1,5 +0,0 @@
-#!/bin/zsh
-
-# mfm Zsh completion script
-
-

static/sample.mfm.yaml

@@ -1,32 +0,0 @@
----
-version: 1
-
-global:
-  mount_point_base: "{{env.HOME}}/mnt"
-
-filesystems:
-  ##
-  ## Sample configuration for encrypted vault (gocryptfs)
-  ##
-  # - type: gocryptfs
-  #   name: "Credential Vault"
-  #   encrypted_path: "{{env.HOME}}/Documents/Credential.Vault"
-  #
-  ##
-  ## Sample configuration remote SSH directory (sshfs)
-  ##
-  # - type: sshfs
-  #   name: "Remote SSH server"
-  #   remote_host: ssh.example.com
-  #   remote_user: "{{env.USER}}"
-  #   remote_path: "/home/{{env.USER}}"
-  #   remote_port: 443
-  #
-  ##
-  ## Sample configuration for remote HTTP directory (httpdirfs)
-  ##
-  - type: httpdirfs
-    name: "Debian Repository"
-    url: "http://ftp.debian.org/debian/"
-    # mount_point: "{{env.HOME}}/another.dir"
-#