jade_systems_toolbox 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77d28ae152583dfee09836b6c268f052e18a3e065db172036839fe63ae1da1f0
-  data.tar.gz: '08307e9fb8f296a5e71e2d990e7a2edd387e1f9a0cea8d53d1d015da2feefd92'
+  metadata.gz: 8bb1d901493c286300b53d74441705dc7402263497e998f5490ca14beac572a5
+  data.tar.gz: bc12fcce57604c61fe617eac640c3ab38e6204da916e73124162df78c519e803
 SHA512:
-  metadata.gz: 4ab241764b4b1514a4d770a605b2db8053b03986be8e5164a1813832e1241bf97698582046122565642b6d0b9cdb6023c2ca0912923d95224ffff54680733beb
-  data.tar.gz: cf374537e612eb3011dd2f7dae3d57b318a7d3be9439609f61dff5bc7d87e937d8cbedf2b91a454118dbfd8428f0d6c66ec84f68633bfc3688e5f96f61ef0d45
+  metadata.gz: 58b7e44b6210955e1b50fc2601cc018a2434c92c105436bf923ab818577448c8f11cc90ed81128bfa6290c86f455b6aeb4e444682d4966ebc04c7cab1f382c37
+  data.tar.gz: 91636de5259a810060040aa51d3cc0fc1bb914358c679e2dc12dad59e639dafcbf3869a0a1f6886228e302154596195503315c92f9ed567cd6394ca708c1d2b1

data/README.md

@@ -27,18 +27,19 @@ gem install --user-install jade_systems_toolbox
 
 ### Summary
 
-```
+```terminal
 Commands:
-  tool down                   # docker compose down
+  tool down                   # docker compose down. Deletes the container. You probably want stop.
   tool edit                   # devcontainer open
   tool help [COMMAND]         # Describe available commands or one specific command
   tool init                   # Initialize compose files and devcontainer.json
   tool initialize_docker      # Initialize compose files
-  tool initialize_vscode      # Initialize devcontainer.json for vscode
+  tool initilize_vscode       # Initialize devcontainer.json for vscode
   tool open                   # Open a page on the services's first port
   tool port [CONTAINER_PORT]  # Get the host port for the CONTAINER_PORT's container port CONTAINER_PORT
   tool ports                  # Get the host ports for the container ports defined in `compose.yml`
   tool server [COMMAND]       # Run the server in the container
+  tool stop                   # Stop the service(s) but preserve the container(s)
   tool terminal               # Run a shell in the container
   tool up                     # docker compose up -d
   tool version                # Show the version number of the tool.
@@ -60,7 +61,8 @@ The broad steps to start a brand new project are:
 1. Run the editor and otherwise do what you need to do to create your project.
 1. When the web server is ready to run (if you're developing a web app), run the server.
 1. Open a browser window to the web server.
-1. When you're done, bring down the containers.
+1. When you're done, stop the containers.
+1. If you need to delete the containers, down tools.
 
 To start:
 
@@ -176,12 +178,26 @@ If you want to connect to a path other than `/`:
 tool open --path letter_opener
 ```
 
+#### Stop the Containers
+
+```bash
+tool stop
+```
+
 #### Bring Down the Containers
 
+This destroys the containers, which will likely destroy all your gems.
+
 ```bash
 tool down
 ```
 
+Skip the confirmation mesage with:
+
+```bash
+tool down --force
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -192,13 +208,13 @@ To test locally without installing, run the executable like this:
 ruby -I lib exe/tool [COMMAND]
 ```
 
-To run in another directory, use the path name from the directory you're in, to the directory where you checked out the gem's code, for example:
+To run in another directory, use the path from the directory you're in, to the directory where you checked out the gem's code. For example:
 
 ```bash
 ruby -I ../jade_systems_toolbox/lib ../jade_systems_toolbox/exe/tool [COMMAND]
 ```
 
-To install this gem onto your local machine, build it: `gem build jade_systems_toolbox.gemspec`, and install it: `gem install -l jade_systems_toolbox-0.1.2.gem`. (Change the version number to match the current version number.)
+To install this gem onto your local machine, build it: `gem build jade_systems_toolbox.gemspec`, and install it: `gem install -l jade_systems_toolbox-0.1.4.gem`. (Change the version number to match the current version number.)
 
 ## Release
 

data/lib/jade_systems_toolbox/cli.rb

@@ -14,8 +14,12 @@ module JadeSystemsToolbox
 
     class_option :verbose, type: :boolean, default: false, aliases: "-v"
 
-    desc "down", "docker compose down"
+    desc "down", "docker compose down. Deletes the container. You probably want stop."
+    option :force, default: "n", aliases: "-f"
     def down
+      force = ask("tool down destroys the containers. Are you sure?").downcase unless options[:force] == "y"
+      exit(1) if force[0] != "y"
+
       system("docker compose down")
     end
 
@@ -47,7 +51,7 @@ module JadeSystemsToolbox
           /jade:rails-app-[0-9]+\.[0-9]+-\w+-\w+$/,
           "jade:rails-app-#{options[:ruby_version] || "3.4"}" \
             "-#{options[:database] || "sqlite"}" \
-            "-#{options[:distro_version] || bookworm}",
+            "-#{options[:distro_version] || "bookworm"}",
         )
       end
 
@@ -118,6 +122,11 @@ module JadeSystemsToolbox
       system("docker compose exec #{workdir}#{service} #{command}")
     end
 
+    desc "stop", "Stop the service(s) but preserve the container(s)"
+    def stop
+      system("docker compose stop")
+    end
+
     desc "terminal", "Run a shell in the container"
     option :service, default: "web"
     def terminal

data/lib/jade_systems_toolbox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JadeSystemsToolbox
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jade_systems_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Larry Reid
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A collection of command line commands to support development.
 test_files: []