firespring_dev_commands 2.1.24.pre.alpha.2 → 2.1.25.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb2cf1870dd2e6e30d0dbd360bee8827c3bf8f748051a1692411e1a3d3324e71
-  data.tar.gz: d71152d34719d590445f2265d955faecfc502cb4864411a54fa4c26d2038b666
+  metadata.gz: 235d5f072b69f3bb254426a735dff14aab125c350ac839607680079c81dfaec7
+  data.tar.gz: cbc047347a657b8e00c129cc4b9059f66366b64f088d3b7dd117e5cf8b40fdf7
 SHA512:
-  metadata.gz: 5040fae63fb2071356d149f22128aedd0fc4bed611431e1254d0eeff1f3b59b4d7656a1be78d502c5bd0a329c095cff050878f42722aac15d1d376b005313096
-  data.tar.gz: ed7695707e6d7fd6dfb7e8962a7001500fd2e62dc8844761ec2cc267e5fedcc023a20d61805fbf650dbd9bdeaed10578d5eb8b43f7a7c04d46c0086430d31b9d
+  metadata.gz: 285074c0b9aaa50b96bb64e1fb4dadde6156569245c98aa8033ac947d6378e0f71f6dcc35f690cd2cb3d8d0c139bb10a27df5451e9a8956e2cf058f1a64d3bc7
+  data.tar.gz: add7ae0e81533290ab062a0ee35226b9f22231d5ac2dd7c7a9a977538885c799287cca5962227925cecd8c8c23b79c7e73936f783f84523c49efdba4f42dd3a1

data/lib/firespring_dev_commands/coverage/base.rb

@@ -1,10 +1,13 @@
 module Dev
   module Coverage
+    # Class which defines the methods which must be implemented to function as a coverage class
     class Base
+      # Raises not implemented
       def php_options
         raise 'not implemented'
       end
 
+      # Raises not implemented
       def check(*)
         raise 'not implemented'
       end

data/lib/firespring_dev_commands/coverage/none.rb

@@ -1,14 +1,18 @@
 module Dev
+  # Module with a variety of coverage methods for different languages
   module Coverage
+    # Class which provides methods to effectvely skip coverage
     class None < Base
       def initialize(*)
         super()
       end
 
+      # Returns the php options for generating code coverage file
       def php_options
         []
       end
 
+      # Checks the code coverage against the defined threshold
       def check(*)
         puts 'Coverage not configured'
       end

data/lib/firespring_dev_commands/docker/desktop.rb

@@ -0,0 +1,63 @@
+module Dev
+  class Docker
+    # Class for configuring docker desktop
+    # This is mostly around configuring the docker URL correctly
+    class Desktop
+      # A snippet of a docker compose file which forwards a socket to a local port so that we can read it in the docker library
+      WIN_TCP_COMPOSE_CONTENT = "
+---
+version: '3.8'
+services:
+  socat:
+    image: alpine/socat
+    container_name: windows_tcp
+    network_mode: bridge
+    ports:
+      - 127.0.0.1:23750:2375
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+    command: tcp-listen:2375,reuseaddr,fork unix-connect:/var/run/docker.sock
+    restart: always".freeze
+
+      # Set up the local ports/sockets correctly based off of the os type
+      def configure
+        if Dev::Os.new.windows?
+          # Start up a small proxy container if running Docker Desktop on windows
+          # This is needed because the docker api library cannot connect to the windows socket
+          unless Dev::Port.new('127.0.0.1', 23_750).open?
+            LOG.info('Starting local proxy port for docker')
+
+            # Make sure any stopped version of the container are cleaned up
+            Dev::Docker.new.prune_containers
+
+            # Write the compose data to a tmp file
+            tmp_compose_file = Tempfile.new('windows_tcp')
+            tmp_compose_file.write(WIN_TCP_COMPOSE_CONTENT)
+            tmp_compose_file.close
+
+            # Start up the container
+            Dev::Docker::Compose.new(
+              compose_files: tmp_compose_file.path,
+              options: ['--detach'],
+              project_name: SecureRandom.hex
+            ).up
+
+            # Wait 1 second before we continue
+            sleep 1
+          end
+
+          # Configure the docker url to use 23750 on windows
+          ::Docker.url = 'tcp://127.0.0.1:23750'
+
+        else
+          # If a user based socket has been defined, default to that
+          ::Docker.url = if File.exist?("/#{Dir.home}/.docker/run/docker.sock")
+                           "unix://#{Dir.home}/.docker/run/docker.sock"
+                         elsif File.exist?("/#{Dir.home}/.docker/desktop/docker.sock")
+                           "unix://#{Dir.home}/.docker/desktop/docker.sock"
+                         end
+        end
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/eol.rb

@@ -5,9 +5,8 @@ module Dev
     END_OF_LIFE_API_URL = 'https://endoflife.date/api'.freeze
 
     # Config object for setting top level git config options
-    Config = Struct.new(:check_aws_resources, :product_versions, :manual_dates) do
+    Config = Struct.new(:product_versions, :manual_dates) do
       def initialize
-        self.check_aws_resources = false
         self.product_versions = []
         self.manual_dates = {}
       end
