verto 0.6.1 → 0.10.1

data/lib/verto/dsl/interpreter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Verto
   module DSL
     class Interpreter
@@ -6,15 +8,14 @@ module Verto
       # TODO: Wrap stacktrace
       Error = Class.new(Verto::ExitError)
 
-      def evaluate(vertofile_content=nil, attributes: {}, &block)
+      def evaluate(vertofile_content = nil, attributes: {}, &block)
         with_attributes(attributes) do
-          vertofile_content ? instance_eval(vertofile_content)  : instance_eval(&block)
+          vertofile_content ? instance_eval(vertofile_content) : instance_eval(&block)
         end
+      rescue StandardError => e
+        raise e if e.is_a?(Verto::ExitError)
 
-      rescue StandardError => error
-        raise error if error.is_a?(Verto::ExitError)
-
-        raise Error, error.message
+        raise Error, e.message
       end
 
       private
@@ -27,7 +28,7 @@ module Verto
 
         block.call
 
-        attributes.each do |key, value|
+        attributes.each do |key, _value|
           instance_variable_set("@#{key}", nil)
           singleton_class.remove_method(key)
         end

data/lib/verto/dsl/syntax.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Verto
   module DSL
     module Syntax
@@ -55,17 +57,13 @@ module Verto
       end
 
       def sh!(command, output: :from_config)
-        raise Verto::ExitError unless sh(command, output: output).success?
+        raise Verto::ExitError, command unless sh(command, output: output).success?
       end
 
       def command_options
         Verto.config.command_options
       end
 
-      def on(moment, &block)
-        Verto.config.hooks << Hook.new(moment: moment, &block)
-      end
-
       def before(&block)
         Verto.config.hooks << Hook.new(moment: :before, &block)
       end
@@ -74,14 +72,48 @@ module Verto
         Verto.config.hooks << Hook.new(moment: :after, &block)
       end
 
+      def on(moment, &block)
+        deprecate('on', use: 'before_tag_creation')
+
+        Verto.config.hooks << Hook.new(moment: moment, &block)
+      end
+
       def before_command(command_name, &block)
+        deprecate('before_command', use: 'before_command_tag_up')
+
         Verto.config.hooks << Hook.new(moment: "before_#{command_name}", &block)
       end
 
       def after_command(command_name, &block)
+        deprecate('after_command', use: 'after_command_tag_up')
+
         Verto.config.hooks << Hook.new(moment: "after_#{command_name}", &block)
       end
 
+      def before_command_tag_up(&block)
+        Verto.config.hooks << Hook.new(moment: 'before_tag_up', &block)
+      end
+
+      def after_command_tag_up(&block)
+        Verto.config.hooks << Hook.new(moment: 'after_tag_up', &block)
+      end
+
+      def before_tag_creation(&block)
+        Verto.config.hooks << Hook.new(moment: 'before_tag_creation', &block)
+      end
+
+      def update_changelog(with: :merged_pull_requests_with_bracketed_labels, confirmation: true, filename: 'CHANGELOG.md')
+        permitted_moments = %w[before_tag_creation after_tag_up]
+        unless permitted_moments.include? Verto.current_moment.to_s
+          raise ExitError, 'update_changelog is only supported in before_tag_creation or after_command_tag_up'
+        end
+
+        UpdateChangelog.new.call(with: with,
+                                 new_version: new_version,
+                                 confirmation: confirmation,
+                                 filename: filename)
+      end
+
       def file(filepath)
         DSL::File.new(filepath)
       end
@@ -90,8 +122,9 @@ module Verto
         ENV[environment_name]
       end
 
+      # TODO: Use delegator
       def confirm(text)
-        shell_basic.yes?("#{text} (y/n)")
+        CliHelpers.confirm(text)
       end
 
       def error(text)
@@ -110,16 +143,12 @@ module Verto
         @executors ||= {
           from_config: Verto::SystemCommandExecutor.new,
           true => Verto::SystemCommandExecutor.new(stdout: $stdout, stderr: $stderr),
-          false => Verto::SystemCommandExecutor.new(stdout: nil, stderr: nil),
+          false => Verto::SystemCommandExecutor.new(stdout: nil, stderr: nil)
         }
 
         @executors[output]
       end
 
-      def shell_basic
-        @shell_basic ||= Thor::Shell::Basic.new
-      end
-
       def stderr
         Verto.stderr
       end
@@ -135,6 +164,10 @@ module Verto
 
         SemanticVersion.new(tag_version)
       end
+
+      def deprecate(current, use:)
+        warn "[DEPRECATED] `#{current}` is deprecated and will be removed in a future release, use `#{use}` instead"
+      end
     end
   end
 end

data/lib/verto/dsl/update_changelog.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Verto
+  module DSL
+    class UpdateChangelog
+      include Verto.import[:cli_helpers, :stdout,
+                           executor: 'system_command_executor_without_output', changelog_format: 'changelog.format']
+
+      InvalidChangelogSource = Class.new(Verto::ExitError)
+
+      SOURCES = StrictHash.new(
+        {
+          merged_pull_requests_with_bracketed_labels: lambda do |executor|
+            executor.run(
+              %q(git log --oneline --decorate  | grep -B 100 -m 1 "tag:" | grep "pull request" | awk '{print $1}' | xargs git show --format='%b' | grep -v Approved | grep -v "^$" | grep -E "^[[:space:]]*\[.*\]")
+            ).output.split("\n").map(&:strip)
+          end
+        },
+        default_proc: ->(hash, _) { raise InvalidChangelogSource, "Invalid CHANGELOG Source, avaliable options: '#{hash.keys.join(',')}'" }
+      )
+
+      def call(new_version:, confirmation: true, filename: 'CHANGELOG.md', with: :merged_pull_requests_with_bracketed_labels)
+        verify_file_presence!(filename)
+
+        stdout.puts separator
+        changelog_changes = format_changes(new_version, version_changes(with))
+
+        exit if confirmation && !cli_helpers.confirm("Create new Realease?\n" \
+                                                     "#{separator}\n" \
+                                                     "#{changelog_changes}" \
+                                                     "#{separator}\n")
+        update_file(filename, changelog_changes)
+      end
+
+      private
+
+      def verify_file_presence!(filename)
+        return if Verto.project_path.join(filename).exist?
+
+        raise Verto::ExitError, "changelog file '#{filename}' doesnt exist"
+      end
+
+      def version_changes(with)
+        SOURCES[with].call(executor)
+      end
+
+      def update_file(filename, changelog_changes)
+        DSL::File.new(filename).prepend(changelog_changes)
+      end
+
+      def format_changes(new_version, version_changes)
+        Mustache.render(changelog_format, { new_version: new_version, version_changes: version_changes }) + "\n"
+      end
+
+      def separator
+        '---------------------------'
+      end
+    end
+  end
+end

data/lib/verto/repositories/tag_repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Verto
   class TagRepository
     include Verto.import[executor: 'system_command_executor_without_output']

data/lib/verto/utils/cli_helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CliHelpers
+  class << self
+    def confirm(text)
+      shell_basic.yes?("#{text} (y/n)")
+    end
+
+    private
+
+    def shell_basic
+      @shell_basic ||= Thor::Shell::Basic.new
+    end
+  end
+end

data/lib/verto/utils/command_options.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Verto
   class CommandOptions < Thor::CoreExt::HashWithIndifferentAccess
-    alias_method :add, :merge!
+    alias add merge!
 
     def except(*keys)
-      self.reject { |key, v| keys.include?(key) }
+      reject { |key, _v| keys.include?(key) }
     end
   end
 end

