git-story-workflow 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63e47013d8d5c62bf7f3b02c334ab8a6cfb6e200d54506042a8552005fabcd03
-  data.tar.gz: 23b3d417eb765ec8d842a06c927c14c3bc79c9e45a488bb1be395ed35ff856e3
+  metadata.gz: a3ca228230e6df3b78a7666b097cdfb126a3c304f58e437ea5f65cac3341eb1b
+  data.tar.gz: 24ec3369789ef343dfd3040ba834ca7726605eab327cb9a0f7d4bad7d772d5fe
 SHA512:
-  metadata.gz: fe79a45d3ba9663fa4b7240fc13e6379b4847282669333ee89c44012226fce6179064152b5c6b345ed57a89fc85e6d1c3fc55e6e561e5a81ef8543be1203bb47
-  data.tar.gz: f710599f822a1711c4fc5f7c7731db03b9fbed0e298e3f15fdf4304654c4f5ac20bbf955f51a5c2984eae49db6150f960a3fb43b479272253e5c36141b368ad3
+  metadata.gz: 5081071d98fd353fd9a9a6b6c14339b398d367eafb55509deaf9569871c58892c7d942ecef6eb7a8b989c58909e8dbf9c7c91c09a83bbe137845b52bfd135438
+  data.tar.gz: b3358fddfce2f7233972397e9bc72091f99d5adb08f6a07bd519cca613103995d06a0fe9099939b9a584c60063c6a9659d0eb94a09701e8d7e3714358983ce99

data/Rakefile

@@ -27,6 +27,7 @@ GemHadar do
   development_dependency 'rake'
   development_dependency 'simplecov'
   development_dependency 'rspec'
+  development_dependency 'byebug'
   licenses << 'Apache-2.0'
 end
 

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.5.0

data/config/story.yml

@@ -1,4 +1,8 @@
 ---
-pivotal_token: <%= ENV['PIVOTAL_TOKEN'] %>
+pivotal_token:   <%= ENV['PIVOTAL_TOKEN'] %>
 pivotal_project: 123456789
+pivotal_reference_prefix: pivotal
 deploy_tag_prefix: production_deploy_
+semaphore_auth_token: <%= ENV['SEMAPHORE_AUTH_TOKEN'] %>
+semaphore_project_url: https://betterplace.semaphoreci.com/projects/betterplace
+todo_nudging: <%= ENV['TODO_NUDGING'].to_i == 1 %>

data/git-story-workflow.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: git-story-workflow 1.3.0 ruby lib
+# stub: git-story-workflow 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "git-story-workflow".freeze
-  s.version = "1.3.0"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2021-05-21"
+  s.date = "2021-10-21"
   s.description = "Gem abstracting a git workflow\u2026".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["git-story".freeze]
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency(%q<rake>.freeze, [">= 0"])
     s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
     s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
     s.add_runtime_dependency(%q<infobar>.freeze, [">= 0"])
     s.add_runtime_dependency(%q<tins>.freeze, [">= 0"])
     s.add_runtime_dependency(%q<mize>.freeze, [">= 0"])
@@ -41,6 +42,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rake>.freeze, [">= 0"])
     s.add_dependency(%q<simplecov>.freeze, [">= 0"])
     s.add_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<byebug>.freeze, [">= 0"])
     s.add_dependency(%q<infobar>.freeze, [">= 0"])
     s.add_dependency(%q<tins>.freeze, [">= 0"])
     s.add_dependency(%q<mize>.freeze, [">= 0"])

data/lib/git/story/app.rb

@@ -39,7 +39,13 @@ class Git::Story::App
     @opts      = go 'n:', @argv
     @debug     = debug
     determine_command
-    Git::Story::Setup.perform
+    if !cc.story? && @command != :setup
+      warn "git story configuration file " +
+        "config/story.yml".bold + " is missing.\n\nCall " +
+        "git story setup".bold + " to create an initial one, inspect and " +
+        "edit it yourself, and also set the appropriate env vars.\n\n"
+      @command, @argv = :help, []
+    end
   end
 
   def run
@@ -72,6 +78,15 @@ class Git::Story::App
     )
   end
 
+  command doc: 'initialize git story config file if missing'
+  def setup
+    if cc.config?
+      red("config/story.yml configration already exists!")
+    else
+      Git::Story::Setup.perform
+    end
+  end
+
   command doc: 'output the current story branch if it is checked out'
   def current(check: true)
     if check
@@ -466,7 +481,12 @@ class Git::Story::App
   def pivotal_get(path)
     path = path.sub(/\A\/*/, '')
     url = "https://www.pivotaltracker.com/services/v5/#{path}"
-    @debug and STDERR.puts "Fetching #{url.inspect}"
+    if pivotal_token
+      @debug and STDERR.puts "Fetching #{url.inspect}"
+    else
+      STDERR.puts "Cannot fetch #{url.inspect} without PIVOTAL_TOKEN set as env var"
+      return
+    end
     URI.open(url,
          'X-TrackerToken' => pivotal_token,
          'Content-Type'   => 'application/xml',

data/lib/git/story/prepare-commit-msg

@@ -2,11 +2,14 @@
 # Installed by the git-story gem
 
 require 'tempfile'
+require 'complex_config/rude'
+include ComplexConfig::Provider::Shortcuts
 
 class CommitMesssageParser
   def initialize
     @line_index         = 0
     @story_number_found = false
+    @story_number_done  = false
     @message_data       = []
   end
 
@@ -16,10 +19,20 @@ class CommitMesssageParser
     @story_number_found
   end
 
+  def story_number_done?
+    @story_number_done
+  end
+
   def parse(template)
     @message_data = template.readlines
     @message_data.each do |line|
-      line =~ /\[.*#\d+.*\]/ and @story_number_found = true
+      if /^\s*\[.*(?:#\d+|TODO|(?<done>DONE)).*\]/i =~ line
+        @story_number_found = true
+        if @story_number_done  = !!done
+          @message_data.slice!(@line_index)
+          next
+        end
+      end
       if line =~ /^\s*#/
         break
       else
@@ -49,21 +62,31 @@ story_numbers =
     break $1.split(/_/)
   } || []
 story_numbers.map!(&:chomp)
-unless story_numbers.empty?
-  Tempfile.open('commit') do |output|
-    File.open(ARGV.first) do |template|
-      message_parsed = CommitMesssageParser.new.parse(template)
-      if message_parsed.story_number_found?
-        output.puts message_parsed.total
-      else
-        output.puts message_parsed.data, "",
-          "[#{story_numbers.map { |story_number| "##{story_number}" } * ' '}]",
-          "", message_parsed.footer
-      end
-      output.rewind
-      File.open(ARGV.first, 'w') do |message|
-        message.write output.read
+Tempfile.open('commit') do |output|
+  File.open(ARGV.first) do |template|
+    message_parsed = CommitMesssageParser.new.parse(template)
+    if message_parsed.story_number_found?
+      output.puts message_parsed.total
+    elsif complex_config.story.todo_nudging? && story_numbers.empty? && !message_parsed.story_number_done?
+      output.puts message_parsed.data, "", "[TODO]", "", message_parsed.footer
+    else
+      full_message = [  message_parsed.data, "", ]
+      if prefix = complex_config.story.pivotal_reference_prefix?
+        pivotal_reference = -> number { "%s-%u" % [ prefix, number ] }
+        full_message.concat(
+          story_numbers.each_with_index.map { |story_number, i| "#{i + 1}. " + pivotal_reference.(story_number) }
+        )
+        full_message << ""
       end
+      full_message <<
+        "[#{story_numbers.map { |story_number| "##{story_number}" } * ' '}]" <<
+        "" <<
+        message_parsed.footer
+      output.puts full_message
+    end
+    output.rewind
+    File.open(ARGV.first, 'w') do |message|
+      message.write output.read
     end
   end
 end

data/lib/git/story/setup.rb

@@ -8,15 +8,35 @@ module Git::Story::Setup
   PREPARE_COMMIT_MESSAGE_SRC = File.join(__dir__, 'prepare-commit-msg')
   PREPARE_COMMIT_MESSAGE_DST = File.join(HOOKS_DIR, 'prepare-commit-msg')
 
+  CONFIG_TEMPLATE = <<~end
+    ---
+    pivotal_token:   <%= ENV['PIVOTAL_TOKEN'] %>
+    pivotal_project: 123456789
+    pivotal_reference_prefix: pivotal
+    deploy_tag_prefix: production_deploy_
+    semaphore_auth_token: <%= ENV['SEMAPHORE_AUTH_TOKEN'] %>
+    semaphore_project_url: https://betterplace.semaphoreci.com/projects/betterplace
+    todo_nudging: <%= ENV['TODO_NUDGING'].to_i == 1 %>
+  end
+
+
   module_function
 
   def perform(force: false)
+    unless File.directory?('.git')
+      puts "No directory .git found, you need an initialized git repo for this to work"
+      return
+    end
+    install_config('config/story.yml', force: force)
+    install_hooks(force: force)
+    "Setup was performed."
+  end
+
+  def install_hooks(force: false)
     for filename in %w[ prepare-commit-msg pre-push ]
       if path = file_installed?(filename)
-        if force
+        if force || File.read(path).match?(MARKER)
           install_file filename
-        elsif File.read(path).match?(MARKER)
-          ;
         else
           ask(
             prompt: "File #{path.inspect} not created by git-story."\
@@ -43,6 +63,28 @@ module Git::Story::Setup
 
   def install_file(filename)
     File.exist?(HOOKS_DIR) or mkdir_p(HOOKS_DIR)
-    cp File.join(__dir__, filename), File.join(HOOKS_DIR, filename)
+    cp File.join(__dir__, filename), dest = File.join(HOOKS_DIR, filename)
+    puts "#{filename.to_s.inspect} was installed to #{dest.to_s.inspect}."
+  end
+
+  def install_config(filename, force: false)
+    filename = File.expand_path(filename)
+    if !force && File.exist?(filename)
+      ask(
+        prompt: "File #{filename.to_s.inspect} exists."\
+        " Overwrite? (y/n, default is %s) ",
+        default: ?n,
+      ) do |response|
+        if response != ?y
+          puts "Skipping creation of #{filename.to_s.inspect}."
+          return
+        end
+      end
+    end
+    mkdir_p File.dirname(filename)
+    File.secure_write(filename) do |io|
+      io.puts CONFIG_TEMPLATE
+    end
+    puts "#{filename.to_s.inspect} was created."
   end
 end

data/lib/git/story/version.rb

@@ -1,6 +1,6 @@
 module Git::Story
   # Git::Story version
-  VERSION         = '1.3.0'
+  VERSION         = '1.5.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-story-workflow
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: infobar
   requirement: !ruby/object:Gem::Requirement