fileverse 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa201a13fbd4310e92d1abb0f0589a84612898af61e5971ba7c6edfa349c47b6
-  data.tar.gz: 5896f09dd563c6df50b91cd4171a9bef539e926c36c761f3780ace0be32cfebb
+  metadata.gz: eb4f08cab20e1b1b98e24f2313733732e0512a1c430eb14e757d87ab8419a9d3
+  data.tar.gz: fa9d796257f859c1fa7a94e6b285ef54d6974265679b9721ed9f4882fa696da8
 SHA512:
-  metadata.gz: 118538226ff51aa2065abafb8e5a2aa09c0314756619a119e36ef09a6bbc8179085a5c7e98f8a0aa05483be0e22cfcba060afcfd7d0cd1e5789ec318f0220b09
-  data.tar.gz: 6a487fb4a144e40aa398917d942adfae39e20608a994b0370005f8f213bd4ddd78705a69284606bc0723e8a51a31eb248ad0548022c6e708b8c5abbc9435082d
+  metadata.gz: 319a6cd3418244abf49b1769b90e5a4255ce70ad2c3aed01d69d80dc49f88c960c2830d1b4b23b8a86a382acf50a68d73a3c54b228df3695addb72a389bd470f
+  data.tar.gz: 104f680f5bf3ee9008c356be7ec8ff4a345f3bcfba3e4e0905697fad62f5e37662283be9c56e048d031ecfc5bc434b87d13f4f555699f17ebf3aa09bed2e5220

data/README.md

@@ -17,7 +17,7 @@ A simple ruby cli tool for keeping different versions of a file.
     - preview       --name=""       {file_path}             (p)
     - preview       --index=0       {file_path}             (p)
     - reset                         {file_path}             (x)
-    - summary                       {file_path}             (sm)
+    - snap_and_restore_template     {file_path}             (sart)
     - restore                       {file_path}             (r)
 
 ## Sample

data/lib/fileverse/cli.rb

@@ -4,90 +4,124 @@ require "thor"
 
 module Fileverse
   # CLI class
-  class CLI < Thor
+  class CLI < Thor # rubocop:disable Metrics/ClassLength
     desc "snap file content", "store current file content"
     options template: :boolean, name: :string
     def snap(path)
-      setup path
+      setup_options
+      @template ? setup_template_parser(path) : setup_file_parser(path)
       @parser.parse
-      @parser.add_snapshot(Files.read(@path), options[:name])
+      @parser.add_snapshot(Files.read(@path), @snapshot_name)
       Files.write_content(@path)
-      Files.write_content(@hidden_path, @parser.to_writable_lines)
+      Files.write_content(@storage_path, @parser.to_writable_lines)
+    rescue StandardError => e
+      puts e.message
     end
     map "s" => "snap"
 
     desc "restore content", "restore content in the current cursor"
     options template: :boolean, name: :string
     def restore(path)
-      setup path
-      @parser.parse
-      options[:template] ? restore_template : restore_snapshot
+      setup_options
+      @template ? restore_template_snapshot(path) : restore_file_snapshot(path)
+    rescue StandardError => e
+      puts e.message
     end
     map "r" => "restore"
 
     desc "preview snapshot", "preview snapshot at different index or name"
     options bwd: :boolean, fwd: :boolean, index: :numeric, name: :string, template: :boolean
     def preview(path)
-      setup path
+      setup_options
+      @template ? setup_template_parser(path) : setup_file_parser(path)
       @parser.parse
-      @previewer.parse
+      setup_previewer
       @previewer.preview_content = preview_content
       Files.write_content(@path, @previewer.to_writable_lines)
-      Files.write_content(@hidden_path, @parser.to_writable_lines)
+      Files.write_content(@storage_path, @parser.to_writable_lines)
+    rescue StandardError => e
+      puts e.message
     end
     map "p" => "preview"
 
-    desc "reset", "reset files. both the config and original"
+    desc "reset", "reset files. both the storage and original"
     def reset(path)
-      setup path
+      setup_file_parser(path)
       @parser.parse
+      @parser.reset
+      setup_previewer
       @previewer.parse
       @previewer.preview_content = []
-      @parser.reset
       Files.write_content(@path, @previewer.to_writable_lines)
-      Files.write_content(@hidden_path, @parser.to_writable_lines)
+      Files.write_content(@storage_path, @parser.to_writable_lines)
+    rescue StandardError => e
+      puts e.message
     end
     map "x" => "reset"
 
