gitti 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef8765bec0642f4ee88c23169fffe92f8f0bba1a
-  data.tar.gz: a877ebe7e9bcff04915ed4fcc782dcf2c8000dc3
+  metadata.gz: 22e1840beecff16feb5247fa52e7c6c5ce7deaa3
+  data.tar.gz: 70495a4374a990460a505c3b927f3501b91c74a5
 SHA512:
-  metadata.gz: 683017b302f2becfaa0fb76c6f2dbfecd3e961ef534d8c8b784070a2df90fefc4df38c476d9601ef0d2e0167b2c613adbe781e918520ba15dc2e8e0b33e0ece7
-  data.tar.gz: 41320be67f3b4f4a3dd34bdac9a7ac4a94b21d47012f84be53cb8dee0170c9acc811927c910e985983f724a7d7826fbd36b04f457c31b25c47320733af7ce832
+  metadata.gz: 196886378c5879ff3ac790e25e017cd0c48af5d8c15f2073f99b2d25caca2ec878e81a073da1ca2cbf4f2fd40e76317b7e01a2a7fb4268d325db4a36f1e58bad
+  data.tar.gz: b15e3d0bbcdfa562ee4ac600fd8b2acd6d72d52c331e124defe04d12cb5e944844f28ba042c3390f7de8cfa5aabea702f2cbce6ed4baacd9c058d60a28662281

data/README.md

@@ -25,10 +25,13 @@ Example:
 ###############
 ## "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( "git@github.com:rubycoco/gitti.git" )  ## same as  git clone --mirror
+Git.mirror( "https://github.com/rubycoco/gitti.git" )  ## same as  git clone --mirror
 
 #################
 ## standard git commands
@@ -63,12 +66,14 @@ 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
@@ -107,6 +112,9 @@ GitProject.open( "rubycoco/gitti" ) do |proj|
 
   proj.files
 
+  proj.master?
+  proj.main?
+
   proj.origin
   proj.upstream
   proj.origin?
@@ -131,6 +139,14 @@ 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

data/lib/gitti/git.rb

@@ -16,9 +16,10 @@ class Git   ## make Git a module - why? why not?
   ###############
   ## "setup" starter git commands
 
-  def self.clone( repo, name=nil )
+  def self.clone( repo, name=nil, depth: nil )
     cmd = "git clone #{repo}"
-    cmd << " #{name}"   unless name.nil? || name.empty?
+    cmd << " #{name}"            unless name.nil? || name.empty?
+    cmd << " --depth #{depth}"   unless depth.nil?
     Shell.run( cmd )
   end
 
@@ -194,6 +195,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 +230,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 +241,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 )
@@ -266,7 +291,7 @@ def self.run( cmd )
   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 "2>"
     puts stderr
   end
 

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

@@ -8,7 +8,7 @@
 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
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitti
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-06 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc