git_tree 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34ccd05ecc6f42587797fe03361bed486df6ba5591baaf3cefa715669c27f07f
+  data.tar.gz: 9f547d654742f88d5db2b2163299c3fda8152a5e257546d6aab23690b2f95f5f
+SHA512:
+  metadata.gz: 1e87d794586327101150260f1d5942ba5d487b9f91b54d6db7a0d0d6e6a93e88952898704341d8643b4b3cd0f723e6ceb07e52a4d64b453198d280180bdaa755
+  data.tar.gz: 2144afb4d96f9f9dfc09e28a6d6caac5758a61c3f8bf108b236a28c7cda3c4efc6ba52a2a1e41c7765f3d7ab69a00c3ea63a6b3e6b1a33be103a491ace9a65c4

data/.rubocop.yml

@@ -0,0 +1,101 @@
+require:
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - demo/_site/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+    - git_tree.gemspec
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/InitialIndentation:
+  Exclude:
+    - README.md
+
+Layout/LineLength:
+  Max: 150
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - git_tree.gemspec
+
+Metrics/AbcSize:
+  Max: 45
+
+Metrics/BlockLength:
+  Exclude:
+    - git_tree.gemspec
+    - spec/**/*
+
+Metrics/ClassLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 15
+
+Style/CommandLiteral:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringConcatenation:
+  Exclude:
+    - spec/**/*
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## 0.2.0 / 2023-05-02
+  * 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!!!)
+
+## 0.1.2 / 2023-05-01
+  * Fussing with gem executable (did not work)
+
+## 0.1.1 / 2023-05-01
+  * Added missing file (did not work)
+
+## 0.1.0 / 2023-05-01
+  * Published as a gem (did not work)
+
+## 2021-04-10
+  * Initial version published at https://www.mslinn.com/git/1100-git-tree.html

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Slinn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,169 @@
+`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.
+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_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.
+
+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:
+
+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
+```
+
+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.
+
+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:
+
+```shell
+$ scp work.sh machine2:
+
+$ 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.
+
+```shell
+if [ ! -d "sinatra/sinatras-skeleton/.git" ]; then
+  mkdir -p 'sinatra'
+  pushd 'sinatra' > /dev/null
+  git clone git@github.com:mslinn/sinatras-skeleton.git
+  git remote add upstream 'https://github.com/simonneutert/sinatras-skeleton.git'
+  popd > /dev/null
+fi
+```
+
+### Generated Script from `git_tree_evars`
+Following is a sample of environment variable definitions.
+You can edit it to suit.
+Notice that it appends these environment variable definitions to `$work/.evars`.
+You could cause it to replace the contents of that file by changing the `>>` to `>`.
+
+```shell
+cat <<EOF >> $work/.evars
+export work=/mnt/c/work
+export ancientWarmth=$work/ancientWarmth/ancientWarmth
+export ancientWarmthBackend=$work/ancientWarmth/ancientWarmthBackend
+export braintreeTutorial=$work/ancientWarmth/braintreeTutorial
+export survey_analytics=$work/ancientWarmth/survey-analytics
+export survey_creator=$work/ancientWarmth/survey-creator
+export django=$work/django/django
+export frobshop=$work/django/frobshop
+EOF
+```
+
+The environment variable definitions are meant to be saved into a file that is `source`d upon boot.
+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
+
+$ cd $my_project
+```
+
+
+## Installation
+Type the following at a shell prompt:
+
+```ruby
+$ gem install git_tree
+```
+
+
+## Additional Information
+More information is available on
+[Mike Slinn&rsquo;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.
+```
+$ bin/console
+irb(main):001:0> GitTree.command_replicate 'demo'
+
+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:
+```
+$ gem info git_tree
+
+*** LOCAL GEMS ***
+git_tree (0.2.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/git_tree_replicate
+    License: MIT
+    Installed at: /home/mslinn/.gems
+```
+
+
+### Build and Push to RubyGems
+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).
+
+
+## Contributing
+
+1. Fork the project
+2. Create a descriptively named feature branch
+3. Add your feature
+4. Submit a pull request
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bindir/git_tree_evars

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

data/bindir/git_tree_replicate

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

data/git_tree.gemspec

@@ -0,0 +1,45 @@
+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.description = <<~END_OF_DESC
+    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,
+    and adds any defined remotes.
+    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.files = Dir[
+    '{bindir,lib}/**/*',
+    '.rubocop.yml',
+    'LICENSE.*',
+    'Rakefile',
+    '*.gemspec',
+    '*.md'
+  ]
+  spec.homepage = 'https://www.mslinn.com/git/1100-git-tree.html'
+  spec.license = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{github}/issues",
+    'changelog_uri'     => "#{github}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => github,
+  }
+  spec.name = 'git_tree'
+  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.add_dependency 'rugged'
+end

data/lib/git_tree/version.rb

@@ -0,0 +1,3 @@
+module GitUrlsVersion
+  VERSION = '0.2.0'.freeze
+end

data/lib/git_tree.rb

@@ -0,0 +1,126 @@
+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? '$'
+
+    base = MslinnUtil.expand_env root
+    dirs = directories_to_process base
+
+    # puts "# root=#{root}, base=#{base}"
+    puts make_replicate_script root, base, dirs
+  end
+
+  # @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
+
+    root_fq = MslinnUtil.deref_symlink(root_fq).to_s
+    abort "Error: #{root_fq} does not exist. Halting." unless Dir.exist? root_fq
+
+    result = []
+    Find.find(root_fq) do |path|
+      next if File.file? path
+
+      Find.prune if File.exist?("#{path}/.ignore")
+
+      if Dir.exist?("#{path}/.git")
+        result << path.to_s
+        Find.prune
+      end
+    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 might be "$envar" or a fully qualified directory name ("/a/b/c")
+  # @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 << "cat <<EOF >> #{root}/.evars"
+    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 << "EOF\n"
+    result.join "\n"
+  end
+
+  # @param root might be "$envar" or a fully qualified directory name ("/a/b/c")
+  # @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/util.rb

@@ -0,0 +1,19 @@
+module MslinnUtil
+  # @return Path to symlink
+  def self.deref_symlink(symlink)
+    require 'pathname'
+    Pathname.new(symlink).realpath
+  end
+
+  def self.ensure_ends_with(string, suffix)
+    string = string.delete_suffix suffix
+    "#{string}#{suffix}"
+  end
+
+  def self.expand_env(str)
+    str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) do
+      ENV.fetch(Regexp.last_match(1), nil)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: git_tree
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: bindir
+cert_chain: []
+date: 2023-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rugged
+  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'
+description: |
+  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,
+  and adds any defined remotes.
+  The git_tree_evars command writes a script that defines environment variables pointing to git repos.
+email:
+- mslinn@mslinn.com
+executables:
+- git_tree_evars
+- git_tree_replicate
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bindir/git_tree_evars
+- bindir/git_tree_replicate
+- git_tree.gemspec
+- lib/git_tree.rb
+- lib/git_tree/version.rb
+- lib/util.rb
+homepage: https://www.mslinn.com/git/1100-git-tree.html
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/git_tree/issues
+  changelog_uri: https://github.com/mslinn/git_tree/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/git/1100-git-tree.html
+  source_code_uri: https://github.com/mslinn/git_tree
+post_install_message: |2+
+
+  Thanks for installing git_tree!
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Installs two commands that scan a git directory tree and write out scripts
+  for replication.
+test_files: []
+...