git_tree 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a42706ad381181c5b6d7ed6de426de01c514892770437155a1ede09e3c5ccf3d
-  data.tar.gz: fc98272834fd37f68c547ba23b22b68d5097c5ab69984d291f188132a16a03cc
+  metadata.gz: 744efed3dbbb3370021be4abf7e50f5105f340f0b00c2fe525416d18665b6561
+  data.tar.gz: 938fdd59658c6ec5a74b120da486ab65d418cb5f34e69b13279bfc3656abdf50
 SHA512:
-  metadata.gz: 63fad3a8431607be61d06607b88ca532242dea7c0a8b244194b282aa824cf790fe8c7c21ae91d0bd7f18c38871ccb64c102f31b247136e76ac1b463a3452aa9c
-  data.tar.gz: a3ebe92f5e7a5ed5d2b688cbb38e3c6fd40a63e470db644bfd09db3bcbbded254e8d004bc9731d789cd4269151bb116e0a4b80962aad6a6b7760c794137ea9fa
+  metadata.gz: b35184a83646f7ccffd3e34e744da2320163d46f37b2ea3f3f1511cb73d63f13f098e8472da6b792d31101f0b340b49bbc2b4eb29bdd903cae044cf129a2e34d
+  data.tar.gz: 1cc7aaa472d842c40c5f80b747af0d55c55737b2cf4aa32a73c42081898fbc051fc30169554380dcba649b96d33cf3f4125c55efbbffbc449a5a7117191cf8ae

data/.rubocop.yml

@@ -66,6 +66,9 @@ Naming/FileName:
 RSpec/ExampleLength:
   Max: 20
 
+RSpec/FilePath:
+  Enabled: false
+
 RSpec/MultipleExpectations:
   Max: 15
 
@@ -88,8 +91,7 @@ Style/RegexpLiteral:
   Enabled: false
 
 Style/StringConcatenation:
-  Exclude:
-    - spec/**/*
+  Enabled: false
 
 Style/StringLiterals:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.2.3 / 2023-05-26
+  * Improved help messages.
+  * Renamed executables to `git-tree-replicate` and `git-tree-evars`.
+
+## 0.2.2 / 2023-05-23
+  * `git_tree_evars` now checks for previous definitions and issues warnings.
+
 ## 0.2.1 / 2023-05-03
   * Removed the here document wrapper from the output of `git_tree_evars`.
 

data/README.md

@@ -5,36 +5,33 @@
 This Ruby gem installs two commands that scan a git directory tree and write out scripts.
 Directories containing a file called `.ignore` are ignored.
 
- - The `git_tree_replicate` command writes a script that clones the repos in the tree,
+ - The `git-tree-replicate` command writes a script that clones the repos in the tree,
    and adds any defined remotes.
    - Any git repos that have already been cloned into the target directory tree are skipped.
-     This means you can rerun `git_tree_replicate` as many times as you want, without ill effects.
+     This means you can rerun `git-tree-replicate` as many times as you want, without ill effects.
    - All remotes in each repo are replicated.
 
- - The `git_tree_evars` command writes a script that defines environment variables pointing to git repos.
+ - The `git-tree-evars` command writes a script that defines environment variables pointing to git repos.
 
 
 ## Usage
-Both commands requires only one parameter:
-the name of the top-level directory to scan.
+Both commands require one environment variable reference to be passed to them.
+Enclose the name of the environment variable within single quotes,
+which will prevent the shell from expanding it before invoking the command.
 
-You must pass an environment variable to both commands.
-Enclosing the name of the env var in single quotes,
-which will prevent the shell from expanding it before invoking either command.
 
-
-## `Git_tree_replicate` Usage
+## `git-tree-replicate` Usage
 The following creates a script in the current directory called `work.sh`,
 that replicates the desired portions of the directory tree of git repos pointed to by `$work`:
 ```shell
-$ git_tree_replicate '$work' > work.sh
+$ git-tree-replicate '$work' > work.sh
 ```
 
 The generated environment variables will all be relative to the
-env var you provided.
-You will understand what this means once you try it and look at the generated script.
+path pointed to by the expanded environment variable that you provided.
+You will understand what this means once you look at the generated script.
 
-When `git_tree_replicate` completes,
+When `git-tree-replicate` completes,
 edit the generated script to suit, then
 copy it to the target machine and run it.
 The following example copies the script to `machine2` and runs it:
