firespring_dev_commands 2.3.4 → 2.5.0.pre.alpha.1

data/lib/firespring_dev_commands/git.rb

@@ -1,6 +1,5 @@
 require 'fileutils'
 require 'git'
-require 'octokit'
 
 module Dev
   # Class for performing git functions
@@ -97,8 +96,7 @@ module Dev
     def branch_name(dir: default_project_dir)
       return unless File.exist?(dir)
 
-      g = ::Git.open(dir)
-      g.current_branch || "HEAD detached at #{g.object('HEAD').sha[0..7]}"
+      ::Git.open(dir).current_branch
     end
 
     # Returns true if the remote branch exists, false otherwise
@@ -115,10 +113,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        header = "#{repo_basename} (#{original_branches[project_dir]})"
-        puts Dev::Common.new.center_pad(header).light_green
+        header = " #{repo_basename} (#{original_branches[project_dir]}) "
+        puts center_pad(header).light_green
         @success &= status(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -167,10 +165,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        header = "#{repo_basename} (#{original_branches[project_dir]})"
-        puts Dev::Common.new.center_pad(header).light_green
+        header = " #{repo_basename} (#{original_branches[project_dir]}) "
+        puts center_pad(header).light_green
         reset(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
     end
@@ -185,7 +183,7 @@ module Dev
     end
 
     # Checks out the given branch in all repositories with some additional formatting
-    def checkout_all(branch, default)
+    def checkout_all(branch)
       @success = true
       puts
       puts "Checking out #{branch} in each repo".light_yellow if project_dirs.length > 1
@@ -193,9 +191,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
-        @success &= checkout(branch, default, dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
+        @success &= checkout(branch, dir: project_dir)
+        puts center_pad.light_green
       end
       puts
 
@@ -203,10 +202,9 @@ module Dev
     end
 
     # Checks out the given branch in the given repo
-    # If the given branch isn't found, falls back to default branch, then staging, then main
     # Defaults to the current directory
     # optionally raise errors
-    def checkout(branch, default, dir: default_project_dir, raise_errors: false)
+    def checkout(branch, dir: default_project_dir, raise_errors: false)
       raise 'branch is required' if branch.to_s.strip.empty?
       return unless File.exist?(dir)
 
@@ -216,11 +214,10 @@ module Dev
       g = ::Git.open(dir)
       g.fetch('origin', prune: true)
 
-      # If the branch we are checking out doesn't exist,
-      # check out either the default branch, staging branch, or the main branch
+      # If the branch we are checking out doesn't exist, check out either the staging branch or the main branch
       actual_branch = branch
       unless branch_exists?(dir, branch)
-        actual_branch = [default, staging_branch, main_branch].uniq.find { |it| branch_exists?(dir, it) }
+        actual_branch = [staging_branch, main_branch].uniq.find { |it| branch_exists?(dir, it) }
         puts "Branch #{branch} not found, checking out #{actual_branch} instead".light_yellow
       end
 
@@ -288,9 +285,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= merge(branch, dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -336,9 +334,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= pull(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -374,9 +373,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= push(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -411,10 +411,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: nil, branch: nil, depth: nil)
-      # TODO: Split out the default of 'firespring' into a configuration variable
-      repo_org = 'firespring' if repo_org.to_s.strip.empty?
-
+    def clone_repo(dir:, repo_name:, repo_org: 'firespring', branch: nil, depth: nil)
       if Dir.exist?("#{dir}/.git")
         puts "#{dir} already cloned".light_green
         return
@@ -431,19 +428,6 @@ module Dev
       g.fetch('origin', prune: true)
     end
 
-    def commit_status(token:, repo_name:, commit_id:, status:, repo_org: nil, options: {})
-      # TODO: Split out the default of 'firespring' into a configuration variable
-      repo_org = 'firespring' if repo_org.to_s.strip.empty?
-      repo = "#{repo_org}/#{repo_name}"
-
-      # Set up the GitHub client
-      client = Octokit::Client.new(access_token: token)
-
-      # Create the commit status
-      puts "Tagging commit #{commit_id} in #{repo} as #{status} for #{options[:context]}"
-      client.create_status(repo, commit_id, status, options)
-    end
-
     # Builds an ssh repo URL using the org and repo name given
     def ssh_repo_url(name, org)
       "git@github.com:#{org}/#{name}.git"
@@ -455,10 +439,11 @@ module Dev
     end
 
     # Center the string and pad on either side with the given padding character
-    # @deprecated Please use {Dev::Common#center_pad} instead
     def center_pad(string = '', pad: '-', len: 80)
-      warn '[DEPRECATION] `Dev::Git#center_pad` is deprecated. Please use `Dev::Common#center_pad` instead.'
-      Dev::Common.new.center_pad(string, pad:, len:)
+      center_dash = len / 2
+      string = string.to_s
+      center_str = string.length / 2
+      string.rjust(center_dash + center_str - 1, pad).ljust(len - 1, pad)
     end
 
     # Exclude the command from the message and print all error lines

data/lib/firespring_dev_commands/jira/issue.rb

@@ -5,13 +5,11 @@ module Dev
       # Issue subtypes which do not map to a story type
       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, :parent, :id, :title, :points, :assignee, :resolved_date, :histories,
-                    :last_in_progress_history, :first_in_review_history, :last_closed_history
+      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
         @project = Jira::Project.new(data)
-        @parent = Jira::Parent.new(data) if data.respond_to?(:parent)
         @id = data.key
         @title = data.summary
         @points = calculate_points(data)

data/lib/firespring_dev_commands/node.rb

@@ -96,7 +96,7 @@ module Dev
       test
     end
 
-    # Build the node test command
+    # Build the node test (with coverage) command
     def test_coverage_command
       test = base_command
       test << 'run' << 'test:coverage'

data/lib/firespring_dev_commands/php/audit.rb

@@ -16,10 +16,6 @@ module Dev
       def to_report
         Dev::Audit::Report.new(
           data['advisories'].map do |_, v|
-            # If there are multiple advisories for the same package, v changes from an array into a hash
-            v = v.values if v.is_a?(Hash)
-
-            # Iterate over the advisories and turn them into report items
             v.map do |it|
               Dev::Audit::Report::Item.new(
                 id: it['advisoryId'],

data/lib/firespring_dev_commands/php.rb

@@ -8,12 +8,11 @@ module Dev
     DEFAULT_PACKAGE_FILE = 'composer.json'.freeze
 
     # Config object for setting top level git config options
-    Config = Struct.new(:container_path, :local_path, :package_file, :coverage) do
+    Config = Struct.new(:container_path, :local_path, :package_file) do
       def initialize
         self.container_path = DEFAULT_PATH
         self.local_path = DEV_COMMANDS_ROOT_DIR
         self.package_file = DEFAULT_PACKAGE_FILE
-        self.coverage = nil
       end
     end
 
@@ -31,14 +30,12 @@ module Dev
       alias_method :configure, :config
     end
 
-    attr_accessor :container_path, :local_path, :package_file, :coverage
+    attr_accessor :container_path, :local_path, :package_file
 
-    def initialize(container_path: nil, local_path: nil, package_file: nil, coverage: nil)
+    def initialize(container_path: nil, local_path: nil, package_file: nil)
       @container_path = container_path || self.class.config.container_path
       @local_path = local_path || self.class.config.local_path
       @package_file = package_file || self.class.config.package_file
-      @coverage = coverage || Dev::Coverage::None.new
-      raise 'coverage must be an instance of the base class' unless @coverage.is_a?(Dev::Coverage::Base)
     end
 
     # The base npm command that is the starting point for all subsequent commands
@@ -61,12 +58,9 @@ module Dev
     end
 
     # Build the command to fix any security vulnerabilities that were found
-    # def audit_fix_command
-    #  audit_fix = base_command
-    #  audit_fix << 'audit' << 'fix'
-    #  audit_fix.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
-    #  audit_fix
-    # end
+    def audit_fix_command
+      raise 'not implemented'
+    end
 
     # Build the php install command
     def install_command
@@ -79,7 +73,7 @@ module Dev
     # Build the php lint command
     def lint_command
       lint = base_command
-      lint << 'lint'
+      lint << 'run' << 'lint'
       lint.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint
     end
@@ -87,7 +81,7 @@ module Dev
     # Build the php lint fix command
     def lint_fix_command
       lint_fix = base_command
-      lint_fix << 'lint-fix'
+      lint_fix << 'run' << 'lint-fix'
       lint_fix.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint_fix
     end
@@ -95,24 +89,14 @@ module Dev
     # Build the php test command
     def test_command
       test = []
-      test << './vendor/bin/phpunit'
-      test.concat(coverage.php_options) if coverage
+      lint_fix << 'run' << 'test'
       test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       test
     end
 
-    # Run the check to ensure code coverage meets the desired threshold
-    def check_test_coverage(application:)
-      coverage.check(application:)
-    end
-
-    # Build the php fast test command
-    def test_fast_command(processes = 4)
-      test = []
-      test << './vendor/bin/paratest'
-      test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
-      test << "-p#{processes}" << '--runner=WrapperRunner'
-      test
+    # Build the php test (with coverage) command
+    def test_coverage_command
+      raise 'not implemented'
     end
   end
 end

data/lib/firespring_dev_commands/platform.rb

@@ -1,46 +1,39 @@
 module Dev
-  # Class which returns information about the current platform
-  class Platform
-    # Constant containing all supported architectures
-    ALLOWED_ARCHITECTURES = %w(linux/arm64 linux/amd64).freeze
-
-    # If an architecture was specified in the ENV, use that. Otherwise auto-deted based of the OS reported architecture
-    def architecture
-      arch = env_architecture || os_architecture
-      raise "Invalid DOCKER_ARCHITECTURE: #{arch} (allowed are #{ALLOWED_ARCHITECTURES.join(', ')})" unless ALLOWED_ARCHITECTURES.include?(arch)
-
-      arch
-    end
-
-    # Check to see if a docker architecture has been specified in the ENV
-    # If it has, verify the format and the value
-    private def env_architecture
-      arch = ENV['DOCKER_ARCHITECTURE'].to_s.strip.downcase
-      return nil if arch.empty?
+  class Common
+    # Class which returns information about the current platform
+    class Platform
+      # Constant containing all supported architectures
+      ALLOWED_ARCHITECTURES = %w(arm64 amd64).freeze
 
-      "linux/#{arch}" unless arch.start_with?('linux/')
-      arch
-    end
+      # Normalize the ruby platform to return a docker platform architecture format
+      def determine_compute_architecture
+        case RUBY_PLATFORM
+        when /x86_64|amd64/
+          'linux/amd64' # 64-bit Intel/AMD architecture
+        when /arm|aarch64/
+          'linux/arm64' # ARM architecture
+        else
+          raise 'Unknown or unsupported architecture'
+        end
+      end
 
-    # Returns a valid docker architecture based off the RUBY_PLATFORM
-    private def os_architecture
-      return 'linux/amd64' if RUBY_PLATFORM.match?(/x86_64|amd64|x64-mingw/)
-      return 'linux/arm64' if RUBY_PLATFORM.match?(/arm|aarch64/)
+      # Determine the platform architecture
+      # If one was specified in the DOCKER_ARCHITECTURE variable, use it
+      # Otherwise, use the RUBY_PLATFORM built-in to auto-detect and architecture
+      def architecture
+        docker_architecture = ENV['DOCKER_ARCHITECTURE'].to_s.strip.downcase
+        if docker_architecture.empty?
+          determine_compute_architecture
+        else
+          raise "Missing 'linux/' prefix in DOCKER_ARCHITECTURE: #{docker_architecture}" unless docker_architecture.start_with?('linux/')
 
-      raise 'Unknown or unsupported architecture'
-    end
-  end
-end
+          architecture_name = docker_architecture.split('/')[1]
+          unless ALLOWED_ARCHITECTURES.include?(architecture_name)
+            raise "Invalid DOCKER_ARCHITECTURE: #{architecture_name}. Allowed architectures are #{ALLOWED_ARCHITECTURES.join(', ')}"
+          end
 
-module Dev
-  class Common
-    # Class which returns information about the current platform
-    class Platform < Platform
-      # Initializer for the deprecated class
-      # @deprecated Please use {Dev::Platform#new} instead
-      def initialize
-        warn '[DEPRECATION] `Dev::Common::Platform#new` is deprecated.  Please use `Dev::Platform#new` instead.'
-        super
+          docker_architecture
+        end
       end
     end
   end

data/lib/firespring_dev_commands/ruby.rb

@@ -90,16 +90,14 @@ module Dev
 
     # Build the bundle lint command
     def lint_command
-      lint = base_command
-      lint << 'exec' << 'rubocop'
+      lint = ['rubocop']
       lint.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint
     end
 
     # Build the bundle lint fix command
     def lint_fix_command
-      lint_fix = base_command
-      lint_fix << 'exec' << 'rubocop'
+      lint_fix = ['rubocop']
       lint_fix << '-A'
       lint_fix.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint_fix
@@ -107,8 +105,7 @@ module Dev
 
     # Build the bundle test command
     def test_command
-      test = base_command
-      test << 'exec' << 'rspec'
+      test = ['rspec']
       test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       test
     end

data/lib/firespring_dev_commands/target_process/query.rb

@@ -2,13 +2,12 @@ module Dev
   class TargetProcess
     # Class for writing target process query statements
     class Query
-      attr_accessor :where, :incl, :take, :empty
+      attr_accessor :where, :incl, :take
 
       def initialize
         @where = []
         @incl = []
         @take = 250
-        @empty = false
       end
 
       # Add a new query clause
@@ -34,11 +33,6 @@ module Dev
         end
       end
 
-      # Check if any of the "in" statements were empty. If so then we don't want to actually run the query
-      def empty?
-        @empty == true
-      end
-
       # Generate the string representation for this query
       def generate
         {}.tap do |clause|
@@ -56,38 +50,22 @@ module Dev
       # TODO: Do these need moved to their associated entities?
       # Add a filter that looks for stories whose id is contained in the list of ids given
       def filter_by_user_story_ids(user_story_ids)
-        if user_story_ids.nil? || user_story_ids.empty?
-          @empty = true
-          return
-        end
         self << "(Id in ('#{user_story_ids.join("', '")}'))"
       end
 
       # Add a filter that looks for stories whose team id is contained in the list of ids given
       def filter_by_team_ids(team_ids)
-        if team_ids.nil? || team_ids.empty?
-          @empty = true
-          return
-        end
-        self << "(Team.Id in ('#{team_ids.join("', '")}'))"
+        self << "(Team.Id in ('#{team_ids.join("', '")}'))" unless team_ids.nil? || team_ids.empty?
       end
 
       # Add a filter that looks for stories whose project id is contained in the list of ids given
       def filter_by_project(projects)
-        if projects.nil? || projects.empty?
-          @empty = true
-          return
-        end
         self << "(Project.Name in ('#{projects.join("', '")}'))"
       end
 
       # Add a filter that looks for stories whose state is contained in the list of states given
       def filter_by_states(states)
-        if states.nil? || states.empty?
-          @empty = true
-          return
-        end
-        self << "(EntityState.Name in ('#{states.join("', '")}'))"
+        self << "(EntityState.Name in ('#{states.join("', '")}'))" unless states.nil? || states.empty?
       end
 
       # Add a filter that looks for stories whose state is set to final
@@ -136,11 +114,7 @@ module Dev
 
       # Add a filter that looks for assignable ids which are included in the given array
       def filter_by_entity_ids(entity_ids)
-        if entity_ids.nil? || entity_ids.empty?
-          @empty = true
-          return
-        end
-        self << "(Assignable.Id in ('#{entity_ids.join("', '")}'))"
+        self << "(Assignable.Id in ('#{entity_ids.join("', '")}'))" unless entity_ids.nil? || entity_ids.empty?
       end
 
       # Add a filter that looks for a custom deploy date between the given dates`

data/lib/firespring_dev_commands/target_process/release.rb

@@ -24,7 +24,7 @@ module Dev
       def parse_time(string)
         return nil unless string && !string.empty?
 
-        ::Time.at(string.slice(6, 10).to_i)
+        Time.at(string.slice(6, 10).to_i)
       end
     end
   end

data/lib/firespring_dev_commands/target_process/team_assignment.rb

@@ -24,7 +24,7 @@ module Dev
       def parse_time(string)
         return nil unless string && !string.empty?
 
-        ::Time.at(string.slice(6, 10).to_i)
+        Time.at(string.slice(6, 10).to_i)
       end
 
       # Calculate the cycle time as the amount of time the story was open

data/lib/firespring_dev_commands/target_process/user.rb

@@ -2,13 +2,7 @@ module Dev
   class TargetProcess
     # Class containing user information
     class User
-      # The resource type for the api endpoint
-      RESOURCE_TYPE = 'User'.freeze
-
-      # The api path for user requests
-      PATH = '/User'.freeze
-
-      attr_accessor :data, :id, :type, :name, :login, :email
+      attr_accessor :data, :id, :type, :name, :login
 
       def initialize(data)
         @data = data
@@ -16,12 +10,6 @@ module Dev
         @type = data['ResourceType']
         @name = data['FullName']
         @login = data['Login']
-        @email = data['Email']
-      end
-
-      # Get the user with the given id and return that object
-      def self.get(id)
-        new(TargetProcess.new.get("#{User::PATH}/#{id}", Query.new))
       end
     end
   end

data/lib/firespring_dev_commands/target_process/user_story.rb

@@ -37,7 +37,7 @@ module Dev
       def parse_time(string)
         return nil unless string && !string.empty?
 
-        ::Time.at(string.slice(6, 10).to_i)
+        Time.at(string.slice(6, 10).to_i)
       end
 
       # Calculate the cycle time as the amount of time the story was open

data/lib/firespring_dev_commands/target_process/user_story_history.rb

@@ -38,7 +38,7 @@ module Dev
       def parse_time(string)
         return nil unless string && !string.empty?
 
-        ::Time.at(string.slice(6, 10).to_i)
+        Time.at(string.slice(6, 10).to_i)
       end
     end
   end

data/lib/firespring_dev_commands/target_process.rb

@@ -15,7 +15,7 @@ module Dev
     # The text of the url variable key
     TP_URL = 'TP_URL'.freeze
 
-    # Config object for setting top level target process config options
+    # Config object for setting top level jira config options
     Config = Struct.new(:username, :password, :url, :http_debug) do
       def initialize
         Dotenv.load(CONFIG_FILE) if File.exist?(CONFIG_FILE)
@@ -72,8 +72,8 @@ module Dev
       [].tap do |ary|
         get(Release::PATH, query) do |result|
           ary << Release.new(result)
-          yield ary.last if block_given?
         end
+        ary.each(&)
       end
     end
 
@@ -84,8 +84,8 @@ module Dev
       [].tap do |ary|
         get(UserStory::PATH, query) do |result|
           ary << UserStory.new(result)
-          yield ary.last if block_given?
         end
+        ary.each(&)
       end
     end
 
@@ -96,8 +96,8 @@ module Dev
       [].tap do |ary|
         get(UserStoryHistory::PATH, query) do |result|
           ary << UserStoryHistory.new(result)
-          yield ary.last if block_given?
         end
+        ary.each(&)
       end
     end
 
@@ -108,20 +108,8 @@ module Dev
       [].tap do |ary|
         get(TeamAssignment::PATH, query) do |result|
           ary << TeamAssignment.new(result)
-          yield ary.last if block_given?
-        end
-      end
-    end
-
-    # Perform a query to the time api path
-    # Call the given block (if present) with each time
-    # Return all times
-    def times(query, &)
-      [].tap do |ary|
-        get(Time::PATH, query) do |result|
-          ary << Time.new(result)
-          yield ary.last if block_given?
         end
+        ary.each(&)
       end
     end
 
@@ -129,8 +117,6 @@ module Dev
     # Call the given block (if present) with each piece of data
     # Return all pieces of data
     def get(path, query, &)
-      return [] if query.empty?
-
       query_string = query.generate
       url = "/api/v1/#{path}"
       url << "?#{URI.encode_www_form(query_string)}" unless query_string.empty?
@@ -144,11 +130,8 @@ module Dev
       parsed_response['Items'].each(&)
 
       while parsed_response['Next']
-        next_query_string = URI(parsed_response['Next']).query
-        next_url = "/api/v1/#{path}"
-        next_url << "?#{next_query_string}" unless query_string.empty?
-        response = client.request_get(next_url, headers)
-        raise "Error querying #{next_url} [#{next_query_string}]: #{response.inspect}" unless response.response.is_a?(Net::HTTPSuccess)
+        response = client.request_get(parsed_response['Next'], headers)
+        raise "Error querying #{parsed_response['Next']} [#{query_string}]: #{response.inspect}" unless response.response.is_a?(Net::HTTPSuccess)
 
         parsed_response = JSON.parse(response.body)
         return parsed_response unless parsed_response.key?('Items')