fileverse 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 202c582c5236ee0e4b32a6bb4dbf1d41481f95105ebed2ba6ee4a513d9418ffd
+  data.tar.gz: 1872caba0bcc0529dc7e28c47292931968713d50556ce0ba759453527aa72542
+SHA512:
+  metadata.gz: 4586d70ff46c42133741962c33ea9330bbf4cba10b75f58d5b27aa467c55a4a0470900c38c92cbc237604dc016b5cc99c877631cf33f316ecab1d33a13d959cf
+  data.tar.gz: a5979631dbef6fd0eee5950beca5947774f9efe3212870df45ebb84c6b3c0b8b8c73930cb57f5a8be73ce7423cad8115a8a69247f5be99430e3f8958cabe503b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Unegbu Kingsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Fileverse
+
+A simple ruby cli tool for keeping different versions of a file.
+
+## Installation
+
+    $ gem install fileverse
+
+## Usage
+
+    $ fileverse {file_path} {command} {options}
+
+## Commands / Shortcuts
+    - snap                          {file_path}             (s)
+    - preview       --<<            {file_path}             (p)
+    - preview       -->>            {file_path}             (p)
+    - preview       --name=""       {file_path}             (p)
+    - preview       --index=0       {file_path}             (p)
+    - reset                         {file_path}             (x)
+    - snapshots                     {file_path}             (c)
+    - restore                       {file_path}             (r)
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/urchmaney/fileverse. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/fileverse/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fversion project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fversion/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/fileverse

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "fileverse"
+
+Fileverse::CLI.start

data/lib/fileverse/cli.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Fileverse
+  # CLI class
+  class CLI < Thor
+    desc "snap file content", "store current file content"
+    def snap(path)
+      parser, full_hidden_path = parser_and_hidden_path path
+      parser.parse
+      parser.add_snapshot(Files.read(path))
+      Files.wrie_content(path)
+      Files.wrie_content(full_hidden_path, parser.to_writable_lines)
+    end
+    map "s" => "snap"
+
+    desc "restore content", "restore content in the current cursor"
+    def restore(path)
+      parser, full_hidden_path = parser_and_hidden_path path
+      parser.parse
+      Files.wrie_content(path, parser.cursor_content)
+      parser.remove_cursor_snapshot
+      Files.wrie_content(full_hidden_path, parser.to_writable_lines)
+    end
+    map "r" => "restore"
+
+    # desc "preview snapshot", "preview snapshot at different index or name"
+    # def preview(path)
+
+    # end
+    # map "p" => "preview"
+
+    private
+
+    def parser_and_hidden_path(path)
+      full_hidden_path = Files.expand_hidden_path(path)
+      parser = Parser::Header.new(full_hidden_path)
+      [parser, full_hidden_path]
+    end
+  end
+end

data/lib/fileverse/errors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Fileverse
+  class Error < StandardError; end
+
+  # File not found error
+  class FileNotFoundError < StandardError
+    def initialize(file)
+      super("Could not find file: #{file}")
+    end
+  end
+
+  # Error for corrupt config file
+  class CorruptFormat < StandardError
+    def initialize(section = nil)
+      super("The configuration file is corrupt.#{section}")
+    end
+  end
+end

data/lib/fileverse/files.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Fileverse
+  module Files # rubocop:disable Style/Documentation
+    module_function
+
+    def expand_hidden_path(path)
+      path = File.join(File.dirname(path), ".verse.#{File.basename(path)}")
+      File.expand_path path, Dir.pwd
+    end
+
+    def read(path)
+      full_path = File.expand_path path, Dir.pwd
+      File.readlines(full_path)
+    end
+
+    def wrie_content(path, content = [])
+      full_path = File.expand_path path, Dir.pwd
+      File.open(full_path, "w") { |file| file.puts content }
+    end
+  end
+end

data/lib/fileverse/parser.rb

