gitti 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cedf4859bb7b5521d3680c64f310f0a3456d1fbb
-  data.tar.gz: 32e27bc777a0381db476082563b466d2438be218
+  metadata.gz: ef8765bec0642f4ee88c23169fffe92f8f0bba1a
+  data.tar.gz: a877ebe7e9bcff04915ed4fcc782dcf2c8000dc3
 SHA512:
-  metadata.gz: 7b23e5ed7a99c1e632b0ccfecc7e9a3afc8aeee943884b72367e354e6829f2360cd3b8ba2f43e3bb8f54467fd262d72d7dcd54b26bfb29b647b7a9a93833c367
-  data.tar.gz: ba2a18948bf92d98d9c4a09396ee95dcd05da757a3ce65aa633438530a43cdc133784054e3755fa72168eaa06c652beedc1aabeb8de73affd6a20b6f4b9c2d12
+  metadata.gz: 683017b302f2becfaa0fb76c6f2dbfecd3e961ef534d8c8b784070a2df90fefc4df38c476d9601ef0d2e0167b2c613adbe781e918520ba15dc2e8e0b33e0ece7
+  data.tar.gz: 41320be67f3b4f4a3dd34bdac9a7ac4a94b21d47012f84be53cb8dee0170c9acc811927c910e985983f724a7d7826fbd36b04f457c31b25c47320733af7ce832

data/Manifest.txt

@@ -4,6 +4,8 @@ README.md
 Rakefile
 lib/gitti.rb
 lib/gitti/base.rb
+lib/gitti/git.rb
+lib/gitti/mirror.rb
 lib/gitti/project.rb
 lib/gitti/reposet.rb
 lib/gitti/version.rb

data/README.md

@@ -1,6 +1,6 @@
 # gitti
 
