git-story-workflow 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04601b201fea90d5e5054d3e61881533d1d5c87b8fb9f4d0c23ab71b74fbda4d
-  data.tar.gz: 3991c64783f6d63815273b6475597a87731a7737cbfc41e2050919c18ec5c1af
+  metadata.gz: 71a678629ab94d345b9362db3a9632978eecccf4a0b42074b8926a8caa8e7793
+  data.tar.gz: c709d15f03f8a751ec2c61626210ec240fbd5ab1e89b4cd314d9548499ab3284
 SHA512:
-  metadata.gz: 34536de7b1148214bd5fa6a09dfee1ac876ff16a0d4a9543eb34b08ae92aac111d264bc8b0aefb4bdde112b76c9867ebd7622e58f771ffce411e2a9aee3e2a9e
-  data.tar.gz: 9ecadc6812f41148ad7e79b0184b694a19ec593a041b93626972f9ad2100f6b6b7a6c51962a1e16ceb86222a0800794f2538086b8ad5d7666d406a1fb4e45cd6
+  metadata.gz: c1b06bbac8125456cb8095081affae06ee3105f3d157ae2b5f24f970d92072cac0b5aa129d6abde397fdf8d91e7040232673dbb43c55e46aebf30b8cddf66fc4
+  data.tar.gz: 03b2db927c695b5c16b1c0503ff26dbd570e4fe1e12317cf4dd69e3332c2329b2c8fe6c75709b8c4738bd6a4eec68b8dc71bf60c15728e9a163837f09457c734

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.4.0
+1.6.0

data/config/story.yml

@@ -1,4 +1,8 @@
 ---
-pivotal_token: <%= ENV['PIVOTAL_TOKEN'] %>
-pivotal_project: 123456789
+pivotal_token:   <%= ENV['PIVOTAL_TOKEN'] %>
+pivotal_project: 1254912
+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.4.0 ruby lib
+# stub: git-story-workflow 1.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "git-story-workflow".freeze
-  s.version = "1.4.0"
+  s.version = "1.6.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-08-17"
+  s.date = "2021-11-15"
   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
@@ -85,31 +100,9 @@ class Git::Story::App
     end
   end
 
-  def provide_name(story_id = nil)
-    until story_id.present?
-      story_id = ask(prompt: 'Story id? ').strip
-    end
-    story_id = story_id.gsub(/[^0-9]+/, '')
-    @story_id = Integer(story_id)
-    if stories.any? { |s| s.story_id == @story_id }
-      @reason = "story for ##@story_id already created"
-      return
-    end
-    if name = fetch_story_name(@story_id)
-      name = normalize_name(
-        name,
-        max_size: 128 - 'story'.size - @story_id.to_s.size - 2 * ?_.size
-      ).full? || name
-      [ 'story', name, @story_id ] * ?_
-    else
-      @reason = "name for ##@story_id could not be fetched from tracker"
-      return
-    end
-  end
-
   command doc: '[STORY_ID] fetch status of current story, -n SECONDS refreshes'
   def status(story_id = current(check: true)&.[](/_(\d+)\z/, 1)&.to_i)
-    if story = fetch_story(story_id)
+    if story = fetch_story(story_id, with_owner: true)
       color_state =
         case cs = story.current_state
         when 'unscheduled', 'planned', 'unstarted'
@@ -132,20 +125,21 @@ class Git::Story::App
         else
           t
         end
-      owners = Array(fetch_story_owners(story_id)).map { |o| "#{o.name} <#{o.email}>" }
       result = <<~end
         Id: #{(?# + story.id.to_s).green}
         Name: #{story.name.inspect.bold}
         Type: #{color_type}
         Estimate: #{story.estimate.to_s.full? { |e| e.yellow.bold } || 'n/a'}
         State: #{color_state}
-        Branch: #{current_branch_checked?&.color('#ff5f00')}
         Labels: #{story.labels.map { |l| l.name.on_color(91) }.join(' ')}
-        Owners: #{owners.join(', ').yellow}
+        Owners: #{story.owners.map { |o| "%s <%s>" % [ o.name, o.email ] }.join(', ').yellow}
         Pivotal: #{story.url.color(33)}
       end
-      if url = github_url(current_branch_checked?)
-        result << "Github: #{url.color(33)}\n"
+      if branch = current_branch_checked? and url = github_url(current_branch_checked?)
+        result << <<~end
+          Github: #{url.color(33)}
+          Branch: #{branch.color('#ff5f00')}
+        end
       end
       result
     end
@@ -219,18 +213,44 @@ class Git::Story::App
     fetch_statuses(pivotal_ids) * (?┄ * Tins::Terminal.cols << ?\n)
   end
 
-  def fetch_statuses(pivotal_ids)
-    tg = ThreadGroup.new
-    pivotal_ids.each do |pid|
-      tg.add Thread.new { Thread.current[:status] = status(pid) }
+  command doc: '[REF] Create some parts of deploy document'
+  def deploy_document(ref = default_ref, rest: [])
+    ref = build_ref_range(ref)
+    fetch_commits
+    fetch_tags
+    opts = ([
+      '--color=never',
+      '--pretty=%B'
+    ] | rest) * ' '
+    output = capture("git log #{opts} #{ref}")
+    pivotal_ids = SortedSet[]
+    output.scan(/\[\s*#\s*(\d+)\s*\]/) { pivotal_ids << $1.to_i }
+    stories   = ''
+    attendees = Set[]
+    fetch_stories(pivotal_ids) do |pid|
+      story = fetch_story(pid, with_owner: true)
+      attendees.merge story.owners
+      stories << <<~end
+      • [##{story.id}] #{story.name}
+        ○ Pivotal: https://www.pivotaltracker.com/story/show/#{pid}
+        ○ Type: #{story.story_type}
+        ○ Status: #{story.current_state}
+        ○ Owners: #{story.owners.map { |o| "%s <%s>" % [ o.name, o.email ] }.join(', ')}
+        ○ Tasks to be done before deployment:
+          ☐ …
+        ○ Tasks to be done after deployment:
+         ☐ …
+      end
     end
-    tg.list.with_infobar(label: 'Story').map do |t|
-      +infobar
-      t.join
-      t[:status]
+    attendees.map! { |a| "• @#{a.email}" }
+    <<~end
+      #{attendees.join(?\n)}
+
+      #{stories}
     end
   end
 
+
   command doc: '[REF] output diff since last production deploy tag'
   def deploy_diff(ref = default_ref, rest: [])
     ref = build_ref_range(ref)
@@ -261,8 +281,8 @@ class Git::Story::App
     "Story #{name} created.".green
   end
 
-  command doc: '[PATTERN] switch to story matching PATTERN'
-  def switch(pattern = nil)
+  command doc: 'switch to selected story branch'
+  def switch
     fetch_commits
     if branch = pick_branch(prompt: 'Switch to story? %s')
       sh "git checkout #{branch}"
@@ -270,7 +290,7 @@ class Git::Story::App
     end
   end
 
-  command doc: '[PATTERN] delete story branch matching PATTERN'
+  command doc: 'delete selected story branch'
   def delete(pattern = nil)
     fetch_commits
     if branch = pick_branch(prompt: 'Delete story branch? %s', symbol: ?⌦)
@@ -322,6 +342,28 @@ class Git::Story::App
 
   private
 
+  def provide_name(story_id = nil)
+    until story_id.present?
+      story_id = ask(prompt: 'Story id? ').strip
+    end
+    story_id = story_id.gsub(/[^0-9]+/, '')
+    @story_id = Integer(story_id)
+    if stories.any? { |s| s.story_id == @story_id }
+      @reason = "story for ##@story_id already created"
+      return
+    end
+    if name = fetch_story_name(@story_id)
+      name = normalize_name(
+        name,
+        max_size: 128 - 'story'.size - @story_id.to_s.size - 2 * ?_.size
+      ).full? || name
+      [ 'story', name, @story_id ] * ?_
+    else
+      @reason = "name for ##@story_id could not be fetched from tracker"
+      return
+    end
+  end
+
   def determine_command
     c, command = [], nil
     possible_commands = []
@@ -433,11 +475,6 @@ class Git::Story::App
     name
   end
 
-  def apply_pattern(pattern, stories)
-    pattern = pattern.gsub(?#, '')
-    stories.grep(/#{Regexp.quote(pattern)}/)
-  end
-
   def error(msg)
     puts msg.red
     exit 1
@@ -455,8 +492,10 @@ class Git::Story::App
     fetch_story(story_id)&.name
   end
 
-  def fetch_story(story_id)
-    pivotal_get("projects/#{pivotal_project}/stories/#{story_id}").full?
+  def fetch_story(story_id, with_owner: false)
+    story = pivotal_get("projects/#{pivotal_project}/stories/#{story_id}").full?
+    story.owners = Array((fetch_story_owners(story_id) if with_owner))
+    story
   end
 
   def fetch_story_owners(story_id)
@@ -466,7 +505,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',
@@ -566,4 +610,23 @@ class Git::Story::App
     url = url.sub('git@github.com:', 'https://github.com/')
     url = url.sub(/(\.git)\z/, "/tree/#{branch}")
   end
+
+  def fetch_stories(pivotal_ids, &block)
+    block or raise ArgumentError, '&block parameter is required'
+    tg = ThreadGroup.new
+    pivotal_ids.each do |pid|
+      tg.add Thread.new { Thread.current[:result] = block.(pid) }
+    end
+    tg.list.with_infobar(label: 'Story').map do |t|
+      t.join
+      +infobar
+      t[:result]
+    end
+  end
+
+  def fetch_statuses(pivotal_ids)
+    fetch_stories(pivotal_ids) do |pid|
+      status(pid)
+    end
+  end
 end

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

@@ -67,7 +67,7 @@ Tempfile.open('commit') do |output|
     message_parsed = CommitMesssageParser.new.parse(template)
     if message_parsed.story_number_found?
       output.puts message_parsed.total
-    elsif complex_config.todo_nudging? && story_numbers.empty? && !message_parsed.story_number_done?
+    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, "", ]

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.4.0'
+  VERSION         = '1.6.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.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-17 00:00:00.000000000 Z
+date: 2021-11-15 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