@@ -27,10 +26,9 @@ module Dev
       alias_method :configure, :config
     end
 
-    attr_accessor :url, :products, :check_aws_resources, :product_versions
+    attr_accessor :url, :products, :product_versions
 
-    def initialize(check_aws_resources: self.class.config.check_aws_resources, product_versions: self.class.config.product_versions)
-      @check_aws_resources = check_aws_resources
+    def initialize(product_versions: self.class.config.product_versions)
       @product_versions = Array(product_versions)
       raise 'product version must be of type Dev::EndOfLife::ProductVersions' unless @product_versions.all?(Dev::EndOfLife::ProductVersion)
     end
@@ -52,14 +50,7 @@ module Dev
     # Raises an error if any products are EOL
     def check
       puts
-      checks_to_perform = product_versions.clone
-      if check_aws_resources
-        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
-        checks_to_perform.concat(Dev::EndOfLife::Aws.new.default_products)
-      end
-      checks_to_perform.sort_by(&:name).each(&:print_status)
+      product_versions.sort_by(&:name).each(&:print_status)
       puts
       raise 'found EOL versions' if product_versions.any?(&:eol)
     end

data/lib/firespring_dev_commands/os.rb

@@ -0,0 +1,35 @@
+module Dev
+  # Class containing methods for determining operating system information
+  class Os
+    attr_accessor :os
+
+    def initialize
+      @os = ::RbConfig::CONFIG['host_os']
+    end
+
+    # Returns true if the host_os contains windowsy text
+    def windows?
+      os.match?(/(mingw|mswin|windows)/i)
+    end
+
+    # Returns true if the host_os contains darwinsy text
+    def darwin?
+      os.match?(/(darwin|mac os)/i)
+    end
+
+    # Returns true if the host_os contains macsy text
+    def mac?
+      darwin?
+    end
+
+    # Returns true if the host_os contains nixy text
+    def nix?
+      os.match?(/(linux|bsd|aix|solaris)/i)
+    end
+
+    # Returns true if the host_os contains cygwiny text
+    def cygwin?
+      os.match?(/(cygwin)/i)
+    end
+  end
+end

data/lib/firespring_dev_commands/port.rb

@@ -0,0 +1,24 @@
+module Dev
+  # Class containing methods for actions to be taken on ports
+  class Port
+    attr_accessor :ip_address, :port
+
+    def initialize(ip_address, port)
+      @ip_address = ip_address
+      @port = port
+    end
+
+    # Returns true if the port is open
+    # Returns false otherwise
+    def open?(timeout = 1)
+      Timeout.timeout(timeout) do
+        TCPSocket.new(ip_address, port).close
+        return true
+      end
+
+      false
+    rescue Timeout::Error, Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+      false
+    end
+  end
+end

data/lib/firespring_dev_commands/templates/aws.rb

@@ -94,11 +94,23 @@ module Dev
       end
       # rubocop:enable Metrics/MethodLength
 
-      # Set the EOL library to also check AWS resources
+      # Create the rake task for the eol method
       def create_eol_task!
-        return if exclude.include?(:eol)
+        # 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?(:eol)
 
-        Dev::EndOfLife.config { |c| c.check_aws_resources = true }
+          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
+
+            Dev::EndOfLife.new(product_versions: Dev::EndOfLife::Aws.new.default_products).check
+          end
+        end
       end
     end
   end

data/lib/firespring_dev_commands/templates/git.rb

@@ -4,23 +4,6 @@ module Dev
   module Template
     # Class contains rake templates for managing your git project
     class Git < Dev::Template::BaseInterface
-      # Create the rake task for cloning all defined repos
-      def create_clone_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
-          namespace :git do
-            return if exclude.include?(:clone)
-
-            desc 'Make sure all repos are cloned'
-            task :clone do
-              Dev::Git.new.clone_repos
-            end
-          end
-        end
-      end
-
       # Create the rake task for the git checkout method
       def create_checkout_task!
         # Have to set a local variable to be accessible inside of the instance_eval block

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.24.pre.alpha.2'.freeze
+    VERSION = '2.1.25.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.24.pre.alpha.2
+  version: 2.1.25.pre.alpha.1
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -339,6 +339,7 @@ files:
 - lib/firespring_dev_commands/daterange.rb
 - lib/firespring_dev_commands/docker.rb
 - lib/firespring_dev_commands/docker/compose.rb
+- lib/firespring_dev_commands/docker/desktop.rb
 - lib/firespring_dev_commands/docker/status.rb
 - lib/firespring_dev_commands/dotenv.rb
 - lib/firespring_dev_commands/env.rb
@@ -357,9 +358,11 @@ files:
 - lib/firespring_dev_commands/logger.rb
 - lib/firespring_dev_commands/node.rb
 - lib/firespring_dev_commands/node/audit.rb
+- lib/firespring_dev_commands/os.rb
 - lib/firespring_dev_commands/php.rb
 - lib/firespring_dev_commands/php/audit.rb
 - lib/firespring_dev_commands/platform.rb
+- lib/firespring_dev_commands/port.rb
 - lib/firespring_dev_commands/rake.rb
 - lib/firespring_dev_commands/ruby.rb
 - lib/firespring_dev_commands/ruby/audit.rb