@@ -0,0 +1,241 @@
+# 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
+
+      def parse
+        return if @iterator.size.zero? # rubocop:disable Style/ZeroLengthPredicate
+
+        verify_first_header
+        parse_header_template_lines
+        parse_header_snapshot_lines
+        parse_snapshots
+
+        raise CorruptFormat, " Content remains after parsing." unless peek_line.nil?
+      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_cursor
+      end
+
+      def cursor_content
+        @snapshots[@cursor]&.content
+      end
+
+      def remove_cursor_snapshot
+        snapshot = @snapshots[@cursor]
+        return unless snapshot
+
+        snapshot_before = @snapshots[@cursor - 1]
+        snapshot_before.next_snapshot = snapshot.next_snapshot if snapshot_before
+        @snapshots = @snapshots[0, @cursor].concat(@snapshots[@cursor + 1..])
+      end
+
+      def to_writable_lines
+        [*head_lines, *template_lines, *snapshot_lines]
+      end
+
+      private
+
+      def reset_cursor
+        @cursor = @snapshots.length - 1
+      end
+
+      def verify_first_header
+        first_line = next_line
+        /\A<\#{6}(?<cursor>\d+)\z/ =~ first_line
+        raise CorruptFormat unless cursor
+
+        @cursor = cursor.to_i
+      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
+
+          next_line
+          @templates.push(Snapshot.new(start.to_i, stop.to_i, name))
+        end
+      end
+
+      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
+
+            raise CorruptFormat
+          end
+          raise CorruptFormat if stop.to_i < start.to_i
+
+          @snapshots.push Snapshot.new(start.to_i, stop.to_i)
+        end
+      end
+
+      def parse_snapshots
+        last_snap = nil
+        [*@templates, *@snapshots].each do |snap|
+          raise CorruptFormat, " Wrong indexing in header." if line_index != snap.start
+
+          snap.content = parse_snap_content(snap)
+
+          last_snap&.next_snapshot = snap
+          last_snap = snap
+        end
+      end
+
+      def parse_snap_content(snap)
+        result = []
+        (snap.stop - snap.start).times { result.push next_line }
+        result
+      end
+
+      def next_line
+        @line_index += 1
+        @iterator.next
+      rescue StopIteration
+        raise CorruptFormat, " No content to parse."
+      end
+
+      def peek_line
+        @iterator.peek
+      rescue StopIteration
+        nil
+      end
+
+      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
+        ]
+      end
+
+      def template_lines
+        @templates.map(&:content).flatten
+      end
+
+      def snapshot_lines
+        @snapshots.map(&:content).flatten
+      end
+
+      # Snapshot for each file
+      class Snapshot
+        attr_reader :start, :stop, :name, :content
+        attr_accessor :next_snapshot
+
+        def initialize(start, stop, name = nil)
+          @start = start
+          @stop = stop
+          @name = name
+        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
+  end
+end

data/lib/fileverse/previewer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "English"
+
+module Fileverse
+  # Previewer parses the main file to check if there is preview content
+  # and parse it if there is.
+  class Previewer
+    PREVIEW_HEAD = "=============SNAPSHOT============"
+    PREVIEW_FOOTER = "=================================="
+
+    attr_accessor :preview_content
+
+    def initialize(path)
+      @path = path
+      @main_content = []
+      @preview_content = []
+    end
+
+    def parse
+      content = File.read @path
+      # match = /#{TEMPLATE_HEAD}?(.*)#{TEMPLATE_FOOTER}?(.*)/ =~ conent
+      match = /(#{PREVIEW_HEAD})?(?(1)(.*)(#{PREVIEW_FOOTER})(.*)|(.*))/m =~ content
+      raise CorruptFormat, " Error: Parsing preview content" if match.nil?
+
+      @preview_content = $LAST_MATCH_INFO[2]&.split("\n") || []
+      @main_content = ($LAST_MATCH_INFO[5] || $LAST_MATCH_INFO[4]).split("\n") || []
+    end
+
+    def to_writable_lines
+      [*writable_preview_section, *@main_content]
+    end
+
+    private
+
+    def writable_preview_section
+      return @preview_content if @preview_content.empty?
+
+      [PREVIEW_HEAD, *@preview_content, PREVIEW_FOOTER]
+    end
+  end
+end

data/lib/fileverse/version.rb

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

data/lib/fileverse.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "fileverse/version"
+require_relative "fileverse/errors"
+require_relative "fileverse/files"
+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
+
+require_relative "fileverse/cli"

data/sig/fileverse.rbs

@@ -0,0 +1,4 @@
+module Fversion
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: fileverse
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Unegbu Kingsley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: |-
+  A ruby gem for keeping different versions for a file.
+    Allowing you to specify which version you want to use
+email:
+- kingsobino@gmail.com
+executables:
+- fileverse
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/fileverse
+- lib/fileverse.rb
+- lib/fileverse/cli.rb
+- lib/fileverse/errors.rb
+- lib/fileverse/files.rb
+- lib/fileverse/parser.rb
+- lib/fileverse/previewer.rb
+- lib/fileverse/version.rb
+- sig/fileverse.rbs
+homepage: https://github.com/urchmaney/fileverse
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/urchmaney/fileverse
+  source_code_uri: https://github.com/urchmaney/fileverse
+  changelog_uri: https://github.com/urchmaney/fileverse/changelog.md.
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: A ruby gem for keeping different versions for a file.
+test_files: []