firespring_dev_commands 2.2.6 → 2.5.0.pre.alpha.1

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')

data/lib/firespring_dev_commands/templates/aws.rb

@@ -18,22 +18,6 @@ module Dev
         end
       end
 
-      # Create the rake task which shows the current AWS account information
-      def create_show_account_info_task!
-        # Have to set a local variable to be accessible inside of the instance_eval block
-        exclude = @exclude
-
-        DEV_COMMANDS_TOP_LEVEL.instance_eval do
-          return if exclude.include?(:show_account_info)
-
-          task show_account_info: %w(init ensure_aws_credentials) do
-            account_id = Dev::Aws::Credentials.new.logged_in_account
-            account_name = Dev::Aws::Account.new.name_by_account(account_id)
-            LOG.info "\n  Current AWS Account is #{account_name} (#{account_id})\n".light_yellow
-          end
-        end
-      end
-
       # Create the rake task for the aws profile method
       def create_profile_task!
         # Have to set a local variable to be accessible inside of the instance_eval block
@@ -118,24 +102,13 @@ module Dev
         DEV_COMMANDS_TOP_LEVEL.instance_eval do
           return if exclude.include?(:eol)
 
-          task eol: [:'eol:aws'] do
-            # This is just a placeholder to execute the dependencies
-          end
-
-          namespace :eol do
-            desc 'Compares the current date to the EOL date for supported aws resources'
-            task aws: %w(init ensure_aws_credentials) do
-              next if ENV.fetch('CHECK_AWS', nil).to_s.strip == 'false'
-
-              aws_products = Dev::EndOfLife::Aws.new.default_products
-              next if aws_products.empty?
+          desc 'Compares the current date to the EOL date for supported resources'
+          task eol: %w(init ensure_aws_credentials) do
+            account_id = Dev::Aws::Profile.new.current
+            account_name = Dev::Aws::Account.new.name_by_account(account_id)
+            LOG.info "  Current AWS Account is #{account_name} (#{account_id})".light_yellow
 
-              puts
-              account_id = Dev::Aws::Profile.new.current
-              account_name = Dev::Aws::Account.new.name_by_account(account_id)
-              puts "AWS product versions (in account #{account_name} / #{account_id})".light_yellow
-              Dev::EndOfLife.new(product_versions: aws_products).status
-            end
+            Dev::EndOfLife.new(product_versions: Dev::EndOfLife::Aws.new.default_products).check
           end
         end
       end

data/lib/firespring_dev_commands/templates/base_interface.rb

@@ -47,14 +47,14 @@ end
 # Create the base init command
 DEV_COMMANDS_TOP_LEVEL.instance_eval do
   task :init do
-    # Default Base Init method
+    LOG.debug 'In base init'
   end
 end
 
 # Create the base init_docker command
 DEV_COMMANDS_TOP_LEVEL.instance_eval do
   task init_docker: %w(init) do
-    # Default Base Init Docker method
+    LOG.debug 'In base init docker'
   end
 end
 

data/lib/firespring_dev_commands/templates/ci.rb

@@ -20,17 +20,15 @@ module Dev
           # Have to set a local variable to be accessible inside of the instance_eval block
           exclude = @exclude
           cloudformations = @cloudformations
-          return if exclude.include?(:create)
+          return if exclude.include?(:status)
 
           DEV_COMMANDS_TOP_LEVEL.instance_eval do
             namespace :ci do
               desc 'Create the ci cloudformation stack in aws'
-              task create: %w(init ensure_aws_credentials show_account_info) do
+              task create: %w(init ensure_aws_credentials) do
+                LOG.info
                 next if cloudformations.empty?
 
-                names = cloudformations.map(&:name).join(', ')
-                Dev::Common.new.exit_unless_confirmed("  This will create the #{names} pipelines. Continue?")
-
                 # Start create on all stacks without waiting so they are created in parallel
                 cloudformations.each do |cloudformation|
                   next if cloudformation.exist?
@@ -55,17 +53,15 @@ module Dev
           # Have to set a local variable to be accessible inside of the instance_eval block
           exclude = @exclude
           cloudformations = @cloudformations
-          return if exclude.include?(:update)
+          return if exclude.include?(:status)
 
           DEV_COMMANDS_TOP_LEVEL.instance_eval do
             namespace :ci do
               desc 'Update the ci cloudformation stack in aws'
-              task update: %w(init ensure_aws_credentials show_account_info) do
+              task update: %w(init ensure_aws_credentials) do
+                LOG.info
                 next if cloudformations.empty?
 
-                names = cloudformations.map(&:name).join(', ')
-                Dev::Common.new.exit_unless_confirmed("  This will update the #{names} pipelines. Continue?")
-
                 # Start update on all stacks without waiting so they are updated in parallel
                 cloudformations.each do |cloudformation|
                   next unless cloudformation.exist?
@@ -90,17 +86,15 @@ module Dev
           # Have to set a local variable to be accessible inside of the instance_eval block
           exclude = @exclude
           cloudformations = @cloudformations
-          return if exclude.include?(:delete)
+          return if exclude.include?(:status)
 
           DEV_COMMANDS_TOP_LEVEL.instance_eval do
             namespace :ci do
               desc 'Delete the ci cloudformation stack in aws'
