ballantine 0.1.5.pre.rc2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c25803046495e2cb79cf8998bfaf50b45e1699c3d1abd751c4779e0dcd765bb
-  data.tar.gz: c0a89a4903d9083d52a91e0ac64e35017d128d0ff6edaa67c563d452c640931c
+  metadata.gz: 77449354cec29e4273ad0ca09e096d7803d116dbf902b05c48b6107654dcd981
+  data.tar.gz: aaa7fc4269cf1bb7221bab4a5c7f6247314e6ab8517c87a99561275706e9198a
 SHA512:
-  metadata.gz: 71b1f1a69c9085dea54e6494411d4101815986c153549cf0e7e2ce3d63f43f90475381a93ccfe5230e0b31beae44762e74f4c0fcaaed984cf3bb77dc95f28ccc
-  data.tar.gz: ba01668f022733b3e0f622a4ad917e9ce572a5f0070e1060d8781593071ce430c2751679877cbe49820545c2f1dacfc9aa05d1b5dc590b7dc7afcc64f70d6861
+  metadata.gz: 9a91ea909252259c4916478d945b7fe9249fe14c36514a1536e978cbae67f5c719e52ca02e1d16052dd60389c691946ca4adcd8eb9cdbb235b07788dfd209948
+  data.tar.gz: b00877f1c352da8814c7c6ba927c3c4da96c03220ffc93ca4e9fe4ff1ff5afe384f48a46366c0bac4c2c5d7edaed093edd161ff76ef650f3bf9ad8e2a4f7d35a

data/lib/ballantine/author.rb

@@ -36,8 +36,6 @@ 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)
@@ -54,8 +52,6 @@ module Ballantine
     # reference: https://api.slack.com/messaging/composing/layouts#building-attachments
     # @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" \
@@ -70,8 +66,6 @@ module Ballantine
 
     private
 
-    def conf = Config.instance
-
     # @param [Array<Commit>] commits
     # @param [Array(Integer, String)] count, word
     def retrieve_count_and_word(commits)

data/lib/ballantine/cli.rb

@@ -14,7 +14,7 @@ module Ballantine
     option "force", type: :boolean, aliases: "-f", default: false, desc: "Initialize forcely if already initialized."
     desc "init", "Initialize ballantine"
     def init
-      conf.init_file(force: options["force"])
+      Config.instance.init_file(force: options["force"])
 
       puts "🥃 Initialized ballantine."
 
@@ -25,8 +25,8 @@ module Ballantine
     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
+      Config.instance.verbose = options["verbose"]
+      puts "$ ballantine config #{key} #{value}" if Config.instance.verbose
 
       # check environment value
       if Config::AVAILABLE_ENVIRONMENTS.map { |key| !options[key] }.reduce(:&)
@@ -38,28 +38,35 @@ module Ballantine
       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)
+      Config.instance.env = env
+      value ? Config.instance.set_data(key, value) : Config.instance.print_data(key)
+
+      true
     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"
     def diff(target, source = %x(git rev-parse --abbrev-ref HEAD).chomp)
-      conf.verbose = options["verbose"]
-      puts "$ ballantine diff #{target} #{source}" if conf.verbose
+      Config.instance.verbose = options["verbose"]
+      puts "$ ballantine diff #{target} #{source}" if Config.instance.verbose
+
+      # retrieve uncommitted files
+      uncommitted = retrieve_uncommitted
 
       # validate arguments
-      validate(target, source, **options)
+      validate(target, source, uncommitted, **options)
 
-      # init instance variables
-      init_variables(target, source, **options)
+      with_stash(uncommitted) do
+        # init instance variables
+        init_variables(target, source, **options)
 
-      # check commits
-      check_commits(**options)
+        # check commits
+        check_commits
 
-      # print commits
-      print_commits(target, source, **options)
+        # print commits
+        print_commits(target, source)
+      end
     end
 
     desc "version", "Display version information about ballntine"
@@ -71,28 +78,25 @@ module Ballantine
 
     private
 
-    def conf = Config.instance
-
     # @param [String] target
     # @param [String] source
+    # @param [Array<String>] uncommitted
     # @param [Hash] options
     # @return [NilClass] nil
