firespring_dev_commands 1.3.0 → 1.4.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6f07bb537b2a77642593e6f28ad14791810c0395b56eb73b7dfe062f414491c
-  data.tar.gz: 6fd0bb605fb7fa4fe17f5baf565003a960479774b0f0d83a4c5c3b6cf1ceacd9
+  metadata.gz: cfbd9f0c516989ed9533d89c0ac479d8ba0721ee3be2c49e0804ca6fd0583a82
+  data.tar.gz: 9ba36433baabd374d4d213005996e71ef68e553a7351c191d7712cf182bc923f
 SHA512:
-  metadata.gz: a8f58eca8af848da446bd775e0fb7a329cf94188abe44ae6a6ce4b7f074cf09a6d7a8598bbd4a8e1cdd69031dae586380d543f28b398821c5f63ac4c53fbe13d
-  data.tar.gz: 2edd0e114d231fbc3019d4c4235a51629df99e91dcd49c4ca4b0d03ee40cbf7ee8d2639670e4f5613f0027cfdb89b6b3ad204cd5856e9896099381fbbad2b2d7
+  metadata.gz: c86e589fd697eaea43352ab91fabea539d6c1d5bed10319ef827f48abd9df0cc895c47c04b8738bf5b45d640ce3ab274de812d98ab6b0a43d5167bc75e261edd
+  data.tar.gz: 3de8999147a150a425588dacef3dd9947c7e60f45ca781858a707b9a87f152c92e1827bbde7237d5ec8c0157a1b875f448d79a93ed1e128fdbdf0188939d3601

data/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 Firespring
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 Firespring
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/firespring_dev_commands/templates/base_interface.rb

@@ -47,8 +47,166 @@ DEV_COMMANDS_TOP_LEVEL.instance_eval do
   end
 end
 
+# Create the base init_docker command
 DEV_COMMANDS_TOP_LEVEL.instance_eval do
   task init_docker: %w(init) do
     LOG.debug 'In base init docker'
   end
 end