-gitti gem - (yet) another (lite) git command line wrapper / library
+gitti gem - (yet) another (lite) git command line helper / wrapper
 
 * home  :: [github.com/rubycoco/gitti](https://github.com/rubycoco/gitti)
 * bugs  :: [github.com/rubycoco/gitti/issues](https://github.com/rubycoco/gitti/issues)
@@ -11,7 +11,7 @@ gitti gem - (yet) another (lite) git command line wrapper / library
 
 ## Usage
 
-`Git` • `GitProject`
+`Git` • `GitProject` • `GitMirror`
 
 
 ### `Git` Class
@@ -58,6 +58,17 @@ Git.add_all           ## same as  git --all
 Git.commit( "message" )
 
 Git.files                       ## same as  git ls-tree --full-tree --name-only -r HEAD
+
+Git.check                       ## same as  git fsck
+Git.fsck                        ## alias for check
+Git.checksum                    ## another alias for check
+
+Git.origin           ## same as   git remote show origin
+Git.upstream         ## same as   git remote show upstream
+Git.origin?
+Git.upstream?
+
+
 Git.config( "user.name" )                    ## use --get option
 Git.config( "user.name", show_origin: true ) ## add --show-origin flag
 Git.config( "user.name", show_scope: true )  ## add --show-scope flag
@@ -95,9 +106,28 @@ GitProject.open( "rubycoco/gitti" ) do |proj|
   proj.commit( "message" )
 
   proj.files
+
+  proj.origin
+  proj.upstream
+  proj.origin?
+  proj.upstream?
+end
+```
+
+
+### `GitMirror` Class
+
+Use the `GitMirror` class for existing mirrored (bare) git repo(sitories)
+without workspace. Example:
+
+``` ruby
+GitMirror.open( "rubycoco/gitti.git" ) do |mirror|
+  mirror.update     # sames as  git remote update
 end
 ```
 
+
+
 That's it for now.
 
 

data/Rakefile

@@ -3,9 +3,9 @@ require './lib/gitti/version.rb'
 
 Hoe.spec 'gitti' do
 
-  self.version = Gitti::VERSION
+  self.version = GittiCore::VERSION
 
-  self.summary = 'gitti - (yet) another (lite) git command line wrapper / library'
+  self.summary = 'gitti - (yet) another (lite) git command line helper / wrapper'
   self.description = summary
 
   self.urls    = { home: 'https://github.com/rubycoco/gitti' }

data/lib/gitti.rb

@@ -1,44 +1,7 @@
-require 'pp'
-require 'time'
-require 'date'    ## e.g. Date.today etc.
-require 'yaml'
-require 'json'
-require 'uri'
-require 'net/http'
-require "net/https"
-require 'open3'
-require 'fileutils'    ## e.g. FileUtils.mkdir_p etc.
+require_relative 'gitti/base'
 
+## note: auto include Gitti; for "modular" version use ("Sinatra-style")
+##         require "gitti/base"
 
+include Gitti
 
-# our own code
-require 'gitti/version'   # note: let version always go first
-require 'gitti/base'
-require 'gitti/project'
-require 'gitti/reposet'
-
-
-
-module Gitti
-## todo: change to GitHubRepoRef or GitHubProject
-##   or Git::GitHub or Git::Source::GitHub or such - why? why not?
-class GitHubRepo
-  attr_reader :owner, :name
-
-  def initialize( owner, name )
-    @owner = owner    ## use/rename to login or something - why? why not??
-    @name  = name     #  e.g. "rubylibs/webservice"
-  end
-
-  def ssh_clone_url
-     ##  check: use https: as default? for github - http:// still supported? or redirected?
-     ## "http://github.com/#{@owner}/#{@name}"
-     "git@github.com:#{@owner}/#{@name}.git"
-  end
-end   ## class GitHubRepo
-end   ## module Gitti
-
-
-
-# say hello
-puts Gitti.banner      ## if defined?( $RUBYCOCO_DEBUG )

data/lib/gitti/base.rb

@@ -1,220 +1,57 @@
-module Gitti
-
-## raised by Git::Shell.run -- check if top-level ShellError alread exists?
-##   use ShellError or RunError - why? why not?
-##   and make Git::Shell top-level e.g. Shell - why? why not?
-class GitError < StandardError
-end
-
-
-class Git   ## make Git a module - why? why not?
-
-  ###
-  ## todo/fix:  change opts=nil to *args or such - why? why not?
-
-
-  ###############
-  ## "setup" starter git commands
-
-  def self.clone( repo, name=nil )
-    cmd = "git clone #{repo}"
-    cmd << " #{name}"   unless name.nil? || name.empty?
-    Shell.run( cmd )
-  end
-
-  def self.mirror( repo )
-    cmd = "git clone --mirror #{repo}"
-    Shell.run( cmd )
-  end
-
-
-  #################
-  ## standard git commands
-
-  def self.version
-    cmd = 'git --version'
-    Shell.run( cmd )
-  end
-
-  def self.status( short: false )
-    cmd = 'git status'
-    cmd << " --short"   if short
-    Shell.run( cmd )
-  end
-
-  def self.changes  ## same as git status --short  - keep shortcut / alias - why? why not?
-    ## returns changed files - one per line or empty if no changes
-    cmd = 'git status --short'
-    Shell.run( cmd )
-  end
-
-  #####################
-  ## status helpers
-
-  ## git status --short  returns empty stdout/list
-  def self.clean?()   changes.empty?; end
-
-  def self.changes?() clean? == false; end  ## reverse of clean?
-  class << self
-    alias_method :dirty?, :changes?  ## add alias
-  end
-
-
-  #######
-  ## more (major) git commands
-
-  def self.fetch
-    cmd = 'git fetch'
-    Shell.run( cmd )
-  end
-
-  def self.pull
-    cmd = 'git pull'
-    Shell.run( cmd )
-  end
-
-  def self.fast_forward
-    cmd = 'git pull --ff-only'
-    Shell.run( cmd )
-  end
-  class << self
-    alias_method :ff, :fast_forward   ## add alias
-  end
-
-
-  def self.push
-    cmd = 'git push'
-    Shell.run( cmd )
-  end
-
-  def self.add( pathspec=nil )  ## e.g. git add .  or git add *.rb or such
-    cmd = 'git add'
-    cmd << " #{pathspec}"   unless pathspec.nil? || pathspec.empty?
-    Shell.run( cmd )
-  end
-
-  def self.add_all
-    cmd = 'git add --all'
-    Shell.run( cmd )
-  end
-
-  def self.commit( message )
-    ### todo/check: make message.nil? an ArgumentError - why? why not?
-    ###  if message.nil? || message.empty?
-
-    cmd = 'git commit'
-    cmd << %Q{ -m "#{message}"}
-
-    Shell.run( cmd )
-  end
-
-
-  #############
-  #  change git ls-files to git ls-tree ... - why? why not?
-  ##  - note: git ls-files will include stages files too
-  #                not only committed ones!!!
-  #
-  #  git ls-tree --full-tree --name-only -r HEAD
-  #   1)  --full-tree makes the command run as if you were in the repo's root directory.
-  #   2)  -r recurses into subdirectories. Combined with --full-tree, this gives you all committed, tracked files.
-  #   3)  --name-only removes SHA / permission info for when you just want the file paths.
-  #   4)  HEAD specifies which branch you want the list of tracked, committed files for.
-  #       You could change this to master or any other branch name, but HEAD is the commit you have checked out right now.
-  #
-  #   see https://stackoverflow.com/questions/15606955/how-can-i-make-git-show-a-list-of-the-files-that-are-being-tracked
-  #
-  #  was:
-
-  def self.files  ## was: e.g. git ls-files .  or git ls-files *.rb or such
-    ### todo/check: include --full-tree - why? why not?
-    ##   will ALWAYS list all files NOT depending on (current) working directory
-
-    cmd = 'git ls-tree --full-tree --name-only -r HEAD'  # was:  'git ls-files'
-    Shell.run( cmd )
-  end
-  ## add list_files or ls_files alias - why? why not?
-
-
-  ########
-  ## query git configuration helpers
-  def self.config( prop,
-                   show_origin: false,
-                   show_scope: false )  ## find a better name e.g. config_get? why? why not?
-    cmd = "git config"
-    cmd << " --show-origin"   if show_origin
-    cmd << " --show-scope"    if show_scope
-
-    if prop.is_a?( Regexp )
-      ## note: use Regexp#source
-      ##    Returns the original string of the pattern.
-      ##      e.g. /ab+c/ix.source #=> "ab+c"
-      ##    Note that escape sequences are retained as is.
-      ##    /\x20\+/.source  #=> "\\x20\\+"
-      cmd << " --get-regexp #{prop.source}"
-    else  ## assume string
-      cmd << " --get #{prop}"
-    end
-
-    Shell.run( cmd )
-  end
-
-
-### add more - why? why not?
-##
-## def remote_update( opts={} )   ## e.g. git remote update
-## command "remote update"
-## end
-
-##  todo/check: rename remote to shorthand/shortcut or something or to branch - why, why not??
-## def remote_show( name='origin', opts={})  ## e.g. git remote show origin
-## command "remote show #{name}"
-## end
-
-
-
-
-
-###
-#  use nested class for "base" for running commands - why? why not?
-class Shell
-def self.run( cmd )
-  print "cmd exec >#{cmd}<..."
-  stdout, stderr, status = Open3.capture3( cmd )
-
-  if status.success?
-    print " OK"
-    print "\n"
-  else
-    print " FAIL (#{status.exitstatus})"
-    print "\n"
-  end
-
-  unless stdout.empty?
-    puts stdout
-  end
-
-  unless stderr.empty?
-    ## todo/check: or use >2: or &2: or such
-    ##  stderr output not always an error (that is, exit status might be 0)
-    puts "STDERR:"
-    puts stderr
-  end
-
-  if status.success?
-    stdout   # return stdout string
-  else
-    puts "!! ERROR: cmd exec >#{cmd}< failed with exit status #{status.exitstatus}:"
-    puts stderr
-
-    ### todo/fix:  do NOT use GitError here!!! make it more "general"
-    ###   use a Git::Shell.run() wrapper or such - why? why not?
-    ##   or use a Shell.git() or Shell.git_run() ???
-    ##   or pass in error class - why? why not?
-    raise GitError, "cmd exec >#{cmd}< failed with exit status #{status.exitstatus}<: #{stderr}"
-  end
-end
-end # class Git::Shell
-
-end # class Git
-
-end # module Gitti
+require 'pp'
+require 'time'
+require 'date'    ## e.g. Date.today etc.
+require 'yaml'
+require 'json'
+require 'uri'
+require 'net/http'
+require "net/https"
+require 'open3'
+require 'fileutils'    ## e.g. FileUtils.mkdir_p etc.
+
+
+
+# our own code
+require 'gitti/version'   # note: let version always go first
+require 'gitti/git'
+require 'gitti/project'
+require 'gitti/mirror'
+require 'gitti/reposet'
+
+
+
+module Gitti
+## todo: change to GitHubRepoRef or GitHubProject
+##   or Git::GitHub or Git::Source::GitHub or such - why? why not?
+class GitHubRepo
+  attr_reader :owner, :name
+
+  def initialize( owner, name )
+    @owner = owner    ## use/rename to login or something - why? why not??
+    @name  = name     #  e.g. "rubylibs/webservice"
+  end
+
+
+  def ssh_clone_url
+     ##  check: use https: as default? for github - http:// still supported? or redirected?
+     ## "http://github.com/#{@owner}/#{@name}"
+     "git@github.com:#{@owner}/#{@name}.git"
+  end
+
+  def http_clone_url   ## use clone_url( http: true )  -- why? why not?
+     ##  note: https is default for github - http:// gets redirected to https://
+     "http://github.com/#{@owner}/#{@name}"
+  end
+
+  def https_clone_url
+    "https://github.com/#{@owner}/#{@name}"
+  end
+
+
+end   ## class GitHubRepo
+end   ## module Gitti
+
+
+
+# say hello
+puts GittiCore.banner      ## if defined?( $RUBYCOCO_DEBUG )

data/lib/gitti/git.rb

@@ -0,0 +1,290 @@
+module Gitti
+
+## raised by Git::Shell.run -- check if top-level ShellError alread exists?
+##   use ShellError or RunError - why? why not?
+##   and make Git::Shell top-level e.g. Shell - why? why not?
+class GitError < StandardError
+end
+
+
+class Git   ## make Git a module - why? why not?
+
+  ###
+  ## todo/fix:  change opts=nil to *args or such - why? why not?
+
+
+  ###############
+  ## "setup" starter git commands
+
+  def self.clone( repo, name=nil )
+    cmd = "git clone #{repo}"
+    cmd << " #{name}"   unless name.nil? || name.empty?
+    Shell.run( cmd )
+  end
+
+  ###
+  ## What's the difference between git clone --mirror and git clone --bare
+  ##   see https://stackoverflow.com/questions/3959924/whats-the-difference-between-git-clone-mirror-and-git-clone-bare
+  ##
+  ##  The git clone help page has this to say about --mirror:
+  ##   > Set up a mirror of the remote repository. This implies --bare
+  ##
+  ##  The difference is that when using --mirror, all refs are copied as-is.
+  ##  This means everything: remote-tracking branches, notes, refs/originals/*
+  ## (backups from filter-branch). The cloned repo has it all.
+  ## It's also set up so that a remote update will re-fetch everything from the origin
+  ## (overwriting the copied refs). The idea is really to mirror the repository,
+  ## to have a total copy, so that you could for example host your central repo
+  ## in multiple places, or back it up. Think of just straight-up copying the repo,
+  ## except in a much more elegant git way.
+  ##
+  ## The new documentation pretty much says all this:
+  ##  see https://git-scm.com/docs/git-clone
+  ##
+  ##  --mirror
+  ## Set up a mirror of the source repository. This implies --bare.
+  ##  Compared to --bare, --mirror not only maps local branches of the source
+  ## to local branches of the target, it maps all refs
+  ## (including remote-tracking branches, notes etc.) and sets up a refspec configuration
+  ##  such that all these refs are overwritten by a git remote update
+  ## in the target repository.
+  ##
+  ## More Articles / Resources:
+  ##  https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/duplicating-a-repository
+
+
+  ## add -n  (--no-checkout)   -- needed - why? why not?
+  ## add --no-hardlinks        -- needed/recommended - why? why not?
+
+  def self.mirror( repo )
+    cmd = "git clone --mirror #{repo}"
+    Shell.run( cmd )
+  end
+
+
+  #################
+  ## standard git commands
+
+  def self.version
+    cmd = 'git --version'
+    Shell.run( cmd )
+  end
+
+  def self.status( short: false )
+    cmd = 'git status'
+    cmd << " --short"   if short
+    Shell.run( cmd )
+  end
+
+  def self.changes  ## same as git status --short  - keep shortcut / alias - why? why not?
+    ## returns changed files - one per line or empty if no changes
+    cmd = 'git status --short'
+    Shell.run( cmd )
+  end
+
+  #####################
+  ## status helpers
+
+  ## git status --short  returns empty stdout/list
+  def self.clean?()   changes.empty?; end
+
+  def self.changes?() clean? == false; end  ## reverse of clean?
+  class << self
+    alias_method :dirty?, :changes?  ## add alias
+  end
+
+
+  #######
+  ## more (major) git commands
+
+  def self.fetch
+    cmd = 'git fetch'
+    Shell.run( cmd )
+  end
+
+  def self.pull
+    cmd = 'git pull'
+    Shell.run( cmd )
+  end
+
+  def self.fast_forward
+    cmd = 'git pull --ff-only'
+    Shell.run( cmd )
+  end
+  class << self
+    alias_method :ff, :fast_forward   ## add alias
+  end
+
+
+  def self.push
+    cmd = 'git push'
+    Shell.run( cmd )
+  end
+
+  def self.add( *pathspecs )  ## e.g. git add .  or git add *.rb or such
+    cmd = 'git add'
+    pathspecs = ['.']   if pathspecs.size == 0
+    cmd << " #{pathspecs.join('')}"
+    Shell.run( cmd )
+  end
+
+  def self.add_all
+    cmd = 'git add --all'
+    Shell.run( cmd )
+  end
+
+  def self.commit( message )
+    ### todo/check: make message.nil? an ArgumentError - why? why not?
+    ###  if message.nil? || message.empty?
+
+    cmd = 'git commit'
+    cmd << %Q{ -m "#{message}"}
+
+    Shell.run( cmd )
+  end
+
+
+  #############
+  #  change git ls-files to git ls-tree ... - why? why not?
+  ##  - note: git ls-files will include stages files too
+  #                not only committed ones!!!
+  #
+  #  git ls-tree --full-tree --name-only -r HEAD
+  #   1)  --full-tree makes the command run as if you were in the repo's root directory.
+  #   2)  -r recurses into subdirectories. Combined with --full-tree, this gives you all committed, tracked files.
+  #   3)  --name-only removes SHA / permission info for when you just want the file paths.
+  #   4)  HEAD specifies which branch you want the list of tracked, committed files for.
+  #       You could change this to master or any other branch name, but HEAD is the commit you have checked out right now.
+  #
+  #   see https://stackoverflow.com/questions/15606955/how-can-i-make-git-show-a-list-of-the-files-that-are-being-tracked
+  #
+  #  was:
+
+  def self.files  ## was: e.g. git ls-files .  or git ls-files *.rb or such
+    ### todo/check: include --full-tree - why? why not?
+    ##   will ALWAYS list all files NOT depending on (current) working directory
+
+    cmd = 'git ls-tree --full-tree --name-only -r HEAD'  # was:  'git ls-files'
+    Shell.run( cmd )
+  end
+  ## add list_files or ls_files alias - why? why not?
+
+
+  ########
+  ## query git configuration helpers
+  def self.config( prop,
+                   show_origin: false,
+                   show_scope: false )  ## find a better name e.g. config_get? why? why not?
+    cmd = "git config"
+    cmd << " --show-origin"   if show_origin
+    cmd << " --show-scope"    if show_scope
+
+    if prop.is_a?( Regexp )
+      ## note: use Regexp#source
+      ##    Returns the original string of the pattern.
+      ##      e.g. /ab+c/ix.source #=> "ab+c"
+      ##    Note that escape sequences are retained as is.
+      ##    /\x20\+/.source  #=> "\\x20\\+"
+      cmd << " --get-regexp #{prop.source}"
+    else  ## assume string
+      cmd << " --get #{prop}"
+    end
+
+    Shell.run( cmd )
+  end
+
+
+## git remote update will update all of your branches
+##   set to track remote ones, but not merge any changes in.
+##
+## git fetch --all didn't exist at one time, so git remote update what more useful.
+##  Now that --all has been added to git fetch, git remote update is not really necessary.
+##
+## Differences between git remote update and fetch?
+##  Is git remote update the equivalent of git fetch?
+##   see https://stackoverflow.com/questions/1856499/differences-between-git-remote-update-and-fetch/17512004#17512004
+##
+##  git fetch learned --all and --multiple options,
+##   to run fetch from many repositories,
+##   and --prune option to remove remote tracking branches that went stale.
+##   These make git remote update and git remote prune less necessary
+##    (there is no plan to remove remote update nor remote prune, though).
+  def self.update
+    cmd = 'git remote update'
+    Shell.run( cmd )
+  end
+
+  def self.origin  ## e.g. git remote show origin
+    cmd = "git remote show origin"
+    Shell.run( cmd )
+  end
+
+  def self.upstream  ## e.g. git remote show origin
+    cmd = "git remote show upstream"
+    Shell.run( cmd )
+  end
+
+  def self.origin?
+    puts "todo/fix: check if remote origin is available/exists - how?"
+  end
+
+  def self.upstream?
+    puts "todo/fix: check if remote upstream is available/exists - how?"
+  end
+
+
+  def self.check  ## e.g. git fsck  - check/validate hash of objects
+    cmd = "git fsck"
+    Shell.run( cmd )
+  end
+  class << self
+    alias_method :fsck,     :check   ## add alias
+    alias_method :checksum, :check
+  end
+
+
+
+###
+#  use nested class for "base" for running commands - why? why not?
+class Shell
+def self.run( cmd )
+  print "cmd exec >#{cmd}<..."
+  stdout, stderr, status = Open3.capture3( cmd )
+
+  if status.success?
+    print " OK"
+    print "\n"
+  else
+    print " FAIL (#{status.exitstatus})"
+    print "\n"
+  end
+
+  unless stdout.empty?
+    puts stdout
+  end
+
+  unless stderr.empty?
+    ## todo/check: or use >2: or &2: or such
+    ##  stderr output not always an error (that is, exit status might be 0)
+    puts "STDERR:"
+    puts stderr
+  end
+
+  if status.success?
+    stdout   # return stdout string
+  else
+    puts "!! ERROR: cmd exec >#{cmd}< failed with exit status #{status.exitstatus}:"
+    puts stderr
+
+    ### todo/fix:  do NOT use GitError here!!! make it more "general"
+    ###   use a Git::Shell.run() wrapper or such - why? why not?
+    ##   or use a Shell.git() or Shell.git_run() ???
+    ##   or pass in error class - why? why not?
+    raise GitError, "cmd exec >#{cmd}< failed with exit status #{status.exitstatus}<: #{stderr}"
+  end
+end
+end # class Git::Shell
+
+end # class Git
+
+end # module Gitti

data/lib/gitti/mirror.rb

@@ -0,0 +1,33 @@
+module Gitti
+
+class GitMirror
+  def self.open( path, &blk )
+    new( path ).open( &blk )
+  end
+
+  def self.update( path )    ### all-in-one convenience shortcut
+    new( path).open { |mirror| mirror.update }
+  end
+
+
+
+  def initialize( path )
+    raise ArgumentError, "dir >#{path}< not found; dir MUST already exist for GitMirror class - sorry"   unless Dir.exist?( path )
+    ## todo/check:  check for more dirs and files e.g.
+    ##  /info,/objects,/refs, /hooks, HEAD, config, description -- why? why not?
+    raise ArgumentError, "dir >#{path}/objects< not found; dir MUST already be initialized with git for GitMirror class - sorry"  unless Dir.exist?( "#{path}/objects" )
+    @path = path
+  end
+
+
+  def open( &blk )
+    Dir.chdir( @path ) do
+      blk.call( self )
+    end
+  end
+
+  def update()           Git.update; end
+
+end # class GitMirror
+end # module Gitti
+

data/lib/gitti/project.rb

@@ -35,14 +35,21 @@ class GitProject
 
   def push()                    Git.push; end
 
-  def add( pathspec )           Git.add( pathspec ); end
+  def add( *pathspecs )         Git.add( *pathspecs ); end
   def add_all()                 Git.add_all; end
   def commit( message )         Git.commit( message ); end
 
   def files()                   Git.files; end
 
-  def run( cmd )                Git::Shell.run( cmd ); end
 
+  ### remote show origin|upstream|etc.
+  def origin()                  Git.origin; end
+  def upstream()                Git.upstream; end
+  def origin?()                 Git.origin?; end
+  def upstream?()               Git.upstream?; end
+
+
+  def run( cmd )                Git::Shell.run( cmd ); end
 end # class GitProject
 end # module Gitti
 

data/lib/gitti/reposet.rb

@@ -4,8 +4,9 @@ module Gitti
 
 class GitRepoSet  ## todo: rename to Hash/Dict/List/Map  or use GitHubRepoSet ??
 
-def self.from_file( path )   ## todo/fix: change to self.read - why? why not?
-  hash = YAML.load_file( path )
+def self.read( path )
+  txt  = File.open( path, 'r:utf-8') { |f| f.read }
+  hash = YAML.load( txt )
   new( hash )
 end
 
@@ -14,19 +15,24 @@ def initialize( hash )
   @hash = hash
 end
 
+def size
+  ## sum up total number of repos
+  @size ||=  @hash.reduce(0) {|sum,(_,names)| sum+= names.size; sum }
+end
+
 def each
-  @hash.each do |key_with_counter,values|
+  @hash.each do |org_with_counter,names|
 
     ## remove optional number from key e.g.
     ##   mrhydescripts (3)    =>  mrhydescripts
     ##   footballjs (4)       =>  footballjs
     ##   etc.
 
-    key = key_with_counter.sub( /\s+\([0-9]+\)/, '' )
+    org = org_with_counter.sub( /\([0-9]+\)/, '' ).strip
 
-    puts "  -- #{key_with_counter} [#{key}] --"
+    ## puts "  -- #{key_with_counter} [#{key}] --"
 
-    yield( key, values )
+    yield( org, names )
   end
 end
 

data/lib/gitti/version.rb

@@ -1,7 +1,13 @@
 
-module Gitti
+### note: use a different module for version (meta) info
+###        that is, GittiCore and NOT Gitti
+###       why? do NOT "pollute" Gitti with MAJOR, MINOR, PATH, and
+###                                        self.banner, self.root, etc.
+
+
+module GittiCore    ## todo/check: rename GittiBase or GittiMeta or such - why? why not?
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 3
+  MINOR = 4
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
@@ -16,5 +22,5 @@ module Gitti
   def self.root
     "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
   end
-end # module Gitti
+end # module GittiCore
 

data/test/test_base.rb

@@ -6,7 +6,6 @@ require 'helper'
 
 class TestBase < MiniTest::Test
 
-  include Gitti
 
   def test_git_config
     puts "---"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitti
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2020-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.16'
-description: gitti - (yet) another (lite) git command line wrapper / library
+description: gitti - (yet) another (lite) git command line helper / wrapper
 email: ruby-talk@ruby-lang.org
 executables: []
 extensions: []
@@ -53,6 +53,8 @@ files:
 - Rakefile
 - lib/gitti.rb
 - lib/gitti/base.rb
+- lib/gitti/git.rb
+- lib/gitti/mirror.rb
 - lib/gitti/project.rb
 - lib/gitti/reposet.rb
 - lib/gitti/version.rb
@@ -83,5 +85,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: gitti - (yet) another (lite) git command line wrapper / library
+summary: gitti - (yet) another (lite) git command line helper / wrapper
 test_files: []