fileverse 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a14542329552682cfacbc80a77a520f6f67b8d879e68fc7ee901953039eddbaa
-  data.tar.gz: 86d8f88902bf3dca295860636c073276322e0667524d0304a1db6e3de9c6527e
+  metadata.gz: b739dd6750e9f37a5720e9789800efa69c545abb67855d8f38630841f3c30870
+  data.tar.gz: d575e0eec8c760353b5b61d54f5e5e923cd6d261dd55d8a75533ed7079e7ecf4
 SHA512:
-  metadata.gz: 64bfd38030920a3a5185ac8db6e82475392e32eb49e6a5d5b1a94c832aa914f9961a2e832f6b44608dfb71bf965e2ed8dd43cca56ebc6344089313fb4e87c1d1
-  data.tar.gz: 104739b54efc776f2d71901cc9eac641104f4151165fe42288edd39de4641d99e4ea517177e975dff9c6f4d3025e9569f00fed29260c48e5311b2c6d635d66d6
+  metadata.gz: 5c64c1dca0991f50667bf048d74f88971b0611da8e309a9287f7bb679b8b8332c7cfc221e63eb4b411a6ce144a29243ee512a25c3f48e5f75173a25fe0e382fb
+  data.tar.gz: f551ff2f97acabd6299fea567425425261822361b789ef6065a966a25edaebc413c6938ad0db52068ba9d8d4c1a4527ae180176acb9ed38cef95f6ac0dbde98b

data/README.md

@@ -12,14 +12,17 @@ A simple ruby cli tool for keeping different versions of a file.
 
 ## Commands / Shortcuts
     - snap                          {file_path}             (s)
-    - preview       --<<            {file_path}             (p)
-    - preview       -->>            {file_path}             (p)
+    - preview       --bwd           {file_path}             (p)
+    - preview       --fwd           {file_path}             (p)
     - preview       --name=""       {file_path}             (p)
     - preview       --index=0       {file_path}             (p)
     - reset                         {file_path}             (x)
-    - snapshots                     {file_path}             (c)
+    - summary                       {file_path}             (sm)
     - restore                       {file_path}             (r)
 
+## Sample
+![Sample](./sample.gif)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/fileverse/cli.rb

@@ -6,32 +6,32 @@ module Fileverse
   # CLI class
   class CLI < Thor
     desc "snap file content", "store current file content"
+    options template: :boolean, name: :string
     def snap(path)
       setup path
       @parser.parse
-      @parser.add_snapshot(Files.read(@path))
+      @parser.add_snapshot(Files.read(@path), options[:name])
       Files.write_content(@path)
       Files.write_content(@hidden_path, @parser.to_writable_lines)
     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
-      Files.write_content(@path, @parser.cursor_content)
-      @parser.remove_cursor_snapshot
-      Files.write_content(@hidden_path, @parser.to_writable_lines)
+      options[:template] ? restore_template : restore_snapshot
     end
     map "r" => "restore"
 
     desc "preview snapshot", "preview snapshot at different index or name"
-    options bwd: :boolean, fwd: :boolean, index: :numeric, name: :string
+    options bwd: :boolean, fwd: :boolean, index: :numeric, name: :string, template: :boolean
     def preview(path)
       setup path
       @parser.parse
       @previewer.parse
-      update_preview_content
+      @previewer.preview_content = preview_content
       Files.write_content(@path, @previewer.to_writable_lines)
       Files.write_content(@hidden_path, @parser.to_writable_lines)
     end
@@ -49,24 +49,46 @@ module Fileverse
     end
     map "x" => "reset"
 
+    desc "summary", "return all the summary of snapshots"
+    def summary(path)
+      setup path
+      @parser.parse_head
+      puts @parser.summary
+    end
+    map "sm" => "summary"
+
     private
 
     def setup(path)
       @path = Files.expand_path(path)
-      @hidden_path = Files.expand_hidden_path(path)
-      @parser = Parser::Header.new(@hidden_path)
+      @hidden_path = options[:template] ? Files.template_path : Files.expand_hidden_path(path)
+      @parser = Parser.new(@hidden_path)
       @previewer = Previewer.new(@path)
     end
 
