gitti 0.4.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef8765bec0642f4ee88c23169fffe92f8f0bba1a
-  data.tar.gz: a877ebe7e9bcff04915ed4fcc782dcf2c8000dc3
+  metadata.gz: 9af5dbeb98c92b61217e79f16a009baea537c068
+  data.tar.gz: '0378847df0d03662f0a7d89d25c51b01ff887ce7'
 SHA512:
-  metadata.gz: 683017b302f2becfaa0fb76c6f2dbfecd3e961ef534d8c8b784070a2df90fefc4df38c476d9601ef0d2e0167b2c613adbe781e918520ba15dc2e8e0b33e0ece7
-  data.tar.gz: 41320be67f3b4f4a3dd34bdac9a7ac4a94b21d47012f84be53cb8dee0170c9acc811927c910e985983f724a7d7826fbd36b04f457c31b25c47320733af7ce832
+  metadata.gz: 2a43608097a13b762821df5a576e8f8346cd684680b1494fce35e0d0b2f3f043ba6ef8e36b931f2eb447b526cab753b62287206eee984f6323c6ee33c0a96c00
+  data.tar.gz: 60aaf0d3ee8c9582ec276a65e700391e1b0f3ae388f2dd53143c30c322218e9c20bf94fa3ee0269952aca453388d0097b747ed33749e44d10a412e951b51a994

data/README.md

