verto 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfde45c8eb00cd3302f89417e1302b90e2fd41a2fd49a5c402c6e29ec2e46fdf
-  data.tar.gz: d6822ed93c979646fc7c0064b39310a1a180ae632a92ea53b2a7b7841503c138
+  metadata.gz: ec5d303284b7d17001dacb3f3daa72ba1d47601dffb325790e61ec941f2f2b84
+  data.tar.gz: f078471b8bb4cb5243cfdb5748332a7582a8d26f3da17a19d6b3777757b8a2d0
 SHA512:
-  metadata.gz: f93afd8ec28cfcf7a6183d82570da5e5636f23ffd1387c111de3bbbbddae2db114b7022207a953f47e45020f6069024a1cdeffca419aec6fe0ca0d923583fc78
-  data.tar.gz: c07c60169151793d64806ae93851aabd649233f2d8364fe1aba2e896a57c89054dfd634d37b69554f934219420964f76ae3b932504b7964a2f3c14b9aeb8fe57
+  metadata.gz: 21e6d0f0e89edcb6f0ec6b2892ad0a8c71d81623f602daacc9103b2d51508c570273e05151e0143f2e7915678faa4e598eab10efd369058041bf892112fdc38b
+  data.tar.gz: 534cc6aecfd85f5e027d0fd6e31dcfe4b41e88c33aedff39b5f66919826005a8bab6ced748fc70471086a9b4eabadf6ebde208b591b2d08b633a482e548730b2

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.10.0 - 14/10/2020
+ * [FEATURE] Adds update_changelog in DSL
+
 ## 0.9.0 - 08/08/2020
  * [FEATURE] Custom Default Pre-Release Identifier
 

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    verto (0.9.0)
+    verto (0.10.0)
       dry-auto_inject (~> 0.7)
       dry-configurable (~> 0.8)
       dry-container (~> 0.7)
+      mustache (~> 1.1.1)
       thor (~> 1.0.1)
       vseries (~> 0.2)
 
@@ -12,7 +13,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.1)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.3)
     docile (1.3.2)
     dry-auto_inject (0.7.0)
@@ -27,6 +28,7 @@ GEM
     dry-core (0.4.9)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
+    mustache (1.1.1)
     rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)

data/README.md

@@ -32,20 +32,20 @@ You don't need to install verto in your machine, you can run verto via the docke
 To use verto in the same way that you use any other cli, you can set an alias in your `.bashrc`, `.zshrc`, etc:
 
 ```shell
-alias verto='docker run -v $(pwd):/usr/src/project -it catks/verto:0.9.0'
+alias verto='docker run -v $(pwd):/usr/src/project -it catks/verto:0.10.0'
 ```
 
 If you want you can share your git configuration and known_hosts with:
 
 ```shell
-alias verto='docker run -v ~/.gitconfig:/etc/gitconfig -v $(pwd):/usr/src/project -v $HOME/.ssh/known_hosts:/root/.ssh/known_hosts -it catks/verto:0.9.0'
+alias verto='docker run -v ~/.gitconfig:/etc/gitconfig -v $(pwd):/usr/src/project -v $HOME/.ssh/known_hosts:/root/.ssh/known_hosts -it catks/verto:0.10.0'
 
 ```
 
 You can also use your ssh keys, know_hosts and git config with verto container (for git push):
 
 ```shell
-alias verto='docker run -v ~/.gitconfig:/etc/gitconfig -v $(pwd):/usr/src/project -v $HOME/.ssh/known_hosts:/root/.ssh/known_hosts -v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa -e SSH_PRIVATE_KEY=/root/.ssh/id_rsa -it catks/verto:0.9.0'
+alias verto='docker run -v ~/.gitconfig:/etc/gitconfig -v $(pwd):/usr/src/project -v $HOME/.ssh/known_hosts:/root/.ssh/known_hosts -v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa -e SSH_PRIVATE_KEY=/root/.ssh/id_rsa -it catks/verto:0.10.0'
 
 ```
 
