ballantine 0.1.4.pre.beta1 → 0.1.4.pre.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0bf16550e63e8b7c9436b7ac9abe5fdc0f8d10251e36494ad2586c958eab572
-  data.tar.gz: 72b9ff136bbe2478c58d237d862e3fa26196daf382391ee554e9f5e19de1f698
+  metadata.gz: 205e73804edf1a3ea9c16ddabb4dc3f5d1cc916300ff6f59576112153d8fadaa
+  data.tar.gz: 3a742736e8db01a38761b0a395a94e7e16083edd35ff8cf460c77e4db0f797d5
 SHA512:
-  metadata.gz: 8f22b05c86c438d910a251bb758ab5a4708b5e79db483c66a4eadd2f4603c899ac68d234e4dbae75ef314c66289caea55485e4a91a2bb480d4af1ac0ecd09948
-  data.tar.gz: f0605cfe1fb7d8c713e0c92d969504545bdb8cb73f725961d0d69c11c7bed36aea45d24b0e5d865df6a339f5b3d15657bc6bf497dce4145f16c98881aa0aad26
+  metadata.gz: 41654e7d79f79ca6a0c5a556e567ec40f64f343797b92c748c6930d012c6cf49c9674878aa81ad9e7d50f42f8740208a0003f7bf9cde5e11bc674f0f8e8d0b5a
+  data.tar.gz: 214c98d8b880faf7b68aeefa65a5670c688186d2b3e2f3098e2c3ed42cd80f221282ce441de10b6ea12e2569ec977f4062954100206fedcf0f5eae509ca70a26

data/lib/ballantine/author.rb

@@ -2,16 +2,16 @@
 
 module Ballantine
   class Author
-    attr_accessor :name, :commits
+    attr_reader :name, :commits_hash
 
     class << self
       # @param [String] name
       # @return [Author] author
-      def find_or_create_by(name)
+      def find_or_create_by(name:)
         @_collections = {} unless defined?(@_collections)
         return @_collections[name] unless @_collections[name].nil?
 
-        @_collections[name] = new(name)
+        @_collections[name] = new(name:)
       end
 
       # @return [Array<Author>] authors
@@ -23,29 +23,30 @@ module Ballantine
     end
 
     # @param [String] name
-    def initialize(name)
+    def initialize(name:)
       @name = name
-      @commits = {}
+      @commits_hash = {}
     end
 
-    # @return [NilClass] nil
+    # @return [Boolean]
     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
+      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)
       end
-      nil
+
+      true
     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")}"