-    def update_preview_content
-      if options[:bwd]
-        @parser.decrement_cursor
+    def restore_snapshot
+      Files.write_content(@path, @parser.cursor_content)
+      @parser.remove_cursor_snapshot
+      Files.write_content(@hidden_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)
+    end
+
+    def preview_content
+      if options[:name]
+        @parser.snapshot_content_by_name(options[:name])
+      elsif options[:bwd]
+        @parser.snapshot_content_backward
       elsif options[:fwd]
-        @parser.increment_cursor
+        @parser.snapshot_content_forward
       elsif options[:index]
-        @parser.cursor = options[:index]
+        @parser.snapshot_content_by_index(options[:index])
       end
-      @previewer.preview_content = @parser.cursor_content
     end
   end
 end

data/lib/fileverse/files.rb

@@ -22,5 +22,9 @@ module Fileverse
       full_path = File.expand_path path, Dir.pwd
       File.open(full_path, "w") { |file| file.puts content }
     end
+
+    def template_path
+      File.expand_path ".fileverse.template", Dir.home
+    end
   end
 end

data/lib/fileverse/parser.rb

@@ -1,260 +1,280 @@
 # frozen_string_literal: true
 
 module Fileverse
-  module Parser
-    # Fileverse::Parser::Header : is the main parser for the storage file.
-    # Lets take a storage file example:
-    #
-    # == Storage file Example content
-    #
-    # <######0
-    # template>shot> 6 ~> 9
-    # 9 ~> 12
-    # 12 ~> 15
-    # 15 ~> 18
-    # ######>
-    # // New file
-    # // Write here
-    # // When you can
-    # File 1
-    # Content 1 of file 1
-    # Content 2 of file 1
-    # File 2
-    # Content 1 of file 2
-    # Content 2 of file 2
-    # File 3
-    # Content 1 of file 3
-    # Content 2 of file 3
-    #
-    #
-    # == Example end
-    #
-    # It uses the head section which is what is between "<######{cursor}" and "######>".
-    # It starts with "templates" and then "files". Each has a range which is represented like "{start} ~> {stop}".
-    # templates are represented as "template>{name}>{range}". While files are just represented as "{range}".
-    # so the above example will parse as follows:
-    #
-    # - template>shot> 6 ~> 9
-    #
-    # =======================================
-    # |   // New file
-    # |   // Write here
-    # |   // When you can
-    # ======================================
-    #
-    # - 9 ~> 12
-    #
-    # =======================================
-    # |   File 1
-    # |   Content 1 of file 1
-    # |   Content 2 of file 1
-    # ======================================
-    #
-    # - 12 ~> 15
-    #
-    # =======================================
-    # |   File 2
-    # |   Content 1 of file 2
-    # |   Content 2 of file 2
-    # ======================================
-    #
-    # - 15 ~> 18
-    #
-    # =======================================
-    # |   File 3
-    # |   Content 1 of file 3
-    # |   Content 2 of file 3
-    # ======================================
-    #
-    class Header # rubocop:disable Metrics/ClassLength
-      START_TAG = "<######"
-      CLOSE_TAG = "######>"
-
-      attr_reader :path, :cursor, :line_index
-
-      def initialize(path)
-        @path = path
-        @iterator = File.foreach(path, chomp: true)
-        @line_index = 0
-        @cursor = -1
-        @snapshots = []
-        @templates = []
-      end
+  # Fileverse::Parser : is the main parser for the storage file.
+  # Lets take a storage file example:
+  #
+  # == Storage file Example content
+  #
+  # <######0
+  # shot> 6 ~> 9
+  # 9 ~> 12
+  # 12 ~> 15
+  # 15 ~> 18
+  # ######>
+  # // New file
+  # // Write here
+  # // When you can
+  # File 1
+  # Content 1 of file 1
+  # Content 2 of file 1
+  # File 2
+  # Content 1 of file 2
+  # Content 2 of file 2
+  # File 3
+  # Content 1 of file 3
+  # Content 2 of file 3
+  #
+  #
+  # == Example end
+  #
+  # It uses the head section which is what is between "<######{cursor}" and "######>" as the table to parse the file.
+  # Each line is a range represented like "{name}> {start} ~> {stop}". the "{name}>" part is optional.
+  # so the above example will parse as follows:
+  #
+  # - shot> 6 ~> 9
+  #
+  # =======================================
+  # |   // New file
+  # |   // Write here
+  # |   // When you can
+  # ======================================
+  #
+  # - 9 ~> 12
+  #
+  # =======================================
+  # |   File 1
+  # |   Content 1 of file 1
+  # |   Content 2 of file 1
+  # ======================================
+  #
+  # - 12 ~> 15
+  #
+  # =======================================
+  # |   File 2
+  # |   Content 1 of file 2
+  # |   Content 2 of file 2
+  # ======================================
+  #
+  # - 15 ~> 18
+  #
+  # =======================================
+  # |   File 3
+  # |   Content 1 of file 3
+  # |   Content 2 of file 3
+  # ======================================
+  #
+  class Parser # rubocop:disable Metrics/ClassLength
+    START_TAG = "<######"
+    CLOSE_TAG = "######>"
+
+    attr_reader :path, :cursor, :line_index
+
+    def initialize(path)
+      @path = path
+      @iterator = File.foreach(path, chomp: true)
+      @line_index = 0
+      @cursor = -1
+      @snapshots = []
+    end
 