data/lib/verto/utils/semantic_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Verto
   class SemanticVersion < Vseries::SemanticVersion
     DEFAULT_PRE_RELEASE_INITIAL_NUMBER = Verto.config.pre_release.initial_number

data/lib/verto/utils/strict_hash.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class StrictHash < Hash
+  def initialize(hash, default_proc: nil)
+    super()
+    self.default_proc = default_proc if default_proc
+    merge!(hash)
+  end
+end

data/lib/verto/utils/system_command_executor.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'open3'
 
 module Verto
   class SystemCommandExecutor
     include Verto.import['project.path', 'stdout', 'stderr']
 
-    class Result < Struct.new(:output, :error, :result)
+    Result = Struct.new(:output, :error, :result) do
       def success?
         result.success?
       end
@@ -16,7 +18,7 @@ module Verto
     Error = Class.new(StandardError)
 
     def run(command)
-      stderr.puts running_log(command, path) if stderr
+      stderr&.puts running_log(command, path)
 
       Open3.popen3(command, chdir: path.to_s) do |_, stdout, stderr, wait_thread|
         @output = stdout.read

data/lib/verto/utils/tag_filter.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module TagFilter
-  REALEASE_ONLY = /\d+\.\d+\.\d+$/
-  PRE_REALEASE_ONLY = /\d+\.\d+\.\d+-.*\d+/
+  REALEASE_ONLY = /\d+\.\d+\.\d+$/.freeze
+  PRE_REALEASE_ONLY = /\d+\.\d+\.\d+-.*\d+/.freeze
 
   FILTERS = {
     release_only: REALEASE_ONLY,
     pre_release_only: PRE_REALEASE_ONLY,
     all: nil
-  }
+  }.freeze
 
   def self.for(tag_key)
     FILTERS[tag_key.to_sym] if tag_key

data/lib/verto/utils/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Verto
   class Template
     def self.render(template_name, to:)

data/lib/verto/utils/templates/Vertofile

