ballantine 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2188ad3272546c25226bdbb1209075baadee05fb7f011cafe13874b1af45777
+  data.tar.gz: 0fe5889c616c93c7f62ce8353671543750604fc4c6def9958abdfe3a0f6e5c42
+SHA512:
+  metadata.gz: ab52789a4ae2fb510d48f34cd7cf8c2920610e5f341fdbbd94f687fee7ace7ff1f1ff7cbce32fe2e4ce78a783762aa29cf1c9053be5f042ef5b12f84f9101b28
+  data.tar.gz: bda07819f4146ac05b3ab1c39f4debe647f9c72a3a1dc50cfac433bf3381ecc6b96e96c92559775c08ecbf4f4e14b39a235a5a23d8636d2e956b6eddee33ad60

data/bin/ballantine

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'ballantine'
+Ballantine::CLI.start

data/lib/ballantine/author.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+class Author
+  attr_accessor :name, :commits
+
+  class << self
+    # @param [String] name
+    # @return [Author] author
+    def find_or_create_by(name)
+      @@_collections = {} unless defined?(@@_collections)
+      return @@_collections[name] unless @@_collections[name].nil?
+      @@_collections[name] = new(name)
+    end
+
+    # @return [Array<Author>] authors
+    def all
+      return [] unless defined?(@@_collections)
+      @@_collections.sort.map(&:last) # sort and take values
+    end
+  end
+
+  # @param [String] name
+  def initialize(name)
+    @name = name
+    @commits = {}
+  end
+
+  # @return [NilClass] nil
+  def print_commits
+    puts "\n" + "@#{name}".green
+    @commits.each do |repo, lists|
+      count, word = retrieve_count_and_word(lists)
+      puts " > #{repo.blue}: #{count} new #{word}\n"
+      puts lists
+    end
+    nil
+  end
+
+  # returns an array to use slack attachments field
+  # reference: https://api.slack.com/messaging/composing/layouts#building-attachments
+  # @return [Hash] result
+  def serialize_commits
+    message = @commits.map do |repo, lists|
+      count, word = retrieve_count_and_word(lists)
+      "*#{repo}*: #{count} new #{word}\n#{lists.join("\n")}"
+    end.join("\n")
+
+    results = {
+      'text' => "- <@#{name}>\n#{message}",
+      'color' => '#00B86A', # green
+    }
+  end
+
+  private
+
+  # @param [Array<String>] lists
+  # @param [Array(Integer, String)] count, word
+  def retrieve_count_and_word(lists)
+    count = lists.size
+    word = count == 1 ? 'commit' : 'commits'
+    [count, word]
+  end
+end

data/lib/ballantine/cli.rb

@@ -0,0 +1,256 @@
+#!/usr/bin/env ruby
+
+module Ballantine
+  require 'thor'
+  require 'json'
+  require_relative './author'
+  require_relative './string'
+
+  class CLI < Thor
+    # reference: https://github.com/desktop/desktop/blob/a7bca44088b105a04714dc4628f4af50f6f179c3/app/src/lib/remote-parsing.ts#L27-L44
+    GITHUB_REGEXES = [
+      '^https?://(.+)/(.+)/(.+)\.git/?$', # protocol: https -> https://github.com/oohyun15/ballantine.git | https://github.com/oohyun15/ballantine.git/
+      '^https?://(.+)/(.+)/(.+)/?$',      # protocol: https -> https://github.com/oohyun15/ballantine | https://github.com/oohyun15/ballantine/
+      '^git@(.+):(.+)/(.+)\.git$',        # protocol: ssh   -> git@github.com:oohyun15/ballantine.git
+      '^git@(.+):(.+)/(.+)/?$',           # protocol: ssh   -> git@github.com:oohyun15/ballantine | git@github.com:oohyun15/ballantine/
+      '^git:(.+)/(.+)/(.+)\.git$',        # protocol: ssh   -> git:github.com/oohyun15/ballantine.git
+      '^git:(.+)/(.+)/(.+)/?$',           # protocol: ssh   -> git:github.com/oohyun15/ballantine | git:github.com/oohyun15/ballantine/
+      '^ssh://git@(.+)/(.+)/(.+)\.git$',  # protocol: ssh   -> ssh://git@github.com/oohyun15/ballantine.git
+    ].freeze
+
+    FILE_GITMODULES = '.gitmodules'
+    FILE_BALLANTINE_CONFIG = '.ballantine.json'
+
+    TYPE_TERMINAL = 'terminal'
+    TYPE_SLACK = 'slack'
+
+    DEFAULT_LJUST = 80
+
+    AVAILABLE_CONFIG = ['slack_webhook'].freeze
+
+    attr_reader :app_name, :main_path, :sub_path, :slack_webhook, :send_type
+
+    package_name 'Ballantine'
+
+    desc 'init', 'Initialize ballantine configuration'
+    def init
+      puts "🥃 Init ballantine configuration"
+      slack_webhook = ask("Q. Set slack webhook\n> ")
+
+      config = {
+        slack_webhook: slack_webhook
+      }
+      File.write('./' + FILE_BALLANTINE_CONFIG, JSON.dump(config))
+    end
+
+    desc 'config', 'Describe ballantine configuration'
+    def config
+      load_config
+      AVAILABLE_CONFIG.each do |key|
+        puts "#{key}: #{instance_variable_get('@' + key)}"
+      end
+    end
+
+    desc 'diff [TARGET] [SOURCE]', 'Diff commits between TARGET and SOURCE'
+    option TYPE_SLACK, type: :boolean, aliases: '-s', default: false, desc: 'send to slack using slack webhook URL.'
+    def diff(from, to = `git rev-parse --abbrev-ref HEAD`.chomp)
+      load_config
+      preprocess(from, to, **options)
+
+      # check argument is tag
+      from = check_tag(from)
+      to = check_tag(to)
+
+      # check commits are newest
+      system 'git pull -f &> /dev/null'
+
+      # set instance variables
+      @send_type = options[TYPE_SLACK] ? TYPE_SLACK : TYPE_TERMINAL
+      @app_name = File.basename(`git config --get remote.origin.url`.chomp, '.git')
+      @main_path = Dir.pwd
+      @sub_path = if Dir[FILE_GITMODULES].any?
+        file = File.open(FILE_GITMODULES)
+        lines = file.readlines.map(&:chomp)
+        file.close
+        lines.grep(/path =/).map{ |line| line[/(?<=path \=).*/, 0].strip }.sort
+      else
+        []
+      end
+
+      # find github url, branch
+      main_url = github_url(`git config --get remote.origin.url`.chomp)
+      current_branch = `git rev-parse --abbrev-ref HEAD`.chomp
+
+      # get commit hash
+      main_from, sub_from = commit_hash(from)
+      main_to, sub_to = commit_hash(to)
+      system "git checkout #{current_branch} -f &> /dev/null"
+
+      # check commits
+      check_commits(main_from, main_to, main_url)
+      @sub_path.each_with_index do |path, idx|
+        next if sub_from[idx] == sub_to[idx]
+        Dir.chdir(path)
+        sub_url = github_url(`git config --get remote.origin.url`.chomp)
+        check_commits(sub_from[idx], sub_to[idx], sub_url)
+        Dir.chdir(@main_path)
+      end
+
+      send_commits(from, to, main_url)
+
+      exit 0
+    end
+
+    desc 'version', 'Display version information about ballntine'
+    def version
+      puts "ballantine version #{Ballantine::VERSION}"
+    end
+
+    private
+
+    def self.exit_on_failure?
+      exit 1
+    end
+
+    def load_config
+      return if Dir[FILE_BALLANTINE_CONFIG].empty?
+
+      JSON.parse(File.read('./' + FILE_BALLANTINE_CONFIG)).each do |key, value|
+        next unless AVAILABLE_CONFIG.include?(key)
+        instance_variable_set('@' + key, value)
+      end
+    end
+
+    # @param [String] from
+    # @param [String] to
+    # @param [Hash] options
+    # @return [NilClass] nil
+    def preprocess(from, to, **options)
+      if Dir['.git'].empty?
+        raise SystemCallError, "ERROR: There is no \".git\" in #{Dir.pwd}."
+      end
+
+      if (uncommitted = `git diff HEAD --name-only`.split("\n")).any?
+        raise SystemCallError, "ERROR: Uncommitted file exists. stash or commit uncommitted files.\n#{uncommitted.join("\n")}"
+      end
+
+      if from == to
+        raise ArgumentError, "ERROR: target(#{from}) and source(#{to}) can't be equal."
+      end
+
+      if options[TYPE_SLACK] && !@slack_webhook
+        raise ArgumentError, "ERROR: Can't find any slack webhook. Set slack webhook using `ballantine init`."
+      end
+
+      nil
+    end
+
+    # @param [String] name
+    # @return [String] hash
+    def check_tag(name)
+      list = `git tag -l`.split("\n")
+      return name unless list.grep(name).any?
+
+      system "git fetch origin tag #{name} -f &> /dev/null"
+      `git rev-list -n 1 #{name}`.chomp[0...7]
+    end
+
+    # @param [String] from
+    # @param [String] to
+    # @param [String] url
+    # @return [NilClass] nil
+    def check_commits(from, to, url)
+      repo = File.basename(`git config --get remote.origin.url`.chomp, '.git')
+      names = `git --no-pager log --pretty=format:"%an" #{from}..#{to}`.split("\n").uniq.sort
+      authors = names.map{ |name| Author.find_or_create_by(name) }
+      authors.each do |author|
+        format = commit_format(url, ljust: DEFAULT_LJUST - 10)
+        commits = `git --no-pager log --reverse --no-merges --author="#{author.name}" --format="#{format}" --abbrev=7 #{from}..#{to}`.gsub('"', '\"').gsub(/[\u0080-\u00ff]/, '')
+        next if commits.empty?
+        author.commits[repo] = commits.split("\n")
+      end
+      nil
+    end
+
+    # @param [String] url
+    # @return [String] github_url
+    def github_url(url)
+      owner, repository = GITHUB_REGEXES.each do |regex|
+        if (str = url.match(regex))
+          break [str[2], str[3]]
+        end
+      end
+
+      "https://github.com/#{owner}/#{repository}"
+    end
+
+    # @param [String] hash
+    # @param [Array<String>] sub_path
+    # @return [Array(String, Array<String>)] main, sub's hash
+    def commit_hash(hash)
+      system "git checkout #{hash} -f &> /dev/null"
+      system 'git pull &> /dev/null'
+      main_hash = `git --no-pager log -1 --format='%h'`.chomp
+      sub_hash = if @sub_path.any?
+        `git ls-tree HEAD #{@sub_path.join(' ')}`.split("\n").map{ |line| line.split(' ')[2] }
+      else
+        []
+      end
+
+      [main_hash, sub_hash]
+    end
+
+    # @param [String] url
+    # @param [String] format
+    # @param [Integer] ljust
+    def commit_format(url, ljust: DEFAULT_LJUST)
+      case @send_type
+      when TYPE_TERMINAL
+        " - "+ "%h".yellow + " %<(#{ljust})%s " + "#{url}/commit/%H".gray
+      when TYPE_SLACK
+        "\\\`<#{url}/commit/%H|%h>\\\` %s - %an"
+      end
+    end
+
+    # @param [String] from
+    # @param [String] to
+    # @param [String] url
+    # @return [NilClass] nil
+    def send_commits(from, to, url)
+      authors = Author.all
+      if authors.empty?
+        raise ArgumentError, "ERROR: There is no commits between \"#{from}\" and \"#{to}\""
+      end
+      number = authors.size
+      last_commit = `git --no-pager log --reverse --format="#{commit_format(url, ljust: DEFAULT_LJUST - 22)}" --abbrev=7 #{from}..#{to} -1`.strip
+
+      case @send_type
+      when TYPE_TERMINAL
+        puts "Check commits before #{@app_name.red} deployment. (#{from.cyan} <- #{to.cyan})".ljust(DEFAULT_LJUST + 34) + " #{url}/compare/#{from}...#{to}".gray
+        puts "Author".yellow + ": #{number}"
+        puts "Last commit".blue + ": #{last_commit}"
+        authors.map(&:print_commits)
+      when TYPE_SLACK
+        # set message for each author
+        messages = authors.map(&:serialize_commits)
+        actor = `git config user.name`
+
+        # send message to slack
+        require 'net/http'
+        require 'uri'
+        uri = URI.parse(@slack_webhook)
+        request = Net::HTTP::Post.new(uri)
+        request.content_type = 'application/json'
+        request.body = JSON.dump({
+          'text' => ":check: *#{@app_name}* deployment request by <@#{actor}> (\`<#{url}/tree/#{from}|#{from}>\` <- \`<#{url}/tree/#{to}|#{to}>\` <#{url}/compare/#{from}...#{to}|compare>)\n:technologist: Author: #{number}\nLast commit: #{last_commit}",
+          'attachments' => messages
+        })
+        req_options = { use_ssl: uri.scheme == 'https' }
+        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+          http.request(request)
+        end
+        puts response.message
+      end
+    end
+  end
+end