+
+# Create the base hook commands
+DEV_COMMANDS_TOP_LEVEL.instance_eval do
+  # Define an empty _pre_build_hooks handler which can be overridden by the user
+  task :_pre_build_hooks do
+    # The user may define custom _pre_build_hooks tasks to add any pre-build actions the build process
+    # Define this process in the appropriate namespace to add them only to a specific build
+    #   In that case it is recommended that you call the base _pre_build_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_build_hooks handler which can be overridden by the user
+  task :_post_build_hooks do
+    # The user may define custom _post_build_hooks tasks to add any post-build actions the build process
+    # Define this process in the appropriate namespace to add them only to a specific build
+    #   In that case it is recommended that you call the base _post_build_hooks as a dependency of that task
+  end
+
+  # Define an empty _pre_up_hooks handler which can be overridden by the user
+  task :_pre_up_hooks do
+    # The user may define custom _pre_up_hooks tasks to add any pre-up actions the up process
+    # Define this process in the appropriate namespace to add them only to a specific up
+    #   In that case it is recommended that you call the base _pre_up_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_up_hooks handler which can be overridden by the user
+  task :_post_up_hooks do
+    # The user may define custom _post_up_hooks tasks to add any post-up actions the up process
+    # Define this process in the appropriate namespace to add them only to a specific up
+    #   In that case it is recommended that you call the base _post_up_hooks as a dependency of that task
+  end
+
+  # Define an empty _pre_sh_hooks handler which can be overridden by the user
+  task :_pre_sh_hooks do
+    # The user may define custom _pre_sh_hooks tasks to add any pre-sh actions the sh process
+    # Define this process in the appropriate namespace to add them only to a specific sh
+    #   In that case it is recommended that you call the base _pre_sh_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_sh_hooks handler which can be overridden by the user
+  task :_post_sh_hooks do
+    # The user may define custom _post_sh_hooks tasks to add any post-sh actions the sh process
+    # Define this process in the appropriate namespace to add them only to a specific sh
+    #   In that case it is recommended that you call the base _post_sh_hooks as a dependency of that task
+  end
+
+  # Define an empty _pre_logs_hooks handler which can be overridden by the user
+  task :_pre_logs_hooks do
+    # The user may define custom _pre_logs_hooks tasks to add any pre-logs actions the logs process
+    # Define this process in the appropriate namespace to add them only to a specific logs
+    #   In that case it is recommended that you call the base _pre_logs_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_logs_hooks handler which can be overridden by the user
+  task :_post_logs_hooks do
+    # The user may define custom _post_logs_hooks tasks to add any post-logs actions the logs process
+    # Define this process in the appropriate namespace to add them only to a specific logs
+    #   In that case it is recommended that you call the base _post_logs_hooks as a dependency of that task
+  end
+
+  # Define an empty _pre_down_hooks handler which can be overridden by the user
+  task :_pre_down_hooks do
+    # The user may define custom _pre_logs_hooks tasks to add any pre-logs actions the logs process
+    # Define this process in the appropriate namespace to add them only to a specific logs
+    #   In that case it is recommended that you call the base _pre_logs_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_down_hooks handler which can be overridden by the user
+  task :_post_down_hooks do
+    # The user may define custom _post_down_hooks tasks to add any post-down actions the down process
+    # Define this process in the appropriate namespace to add them only to a specific down
+    #   In that case it is recommended that you call the base _post_down_hooks as a dependency of that task
+  end
+
+  # Define an empty _pre_reload_hooks handler which can be overridden by the user
+  task :_pre_reload_hooks do
+    # The user may define custom _pre_reload_hooks tasks to add any pre-reload actions the reload process
+    # Define this process in the appropriate namespace to add them only to a specific reload
+    #   In that case it is recommended that you call the base _pre_reload_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_reload_hooks handler which can be overridden by the user
+  task :_post_reload_hooks do
+    # The user may define custom _post_reload_hooks tasks to add any post-reload actions the reload process
+    # Define this process in the appropriate namespace to add them only to a specific reload
+    #   In that case it is recommended that you call the base _post_reload_hooks as a dependency of that task
+  end
+
+  # Define an empty _pre_clean_hooks handler which can be overridden by the user
+  task :_pre_clean_hooks do
+    # The user may define custom _pre_clean_hooks tasks to add any pre-clean actions the clean process
+    # Define this process in the appropriate namespace to add them only to a specific clean
+    #   In that case it is recommended that you call the base _pre_clean_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_clean_hooks handler which can be overridden by the user
+  task :_post_clean_hooks do
+    # The user may define custom _post_clean_hooks tasks to add any post-clean actions the clean process
+    # Define this process in the appropriate namespace to add them only to a specific clean
+    #   In that case it is recommended that you call the base _post_clean_hooks as a dependency of that task
+  end
+
+  # Define an empty _pre_push_hooks handler which can be overridden by the user
+  task :_pre_push_hooks do
+    # The user may define custom _pre_push_hooks tasks to add any pre-push actions the push process
+    # Define this process in the appropriate namespace to add them only to a specific push
+    #   In that case it is recommended that you call the base _pre_push_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_push_hooks handler which can be overridden by the user
+  task :_post_push_hooks do
+    # The user may define custom _post_push_hooks tasks to add any post-push actions the push process
+    # Define this process in the appropriate namespace to add them only to a specific push
+    #   In that case it is recommended that you call the base _post_push_hooks as a dependency of that task
+  end
+
+  # Define an empty _pre_pull_hooks handler which can be overridden by the user
+  task :_pre_pull_hooks do
+    # The user may define custom _pre_pull_hooks tasks to add any pre-pull actions the pull process
+    # Define this process in the appropriate namespace to add them only to a specific pull
+    #   In that case it is recommended that you call the base _pre_pull_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_pull_hooks handler which can be overridden by the user
+  task :_post_pull_hooks do
+    # The user may define custom _post_pull_hooks tasks to add any post-pull actions the pull process
+    # Define this process in the appropriate namespace to add them only to a specific pull
+    #   In that case it is recommended that you call the base _post_pull_hooks as a dependency of that task
+  end
+
+  # Define an empty _pre_images_hooks handler which can be overridden by the user
+  task :_pre_images_hooks do
+    # The user may define custom _pre_images_hooks tasks to add any pre-images actions the images process
+    # Define this process in the appropriate namespace to add them only to a specific images
+    #   In that case it is recommended that you call the base _pre_images_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_images_hooks handler which can be overridden by the user
+  task :_post_images_hooks do
+    # The user may define custom _post_images_hooks tasks to add any post-images actions the images process
+    # Define this process in the appropriate namespace to add them only to a specific images
+    #   In that case it is recommended that you call the base _post_images_hooks as a dependency of that task
+  end
+
+  # Define an empty _pre_ps_hooks handler which can be overridden by the user
+  task :_pre_ps_hooks do
+    # The user may define custom _pre_ps_hooks tasks to add any pre-ps actions the ps process
+    # Define this process in the appropriate namespace to add them only to a specific ps
+    #   In that case it is recommended that you call the base _pre_ps_hooks as a dependency of that task
+  end
+
+  # Define an empty _post_ps_hooks handler which can be overridden by the user
+  task :_post_ps_hooks do
+    # The user may define custom _post_ps_hooks tasks to add any post-ps actions the ps process
+    # Define this process in the appropriate namespace to add them only to a specific ps
+    #   In that case it is recommended that you call the base _post_ps_hooks as a dependency of that task
+  end
+end

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

