herdsman 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f18f584c60859f1587dd80aaa46f302cab09efb6
+  data.tar.gz: e8a287c600b82bea7fed32924ab6779b3557e77c
+SHA512:
+  metadata.gz: 4413b1e186657cd9dbc41be92e6530b509e022fdf1bc1cb604c022a58dcec676acca1f7f67db6ffccf0edfc4f5b43988670d5bfb12787b8cf136b4d5fbf912d2
+  data.tar.gz: 80d372ceb0e04bf9baf7775bdf404a6708b7c8ea4bc894ecc0d26e5e4f8ba8b894ea9fa988a9811806441f7e22ec66fce982171031026468ed7d8c69c8661432

data/README.md

@@ -0,0 +1,64 @@
+# Herdsman
+
+Herdsman is a command line utility for working with multiple Git repositories.
+
+## Installation
+
+```sh
+gem install herdsman
+```
+
+## Usage
+
+```
+Commands:
+  herdsman help [COMMAND]  # Describe available commands or one specific command
+  herdsman status          # Check the status of the repositories in the herd
+  herdsman version         # Show the herdsman version
+
+Options:
+  q, [--quiet], [--no-quiet]
+```
+
+### `herdsman status`
+
+`herdsman status` will check each of the repositories in the herd:
+* for untracked files
+* for modified files
+* for unpushed commits
+* for unpulled commits
+* is on the specified revision (defaults to `master`)
+
+```
+$ herdsman status
+WARN: foo-repo has untracked files
+WARN: foo-repo has modified files
+INFO: bar-repo is ok
+WARN: baz-repo has unpushed commits
+WARN: baz-repo has unpulled commits
+WARN: baz-repo revision is not 'qux-branch'
+```
+
+Exits `0` if all checks pass. Exits `1` if any of the repositories in the herd fail any of the checks.
+
+## Configuration
+
+Configure the herd of repositories to manage with a `herdsman.yml` file in the current working directory.
+
+Example:
+
+```yml
+repos:
+  - /path/to/foo-repo
+  - ../../path/to/bar-repo
+  - path: /path/to/baz-repo
+    revision: qux-branch    # defaults to `master` if unset
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Credits
+
+* [Thoughtbot's gitsh](https://github.com/thoughtbot/gitsh) Git shell, which was referenced for much of the Git CLI integration.

data/bin/herdsman

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'herdsman'
+require 'herdsman/cli'
+
+Herdsman::CLI.start

data/herdsman.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+require 'herdsman/version'
+
+Gem::Specification.new do |spec|
+  spec.authors       = ['Tom Marshall']
+  spec.description   =
+    'Herdsman is a CLI utility for working with multiple Git repositories'
+  spec.files         = %w(herdsman.gemspec) + Dir['*.md',
+                                                  'bin/*',
+                                                  'lib/**/*.rb']
+  spec.email         = 'tommarshall7@gmail.com'
+  spec.executables   = ['herdsman']
+  spec.homepage      = 'https://github.com/tommarshall/herdsman'
+  spec.license       = 'MIT'
+  spec.name          = 'herdsman'
+  spec.require_paths = ['lib']
+  spec.summary       =
+    'A CLI utility for working with multiple Git repositories'
+  spec.version       = Herdsman::VERSION
+end

data/lib/herdsman/cli.rb

@@ -0,0 +1,60 @@
+require 'thor'
+
+module Herdsman
+  class CLI < Thor
+    require 'herdsman'
+
+    class_option :quiet, type: :boolean, aliases: :q
+
+    default_task :status
+
+    desc 'status', 'Check the status of the repositories in the herd'
+    def status
+      cmd = Herdsman::Command::Status.new(herd: herd, logger: logger)
+      result = cmd.run
+      exit result
+    end
+
+    desc 'version', 'Show the herdsman version'
+    map %w(-v --version) => :version
+    def version
+      puts "Herdsman version #{Herdsman::VERSION}"
+    end
+
+    private
+
+    def config
+      Herdsman::Config.new(File.expand_path('herdsman.yml', Dir.pwd))
+    rescue
+      $stderr.puts "ERROR: #{$!.message}"
+      exit 1
+    end
+
+    def env
+      Herdsman::Environment.new
+    end
+
+    def herd
+      Herdsman::Herd.new(env, config, herd_members(config.repos))
+    end
+
+    def logger
+      writer = Logger.new(STDOUT)
+      writer.formatter = proc do |severity, _, _, msg|
+        "#{severity.upcase}: #{msg}\n"
+      end
+      logger = Herdsman::LogAdapter.new(writer)
+      logger.adjust_verbosity(quiet: options[:quiet])
+      logger
+    end
+
+    def herd_members(repos)
+      repos.map do |repo|
+        Herdsman::HerdMember.new(
+          Herdsman::GitRepo.new(env, repo.path),
+          repo.revision,
+        )
+      end
+    end
+  end
+end

data/lib/herdsman/command/status.rb

@@ -0,0 +1,23 @@
+module Herdsman
+  module Command
+    class Status
+      def initialize(args = {})
+        @herd   = args[:herd]
+        @logger = args[:logger]
+      end
+
+      def run
+        herd.members.each do |herd_member|
+          herd_member.status_report.each do |message|
+            logger.send(message.level, message.msg)
+          end
+        end
+        herd.gathered?
+      end
+
+      private
+
+      attr_reader :herd, :logger
+    end
+  end
+end

data/lib/herdsman/config.rb

@@ -0,0 +1,67 @@
+require 'yaml'
+
+module Herdsman
+  class Config
+    def initialize(path)
+      @config = read_config!(path)
+      validate!
+    end
+
+    def repos
+      config_repos = config['repos'] || []
+      config_repos.map do |repo_config|
+        RepoConfig.new(repo_config)
+      end
+    end
+
+    private
+
+    attr_reader :config
+
+    class RepoConfig
+      def initialize(repo_config)
+        @repo_config = repo_config
+      end
+
+      def path
+        if repo_config.is_a?(Hash)
+          repo_config['path']
+        else
+          repo_config
+        end
+      end
+
+      def revision
+        if repo_config.is_a?(Hash) && repo_config.include?('revision')
+          repo_config['revision']
+        else
+          default_revision
+        end
+      end
+
+      private
+
+      attr_reader :repo_config
+
+      def default_revision
+        'master'
+      end
+    end
+
+    def read_config!(path)
+      YAML.load_file(path)
+    rescue
+      raise 'No config found'
+    end
+
+    def validate!
+      raise 'Invalid config' unless config.is_a?(Hash) && repos.is_a?(Array)
+      raise 'No repos defined' if repos.empty?
+      repos.each do |repo|
+        unless File.directory?(repo.path)
+          raise "#{repo.path} is not a directory"
+        end
+      end
+    end
+  end
+end

data/lib/herdsman/environment.rb

@@ -0,0 +1,10 @@
+module Herdsman
+  class Environment
+    DEFAULT_GIT_COMMAND = '/usr/bin/env git'.freeze
+
+    attr_accessor :git_command
+    def initialize
+      @git_command = DEFAULT_GIT_COMMAND
+    end
+  end
+end

data/lib/herdsman/git_repo.rb

@@ -0,0 +1,101 @@
+require 'open3'
+
+module Herdsman
+  class GitRepo
+    attr_reader :path
+    def initialize(env, path)
+      @env  = env
+      @path = path
+    end
+
+    def initialized?
+      !git_dir.empty? && File.exist?(path + '/' + git_dir)
+    end
+
+    def git_dir
+      git_output('rev-parse --git-dir')
+    end
+
+    def current_head
+      current_branch_name || current_tag_name || abbreviated_commit_ref
+    end
+
+    def has_untracked_files?
+      status.untracked_files.any?
+    end
+
+    def has_modified_files?
+      status.modified_files.any?
+    end
+
+    def has_unpushed_commits?
+      git_output('log --oneline @{u}..').lines.any?
+    end
+
+    def has_unpulled_commits?
+      fetch
+      git_output('log --oneline ..@{u}').lines.any?
+    end
+
+    def revision?(revision)
+      [current_branch_name, current_tag_name, abbreviated_commit_ref].include?(
+        revision,
+      )
+    end
+
+    private
+
+    attr_reader :env
+
+    def current_branch_name
+      branch_name = git_output('symbolic-ref HEAD --short')
+      branch_name unless branch_name.empty?
+    end
+
+    def current_tag_name
+      tag_name = git_output('describe --exact-match --tags HEAD')
+      tag_name unless tag_name.empty?
+    end
+
+    def abbreviated_commit_ref
+      commit_ref = git_output('rev-parse HEAD')
+      commit_ref[0, 7].to_s unless commit_ref.empty?
+    end
+
+    def status
+      StatusParser.new(git_output('status --porcelain'))
+    end
+
+    def fetch
+      git_output('fetch --all')
+    end
+
+    def git_output(command)
+      Dir.chdir(File.expand_path(path, Dir.pwd)) do
+        Open3.capture3(git_command(command)).first.chomp
+      end
+    end
+
+    def git_command(sub_command)
+      "#{env.git_command} #{sub_command}"
+    end
+
+    class StatusParser
+      def initialize(status_porcelain)
+        @status_porcelain = status_porcelain
+      end
+
+      def untracked_files
+        status_porcelain.lines.select { |l| l.start_with?('??') }
+      end
+
+      def modified_files
+        status_porcelain.lines.select { |l| l =~ /^ ?[A-Z]/ }
+      end
+
+      private
+
+      attr_reader :status_porcelain
+    end
+  end
+end

data/lib/herdsman/herd.rb

@@ -0,0 +1,18 @@
+module Herdsman
+  class Herd
+    attr_reader :members
+    def initialize(env, config, members)
+      @env = env
+      @config = config
+      @members = members
+    end
+
+    def gathered?
+      members.all?(&:gathered?)
+    end
+
+    private
+
+    attr_reader :env
+  end
+end

data/lib/herdsman/herd_member.rb

@@ -0,0 +1,85 @@
+module Herdsman
+  class HerdMember
+    attr_reader :name
+    def initialize(repo, revision, args = {})
+      @repo     = repo
+      @revision = revision
+      @name     = args[:name] || default_name
+    end
+
+    def gathered?
+      [repo_initialized?,
+       repo_has_zero_unpushed_commits?,
+       repo_has_zero_unpulled_commits?,
+       repo_has_zero_untracked_files?,
+       repo_has_zero_modified_files?,
+       repo_on_specified_revision?].all?
+    end
+
+    def status_report
+      clear_messages
+      messages << Message.new(:info, "#{name} is ok") if gathered?
+      messages
+    end
+
+    private
+
+    attr_reader :repo, :revision
+
+    def default_name
+      File.basename(repo.path)
+    end
+
+    Message = Struct.new(:level, :msg)
+
+    def messages
+      @messages ||= []
+    end
+
+    def clear_messages
+      @messages = []
+    end
+
+    def repo_initialized?
+      unless repo.initialized?
+        messages << Message.new(:warn, "#{repo.path} is not a git repo")
+      end
+      repo.initialized?
+    end
+
+    def repo_has_zero_unpushed_commits?
+      if repo.has_unpushed_commits?
+        messages << Message.new(:warn, "#{name} has unpushed commits")
+      end
+      !repo.has_unpushed_commits?
+    end
+
+    def repo_has_zero_unpulled_commits?
+      if repo.has_unpulled_commits?
+        messages << Message.new(:warn, "#{name} has unpulled commits")
+      end
+      !repo.has_unpulled_commits?
+    end
+
+    def repo_has_zero_untracked_files?
+      if repo.has_untracked_files?
+        messages << Message.new(:warn, "#{name} has untracked files")
+      end
+      !repo.has_untracked_files?
+    end
+
+    def repo_has_zero_modified_files?
+      if repo.has_modified_files?
+        messages << Message.new(:warn, "#{name} has modified files")
+      end
+      !repo.has_modified_files?
+    end
+
+    def repo_on_specified_revision?
+      if repo.initialized? && !repo.revision?(revision)
+        messages << Message.new(:warn, "#{name} revision is not '#{revision}'")
+      end
+      !repo.initialized? || repo.revision?(revision)
+    end
+  end
+end

data/lib/herdsman/log_adapter.rb

@@ -0,0 +1,46 @@
+module Herdsman
+  class LogAdapter
+    attr_accessor :writer
+
+    LOG_LEVELS = {
+      debug: ::Logger::DEBUG,
+      info:  ::Logger::INFO,
+      warn:  ::Logger::WARN,
+      error: ::Logger::ERROR,
+    }.freeze
+
+    def log_level
+      writer.level
+    end
+
+    def log_level=(level)
+      writer.level = LOG_LEVELS.fetch(level)
+    end
+
+    def adjust_verbosity(options = {})
+      if options[:quiet]
+        self.log_level = :error
+      end
+    end
+
+    def initialize(writer)
+      @writer = writer
+    end
+
+    def debug(message)
+      writer.debug(message)
+    end
+
+    def info(message)
+      writer.info(message)
+    end
+
+    def warn(message)
+      writer.warn(message)
+    end
+
+    def error(message)
+      writer.error(message)
+    end
+  end
+end

data/lib/herdsman/version.rb

@@ -0,0 +1,3 @@
+module Herdsman
+  VERSION = '0.1.0'.freeze
+end

data/lib/herdsman.rb

@@ -0,0 +1,9 @@
+require 'logger'
+require 'herdsman/command/status'
+require 'herdsman/config'
+require 'herdsman/environment'
+require 'herdsman/git_repo'
+require 'herdsman/herd'
+require 'herdsman/herd_member'
+require 'herdsman/log_adapter'
+require 'herdsman/version'

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: herdsman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Marshall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-20 00:00:00.000000000 Z
+dependencies: []
+description: Herdsman is a CLI utility for working with multiple Git repositories
+email: tommarshall7@gmail.com
+executables:
+- herdsman
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/herdsman
+- herdsman.gemspec
+- lib/herdsman.rb
+- lib/herdsman/cli.rb
+- lib/herdsman/command/status.rb
+- lib/herdsman/config.rb
+- lib/herdsman/environment.rb
+- lib/herdsman/git_repo.rb
+- lib/herdsman/herd.rb
+- lib/herdsman/herd_member.rb
+- lib/herdsman/log_adapter.rb
+- lib/herdsman/version.rb
+homepage: https://github.com/tommarshall/herdsman
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A CLI utility for working with multiple Git repositories
+test_files: []