@@ -1,36 +1,40 @@
-verto_version '0.6.1'
+verto_version '0.10.1'
 
 config {
  # version.prefix = 'v' # Adds a version_prefix
  # pre_release.initial_number = 0 # Configures pre_release initial number, defaults to 1
  # project.path = "#{project_path}" # Configures a custom project path
+ # git.pull_before_tag_creation = true # Pull Changes before tag creation
+ # git.push_after_tag_creation = true # Push changes after tag creation
+
+ ## CHANGELOG FORMAT
+ ## Verto uses Mustache template rendering to render changelog updates, the default value is:
+ ##
+ ##   ## {{new_version}} - #{Time.now.strftime('%d/%m/%Y')}
+ ##       {{#version_changes}}
+ ##       * {{.}}
+ ##       {{/version_changes}}
+ ##
+ ## A custom format can be specified, eg:
+ # changelog.format =  <<~CHANGELOG
+ #                       ## {{new_version}}
+ #                        {{#version_changes}}
+ #                        * {{.}}
+ #                        {{/version_changes}}
+ #                      CHANGELOG
 }
 
 context(branch('master')) {
-  before_command('tag_up') {
-    git!('pull origin master')
+  before_command_tag_up {
     command_options.add(filter: 'release_only')
   }
 
-  on('before_tag_creation') {
-
-    version_changes = ""
-    # Uncomment to get Merged PRs Titles as changes to add in CHANGELOG.
-    # version_changes = sh(
-    #  %q#git log --oneline --decorate  | grep -B 100 -m 1 "tag:" | grep "pull request" | awk '{print $1}' | xargs git show --format='%b' | grep -v Approved | grep -v "^$" | grep -E "^[[:space:]]*\[.*\]" | sed 's/^[[:space:]]*\(.*\)/ * \1/'#, output: false
-    # ).output
-
-    puts "---------------------------"
-    version_changes = "## #{new_version} - #{Time.now.strftime('%d/%m/%Y')}\n#{version_changes}\n"
-    exit unless confirm("Create new Realease?\n" \
-      "---------------------------\n" \
-      "#{version_changes}" \
-      "---------------------------\n"
-    )
-
-    # CHANGELOG
-    file('CHANGELOG.md').prepend(version_changes)
-    git('add CHANGELOG.md')
+  before_tag_creation {
+    # Uncomment to update CHANGELOG file
+    # update_changelog(with: :merged_pull_requests_with_bracketed_labels,
+    #                  confirmation: true,
+    #                  filename: 'CHANGELOG.md')
+    # git('add CHANGELOG.md')
 
     # Uncomment to update the version in other files, like package.json
     # file('package.json').replace(/"(\d+)\.(\d+)\.(\d+)(-?.*)"/, %Q{"#{new_version}"})
@@ -38,34 +42,28 @@ context(branch('master')) {
 
     git('commit -m "Updates CHANGELOG"')
   }
-
-  after_command('tag_up') {
-    git('push --tags')
-    git('push origin master')
-  }
 }
 
 # Uncomment to get a specific pre_release proccess, like a staging or qa branch
 # context(branch('staging')) {
-#  before_command('tag_up') {
+#  before_command_tag_up {
 #    git!('pull origin staging')
 #    command_options.add(pre_release: 'rc')
 #  }
 #
-#  on('before_tag_creation') {
+#  before_tag_creation {
 #    file('package.json').replace(/"(\d+)\.(\d+)\.(\d+)(-?.*)"/, %Q{"#{new_version}"}) # Atualiza versão do package.json
 #    git('add package.json')
 #    git('commit --allow-empty -m "Staging Release"')
 #  }
 
-#  after_command('tag_up') {
-#    git('push --tags')
-#    git('push origin staging')
+#  after_command_tag_up {
+#    sh('some command')
 #  }
 #}
 
 # Uncomment to block tag creation in other branchs
 #context(!branch('master', 'staging')) {
-#  error "Tags only can be created in master or staging branch"
+#  error 'Tags only can be created in master or staging branch'
 #  exit
 #}

data/lib/verto/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Verto
-  VERSION = "0.6.1"
+  VERSION = '0.10.1'
 end

data/verto.gemspec

@@ -1,40 +1,44 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "verto/version"
+require 'verto/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "verto"
+  spec.name          = 'verto'
   spec.version       = Verto::VERSION
-  spec.authors       = ["Carlos Atkinson"]
-  spec.email         = ["carlos.atks@gmail.com"]
-
-  spec.summary       = %q{Verto helps you to versionate your project}
-  spec.homepage      = "https://github.com/catks/verto"
-  spec.license       = "MIT"
+  spec.authors       = ['Carlos Atkinson']
+  spec.email         = ['carlos.atks@gmail.com']
 
+  spec.summary       = 'Verto helps you to versionate your project'
+  spec.homepage      = 'https://github.com/catks/verto'
+  spec.license       = 'MIT'
 
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/catks/verto'
+  spec.metadata['changelog_uri'] = 'https://github.com/catks/verto/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.5'
 
-  spec.add_dependency             "thor", "~> 1.0.1"
-  spec.add_dependency             "dry-configurable", "~> 0.8"
-  spec.add_dependency             "dry-container", "~> 0.7"
-  spec.add_dependency             "dry-auto_inject", "~> 0.7"
-  spec.add_dependency             "vseries", "~> 0.2"
+  spec.add_dependency             'dry-auto_inject', '~> 0.7'
+  spec.add_dependency             'dry-configurable', '~> 0.8'
+  spec.add_dependency             'dry-container', '~> 0.7'
+  spec.add_dependency             'mustache', '~> 1.1.1'
+  spec.add_dependency             'thor', '~> 1.0.1'
+  spec.add_dependency             'vseries', '~> 0.2'
 
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov", "~> 0.18.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov', '~> 0.17.0'
 end