@@ -15,9 +15,10 @@ module Dev
               return if exclude.include?(:build)
 
               desc "Builds the #{application} container"
-              task build: %w(init_docker) do
+              task build: %w(init_docker _pre_build_hooks) do
                 LOG.debug "In #{application} build"
                 Dev::Docker::Compose.new(services: [application]).build
+                Rake::Task[:_post_build_hooks].execute
               end
             end
           end
@@ -33,9 +34,10 @@ module Dev
               return if exclude.include?(:up)
 
               desc "Starts up the #{application} container and it's dependencies"
-              task up: %w(init_docker) do
+              task up: %w(init_docker _pre_up_hooks) do
                 LOG.debug "In #{application} up"
                 Dev::Docker::Compose.new(services: [application]).up
+                Rake::Task[:_post_up_hooks].execute
               end
             end
           end
@@ -51,9 +53,10 @@ module Dev
               return if exclude.include?(:up_no_deps)
 
               desc "Starts up the #{application} container but no dependencies"
-              task up_no_deps: %w(init_docker) do
+              task up_no_deps: %w(init_docker _pre_up_hooks) do
                 LOG.debug "In #{application} up_no_deps"
                 Dev::Docker::Compose.new(services: [application], options: ['--no-deps']).up
+                Rake::Task[:_post_up_hooks].execute
               end
             end
           end
@@ -69,8 +72,9 @@ module Dev
               return if exclude.include?(:sh)
 
               desc "Open a shell into a running #{application} container"
-              task sh: %W(init_docker #{application}:up) 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
             end
           end
@@ -86,9 +90,10 @@ module Dev
               return if exclude.include?(:logs)
 
               desc "Shows logs for the #{application} container"
-              task logs: %w(init_docker) do
+              task logs: %w(init_docker _pre_logs_hooks) do
                 LOG.debug "In #{application} logs"
                 Dev::Docker::Compose.new(services: [application]).logs
+                Rake::Task[:_post_logs_hooks].execute
               end
             end
           end
@@ -104,7 +109,7 @@ module Dev
               return if exclude.include?(:down)
 
               desc "Stops the #{application} container"
-              task down: %w(init_docker) do
+              task down: %w(init_docker _pre_down_hooks) do
                 LOG.debug "In #{application} down"
 
                 # docker-copmose down shuts down everything (you can't only specify a single service)
@@ -114,6 +119,7 @@ module Dev
                 Dev::Docker.new.prune_networks
                 Dev::Docker.new.prune_volumes if ENV['REMOVE_VOLUMES'].to_s.strip == 'true'
                 Dev::Docker.new.prune_images
+                Rake::Task[:_post_down_hooks].execute
               end
             end
           end
@@ -129,8 +135,8 @@ module Dev
               return if exclude.include?(:reload)
 
               desc "Reloads the #{application} container"
-              task reload: %w(init_docker down up) do
-                # Run the down and then the up commands
+              task reload: %w(init_docker _pre_reload_hooks down up) do
+                Rake::Task[:_post_reload_hooks].execute
               end
             end
           end
@@ -146,9 +152,10 @@ module Dev
               return if exclude.include?(:push)
 
               desc "Push the #{application} container to the configured image repository"
-              task push: %w(init_docker) do
+              task push: %w(init_docker _pre_push_hooks) do
                 LOG.debug "In #{application} push"
                 Dev::Docker::Compose.new(services: [application]).push
+                Rake::Task[:_post_push_hooks].execute
               end
             end
           end
@@ -164,9 +171,10 @@ module Dev
               return if exclude.include?(:pull)
 
               desc "Pull the #{application} container from the configured image repository"
-              task pull: %w(init_docker) do
+              task pull: %w(init_docker _pre_pull_hooks) do
                 LOG.debug "In #{application} pull"
                 Dev::Docker::Compose.new(services: [application]).pull
+                Rake::Task[:_post_pull_hooks].execute
               end
             end
           end

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

@@ -16,9 +16,10 @@ module Dev
             desc 'Builds all images used by services in the compose files' \
                  "\n\toptionally specify NO_CACHE=true to not use build cache" \
                  "\n\toptionally specify PULL=true to force pulling new base images"
-            task build: %w(init_docker) do
+            task build: %w(init_docker _pre_build_hooks) do
               LOG.debug('In base build')
               Dev::Docker::Compose.new.build
+              Rake::Task[:_post_build_hooks].execute
             end
           end
         end
@@ -32,9 +33,10 @@ module Dev
 
             desc 'Starts containers for all services listed in the compose files' \
                  "\n\toptionally specify DETACHED=false to not detach from the started services"
-            task up: %w(init_docker) do
+            task up: %w(init_docker _pre_up_hooks) do
               LOG.debug('In base up')
               Dev::Docker::Compose.new.up
+              Rake::Task[:_post_up_hooks].execute
             end
           end
         end
@@ -49,9 +51,10 @@ module Dev
             desc 'Connects to the output stream of all running containers' \
                  "\n\toptionally specify NO_FOLLOW=true to print all current output and exit" \
                  "\n\toptionally specify TAIL=n to print the last 'n' lines of output"
-            task logs: %w(init_docker) do
+            task logs: %w(init_docker _pre_logs_hooks) do
               LOG.debug('In base logs')
               Dev::Docker::Compose.new.logs
+              Rake::Task[:_post_logs_hooks].execute
             end
           end
         end
@@ -65,9 +68,10 @@ module Dev
 
             desc 'Stops and removes containers and associated resources' \
                  "\n\toptionally specify REMOVE_VOLUMES=true to also remove unused volumes"
-            task down: %w(init_docker) do
+            task down: %w(init_docker _pre_down_hooks) do
               LOG.debug('In base down')
               Dev::Docker::Compose.new.down
+              Rake::Task[:_post_down_hooks].execute
             end
           end
         end
@@ -80,8 +84,8 @@ module Dev
             return if exclude.include?(:reload)
 
             desc 'Runs a "down" followed by an "up"'
-            task reload: %w(down up) do
-              LOG.debug('In reload')
+            task reload: %w(_pre_reload_hooks down up) do
+              Rake::Task[:_post_reload_hooks].execute
             end
           end
         end
@@ -94,10 +98,11 @@ module Dev
             return if exclude.include?(:clean)
 
             desc 'Removes all stopped containers and unused images, volumes, and networks'
-            task clean: %w(init_docker) do
+            task clean: %w(init_docker _pre_clean_hooks) do
               LOG.debug 'In base clean'
               Dev::Docker.new.prune
               LOG.info
+              Rake::Task[:_post_clean_hooks].execute
             end
             task prune: [:clean] do
               # This is an alias to the clean command
@@ -113,9 +118,10 @@ module Dev
             return if exclude.include?(:push)
 
             desc 'Push all local images to their defined image repository'
-            task push: %w(init_docker) do
+            task push: %w(init_docker _pre_push_hooks) do
               LOG.debug 'In base push'
               Dev::Docker::Compose.new.push
+              Rake::Task[:_post_push_hooks].execute
             end
           end
         end
@@ -128,9 +134,10 @@ module Dev
             return if exclude.include?(:pull)
 
             desc 'Pull all images from their defined image repository'
-            task pull: %w(init_docker) do
+            task pull: %w(init_docker _pre_pull_hooks) do
               LOG.debug 'In base pull'
               Dev::Docker::Compose.new.pull
+              Rake::Task[:_post_pull_hooks].execute
             end
           end
         end
@@ -144,8 +151,9 @@ module Dev
 
             desc 'Print a table of all images' \
                  "\n\t(equivalent to docker images)"
-            task images: %w(init_docker) do
+            task images: %w(init_docker _pre_images_hooks) do
               Dev::Docker.new.print_images
+              Rake::Task[:_post_images_hooks].execute
             end
           end
         end
@@ -159,38 +167,9 @@ module Dev
 
             desc 'Print a table of all running containers' \
                  "\n\t(equivalent to docker ps)"
-            task ps: %w(init_docker) do
+            task ps: %w(init_docker _pre_ps_hooks) do
               Dev::Docker.new.print_containers
-            end
-          end
-        end
-
-        # Create the rake task which shows all docker images on the system
-        def create_images_task!
-          exclude = @exclude
-
-          DEV_COMMANDS_TOP_LEVEL.instance_eval do
-            unless exclude.include?(:images)
-              desc 'Print a table of all images' \
-                   "\n\t(equivalent to docker images)"
-              task images: [:init] do
-                Dev::Docker.new.print_images
-              end
-            end
-          end
-        end
-
-        # Create the rake task which shows all docker containers on the system
-        def create_ps_task!
-          exclude = @exclude
-
-          DEV_COMMANDS_TOP_LEVEL.instance_eval do
-            unless exclude.include?(:ps)
-              desc 'Print a table of all running containers' \
-                   "\n\t(equivalent to docker ps)"
-              task ps: [:init] do
-                Dev::Docker.new.print_containers
-              end
+              Rake::Task[:_post_ps_hooks].execute
             end
           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 = '1.3.0'.freeze
+    VERSION = '1.4.0.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: 1.3.0
+  version: 1.4.0.pre.alpha.1
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -262,6 +262,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -425,9 +439,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key: