smp_tool-cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da03ac32fe8ebcf2d0f32f19d49f37b48b7404289bc91cf006e45c4dddc353a1
-  data.tar.gz: 78a43fdd3e6f1f533681e362786ad8059bb07a39703d2e0d6d4dda3f5ffe29da
+  metadata.gz: c83c658d44b09650948b0d0b94e34250ac9a41b374651ed34ed64675678f122b
+  data.tar.gz: a4052f1740f90749c0dd998850eef0c7d0e6bfd7c54fbb79d2f2dfad03ff9a05
 SHA512:
-  metadata.gz: a060a0c98f3bef66ef1984f30f0e6098e0219789197009acef2ca157cfa013ee08112df4ef0ea2a0bc6af2fc8b19a690114a7371ae53057c1dd97ad5f7e50c53
-  data.tar.gz: 358a6164fb66b79767900a0f8506304636ce1d67c2201ad2059e39aebe52388dd3dea7fabd34d9e0378c2ab330283a0744b9f6beabd29dd2336c30c5fe61af50
+  metadata.gz: 780ab66ca40a0abebd11a47e6f1415429593776d4545c723b1ee94b72928a7e04f82d6a024d70835d12fc96bd7bca6c0824842b6b0f2eec54a5bbd8504d86790
+  data.tar.gz: 5abbc23d7cbae441f7760a1d030fcc05ebd783c7d4c70bf7af037b0938f4e9a9471654f2357d91298ea890e2783f803c84b6b386a7eb9033e4e0798a5a1d8409

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.2.0] - 2024-03-17
+
+* `--raw` option for the extract command
+* more advanced `delete` command
+
+## [0.1.1] - 2024-03-15
+
+* Few changes in the UI
+
 ## [0.1.0] - 2024-03-14
 
-- Initial release
+* Initial release

data/lib/smp_tool/cli/commands/delete.rb

@@ -4,20 +4,28 @@ module SMPTool
   module CLI
     module Commands
       #
-      # Delete a file from the volume.
+      # Delete file(s) from the volume.
       #
       class Delete < VolumeOperation
-        desc "Delete a file from the volume"
+        desc "Delete files from the volume"
 
-        option :filename,
+        option :f_list,
+               type: :array,
                required: true,
-               desc: "File to delete",
+               desc: "File(s) to delete",
                aliases: ["-f"]
 
-        def call(input:, filename:, **options)
+        option :squeeze,
+               type: :boolean,
+               required: false,
+               default: false,
+               desc: "When done, perform the `squeeze` operation",
+               aliases: ["-s"]
+
+        def call(input:, f_list:, **options)
           Executor::Deleter.new(
             input: input,
-            filename: filename,
+            f_list: f_list,
             logger: _logger(options[:verbosity]),
             **options
           ).call

data/lib/smp_tool/cli/commands/extract.rb

@@ -21,7 +21,24 @@ module SMPTool
                desc: "File(s) to extract",
                aliases: ["-f"]
 
+        option :raw,
+               type: :boolean,
+               default: false,
+               required: false,
+               desc: "Extract as raw data",
+               aliases: ["-r"]
+
         def call(input:, f_list:, **options)
+          if options[:raw]
+            _extract_raw(input: input, f_list: f_list, **options)
+          else
+            _extract_txt(input: input, f_list: f_list, **options)
+          end
+        end
+
+        private
+
+        def _extract_txt(input:, f_list:, **options)
           Executor::ExtracterTxt.new(
             input: input,
             f_list: f_list,
@@ -29,6 +46,15 @@ module SMPTool
             **options
           ).call
         end
+
+        def _extract_raw(input:, f_list:, **options)
+          Executor::ExtracterRaw.new(
+            input: input,
+            f_list: f_list,
+            logger: _logger(options[:verbosity]),
+            **options
+          ).call
+        end
       end
     end
   end

data/lib/smp_tool/cli/commands/extract_all.rb

@@ -15,13 +15,38 @@ module SMPTool
                desc: "Output directory",
                aliases: ["-d"]
 
+        option :raw,
+               type: :boolean,
+               default: false,
+               required: false,
+               desc: "Extract as raw data",
+               aliases: ["-r"]
+
         def call(input:, **options)