@@ -46,7 +43,7 @@ $ ssh machine2 work.sh
 ```
 
 
-### Generated Script from `git_tree_replicate`
+### Generated Script from `git-tree-replicate`
 Following is a sample of one section, which is repeated for every git repo that is processed:
 You can edit them to suit.
 
@@ -60,8 +57,8 @@ if [ ! -d "sinatra/sinatras-skeleton/.git" ]; then
 fi
 ```
 
-## `Git_tree_evars` Usage
-The `git_tree_evars` command should be run on the target computer.
+## `git-tree-evars` Usage
+The `git-tree-evars` command should be run on the target computer.
 The command requires only one parameter:
 an environment variable reference, pointing to the top-level directory to replicate.
 The environment variable reference must be contained within single quotes to prevent expansion by the shell.
@@ -69,13 +66,13 @@ The environment variable reference must be contained within single quotes to pre
 The following appends to any script in the `$work` directory called `.evars`.
 The script defines environment variables that point to each git repos pointed to by `$work`:
 ```shell
-$ git_tree_evars '$work' >> $work/.evars
+$ git-tree-evars '$work' >> $work/.evars
 ```
 
 
-### Generated Script from `git_tree_evars`
+### Generated Script from `git-tree-evars`
 Following is a sample of environment variable definitions.
-You can edit it to suit.
+You are expected to edit it to suit.
 
 ```shell
 export work=/mnt/c/work
@@ -106,12 +103,16 @@ $ cd $my_project
 
 
 ## Installation
-Type the following at a shell prompt:
+Type the following at a shell prompt on the machine you are copying the git tree from, and on the machine that you are copying the git tree to:
+
+```shell
+$ yes | sudo apt install cmake libgit2-dev libssh2-1-dev pkg-config
 
-```ruby
 $ gem install git_tree
 ```
 
+To register the new commands, either log out and log back in, or open a new console.
+
 
 ## Additional Information
 More information is available on

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec

data/bindir/{git_tree_evars → git-tree-evars}

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'git_tree'
+require 'git_tree_evars'
 
 GitTree.command_evars

data/bindir/{git_tree_replicate → git-tree-replicate}

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'git_tree'
+require 'git_tree_replicate'
 
 GitTree.command_replicate

data/git_tree.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
     The git_tree_evars command writes a script that defines environment variables pointing to git repos.
   END_OF_DESC
   spec.email = ['mslinn@mslinn.com']
