gitoc 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bef45ac911fb315a1dbcf743edfff6dc8f49cc621662e4b410de4807c4e81142
+  data.tar.gz: 8f0fc609562e69ca190a350d84d935c26a920d5472dd6beabbe011348d043ec6
+SHA512:
+  metadata.gz: 0e72e70f2813c6193334f027b7f5c28491f0aa9692d6f3b896f9a285ea61c5429a71c163e2629b850f9234a305dda9803afdaf9996ef387e24d770b75b5bb8be
+  data.tar.gz: e5aa5b03fd8e363204fda516c58a59aee3ccae36f1a7d47c480d6691bca4d534a094dc4123c4d7e0bbde29dad496215b80e914e93f66439a2951581f85d0e990

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Release v0.3.0 (26 Oct 2021)
+
+* first public release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gitoc.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Patrick Marchi
+
+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,35 @@
+# Gitoc
+
+GiTOC generates a table of contents from a local directory tree of git repositories. Use this GiTOC file to clone all your git repositories to a new location (computer) or run a command on all your repositories.
+
+## Installation
+
+    $ gem install gitoc
+
+## Usage
+
+The local directory tree of your git repositories defaults to `~/git` and the default GiTOC file path is set to `~/.gitoc.yaml`. Use `--base=DIRECTORY` and `--toc=GiTOC-FILE` to overwrite these defaults.
+
+First you have to generate a GiTOC file with
+
+    $ gitoc dump
+
+Then you can run things on your local repositories
+
+    # Run git pull on all your repositories
+    $ gitoc pull
+
+    # Clone all git repositories to a new location using the same directory structure specified in your GiTOC file.
+
+    # ... to a new location on the same computer
+    $ gitoc clone --base=NEW-DIRECTORY
+
+    # ... to a new computer (copy/move your GiTOC file first)
+    $ gitoc clone
+
+    # Check your GiTOC file
+    $ gitoc check
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gitoc.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "gitoc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gitoc

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "gitoc"
+
+Gitoc::Cli.start ARGV

data/gitoc.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/gitoc/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gitoc"
+  spec.version = Gitoc::VERSION
+  spec.authors = ["Patrick Marchi"]
+  spec.email = ["mail@patrickmarchi.ch"]
+
+  spec.summary = [spec.name, spec.version].join(" ")
+  spec.description = "Manage git repositories in directory tree."
+  spec.homepage = "https://github.com/pmarchi/gitoc"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = File.join(spec.homepage, "blob/main/CHANGELOG.md")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "thor"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gitoc/cli.rb

@@ -0,0 +1,118 @@
+require "pathname"
+require "yaml"
+require "thor"
+
+class Gitoc::Cli < Thor
+  include Thor::Actions
+
+  class_option :base, default: "~/git", desc: "Local git base directory"
+  class_option :toc, default: "~/.gitoc.yaml", desc: "GiTOC file"
+
+  desc "check", "Check GiTOC file"
+  def check
+    init_base
+
+    list = repositories.map do |repo|
+      path, url = repo.to_hash.values
+      path = set_color(path, :red) if url.nil? || url.empty?
+      [path, url]
+    end
+
+    print_table list
+  end
+
+  desc "dump", "Recursively scan base for git repositories and generate GiTOC file"
+  def dump
+    init_base
+
+    toc = Gitoc::Repository.base.glob("**/.git").map do |git_dir|
+      Gitoc::Repository.new(git_dir.parent)
+    end.sort_by(&:path).map(&:to_hash)
+
+    # Write git_toc file
+    gitoc.write toc.to_yaml
+    puts "Write #{gitoc}"
+  end
+
+  desc "clone", "Read GiTOC file and clone all repositories"
+  def clone
+    init_base
+
+    each_repository do |repo|
+      if repo.exist?
+        say "Skip repository, #{repo.path} already exists.", :red
+        next
+      end
+
+      repo.clone
+    end
+  end
+
+  desc "pull", "Read GiTOC file and pull all repositories"
+  def pull
+    init_base
+
+    each_repository do |repo|
+      unless repo.exist?
+        say "Skip repository, #{repo.path} doesn't exist.", :red
+        next
+      end
+
+      repo.pull
+    end
+  end
+
+  desc "clone-or-pull", "Read GiTOC file and clone/pull all repositories"
+  def clone_or_pull
+    init_base
+
+    each_repository do |repo|
+      if repo.exist?
+        repo.pull
+      else
+        repo.clone
+      end
+    end
+  end
+
+  private
+
+  def init_base
+    Gitoc::Repository.base = Pathname.new(options[:base]).expand_path
+  end
+
+  def gitoc
+    @gitoc ||= Pathname.new(options[:toc]).expand_path
+  end
+
+  def repositories
+    @repositories ||= begin
+      unless gitoc.exist?
+        say "#{gitoc} not found", :red
+        exit 1
+      end
+
+      YAML.load_file(gitoc).map do |attributes|
+        Gitoc::Repository.load attributes
+      end
+    end
+  end
+
+  def each_repository
+    repositories.each_with_index do |repo, index|
+      puts
+      say "~/#{repo.path.relative_path_from(home)} (#{index + 1}/#{repositories.count})", :cyan
+
+      unless repo.url?
+        say "Skip repository with no remote.origin.url", :red
+        next
+      end
+
+      yield repo
+    end
+  end
+      
+  def home
+    @home ||= Pathname.new(ENV["HOME"])
+  end
+end

data/lib/gitoc/repository.rb

@@ -0,0 +1,59 @@
+require "open3"
+require "pathname"
+
+class Gitoc::Repository
+  class << self
+    attr_accessor :base
+
+    def load attribute
+      new base.join(attribute[:path]), attribute[:url]
+    end
+  end
+
+  # Path to the git repository
+  attr_reader :path
+
+  def initialize path, url = nil
+    @path = Pathname.new(path).expand_path
+    @url = url
+  end
+
+  def to_hash
+    {
+      path: path.relative_path_from(self.class.base).to_s,
+      url: url
+    }
+  end
+
+  def exist?
+    path.exist?
+  end
+
+  def url?
+    !(url.nil? || url.empty?)
+  end
+
+  def url
+    @url ||= begin
+      out, _status = run_in path, "git config remote.origin.url"
+      out.chomp
+    end
+  end
+
+  def clone
+    return unless url?
+    path.parent.mkpath
+    run_in path.parent, "git clone #{url}"
+  end
+
+  def pull
+    return unless exist?
+    run_in path, "git pull"
+  end
+
+  def run_in path, cmd
+    Dir.chdir path do
+      Open3.capture2 cmd
+    end
+  end
+end

data/lib/gitoc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gitoc
+  VERSION = "0.2.0"
+end

data/lib/gitoc.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "gitoc/version"
+
+module Gitoc
+  class Error < StandardError; end
+  # Your code goes here...
+
+  autoload :Cli, "gitoc/cli"
+  autoload :Repository, "gitoc/repository"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: gitoc
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Patrick Marchi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: Manage git repositories in directory tree.
+email:
+- mail@patrickmarchi.ch
+executables:
+- gitoc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitoc
+- gitoc.gemspec
+- lib/gitoc.rb
+- lib/gitoc/cli.rb
+- lib/gitoc/repository.rb
+- lib/gitoc/version.rb
+homepage: https://github.com/pmarchi/gitoc
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/pmarchi/gitoc
+  source_code_uri: https://github.com/pmarchi/gitoc
+  changelog_uri: https://github.com/pmarchi/gitoc/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: gitoc 0.2.0
+test_files: []