data/lib/ballantine/string.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# @override
+class String
+  NC =     "\e[0m"
+  GRAY =   "\e[1;30m"
+  RED =    "\e[1;31m"
+  GREEN =  "\e[1;32m"
+  YELLOW = "\e[1;33m"
+  BLUE =   "\e[1;34m"
+  CYAN =   "\e[1;36m"
+
+  def gray;   "#{GRAY}#{self}#{NC}"   end
+  def red;    "#{RED}#{self}#{NC}"    end
+  def green;  "#{GREEN}#{self}#{NC}"  end
+  def yellow; "#{YELLOW}#{self}#{NC}" end
+  def blue;   "#{BLUE}#{self}#{NC}"   end
+  def cyan;   "#{CYAN}#{self}#{NC}"   end
+end

data/lib/ballantine/version.rb

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

data/lib/ballantine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require_relative "ballantine/cli"
+require_relative "ballantine/version"
+
+module Ballantine
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: ballantine
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- oohyun15
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+description: Ballantine helps you describe your commits easier and prettier from cli
+  & slack.
+email:
+- sakiss4774@gmail.com
+executables:
+- ballantine
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/ballantine
+- lib/ballantine.rb
+- lib/ballantine/author.rb
+- lib/ballantine/cli.rb
+- lib/ballantine/string.rb
+- lib/ballantine/version.rb
+homepage: https://github.com/oohyun15/ballantine
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Describe your commits.
+test_files: []