+          if options[:raw]
+            _extract_raw(input: input, **options)
+          else
+            _extract_txt(input: input, **options)
+          end
+        end
+
+        private
+
+        def _extract_txt(input:, **options)
           Executor::ExtracterTxtAll.new(
             input: input,
             logger: _logger(options[:verbosity]),
             **options
           ).call
         end
+
+        def _extract_raw(input:, **options)
+          Executor::ExtracterRawAll.new(
+            input: input,
+            logger: _logger(options[:verbosity]),
+            **options
+          ).call
+        end
       end
     end
   end

data/lib/smp_tool/cli/commands/list_files.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Commands
+      #
+      # Command to list files.
+      #
+      class ListFiles < InputCommand
+        desc "List all files on the volume"
+
+        def call(input:, **options)
+          Executor::FileListInformer.new(
+            input: input,
+            logger: _logger(options[:verbosity]),
+            **options
+          ).call
+        end
+      end
+    end
+  end
+end

data/lib/smp_tool/cli/commands/new.rb

@@ -17,13 +17,13 @@ module SMPTool
 
         option :basic,
                required: true,
-               desc: "Target Basic version { 1 | 2 }",
+               desc: "Target BASIC version { 1 | 2 }",
                aliases: ["-b"]
 
         option :n_clusters,
                default: DEF_N_CLUSTERS,
                required: false,
-               desc: "Number of clusters allocated to the volume",
+               desc: "Number of 512-byte clusters allocated to the volume (4..127)",
                aliases: ["-c"]
 
         option :n_dir_segs,
