smp_tool-cli 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd85230de1a516aa00d00cfc1cb4b6cc974d31911f5ffc9e9f960308d9ab3305
-  data.tar.gz: 5564aaf53a4f2b3404a0ab017b5310e04b71e0863d6e2a6ced8bc4a8df83d074
+  metadata.gz: 3149aa9dc1f632c851d3eb26f0a7789a793915fade6999067efa2869b2190e38
+  data.tar.gz: 71b57cabecc20c1a3ef3f45f69a44a908349ee3a91783d54f911a42c3c10f58a
 SHA512:
-  metadata.gz: 2d121db1b7ece3b790b9d161b61edb4f2cb1cb70ab1abdfcb729da0274a5f9d26d129d2dde277f8cd98354217850405b19d0b4f0f5dadc33f0383a0f49646cf9
-  data.tar.gz: be1b984472598136b0da421e7bcb00007335adf5d9930416042b186d04bed846079ac7f5f90bf803d145e3780e9161d67cdcd5568df8d2787528595121a9bc5c
+  metadata.gz: e558d4ce08db06194481a202b21e42b9e350a346f4c0819dfa493d25e1b06dbf3ed3ce83934c6aff390210d81465c8a3e3f37bde6ede2079cd1fa87f859d3efe
+  data.tar.gz: 60fca9c7337d7934b8b8f9270d8e9db3cdd57b2fe04eb48f133b91a2564cfb75cbe935a16597c17ffe9c5f13fca47dc0f933002ed5cafbf2f340807162832099

data/CHANGELOG.md

@@ -1,7 +1,16 @@
+## [0.2.1] - 2024-03-18
+
+* bug fix: file read/write on MS Windows
+
+## [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
+* 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,7 +17,7 @@ module SMPTool
 
         option :basic,
                required: true,
-               desc: "Target Basic version { 1 | 2 }",
+               desc: "Target BASIC version { 1 | 2 }",
                aliases: ["-b"]
 
         option :n_clusters,

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/base.rb

@@ -12,53 +12,6 @@ module SMPTool
         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

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

@@ -17,12 +17,12 @@ module SMPTool
         # @param [Hash{ Symbol => Object }] **_options
         #
         def _save_volume(path:, volume:, **_options)
-          b_str = _volume_to_binary(volume)
-          @logger.debug "Converted to binary string"
+          bin_obj = volume.to_volume_io
+          @logger.debug "Converted to VolumeIO of #{bin_obj.num_bytes} bytes"
 
           _write_bin_file(
             path,
-            b_str
+            bin_obj
           )
 
           @logger.es_info "Changes saved to the file: '#{path}'"
@@ -44,11 +44,10 @@ module SMPTool
         #
         # @param [String] path
         #
-        # @param [String] data
-        #   Binary string with the file's content.
+        # @param [Object] bin_obj
         #
-        def _write_bin_file(path, data)
-          Dry::Files.new.write(path, data)
+        def _write_bin_file(path, bin_obj)
+          File.open(path, "wb") { |file| bin_obj.write(file) }
         end
       end
     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

@@ -19,7 +19,7 @@ module SMPTool
 
           f_arr.each do |f|
             path = dry_files.join(@options[:dir], _filter_filename(f.filename))
-            _write_file(path, f)
+            _save_file(path, f)
             @logger.info "File '#{path}' created"
           end
 
@@ -34,7 +34,7 @@ module SMPTool
           base + ext
         end
 
-        def _write_file(path, _file_obj); end
+        def _save_file(path, _file_obj); end
       end
     end
   end

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,23 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class ExtracterRawBase < ExtracterBase
+        private
+
+        def _save_file(path, file_obj)
+          _write_data(path, file_obj.data)
+        end
+
+        def _write_data(path, data)
+          File.binwrite(path, 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,19 @@
+# frozen_string_literal: true
+
+module SMPTool
+  module CLI
+    module Executor
+      class ExtracterTxtBase < ExtracterBase
+        private
+
+        def _save_file(path, file_obj)
+          _write_data(path, file_obj.data.join("\n"))
+        end
+
+        def _write_data(path, data)
+          File.binwrite(path, data)
+        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

@@ -26,6 +26,8 @@ module SMPTool
           super
         end
 
+        private
+
         def _choose_basic(extra_word)
           case extra_word
           when SMPTool::Basic10::ENTRY_EXTRA_WORD

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/executor/vol_read_operator.rb

@@ -30,39 +30,14 @@ module SMPTool
         # @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"
+          io = File.binread(path)
 
-          vol
-        end
+          @logger.info "Read data from the file: '#{path}'"
 
-        #
-        # 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
+            io
           )
         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

data/lib/smp_tool/cli/version.rb

@@ -2,6 +2,6 @@
 
 module SMPTool
   module CLI
-    VERSION = "0.1.1"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smp_tool-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - 8bit-m8
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -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