@@ -1,150 +1,166 @@
-# gitti
-
-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)
-* gem   :: [rubygems.org/gems/gitti](https://rubygems.org/gems/gitti)
-* rdoc  :: [rubydoc.info/gems/gitti](http://rubydoc.info/gems/gitti)
-
-
-
-## Usage
-
-`Git` • `GitProject` • `GitMirror`
-
-
-### `Git` Class
-
-Use the `Git` class for "low-level / to the metal" git commands
-that run in your current working directory.
-Example:
-
-``` ruby
-
-###############
-## "setup" starter git commands
-
-Git.clone( "git@github.com:rubycoco/gitti.git" )
-Git.clone( "git@github.com:rubycoco/gitti.git", "gitti-clone" )
-
-Git.mirror( "git@github.com:rubycoco/gitti.git" )  ## same as  git clone --mirror
-
-#################
-## standard git commands
-
-Git.version                 ## same as  git --version
-Git.status
-Git.status( short: true )   ## same as Git.changes
-Git.changes                 ## same as  git status --short
-
-#####################
-## status helpers
-
-Git.clean?
-Git.changes?
-Git.dirty?      ## alias for changes?
-
-#######
-## more (major) git commands
-
-Git.fetch
-Git.pull
-Git.fast_forward      ## same as  git pull --ff-only
-Git.ff                ## alias for fast_forward
-Git.push
-Git.add( "pathspec" )
-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
-
-Git.config( /user/ )                     ## use --get-regexp option
-Git.config( /user/, show_origin: true )  ## add --show-origin flag
-Git.config( /user/, show_scope: true )   ## add --show-scope flag
-```
-
-
-
-### `GitProject` Class
-
-Use the `GitProject` class for existing git repo(sitories)
-with workspace. Example:
-
-``` ruby
-GitProject.open( "rubycoco/gitti" ) do |proj|
-  proj.status
-  proj.status( short: true )
-  proj.changes
-  proj.clean?
-  proj.changes?
-  proj.dirty?
-
-  proj.fetch
-  proj.pull
-  proj.fast_forward
-  proj.ff
-
-  proj.push
-
-  proj.add( "pathspec" )
-  proj.add_all
-  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.
-
-
-## Installation
-
-Use
-
-    gem install gitti
-
-or add to your Gemfile
-
-    gem 'gitti'
-
-
-
-## License
-
-The `gitti` scripts are dedicated to the public domain.
-Use it as you please with no restrictions whatsoever.
-
+# gitti
+
+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)
+* gem   :: [rubygems.org/gems/gitti](https://rubygems.org/gems/gitti)
+* rdoc  :: [rubydoc.info/gems/gitti](http://rubydoc.info/gems/gitti)
+
+
+
+## Usage
+
+`Git` • `GitProject` • `GitMirror`
+
+
+### `Git` Class
+
+Use the `Git` class for "low-level / to the metal" git commands
+that run in your current working directory.
+Example:
+
+``` ruby
+
+###############
+## "setup" starter git commands
+
+Git.clone( "https://github.com/rubycoco/gitti.git" )
+Git.clone( "https://github.com/rubycoco/gitti.git", "gitti-clone" )
+# -or-    -- if you have write / commit access use ssh
+Git.clone( "git@github.com:rubycoco/gitti.git" )
+Git.clone( "git@github.com:rubycoco/gitti.git", "gitti-clone" )
+
+Git.mirror( "https://github.com/rubycoco/gitti.git" )  ## same as  git clone --mirror
+
+#################
+## standard git commands
+
+Git.version                 ## same as  git --version
+Git.status
+Git.status( short: true )   ## same as Git.changes
+Git.changes                 ## same as  git status --short
+
+#####################
+## status helpers
+
+Git.clean?
+Git.changes?
+Git.dirty?      ## alias for changes?
+
+#######
+## more (major) git commands
+
+Git.fetch
+Git.pull
+Git.fast_forward      ## same as  git pull --ff-only
+Git.ff                ## alias for fast_forward
+Git.push
+Git.add( "pathspec" )
+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.master?          ## on master branch
+Git.main?            ## on main branch
+
+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
+
+Git.config( /user/ )                     ## use --get-regexp option
+Git.config( /user/, show_origin: true )  ## add --show-origin flag
+Git.config( /user/, show_scope: true )   ## add --show-scope flag
+```
+
+
+
+### `GitProject` Class
+
+Use the `GitProject` class for existing git repo(sitories)
+with workspace. Example:
+
+``` ruby
+GitProject.open( "rubycoco/gitti" ) do |proj|
+  proj.status
+  proj.status( short: true )
+  proj.changes
+  proj.clean?
+  proj.changes?
+  proj.dirty?
+
+  proj.fetch
+  proj.pull
+  proj.fast_forward
+  proj.ff
+
+  proj.push
+
+  proj.add( "pathspec" )
+  proj.add_all
+  proj.commit( "message" )
+
+  proj.files
+
+  proj.master?
+  proj.main?
+
+  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.
+
+
+
+## Real World Usage
+
+The [`monos`](https://github.com/rubycoco/monos) gem incl. some monorepo / mono source tree tools and (startup) scripts
+that let you run git commands on multiple repos.
+
+
+
+## Installation
+
+Use
+
+    gem install gitti
+
+or add to your Gemfile
+
+    gem 'gitti'
+
+
+
+## License
+
+The `gitti` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+

data/Rakefile

@@ -17,12 +17,13 @@ Hoe.spec 'gitti' do
   self.readme_file  = 'README.md'
   self.history_file = 'CHANGELOG.md'
 
-  self.extra_deps = []
+  self.extra_deps = [
+    ['shell-lite', '>= 0.0.1' ],
+  ]
 
   self.licenses = ['Public Domain']
 
   self.spec_extras = {
    required_ruby_version: '>= 2.2.2'
   }
-
 end

data/lib/gitti/base.rb

@@ -1,57 +1,60 @@
-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 )
+require 'shell-lite'   ## note: move shell execute for (re)use to its own (upstream) gem
+
+module Gitti
+  Shell      = Computer::Shell
+  ShellError = Computer::ShellError
+  GitError   = Computer::ShellError  ## raised if git exec returns with non-zero exit - just use ShellError - why? why not?
+  ## raised by Git::Shell.run
+  ##  todo/check: use ShellError or RunError - why? why not?
+  ##   and make Git::Shell top-level e.g. Shell - why? why not?
+
+  ##   differentiate into/use
+  ##     GitShell.run/GitCmd.run() or such and Shell.run  - why? why not?
+end
+
+
+
+# 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

@@ -1,24 +1,18 @@
 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?
+  def self.clone( repo, name=nil, depth: nil )
+    cmd = "git clone"
+    cmd << " --depth #{depth}"   unless depth.nil?
+    cmd << " #{repo}"
+    cmd << " #{name}"            unless name.nil? || name.empty?
     Shell.run( cmd )
   end
 
@@ -194,6 +188,21 @@ class Git   ## make Git a module - why? why not?
   end
 
 
+  def self.branch
+    cmd = 'git branch'
+    Shell.run( cmd )
+  end
+
+  def self.master?
+    output = branch     ## check for '* master'
+    output.split( /\r?\n/ ).include?( '* master' )
+  end
+
+  def self.main?
+    output = branch     ## check for '* main'
+    output.split( /\r?\n/ ).include?('* main')
+  end
+
 ## git remote update will update all of your branches
 ##   set to track remote ones, but not merge any changes in.
 ##
@@ -214,6 +223,7 @@ class Git   ## make Git a module - why? why not?
     Shell.run( cmd )
   end
 
+
   def self.origin  ## e.g. git remote show origin
     cmd = "git remote show origin"
     Shell.run( cmd )
@@ -224,15 +234,23 @@ class Git   ## make Git a module - why? why not?
     Shell.run( cmd )
   end
 
+  def self.remote
+    cmd = "git remote"
+    Shell.run( cmd )
+  end
+
   def self.origin?
-    puts "todo/fix: check if remote origin is available/exists - how?"
+    output = remote     ## check for 'origin'
+    output.split( /\r?\n/ ).include?( 'origin' )
   end
 
   def self.upstream?
-    puts "todo/fix: check if remote upstream is available/exists - how?"
+    output = remote     ## check for 'upstream'
+    output.split( /\r?\n/ ).include?( 'upstream' )
   end
 
 
+
   def self.check  ## e.g. git fsck  - check/validate hash of objects
     cmd = "git fsck"
     Shell.run( cmd )
@@ -242,49 +260,6 @@ class Git   ## make Git a module - why? why not?
     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

@@ -1,33 +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
-
+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

@@ -43,11 +43,17 @@ class GitProject
 
 
   ### remote show origin|upstream|etc.
+  def remote()                  Git.remote; end
   def origin()                  Git.origin; end
   def upstream()                Git.upstream; end
   def origin?()                 Git.origin?; end
   def upstream?()               Git.upstream?; end
 
+  ### branch management
+  def branch()                  Git.branch; end
+  def master?()                 Git.master?; end
+  def main?()                   Git.main?; end
+
 
   def run( cmd )                Git::Shell.run( cmd ); end
 end # class GitProject

data/lib/gitti/version.rb

@@ -7,8 +7,8 @@
 
 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 = 4
-  PATCH = 0
+  MINOR = 6
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version
@@ -20,7 +20,7 @@ module GittiCore    ## todo/check: rename GittiBase or GittiMeta or such - why?
   end
 
   def self.root
-    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
   end
 end # module GittiCore
 

data/test/test_base.rb

@@ -6,6 +6,16 @@ require 'helper'
 
 class TestBase < MiniTest::Test
 
+  def test_branch
+    Git.branch
+    assert_equal true,  Git.master?
+    assert_equal false, Git.main?
+
+    Git.remote
+    assert_equal true,  Git.origin?
+    assert_equal false, Git.upstream?
+  end
+
 
   def test_git_config
     puts "---"

metadata

@@ -1,43 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: gitti
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-06 00:00:00.000000000 Z
+date: 2020-10-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: shell-lite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.22'
 description: gitti - (yet) another (lite) git command line helper / wrapper
 email: ruby-talk@ruby-lang.org
 executables: []