@@ -47,8 +47,8 @@ module SMPTool
         example [
           "-b 1                   # Create a BASIC v.1.0 volume with the default parameters, " \
                                   "save result to the `smp0.bin` file (default path)",
-          "-b 2 -o /dir/smp.bin   # Create a BASIC v.1.0 volume with the default parameters, " \
-                                  "save result to the `/dir/smp.bin` file (custom path)",
+          "-b 2 -o dir/smp.bin    # Create a BASIC v.1.0 volume with the default parameters, " \
+                                  "save result to the `dir/smp.bin` file (custom path)",
           "-b 2 -l auto           # Create a BASIC v.2.0 volume with the auto-loader",
           "-b 1 -c 127 -d 2       # Create the largest possible BASIC v.1.0 volume",
           "-b 1 -s 1              # Create a BASIC v.1.0 volume with the 'trimmed' directory"

data/lib/smp_tool/cli/commands.rb

@@ -18,6 +18,7 @@ module SMPTool
       register "rename", Rename, aliases: ["r"]
       register "resize", Resize, aliases: ["z"]
       register "squeeze", Squeeze, aliases: ["s"]
+      register "list", ListFiles, aliases: ["l"]
 
       register "version", Version, aliases: ["-v", "--version"]
     end

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

@@ -4,9 +4,17 @@ module SMPTool
   module CLI
     module Executor
       class Deleter < VolReadWriteOperator
+        include SqueezeMixin
+
         def call
-          fn = @volume.f_delete(@options[:filename])
-          @logger.es_info "File '#{fn}' was deleted from the volume"
+          @options[:f_list].each do |file|
+            fn = @volume.f_delete(file)
+            @logger.info "File '#{fn}' was deleted from the volume"
+          end
+
+          @logger.es_info "#{@options[:f_list].length} files were deleted from the volume"
+
+          _squeeze if @options[:squeeze]
 
           super
         end

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

@@ -23,7 +23,7 @@ module SMPTool
             @logger.info "File '#{path}' created"
           end
 
-          @logger.es_info "#{f_arr.length} files extracted"
+          @logger.es_info "#{f_arr.length} files were extracted to the directory: '#{@options[:dir]}'"
         end
 
         # Remove trailing spaces from the base filename and ext.

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class ExtracterRaw < ExtracterRawBase
+        private
+
+        def _extract_files
+          @options[:f_list].map do |fn|
+            @volume.f_extract_raw(fn)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class ExtracterRawAll < ExtracterRawBase
+        private
+
+        def _extract_files
+          @volume.f_extract_raw_all
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class ExtracterRawBase < ExtracterBase
+        private
+
+        def _write_file(path, file_obj)
+          dry_files = Dry::Files.new
+          dry_files.write(path, file_obj.data)
+        end
+
+        def _filter_filename(filename)
+          "#{super}.bin"
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module SMPTool
   module CLI
     module Executor
-      class ExtracterTxt < ExtracterBase
+      class ExtracterTxt < ExtracterTxtBase
         private
 
         def _extract_files
@@ -11,11 +11,6 @@ module SMPTool
             @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

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

@@ -3,17 +3,12 @@
 module SMPTool
   module CLI
     module Executor
-      class ExtracterTxtAll < ExtracterBase
+      class ExtracterTxtAll < ExtracterTxtBase
         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

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class ExtracterTxtBase < ExtracterBase
+        private
+
+        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/file_list_informer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      #
+      # Lists files on the volume.
+      #
+      class FileListInformer < VolReadOperator
+        def call
+          snapshot = @volume.snapshot
+
+          _list_files(snapshot[:volume_data])
+
+          super
+        end
+
+        private
+
+        def _list_files(vol_data)
+          vol_data.reject { |e| e[:status] == "empty" }
+                  .each { |e| puts e[:filename] }
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module SMPTool
       # Prints info about the volume.
       #
       class Informer < VolReadOperator
-        VOL_PAR_L = 24
+        VOL_PAR_L = 32
 
         F_NUM_L = 5
         F_STATUS_L = 10
@@ -26,6 +26,8 @@ module SMPTool
           super
         end
 
+        private
+
         def _choose_basic(extra_word)
           case extra_word
           when SMPTool::Basic10::ENTRY_EXTRA_WORD
@@ -44,8 +46,8 @@ module SMPTool
         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 "Dir. seg. size, clusters:".ljust(VOL_PAR_L) << vol_params[:n_clusters_per_dir_seg].to_s
+          puts "Directory capacity, files:".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
 

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

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

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

@@ -4,9 +4,10 @@ module SMPTool
   module CLI
     module Executor
       class Squeezer < VolReadWriteOperator
+        include SqueezeMixin
+
         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"
+          _squeeze
 
           super
         end

data/lib/smp_tool/cli/version.rb

@@ -2,6 +2,6 @@
 
 module SMPTool
   module CLI
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/smp_tool-cli.gemspec

@@ -35,5 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-cli", "~> 1.0", ">= 1.0.0"
   spec.add_dependency "dry-files", "~> 1.1", ">= 1.1.0"
   spec.add_dependency "smp_tool", "~> 0.1", ">= 0.1.0"
-  spec.add_dependency "zeitwerk", "~> 2.6", ">= 2.6.12"
+  spec.add_dependency "zeitwerk", "~> 2.6", ">= 2.6.13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smp_tool-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - 8bit-m8
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -79,7 +79,7 @@ dependencies:
         version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.12
+        version: 2.6.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ dependencies:
         version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.12
+        version: 2.6.13
 description: 
 email:
 - you@example.com
@@ -114,6 +114,7 @@ files:
 - lib/smp_tool/cli/commands/extract_all.rb
 - lib/smp_tool/cli/commands/info.rb
 - lib/smp_tool/cli/commands/input_command.rb
+- lib/smp_tool/cli/commands/list_files.rb
 - lib/smp_tool/cli/commands/new.rb
 - lib/smp_tool/cli/commands/push.rb
 - lib/smp_tool/cli/commands/rename.rb
@@ -127,13 +128,19 @@ files:
 - lib/smp_tool/cli/executor/creator.rb
 - lib/smp_tool/cli/executor/deleter.rb
 - lib/smp_tool/cli/executor/extracter_base.rb
+- lib/smp_tool/cli/executor/extracter_raw.rb
+- lib/smp_tool/cli/executor/extracter_raw_all.rb
+- lib/smp_tool/cli/executor/extracter_raw_base.rb
 - lib/smp_tool/cli/executor/extracter_txt.rb
 - lib/smp_tool/cli/executor/extracter_txt_all.rb
+- lib/smp_tool/cli/executor/extracter_txt_base.rb
+- lib/smp_tool/cli/executor/file_list_informer.rb
 - lib/smp_tool/cli/executor/informer.rb
 - lib/smp_tool/cli/executor/operator.rb
 - lib/smp_tool/cli/executor/pusher.rb
 - lib/smp_tool/cli/executor/renamer.rb
 - lib/smp_tool/cli/executor/resizer.rb
+- lib/smp_tool/cli/executor/squeeze_mixin.rb
 - lib/smp_tool/cli/executor/squeezer.rb
 - lib/smp_tool/cli/executor/vol_read_operator.rb
 - lib/smp_tool/cli/executor/vol_read_write_operator.rb