git_tree 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45ac579ee8e240d6c78bd782b40b1ca473ffd5e7f1d87a1fb81b53012516465c
-  data.tar.gz: 32b342b9e45b35a64beca464cf9a0e3af514ea5867cd864916ff551425f3dcd7
+  metadata.gz: 744efed3dbbb3370021be4abf7e50f5105f340f0b00c2fe525416d18665b6561
+  data.tar.gz: 938fdd59658c6ec5a74b120da486ab65d418cb5f34e69b13279bfc3656abdf50
 SHA512:
-  metadata.gz: 7ecfa103809f6cd8d63bbd76b69cbbf5d7af5c746b16a7d533d7bfc9a269687413413b98b7fa5aab27028f37a7d8e2ef4df40decd49a07828549cedfb072c47a
-  data.tar.gz: 1dc61521613c96dbb776de98b02b269a3dc0d0aa2605e534fdc19d4facf103c8e4a9fa6dddef143720b841e672b9fc5072c74b81b643cc1fd6ea4ba502a1a821
+  metadata.gz: b35184a83646f7ccffd3e34e744da2320163d46f37b2ea3f3f1511cb73d63f13f098e8472da6b792d31101f0b340b49bbc2b4eb29bdd903cae044cf129a2e34d
+  data.tar.gz: 1cc7aaa472d842c40c5f80b747af0d55c55737b2cf4aa32a73c42081898fbc051fc30169554380dcba649b96d33cf3f4125c55efbbffbc449a5a7117191cf8ae

data/CHANGELOG.md

@@ -1,5 +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,13 +5,13 @@
 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
@@ -20,18 +20,18 @@ Enclose the name of the environment variable within single quotes,
 which will prevent the shell from expanding it before invoking the 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
 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:
@@ -43,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.
 
@@ -57,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.
@@ -66,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
@@ -103,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
+
 $ 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/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',

data/lib/git_tree/version.rb

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

data/lib/git_tree_evars.rb

@@ -1,4 +1,3 @@
-require 'shellwords'
 require_relative 'git_tree'
 
 module GitTree
@@ -6,13 +5,16 @@ module GitTree
 
   # @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 ($)".red unless root.start_with? '$'
+    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
-    dirs = directories_to_process base
+    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)
 
-    # puts "# root=#{root}, base=#{base}"
-    puts make_env_vars root, base, dirs
+    dirs = directories_to_process base
+    puts make_env_vars(root, base, dirs)
   end
 
   def self.env_var_name(path)
@@ -21,12 +23,26 @@ module GitTree
   end
 
   def self.help_evars(msg = nil)
-    puts msg if msg
+    prog_name = File.basename $PROGRAM_NAME
+    puts "Error: #{msg}\n".red if msg
     puts <<~END_HELP
-      Examines a tree of git repos and writes a bash script to STDOUT that defines environment variables that point to the repos in the tree.
-      Does not redefine existing environment variables.
+      #{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
@@ -39,27 +55,28 @@ module GitTree
   # @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.\n\n" if root.to_s.empty?
+    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.shellescape.delete_prefix('\\') unless ename_value.empty?
-      if ename_value.to_s.empty?
+      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}"
-        dir = MslinnUtil.expand_env(ename_value)
-        if Dir.exist? dir
+        dir2 = MslinnUtil.expand_env(ename_value)
+        if Dir.exist? dir2
           warn msg.cyan
         else
-          msg += ", but that directory does not exist, so redefining #{ename}."
+          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
+    result.map { |x| "#{x}\n" }.join + "\n"
   end
 end

data/lib/git_tree_replicate.rb

@@ -1,25 +1,43 @@
 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])
-    abort "Error: No directories were specified" if root.to_s.empty?
-    abort "Error: Argument must start with a dollar sign ($)" unless root.start_with? '$'
+    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
-    dirs = directories_to_process base
+    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)
 
-    # puts "# root=#{root}, base=#{base}"
-    puts make_replicate_script root, base, dirs
+    dirs = directories_to_process base
+    puts make_replicate_script(root, base, dirs)
   end
 
   def self.help_replicate(msg = nil)
-    puts msg if msg
+    prog_name = File.basename $PROGRAM_NAME
+    puts "Error: #{msg}\n".red 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.
+      #{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
@@ -38,7 +56,7 @@ module GitTree
 
   def self.replicate_one(dir)
     output = []
-    project_dir = File.basename dir
+    # project_dir = File.basename dir
     parent_dir = File.dirname dir
     repo = Rugged::Repository.new dir
     origin_url = repo.config['remote.origin.url']
@@ -61,7 +79,7 @@ module GitTree
     #   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 << 'fi'
     output << ''
     output
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_tree
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: bindir
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -47,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:
@@ -57,8 +57,8 @@ 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