jade_systems_toolbox 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1564046e94dbda9d89321692a3c7f7e41c56377bc1693495d45fcdb97fbbddc2
-  data.tar.gz: c78fdc0c03d57f69c1f86f105eb31f5b0be4bbc310740d457f548a757d380354
+  metadata.gz: 8bb1d901493c286300b53d74441705dc7402263497e998f5490ca14beac572a5
+  data.tar.gz: bc12fcce57604c61fe617eac640c3ab38e6204da916e73124162df78c519e803
 SHA512:
-  metadata.gz: 056fc421ea13e0d2f66c3a6bfbe0e904a139ec23c6886ef0978087bd71513268e79f58a906d929f87fd9b59fc2845544a1a47073341fabc55931d92d769de837
-  data.tar.gz: af541bff905aba2abd9dd41b0eb9af5aee155fbc8d939d3f962f9d83dc01a19c8ddeddc189c41cba230785c4bc1a30470eb928e2a7268132f86c8c9bebf09e27
+  metadata.gz: 58b7e44b6210955e1b50fc2601cc018a2434c92c105436bf923ab818577448c8f11cc90ed81128bfa6290c86f455b6aeb4e444682d4966ebc04c7cab1f382c37
+  data.tar.gz: 91636de5259a810060040aa51d3cc0fc1bb914358c679e2dc12dad59e639dafcbf3869a0a1f6886228e302154596195503315c92f9ed567cd6394ca708c1d2b1

data/.rubocop.yml

@@ -1,13 +1,33 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
 
-Style/StringLiterals:
+# Omakase Ruby styling for Rails
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml
+
+# Your own specialized rules go here
+
+Layout/HeredocIndentation:
   Enabled: true
-  EnforcedStyle: double_quotes
 
-Style/StringLiteralsInInterpolation:
+Layout/IndentationConsistency:
   Enabled: true
-  EnforcedStyle: double_quotes
+  EnforcedStyle: normal
 
-Layout/LineLength:
-  Max: 120
+Layout/IndentationWidth:
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always # or 'always' or 'never' depending on your preference
+  SafeAutoCorrect: true # Set to true for safe autocorrection, false if you need to review changes

data/.vscode/extensions.json

@@ -0,0 +1,16 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+	// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+	// List of extensions which should be recommended for users of this workspace.
+	"recommendations": [
+		"adpyke.vscode-sql-formatter",
+		"eamodio.gitlens",
+		"esbenp.prettier-vscode",
+		"mechatroner.rainbow-csv",
+		"ms-vsliveshare.vsliveshare",
+		"redhat.vscode-yaml",
+		"shopify.ruby-extensions-pack",
+	],
+	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+	"unwantedRecommendations": []
+}

data/.vscode/settings.json