-    def validate(target, source, **options)
-      conf.print_log(binding) if conf.verbose
-
+    def validate(target, source, uncommitted, **options)
       if Dir[".git"].empty?
         raise NotAllowed, "ERROR: There is no \".git\" in #{Dir.pwd}."
       end
 
-      if (uncommitted = %x(git diff HEAD --name-only).split("\n")).any?
-        raise NotAllowed, "ERROR: Uncommitted file exists. stash or commit uncommitted files.\n#{uncommitted.join("\n")}"
+      if uncommitted.any? && Config.instance.raise_uncommitted?
+        raise NotAllowed, "ERROR: Uncommitted file exists. stash or commit uncommitted files.\n\t#{uncommitted.join("\n\t")}"
       end
 
       if target == source
         raise NotAllowed, "ERROR: target(#{target}) and source(#{source}) can't be equal."
       end
 
-      if options[Config::TYPE_SLACK] && !conf.get_data(Config::KEY_SLACK_WEBHOOK)
+      if options[Config::TYPE_SLACK] && !Config.instance.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
 
@@ -104,12 +108,10 @@ module Ballantine
     # @param [Hash] options
     # @return [Boolean]
     def init_variables(target, source, **options)
-      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
+      Config.instance.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,
@@ -120,23 +122,16 @@ module Ballantine
       true
     end
 
-    # @param [Hash] options
     # @return [Boolean]
-    def check_commits(**options)
-      conf.print_log(binding) if conf.verbose
-
+    def check_commits
       repo.check_commits
-
       true
     end
 
     # @param [String] target
     # @param [String] source
-    # @param [Hash] options
     # @return [Boolean]
-    def print_commits(target, source, **options)
-      conf.print_log(binding) if conf.verbose
-
+    def print_commits(target, source)
       authors = Author.all
       if authors.empty?
         raise ArgumentError, "ERROR: There is no commits between \"#{target}\" and \"#{source}\""
@@ -144,7 +139,7 @@ module Ballantine
 
       number = authors.size
 
-      case conf.print_type
+      case Config.instance.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}"
@@ -158,7 +153,7 @@ module Ballantine
         # send message to slack
         require "net/http"
         require "uri"
