dev_snap 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3ae2f36b440a48ffd92edba27c74f0db21a135be6941cb2ab5fdeffdc7c746a
+  data.tar.gz: f40c68029e2ca16ebec71b6fb9988022c6aa5f91566bc1bc1a8f62fb9ae57cc9
+SHA512:
+  metadata.gz: 428abe9df3c05efad935135553062d224103fbcdfb2fd6aa3e34523f2f49903308e55bcd58ef3da9fe24fe55ae7ebe9a409065451f6a409d6c4ae5c8f3fdef35
+  data.tar.gz: c068a9fc28d2d4199dcb282fe8f9f03c08fc1bb08da04f845585e8445cbb13e30d52d01b5fa480ead9b9489c4728de26562b2c2992991a3e144633dd15224610

data/.rspec

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

data/README.md

@@ -0,0 +1,31 @@
+# DevSnap
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dev_snap`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/dev_snap.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+require 'release/gem'

data/exe/devsnap

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+if ARGV.length == 0
+  STDERR.puts  "devsnap <path>"
+else
+  require_relative '../lib/dev_snap'
+
+  require 'tty/prompt'
+  require 'colorize'
+
+  pmt = TTY::Prompt.new
+  cm = DevSnap::Cli::CliManager.new(pmt)
+  begin
+    cm.parse_argv(ARGV)
+  rescue Exception => ex
+    STDERR.puts "\n Error >> #{ex.message}\n".red
+    STDERR.puts ex.backtrace.join("\n") if ENV['DEVSNAP_BACKTRACE'] == 'true'
+  end
+end

data/lib/dev_snap/cli_manager.rb

@@ -0,0 +1,136 @@
+
+require 'toolrack'
+
+module DevSnap
+  module Cli
+
+    class CliManager
+      include TR::CondUtils
+      include TR::ArgUtils
+
+      callback :pre_processing do |a|
+        derive_action(a)
+      end
+
+      def initialize(pmt)
+        @pmt = pmt
+      end
+
+      def derive_action(a)
+
+        @pmt.puts "\n DevSnap version #{DevSnap::VERSION}".yellow
+        ops = a.first
+
+        case ops.downcase
+        when 'snap-root', 'root'
+          root = action_set_snap_root(a[1..-1])
+          @pmt.puts "\n Snap root is set at : #{root}\n".green
+
+        when 'add', 'a'
+          ws = action_add(a[1..-1]) 
+          @pmt.puts "\n Workspace '#{ws}' is added to monitoring list\n".green
+
+        when 'forget','ignore'
+          action_forget(a[1..-1])
+          @pmt.puts "\n Workspace '#{ws}' is removed from monitoring list\n".yellow
+
+        when 'list', 'l'
+          action_list
+
+        when 'run','r'
+          start, done, duration = action_run
+          @pmt.puts "Run starts on #{start} and ends on #{done}. Took #{duration} seconds"
+
+        else
+          logger.debug "Unknown action '#{ops.downcase}"
+        end
+
+        [true, []]
+
+      end
+
+
+      private
+      def logger
+        DevSnap.logger(:cli_mgr) 
+      end
+
+      def action_run
+        
+        start = Time.now
+        logger.debug "Run started on #{start}"
+        engine.run
+        done = Time.now
+        duration = done-start
+        logger.debug "Run completed on #{done} [#{duration} sec]"
+        [start, done, duration]
+
+      end
+
+      def action_set_snap_root(params)
+
+        fpath = params.first 
+        raise Error, "Snap root is not given" if is_empty?(fpath)
+        fpath = File.expand_path(fpath)
+
+        engine.set_snap_root(fpath) 
+        logger.debug "Snap root points to : #{fpath}"
+        fpath
+      end
+
+      def action_add(params)
+
+        fpath = params.first 
+        raise Error, "Workspace to add not given" if is_empty?(fpath)
+        fpath = File.expand_path(fpath)
+
+        if not engine.is_monitoring?(fpath)
+          engine.monitor(fpath)
+          logger.debug "'#{fpath}' added to monitoring list"
+        else
+          logger.debug "'#{fpath}' already in monitoring list"
+        end
+
+        fpath
+
+      end
+
+      def action_forget(params)
+
+        fpath = params.first 
+        raise Error, "Workspace to forget not given" if is_empty?(fpath)
+        fpath = File.expand_path(fpath)
+
+        if engine.is_monitoring?(fpath)
+          engine.ignore(fpath)
+          logger.debug "'#{fpath}' removed from monitoring list"
+        else
+          logger.debug "'#{fpath}' not in monitoring list. Forget/ignore request is skipped"
+        end
+
+      end
+
+      def action_list
+        list = engine.monitoring_paths
+        @pmt.puts "\n Monitoring List (#{list.length}) : ".blue
+        @pmt.puts " Snap Root : #{engine.snap_root}".blue
+        @pmt.puts
+        cnt = 1
+        engine.monitoring_paths.each do |pa|
+          @pmt.puts " #{cnt}. #{pa}".blue
+          cnt += 1
+        end
+        list
+      end
+
+      def engine
+
+        if @_eng.nil?
+          @_eng = DevSnap::Engine.new
+        end
+        @_eng
+
+      end
+    end
+  end
+end

data/lib/dev_snap/config.rb

@@ -0,0 +1,65 @@
+
+require 'yaml'
+
+module DevSnap
+  
+  class Config
+    include Singleton
+    include TR::CondUtils
+
+    def set_snap_root(root)
+      _config[:snap_root] = root 
+      write
+    end
+
+    def snap_root
+      _config[:snap_root]
+    end
+
+    def add_to_monitor(path)
+      if not_empty?(path)
+        _config[:path] = [] if is_empty?(_config[:path])
+        _config[:path] << path 
+        write
+      end
+    end
+
+    def remove_path(path)
+      if not_empty?(path) and not_empty?(_config[:path])
+        _config[:path].delete(path)
+        write
+      end
+    end
+
+    def monitor_paths
+      _config[:path].nil? ? [] : _config[:path].clone.freeze
+    end
+
+    private
+    def _config
+      if @_config.nil?
+        if File.exist?(config_path)
+          #@_config = YAML.safe_load(File.read(config_path),[Symbol])
+          @_config = YAML.unsafe_load(File.read(config_path))
+        else
+          @_config = {}
+        end
+      end
+      @_config
+    end
+
+    def write
+      File.open(config_path,"w") do |f|
+        f.write YAML.dump(_config)
+      end
+    end
+
+    def config_path
+      pa = File.join(Dir.home,".devsnap","monitor_list.yml")
+      FileUtils.mkdir_p(File.dirname(pa)) if not File.exist?(pa)
+      pa
+    end
+
+  end
+
+end

data/lib/dev_snap/engine.rb

@@ -0,0 +1,60 @@
+
+require_relative 'config'
+require_relative 'snap_repos'
+require_relative 'monitor_workspace'
+
+module DevSnap
+  class Engine
+    include TR::CondUtils
+
+    def set_snap_root(path)
+      config.set_snap_root(path)
+    end
+
+    def snap_root
+      config.snap_root 
+    end
+
+    def monitor(path)
+      config.add_to_monitor(path)
+    end
+
+    def is_monitoring?(path)
+      config.monitor_paths.include?(path)
+    end
+
+    def ignore(path)
+      config.remove_path(path)
+    end
+
+    def monitoring_paths
+      config.monitor_paths
+    end
+
+    def run
+
+      raise Error, "Snap root not given" if is_empty?(config.snap_root)
+
+      config.monitor_paths.each do |pa|
+        begin
+          sr = SnapRepos.new(config.snap_root, File.basename(pa))
+          backPath = sr.init
+          mw = MonitorWorkspace.new(pa, backPath)
+          mw.run
+        rescue Exception => ex
+          logger.error ex
+        end
+      end
+
+    end
+
+    private
+    def config
+      Config.instance
+    end
+
+    def logger
+      DevSnap.logger(:devsnap_eng)
+    end
+  end
+end

data/lib/dev_snap/monitor_workspace.rb

@@ -0,0 +1,116 @@
+
+require 'git_cli'
+#require 'debug'
+
+module DevSnap
+
+  # 
+  # Strong assume it is git workspace
+  #
+  class MonitorWorkspace
+
+    VCSMarker = ".git"
+    DevSnapRepoName = "dev_snap_repos"
+
+    def initialize(root, backupReposPath)
+      @root = root
+      raise Error, "Root does not exist" if not File.exist?(@root)
+
+      @workspace = GitCli::Workspace.new(@root)
+      @backupReposPath = backupReposPath
+    end
+
+    def is_vcs_workspace?
+      @workspace.is_workspace?
+    end
+
+    def run
+
+      if is_vcs_workspace?
+
+        #binding.break
+
+        snapName = ".git_snap"
+        gitBackupName = ".git_prod"
+
+        prodGit = File.join(@root, VCSMarker)
+        prodGitBack = File.join(@root, gitBackupName)
+        snapGit = File.join(@root, snapName)
+
+        # Move .git folder to .git_prod... 
+        logger.debug "Move #{prodGit} to #{prodGitBack}" if DevSnap.is_detail_debug?
+        FileUtils.mv(prodGit, prodGitBack)
+        # no more .git/...
+
+        begin
+          if not File.exist?(snapGit)
+            # init .git/
+            logger.debug "'#{snapGit}' doesn't exist. Init snap git"
+            @workspace.vcs.init(@root)
+            @workspace.add_remote(DevSnapRepoName, @backupReposPath)
+            @workspace.ignore(snapName, gitBackupName)
+            @workspace.commit("Adding backup git into ignore list")
+          else
+            # rename .git.snap/ to .git/
+            logger.debug "Rename #{snapGit} to #{prodGit}" if DevSnap.is_detail_debug?
+            FileUtils.mv(snapGit, prodGit)
+          end
+
+          # here, .git = snap git
+
+          if not @workspace.clean?
+            logger.debug "Workspace '#{@workspace.workspace_root}' has changes"
+            if DevSnap.is_detail_debug?
+              logger.debug "Workspace new files : #{@workspace.newFiles}"
+              logger.debug "Workspace modified files : #{@workspace.modFiles}"
+              logger.debug "Workspace staged files : #{@workspace.stgFiles}"
+              logger.debug "Workspace deleted files : #{@workspace.delFiles}"
+              logger.debug "Workspace conflicted files : #{@workspace.cftFiles}"
+            end
+
+            @workspace.add(".")
+            @workspace.commit("Added by DevSnap version #{DevSnap::VERSION} at #{Time.now}")
+
+            if not @workspace.remote_config.keys.include?("dev_snap_repos")
+              @workspace.add_remote(DevSnapRepoName, @backupReposPath)
+            end
+
+            @workspace.push_changes(DevSnapRepoName)
+
+          else
+            logger.debug "[Skipped] Workspace '#{@workspace.workspace_root}' is clean"
+          end
+
+        rescue Exception => ex
+          raise
+
+        ensure
+
+          # before begin block, .git/ already renamed to .git_prod
+          # If there is still .git/, then it must be the snap
+          if File.exist?(prodGit)
+            # rename .git to .git.snap.. no more .git
+            logger.debug "Rename #{prodGit} to #{snapGit}" if DevSnap.is_detail_debug?
+            FileUtils.mv(prodGit, snapGit)
+          end
+
+          # rename .git_prod to .git
+          logger.debug "Move #{prodGitBack} to #{prodGit}" if DevSnap.is_detail_debug?
+          FileUtils.mv(prodGitBack, prodGit)
+
+        end
+
+      else
+        logger.debug "Path '#{@root}' is not a VCS workspace"
+      end
+
+    end
+
+
+    private
+    def logger
+      DevSnap.logger(:mon_ws)
+    end
+
+  end
+end

data/lib/dev_snap/snap_repos.rb

@@ -0,0 +1,35 @@
+
+
+require 'git_cli'
+
+module DevSnap
+  
+  class SnapRepos
+    include TR::CondUtils
+
+    def initialize(root, name)
+      raise Error, "Snap repos root cannot be nil" if root.nil?
+      @root = root
+      FileUtils.mkdir_p(@root) if not File.exist?(@root)
+      @name = name
+    end
+
+    def init
+      target = File.join(@root, @name)
+      if not File.exist?(target)
+        logger.debug "Snap workspace '#{target}' does not exist. Creating new bare workspace"
+        GitCli::Vcs.new.init(target, true)
+      else
+        logger.debug "Snap workspace '#{target}' already exist."
+      end
+      target
+    end
+
+    private
+    def logger
+      DevSnap.logger(:snap_repos)
+    end
+
+  end
+
+end

data/lib/dev_snap/version.rb

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

data/lib/dev_snap.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'toolrack'
+require 'teLogger'
+
+require_relative "dev_snap/version"
+
+require_relative 'dev_snap/engine'
+require_relative 'dev_snap/cli_manager'
+
+module DevSnap
+  include TR::CondUtils
+
+  class Error < StandardError; end
+  # Your code goes here...
+
+  def self.logger(tag = nil, &block)
+    if @_logger.nil?
+      @_logger = TeLogger::Tlogger.new('/home/chris/.devsnap/devsnap.log',5, 500*1024*1024)
+      @_logger.debug "DevSnap version #{DevSnap::VERSION} in action"
+    end
+
+    if block
+      if not_empty?(tag)
+        @_logger.with_tag(tag, &block)
+      else
+        @_logger.with_tag(@_logger.tag, &block)
+      end
+    else
+      if is_empty?(tag)
+        @_logger.tag = :devsnap
+        @_logger
+      else
+        # no block but tag is given? hmm
+        @_logger.tag = tag
+        @_logger
+      end
+    end
+
+  end # def logger
+
+
+  def self.is_detail_debug?
+    ENV["DevSnap_DetailDebug"] == "true"
+  end
+
+end

data/sig/dev_snap.rbs

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

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: dev_snap
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Chris
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: toolrack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: teLogger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: git_cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: release-gem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- chris@antrapol.com
+executables:
+- devsnap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- exe/devsnap
+- lib/dev_snap.rb
+- lib/dev_snap/cli_manager.rb
+- lib/dev_snap/config.rb
+- lib/dev_snap/engine.rb
+- lib/dev_snap/monitor_workspace.rb
+- lib/dev_snap/snap_repos.rb
+- lib/dev_snap/version.rb
+- sig/dev_snap.rbs
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: Development Snapshot - incremental backup utility
+test_files: []