-      def parse
-        return unless File.exist?(@path) && !peek_line.nil?
+    def parse
+      return unless File.exist?(@path) && !peek_line.nil?
 
-        verify_first_header
-        parse_header_template_lines
-        parse_header_snapshot_lines
-        parse_snapshots
+      verify_first_header
+      parse_header_snapshot_lines
+      parse_snapshots
 
-        raise CorruptFormat, " Content remains after parsing." unless peek_line.nil?
-      end
+      raise CorruptFormat, " Content remains after parsing." unless peek_line.nil?
+    end
 
-      def snapshot_count
-        @snapshots.length
-      end
+    def snapshot_count
+      @snapshots.length
+    end
 
-      def add_snapshot(content)
-        last_snapshot = @snapshots[-1]
-        start = last_snapshot&.stop || 3
-        snapshot = Snapshot.new(start, start + content.length)
-        snapshot.content = content
-        last_snapshot&.next_snapshot = snapshot
-        @snapshots.push(snapshot)
-        reset
-      end
+    def add_snapshot(content, name = nil)
+      return if name && update_named_snapshot(name, content)
 
-      def cursor_content
-        @snapshots[@cursor]&.content || []
-      end
+      prev_snapshot = @snapshots[-1]
+      start = prev_snapshot&.stop || 3
+      snapshot = Snapshot.new(start, start + content.length, name)
+      snapshot.content = content
+      prev_snapshot&.next_snapshot = snapshot
+      @snapshots.push(snapshot)
+      reset
+    end
 
-      def remove_cursor_snapshot
-        snapshot = @snapshots[@cursor]
-        return unless snapshot
+    def cursor_content
+      raise InvalidCursorPointer if @cursor.negative? || @cursor > @snapshots.length
 
-        snapshot_before = @snapshots[@cursor - 1]
-        snapshot_before.next_snapshot = snapshot.next_snapshot if snapshot_before
-        @snapshots = @snapshots[0, @cursor].concat(@snapshots[@cursor + 1..])
-        reset
-      end
+      @snapshots[@cursor].content
+    end
 
-      def to_writable_lines
-        [*head_lines, *template_lines, *snapshot_lines]
-      end
+    def snapshot_content_by_name(name)
+      find_named_snapshot(name)&.content
+    end
 
-      def increment_cursor
-        raise InvalidCursorPointer if @cursor + 1 >= @snapshots.length
+    def snapshot_content_by_index(index)
+      raise InvalidCursorPointer if index.negative? || index > @snapshots.length
 