-              task delete: %w(init ensure_aws_credentials show_account_info) do
+              task delete: %w(init ensure_aws_credentials) do
+                LOG.info
                 next if cloudformations.empty?
 
-                names = cloudformations.map(&:name).join(', ')
-                Dev::Common.new.exit_unless_confirmed("  This will delete the #{names} pipelines. Continue?")
-
                 # Start delete on all stacks without waiting so they are deleted in parallel
                 cloudformations.each do |cloudformation|
                   next unless cloudformation.exist?
@@ -130,7 +124,8 @@ module Dev
           DEV_COMMANDS_TOP_LEVEL.instance_eval do
             namespace :ci do
               desc 'Show the current status of the pipelines associated with your branch'
-              task status: %w(init ensure_aws_credentials show_account_info) do
+              task status: %w(init ensure_aws_credentials) do
+                LOG.info
                 next if cloudformations.empty?
 
                 pattern = /#{cloudformations.map(&:name).join('|')}/

data/lib/firespring_dev_commands/templates/docker/application.rb

@@ -72,7 +72,7 @@ module Dev
               return if exclude.include?(:sh)
 
               desc "Open a shell into a running #{application} container"
-              task sh: %W(init_docker #{application}:up_no_deps _pre_sh_hooks) do
+              task sh: %W(init_docker #{application}:up _pre_sh_hooks) do
                 Dev::Docker::Compose.new(services: [application]).sh
                 Rake::Task[:_post_sh_hooks].execute
               end
@@ -154,7 +154,7 @@ module Dev
               return if exclude.include?(:reload)
 
               desc "Reloads the #{application} container"
-              task reload: %w(init_docker _pre_reload_hooks down up_no_deps) do
+              task reload: %w(init_docker _pre_reload_hooks down up) do
                 Rake::Task[:_post_reload_hooks].execute
               end
             end

data/lib/firespring_dev_commands/templates/docker/node/application.rb

@@ -7,29 +7,15 @@ module Dev
       module Node
         # Class for default rake tasks associated with a node project
         class Application < Dev::Template::ApplicationInterface
-          attr_reader :node, :start_container_dependencies_on_test
-
-          # Create the templated rake tasks for the node application
-          #
-          # @param application [String] The name of the application
-          # @param container_path [String] The path to the application inside of the container
-          # @param local_path [String] The path to the application on your local system
-          # @param start_container_dependencies_on_test [Boolean] Whether or not to start up container dependencies when running tests
-          # @param exclude [Array<Symbol>] An array of default template tasks to exclude
-          def initialize(
-            application,
-            container_path: nil,
-            local_path: nil,
-            start_container_dependencies_on_test: true,
-            exclude: []
-          )
+          attr_reader :node
+
+          # Allow for custom container path for the application
+          def initialize(application, container_path: nil, local_path: nil, exclude: [])
             @node = Dev::Node.new(container_path:, local_path:)
-            @start_container_dependencies_on_test = start_container_dependencies_on_test
             super(application, exclude:)
           end
 
           # Create the rake task which runs linting for the application name
-          # rubocop:disable Metrics/MethodLength
           def create_lint_task!
             application = @name
             node = @node
@@ -43,13 +29,6 @@ module Dev
                   # This is just a placeholder to execute the dependencies
                 end
 
-                namespace :lint do
-                  desc 'Run all linting software and apply all available fixes'
-                  task fix: %w(node:lint:fix) do
-                    # This is just a placeholder to execute the dependencies
-                  end
-                end
-
                 namespace :node do
                   desc "Run the node linting software against the #{application}'s codebase"
                   task lint: %w(init_docker up_no_deps) do
@@ -74,14 +53,12 @@ module Dev
               end
             end
           end
-          # rubocop:enable Metrics/MethodLength
 
           # Create the rake task which runs all tests for the application name
           def create_test_task!
             application = @name
             node = @node
             exclude = @exclude
-            up_cmd = @start_container_dependencies_on_test ? :up : :up_no_deps
             return if exclude.include?(:test)
 
             DEV_COMMANDS_TOP_LEVEL.instance_eval do
@@ -93,7 +70,7 @@ module Dev
 
                 namespace :node do
                   desc "Run all node tests against the #{application}'s codebase"
-                  task test: %W(init_docker #{up_cmd}) do
+                  task test: %w(init_docker up) do
                     LOG.debug("Running all node tests in the #{application} codebase")
 
                     options = []
@@ -163,33 +140,6 @@ module Dev
               end
             end
           end
-
-          # Create the rake task for the node eol method
-          def create_eol_task!
-            # Have to set a local variable to be accessible inside of the instance_eval block
-            exclude = @exclude
-            node = @node
-
-            DEV_COMMANDS_TOP_LEVEL.instance_eval do
-              return if exclude.include?(:eol)
-
-              task eol: [:'eol:node'] do
-                # This is just a placeholder to execute the dependencies
-              end
-
-              namespace :eol do
-                desc 'Compares the current date to the EOL date for supported packages in the node package file'
-                task node: %w(init) do
-                  eol = Dev::EndOfLife::Node.new(node)
-                  node_products = eol.default_products
-
-                  puts
-                  puts "Node product versions (in #{eol.lockfile})".light_yellow
-                  Dev::EndOfLife.new(product_versions: node_products).status
-                end
-              end
-            end
-          end
         end
       end
     end