smp_tool-cli 0.1.0

data/lib/smp_tool/cli/executor/base.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      #
+      # Base class all executors inherit from.
+      #
+      class Base
+        def initialize(logger:, **)
+          @logger = logger
+        end
+
+        def call; end
+
+        private
+
+        #
+        # Save volume to a binary file.
+        #
+        # @param [String] path
+        #   Path to the destination file.
+        #
+        # @param [SMPTool::VirtualVolume::Volume] volume
+        #
+        # @param [Hash{ Symbol => Object }] **_options
+        #
+        def _save_volume(path:, volume:, **_options)
+          b_str = _volume_to_binary(volume)
+          @logger.debug "Converted to binary string."
+
+          _write_bin_file(
+            path,
+            b_str
+          )
+
+          @logger.info "Changes saved to the file: '#{path}'"
+        end
+
+        #
+        # Convert virtual volume to binary string.
+        #
+        # @param [SMPTool::VirtualVolume::Volume] volume
+        #
+        # @return [String]
+        #
+        def _volume_to_binary(volume)
+          volume.to_binary_s
+        end
+
+        #
+        # Write data to a binary file.
+        #
+        # @param [String] path
+        #
+        # @param [String] data
+        #   Binary string with the file's content.
+        #
+        def _write_bin_file(path, data)
+          Dry::Files.new.write(path, data)
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/bin_write_mixin.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      module BinWriteMixin
+        private
+
+        #
+        # Save volume to a binary file.
+        #
+        # @param [String] path
+        #   Path to the destination file.
+        #
+        # @param [SMPTool::VirtualVolume::Volume] volume
+        #
+        # @param [Hash{ Symbol => Object }] **_options
+        #
+        def _save_volume(path:, volume:, **_options)
+          b_str = _volume_to_binary(volume)
+          @logger.debug "Converted to binary string"
+
+          _write_bin_file(
+            path,
+            b_str
+          )
+
+          @logger.es_info "Changes saved to the file: '#{path}'"
+        end
+
+        #
+        # Convert virtual volume to binary string.
+        #
+        # @param [SMPTool::VirtualVolume::Volume] volume
+        #
+        # @return [String]
+        #
+        def _volume_to_binary(volume)
+          volume.to_binary_s
+        end
+
+        #
+        # Write data to a binary file.
+        #
+        # @param [String] path
+        #
+        # @param [String] data
+        #   Binary string with the file's content.
+        #
+        def _write_bin_file(path, data)
+          Dry::Files.new.write(path, data)
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/creator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class Creator
+        include BinWriteMixin
+
+        def initialize(output:, volume_specs:, logger:, **options)
+          @logger = logger
+          @output = output
+          @volume_specs = volume_specs
+          @options = options
+        end
+
+        def call
+          vol = SMPTool::VirtualVolume::Volume.new(
+            bootloader: @volume_specs.bootloader,
+            home_block: @volume_specs.home_block,
+            volume_params: @volume_specs.volume_params
+          )
+
+          @logger.debug "Virtual volume created"
+
+          _save_volume(path: @output, volume: vol, **@options)
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/deleter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class Deleter < VolReadWriteOperator
+        def call
+          fn = @volume.f_delete(@options[:filename])
+          @logger.es_info "File '#{fn}' was deleted from the volume"
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/extracter_base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class ExtracterBase < VolReadOperator
+        def call
+          files = _extract_files
+          @logger.debug("Files were extracted from the volume")
+          _output(files)
+        end
+
+        private
+
+        def _extract_files; end
+
+        def _output(f_arr)
+          dry_files = Dry::Files.new
+
+          f_arr.each do |f|
+            path = dry_files.join(@options[:dir], _filter_filename(f.filename))
+            _write_file(path, f)
+            @logger.info "File '#{path}' created"
+          end
+
+          @logger.es_info "#{f_arr.length} files extracted"
+        end
+
+        # Remove trailing spaces from the base filename and ext.
+        def _filter_filename(filename)
+          base = File.basename(filename, ".*").rstrip
+          ext = File.extname(filename).rstrip
+
+          base + ext
+        end
+
+        def _write_file(path, _file_obj); end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/extracter_txt.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class ExtracterTxt < ExtracterBase
+        private
+
+        def _extract_files
+          @options[:f_list].map do |fn|
+            @volume.f_extract_txt(fn)
+          end
+        end
+
+        def _write_file(path, file_obj)
+          dry_files = Dry::Files.new
+          dry_files.write(path, file_obj.data.join("\n"))
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/extracter_txt_all.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class ExtracterTxtAll < ExtracterBase
+        private
+
+        def _extract_files
+          @volume.f_extract_txt_all
+        end
+
+        def _write_file(path, file_obj)
+          dry_files = Dry::Files.new
+          dry_files.write(path, file_obj.data.join("\n"))
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/informer.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      #
+      # Prints info about the volume.
+      #
+      class Informer < VolReadOperator
+        VOL_PAR_L = 24
+
+        F_NUM_L = 5
+        F_STATUS_L = 10
+        F_NAME_L = 13
+        F_SIZE_L = 4
+
+        def call
+          snapshot = @volume.snapshot
+
+          _list_files(snapshot[:volume_data])
+          puts ""
+          puts "--- Volume information: ---"
+          _print_n_free_clusters(snapshot[:n_free_clusters])
+          _print_vol_params(snapshot[:volume_params])
+
+          super
+        end
+
+        def _choose_basic(extra_word)
+          case extra_word
+          when SMPTool::Basic10::ENTRY_EXTRA_WORD
+            "BASIC v.1.0"
+          when SMPTool::Basic20::ENTRY_EXTRA_WORD
+            "BASIC v.2.0"
+          else
+            "unknown"
+          end
+        end
+
+        def _print_n_free_clusters(n_free_clusters)
+          puts "N. free clusters:".ljust(VOL_PAR_L) + n_free_clusters.to_s
+        end
+
+        def _print_vol_params(vol_params)
+          puts "N. clusters allocated:".ljust(VOL_PAR_L) << vol_params[:n_clusters_allocated].to_s
+          puts "N. dir. segments:".ljust(VOL_PAR_L) << vol_params[:n_dir_segs].to_s
+          puts "Dir. seg. size:".ljust(VOL_PAR_L) << vol_params[:n_clusters_per_dir_seg].to_s
+          puts "Directory capacity:".ljust(VOL_PAR_L) << vol_params[:n_max_entries].to_s
+          puts "Volume type:".ljust(VOL_PAR_L) << _choose_basic(vol_params[:extra_word])
+        end
+
+        def _list_files(vol_data)
+          _print_file_list_legend
+          vol_data.each_with_index { |e, i| _print_file_entry(i, e) }
+        end
+
+        def _print_file_list_legend
+          legend = [
+            "#".ljust(F_NUM_L),
+            "Status".ljust(F_STATUS_L),
+            "Filename".ljust(F_NAME_L),
+            "Size".to_s.ljust(F_SIZE_L)
+          ].join("")
+
+          puts legend
+          puts legend.gsub(/[^ ]/, "-")
+        end
+
+        def _print_file_entry(idx, entry)
+          puts (idx + 1).to_s.ljust(F_NUM_L) +
+               entry[:status].ljust(F_STATUS_L) +
+               entry[:filename].ljust(F_NAME_L) +
+               entry[:n_clusters].to_s.ljust(F_SIZE_L)
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/operator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      #
+      # Base class for the executors that do some operation.
+      #
+      class Operator
+        def initialize(logger:, **options)
+          @logger = logger
+          @options = options
+        end
+
+        def call; end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/pusher.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class Pusher < VolReadWriteOperator
+        def call
+          files = _read_files(@options[:f_list])
+
+          files.each do |f|
+            fn = @volume.f_push(f)
+
+            @logger.info "File '#{fn}' pushed to the volume"
+          end
+
+          @logger.es_info "#{files.length} files were pushed to the volume"
+
+          super
+        end
+
+        private
+
+        def _read_files(f_list)
+          f_list.map do |path|
+            {
+              filename: File.basename(path),
+              data: _read_file(path).split(/\n/)
+            }
+          end
+        end
+
+        def _read_file(path)
+          @logger.debug "Reading the file: '#{path}'"
+          Dry::Files.new.read(path)
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/renamer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class Renamer < VolReadWriteOperator
+        def call
+          fns = @volume.f_rename(@options[:old_fn], @options[:new_fn])
+          @logger.es_info "File '#{fns.first}' was renamed to '#{fns.last}'"
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/resizer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class Resizer < VolReadWriteOperator
+        def call
+          n_clusters_changed = @volume.resize(@options[:n_clusters].to_i)
+          @logger.es_info _msg(n_clusters_changed)
+
+          super
+        end
+
+        private
+
+        def _msg(n_clusters)
+          if n_clusters.negative?
+            "#{n_clusters.abs} clusters were trimmed from the volume"
+          elsif n_clusters.positive?
+            "#{n_clusters} clusters were added to the volume"
+          else
+            "No changes were made"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/squeezer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class Squeezer < VolReadWriteOperator
+        def call
+          n_free_clusters = @volume.squeeze
+          @logger.es_info "#{n_free_clusters} clusters were joined into one section at the end of the volume"
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/vol_read_operator.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      #
+      # Base class for the executors that read a volume and
+      # do an operation on it (without saving back).
+      #
+      class VolReadOperator
+        def initialize(input:, logger:, **options)
+          @logger = logger
+          @input = input
+          @volume = _load_volume(path: input, **options)
+          @options = options
+        end
+
+        def call; end
+
+        private
+
+        #
+        # Read and parse volume out of a binary file.
+        #
+        # @param [String] path
+        #   Path to the source file.
+        #
+        # @param [Hash{ Symbol => Object }] **_options
+        #
+        # @return [SMPTool::VirtualVolume::Volume]
+        #
+        def _load_volume(path:, **_options)
+          b_str = _read_bin_file(path)
+          @logger.info "Read data from the file: '#{path}'"
+
+          vol = _parse_volume(b_str)
+          @logger.debug "Volume parsed"
+
+          vol
+        end
+
+        #
+        # Parse binary string to create a volume obj.
+        #
+        # @param [String] b_str
+        #
+        # @return [SMPTool::VirtualVolume::Volume]
+        #
+        def _parse_volume(b_str)
+          SMPTool::VirtualVolume::Volume.read_io(
+            b_str
+          )
+        end
+
+        #
+        # Read a binary file.
+        #
+        # @param [String] path
+        #
+        # @return [String]
+        #   Binary string with the file's content.
+        #
+        def _read_bin_file(path)
+          Dry::Files.new.read(path)
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor/vol_read_write_operator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      #
+      # Base class for the executors that read a volume and
+      # do an operation on it, then save the state back to a file.
+      #
+      class VolReadWriteOperator < VolReadOperator
+        include BinWriteMixin
+
+        def call
+          _save_volume(path: @options[:output], volume: @volume, **@options) if @options.key?(:output)
+          _save_volume(path: @input, volume: @volume, **@options) if @options[:apply]
+
+          return if @options.key?(:output) || @options[:apply]
+
+          @logger.warning "Changes were not saved since you didn't specify the output file " \
+                          "or the `-a` option to apply changes to the input file"
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/executor.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    #
+    # Namespace for classes that execute commands.
+    #
+    module Executor; end
+  end
+end