-        @cursor += 1
-      end
+      @cursor = value
+      cursor_content
+    end
 
-      def decrement_cursor
-        raise InvalidCursorPointer if (@cursor - 1).negative?
+    def snapshot_content_backward
+      decrement_cursor
+      cursor_content
+    end
 
-        @cursor -= 1
-      end
+    def snapshot_content_forward
+      increment_cursor
+      cursor_content
+    end
 
-      def cursor=(value)
-        raise InvalidCursorPointer if value.negative? || value > @snapshots.length
+    def remove_cursor_snapshot
+      snapshot = @snapshots[@cursor]
+      return unless snapshot
 
-        @cursor = value
-      end
+      snapshot_before = @snapshots[@cursor - 1]
+      snapshot_before.next_snapshot = snapshot.next_snapshot if snapshot_before
+      @snapshots = @snapshots[0, @cursor].concat(@snapshots[@cursor + 1..])
+      reset
+    end
 
-      def reset
-        @cursor = @snapshots.length - 1
-        @snapshots[0]&.update_start @snapshots.length + 2
-      end
+    def to_writable_lines
+      [*head_lines, *snapshot_lines]
+    end
 
-      private
+    def reset
+      @cursor = @snapshots.length - 1
+      @snapshots[0]&.update_start @snapshots.length + 2
+    end
 
-      def verify_first_header
-        first_line = next_line
-        /\A<\#{6}(?<cursor>-?\d+)\z/ =~ first_line
-        raise CorruptFormat, " Error parsing header" unless cursor
+    def parse_head
+      return unless File.exist?(@path) && !peek_line.nil?
 
-        @cursor = cursor.to_i
-      end
+      verify_first_header
+      parse_header_snapshot_lines
+    end
 
-      def parse_header_template_lines
-        loop do
-          break unless /\A\s*template>(?<name>\w+)>\s*(?<start>\d+)\s*~>\s*(?<stop>\d+)\s*\z/ =~ peek_line
+    private
 
-          next_line
-          @templates.push(Snapshot.new(start.to_i, stop.to_i, name))
-        end
-      end
+    def update_named_snapshot(name, content)
+      snapshot = find_named_snapshot(name)
+      return false unless snapshot
 
-      def parse_header_snapshot_lines
-        loop do
-          line = next_line
-          unless /\A\s*(?<start>\d+)\s*~>\s*(?<stop>\d+)\s*\z/ =~ line
-            break if line == CLOSE_TAG
+      snapshot.content = content
+      reset
+      true
+    end
 
-            raise CorruptFormat
-          end
-          raise CorruptFormat if stop.to_i < start.to_i
+    def find_named_snapshot(name)
+      @snapshots.find { |snapshot| snapshot.name == name }
+    end
 
-          @snapshots.push Snapshot.new(start.to_i, stop.to_i)
-        end
-      end
+    def decrement_cursor
+      raise InvalidCursorPointer if (@cursor - 1).negative?
+
+      @cursor -= 1
+    end
+
+    def increment_cursor
+      raise InvalidCursorPointer if @cursor + 1 >= @snapshots.length
 
-      def parse_snapshots
-        last_snap = nil
-        [*@templates, *@snapshots].each do |snap|
-          raise CorruptFormat, " Wrong indexing in header." if line_index != snap.start
+      @cursor += 1
+    end
+
+    def verify_first_header
+      first_line = next_line
+      /\A<\#{6}(?<cursor>-?\d+)\z/ =~ first_line
+      raise CorruptFormat, " Error parsing header" unless cursor
+
+      @cursor = cursor.to_i
+    end
 
-          snap.content = parse_snap_content(snap)
+    def parse_header_snapshot_lines
+      loop do
+        line = next_line
+        unless /\A\s*(?<name>\w*>)?\s*(?<start>\d+)\s*~>\s*(?<stop>\d+)\s*\z/ =~ line
+          break if line == CLOSE_TAG
 
-          last_snap&.next_snapshot = snap
-          last_snap = snap
+          raise CorruptFormat, "Unknow format found."
         end
-      end
+        raise CorruptFormat, "Start index cannot be larger than stop." if stop.to_i < start.to_i
 
-      def parse_snap_content(snap)
-        result = []
-        (snap.stop - snap.start).times { result.push next_line }
-        result
+        @snapshots.push Snapshot.new(start.to_i, stop.to_i, name&.chomp(">"))
       end
+    end
 
-      def next_line
-        @line_index += 1
-        @iterator.next
-      rescue StopIteration
-        raise CorruptFormat, " No content to parse."
-      end
+    def parse_snapshots
+      last_snap = nil
+      [*@snapshots].each do |snap|
+        raise CorruptFormat, " Wrong indexing in header." if line_index != snap.start
 
-      def peek_line
-        @iterator.peek
-      rescue StopIteration
-        nil
-      end
+        snap.content = parse_snap_content(snap)
 
-      def head_lines
-        [
-          "#{START_TAG}#{cursor}",
-          *@templates.map { |template| "template>#{template.name}> #{template.start} ~> #{template.stop}" },
-          *@snapshots.map { |snap| "#{snap.start} ~> #{snap.stop}" },
-          CLOSE_TAG
-        ]
+        last_snap&.next_snapshot = snap
+        last_snap = snap
       end
+    end
 
-      def template_lines
-        @templates.map(&:content).flatten
-      end
+    def parse_snap_content(snap)
+      result = []
+      (snap.stop - snap.start).times { result.push next_line }
+      result
+    end
 
-      def snapshot_lines
-        @snapshots.map(&:content).flatten
-      end
+    def next_line
+      @line_index += 1
+      @iterator.next
+    rescue StopIteration
+      raise CorruptFormat, " No content to parse."
+    end
 
-      # Snapshot for each file
-      class Snapshot
-        attr_reader :start, :stop, :name, :content
-        attr_accessor :next_snapshot
+    def peek_line
+      @iterator.peek
+    rescue StopIteration
+      nil
+    end
 
-        def initialize(start, stop, name = nil)
-          @start = start
-          @stop = stop
-          @name = name
-        end
+    def head_lines
+      [
+        "#{START_TAG}#{cursor}",
+        *@snapshots.map { |snap| "#{snap.name ? "#{snap.name}>" : ""}#{snap.start} ~> #{snap.stop}" },
+        CLOSE_TAG
+      ]
+    end
 
-        def content=(value)
-          @content = value
-          update_stop
-        end
+    def snapshot_lines
+      @snapshots.map(&:content).flatten
+    end
 
-        def update_start(new_start)
-          @start = new_start
-          update_stop
-        end
+    # Snapshot for each file
+    class Snapshot
+      attr_reader :start, :stop, :name, :content
+      attr_accessor :next_snapshot
 
-        private
+      def initialize(start, stop, name = nil)
+        @start = start
+        @stop = stop
+        @name = name
+      end
 
-        def update_stop
-          @stop = start + content.length
-          next_snapshot&.update_start @stop
-        end
+      def content=(value)
+        @content = value
+        update_stop
+      end
+
+      def update_start(new_start)
+        @start = new_start
+        update_stop
+      end
+
+      private
+
+      def update_stop
+        @stop = start + content.length
+        next_snapshot&.update_start @stop
       end
     end
   end

data/lib/fileverse/version.rb

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

data/lib/fileverse.rb

@@ -7,12 +7,6 @@ require_relative "fileverse/parser"
 require_relative "fileverse/previewer"
 
 # Parent module
-module Fileverse
-  def self.create_hidden_file(path)
-    File.open(path, "w") do |writer|
-      writer.write(inital_header)
-    end
-  end
-end
+module Fileverse; end
 
 require_relative "fileverse/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fileverse
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Unegbu Kingsley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-04-02 00:00:00.000000000 Z
+date: 2025-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -49,6 +49,7 @@ files:
 - lib/fileverse/parser.rb
 - lib/fileverse/previewer.rb
 - lib/fileverse/version.rb
+- sample.gif
 - sig/fileverse.rbs
 homepage: https://github.com/urchmaney/fileverse
 licenses: