ballantine 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2188ad3272546c25226bdbb1209075baadee05fb7f011cafe13874b1af45777
-  data.tar.gz: 0fe5889c616c93c7f62ce8353671543750604fc4c6def9958abdfe3a0f6e5c42
+  metadata.gz: 32d67897fd3d252df4a89c17484075ac5bc442c794de2fa098740f03038e6ab9
+  data.tar.gz: b084bff0c1b433b92de7362a17d3129016de599ac468a9d464227b6ae77d94ba
 SHA512:
-  metadata.gz: ab52789a4ae2fb510d48f34cd7cf8c2920610e5f341fdbbd94f687fee7ace7ff1f1ff7cbce32fe2e4ce78a783762aa29cf1c9053be5f042ef5b12f84f9101b28
-  data.tar.gz: bda07819f4146ac05b3ab1c39f4debe647f9c72a3a1dc50cfac433bf3381ecc6b96e96c92559775c08ecbf4f4e14b39a235a5a23d8636d2e956b6eddee33ad60
+  metadata.gz: 5589a6f22b237a78177ec09b55a3efc2a3965583ef7d79daba8aa441f3888f5fc07dfe236b90651712d7209dfda44d8f7d0b2dfd7c3e250ce29efa1c72596d49
+  data.tar.gz: b1c84acf31a520d3bc8d11b384bf38da80d71303bb1886f2d550c5f45eaae9857c2823c0829474a0322bf99a7ad8e5dc91ab651200bbcb689fdcde2f8fe2b6ba

data/lib/ballantine/author.rb

@@ -1,63 +1,65 @@
 #!/usr/bin/env ruby
 
-class Author
-  attr_accessor :name, :commits
+module Ballantine
+  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
 
-  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)
+    def initialize(name)
+      @name = name
+      @commits = {}
     end
 
-    # @return [Array<Author>] authors
-    def all
-      return [] unless defined?(@@_collections)
-      @@_collections.sort.map(&:last) # sort and take values
+    # @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
-  end
 
-  # @param [String] name
-  def initialize(name)
-    @name = name
-    @commits = {}
-  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")
 
-  # @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
+      results = {
+        'text' => "- <@#{name}>\n#{message}",
+        'color' => '#00B86A', # green
+      }
     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
+    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]
+    # @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
 end

data/lib/ballantine/cli.rb

@@ -1,11 +1,6 @@
 #!/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 = [
@@ -19,42 +14,42 @@ module Ballantine
     ].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
+    attr_reader :app_name, :main_path, :sub_path, :send_type
 
     package_name 'Ballantine'
 
-    desc 'init', 'Initialize ballantine configuration'
+    option 'force', type: :boolean, aliases: '-f', default: false, desc: "Initialize forcely if already initialized."
+    desc 'init', 'Initialize ballantine'
     def init
-      puts "🥃 Init ballantine configuration"
-      slack_webhook = ask("Q. Set slack webhook\n> ")
+      conf.init_file(force: options['force'])
 
-      config = {
-        slack_webhook: slack_webhook
-      }
-      File.write('./' + FILE_BALLANTINE_CONFIG, JSON.dump(config))
+      puts "🥃 Initialized ballantine."
     end
 
