backup_paradise 1.2.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b048638d75f2f38d8c1d22871cd07d78dbbfe10cf70c4dbdc7285a582f976f85
+  data.tar.gz: 9eb0f5e56e2cc411ce54a0d122b34950fd41d92f849aef1ea489a1a46a9f30a7
+SHA512:
+  metadata.gz: b5cfd3354fba7f9157929001c68c4549d7a5a066af34410300803175d4508d1dc1a510d021e172116c1098c07f06c728d0b198032bb6bd4370a840f6dfbc5035
+  data.tar.gz: b8266dfd1ce3baa92c993afbcff5e549dfc6bdffae3029f8b1a997ad0dba571948836de86499d099293e7169270b4a00673218376208bbce19423b44ee521b72

data/README.md

@@ -0,0 +1,231 @@
+# Backup Paradise
+
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
+[![Gem Version](https://badge.fury.io/rb/backup_paradise.svg)](https://badge.fury.io/rb/backup_paradise)
+
+This project attempts to assist you - and me - in backing up data
+to an **external USB** device.
+
+Do note that the project is currently catering to my own use cases,
+so it may not be very useful to other ruby users. I may make
+adjustments for other ruby users, but this may take some time.
+
+The project is primarily just a fancy **recursive copy** operation,
+but it will do some minor additional notifications on the commandline,
+use colours (if the colours gem has been installed), automatically
+create some log files and even provide some semi-complete ruby-gtk
+bindings. So it is a **recursive copy** script with some add-ons.
+
+The project has **one major goal** and a **few minor goals**. The major
+goal is to be usable as a backup-assistant.
+
+The **minor goals** include:
+
+- Flexibility (to back up only individual files or directories)
+- Notify the user about the status of the backup-operation
+and prior backup-operations
+
+## General usage of the BackupParadise project - backing up data via ruby
+
+For the time being, I have aliased the main executable 
+called **backup_paradise** onto:
+
+    backup_paradise
+
+To then use this, I can do:
+
+    backup_paradise usb1
+    backup_paradise usb2
+    backup_paradise tousb3
+    backup_paradise tousb4
+
+Depending on where the **external USB device** is mounted.
+
+Presently (December 2018) these entries are hardcoded
+towards e. g. <b>/Mount/USB1/</b>, <b>/Mount/USB2/</b> and
+so forth. They can be accessed via shortcuts as well, such
+as "usb1" or "tousb1", without the quotes. See the examples
+listed above.
+
+Other mount points can also be used, although not with a
+convenient shortcut. Have a look at the option
+**--backup-to=/opt/** documented elsewhere in this file.
+
+## Backing up individual directories
+
+If you have a directory called **FOOBAR/**, then you can back
+it up simply by issuing:
+
+    backup_paradise --FOOBAR
+    backup_paradise FOOBAR
+
+Whichever variant you prefer. Note that this requires that the
+external device has been mounted already. You can set where
+the device should reside via:
+
+    BackupParadise.set_mounted_path()
+
+Simply pass the directory that you may wish to use for backup
+purpose there.
+
+Note that **class AdvancedBackup** will assume a certain target
+device automatically, tailored to my own system. This is usually
+at **/Mount/USB1** for the first mounted USB device on my
+system.
+
+If you wish to overrule that and use another target, which you
+may most likely want to do, then you can use any of the
+following commandline flags for this:
+
+    backup_paradise --use-this-as-target-for-backup=/opt/
+    backup_paradise --use-this-as-target=/opt/
+    backup_paradise --backup-to=/opt/
+
+In this case **/opt/** would be the target that you use as **source
+directory** for the backup-operation.
+
+If you wish to backup the **/Programs/** hierarchy, should you
+keep an **AppDir layout** on your system, then this commandline
+invocation may be of help:
+
+    backup_paradise --programs-dir
+
+To backup the **/Users/x/STUDIUM/** directory, the following 
+commands are possible:
+
+    backup_paradise --studium-dir
+    backup_paradise --studium-directory
+    backup_paradise --studium
+
+## Log files
+
+The BackupParadise project will try to log as to what has happened,
+since **May 2018**. Several different log files may be created.
+
+If there is more than one log file stored at the target device
+then the current behaviour is to delete all but one log file.
+
+Another log file that may commonly be used is the one
+that targets the file <b>/Depot/Temp/backup.log</b>. This
+will, however had, only work if the directory **/Depot/Temp/** 
+exists, which is the case on my home system. The whole gem here
+is heavily tailored to my own needs - I can adapt it to meet
+other people's wishes if necessary, of course.
+
+The **format** of the log file going into **backup.log** is
+simply how long it took to make the backup, in seconds, and
+the exact date when that particular log file was created. This
+is equal to when the backup-operation happened, too.
+
+## GUI components
+
+Right now the GTK3 version is the most advanced GUI part
+of this project - but it is still very limited. Before I
+can improve it, I have to update the code I used to 
+maintain gtk2/gtk3 bindings, since some of this is
+broken right now.
+
+You can try to invoke the GUI components from the commandline,
+possibly via any of the following flags:
+
+   advanced_backup --gui
+   backup_paradise --GUI
+   backup_paradise --gui
+
+## Miscellaneous comments
+
+The **BackupParadise** project has been rewritten a few times already
+over the years.
+
+In the past there was an instance variable in class AdvancedBackup
+called **@last_backup_directory**, which was pointing to an absolute
+path such as **/Mount/USB1/last_backup-13.08.2018-21:11:15/**. It is
+no longer in use, but I keep it as a reference hint to myself - who
+knows what may be changed in the future.
+
+## Specific examples
+
+This subsection details some invocation examples in a short way.
+
+Some of these will only work on my home system for the time being,
+until I have sufficiently changed the project to allow more 
+flexibility in this regard.
+
+Backup all audio-files to **/opt/**:
+
+    backup_paradise --backup-to=/opt/ --audio-dir
+
+Backup all relevant entries into the default chroot target (on
+my home system):
+
+    backup_paradise --chroot
+
+## How I make use of this project
+
+I make use of the **advanced_backup** project to back up relevant
+data on my home system. For example, all source-archives that
+are registered in the RBT project I also keep locally. Then
+there is my ruby code, other files, and possibly the largest
+share these days are books in .pdf format. These are simpler
+to keep about rather than having lots of hardcopy-paper
+books.
+
+In September 2020, the regular backup size was **54G** per
+backup-action. This is too much, in my opinion, because 
+it takes about half an hour or so to back up on USB 2.0.
+I will have to keep reducing file size and removing stuff
+that I no longer need; aka do some clean-up. At any rate,
+this subsection shows just a bit how I may use the project.
+
+My usual go-to alias is:
+
+    rbackup usb1
+
+to backup to the mount point /Mount/USB1.
+
+## class BackupParadise::AdvancedBackup
+
+This class is the main interface for the BackupParadise project.
+
+For a list of documented options, pass in **--help**.
+
+A few examples will be mentioned here as well, in a succinct
+manner:
+
+    rbackup --pwd # backup into the current working directory
+
+## The configuration file
+
+The **BackupParadise project** comes with a small configuration file,
+called **config.yml**. This is optional, though - it it does
+not exist then the project will ignore this file completely.
+
+Presently (at the least since as of **December 2018**), that
+configuration file specifies only the following **three
+configuration settings**:
+
+    use_this_program_to_rename_tabs: String
+    show_popup_notification: Boolean
+    use_system_cp: Boolean
+
+More options may be added in the future, but I will try to only
+add options that make sense, rather than overwhelm users with
+lots of configuration options.
+
+
+## Contact information
+
+If your creative mind has ideas and specific suggestions to make this
+gem more useful in general, feel free to drop me an email at any
+time, via:
+
+    shevegen@gmail.com
+
+(Do keep in mind that responding to emails may take some time, depending
+on the amount of work I may have at that moment, due to reallife. I will,
+however had, read feedback. Patches and code changes are welcome too
+of course, as long as they are in the spirit of the project at
+hand, e. g. fitting to the general theme.)
+
+Thank you.

data/backup_paradise.gemspec

@@ -0,0 +1,51 @@
+# =========================================================================== #
+# Gemspec for Project BackupParadise.
+# =========================================================================== #
+require 'backup_paradise/version/version.rb'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'backup_paradise'
+  s.version = BackupParadise::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+  
+  DESCRIPTION = <<-EOF
+
+This project can be used for backup-related tasks, although it is
+primarily adjusted to my own personal use cases, so it may not
+be of much use to other ruby users. Still - in the event that someone
+wants to give it a try or re-use existing ideas for inspiration,
+feel free to have a look at it.
+
+For more documentation have a look at the official
+homepage, at:
+
+    https://www.rubydoc.info/gems/backup_paradise/
+
+  EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  s.extra_rdoc_files = %w()
+
+  s.executables = Dir['bin/*'].map { |f| File.basename(f) }
+
+  s.authors   = ['Robert A. Heiler']
+  s.email     = 'shevegen@gmail.com'
+  s.files     = Dir['**/*']
+  s.license   = 'GPL-2.0'
+  s.homepage  = 'http://rubygems.org/gems/backup_paradise'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  s.add_dependency 'colours'
+  s.add_dependency 'convert_global_env'
+  s.add_dependency 'mountpoints'
+  s.add_dependency 'opn'
+  s.add_dependency 'roebe'
+  s.add_dependency 'save_file'
+
+}

data/bin/backup_paradise

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'backup_paradise'
+
+BackupParadise::AdvancedBackup.new(ARGV)

data/doc/README.gen

@@ -0,0 +1,214 @@
+# Backup Paradise
+
+ADD_RUBY_HEADER
+
+This project attempts to assist you - and me - in backing up data
+to an **external USB** device.
+
+Do note that the project is currently catering to my own use cases,
+so it may not be very useful to other ruby users. I may make
+adjustments for other ruby users, but this may take some time.
+
+The project is primarily just a fancy **recursive copy** operation,
+but it will do some minor additional notifications on the commandline,
+use colours (if the colours gem has been installed), automatically
+create some log files and even provide some semi-complete ruby-gtk
+bindings. So it is a **recursive copy** script with some add-ons.
+
+The project has **one major goal** and a **few minor goals**. The major
+goal is to be usable as a backup-assistant.
+
+The **minor goals** include:
+
+- Flexibility (to back up only individual files or directories)
+- Notify the user about the status of the backup-operation
+and prior backup-operations
+
+## General usage of the BackupParadise project - backing up data via ruby
+
+For the time being, I have aliased the main executable 
+called **backup_paradise** onto:
+
+    backup_paradise
+
+To then use this, I can do:
+
+    backup_paradise usb1
+    backup_paradise usb2
+    backup_paradise tousb3
+    backup_paradise tousb4
+
+Depending on where the **external USB device** is mounted.
+
+Presently (December 2018) these entries are hardcoded
+towards e. g. <b>/Mount/USB1/</b>, <b>/Mount/USB2/</b> and
+so forth. They can be accessed via shortcuts as well, such
+as "usb1" or "tousb1", without the quotes. See the examples
+listed above.
+
+Other mount points can also be used, although not with a
+convenient shortcut. Have a look at the option
+**--backup-to=/opt/** documented elsewhere in this file.
+
+## Backing up individual directories
+
+If you have a directory called **FOOBAR/**, then you can back
+it up simply by issuing:
+
+    backup_paradise --FOOBAR
+    backup_paradise FOOBAR
+
+Whichever variant you prefer. Note that this requires that the
+external device has been mounted already. You can set where
+the device should reside via:
+
+    BackupParadise.set_mounted_path()
+
+Simply pass the directory that you may wish to use for backup
+purpose there.
+
+Note that **class AdvancedBackup** will assume a certain target
+device automatically, tailored to my own system. This is usually
+at **/Mount/USB1** for the first mounted USB device on my
+system.
+
+If you wish to overrule that and use another target, which you
+may most likely want to do, then you can use any of the
+following commandline flags for this:
+
+    backup_paradise --use-this-as-target-for-backup=/opt/
+    backup_paradise --use-this-as-target=/opt/
+    backup_paradise --backup-to=/opt/
+
+In this case **/opt/** would be the target that you use as **source
+directory** for the backup-operation.
+
+If you wish to backup the **/Programs/** hierarchy, should you
+keep an **AppDir layout** on your system, then this commandline
+invocation may be of help:
+
+    backup_paradise --programs-dir
+
+To backup the **/Users/x/STUDIUM/** directory, the following 
+commands are possible:
+
+    backup_paradise --studium-dir
+    backup_paradise --studium-directory
+    backup_paradise --studium
+
+## Log files
+
+The BackupParadise project will try to log as to what has happened,
+since **May 2018**. Several different log files may be created.
+
+If there is more than one log file stored at the target device
+then the current behaviour is to delete all but one log file.
+
+Another log file that may commonly be used is the one
+that targets the file <b>/Depot/Temp/backup.log</b>. This
+will, however had, only work if the directory **/Depot/Temp/** 
+exists, which is the case on my home system. The whole gem here
+is heavily tailored to my own needs - I can adapt it to meet
+other people's wishes if necessary, of course.
+
+The **format** of the log file going into **backup.log** is
+simply how long it took to make the backup, in seconds, and
+the exact date when that particular log file was created. This
+is equal to when the backup-operation happened, too.
+
+## GUI components
+
+Right now the GTK3 version is the most advanced GUI part
+of this project - but it is still very limited. Before I
+can improve it, I have to update the code I used to 
+maintain gtk2/gtk3 bindings, since some of this is
+broken right now.
+
+You can try to invoke the GUI components from the commandline,
+possibly via any of the following flags:
+
+   advanced_backup --gui
+   backup_paradise --GUI
+   backup_paradise --gui
+
+## Miscellaneous comments
+
+The **BackupParadise** project has been rewritten a few times already
+over the years.
+
+In the past there was an instance variable in class AdvancedBackup
+called **@last_backup_directory**, which was pointing to an absolute
+path such as **/Mount/USB1/last_backup-13.08.2018-21:11:15/**. It is
+no longer in use, but I keep it as a reference hint to myself - who
+knows what may be changed in the future.
+
+## Specific examples
+
+This subsection details some invocation examples in a short way.
+
+Some of these will only work on my home system for the time being,
+until I have sufficiently changed the project to allow more 
+flexibility in this regard.
+
+Backup all audio-files to **/opt/**:
+
+    backup_paradise --backup-to=/opt/ --audio-dir
+
+Backup all relevant entries into the default chroot target (on
+my home system):
+
+    backup_paradise --chroot
+
+## How I make use of this project
+
+I make use of the **advanced_backup** project to back up relevant
+data on my home system. For example, all source-archives that
+are registered in the RBT project I also keep locally. Then
+there is my ruby code, other files, and possibly the largest
+share these days are books in .pdf format. These are simpler
+to keep about rather than having lots of hardcopy-paper
+books.
+
+In September 2020, the regular backup size was **54G** per
+backup-action. This is too much, in my opinion, because 
+it takes about half an hour or so to back up on USB 2.0.
+I will have to keep reducing file size and removing stuff
+that I no longer need; aka do some clean-up. At any rate,
+this subsection shows just a bit how I may use the project.
+
+My usual go-to alias is:
+
+    rbackup usb1
+
+to backup to the mount point /Mount/USB1.
+
+## class BackupParadise::AdvancedBackup
+
+This class is the main interface for the BackupParadise project.
+
+For a list of documented options, pass in **--help**.
+
+A few examples will be mentioned here as well, in a succinct
+manner:
+
+    rbackup --pwd # backup into the current working directory
+
+## The configuration file
+
+The **BackupParadise project** comes with a small configuration file,
+called **config.yml**. This is optional, though - it it does
+not exist then the project will ignore this file completely.
+
+Presently (at the least since as of **December 2018**), that
+configuration file specifies only the following **three
+configuration settings**:
+
+    use_this_program_to_rename_tabs: String
+    show_popup_notification: Boolean
+    use_system_cp: Boolean
+
+More options may be added in the future, but I will try to only
+add options that make sense, rather than overwhelm users with
+lots of configuration options.
+
+ADD_CONTACT_INFORMATION