-    desc "summary", "return all the summary of snapshots"
-    def summary(path)
-      setup path
-      @parser.parse_head
-      puts @parser.summary
+    desc "snap restore", "snap and restore template"
+    options template_name: :string
+    def snap_and_restore_template(path)
+      snap path
+      @snapshot_name = @template_name
+      restore_template_snapshot path
+    rescue StandardError => e
+      puts e.message
     end
-    map "sm" => "summary"
+    map "sart" => "snap_and_restore_template"
 
     private
 
-    def setup(path)
+    def setup_file_parser(path)
+      @path = Files.expand_path(path)
+      @storage_path = Files.expand_hidden_path(path)
+      @parser = Parser.new(@storage_path)
+    end
+
+    def setup_template_parser(path)
       @path = Files.expand_path(path)
-      @hidden_path = options[:template] ? Files.template_path : Files.expand_hidden_path(path)
-      @parser = Parser.new(@hidden_path)
+      @storage_path = Files.template_path
+      @parser = Parser.new(@storage_path)
+    end
+
+    def setup_previewer
       @previewer = Previewer.new(@path)
     end
 
-    def restore_snapshot
+    def setup_options
+      @template = options[:template]
+      @snapshot_name = options[:name]
+      @move_backward = options[:bwd]
+      @move_forward = options[:fwd]
+      @index = options[:index]
+      @template_name = options[:template_name]
+    end
+
+    def restore_file_snapshot(path)
+      setup_file_parser(path)
+      @parser.parse
       Files.write_content(@path, @parser.cursor_content)
       @parser.remove_cursor_snapshot
-      Files.write_content(@hidden_path, @parser.to_writable_lines)
+      Files.write_content(@storage_path, @parser.to_writable_lines)
     end
 
-    def restore_template
-      template_content = @parser.snapshot_content_by_name(options[:name])
-      return if template_content.nil?
-
-      Files.write_content(@path, template_content)
+    def restore_template_snapshot(path)
+      setup_template_parser(path)
+      @parser.parse
+      Files.write_content(@path, @parser.snapshot_content_by_name(@snapshot_name))
     end
 
-    def preview_content
-      if options[:name]
+    def preview_content # rubocop:disable Metrics/MethodLength
+      if @template_name
         @parser.snapshot_content_by_name(options[:name])
-      elsif options[:bwd]
+      elsif @move_backward
         @parser.snapshot_content_backward
-      elsif options[:fwd]
+      elsif @move_forward
         @parser.snapshot_content_forward
-      elsif options[:index]
+      elsif @index
         @parser.snapshot_content_by_index(options[:index])
+      else
+        @parser.cursor_content
       end
     end
   end

data/lib/fileverse/errors.rb

@@ -17,10 +17,24 @@ module Fileverse
     end
   end
 
-  # Error for invalid cursor
-  class InvalidCursorPointer < StandardError
-    def initialize(section = nil)
-      super("Invalid cursor.#{section}")
+  # Error for negative cursor
+  class NegativeCursorPointer < StandardError
+    def initialize
+      super("Cursor can not be negative.")
+    end
+  end
+
+  # Error for maximum cursor
+  class MaxCursorPointer < StandardError
+    def initialize
+      super("Cursor can not be larger that snapped length.")
+    end
+  end
+
+  # Error for maximum cursor
+  class NoContentForName < StandardError
+    def initialize(name)
+      super("No snapshot content for name: '#{name}'.")
     end
   end
 end

data/lib/fileverse/parser.rb

@@ -105,19 +105,21 @@ module Fileverse
     end
 
     def cursor_content
-      raise InvalidCursorPointer if @cursor.negative? || @cursor > @snapshots.length
+      raise NegativeCursorPointer if @cursor.negative?
+      raise MaxCursorPointer if @cursor >= @snapshots.length
 
       @snapshots[@cursor].content
     end
 
     def snapshot_content_by_name(name)
-      find_named_snapshot(name)&.content
+      content = find_named_snapshot(name)&.content
+      raise NoContentForName, name if content.nil?
+
+      content
     end
 
     def snapshot_content_by_index(index)
-      raise InvalidCursorPointer if index.negative? || index > @snapshots.length
-
-      @cursor = value
+      @cursor = index
       cursor_content
     end
 
@@ -173,14 +175,10 @@ module Fileverse
     end
 
     def decrement_cursor
-      raise InvalidCursorPointer if (@cursor - 1).negative?
-
       @cursor -= 1
     end
 
     def increment_cursor
-      raise InvalidCursorPointer if @cursor + 1 >= @snapshots.length
-
       @cursor += 1
     end
 

data/lib/fileverse/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fileverse
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fileverse
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Unegbu Kingsley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-04-16 00:00:00.000000000 Z
+date: 2025-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor