ballantine 0.1.4.pre.beta2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 205e73804edf1a3ea9c16ddabb4dc3f5d1cc916300ff6f59576112153d8fadaa
-  data.tar.gz: 3a742736e8db01a38761b0a395a94e7e16083edd35ff8cf460c77e4db0f797d5
+  metadata.gz: 7dc81ef643fe888582cb999e267066d56fde114d898a234122ea2165b79a6153
+  data.tar.gz: 823bb10cd43e75743c26fc61b65d2512229438b7232a3e779a20a53e7ff9bad1
 SHA512:
-  metadata.gz: 41654e7d79f79ca6a0c5a556e567ec40f64f343797b92c748c6930d012c6cf49c9674878aa81ad9e7d50f42f8740208a0003f7bf9cde5e11bc674f0f8e8d0b5a
-  data.tar.gz: 214c98d8b880faf7b68aeefa65a5670c688186d2b3e2f3098e2c3ed42cd80f221282ce441de10b6ea12e2569ec977f4062954100206fedcf0f5eae509ca70a26
+  metadata.gz: f55eb551e6c00ea8b6b1c59abfdae3d69742b7eab52cf8739a51d4d38918b4f77fe8f69f5e88c6418dec0e57cb4bb3892ea36ae64540ff19f79f31a01a5e3af0
+  data.tar.gz: 7abba991f1cb76e9f56d1685e06cd490d66bc48d6dff53d3078eae7ef42fe627028ee0b791aafb8ea1c9b82975e9ee36461d7a2d2f448518ab3d33870681a346

data/lib/ballantine/author.rb

@@ -2,16 +2,22 @@
 
 module Ballantine
   class Author
+    include Printable
+
     attr_reader :name, :commits_hash
 
     class << self
       # @param [String] name
-      # @return [Author] author
-      def find_or_create_by(name:)
+      # @return [Author, NilClass]
+      def find(name:)
         @_collections = {} unless defined?(@_collections)
-        return @_collections[name] unless @_collections[name].nil?
+        @_collections[name]
+      end
 
-        @_collections[name] = new(name:)
+      # @param [String] name
+      # @return [Author]
+      def find_or_create_by(name:)
+        find(name:) || @_collections[name] = new(name:)
       end
 
       # @return [Array<Author>] authors
@@ -30,11 +36,15 @@ module Ballantine
 
     # @return [Boolean]
     def print_commits
+      conf.print_log(binding) if conf.verbose
+
       puts "\n" + "@#{name}".green
       commits_hash.each do |repo_name, commits|
         count, word = retrieve_count_and_word(commits)
-        puts " > #{repo_name.blue}: #{count} new #{word}\n"
-        puts commits.map(&:message)
+        puts " > #{repo_name.blue}: #{count} new #{word}"
+        commits.each do |commit|
+          puts_r " - #{commit.hash.yellow} #{commit.subject}", commit.url.gray
+        end
       end
 
       true
@@ -42,11 +52,14 @@ module Ballantine
 
     # returns an array to use slack attachments field
     # reference: https://api.slack.com/messaging/composing/layouts#building-attachments
-    # @return [Hash] result
-    def serialize_commits
+    # @return [Hash]
+    def slack_message
+      conf.print_log(binding) if conf.verbose
+
       message = commits_hash.map do |repo_name, commits|
         count, word = retrieve_count_and_word(commits)
-        "*#{repo_name}*: #{count} new #{word}\n#{commits.map(&:message).join("\n")}"
+        "*#{repo_name}*: #{count} new #{word}\n" \
+          "#{commits.map(&:slack_message).join("\n")}"
       end.join("\n")
 
       {
@@ -57,6 +70,8 @@ module Ballantine
 
     private
 
+    def conf; Config.instance end
+
     # @param [Array<Commit>] commits
     # @param [Array(Integer, String)] count, word
     def retrieve_count_and_word(commits)

data/lib/ballantine/cli.rb

@@ -2,10 +2,9 @@
 
 module Ballantine
   class CLI < Thor
-    TYPE_TERMINAL = "terminal"
-    TYPE_SLACK = "slack"
+    include Printable
 
-    attr_reader :send_type, :repo
+    attr_reader :repo
 
     class << self
       def exit_on_failure?; exit(1) end
@@ -23,8 +22,12 @@ module Ballantine
     end
 
     Config::AVAILABLE_ENVIRONMENTS.each { |env| option env, type: :boolean, default: false, desc: "Set envirment to `#{env}'." }
+    option "verbose", type: :boolean, default: false, desc: "Print a progress."
     desc "config [--env] [KEY] [VALUE]", "Set ballantine's configuration"
     def config(key = nil, value = nil)
+      conf.verbose = options["verbose"]
+      puts "$ ballantine config #{key} #{value}" if conf.verbose
+
       # check environment value
       if Config::AVAILABLE_ENVIRONMENTS.map { |key| !options[key] }.reduce(:&)
         raise NotAllowed, "Set environment value (#{Config::AVAILABLE_ENVIRONMENTS.map { |key| "`--#{key}'" }.join(", ")})"
@@ -32,31 +35,31 @@ module Ballantine
         raise NotAllowed, "Environment value must be unique."
       end
 
-      @env = Config::AVAILABLE_ENVIRONMENTS.find { |key| options[key] }
-      raise AssertionFailed, "Environment value must exist: #{@env}" if @env.nil?
+      env = Config::AVAILABLE_ENVIRONMENTS.find { |key| options[key] }
+      raise AssertionFailed, "Environment value must exist: #{env}" if env.nil?
 
+      conf.env = env
       value ? conf.set_data(key, value) : conf.print_data(key)
     end
 
+    option "verbose", type: :boolean, default: false, desc: "Print a progress."
+    option Config::TYPE_SLACK, type: :boolean, aliases: "-s", default: false, desc: "Send to slack using slack webhook URL."
     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(target, source = %x(git rev-parse --abbrev-ref HEAD).chomp)
+      conf.verbose = options["verbose"]
+      puts "$ ballantine diff #{target} #{source}" if conf.verbose
+
       # validate arguments
       validate(target, source, **options)
 
-      # check commits are newest
-      system("git pull -f &> /dev/null")
-
       # init instance variables
       init_variables(target, source, **options)
 
       # check commits
       check_commits(**options)
 
-      # send commits
-      send_commits(target, source, **options)
-
-      exit(0)
+      # print commits
+      print_commits(target, source, **options)
     end
 
     desc "version", "Display version information about ballntine"
@@ -68,13 +71,15 @@ module Ballantine
 
     private
 
-    def conf; @conf ||= Config.new(@env) end
+    def conf; Config.instance end
 
     # @param [String] target
     # @param [String] source
     # @param [Hash] options
     # @return [NilClass] nil
     def validate(target, source, **options)
+      conf.print_log(binding) if conf.verbose
+
       if Dir[".git"].empty?
         raise NotAllowed, "ERROR: There is no \".git\" in #{Dir.pwd}."
       end
@@ -87,7 +92,7 @@ module Ballantine
         raise NotAllowed, "ERROR: target(#{target}) and source(#{source}) can't be equal."
       end
 
-      if options[TYPE_SLACK] && !conf.get_data(Config::KEY_SLACK_WEBHOOK)
+      if options[Config::TYPE_SLACK] && !conf.get_data(Config::KEY_SLACK_WEBHOOK)
         raise NotAllowed, "ERROR: Can't find any slack webhook. Set slack webhook using `ballantine config --#{Config::ENV_LOCAL} slack_webhook [YOUR_WEBHOOK]'."
       end
 
@@ -99,8 +104,12 @@ module Ballantine
     # @param [Hash] options
     # @return [Boolean]
     def init_variables(target, source, **options)
-      @send_type = options[TYPE_SLACK] ? TYPE_SLACK : TYPE_TERMINAL
-      Repository.send_type = @send_type
+      conf.print_log(binding) if conf.verbose
+
+      # check commits are newest
+      system("git pull -f &> /dev/null")
+
+      conf.print_type = options[Config::TYPE_SLACK] ? Config::TYPE_SLACK : Config::TYPE_TERMINAL
       @repo = Repository.find_or_create_by(
         path: Dir.pwd,
         remote_url: %x(git config --get remote.origin.url).chomp,
@@ -114,6 +123,8 @@ module Ballantine
     # @param [Hash] options
     # @return [Boolean]
     def check_commits(**options)
+      conf.print_log(binding) if conf.verbose
+
       repo.check_commits
 
       true
@@ -123,24 +134,25 @@ module Ballantine
     # @param [String] source
     # @param [Hash] options
     # @return [Boolean]
-    def send_commits(target, source, **options)
+    def print_commits(target, source, **options)
+      conf.print_log(binding) if conf.verbose
+
       authors = Author.all
       if authors.empty?
         raise ArgumentError, "ERROR: There is no commits between \"#{target}\" and \"#{source}\""
       end
 
       number = authors.size
-      last_commit = repo.print_last_commit
 
-      case send_type
-      when TYPE_TERMINAL
-        puts "Check commits before #{repo.name.red} deployment. (#{target.cyan} <- #{source.cyan})".ljust(Repository::DEFAULT_LJUST + 44) + " #{repo.url}/compare/#{repo.from.hash}...#{repo.to.hash}".gray
+      case conf.print_type
+      when Config::TYPE_TERMINAL
+        puts_r "Check commits before #{repo.name.red} deployment. (#{target.cyan}...#{source.cyan})", "#{repo.url}/compare/#{repo.from.hash}...#{repo.to.hash}".gray
         puts "Author".yellow + ": #{number}"
-        puts "Last commit".blue + ": #{last_commit}"
+        puts_r "#{"Last commit".blue}: #{repo.to.hash.yellow} #{repo.to.subject}", repo.to.url.gray
         authors.map(&:print_commits)
-      when TYPE_SLACK
+      when Config::TYPE_SLACK
         # set message for each author
-        messages = authors.map(&:serialize_commits)
+        messages = authors.map(&:slack_message)
         actor = %x(git config user.name).chomp
 
         # send message to slack
@@ -151,15 +163,15 @@ module Ballantine
         request.content_type = "application/json"
         request.body = JSON.dump({
           "text" => ":white_check_mark: *#{repo.name}* deployment request by <@#{actor}>" \
-            " (\`<#{repo.url}/tree/#{repo.from.hash}|#{target}>\` <- \`<#{repo.url}/tree/#{repo.to.hash}|#{source}>\` <#{repo.url}/compare/#{repo.from.hash}...#{repo.to.hash}|compare>)" \
-            "\n:technologist: Author: #{number}\nLast commit: #{last_commit}",
+            " (\`<#{repo.url}/tree/#{repo.from.hash}|#{target}>\`<#{repo.url}/compare/#{repo.from.hash}...#{repo.to.hash}|...>\`<#{repo.url}/tree/#{repo.to.hash}|#{source}>\`)" \
+            "\n:technologist: Author: #{number}\nLast commit: #{repo.to.slack_message}",
           "attachments" => messages,
         })
         req_options = { use_ssl: uri.scheme == "https" }
         response = Net::HTTP.start(uri.hostname, uri.port, req_options) { |http| http.request(request) }
         puts response.message
       else
-        raise AssertionFailed, "Unknown send type: #{send_type}"
+        raise AssertionFailed, "Unknown print type: #{conf.print_type}"
       end
 
       true

data/lib/ballantine/commit.rb

@@ -2,33 +2,45 @@
 
 module Ballantine
   class Commit
-    attr_reader :hash, :message # attributes
+    attr_reader :hash, :long_hash, :subject # attributes
     attr_reader :repo, :author # associations
 
     class << self
       # @param [String] hash
       # @param [Repository] repo
-      # @param [String] message
-      # @param [Author, NilClass] message
-      # @return [Commit]
-      def find_or_create_by(hash:, repo:, message: nil, author: nil)
+      # @return [Commit, NilClass]
+      def find(hash:, repo:)
         @_collections = {} unless defined?(@_collections)
-        index = "#{hash}-#{repo.name}"
-        return @_collections[index] unless @_collections[index].nil?
+        @_collections["#{hash[...7]}-#{repo.name}"]
+      end
 
-        @_collections[index] = new(hash:, repo:, message:, author:)
+      # @param [String] hash
+      # @param [Repository] repo
+      # @return [Commit]
+      def find_or_create_by(hash:, repo:)
+        find(hash:, repo:) || @_collections["#{hash[...7]}-#{repo.name}"] = new(hash:, repo:)
       end
     end
 
     # @param [String] hash
     # @param [Repository] repo
-    # @param [String] message
-    # @param [Author] author
-    def initialize(hash:, repo:, message:, author:)
-      @hash = hash
+    def initialize(hash:, repo:)
+      @hash = hash[...7]
       @repo = repo
-      @message = message
-      @author = author
+    end
+
+    # @return [Commit]
+    def update(**kwargs)
+      # TODO: validate keys and values
+      kwargs.each { |key, value| instance_variable_set("@#{key}", value) }
+      self
+    end
+
+    def url; @url ||= "#{repo.url}/commit/#{long_hash}" end
+
+    # @return [String]
+    def slack_message
+      "\`<#{url}|#{hash}>\` #{subject} - #{author.name}"
     end
   end
 end

data/lib/ballantine/config.rb

@@ -2,26 +2,40 @@
 
 module Ballantine
   class Config
+    FILE_BALLANTINE_CONFIG = ".ballantine.json"
     ENV_LOCAL = "local"
     ENV_GLOBAL = "global"
+    TYPE_TERMINAL = "terminal"
+    TYPE_SLACK = "slack"
     AVAILABLE_ENVIRONMENTS = [
       ENV_LOCAL,
       ENV_GLOBAL,
     ].freeze
-
     KEY_SLACK_WEBHOOK = "slack_webhook"
     AVAILABLE_KEYS = [
       KEY_SLACK_WEBHOOK,
     ].freeze
+    AVAILABLE_PRINT_INSTANCE_VARIABLES = [:@name, :@from, :@to].freeze
 
-    FILE_BALLANTINE_CONFIG = ".ballantine.json"
+    attr_reader :data, :loaded
+    attr_accessor :env, :print_type, :verbose
 
-    attr_reader :env, :data, :loaded
+    class << self
+      # @note singleton method
+      # @return [Config]
+      def instance(...)
+        return @_instance if defined?(@_instance)
 
-    def initialize(env)
-      @env = env || ENV_LOCAL
+        @_instance = new(...)
+      end
+    end
+
+    def initialize
+      @env = ENV_LOCAL
       @data = {}
       @loaded = false
+      @print_type = TYPE_TERMINAL
+      @verbose = false
     end
 
     # @param [Hash] options
@@ -87,6 +101,18 @@ module Ballantine
       @data[key]
     end
 
+    # @param [Binding] binding
+    # @return [NilClass]
+    def print_log(binding)
+      method = caller(1..1)[0][/`([^']*)'/, 1]
+
+      puts [
+        "#{binding.receiver.class.name}##{method}",
+        (binding.receiver.instance_variables & AVAILABLE_PRINT_INSTANCE_VARIABLES).map { |var| "#{var}:#{binding.receiver.instance_variable_get(var).inspect}" }.join(" "),
+        binding.receiver.method(method).parameters.map { |_, arg| arg }.map { |arg| "#{arg}:#{binding.local_variable_get(arg)}" }.join(" "),
+      ].compact.join("\t")
+    end
+
     private
 
     def file_path(env = @env)

data/lib/ballantine/repository.rb

@@ -13,21 +13,24 @@ module Ballantine
       '^ssh://git@(.+)/(.+)/(.+)\.git$',  # protocol: ssh   -> ssh://git@github.com/oohyun15/ballantine.git
     ].freeze
     FILE_GITMODULES = ".gitmodules"
-    DEFAULT_LJUST = 70
     PARSER_TOKEN = "!#!#"
 
-    attr_reader :name, :path, :owner, :url, :from, :to, :format # attributes
+    attr_reader :name, :path, :owner, :from, :to # attributes
     attr_reader :main_repo, :sub_repos, :commits # associations
 
     class << self
+      # @param [String] path
+      # @return [Repository, NilClass]
+      def find(path:)
+        @_collections = {} unless defined?(@_collections)
+        @_collections[path]
+      end
+
       # @param [String] path
       # @param [String] remote_url
       # @return [Repository]
       def find_or_create_by(path:, remote_url: nil)
-        @_collections = {} unless defined?(@_collections)
-        return @_collections[path] unless @_collections[path].nil?
-
-        @_collections[path] = new(path:, remote_url:)
+        find(path:) || @_collections[path] = new(path:, remote_url:)
       end
 
       # @return [Array<Repository>]
@@ -36,9 +39,6 @@ module Ballantine
 
         @_collections.values
       end
-
-      def send_type; @_send_type end
-      def send_type=(value); @_send_type = value end
     end
 
     # @param [String] path
@@ -51,14 +51,16 @@ module Ballantine
         str = remote_url.match(regex)
         break [str[2], str[3]] if str
       end
-      @url = "https://github.com/#{owner}/#{name}"
-      @format = check_format
     end
 
+    def url; @url ||= "https://github.com/#{owner}/#{name}" end
+
     # @param [String] target
     # @param [String] source
     # @return [Boolean]
     def init_variables(target, source)
+      conf.print_log(binding) if conf.verbose
+
       current_revision = %x(git rev-parse --abbrev-ref HEAD).chomp
 
       foo = lambda do |hash, context|
@@ -76,7 +78,7 @@ module Ballantine
         if sub_repos.any?
           %x(git ls-tree HEAD #{sub_repos.map(&:path).join(" ")}).split("\n").map do |line|
             _, _, sub_hash, sub_path = line.split(" ")
-            sub_repo = Repository.find_or_create_by(
+            sub_repo = Repository.find(
               path: path + "/" + sub_path,
             )
             sub_commit = Commit.find_or_create_by(
@@ -98,6 +100,8 @@ module Ballantine
 
     # @return [Boolean]
     def check_commits
+      conf.print_log(binding) if conf.verbose
+
       authors = retrieve_authors
       authors.each do |author|
         commits = retrieve_commits(author)
@@ -120,16 +124,9 @@ module Ballantine
       true
     end
 
-    # @return [String]
-    def print_last_commit
-      %x(git --no-pager log --reverse --format="#{check_format(ljust: DEFAULT_LJUST - 12)}" --abbrev=7 #{from.hash}..#{to.hash} -1).strip
-    end
-
     private
 
-    def send_type
-      self.class.send_type
-    end
+    def conf; Config.instance end
 
     # @param [String] name
     # @return [String] hash
@@ -141,16 +138,15 @@ module Ballantine
       %x(git rev-list -n 1 #{name}).chomp[0...7]
     end
 
-    # @param [Integer] ljust
     # @return [String]
-    def check_format(ljust: DEFAULT_LJUST)
-      case send_type
-      when CLI::TYPE_TERMINAL
+    def check_format
+      case conf.print_type
+      when Config::TYPE_TERMINAL
         " - " + "%h".yellow + " %<(#{ljust})%s " + "#{url}/commit/%H".gray
-      when CLI::TYPE_SLACK
+      when Config::TYPE_SLACK
         "\\\`<#{url}/commit/%H|%h>\\\` %s - %an"
       else
-        raise AssertionFailed, "Unknown send type: #{send_type}"
+        raise AssertionFailed, "Unknown print type: #{conf.print_type}"
       end
     end
 
@@ -187,19 +183,26 @@ module Ballantine
     # @param [Author] author
     # @return [Array<Commit>]
     def retrieve_commits(author)
+      command = <<~CMD.tr("\n", " ").strip
+        git --no-pager log --reverse --no-merges --author="#{author.name}"
+        --format="%h#{PARSER_TOKEN}%H#{PARSER_TOKEN}%s"
+        --abbrev=7 #{from.hash}..#{to.hash}
+      CMD
       results =
-        %x(git --no-pager log --reverse --no-merges --author="#{author.name}" --format="%h#{PARSER_TOKEN}#{format}" --abbrev=7 #{from.hash}..#{to.hash})
+        %x(#{command})
           .gsub('"', '\"')
           .gsub(/[\u0080-\u00ff]/, "")
           .split("\n")
 
       results.map do |result|
-        hash, message = result.split(PARSER_TOKEN)
+        hash, long_hash, subject = result.split(PARSER_TOKEN)
         Commit.find_or_create_by(
           hash: hash,
           repo: self,
-          message: message,
+        ).update(
           author: author,
+          long_hash: long_hash,
+          subject: subject,
         )
       end
     end

data/lib/ballantine/version.rb

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

data/lib/ballantine.rb

@@ -3,6 +3,7 @@
 require "thor"
 require "json"
 require_relative "string"
+require_relative "printable"
 require_relative "ballantine/version"
 require_relative "ballantine/config"
 require_relative "ballantine/author"

data/lib/printable.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Printable
+  # @param [String] msg
+  # @param [String] msg_r
+  # @return [NilClass]
+  def puts_r(msg, msg_r)
+    size = rjust_size(msg, msg_r)
+    puts msg + msg_r.rjust(size)
+  end
+
+  # @param [String] msg
+  # @param [String] msg_r
+  # @return [Integer]
+  def rjust_size(msg, msg_r)
+    sanitized = ->(str) { str.sanitize_colored.size + str.scan(/\p{Hangul}/).size }
+    cols - sanitized.call(msg) - sanitized.call(msg_r) + msg_r.size
+  end
+
+  # @return [Integer]
+  def cols
+    return @_cols if defined?(@_cols)
+
+    require "io/console"
+    _lines, @_cols = IO.console.winsize
+    @_cols
+  end
+end

data/lib/string.rb

@@ -16,4 +16,6 @@ class String
   def yellow; "#{YELLOW}#{self}#{NC}" end
   def blue;   "#{BLUE}#{self}#{NC}"   end
   def cyan;   "#{CYAN}#{self}#{NC}"   end
+
+  def sanitize_colored; gsub(/\e\[\d+;?\d*m/, "") end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ballantine
 version: !ruby/object:Gem::Version
-  version: 0.1.4.pre.beta2
+  version: 0.1.4
 platform: ruby
 authors:
 - oohyun15
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -55,6 +55,7 @@ files:
 - lib/ballantine/config.rb
 - lib/ballantine/repository.rb
 - lib/ballantine/version.rb
+- lib/printable.rb
 - lib/string.rb
 homepage: https://github.com/oohyun15/ballantine
 licenses:
@@ -71,9 +72,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.26
 signing_key: