firespring_dev_commands 2.1.6.pre.alpha.2 → 2.1.7.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17a02c0b5521ca1da3efb1b8374529732d7dde86060a9864f1d75be1ba070f6f
-  data.tar.gz: 9264d32211c1d1da7726215e8bf2c4f5df187f915ed9c38c29cdf336675b7e8b
+  metadata.gz: b5efd3f846669710ea2f7f839df890d6489555a18bfe62ef77d644bf884c121e
+  data.tar.gz: 490a60e2c04726bbbb7d0950160395c3c3fb8c70313be14794fc6181296e7e0b
 SHA512:
-  metadata.gz: 436338662d1889eec74a3c5fac8ca50427fa0f58ec2a6a256f7689015217bc8738618e26b14260d3648e650d93bfa4ce64d9fc49ec974204815fb49d2ec09a6b
-  data.tar.gz: 30158eb11227b227d711011bd77db61b1dc8bac6a8fda0760a89e21b8d60434a3f443162499313312d285ccf8c3cac751a5ad106f80c1bfa0e9139d973662028
+  metadata.gz: 11e1f6e01faea39bc49278011efcce6c4f9b30a6dd283efea6e96f13938596e21ed840f961646e3b4d487db50eb4e3a0604a00e14e304eb351f09e2165e7b5b1
+  data.tar.gz: 48d04949c727bade11d7f405701d705fd25eb9a67cd25516a83c799159f32738bd4133028f3271fcf2cddb17a728c422bbed8781bc21f58bfc7d5689543ba555

data/lib/firespring_dev_commands/common.rb

@@ -41,7 +41,7 @@ module Dev
     # If the user answers 'y' then the block is executed.
     # If the user answers 'n' then the block is skipped.
     def with_confirmation(message, default = 'y', color_message: true)
-      message = "\n  #{message}" << '? '.light_green
+      message = "\n  #{message}? "
       message = message.light_green if color_message
       print message
       print '('.light_green << 'y'.light_yellow << '/'.light_green << 'n'.light_yellow << ') '.light_green

data/lib/firespring_dev_commands/git.rb

@@ -203,7 +203,7 @@ module Dev
 
     # Checks out the given branch in the given repo
     # Defaults to the current directory
-    def checkout(branch, dir: default_project_dir, raise_errors: false)
+    def checkout(branch, dir: default_project_dir)
       raise 'branch is required' if branch.to_s.strip.empty?
       return unless File.exist?(dir)
 
@@ -224,14 +224,12 @@ module Dev
       indent g.pull('origin', actual_branch)
       true
     rescue ::Git::GitExecuteError => e
-      raise e if raise_errors
-
       print_errors(e.message)
       false
     end
 
     # Create the given branch in the given repo
-    def create_branch(branch, dir: default_project_dir, raise_errors: false)
+    def create_branch(branch, dir: default_project_dir)
       raise 'branch is required' if branch.to_s.strip.empty?
       raise "refusing to create protected branch '#{branch}'" if %w(master develop).any?(branch.to_s.strip)
       return unless File.exist?(dir)
@@ -242,7 +240,7 @@ module Dev
       g = ::Git.open(dir)
       g.fetch('origin', prune: true)
 
-      puts "Fetching the latest changes for base branch \"#{staging_branch}\""
+      puts "Fetching the latest changes for base branch #{staging_branch}"
       g.checkout(staging_branch)
       g.pull('origin', staging_branch)
 
@@ -253,19 +251,6 @@ module Dev
       g.config("branch.#{branch}.merge", "refs/heads/#{branch}")
       puts
     rescue ::Git::GitExecuteError => e
-      raise e if raise_errors
-
-      print_errors(e.message)
-      false
-    end
-
-    def add(*paths, dir: default_project_dir, raise_errors: false)
-      g = ::Git.open(dir)
-      indent g.add(paths)
-      true
-    rescue ::Git::GitExecuteError => e
-      raise e if raise_errors
-
       print_errors(e.message)
       false
     end
@@ -292,7 +277,7 @@ module Dev
     end
 
     # Merge the given branch into the given repo
-    def merge(branch, dir: default_project_dir, raise_errors: false)
+    def merge(branch, dir: default_project_dir)
       raise 'branch is required' if branch.to_s.strip.empty?
       return unless File.exist?(dir)
 
@@ -311,8 +296,6 @@ module Dev
       indent g.merge(branch)
       true
     rescue ::Git::GitExecuteError => e
-      raise e if raise_errors
-
       print_errors(e.message)
       false
     end
@@ -337,7 +320,7 @@ module Dev
     end
 
     # Pull the given repo
