git_tree 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 744efed3dbbb3370021be4abf7e50f5105f340f0b00c2fe525416d18665b6561
-  data.tar.gz: 938fdd59658c6ec5a74b120da486ab65d418cb5f34e69b13279bfc3656abdf50
+  metadata.gz: fbe9b3cc4ea586c939cc994ddf433fe11a3ae801ebb4d414d26203969272e35e
+  data.tar.gz: a73a4c53e64d9cf8c3a9ac9f82cca966a469585a39c8d2df19f62d99d5d6bc9b
 SHA512:
-  metadata.gz: b35184a83646f7ccffd3e34e744da2320163d46f37b2ea3f3f1511cb73d63f13f098e8472da6b792d31101f0b340b49bbc2b4eb29bdd903cae044cf129a2e34d
-  data.tar.gz: 1cc7aaa472d842c40c5f80b747af0d55c55737b2cf4aa32a73c42081898fbc051fc30169554380dcba649b96d33cf3f4125c55efbbffbc449a5a7117191cf8ae
+  metadata.gz: 28bffd85905de74df607377f3db64588d1697ef7acbaace6ddc5ca410d6ba71aca2aaa293f1620fac87d9175618f2068ccd759080e4a803fc56ff57aa798c8d4
+  data.tar.gz: 963acbcdac77069745e6cc009b653fdb779e6f97e192d5bd937efb0c6bb9e4dfbb34d8796a00c48108e655239b41322baaa5f4751652f0f228cde1aec939cf76

data/.rubocop.yml

@@ -7,12 +7,11 @@ require:
 AllCops:
   Exclude:
     - demo/_site/**/*
-    - exe/**/*
+    - binstub/**/*
     - vendor/**/*
     - Gemfile*
     - git_tree.gemspec
   NewCops: enable
-  TargetRubyVersion: 2.6
 
 Gemspec/DeprecatedAttributeAssignment:
   Enabled: false
@@ -20,6 +19,9 @@ Gemspec/DeprecatedAttributeAssignment:
 Gemspec/RequireMFA:
   Enabled: false
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table

data/CHANGELOG.md

@@ -1,30 +1,59 @@
+# Change Log
+
+## 0.3.1 (in progress)
+
+* Added spec.platform to `.gemspec` because `RubyGems.org` now requires it
+
+
+## 0.3.0 / 2023-06-01
+
+* Added `git-tree-exec` command.
+
+
 ## 0.2.3 / 2023-05-26
-  * Improved help messages.
-  * Renamed executables to `git-tree-replicate` and `git-tree-evars`.
+
+* 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.
+
+* `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`.
+
+* Removed the here document wrapper from the output of `git_tree_evars`.
+
 
 ## 0.2.0 / 2023-05-03
-  * Renamed gem to `git_tree`
-  * Renamed `replicate_git_tree` command to `git_tree_replicate`.
-  * Added `.evars` support with new executable: `git_tree_evars`
-  * Added support for a symlinked root directory
+
+* Renamed gem to `git_tree`
+* Renamed `replicate_git_tree` command to `git_tree_replicate`.
+* Added `.evars` support with new executable: `git_tree_evars`
+* Added support for a symlinked root directory
+
 
 ## 0.1.3 / 2023-05-01
-  * Fussing with directory path (works!!!)
+
+* Fussing with directory path (works!!!)
+
 
 ## 0.1.2 / 2023-05-01
-  * Fussing with gem executable (did not work)
+
+* Fussing with gem executable (did not work)
+
 
 ## 0.1.1 / 2023-05-01
-  * Added missing file (did not work)
+
+* Added missing file (did not work)
+
 
 ## 0.1.0 / 2023-05-01
-  * Published as a gem (did not work)
+
+* Published as a gem (did not work)
+
 
 ## 2021-04-10
-  * Initial version published at https://www.mslinn.com/git/1100-git-tree.html
+
+* Initial version published at https://www.mslinn.com/git/1100-git-tree.html

data/README.md