+      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")}"
       end.join("\n")
 
       {
@@ -56,10 +57,10 @@ module Ballantine
 
     private
 
-    # @param [Array<String>] lists
+    # @param [Array<Commit>] commits
     # @param [Array(Integer, String)] count, word
-    def retrieve_count_and_word(lists)
-      count = lists.size
+    def retrieve_count_and_word(commits)
+      count = commits.size
       word = count == 1 ? "commit" : "commits"
       [count, word]
     end

data/lib/ballantine/cli.rb

@@ -2,25 +2,10 @@
 
 module Ballantine
   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"
-
     TYPE_TERMINAL = "terminal"
     TYPE_SLACK = "slack"
 
-    DEFAULT_LJUST = 80
-
-    attr_reader :app_name, :main_path, :sub_path, :send_type
+    attr_reader :send_type, :repo
 
     class << self
       def exit_on_failure?; exit(1) end
@@ -63,30 +48,13 @@ module Ballantine
       system("git pull -f &> /dev/null")
 
       # init instance variables
-      init_variables(**options)
-
-      # find github url, branch
-      url = github_url(%x(git config --get remote.origin.url).chomp)
-      current_revision = %x(git rev-parse --abbrev-ref HEAD).chomp
-
-      # get commit hash
-      from, sub_from = commit_hash(target)
-      to, sub_to = commit_hash(source)
-      system("git checkout #{current_revision} -f &> /dev/null")
+      init_variables(target, source, **options)
 
       # check commits
-      check_commits(from, to, url)
-      sub_path.each_with_index do |path, idx|
-        next if sub_from[idx] == sub_to[idx]
-
-        Dir.chdir(path)
-        sub_url = github_url(%x(git config --get remote.origin.url).chomp)
-        check_commits(sub_from[idx], sub_to[idx], sub_url)
-        Dir.chdir(main_path)
-      end
+      check_commits(**options)
 
       # send commits
-      send_commits(target, source, from, to, url)
+      send_commits(target, source, **options)
 
       exit(0)
     end
@@ -126,117 +94,47 @@ module Ballantine
       nil
     end
 
+    # @param [String] target
+    # @param [String] source
     # @param [Hash] options
     # @return [Boolean]
-    def init_variables(**options)
+    def init_variables(target, source, **options)
       @send_type = options[TYPE_SLACK] ? TYPE_SLACK : TYPE_TERMINAL
-      @app_name = File.basename(%x(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
+      Repository.send_type = @send_type
+      @repo = Repository.find_or_create_by(
+        path: Dir.pwd,
+        remote_url: %x(git config --get remote.origin.url).chomp,
+      )
+
+      # init repo
+      repo.init_variables(target, source)
       true
     end
 
-    # @param [String] name
-    # @return [String] hash
-    def check_tag(name)
-      list = %x(git tag -l).split("\n")
-      return name unless list.grep(name).any?
-
-      system("git fetch origin tag #{name} -f &> /dev/null")
-      %x(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(%x(git config --get remote.origin.url).chomp, ".git")
-      names = %x(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 =
-          %x(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
-    # @return [Array(String, Array<String>)] main, sub's hash
-    def commit_hash(hash)
-      # check argument is tag
-      hash = check_tag(hash)
-
-      system("git checkout #{hash} -f &> /dev/null")
-      system("git pull &> /dev/null")
-      main_hash = %x(git --no-pager log -1 --format='%h').chomp
-      sub_hash =
-        if sub_path.any?
-          %x(git ls-tree HEAD #{@sub_path.join(" ")}).split("\n").map { |line| line.split(" ")[2] }
-        else
-          []
-        end
-
-      [main_hash, sub_hash]
-    end
+    # @param [Hash] options
+    # @return [Boolean]
+    def check_commits(**options)
+      repo.check_commits
 
-    # @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"
-      else raise AssertionFailed, "Unknown send type: #{send_type}"
-      end
+      true
     end
 
     # @param [String] target
     # @param [String] source
-    # @param [String] from
-    # @param [String] to
-    # @param [String] url
-    # @return [NilClass] nil
-    def send_commits(target, source, from, to, url)
+    # @param [Hash] options
+    # @return [Boolean]
+    def send_commits(target, source, **options)
       authors = Author.all
       if authors.empty?
         raise ArgumentError, "ERROR: There is no commits between \"#{target}\" and \"#{source}\""
       end
 
       number = authors.size
-      last_commit = %x(git --no-pager log --reverse --format="#{commit_format(url, ljust: DEFAULT_LJUST - 22)}" --abbrev=7 #{from}..#{to} -1).strip
+      last_commit = repo.print_last_commit
 
       case send_type
       when TYPE_TERMINAL
-        puts "Check commits before #{app_name.red} deployment. (#{target.cyan} <- #{source.cyan})".ljust(DEFAULT_LJUST + 34) + " #{url}/compare/#{from}...#{to}".gray
+        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
         puts "Author".yellow + ": #{number}"
         puts "Last commit".blue + ": #{last_commit}"
         authors.map(&:print_commits)
@@ -252,17 +150,19 @@ module Ballantine
         request = Net::HTTP::Post.new(uri)
         request.content_type = "application/json"
         request.body = JSON.dump({
-          "text" => ":white_check_mark: *#{app_name}* deployment request by <@#{actor}> (\`<#{url}/tree/#{from}|#{target}>\` <- \`<#{url}/tree/#{to}|#{source}>\` <#{url}/compare/#{from}...#{to}|compare>)\n:technologist: Author: #{number}\nLast commit: #{last_commit}",
+          "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}",
           "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
+        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}"
       end
+
+      true
     end
   end
 end

data/lib/ballantine/commit.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Ballantine
+  class Commit
+    attr_reader :hash, :message # 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)
+        @_collections = {} unless defined?(@_collections)
+        index = "#{hash}-#{repo.name}"
+        return @_collections[index] unless @_collections[index].nil?
+
+        @_collections[index] = new(hash:, repo:, message:, author:)
+      end
+    end
+
+    # @param [String] hash
+    # @param [Repository] repo
+    # @param [String] message
+    # @param [Author] author
+    def initialize(hash:, repo:, message:, author:)
+      @hash = hash
+      @repo = repo
+      @message = message
+      @author = author
+    end
+  end
+end

data/lib/ballantine/repository.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Ballantine
+  class Repository
+    # 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"
+    DEFAULT_LJUST = 70
+    PARSER_TOKEN = "!#!#"
+
+    attr_reader :name, :path, :owner, :url, :from, :to, :format # attributes
+    attr_reader :main_repo, :sub_repos, :commits # associations
+
+    class << self
+      # @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:)
+      end
+
+      # @return [Array<Repository>]
+      def all
+        return [] unless defined?(@_collections)
+
+        @_collections.values
+      end
+
+      def send_type; @_send_type end
+      def send_type=(value); @_send_type = value end
+    end
+
+    # @param [String] path
+    # @param [String] remote_url
+    def initialize(path:, remote_url:)
+      @path = path
+      @commits = []
+      @sub_repos = retrieve_sub_repos
+      @owner, @name = GITHUB_REGEXES.each do |regex|
+        str = remote_url.match(regex)
+        break [str[2], str[3]] if str
+      end
+      @url = "https://github.com/#{owner}/#{name}"
+      @format = check_format
+    end
+
+    # @param [String] target
+    # @param [String] source
+    # @return [Boolean]
+    def init_variables(target, source)
+      current_revision = %x(git rev-parse --abbrev-ref HEAD).chomp
+
+      foo = lambda do |hash, context|
+        hash = check_tag(hash)
+        system("git checkout #{hash} -f &> /dev/null")
+        system("git pull &> /dev/null")
+
+        hash = %x(git --no-pager log -1 --format='%h').chomp
+        commit = Commit.find_or_create_by(
+          hash: hash,
+          repo: self,
+        )
+        instance_variable_set("@#{context}", commit)
+
+        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(
+              path: path + "/" + sub_path,
+            )
+            sub_commit = Commit.find_or_create_by(
+              hash: sub_hash,
+              repo: sub_repo,
+            )
+            sub_repo.instance_variable_set("@#{context}", sub_commit)
+          end
+        end
+      end
+
+      foo.call(target, "from")
+      foo.call(source, "to")
+
+      system("git checkout #{current_revision} -f &> /dev/null")
+
+      true
+    end
+
+    # @return [Boolean]
+    def check_commits
+      authors = retrieve_authors
+      authors.each do |author|
+        commits = retrieve_commits(author)
+        next if commits.empty?
+
+        author.commits_hash[name] = commits
+        # TODO: append `commits` to `repo.commits`
+      end
+
+      if sub_repos.any?
+        sub_repos.each do |sub_repo|
+          next if sub_repo.from.hash == sub_repo.to.hash
+
+          Dir.chdir(sub_repo.path)
+          sub_repo.check_commits
+        end
+        Dir.chdir(path)
+      end
+
+      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
+
+    # @param [String] name
+    # @return [String] hash
+    def check_tag(name)
+      list = %x(git tag -l).split("\n")
+      return name unless list.grep(name).any?
+
+      system("git fetch origin tag #{name} -f &> /dev/null")
+      %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
+        " - " + "%h".yellow + " %<(#{ljust})%s " + "#{url}/commit/%H".gray
+      when CLI::TYPE_SLACK
+        "\\\`<#{url}/commit/%H|%h>\\\` %s - %an"
+      else
+        raise AssertionFailed, "Unknown send type: #{send_type}"
+      end
+    end
+
+    # @return [Array<Repository>]
+    def retrieve_sub_repos
+      gitmodule = path + "/" + FILE_GITMODULES
+      return [] unless Dir[gitmodule].any?
+
+      file = File.open(gitmodule)
+      resp = file.read
+      file.close
+
+      resp.split(/\[submodule.*\]/)
+        .select { |line| line.match?(/path = /) }
+        .sort
+        .map do |line|
+          line = line.strip
+          repo = Repository.find_or_create_by(
+            path: path + "/" + line.match(/path = (.*)/)[1],
+            remote_url: line.match(/url = (.*)/)[1],
+          )
+          repo.instance_variable_set("@main_repo", self)
+          repo
+        end
+    end
+
+    # @return [Array<Author>]
+    def retrieve_authors
+      %x(git --no-pager log --pretty=format:"%an" #{from.hash}..#{to.hash})
+        .split("\n").uniq.sort
+        .map { |name| Author.find_or_create_by(name:) }
+    end
+
+    # @param [Author] author
+    # @return [Array<Commit>]
+    def retrieve_commits(author)
+      results =
+        %x(git --no-pager log --reverse --no-merges --author="#{author.name}" --format="%h#{PARSER_TOKEN}#{format}" --abbrev=7 #{from.hash}..#{to.hash})
+          .gsub('"', '\"')
+          .gsub(/[\u0080-\u00ff]/, "")
+          .split("\n")
+
+      results.map do |result|
+        hash, message = result.split(PARSER_TOKEN)
+        Commit.find_or_create_by(
+          hash: hash,
+          repo: self,
+          message: message,
+          author: author,
+        )
+      end
+    end
+  end
+end

data/lib/ballantine/version.rb

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

data/lib/ballantine.rb

@@ -6,6 +6,8 @@ require_relative "string"
 require_relative "ballantine/version"
 require_relative "ballantine/config"
 require_relative "ballantine/author"
+require_relative "ballantine/repository"
+require_relative "ballantine/commit"
 require_relative "ballantine/cli"
 
 module Ballantine

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ballantine
 version: !ruby/object:Gem::Version
-  version: 0.1.4.pre.beta1
+  version: 0.1.4.pre.beta2
 platform: ruby
 authors:
 - oohyun15
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -51,7 +51,9 @@ files:
 - lib/ballantine.rb
 - lib/ballantine/author.rb
 - lib/ballantine/cli.rb
+- lib/ballantine/commit.rb
 - lib/ballantine/config.rb
+- lib/ballantine/repository.rb
 - lib/ballantine/version.rb
 - lib/string.rb
 homepage: https://github.com/oohyun15/ballantine