-    def pull(dir: default_project_dir, raise_errors: false)
+    def pull(dir: default_project_dir)
       return unless File.exist?(dir)
 
       g = ::Git.open(dir)
@@ -348,8 +331,6 @@ module Dev
       indent g.pull('origin', branch)
       true
     rescue ::Git::GitExecuteError => e
-      raise e if raise_errors
-
       print_errors(e.message)
       false
     end
@@ -374,7 +355,7 @@ module Dev
     end
 
     # Push the given repo
-    def push(dir: default_project_dir, raise_errors: false)
+    def push(dir: default_project_dir)
       return unless File.exist?(dir)
 
       g = ::Git.open(dir)
@@ -385,8 +366,6 @@ module Dev
       indent g.push('origin', branch)
       true
     rescue ::Git::GitExecuteError => e
-      raise e if raise_errors
-
       print_errors(e.message)
       false
     end
@@ -399,7 +378,7 @@ module Dev
     # Clones the repo_name into the dir
     # Optionally specify a repo_org
     # Optionally specify a branch to check out (defaults to the repository default branch)
-    def clone_repo(dir:, repo_name:, repo_org: 'firespring', branch: nil, depth: nil)
+    def clone_repo(dir:, repo_name:, repo_org: 'firespring', branch: nil)
       if Dir.exist?("#{dir}/.git")
         puts "#{dir} already cloned".light_green
         return
@@ -411,7 +390,6 @@ module Dev
 
       opts = {}
       opts[:branch] = branch unless branch.to_s.strip.empty?
-      opts[:depth] = depth unless depth.to_s.strip.empty?
       g = ::Git.clone(ssh_repo_url(repo_name, repo_org), dir, opts)
       g.fetch('origin', prune: true)
     end

data/lib/firespring_dev_commands/jira/histories.rb

@@ -0,0 +1,11 @@
+module Dev
+  class Jira
+    class Histories
+      def self.populate(data)
+        return nil unless data.attrs.key?('changelog')
+
+        data.changelog['histories'].map { |it| Jira::History.new(it) }
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/jira/history.rb

@@ -0,0 +1,17 @@
+require 'date'
+
+module Dev
+  class Jira
+    class History
+      attr_accessor :date, :id, :author, :created, :items
+
+      def initialize(data)
+        @data = data
+        @id = data['id']
+        @author = data['author']
+        @items = data['items']
+        @created = Time.parse(data['created'])
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/jira/issue.rb

@@ -3,9 +3,9 @@ module Dev
     # Contains information and methods representing a Jira issue
     class Issue
       # Issue subtypes which do not map to a story type
-      NON_STORY_TYPES = ['review', 'sub-task', 'code review sub-task', 'pre-deploy sub-task', 'deploy sub-task', 'devops sub-task'].freeze
+      NON_STORY_TYPES = ['epic', 'review', 'sub-task', 'code review sub-task', 'pre-deploy sub-task', 'deploy sub-task', 'devops sub-task'].freeze
 
-      attr_accessor :data, :project, :id, :title, :points, :assignee, :resolved_date
+      attr_accessor :data, :project, :id, :title, :points, :assignee, :resolved_date, :histories, :last_in_progress_history, :first_in_review_history, :last_closed_history
 
       def initialize(data)
         @data = data
@@ -15,10 +15,71 @@ module Dev
         @points = calculate_points(data)
         @assignee = Jira::User.lookup(data.assignee&.accountId)
         @resolved_date = data.resolutiondate
