gitti-backup 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da31fe3c40e34387650d37bac81a8a4c15ce858c
-  data.tar.gz: 595414af6e4655bb6dddc552db194794ac31cb72
+  metadata.gz: 98528e760c07a1b0d66ddd120073ef829bce821a
+  data.tar.gz: b9e5e7e4c2cb3d88cac33b00874274623fb34a29
 SHA512:
-  metadata.gz: 3881867d7f7513f4af361c9a15b96092ce026ed122055d960ef24f3158f777b293dda7a01c1819bf6fee6673060639c29d1720d761ee43ad7a5734d0ba7de312
-  data.tar.gz: e4d6a6066aebdc6e12b2ddaeac156583b78bdba87fac097d80fb2875ef7b5c37983d76b8c730f7772530aa07f1e08a85f306b0ee83929c56cdcb0edaecb893a0
+  metadata.gz: 88be2d1aef4b657bdc49ea048c72cdd5fdaf1fcb39555302d19c7db118550597a64a1e83b8ff88a3d8114d26973f0b5da272e840d8ebc9f1eb379b05fcbdff8d
+  data.tar.gz: 2e51ed36028c50f21419bada59e72fed01d7e564a5a42c621073f2e42f128fe2a9fa257849be5253e479d88f73eaa109075aae3c1522d0b4a56b5e9e9f2f8a32

data/Manifest.txt

@@ -2,6 +2,7 @@ CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
+bin/backup
 lib/gitti/backup.rb
 lib/gitti/backup/backup.rb
 lib/gitti/backup/base.rb

data/README.md

@@ -8,8 +8,70 @@ gitti-backup gem - (yet) another (lite) git backup command line script
 * rdoc  :: [rubydoc.info/gems/gitti-backup](http://rubydoc.info/gems/gitti-backup)
 
 
+
 ## Usage
 
+### `backup` Command Line Tool
+
+Use the `backup` command line tool to backup all repos listed in a "manifest" file (e.g. `repos.yml`, `code.yml`, `github.yml` or such). Example:
+
+```
+backup repos.yml             # or
+backup code.yml data.yml
+```
+
+In a nutshell backup will backup all repos by using
+1. `git clone --mirror` or
+2. `git remote update`  (if the local backup already exists)
+and store all bare repos (without workspace) in the `~/backup` directory.
+
+
+#### Repos Manifest
+
+For now only github repos are supported listed by
+owner / organization. Example `repos.yml`:
+
+``` yaml
+sportdb:
+- sport.db
+- sport.db.sources
+- football.db
+
+yorobot:
+- cache.csv
+- sport.db.more
+- football.db
+- football.csv
+
+openfootball:
+- leagues
+- clubs
+```
+
+Using `backup` with defaults this will result in:
+
+```
+~/backup
+   /sportdb
+      /sport.db.git
+      /sport.db.sources.git
+      /football.db.git
+   /yorobot
+      /cache.csv.git
+      /sport.db.more.git
+      /football.db.git
+      /football.csv.git
+   /openfootball
+      /leagues.git
+      /clubs.git
+```
+
+
+
+### Scripting
+
+You can script your backup in ruby. Example:
+
 
 ``` ruby
 require 'gitti/backup'
@@ -23,6 +85,21 @@ backup = GitBackup.new
 backup.backup( GitRepoSet.read( './repos.yml' ) )
 ```
 
+or
+
+``` ruby
+require 'gitti/backup'
+
+## step 1: setup the root backup directory
+##   1) use custom directory e.g. /backups
+##   2) auto-add a daily directory e.g. /backups/2020-09-27
+backup = GitBackup.new( '/backups', daily: true )
+
+backup.backup( GitRepoSet.read( './repos.yml' ) )
+```
+
+
+
 That's all for now.
 
 

data/bin/backup

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/backup
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/backup
+#
+
+require 'gitti/backup/base'
+
+Gitti::GitBackup::Tool.main

data/lib/gitti/backup/backup.rb

@@ -4,16 +4,35 @@ module Gitti
 
 class GitBackup
 
-  def initialize( root= '~/backup' )
+  class Tool   ## nested class
+    def self.main( args=ARGV )
+      backup = GitBackup.new
+      args.each do |arg|
+        backup.backup( GitRepoSet.read( arg ))
+      end
+    end
+  end ## nested class Tool
+
+
+
+  def initialize( root= '~/backup', daily: false )
     @root = File.expand_path( root )
     pp @root
 
     ## use current working dir for the log path; see do_with_log helper for use
     @log_path = File.expand_path( '.' )
     pp @log_path
+
+    @daily = daily
   end
 
 
+  ##  auto-add "daily" date folder / dir
+  ##    e.g. 2015-11-20 using Date.today.strftime('%Y-%m-%d')
+  def daily=(value) @daily=value; end
+
+
+
   def backup( repos )
     count_orgs  = 0
     count_repos = 0
@@ -21,7 +40,8 @@ class GitBackup
     total_repos  = repos.size
 
     ##  default to adding folder per day ## e.g. 2015-11-20
-    backup_path = "#{@root}/#{Date.today.strftime('%Y-%m-%d')}"
+    backup_path = "#{@root}"
+    backup_path <<  "/#{Date.today.strftime('%Y-%m-%d')}"  if @daily
     pp backup_path
 
     FileUtils.mkdir_p( backup_path )   ## make sure path exists

data/lib/gitti/backup/version.rb

@@ -3,7 +3,7 @@ module GittiBackup
 
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
   MINOR = 4
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitti-backup
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Gerald Bauer
@@ -54,7 +54,8 @@ dependencies:
         version: '3.16'
 description: gitti-backup - (yet) another (lite) git backup command line script
 email: ruby-talk@ruby-lang.org
-executables: []
+executables:
+- backup
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
@@ -65,6 +66,7 @@ files:
 - Manifest.txt
 - README.md
 - Rakefile
+- bin/backup
 - lib/gitti/backup.rb
 - lib/gitti/backup/backup.rb
 - lib/gitti/backup/base.rb