data/lib/smp_tool/cli/logger.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    QUIET_MODE = 1
+    BRIEF_MODE = 2
+    VERBOSE_MODE = 3
+    DEBUG_MODE = 4
+
+    LEVELS = {
+      "quiet" => QUIET_MODE,
+      "brief" => BRIEF_MODE,
+      "verbose" => VERBOSE_MODE,
+      "debug" => DEBUG_MODE
+    }.freeze
+
+    #
+    # Simple logger.
+    #
+    class Logger
+      def initialize(level: "brief")
+        @level = _choose_level(level)
+      end
+
+      # Low-priority info.
+      def info(msg)
+        _print_msg(msg, "Info", VERBOSE_MODE) { |s| puts s }
+      end
+
+      # Essential info.
+      def es_info(msg)
+        _print_msg(msg, "Info", BRIEF_MODE) { |s| puts s }
+      end
+
+      # Warning.
+      def warning(msg)
+        _print_msg(msg, "Warn", QUIET_MODE) { |s| warn s }
+      end
+
+      # Error.
+      def error(msg)
+        _print_msg(msg, "Error", QUIET_MODE) { |s| warn s }
+      end
+
+      # Debug message.
+      def debug(msg)
+        _print_msg(msg, "Debug", DEBUG_MODE) { |s| puts s }
+      end
+
+      private
+
+      def _print_msg(msg, type, mode)
+        return unless mode <= @level
+
+        msg = "[#{type}]: #{msg}"
+
+        yield(msg)
+      end
+
+      def _choose_level(key)
+        raise ArgumentError, "Wrong verbosity level: #{key}" unless LEVELS.key?(key.downcase)
+
+        LEVELS[key.downcase]
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    VERSION = "0.1.0"
+  end
+end