@@ -85,13 +85,29 @@ You can create a new Vertofile with `verto init` or following the next example:
 ```ruby
 # Vertofile
 
-verto_version '0.9.0'
+verto_version '0.10.0'
 
 config {
  # version.prefix = 'v' # Adds a version_prefix
  # pre_release.default_identifier = 'alpha' } # Defaults to 'rc'
  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')) {
@@ -100,20 +116,11 @@ context(branch('master')) {
   }
 
   before_tag_creation {
-    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"
+    update_changelog(
+      with: :merged_pull_requests_with_bracketed_labels, # Optional, defines the strategy to retrive the changes, default: :merged_pull_requests_with_bracketed_labels
+      confirmation: true, # Optional, asks for confirmation before updating the changelog, default: true
+      filename: 'CHANGELOG.md' # Optional, defines the filename of the CHANGELOG file, default: 'CHANGELOG.md'
     )
-
-    # CHANGELOG
-    file('CHANGELOG.md').prepend(version_changes)
     git('add CHANGELOG.md')
 
     # Uncomment to update the version in other files, like package.json

data/Vertofile

@@ -1,4 +1,4 @@
-verto_version '0.7.0'
+verto_version '0.10.0'
 
 config {
   version.prefix = 'v' # Adds a version_prefix
@@ -12,22 +12,7 @@ context(branch('master')) {
   }
 
   before_tag_creation {
-    version_changes = ""
-     bitbucket_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
-     version_changes = bitbucket_changes
-
-    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)
+    update_changelog
     git!('add CHANGELOG.md')
 
     file('lib/verto/version.rb').replace(latest_version.to_s, new_version.to_s)
@@ -37,7 +22,9 @@ context(branch('master')) {
     git!('add README.md')
 
     file('lib/verto/utils/templates/Vertofile').replace(latest_version.to_s, new_version.to_s)
-    git!('add lib/verto/utils/templates/Vertofile')
+    file('Vertofile').replace(latest_version.to_s, new_version.to_s)
+
+    git!('add Vertofile lib/verto/utils/templates/Vertofile')
 
     sh!('bundle install')
     sh!('rake install')
@@ -46,4 +33,3 @@ context(branch('master')) {
     git!('commit -m "Bumps Version"')
   }
 }
-

data/djin.yml

@@ -0,0 +1,8 @@
+djin_version: '0.6.0'
+
+tasks:
+  release:
+    local:
+      run:
+        - verto tag up {{args}}
+        - bundle exec rake release

data/lib/verto.rb

@@ -3,6 +3,7 @@ require "dry-container"
 require "dry-configurable"
 require "dry-auto_inject"
 require "vseries"
+require "mustache"
 require "pathname"
 
 require "verto/version"
@@ -37,6 +38,16 @@ module Verto
     setting :push_after_tag_creation, false
   end
 
+  setting :changelog do
+    setting :format,
+            <<~CHANGELOG
+              ## {{new_version}} - #{Time.now.strftime('%d/%m/%Y')}
+               {{#version_changes}}
+               * {{.}}
+               {{/version_changes}}
+            CHANGELOG
+  end
+
   setting :hooks, []
   setting :command_options, CommandOptions.new
 
@@ -55,6 +66,7 @@ module Verto
     @container ||= Dry::Container.new.tap do |container|
       container.register('system_command_executor') { SystemCommandExecutor.new }
       container.register('system_command_executor_without_output') { SystemCommandExecutor.new(stdout: nil, stderr: nil) }
+      container.register('cli_helpers') { CliHelpers }
 
       container.register('tag_repository') { TagRepository.new }
 
@@ -72,6 +84,10 @@ module Verto
       container.namespace('project') do
         register('path') { Verto.config.project.path }
       end
+
+      container.namespace('changelog') do
+        register('format') { Verto.config.changelog.format }
+      end
     end
   end
 
@@ -86,17 +102,28 @@ module Verto
   def self.stderr
     Verto.container.resolve('stderr')
   end
+
+  def self.current_moment
+    @current_moment
+  end
+
+  def self.current_moment=(moment)
+    @current_moment = moment
+  end
 end
 
 require "verto/utils/semantic_version.rb"
 require "verto/utils/system_command_executor"
 require "verto/utils/tag_filter"
 require "verto/utils/template"
+require "verto/utils/cli_helpers"
+require "verto/utils/strict_hash"
 require "verto/dsl"
 require "verto/dsl/syntax"
 require "verto/dsl/interpreter"
 require "verto/dsl/hook"
 require "verto/dsl/file"
+require "verto/dsl/update_changelog"
 require "verto/dsl/built_in_hooks"
 require "verto/commands/base_command"
 require "verto/commands/tag_command"

data/lib/verto/commands/base_command.rb

@@ -24,7 +24,10 @@ module Verto
       moments_to_call.each do |moment|
         Verto.config.hooks
           .select { |hook| hook.moment == moment.to_sym }
-          .each { |hook| hook.call(with_attributes: with_attributes) }
+          .each do |hook|
+            Verto.current_moment = hook.moment
+            hook.call(with_attributes: with_attributes)
+          end
       end
     end
   end

data/lib/verto/dsl/syntax.rb

@@ -100,6 +100,18 @@ module Verto
         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
@@ -108,8 +120,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)
@@ -128,16 +141,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

data/lib/verto/dsl/update_changelog.rb

@@ -0,0 +1,56 @@
+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)
+        raise Verto::ExitError, "changelog file '#{filename}' doesnt exist" unless Verto.project_path.join(filename).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/utils/cli_helpers.rb

@@ -0,0 +1,13 @@
+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/strict_hash.rb

@@ -0,0 +1,7 @@
+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/templates/Vertofile

@@ -1,4 +1,4 @@
-verto_version '0.9.0'
+verto_version '0.10.0'
 
 config {
  # version.prefix = 'v' # Adds a version_prefix
@@ -6,32 +6,35 @@ config {
  # 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')
     command_options.add(filter: 'release_only')
   }
 
   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')
+    # 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}"})
@@ -39,11 +42,6 @@ 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
@@ -60,8 +58,7 @@ context(branch('master')) {
 #  }
 
 #  after_command_tag_up {
-#    git('push --tags')
-#    git('push origin staging')
+#    sh('some command')
 #  }
 #}
 

data/lib/verto/version.rb

@@ -1,3 +1,3 @@
 module Verto
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/verto.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency             "dry-container", "~> 0.7"
   spec.add_dependency             "dry-auto_inject", "~> 0.7"
   spec.add_dependency             "vseries", "~> 0.2"
+  spec.add_dependency             "mustache", "~> 1.1.1"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "bundler", "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verto
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Carlos Atkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-08 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +186,7 @@ files:
 - Vertofile
 - bin/console
 - bin/setup
+- djin.yml
 - docker-entrypoint.sh
 - exe/verto
 - lib/verto.rb
@@ -184,9 +199,12 @@ files:
 - lib/verto/dsl/hook.rb
 - lib/verto/dsl/interpreter.rb
 - lib/verto/dsl/syntax.rb
+- lib/verto/dsl/update_changelog.rb
 - lib/verto/repositories/tag_repository.rb
+- lib/verto/utils/cli_helpers.rb
 - lib/verto/utils/command_options.rb
 - lib/verto/utils/semantic_version.rb
+- lib/verto/utils/strict_hash.rb
 - lib/verto/utils/system_command_executor.rb
 - lib/verto/utils/tag_filter.rb
 - lib/verto/utils/template.rb