-  spec.executables = %w[git_tree_evars git_tree_replicate]
+  spec.executables = %w[git-tree-evars git-tree-replicate]
   spec.files = Dir[
     '{bindir,lib}/**/*',
     '.rubocop.yml',
@@ -41,5 +41,6 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.summary = 'Installs two commands that scan a git directory tree and write out scripts for replication.'
   spec.version = GitUrlsVersion::VERSION
 
+  spec.add_dependency 'rainbow'
   spec.add_dependency 'rugged'
 end

data/lib/git_tree/version.rb

@@ -1,3 +1,3 @@
 module GitUrlsVersion
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.3'.freeze
 end

data/lib/git_tree.rb

@@ -1,38 +1,19 @@
-module GitTree
-  require 'find'
-  require 'rugged'
-  require_relative 'util'
-
-  # @param root might be "$envar" or a fully qualified directory name ("/a/b/c")
-  def self.command_evars(root = ARGV[0])
-    abort "Error: Argument must start with a dollar sign ($)" unless root.start_with? '$'
-
-    base = MslinnUtil.expand_env root
-    dirs = directories_to_process base
-
-    # puts "# root=#{root}, base=#{base}"
-    puts make_env_vars root, base, dirs
-  end
-
-  # @param root might be "$envar" or a fully qualified directory name ("/a/b/c")
-  def self.command_replicate(root = ARGV[0])
-    abort "Error: Argument must start with a dollar sign ($)" unless root.start_with? '$'
+require 'find'
+require 'rainbow/refinement'
+require 'rugged'
+require_relative 'util'
 
-    base = MslinnUtil.expand_env root
-    dirs = directories_to_process base
-
-    # puts "# root=#{root}, base=#{base}"
-    puts make_replicate_script root, base, dirs
-  end
+module GitTree
+  using Rainbow
 
   # @return array containing directory names to process
   #   Each directory name ends with a slash, to ensure symlinks are dereferences
   def self.directories_to_process(root)
     root_fq = File.expand_path root
-    abort "Error: #{root_fq} is a file, instead of a directory. Cannot recurse." if File.file? root_fq
+    abort "Error: #{root_fq} is a file, instead of a directory. Cannot recurse.".red if File.file? root_fq
 
     root_fq = MslinnUtil.deref_symlink(root_fq).to_s
-    abort "Error: #{root_fq} does not exist. Halting." unless Dir.exist? root_fq
+    abort "Error: #{root_fq} does not exist. Halting.".red unless Dir.exist? root_fq
 
     result = []
     Find.find(root_fq) do |path|
@@ -47,78 +28,4 @@ module GitTree
     end
     result.map { |x| x.delete_prefix("#{root_fq}/") }
   end
-
-  def self.env_var_name(path)
-    name = path.include?('/') ? File.basename(path) : path
-    name.tr(' ', '_').tr('-', '_')
-  end
-
-  def self.help(msg = nil)
-    puts msg if msg
-    puts <<~END_HELP
-      Replicates tree of git repos and writes a bash script to STDOUT that clones the repos in the tree.
-      Adds upstream remotes as required.
-
-      Directories containing a file called .ignore are ignored.
-    END_HELP
-    exit 1
-  end
-
-  def self.make_env_var(name, value)
-    "export #{env_var_name(name)}=#{value}"
-  end
-
-  # @param root should be an "$envar" that points to the root of a directory tree containing git repos.
-  # @param base a fully qualified directory name ("/a/b/c")
-  # @param dirs directory list to process
-  def self.make_env_vars(root, base, dirs)
-    result = []
-    result << make_env_var(env_var_name(base), MslinnUtil.deref_symlink(base))
-    dirs.each do |dir|
-      result << make_env_var(env_var_name(dir), "#{root}/#{dir}")
-    end
-    result.join("\n") + "\n" # rubocop:disable Style/StringConcatenation
-  end
-
-  # @param root should be an "$envar" that points to the root of a directory tree containing git repos.
-  # @param base a fully qualified directory name ("/a/b/c")
-  # @param dirs directory list to process
-  def self.make_replicate_script(root, base, dirs)
-    help "Error: Please specify the subdirectory to traverse.\n\n" if root.to_s.empty?
-
-    Dir.chdir(base) do
-      result = dirs.map { |dir| replicate_one(dir) }
-      result.join "\n"
-    end
-  end
-
-  def self.replicate_one(dir)
-    output = []
-    project_dir = File.basename dir
-    parent_dir = File.dirname dir
-    repo = Rugged::Repository.new dir
-    origin_url = repo.config['remote.origin.url']
-
-    output << "if [ ! -d \"#{dir}/.git\" ]; then"
-    output << "  mkdir -p '#{parent_dir}'"
-    output << "  pushd '#{parent_dir}' > /dev/null"
-    output << "  git clone #{origin_url}"
-
-    repo.remotes.each do |remote|
-      next if remote.name == 'origin' || remote.url == 'no_push'
-
-      output << "  git remote add #{remote.name} '#{remote.url}'"
-    end
-
-    output << '  popd > /dev/null'
-
-    # git_dir_name = File.basename Dir.pwd
-    # if git_dir_name != project_dir
-    #   output << '  # Git project directory was renamed, renaming this copy to match original directory structure'
-    #   output << "  mv #{git_dir_name} #{project_dir}"
-    # end
-    output << "fi"
-    output << ''
-    output
-  end
 end

data/lib/git_tree_evars.rb

@@ -0,0 +1,82 @@
+require_relative 'git_tree'
+
+module GitTree
+  using Rainbow
+
+  # @param root might be "$envar" or a fully qualified directory name ("/a/b/c")
+  def self.command_evars(root = ARGV[0])
+    help_evars "Environment variable reference was missing. Please enclose it within single quotes." if root.to_s.empty?
+    help_evars "Environment variable reference must start with a dollar sign ($)." unless root.start_with? '$'
+
+    base = MslinnUtil.expand_env root
+    help_evars "Environment variable '#{root}' is undefined." if base.strip.empty?
+    help_evars "Environment variable '#{root}' points to a non-existant directory (#{base})." unless File.exist?(base)
+    help_evars "Environment variable '#{root}' points to a file (#{base}), not a directory." unless Dir.exist?(base)
+
+    dirs = directories_to_process base
+    puts make_env_vars(root, base, dirs)
+  end
+
+  def self.env_var_name(path)
+    name = path.include?('/') ? File.basename(path) : path
+    name.tr(' ', '_').tr('-', '_')
+  end
+
+  def self.help_evars(msg = nil)
+    prog_name = File.basename $PROGRAM_NAME
+    puts "Error: #{msg}\n".red if msg
+    puts <<~END_HELP
+      #{prog_name} - Examines a tree of git repositories and writes a bash script to STDOUT
+      that defines environment variables which point to the repositories in the tree.
+
+      Does not redefine existing environment variables; messages are written to
+      STDERR to indicate environment variables that are not redefined.
+
+      The environment variable must have been exported, for example:
+
+      $ export work=$HOME/work
+
+      Directories containing a file called .ignore are ignored.
+
+      Usage example:
+
+      $ #{prog_name} '$work'
+
+      The name of the environment variable must be preceded by a dollar sign and enclosed within single quotes.
+    END_HELP
+    exit 1
+  end
+
+  def self.make_env_var(name, value)
+    "export #{env_var_name(name)}=#{value}"
+  end
+
+  # @param root should be an "$envar" that points to the root of a directory tree containing git repos.
+  # @param base a fully qualified directory name ("/a/b/c")
+  # @param dirs directory list to process
+  def self.make_env_vars(root, base, dirs)
+    help_evars "Error: Please specify the subdirectory to traverse." if root.to_s.empty?
+
+    result = []
+    result << make_env_var(env_var_name(base), MslinnUtil.deref_symlink(base))
+    dirs.each do |dir|
+      ename = env_var_name dir
+      ename_value = MslinnUtil.expand_env "$#{ename}"
+      ename_value = ename_value.gsub(' ', '\\ ').delete_prefix('\\') unless ename_value.empty?
+      if ename_value.to_s.strip.empty?
+        result << make_env_var(ename, "#{root}/#{dir}")
+      else
+        msg = "$#{ename} was previously defined as #{ename_value}"
+        dir2 = MslinnUtil.expand_env(ename_value)
+        if Dir.exist? dir2
+          warn msg.cyan
+        else
+          msg += ", but that directory does not exist,\n  so redefining #{ename} as #{dir}."
+          warn msg.green
+          result << make_env_var(ename, "#{root}/#{dir}")
+        end
+      end
+    end
+    result.map { |x| "#{x}\n" }.join + "\n"
+  end
+end

data/lib/git_tree_replicate.rb

@@ -0,0 +1,86 @@
+require_relative 'git_tree'
+
+module GitTree
+  using Rainbow
+
+  # @param root might be "$envar" or a fully qualified directory name ("/a/b/c")
+  def self.command_replicate(root = ARGV[0])
+    help_replicate "Environment variable reference was missing. Please enclose it within single quotes." if root.to_s.empty?
+    help_replicate "Error: Environment variable reference must start with a dollar sign ($)" unless root.start_with? '$'
+
+    base = MslinnUtil.expand_env root
+    help_replicate "Environment variable '#{root}' is undefined." if base.strip.empty?
+    help_replicate "Environment variable '#{root}' points to a non-existant directory (#{base})." unless File.exist?(base)
+    help_replicate "Environment variable '#{root}' points to a file (#{base}), not a directory." unless Dir.exist?(base)
+
+    dirs = directories_to_process base
+    puts make_replicate_script(root, base, dirs)
+  end
+
+  def self.help_replicate(msg = nil)
+    prog_name = File.basename $PROGRAM_NAME
+    puts "Error: #{msg}\n".red if msg
+    puts <<~END_HELP
+      #{prog_name} - Replicates a tree of git repositories and writes a bash script
+      to STDOUT that clones the repositories in the tree. Replicates any remotes
+      defined in the source repositories to the target repositories.
+
+      The environment variable must have been exported, for example:
+
+      $ export work=$HOME/work
+
+      Directories containing a file called .ignore are ignored.
+
+      Usage example:
+      Assuming that 'work' is an environment variable that contains the name of a
+      directory that contains a tree of git repositories:
+
+      $ #{prog_name} '$work'
+
+      The name of the environment variable must be preceded by a dollar sign and enclosed within single quotes.
+    END_HELP
+    exit 1
+  end
+
+  # @param root should be an "$envar" that points to the root of a directory tree containing git repos.
+  # @param base a fully qualified directory name ("/a/b/c")
+  # @param dirs directory list to process
+  def self.make_replicate_script(root, base, dirs)
+    help_replicate "Error: Please specify the subdirectory to traverse.\n\n" if root.to_s.empty?
+
+    Dir.chdir(base) do
+      result = dirs.map { |dir| replicate_one(dir) }
+      result.join "\n"
+    end
+  end
+
+  def self.replicate_one(dir)
+    output = []
+    # project_dir = File.basename dir
+    parent_dir = File.dirname dir
+    repo = Rugged::Repository.new dir
+    origin_url = repo.config['remote.origin.url']
+
+    output << "if [ ! -d \"#{dir}/.git\" ]; then"
+    output << "  mkdir -p '#{parent_dir}'"
+    output << "  pushd '#{parent_dir}' > /dev/null"
+    output << "  git clone #{origin_url}"
+
+    repo.remotes.each do |remote|
+      next if remote.name == 'origin' || remote.url == 'no_push'
+
+      output << "  git remote add #{remote.name} '#{remote.url}'"
+    end
+
+    output << '  popd > /dev/null'
+
+    # git_dir_name = File.basename Dir.pwd
+    # if git_dir_name != project_dir
+    #   output << '  # Git project directory was renamed, renaming this copy to match original directory structure'
+    #   output << "  mv #{git_dir_name} #{project_dir}"
+    # end
+    output << 'fi'
+    output << ''
+    output
+  end
+end

data/lib/util.rb

@@ -1,4 +1,66 @@
 module MslinnUtil
+  # @param paths [Array[String]] all start with a leading '/' (they are assumed to be absolute paths).
+  # @return [String] the longest path prefix that is a prefix of all paths in array.
+  #   If array is empty, return ''.
+  #   If only the leading slash matches, and allow_root_match is true, return '/', else return ''.
+  def self.common_prefix(paths, allow_root_match: false)
+    return '' if paths.empty?
+
+    relative_paths = paths.reject { |x| x.start_with? '/' }
+    abort "Error: common_prefix received relative paths:" + relative_paths.map { |x| "  #{x}\n" } \
+      unless relative_paths.empty?
+
+    if paths.length == 1
+      result = paths.first.split('/').slice(0...-1).join('/')
+      return result.empty? && allow_root_match ? '/' : result
+    end
+
+    arr = paths.sort
+    first = arr.first.split('/')
+    last = arr.last.split('/')
+    i = 0
+    i += 1 while first[i] == last[i] && i <= first.length
+    result = first.slice(0, i).join('/')
+
+    result.empty? && allow_root_match ? '/' : result
+  end
+
+  # @param paths [Array[String]] absolute paths to examine
+  # @param level [Int] minimum # of leading directory names in result, origin 1
+  def self.roots(paths, level, allow_root_match: false)
+    abort "Error: level must be positive, but it is #{level}." unless level.positive?
+    return allow_root_match ? '/' : '' if paths.empty?
+
+    abort("Error: level parameter must be positive, #{level} was supplied instead.") if level <= 0
+
+    if paths.length == 1
+      root = File.dirname(paths.first)
+      return allow_root_match ? '/' : '' if root == '/'
+
+      return root
+    end
+
+    loop do
+      paths = trim_to_level(paths, level) # does this change paths in the caller?
+      return paths.first if paths.length == 1
+
+      level -= 1
+      break if level.zero?
+    end
+
+    allow_root_match ? '/' : ''
+  end
+
+  # @param paths [Array[String]] absolute paths to examine
+  # @param level is origin 1
+  def self.trim_to_level(paths, level)
+    result = paths.map do |x|
+      elements = x.split('/').reject(&:empty?)
+      '/' + elements[0..level - 1].join('/')
+    end
+    result.sort.uniq
+  end
+
   # @return Path to symlink
   def self.deref_symlink(symlink)
     require 'pathname'
@@ -15,5 +77,4 @@ module MslinnUtil
       ENV.fetch(Regexp.last_match(1), nil)
     end
   end
-
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: git_tree
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: bindir
 cert_chain: []
-date: 2023-05-03 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  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: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -33,8 +47,8 @@ description: |
 email:
 - mslinn@mslinn.com
 executables:
-- git_tree_evars
-- git_tree_replicate
+- git-tree-evars
+- git-tree-replicate
 extensions: []
 extra_rdoc_files: []
 files:
@@ -43,11 +57,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bindir/git_tree_evars
-- bindir/git_tree_replicate
+- bindir/git-tree-evars
+- bindir/git-tree-replicate
 - git_tree.gemspec
 - lib/git_tree.rb
 - lib/git_tree/version.rb
+- lib/git_tree_evars.rb
+- lib/git_tree_replicate.rb
 - lib/util.rb
 homepage: https://www.mslinn.com/git/1100-git-tree.html
 licenses: