gitti 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36700d8747db810c4be1b9288ca6009191ac70e6
-  data.tar.gz: e79373dd7aa170865098a4329412e630e9253502
+  metadata.gz: cedf4859bb7b5521d3680c64f310f0a3456d1fbb
+  data.tar.gz: 32e27bc777a0381db476082563b466d2438be218
 SHA512:
-  metadata.gz: 650e82c5ae7676d1b75d7db6a87f8f2350b5602e649f5b80f181845ccacebafddc34d74c031d28d9e768f9a535bd5d0bc90bf9a485a9300313592752b0ed49c3
-  data.tar.gz: 7b9d0575c06da1267d00c247015c8a8f37c366c317ee0fe545f19dacd89b253741bf2485ad02f47c9f2ab350809bed8be3c25b9ee8ce2bff3153ac294c771616
+  metadata.gz: 7b23e5ed7a99c1e632b0ccfecc7e9a3afc8aeee943884b72367e354e6829f2360cd3b8ba2f43e3bb8f54467fd262d72d7dcd54b26bfb29b647b7a9a93833c367
+  data.tar.gz: ba2a18948bf92d98d9c4a09396ee95dcd05da757a3ce65aa633438530a43cdc133784054e3755fa72168eaa06c652beedc1aabeb8de73affd6a20b6f4b9c2d12

data/Manifest.txt

@@ -1,8 +1,11 @@
-HISTORY.md
+CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
 lib/gitti.rb
-lib/gitti/lib.rb
-lib/gitti/support/reposet.rb
+lib/gitti/base.rb
+lib/gitti/project.rb
+lib/gitti/reposet.rb
 lib/gitti/version.rb
+test/helper.rb
+test/test_base.rb

data/README.md

@@ -2,15 +2,115 @@
 
 gitti gem - (yet) another (lite) git command line wrapper / library
 
-* home  :: [github.com/rubylibs/gitti](https://github.com/rubylibs/gitti)
-* bugs  :: [github.com/rubylibs/gitti/issues](https://github.com/rubylibs/gitti/issues)
+* 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
 
-TBD
+`Git` • `GitProject`
+
+
+### `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.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
+end
+```
+
+That's it for now.
+
+
+## Installation
+
+Use
+
+    gem install gitti
+
+or add to your Gemfile
+
+    gem 'gitti'
+
 
 
 ## License

data/Rakefile

@@ -8,23 +8,21 @@ Hoe.spec 'gitti' do
   self.summary = 'gitti - (yet) another (lite) git command line wrapper / library'
   self.description = summary
 
-  self.urls    = ['https://github.com/rubylibs/gitti']
+  self.urls    = { home: 'https://github.com/rubycoco/gitti' }
 
   self.author  = 'Gerald Bauer'
   self.email   = 'ruby-talk@ruby-lang.org'
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'
-  self.history_file = 'HISTORY.md'
+  self.history_file = 'CHANGELOG.md'
 
-  self.extra_deps = [
-    ['logutils' ],
-  ]
+  self.extra_deps = []
 
   self.licenses = ['Public Domain']
 
   self.spec_extras = {
-   required_ruby_version: '>= 1.9.2'
+   required_ruby_version: '>= 2.2.2'
   }
 
 end

data/lib/gitti.rb

@@ -1,28 +1,44 @@
-# encoding: utf-8
-
 require 'pp'
-require 'json'
-require 'yaml'
+require 'time'
 require 'date'    ## e.g. Date.today etc.
-
+require 'yaml'
+require 'json'
+require 'uri'
 require 'net/http'
 require "net/https"
-require 'uri'
-
+require 'open3'
 require 'fileutils'    ## e.g. FileUtils.mkdir_p etc.
 
 
-# 3rd party gems/libs
-require 'logutils'
 
 # our own code
 require 'gitti/version'   # note: let version always go first
-require 'gitti/lib'
+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
 
-## todo/check: move to its own gem e.g. gitti-support later - why? why not??
-require 'gitti/support/reposet'
 
 
 # say hello
-puts Gitti.banner    if defined?( $RUBYLIBS_DEBUG )
+puts Gitti.banner      ## if defined?( $RUBYCOCO_DEBUG )

data/lib/gitti/base.rb

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

data/lib/gitti/project.rb

@@ -0,0 +1,48 @@
+module Gitti
+
+class GitProject
+  def self.open( path, &blk )
+    new( path ).open( &blk )
+  end
+
+  def initialize( path )
+    raise ArgumentError, "dir >#{path}< not found; dir MUST already exist for GitProject class - sorry"   unless Dir.exist?( path )
+    raise ArgumentError, "dir >#{path}/.git< not found; dir MUST already be initialized with git for GitProject class - sorry"  unless Dir.exist?( "#{path}/.git" )
+    @path = path
+  end
+
+
+  def open( &blk )
+    ## puts "Dir.getwd: #{Dir.getwd}"
+    Dir.chdir( @path ) do
+      blk.call( self )
+    end
+    ## puts "Dir.getwd: #{Dir.getwd}"
+  end
+
+
+  def status( short: false )    Git.status( short: short ); end
+  def changes()                 Git.changes; end
+  def clean?()                  Git.clean?; end
+  def changes?()                Git.changes?; end
+  alias_method :dirty?, :changes?
+
+
+  def fetch()                   Git.fetch; end
+  def pull()                    Git.pull; end
+  def fast_forward()            Git.fast_forward; end
+  alias_method :ff, :fast_forward
+
+  def push()                    Git.push; end
+
+  def add( pathspec )           Git.add( pathspec ); 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
+
+end # class GitProject
+end # module Gitti
+

data/lib/gitti/{support/reposet.rb → reposet.rb}

@@ -1,13 +1,12 @@
-# encoding: utf-8
 
 module Gitti
 
 
 class GitRepoSet  ## todo: rename to Hash/Dict/List/Map  or use GitHubRepoSet ??
 
-def self.from_file( path )
+def self.from_file( path )   ## todo/fix: change to self.read - why? why not?
   hash = YAML.load_file( path )
-  self.new( hash )
+  new( hash )
 end
 
 
@@ -22,7 +21,7 @@ def each
     ##   mrhydescripts (3)    =>  mrhydescripts
     ##   footballjs (4)       =>  footballjs
     ##   etc.
-  
+
     key = key_with_counter.sub( /\s+\([0-9]+\)/, '' )
 
     puts "  -- #{key_with_counter} [#{key}] --"
@@ -30,7 +29,7 @@ def each
     yield( key, values )
   end
 end
-  
+
 end ## class GitRepoSet
 
 end ## module Gitti

data/lib/gitti/version.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
 
 module Gitti
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 2
-  PATCH = 1
+  MINOR = 3
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/helper.rb

@@ -0,0 +1,7 @@
+## minitest setup
+require 'minitest/autorun'
+
+
+## our own code
+require 'gitti'
+

data/test/test_base.rb

@@ -0,0 +1,34 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_base.rb
+
+require 'helper'
+
+class TestBase < MiniTest::Test
+
+  include Gitti
+
+  def test_git_config
+    puts "---"
+    Git.config( 'user.name' )
+    Git.config( 'user.name', show_origin: true )
+    ## Git.config( 'user.name', show_scope: true )
+
+    puts "---"
+    Git.config( /user/ )   ## note: pass in regex for regex match/search
+    Git.config( /user/, show_origin: true )
+    ## Git.config( /user/, show_scope: true )
+
+    puts "---"
+    Git.config( /user\./ )   ## note: pass in regex for regex match/search
+
+    puts "---"
+    ## note: if NOT found Git.config will exit(1) !!!
+    ## Git.config( /proxy/, show_origin: true )
+    ## Git.config( /http/,  show_origin: true )
+
+    puts "---"
+  end
+
+end # class TestBase
+

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gitti
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-22 00:00:00.000000000 Z
+date: 2020-09-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: logutils
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -44,32 +30,35 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.16'
 description: gitti - (yet) another (lite) git command line wrapper / library
 email: ruby-talk@ruby-lang.org
 executables: []
 extensions: []
 extra_rdoc_files:
-- HISTORY.md
+- CHANGELOG.md
 - Manifest.txt
 - README.md
 files:
-- HISTORY.md
+- CHANGELOG.md
 - Manifest.txt
 - README.md
 - Rakefile
 - lib/gitti.rb
-- lib/gitti/lib.rb
-- lib/gitti/support/reposet.rb
+- lib/gitti/base.rb
+- lib/gitti/project.rb
+- lib/gitti/reposet.rb
 - lib/gitti/version.rb
-homepage: https://github.com/rubylibs/gitti
+- test/helper.rb
+- test/test_base.rb
+homepage: https://github.com/rubycoco/gitti
 licenses:
 - Public Domain
 metadata: {}
@@ -83,7 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -91,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: gitti - (yet) another (lite) git command line wrapper / library

data/lib/gitti/lib.rb

@@ -1,118 +0,0 @@
-# encoding: utf-8
-
-module Gitti
-
-class GitError < StandardError 
-end
-
-class GitLib
-
-#######################
-## "open" commands
-
-   def clone( repo, opts={} )
-     command "clone #{repo}"
-   end
-
-   def mirror( repo, opts={} )
-     command "clone --mirror #{repo}"
-   end
-
-#########################
-##  more commands
-
-   def status( opts={} )  ## e.g. git status
-     command "status"
-   end
-
-   def pull( opts={} )  ## e.g. git pull
-     command "pull"
-   end
-
-   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
-
-
-   def add( pathspec='.', opts={} )  ## e.g. git add .
-     command "add #{pathspec}"
-   end
-
-   def commit( message, opts={} )  ## e.g. git commit -m "up standings"
-     command "commit -m \"#{message}\""
-   end
-
-   def push( opts={} )   ## e.g. git push
-     command "push"
-   end
-
-
-
-   ## todo/fix:
-   ##   add last_exit  or something ?? why? why not??
-
-   def command( cmd )
-      ## note: for now use Kernel#system for calling external git command
-      ##
-
-      cmdline = "git #{cmd}"
-      puts "  trying >#{cmdline}< in (#{Dir.pwd})..."
-      
-      result = nil
-      result = system( cmdline )
-
-      pp result
-
-      # note: Kernel#system returns
-      #  - true if the command gives zero exit status
-      #  - false for non zero exit status
-      #  - nil if command execution fails
-      #  An error status is available in $?.
-
-      if result.nil?
-        puts "*** error was #{$?}"
-        fail "[Kernel.system] command execution failed  >#{cmdline}< - #{$?}"   
-      elsif result   ## true => zero exit code (OK)
-        puts 'OK'  ## zero exit; assume OK
-        true   ## assume ok
-      else  ## false => non-zero exit code (ERR/NOK)
-        puts "*** error: non-zero exit - #{$?} !!"   ## non-zero exit (e.g. 1,2,3,etc.); assume error
-      
-        ## log error for now  ???
-        # File.open( './errors.log', 'a' ) do |f|
-        #  f.write "#{Time.now} -- repo #{@owner}/#{@name} - command execution failed - non-zero exit\n"
-        # end
-        raise GitError.new( "command execution failed >#{cmdline}< - non-zero exit (#{$?})" )
-      end
-   end  # method command
-end  # class Lib
-
-
-module Git
-  ## todo/fix: use "shared" singelton lib - why? why not??
-  def self.clone( repo, opts={} )    GitLib.new.clone( repo, opts );  end
-  def self.mirror( repo, opts={} )   GitLib.new.mirror( repo, opts );  end
-  
-  def self.pull( opts={} )           GitLib.new.pull( opts );  end
-  def self.remote_update( opts={} )  GitLib.new.remote_update( opts );  end
-  def self.remote_show( name='origin', opts={})  GitLib.new.remote_show( name, opts );  end
-
-  def self.status( opts={} )         GitLib.new.status( opts );  end
-  def self.pull( opts={} )           GitLib.new.pull( opts );  end
-  def self.add( pathspec='.', opts={} )  GitLib.new.add( pathspec, opts );  end
-  def self.commit( message, opts={} )    GitLib.new.commit( message, opts );  end
-  def self.push( opts={} )               GitLib.new.push( opts );  end
-end  # module Git
-
-end # module Gitti
-
-
-### convenience top level Git module - check if defined? make optional? why? why not??
-## Git = Gitti::Git
-
-#  for now use include Gitti - why? why not??