-    desc 'config', 'Describe ballantine configuration'
-    def config
-      load_config
-      AVAILABLE_CONFIG.each do |key|
-        puts "#{key}: #{instance_variable_get('@' + key)}"
+    Config::AVAILABLE_ENVIRONMENTS.each{ |env| option env, type: :boolean, default: false, desc: "Set envirment to `#{env}'." }
+    desc 'config [--env] [KEY] [VALUE]', "Set ballantine's configuration"
+    def config(key = nil, value = nil)
+      # check environment value
+      if Config::AVAILABLE_ENVIRONMENTS.map{ |key| !options[key] }.reduce(:&)
+        raise NotAllowed, "Set environment value (#{Config::AVAILABLE_ENVIRONMENTS.map{ |key| "`--#{key}'" }.join(", ")})"
+      elsif Config::AVAILABLE_ENVIRONMENTS.map{ |key| !!options[key] }.reduce(:&)
+        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?
+
+      value ? conf.set_data(key, value) : conf.print_data(key)
     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.'
+    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
@@ -108,18 +103,9 @@ module Ballantine
 
     private
 
-    def self.exit_on_failure?
-      exit 1
-    end
-
-    def load_config
-      return if Dir[FILE_BALLANTINE_CONFIG].empty?
+    def self.exit_on_failure?; exit 1 end
 
-      JSON.parse(File.read('./' + FILE_BALLANTINE_CONFIG)).each do |key, value|
-        next unless AVAILABLE_CONFIG.include?(key)
-        instance_variable_set('@' + key, value)
-      end
-    end
+    def conf; @conf ||= Config.new(@env) end
 
     # @param [String] from
     # @param [String] to
@@ -127,19 +113,19 @@ module Ballantine
     # @return [NilClass] nil
     def preprocess(from, to, **options)
       if Dir['.git'].empty?
-        raise SystemCallError, "ERROR: There is no \".git\" in #{Dir.pwd}."
+        raise NotAllowed, "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")}"
+        raise NotAllowed, "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."
+        raise NotAllowed, "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`."
+      if options[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
 
       nil
@@ -209,6 +195,7 @@ module Ballantine
         " - "+ "%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
     end
 
@@ -233,16 +220,16 @@ module Ballantine
       when TYPE_SLACK
         # set message for each author
         messages = authors.map(&:serialize_commits)
-        actor = `git config user.name`
+        actor = `git config user.name`.chomp
 
         # send message to slack
         require 'net/http'
         require 'uri'
-        uri = URI.parse(@slack_webhook)
+        uri = URI.parse(conf.get_data(Config::KEY_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}",
+          'text' => ":white_check_mark: *#{@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' }
@@ -250,6 +237,8 @@ module Ballantine
           http.request(request)
         end
         puts response.message
+      else
+        raise AssertionFailed, "Unknown send type: #{@send_type}"
       end
     end
   end

data/lib/ballantine/config.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+
+module Ballantine
+  class Config
+    ENV_LOCAL = 'local'
+    ENV_GLOBAL = 'global'
+    AVAILABLE_ENVIRONMENTS = [
+      ENV_LOCAL,
+      ENV_GLOBAL
+    ].freeze
+
+    KEY_SLACK_WEBHOOK = 'slack_webhook'
+    AVAILABLE_KEYS = [
+      KEY_SLACK_WEBHOOK
+    ].freeze
+
+    FILE_BALLANTINE_CONFIG = '.ballantine.json'
+
+    attr_reader :env, :data, :loaded
+
+    def initialize(env)
+      @env = env || ENV_LOCAL
+      @data = {}
+      @loaded = false
+    end
+
+    # @param [Hash] options
+    # @return [Boolean] result
+    def init_file(**options)
+      raise NotAllowed, "#{FILE_BALLANTINE_CONFIG} already exists." if Dir[file_path].any? && !options[:force]
+
+      File.write(file_path, {})
+      @loaded = false
+    end
+
+    # @param [Hash] options
+    # @return [Boolean] result
+    def load_file(**options)
+      return false if @loaded
+      raise NotAllowed, "Can't find #{FILE_BALLANTINE_CONFIG}" if Dir[file_path].empty?
+
+      JSON.parse(File.read(file_path)).each do |key, value|
+        next unless AVAILABLE_KEYS.include?(key)
+        @data[key] = value
+      end
+
+      @loaded = true
+    end
+
+    # @param [String] key
+    # @param [Hash] options
+    # @return [Boolean] result
+    def print_data(key, **options)
+      load_file unless @loaded
+
+      if key
+        raise InvalidParameter, "Key must be within #{AVAILABLE_KEYS}" unless AVAILABLE_KEYS.include?(key)
+        puts @data[key]
+      else
+        @data.each do |key, value|
+          puts "#{key}: #{value}"
+        end
+      end
+
+      true
+    end
+
+    # @param [String] key
+    # @param [String] value
+    # @param [Hash] options
+    # @return [Stirng] value
+    def set_data(key, value, **options)
+      load_file unless @loaded
+
+      @data[key] = value
+      File.write(file_path, JSON.dump(@data))
+      value
+    end
+
+    # @param [String] key
+    # @param [Hash] options
+    # @return [Stirng] value
+    def get_data(key, **options)
+      load_file unless @loaded
+      @data[key]
+    end
+
+    private
+
+    def file_path(env = @env)
+      case env
+      when ENV_LOCAL then "./#{FILE_BALLANTINE_CONFIG}"
+      when ENV_GLOBAL then "#{Dir.home}/#{FILE_BALLANTINE_CONFIG}"
+      else raise AssertionFailed, "Unknown environment: #{env}"
+      end
+    end
+  end
+end

data/lib/ballantine/version.rb

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

data/lib/ballantine.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
-require_relative "ballantine/cli"
+require 'thor'
+require 'json'
+require_relative 'string'
 require_relative "ballantine/version"
+require_relative 'ballantine/config'
+require_relative 'ballantine/author'
+require_relative "ballantine/cli"
 
 module Ballantine
   class Error < StandardError; end
+  class NotAllowed < Error; end
+  class InvalidParameter < Error; end
+  class AssertionFailed < Error; end
+  class NotImplemented < Error; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ballantine
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - oohyun15
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -51,8 +51,9 @@ files:
 - lib/ballantine.rb
 - lib/ballantine/author.rb
 - lib/ballantine/cli.rb
-- lib/ballantine/string.rb
+- lib/ballantine/config.rb
 - lib/ballantine/version.rb
+- lib/string.rb
 homepage: https://github.com/oohyun15/ballantine
 licenses:
 - MIT