+        @histories = Jira::Histories.populate(data)
+        @last_in_progress_history = nil
+        @first_in_review_history = nil
+        @last_closed_history = nil
+      end
+
+      def cycle_time
+        # Calculate the difference and convert to days
+        ((last_closed_history.created - last_in_progress_history.created) / 60 / 60 / 24).round(2)
+      end
+
+      def in_progress_cycle_time
+        # Calculate the difference and convert to days
+        ((first_in_review_history.created - last_in_progress_history.created) / 60 / 60 / 24).round(2)
+      end
+
+      def in_review_cycle_time
+        # Calculate the difference and convert to days
+        ((last_closed_history.created - first_in_review_history.created) / 60 / 60 / 24).round(2)
+      end
+
+      private def last_in_progress_history
+        raise 'you must expand the changelog field to calculate cycle time' if histories.nil?
+
+        # Find the first instance in the histoy where the status moved to "In Progress"
+        @last_in_progress_history ||= histories.select do |history|
+          history.items.find do |item|
+            item['fieldId'] == 'status' && item['fromString'] == 'Open' && item['toString'] == 'In Progress'
+          end
+        end.max_by(&:created)
+        raise 'unable to find "In Progress" history entry needed to calculate cycle time' unless @last_in_progress_history
+
+        @last_in_progress_history
+      end
+
+      private def first_in_review_history
+        raise 'you must expand the changelog field to calculate cycle time' if histories.nil?
+
+        # Find the first instance in the histoy where the status moved to "In Review"
+        @first_in_review_history ||= histories.select do |history|
+          history.items.find do |item|
+            item['fieldId'] == 'status' && item['toString'] == 'In Review'
+          end
+        end.min_by(&:created)
+        raise 'unable to find "In Review" history entry needed to calculate cycle time' unless @first_in_review_history
+
+        @first_in_review_history
+      end
+
+      private def last_closed_history
+        raise 'you must expand the changelog field to calculate cycle time' if histories.nil?
+
+        # Find the last instance in the histoy where the status moved to "Closed"
+        @last_closed_history ||= histories.select do |history|
+          history.items.find do |item|
+            item['fieldId'] == 'status' && item['toString'] == 'Closed'
+          end
+        end.max_by(&:created)
+        raise 'unable to find "Closed" history entry needed to calculate cycle time' unless @last_closed_history
+
+        @last_closed_history
       end
 
       # Returns the value of the jira points field or 0 if the field is not found
-      def calculate_points(data)
+      private def calculate_points(data)
         return data.send(Dev::Jira.config.points_field_name).to_i if Dev::Jira.config.points_field_name && data.respond_to?(Dev::Jira.config.points_field_name)
 
         0

data/lib/firespring_dev_commands/jira/user.rb

@@ -22,8 +22,10 @@ module Dev
       # Returns the Jira user object which maps to the give user id
       # If none is found, it returns a Jira user object with only the id set
       def self.lookup(id)
+        id = id.to_s.strip
+        id = 'notfound' if id.empty?
         user = Dev::Jira.config.user_lookup_list&.find { |it| it.id == id }
-        user ||= new(name: '', email: '', id:)
+        user ||= new(name: 'Not Found', email: 'notfound@notfound.com', id:)
         user
       end
     end

data/lib/firespring_dev_commands/jira.rb

@@ -9,12 +9,13 @@ module Dev
     # "user_lookup_list" should be an array of Jira::User objects representing the usernames, ids, etc for all jira users
     #    This is a bit clumsy but currently the jira api only returns the user id with issues
     #    and there is no way to query this information from Jira directly.
-    Config = Struct.new(:username, :token, :url, :points_field_name, :user_lookup_list, :read_timeout, :http_debug) do
+    Config = Struct.new(:username, :token, :url, :points_field_name, :expand, :user_lookup_list, :read_timeout, :http_debug) do
       def initialize
         self.username = nil
         self.token = nil
         self.url = nil
         self.points_field_name = nil
+        self.expand = []
         self.user_lookup_list = []
         self.read_timeout = 120
         self.http_debug = false
@@ -62,15 +63,16 @@ module Dev
     def issues(jql, &)
       start_at = 0
       max_results = 100
+      expand = self.class.config.expand
 
       # Query Jira and yield all issues it returns
-      issues = @client.Issue.jql(jql, start_at:, max_results:)
+      issues = @client.Issue.jql(jql, start_at:, max_results:, expand:)
       issues.map { |data| Issue.new(data) }.each(&)
 
       # If we returned the max_results then there may be more - add the max results to where we start at and query again
       while issues.length >= max_results
         start_at += max_results
-        issues = @client.Issue.jql(jql, start_at:, max_results:)
+        issues = @client.Issue.jql(jql, start_at:, max_results:, expand:)
         issues.map { |data| Issue.new(data) }.each(&)
       end
     end

data/lib/firespring_dev_commands/version.rb

@@ -6,6 +6,6 @@ module Dev
     # Use 'v.v.v.pre.alpha.v' for pre-release vesions
     # Use 'v.v.v.beta.v for beta versions
     # Use semantic versioning for any releases (https://semver.org/)
-    VERSION = '2.1.6.pre.alpha.2'.freeze
+    VERSION = '2.1.7.pre.alpha.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.6.pre.alpha.2
+  version: 2.1.7.pre.alpha.1
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-05 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -284,6 +284,8 @@ files:
 - lib/firespring_dev_commands/git.rb
 - lib/firespring_dev_commands/git/info.rb
 - lib/firespring_dev_commands/jira.rb
+- lib/firespring_dev_commands/jira/histories.rb
+- lib/firespring_dev_commands/jira/history.rb
 - lib/firespring_dev_commands/jira/issue.rb
 - lib/firespring_dev_commands/jira/project.rb
 - lib/firespring_dev_commands/jira/user.rb