@@ -0,0 +1,70 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[ruby]": {
+    "editor.defaultFormatter": "Shopify.ruby-lsp",
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "rubyLsp.formatter": "rubocop",
+  "rubyLsp.linters": [
+    "rubocop"
+  ],
+  "rubyLsp.enabledFeatures": {
+    "codeActions": true,
+    "diagnostics": true,
+    "documentHighlights": true,
+    "documentLink": true,
+    "documentSymbols": true,
+    "foldingRanges": true,
+    "formatting": true,
+    "hover": true,
+    "inlayHint": true,
+    "onTypeFormatting": true,
+    "selectionRanges": true,
+    "semanticHighlighting": true,
+    "completion": true
+  },
+  "[scss]": {
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "launch": {
+    "configurations": [],
+    "compounds": []
+  },
+  "[erb]": {
+    "editor.tabSize": 2
+  },
+  "[html]": {
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "[js]": {
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "[json]": {
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "[css]": {
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "files.trimTrailingWhitespace": true,
+  "[sql]": {
+    "editor.defaultFormatter": "adpyke.vscode-sql-formatter"
+  }
+}

data/README.md

@@ -1,34 +1,228 @@
-# JadeSystemsToolbox
+# Jade Systems' Toolbox
 
-TODO: Delete this and the text below, and describe your gem
+This gem installs a program to help do container-based development. It provides functions to:
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jade_systems_toolbox`. To experiment with that code, run `bin/console` for an interactive prompt.
+* Prepare a directory for development in containers, including some files to configure VScode.
+* Bring up the container(s).
+* Open VScode on the code in the container.
+* Open a browser window on the application-under-development's web server.
+* Open a terminal session on the application container.
+* Show mapping of container ports to the ports on your host (laptop, development machine).
 
-## Installation
+[At the moment, this gem has been tested on Ubuntu. In theory, it will do the job for Windows, Macos, and Linux. Feel free to raise issues if it doesn't.]
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+One of many things this gem _doesn't_ do is impose a Ruby code style on you. The recommended extensions installed by the `init` command include formatting and linting using RuboCop, but you'll get the default RuboCop rules, or the rules from whatever other RuboCop gem you might use (e.g. https://github.com/rails/rubocop-rails-omakase, or https://github.com/standardrb/standard).
 
-Install the gem and add to the application's Gemfile by executing:
+## Installation
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Don't install this gem in your application. It's meant to be a tool available everywhere on your device. Install the gem by executing:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install --user-install jade_systems_toolbox
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+(If you know what the implications are of _not_ putting `--user-install`, you can install the gem without it.)
 
 ## Usage
 
-TODO: Write usage instructions here
+### Summary
+
+```terminal
+Commands:
+  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 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.
+
+Options:
+  -v, [--verbose], [--no-verbose], [--skip-verbose]
+                                                     # Default: false
+```
+
+### Tutorial
+
+The broad steps to start a brand new project are:
+
+1. Create a directory for the project, and change directory into the new directory.
+1. Decide which container(s) you want to use.
+1. Initialize the container(s).
+1. Bring up the container(s).
+1. Open a terminal session and create the application (e.g. `rails new` if you're doing a Rails project.)
+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, stop the containers.
+1. If you need to delete the containers, down tools.
+
+To start:
+
+```bash
+mkdir project && cd project
+```
+
+#### Choose Containers
+
+`tool` can install `compose.yml` for Rails development with SQLite, or Postgres, or MySQL, or MariaDB. You can also choose the Ruby version
+[Coming soon: Install a compose file from any URL, and/or choose any image as the base.]
+
+The default intialization command is:
+
+```bash
+tool init
+```
+
+The initialization installs
+
+* A `compose.yml` file for Rails development with a SQLite database, using Ruby 3.4, and the `bookworm` version of Debian.
+* On Linux, a `compose.override.yml` file.
+* A `.devcontainer.json` file, so VScode can edit without the context of the container.
+* `.vscode/settings.json` and `vscode/extensions.json` so developers have a consistent experience in VScode (mostly linting and autoformatting).
+
+You can change some of the defaults. To choose another database:
+
+```bash
+tool init --database postgres
+```
+
+The choices are `mariadb`, `mysql`, `postgres`, and `sqlite`.
+
+To choose a different ruby version and Debian version:
+
+```bash
+tool init --ruby-version 3.2 --distro-version bullseye
+```
+
+You can choose a currently supported Ruby version, and a Debian version that supports that Ruby version, from the containers built by https://github.com/lcreid/docker.
+
+You're free to modify the `compose.yml` (and `compose.override.yml` on Linux). If you run `tool init` again, it will over-write your changes.
+
+#### Start the Containers
+
+```bash
+tool up
+```
+
+This takes a while to run, the first time you run it when the image isn't already downloaded to your computer.
+
+### Open a Terminal Session
+
+```bash
+tool terminal
+```
+
+This connects to the `web` service defined in the `compose.yml` file. If you want to connect to another service:
+
+```bash
+tool terminal --service mysql
+```
+
+#### Start VScode
+
+```bash
+tool edit
+```
+
+#### Run the Server
+
+```bash
+tool server
+```
+
+This runs `bin/dev`. To run something else, e.g. a bare Puma so you can debug it:
+
+```bash
+tool server "bin/rails s -b 0.0.0.0"
+```
+
+If you have other services running servers, or the server is in a sub-directory of your project:
+
+```bash
+tool server --work-dir test/app --service monitor
+```
+
+To terminate the server, type Control-C.
+
+#### Open a Browser Window
+
+To connect to the server running on service `web` on port 3000:
+
+```bash
+tool open
+```
+
+If the server is listening on a different port:
+
+```bash
+tool open --container-port 5990
+```
+
+As usual, if the server is running in a different service:
+
+```bash
+tool open --service monitor
+```
+
+If you want to connect to a path other than `/`:
+
+```bash
+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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To test locally without installing, run the executable like this:
+
+```bash
+ruby -I lib exe/tool [COMMAND]
+```
+
+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.4.gem`. (Change the version number to match the current version number.)
+
+## Release
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jade_systems_toolbox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jade_systems_toolbox/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/lcreid/jade_systems_toolbox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/lcreid/jade_systems_toolbox/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +230,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the JadeSystemsToolbox project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jade_systems_toolbox/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the JadeSystemsToolbox project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lcreid/jade_systems_toolbox/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -5,7 +5,6 @@ require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
-  t.libs << "lib"
   t.test_files = FileList["test/**/test_*.rb"]
 end
 

data/exe/tool

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # To debug without installing, run as `ruby -I lib exe/tool...`
 require "jade_systems_toolbox"

data/lib/jade_systems_toolbox/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JadeSystemsToolbox
   class Cli < Thor
     # This and other improvements from Matt: https://mattbrictson.com/blog/fixing-thor-cli-behavior
@@ -12,36 +14,45 @@ 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
-      `docker compose 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
 
-    desc "edit", "devcontainer edit"
+    desc "edit", "devcontainer open"
     def edit
       `devcontainer open`
     end
 
+    desc "init", "Initialize compose files and devcontainer.json"
     option :compose_file, default: "compose.yml"
     option :database, default: "sqlite", aliases: "-d"
     option :ruby_version, default: "3.4", aliases: "-r"
     option :distro_version, default: "bookworm", aliases: "-t" # For Toy Story.
-    desc "init", "Initialize compose files and devcontainer.json"
     def init
       invoke :initialize_docker
       invoke :initialize_vscode, [], {}
     end
 
+    desc "initialize_docker", "Initialize compose files"
     option :compose_file, default: "compose.yml"
     option :database, default: "sqlite", aliases: "-d"
     option :ruby_version, default: "3.4", aliases: "-r"
     option :distro_version, default: "bookworm", aliases: "-t" # For Toy Story.
-    desc "initialize_docker", "Initialize compose files"
     def initialize_docker
-      get_and_save_file("https://github.com/lcreid/docker/raw/refs/heads/main/rails-app-sqlite/compose.yml") do |file_contents|
+      get_and_save_file(
+        "https://github.com/lcreid/docker/raw/refs/heads/main/rails-app-sqlite/compose.yml",
+      ) do |file_contents|
         file_contents.gsub!(
           /jade:rails-app-[0-9]+\.[0-9]+-\w+-\w+$/,
-          "jade:rails-app-#{options[:ruby_version] || '3.4'}-#{options[:database] || "sqlite"}-#{options[:distro_version] || bookworm}")
+          "jade:rails-app-#{options[:ruby_version] || "3.4"}" \
+            "-#{options[:database] || "sqlite"}" \
+            "-#{options[:distro_version] || "bookworm"}",
+        )
       end
 
       case Gem::Platform.local.os
@@ -52,18 +63,24 @@ module JadeSystemsToolbox
       end
     end
 
-    desc "initilaize_vscode", "Initialize devcontainer.json for vscode"
+    desc "initilize_vscode", "Initialize devcontainer.json for vscode"
     def initialize_vscode
       get_and_save_file("https://github.com/lcreid/docker/raw/refs/heads/main/.devcontainer.json") do |file_contents|
         file_contents.gsub!(/, "compose.override.yml"/, "") unless Gem::Platform.local.os == "linux"
       end
+
+      Dir.mkdir(".vscode") unless Dir.exist?(".vscode")
+      [
+        "https://github.com/lcreid/jade_systems_toolbox/raw/refs/heads/main/templates/extensions.json",
+        "https://github.com/lcreid/jade_systems_toolbox/raw/refs/heads/main/templates/settings.json",
+      ].each { get_and_save_file(_1, target_directory: File.join(".", ".vscode")) }
     end
 
+    desc "open", "Open a page on the services's first port"
     option :service, default: "web"
     option :path, default: "/"
     option :container_port, default: 3000, type: :numeric
     option :protocol, default: "http"
-    desc "open", "Open a page on the SERVICE's PORT"
     def open
       service = options[:service]
       path = options[:path]
@@ -72,6 +89,7 @@ module JadeSystemsToolbox
 
       container_ports = compose_yaml.dig("services", "service", "ports")
       container_port = container_ports&.[](0) || container_port
+      path = "/#{path}" if path[0] != "/"
       `open "#{protocol}://localhost:#{host_port_from_container_port(service:, container_port:)}#{path}"`
     end
 
@@ -83,9 +101,10 @@ module JadeSystemsToolbox
     end
 
     desc "ports", "Get the host ports for the container ports defined in `compose.yml`"
+    option :compose_file, default: "compose.yml"
     def ports
       services = compose_yaml["services"]
-      service_ports = services.map { |service, attributes| [service, attributes&.[]("ports")] }.to_h
+      service_ports = services.transform_values { |attributes| attributes&.[]("ports") }
 
       service_ports.each do |service, ports|
         ports&.each do |container_port|
@@ -100,34 +119,44 @@ module JadeSystemsToolbox
     def server(command = "bin/dev")
       service = options[:service]
       workdir = "-w #{options[:work_dir]} " unless options[:work_dir].nil?
-      puts("docker compose exec #{workdir}#{service} #{command}")
-      run_via_pty("docker compose exec #{workdir}#{service} #{command}")
+      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
       service = options[:service]
-      run_via_pty("docker compose exec -it #{service} '/bin/bash'")
+      system("docker compose exec -it #{service} '/bin/bash'")
     end
 
     desc "up", "docker compose up -d"
     def up
-      `docker compose up -d`
+      system("docker compose up -d")
+    end
+
+    desc "version", "Show the version number of the tool."
+    def version
+      puts JadeSystemsToolbox::VERSION
     end
 
     private
 
-    def compose_yaml = @compose_yaml ||= YAML.load_file(options[:compose_file])
+    def compose_yaml = @compose_yaml ||= YAML.load_file(options[:compose_file] || "compose.yml")
 
-    def get_and_save_file(url)
-      file_name = Pathname.new(url).basename.to_s
-      file_contents = get_file_from_internet(url: )
+    def get_and_save_file(url, target_directory: nil)
+      file_contents = get_file_from_internet(url:)
       yield file_contents if block_given?
+      file_name = Pathname.new(url).basename.to_s
+      file_name = Pathname.new(target_directory) + file_name unless target_directory.nil?
       File.write(file_name, file_contents)
     end
 
-    def get_file_from_internet(redirects: 10, url:)
+    def get_file_from_internet(url:, redirects: 10)
       raise Errorl.new("Too many redirects", options[:verbose]) if redirects.zero?
 
       uri = URI.parse(url)
@@ -139,13 +168,13 @@ module JadeSystemsToolbox
       when Net::HTTPSuccess
         response.body
       when Net::HTTPRedirection
-        get_file_from_internet(redirects: redirects - 1, url: response['location'])
+        get_file_from_internet(redirects: redirects - 1, url: response["location"])
       else
         response.error!
       end
     end
 
-    def host_port_from_container_port(service: "web", container_port:)
+    def host_port_from_container_port(container_port:, service: "web")
       ports = container_port.to_s.match(/([0-9]+:){0,1}([0-9]+$)/)
       if !ports[1].nil?
         ports[2].to_s
@@ -154,40 +183,5 @@ module JadeSystemsToolbox
         output.match(/[0-9]+$/)
       end
     end
-
-    # A variation with popen was here:
-    # https://nickcharlton.net/posts/ruby-subprocesses-with-stdout-stderr-streams.html
-    # This implementation inspired by the docs:
-    # https://docs.ruby-lang.org/en/3.4/PTY.html#method-c-spawn
-    def run_via_pty(command)
-      child_stdout_stderr, child_stdin, pid = PTY.spawn(command)
-      puts "PID: #{pid}" if options[:verbose]
-      io_threads = [
-        me = Thread.new do
-          $stdout.raw do |stdout|
-            until (c = child_stdout_stderr.getc).nil? do
-              stdout.putc c
-            end
-          end
-        rescue Errno::EIO => exception
-          puts exception.message if options[:verbose]
-          me.terminate
-        end,
-        me = Thread.new do
-          until (c = $stdin.getc).nil? do
-            child_stdin.putc c
-          end
-        rescue Errno::EIO => exception
-          puts exception.message if options[:verbose]
-          me.terminate
-        end,
-      ]
-      io_threads.each { _1.join }
-    ensure
-      io_threads.each { _1.terminate if _1.alive? }
-      child_stdout_stderr.close
-      child_stdin.close
-      Process.wait(pid)
-    end
   end
 end

data/lib/jade_systems_toolbox/error_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JadeSystemsToolbox
   class ErrorReporter < Thor
     class << self

data/lib/jade_systems_toolbox/version.rb

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

data/lib/jade_systems_toolbox.rb

@@ -2,9 +2,7 @@
 
 require "debug"
 require "net/http"
-require "open3"
 require "pathname"
-require "pty"
 require "thor"
 require "yaml"
 

data/templates/extensions.json

@@ -0,0 +1,16 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+	// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+	// List of extensions which should be recommended for users of this workspace.
+	"recommendations": [
+		"adpyke.vscode-sql-formatter",
+		"eamodio.gitlens",
+		"esbenp.prettier-vscode",
+		"mechatroner.rainbow-csv",
+		"ms-vsliveshare.vsliveshare",
+		"redhat.vscode-yaml",
+		"shopify.ruby-extensions-pack",
+	],
+	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+	"unwantedRecommendations": []
+}

data/templates/settings.json

@@ -0,0 +1,70 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[ruby]": {
+    "editor.defaultFormatter": "Shopify.ruby-lsp",
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "rubyLsp.formatter": "rubocop",
+  "rubyLsp.linters": [
+    "rubocop"
+  ],
+  "rubyLsp.enabledFeatures": {
+    "codeActions": true,
+    "diagnostics": true,
+    "documentHighlights": true,
+    "documentLink": true,
+    "documentSymbols": true,
+    "foldingRanges": true,
+    "formatting": true,
+    "hover": true,
+    "inlayHint": true,
+    "onTypeFormatting": true,
+    "selectionRanges": true,
+    "semanticHighlighting": true,
+    "completion": true
+  },
+  "[scss]": {
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "launch": {
+    "configurations": [],
+    "compounds": []
+  },
+  "[erb]": {
+    "editor.tabSize": 2
+  },
+  "[html]": {
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "[js]": {
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "[json]": {
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "[css]": {
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.tabSize": 2
+  },
+  "files.trimTrailingWhitespace": true,
+  "[sql]": {
+    "editor.defaultFormatter": "adpyke.vscode-sql-formatter"
+  }
+}

metadata

@@ -1,43 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jade_systems_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Larry Reid
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: open3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: pathname
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -52,21 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: yaml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-description:
 email:
 - lcreid@jadesystems.ca
 executables:
@@ -75,18 +31,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".vscode/extensions.json"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - exe/tool
-- jade_systems_toolbox.gemspec
 - lib/jade_systems_toolbox.rb
 - lib/jade_systems_toolbox/cli.rb
 - lib/jade_systems_toolbox/error_reporter.rb
 - lib/jade_systems_toolbox/version.rb
 - sig/jade_systems_toolbox.rbs
+- templates/extensions.json
+- templates/settings.json
 homepage: https://github.com/lcreid/jade_systems_toolbox
 licenses:
 - MIT
@@ -94,7 +53,6 @@ metadata:
   homepage_uri: https://github.com/lcreid/jade_systems_toolbox
   source_code_uri: https://github.com/lcreid/jade_systems_toolbox
   changelog_uri: https://github.com/lcreid/jade_systems_toolbox/CHANGELOG.nd
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A collection of command line commands to support development.
 test_files: []

data/jade_systems_toolbox.gemspec

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/jade_systems_toolbox/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "jade_systems_toolbox"
-  spec.version = JadeSystemsToolbox::VERSION
-  spec.authors = ["Larry Reid"]
-  spec.email = ["lcreid@jadesystems.ca"]
-
-  spec.summary = "A collection of command line commands to support development."
-  spec.homepage = "https://github.com/lcreid/jade_systems_toolbox"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = File.join(spec.homepage, "CHANGELOG.nd")
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "open3", "~> 0.1"
-  spec.add_dependency "pathname", "~> 0.2"
-  spec.add_dependency "thor", "~> 1.3"
-  spec.add_dependency "yaml", "~> 0.2"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end