-        uri = URI.parse(conf.get_data(Config::KEY_SLACK_WEBHOOK))
+        uri = URI.parse(Config.instance.get_data(Config::KEY_SLACK_WEBHOOK))
         request = Net::HTTP::Post.new(uri)
         request.content_type = "application/json"
         request.body = JSON.dump({
@@ -171,9 +166,39 @@ module Ballantine
         response = Net::HTTP.start(uri.hostname, uri.port, req_options) { |http| http.request(request) }
         puts response.message
       else
-        raise AssertionFailed, "Unknown print type: #{conf.print_type}"
+        raise AssertionFailed, "Unknown print type: #{Config.instance.print_type}"
+      end
+
+      true
+    end
+
+    # @param [Array<String>] uncommitted
+    # @return [Boolean]
+    def with_stash(uncommitted)
+      if uncommitted.any? && !Config.instance.raise_uncommitted?
+        save_stash
+        yield
+        restore_stash
+      else
+        yield
       end
+      true
+    end
 
+    # @return [Array<String>]
+    def retrieve_uncommitted
+      %x(git diff HEAD --name-only).split("\n")
+    end
+
+    # @return [Boolean]
+    def save_stash
+      %x(git stash save &> /dev/null)
+      true
+    end
+
+    # @return [Boolean]
+    def restore_stash
+      %x(git stash apply &> /dev/null)
       true
     end
   end

data/lib/ballantine/config.rb

@@ -12,10 +12,11 @@ module Ballantine
       ENV_GLOBAL,
     ].freeze
     KEY_SLACK_WEBHOOK = "slack_webhook"
+    KEY_RAISE_UNCOMMITTED = "raise_uncommitted"
     AVAILABLE_KEYS = [
       KEY_SLACK_WEBHOOK,
+      KEY_RAISE_UNCOMMITTED,
     ].freeze
-    AVAILABLE_PRINT_INSTANCE_VARIABLES = [:@name, :@from, :@to].freeze
 
     attr_reader :data, :loaded
     attr_accessor :env, :print_type, :verbose
@@ -38,34 +39,31 @@ module Ballantine
       @verbose = false
     end
 
-    # @param [Hash] options
+    # @param [Boolean] force
     # @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, {})
+    def init_file(force: false)
+      raise NotAllowed, "#{FILE_BALLANTINE_CONFIG} already exists." if Dir[file_path].any? && !force
+      File.write(file_path, JSON.pretty_generate(empty_data))
       @loaded = false
     end
 
-    # @param [Hash] options
     # @return [Boolean] result
-    def load_file(**options)
+    def load_file
       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
+        @data[key] = sanitize_value(key, value)
       end
 
       @loaded = true
     end
 
     # @param [String] key
-    # @param [Hash] options
     # @return [Boolean] result
-    def print_data(key, **options)
+    def print_data(key)
       load_file unless @loaded
 
       if key
@@ -83,38 +81,42 @@ module Ballantine
 
     # @param [String] key
     # @param [String] value
-    # @param [Hash] options
     # @return [Stirng] value
-    def set_data(key, value, **options)
+    def set_data(key, value)
       load_file unless @loaded
-
-      @data[key] = value
-      File.write(file_path, JSON.dump(@data))
+      raise InvalidParameter, "Key must be within #{AVAILABLE_KEYS}" unless AVAILABLE_KEYS.include?(key)
+      @data[key] = sanitize_value(key, value)
+      File.write(file_path, JSON.pretty_generate(@data))
       value
     end
 
     # @param [String] key
-    # @param [Hash] options
     # @return [Stirng] value
-    def get_data(key, **options)
+    def get_data(key)
       load_file unless @loaded
       @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
+    # @return [Boolean]
+    def raise_uncommitted? = get_data(KEY_RAISE_UNCOMMITTED)
 
     private
 
+    # @return [Hash{String => Object}]
+    def empty_data = AVAILABLE_KEYS.map { |key| [key, nil] }.to_h
+
+    # @param [String] key
+    # @param [Object] value
+    # @return [Object]
+    def sanitize_value(key, value)
+      case key
+      when KEY_RAISE_UNCOMMITTED then value == true || value == "true"
+      else value
+      end
+    end
+
+    # @param [String] env
+    # @return [String]
     def file_path(env = @env)
       case env
       when ENV_LOCAL then "./#{FILE_BALLANTINE_CONFIG}"

data/lib/ballantine/repository.rb

@@ -59,8 +59,6 @@ module Ballantine
     # @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|
@@ -100,8 +98,6 @@ 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)
@@ -126,8 +122,6 @@ module Ballantine
 
     private
 
-    def conf = Config.instance
-
     # @param [String] name
     # @return [String] hash
     def check_tag(name)
@@ -140,13 +134,13 @@ module Ballantine
 
     # @return [String]
     def check_format
-      case conf.print_type
+      case Config.instance.print_type
       when Config::TYPE_TERMINAL
         " - " + "%h".yellow + " %<(#{ljust})%s " + "#{url}/commit/%H".gray
       when Config::TYPE_SLACK
         "\\\`<#{url}/commit/%H|%h>\\\` %s - %an"
       else
-        raise AssertionFailed, "Unknown print type: #{conf.print_type}"
+        raise AssertionFailed, "Unknown print type: #{Config.instance.print_type}"
       end
     end
 

data/lib/ballantine/version.rb

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

data/lib/ballantine.rb

@@ -12,7 +12,11 @@ require_relative "ballantine/commit"
 require_relative "ballantine/cli"
 
 module Ballantine
-  class Error < StandardError; end
+  class Error < StandardError
+    # @return [Array<String>, NilClass]
+    def backtrace = Config.instance.verbose ? super : nil
+  end
+
   class NotAllowed < Error; end
   class InvalidParameter < Error; end
   class AssertionFailed < Error; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ballantine
 version: !ruby/object:Gem::Version
-  version: 0.1.5.pre.rc2
+  version: 0.1.5
 platform: ruby
 authors:
 - oohyun15