@@ -1,28 +1,32 @@
-`Git_tree`
-[![Gem Version](https://badge.fury.io/rb/git_tree.svg)](https://badge.fury.io/rb/git_tree)
-===========
+# `Git_tree` [![Gem Version](https://badge.fury.io/rb/git_tree.svg)](https://badge.fury.io/rb/git_tree)
 
-This Ruby gem installs two commands that scan a git directory tree and write out scripts.
+This Ruby gem installs 3 commands that scan a git directory tree;
+2 of the commands write out scripts and the third executes an arbitrary bash command for each repository.
 Directories containing a file called `.ignore` are ignored.
 
- - 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.
-   - All remotes in each repo are replicated.
+- 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.
+  - 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.
+
+- The `git-tree-exec` command executes an arbitrary bash command for each repository.
 
 
 ## Usage
-Both commands require one environment variable reference to be passed to them.
+
+All 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.
 
 
 ## `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
 ```
@@ -44,6 +48,7 @@ $ ssh machine2 work.sh
 
 
 ### 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.
 
@@ -58,6 +63,7 @@ fi
 ```
 
 ## `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.
@@ -65,12 +71,14 @@ 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
 ```
 
 
 ### Generated Script from `git-tree-evars`
+
 Following is a sample of environment variable definitions.
 You are expected to edit it to suit.
 
@@ -89,12 +97,14 @@ The environment variable definitions are meant to be saved into a file that is `
 While you could place them in a file like `~/.bashrc`,
 the author's preference is to instead place them in `$work/.evars`,
 and add the following to `~/.bashrc`:
+
 ```shell
 source "$work/.evars"
 ```
 
 Thus each time you log in, the environment variable definitions will have been re-established.
 You can therefore change directory to any of the cloned projects, like this:
+
 ```shell
 $ cd $git_root
 
@@ -102,8 +112,133 @@ $ cd $my_project
 ```
 
 
+## `git-tree-exec` Usage
+
+The `git-tree-exec` command can be run on any computer.
+The command requires two parameters.
+The first parameter indicates the directory or directories to process.
+3 forms are accepted:
+
+  1. A directory name, which may be relative or absolute.
+  2. An environment variable reference,
+     which must be contained within single quotes to prevent expansion by the shell.
+  3. A list of directory names, which may be relative or absolute, and may contain environment variables.
+
+### Example 1
+
+For all subdirectories of current directory,
+update `Gemfile.lock` and install a local copy of the gem:
+
+```shell
+$ git-tree-exec '
+  $jekyll_plugin_logger
+  $jekyll_draft
+  $jekyll_plugin_support
+  $jekyll_all_collections
+  $jekyll_plugin_template
+  $jekyll_flexible_include_plugin
+  $jekyll_href
+  $jekyll_img
+  $jekyll_outline
+  $jekyll_plugin_template
+  $jekyll_pre
+  $jekyll_quote
+' 'bundle && bundle update && rake install'
+```
+
+### Example 2
+
+This example shows how to display the version of projects that
+create gems under the directory pointed to by `$my_plugins`.
+
+An executable script is required on the `PATH`, so `git-tree-exec`
+can invoke it as it loops through the subdirectories.
+I call this script `version`, and it is written in `bash`,
+although the language used is not significant:
+
+```shell
+#!/bin/bash
+
+x="$( ls lib/**/version.rb 2> /dev/null )"
+if [ -f "$x" ]; then
+  v="$(
+    cat "$x" | \
+    grep '=' | \
+    sed -e s/.freeze// | \
+    tr -d 'VERSION =\"' | \
+    tr -d \'
+  )"
+  echo "$(basename $PWD) v$v"
+fi
+```
+
+Call it like this:
+
+```shell
+$ git-tree-exec '$my_plugins' version
+jekyll_all_collections v0.3.3
+jekyll_archive_create v1.0.2
+jekyll_archive_display v1.0.1
+jekyll_auto_redirect v0.1.0
+jekyll_basename_dirname v1.0.3
+jekyll_begin_end v1.0.1
+jekyll_bootstrap5_tabs v1.1.2
+jekyll_context_inspector v1.0.1
+jekyll_download_link v1.0.1
+jekyll_draft v1.1.2
+jekyll_flexible_include_plugin v2.0.20
+jekyll_from_to_until v1.0.3
+jekyll_href v1.2.5
+jekyll_img v0.1.5
+jekyll_nth v1.1.0
+jekyll_outline v1.2.0
+jekyll_pdf v0.1.0
+jekyll_plugin_logger v2.1.1
+jekyll_plugin_support v0.7.0
+jekyll_plugin_template v0.3.0
+jekyll_pre v1.4.1
+jekyll_quote v0.4.0
+jekyll_random_hex v1.0.0
+jekyll_reading_time v1.0.0
+jekyll_revision v0.1.0
+jekyll_run v1.0.1
+jekyll_site_inspector v1.0.0
+jekyll_sort_natural v1.0.0
+jekyll_time_since v0.1.3
+```
+
+### Example 3
+
+List the projects under the directory pointed to by `$my_plugins`
+that have a `demo/` subdirectory:
+
+```shell
+$ git-tree-exec '$my_plugins' \
+  'if [ -d demo ]; then realpath demo; fi'
+/mnt/c/work/jekyll/my_plugins/jekyll-hello/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_all_collections/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_archive_create/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_download_link/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_draft/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_flexible_include_plugin/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_from_to_until/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_href/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_img/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_outline/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_pdf/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_plugin_support/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_plugin_template/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_pre/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_quote/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_revision/demo
+/mnt/c/work/jekyll/my_plugins/jekyll_time_since/demo
+```
+
+
 ## Installation
-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:
+
+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
@@ -115,20 +250,24 @@ To register the new commands, either log out and log back in, or open a new cons
 
 
 ## Additional Information
+
 More information is available on
 [Mike Slinn’s website](https://www.mslinn.com/git/1100-git-tree.html)
 
 
 ## Development
+
 After checking out the repo, run `bin/setup` to install dependencies.
 
 Run the following to create a directory tree for testing.
+
 ```shell
 $ ruby bin/make_test_directory.rb
 ```
 
 You can run `bin/console` for an interactive prompt that will allow you to experiment.
-```
+
+```shell
 $ bin/console
 irb(main):001:0> GitTree.command_replicate 'demo'
 
@@ -137,13 +276,16 @@ irb(main):002:0> GitTree.command_evars 'demo'
 
 
 ### Build and Install Locally
+
 To build and install this gem onto your local machine, run:
+
 ```shell
 $ bundle exec rake install
 ```
 
 Examine the newly built gem:
-```
+
+```shell
 $ gem info git_tree
 
 *** LOCAL GEMS ***
@@ -157,14 +299,18 @@ git_tree (0.2.0)
 
 
 ### Build and Push to RubyGems
-To release a new version,
+
+To release a new version:
+
   1. Update the version number in `version.rb`.
   2. Commit all changes to git; if you don't the next step might fail with an
      unexplainable error message.
   3. Run the following:
+
      ```shell
      $ bundle exec rake release
      ```
+
      The above creates a git tag for the version, commits the created tag,
      and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
 
@@ -178,4 +324,5 @@ To release a new version,
 
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bindir/git-tree-exec

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'git_tree_exec'
+
+GitTree.command_exec

data/git_tree.gemspec

@@ -3,17 +3,21 @@ require_relative 'lib/git_tree/version'
 Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   github = 'https://github.com/mslinn/git_tree'
 
-  spec.authors = ['Mike Slinn']
-  spec.bindir = 'bindir'
+  spec.authors     = ['Mike Slinn']
+  spec.bindir      = 'bindir'
   spec.description = <<~END_OF_DESC
-    Installs two commands that scan a git directory tree and write out scripts.
+    Installs 3 commands that process a git directory tree.
     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.
-    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.
+
+    The git-tree-exec command executes a bash expression on children of a directory, or a list of directories.
   END_OF_DESC
-  spec.email = ['mslinn@mslinn.com']
-  spec.executables = %w[git-tree-evars git-tree-replicate]
+  spec.email       = ['mslinn@mslinn.com']
+  spec.executables = %w[git-tree-exec git-tree-evars git-tree-replicate]
   spec.files = Dir[
     '{bindir,lib}/**/*',
     '.rubocop.yml',
@@ -23,7 +27,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
     '*.md'
   ]
   spec.homepage = 'https://www.mslinn.com/git/1100-git-tree.html'
-  spec.license = 'MIT'
+  spec.license  = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
     'bug_tracker_uri'   => "#{github}/issues",
@@ -31,15 +35,16 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
     'homepage_uri'      => spec.homepage,
     'source_code_uri'   => github,
   }
-  spec.name = 'git_tree'
+  spec.name                 = 'git_tree'
+  spec.platform             = Gem::Platform::RUBY
   spec.post_install_message = <<~END_MESSAGE
 
     Thanks for installing #{spec.name}!
 
   END_MESSAGE
   spec.required_ruby_version = '>= 2.6.0'
-  spec.summary = 'Installs two commands that scan a git directory tree and write out scripts for replication.'
-  spec.version = GitUrlsVersion::VERSION
+  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'

data/lib/git_tree/version.rb

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

data/lib/git_tree_exec.rb

@@ -0,0 +1,94 @@
+require 'pathname'
+require 'shellwords'
+require_relative 'git_tree'
+
+module GitTree
+  using Rainbow
+
+  # @param root might be:
+  #   - '$envar'
+  #   - A fully qualified directory name ("/a/b/c")
+  #   - A list of either of the above
+  def self.command_exec(args = ARGV)
+    root = args[0]
+    command = args[1]
+
+    help_exec "A directory specification and a command must be specified." if args.empty?
+    help_exec "A command must be specified." if args.length == 1
+
+    base = MslinnUtil.expand_env root
+    help_exec "Environment variable '#{root}' is undefined." if base.empty?
+    base.shellsplit.each do |top|
+      dirs = directories_to_process(top)
+      dirs.each do |dir|
+        dir = File.join(base, dir) if Pathname.new(dir).relative?
+        execute dir, command
+      end
+    end
+  end
+
+  # @return array containing status code and result of running command in the given directory
+  # @param command [String] Shell command to execute
+  def self.execute(dir, command)
+    Dir.chdir(dir) do
+      unless File.exist? dir
+        warn "Warning: directory '#{dir}' does not exist.".yellow
+        return
+      end
+      unless Dir.exist? dir
+        warn "Warning: #{dir} is a file, not a directory.".yellow
+        return
+      end
+      result = `#{command}`.rstrip
+      puts result unless result.empty?
+    end
+  rescue StandardError => e
+    warn "Error: #{e.message} from executing '#{command}' in #{dir}".red
+  end
+
+  def self.help_exec(msg = nil)
+    prog_name = File.basename $PROGRAM_NAME
+    puts "Error: #{msg}\n".red if msg
+    puts <<~END_HELP
+      #{prog_name} - requires only one parameter,
+      which points to the top-level directory to process.
+      3 forms are accepted.
+      Only direct child directories are processed; infinite recursion is not supported.
+        1. A directory name, which may be relative or absolute.
+        2. An environment variable reference,
+           which must be preceded by a dollar sign and enclosed within single quotes
+           to prevent expansion by the shell.
+        3. A list of directory names, which may be relative or absolute,
+           and may contain environment variables.
+
+      The environment variable must have been exported, for example:
+
+        $ export work=$HOME/work
+
+      Directories containing a file called .ignore are ignored.
+
+      Usage examples:
+
+      1) For all subdirectories of the current directory,
+         update `Gemfile.lock` and install a local copy of the gem:
+
+         $ #{prog_name} . 'bundle && bundle update && rake install'
+
+
+      2) For all subdirectories of the directory pointed to by `$work`,
+         run git commit and push changes.
+
+         $ #{prog_name} '$work' 'git commit -am "-" && git push'
+
+
+      3) For all subdirectories of the specified directories,
+         list the projects that have a demo/ subdirectory.
+
+         The specified directories are . (the current directory),
+         ~ (the home directory) and the directory pointed to by $my_plugins
+
+         $ #{prog_name} '. ~ $my_plugins' 'if [ -d demo]; then realpath demo; fi'
+    END_HELP
+    exit 1
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: git_tree
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Slinn
-autorequire:
 bindir: bindir
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -39,15 +38,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |
-  Installs two commands that scan a git directory tree and write out scripts.
+  Installs 3 commands that process a git directory tree.
   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.
-  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.
+
+  The git-tree-exec command executes a bash expression on children of a directory, or a list of directories.
 email:
 - mslinn@mslinn.com
 executables:
 - git-tree-evars
+- git-tree-exec
 - git-tree-replicate
 extensions: []
 extra_rdoc_files: []
@@ -58,11 +62,13 @@ files:
 - README.md
 - Rakefile
 - bindir/git-tree-evars
+- bindir/git-tree-exec
 - bindir/git-tree-replicate
 - git_tree.gemspec
 - lib/git_tree.rb
 - lib/git_tree/version.rb
 - lib/git_tree_evars.rb
+- lib/git_tree_exec.rb
 - lib/git_tree_replicate.rb
 - lib/util.rb
 homepage: https://www.mslinn.com/git/1100-git-tree.html
@@ -92,8 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Installs two commands that scan a git directory tree and write out scripts
   for replication.