laser-cutter 1.0.5 → 2.0.1

data/README.md

@@ -1,138 +1,266 @@
-[![Gem Version](https://badge.fury.io/rb/laser-cutter.svg)](http://badge.fury.io/rb/laser-cutter)
-[![Build status](https://secure.travis-ci.org/kigster/laser-cutter.png)](http://travis-ci.org/kigster/laser-cutter)
-[![Maintainability](https://api.codeclimate.com/v1/badges/bea3225fd93ee84d078a/maintainability)](https://codeclimate.com/github/kigster/laser-cutter/maintainability)[![Test Coverage](https://api.codeclimate.com/v1/badges/bea3225fd93ee84d078a/test_coverage)](https://codeclimate.com/github/kigster/laser-cutter/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/laser-cutter.svg)](http://badge.fury.io/rb/laser-cutter) ![coverage](docs/badges/coverage_badge.svg)
 
-[![Join the chat at https://gitter.im/kigster/laser-cutter](https://badges.gitter.im/kigster/laser-cutter.svg)](https://gitter.im/kigster/laser-cutter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![GitHub issues](https://img.shields.io/github/issues/kigster/laser-cutter.svg)](https://github.com/kigster/laser-cutter/issues)
-[![GitHub forks](https://img.shields.io/github/forks/kigster/laser-cutter.svg)](https://github.com/kigster/laser-cutter/network)
-[![GitHub stars](https://img.shields.io/github/stars/kigster/laser-cutter.svg)](https://github.com/kigster/laser-cutter/stargazers)
-[![GitHub license](https://img.shields.io/github/license/kigster/laser-cutter.svg)](https://github.com/kigster/laser-cutter/blob/master/LICENSE)
+## LaserCutter and Make-A-Box.io
 
-[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FSFYYNEQ8RKWU)
-
-# LaserCutter
-
-**LaserCutter** is a ruby library for generating PDF designs for boxes of custom dimensions that suit your project, that are meant to be used as a cut template on a laser-cutter. The sides of the box snap together using alternating notches, that are deliberately laid out in a symmetric form.
+`laser-cutter` is a ruby library for generating PDF designs for boxes of custom dimensions that suit your project, that can be cut from wood or acrylic using a laser-cutter. The sides of the box snap together using alternating notches, that are deliberately layed out in a symmetric form.
 
 To use `laser-cutter` you need to have a recent version of ruby interpreter, install it as a gem, and use command line to generate PDFs.
 
-[MakeABox.IO](http://makeabox.io) is an online web application that uses `laser-cutter` library and provides a straight-forward user interface for generating PDF designs without the need to install the gem or use command line.  
+[Make-A-Box](http://makeabox.io) is a online web application that uses `laser-cutter` library and provides a straight-forward user interface for generating PDF designs without the need to install the gem or use command line.
 
 Use whatever suites you better.
 
-> NOTE: Please read our [feature comparison guide](BOXMAKER.md) of LaserCutter against an older tool called [BoxMaker](https://github.com/rahulbot/boxmaker).
+### Design Goals
+
+One of the design goals of this project is to provide a highly extensible platform for creating laser-cut designs, where alternative strategies can be added over time, and supported by various command line options, and perhaps a light weight web application. If you are interested in contributing to the project, please see [contributing](CONTRIBUTING.md) for more details.
+
+`laser-cutter` supports many flexible command line options that allow setting dimensions, stroke width, page size, layout, margins, padding (spacing between the boxes), and many more.
 
 ## Dependencies
 
-The gem depends primarily on [Prawn](http://prawnpdf.org) – a fantastic PDF generation library. 
+The gem depends primarily on [Prawn](http://prawnpdf.org) – a fantastic PDF generation library. SVG output uses [Victor](https://github.com/DannyBen/victor), and the command line is built on [dry-cli](https://dry-cli.tools/). It needs Ruby 4.0 or newer.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'laser-cutter'
+```
+gem 'laser-cutter'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
-Or install it manually:
+Or install it yourself as:
 
-    $ gem install laser-cutter
+```
+$ gem install laser-cutter
+```
 
 ## Usage
 
-We'll start with some examples:
+```text
+laser-cutter COMMAND [OPTIONS]
+
+  generate, g    Draw the panels of a box into a PDF or an SVG file
+  page-sizes     List every page size, with its dimensions
+  examples       Show detailed usage examples
+  help           Show help, for the program or for one command
+  version        Print the version
+  completion     Print a bash or zsh completion script
+```
+
+`laser-cutter help generate` lists every option. The common ones:
+
+| Option                 | Meaning                                                        |
+| :--------------------- | :------------------------------------------------------------- |
+| `-b`, `--box`          | `WxHxD/T[/N]`: width, height, depth, thickness, optional notch |
+| `-w`, `-H`, `-d`, `-t` | Width, height, depth and thickness, one at a time              |
+| `-n`, `--notch`        | Notch length, a guide only                                     |
+| `-k`, `--kerf`         | Kerf, the width of the cut                                     |
+| `-L`, `--lid`          | `full` (default), `back` or `plain`, see below                 |
+| `-u`, `--units`        | `in` (default) or `mm`                                         |
+| `-o`, `--file`         | File to write, required                                        |
+| `-f`, `--format`       | `pdf` (default) or `svg`, in either case                       |
+| `-B`, `--inside-box`   | Also draw the box without kerf, in red                         |
+| `-W`, `-R`             | Save the configuration to a file, or read it from one          |
+
+Height is `-H`, because `-h` prints help.
 
 ### Examples
 
-Create a box defined in inches, with kerf (cut width) set to `0.005in`, and open PDF in preview right after:
+A box in inches, with the kerf set to 0.008", opened once it is written:
 
 ```bash
-    laser-cutter -z 3x2x2/0.125 -k 0.005 -O -o box.pdf
-```       
+laser-cutter generate -b 3x2x2/0.125 -k 0.008 -O -o box.pdf
+```
 
-Create a box defined in millimeters, print verbose info, and set page size to A3, and layout to landscape, and stroke width to `1/2mm`:
+A box with a lid that lifts off:
 
 ```bash
-    laser-cutter -u mm -w70 -h20 -d50 -t4.3 -n5 -iA3 -l landscape -s0.5 -v -O -o box.pdf
-```   
+laser-cutter generate -b 3x2x2/0.125 --lid plain -o box.pdf
+```
+
+### The lid
+
+The lid is the top panel. `--lid` sets how it joins the walls:
+
+| `--lid` | The lid                              | The walls under it                                |
+| :------ | :----------------------------------- | :------------------------------------------------ |
+| `full`  | Notched on all four sides            | Notched; the box is glued shut                    |
+| `back`  | Notched where it meets the back wall | The back is notched, the other three are straight |
+| `plain` | A rectangle, no notches              | All four are straight                             |
 
-List all possible page sizes in metric system:
+| `--lid full`                                            | `--lid back`                                                           | `--lid plain`                                             |
+| :------------------------------------------------------ | :--------------------------------------------------------------------- | :-------------------------------------------------------- |
+| ![A box with a full lid](docs/images/box-lid-full.avif) | ![A box with a lid notched at the back](docs/images/box-lid-back.avif) | ![A box with a plain lid](docs/images/box-lid-plain.avif) |
+
+Each is `laser-cutter generate -b 3x2x2/0.125 --lid …`. The lid is the panel at the bottom of the page, the back wall the one at the top.
+
+A lid edge without notches reaches the outside of the wall under it, and that wall ends at the internal height. So a `plain` lid is `W + 2T` by `D + 2T` and lies on top of the box, and the space inside is still `W` by `H` by `D`.
+
+The same box as an SVG:
 
 ```bash
-    laser-cutter -L -u mm
-```                 
+laser-cutter generate -b 3x2x2/0.125 -f svg -o box.svg
+```
 
-Create a box with provided dimensions, and save the config to a file for later use:
+A box in millimeters on a landscape A3 page, with a 0.5mm stroke:
 
 ```bash
-    laser-cutter -z 1.1x2.5x1.5/0.125/0.125 -p 0.1 -O -o box.pdf -W box-settings.json
-```    
+laser-cutter generate -u mm -w 70 -H 20 -d 50 -t 4.3 -n 5 -i A3 -l landscape -s 0.5 -o box.pdf
+```
 
-Read settings from a previously saved file:
+Every page size, in millimeters:
 
 ```bash
-    laser-cutter -O -o box.pdf -R box-settings.json
-    cat box-settings.json | laser-cutter -O -o box.pdf -R -
+laser-cutter page-sizes -u mm
 ```
 
-### Complete Help
+Save the settings of a box, and use them again:
 
 ```bash
+laser-cutter generate -b 1.1x2.5x1.5/0.125/0.125 -p 0.1 -o box.pdf -W box-settings.json
+laser-cutter generate -o box.pdf -R box-settings.json
+cat box-settings.json | laser-cutter generate -o box.pdf -R -
+```
 
-Usage: laser-cutter [options] -o filename.pdf
-   eg: laser-cutter -z 1x1.5x2/0.125 -O -o box.pdf
+### More boxes
 
-Specific Options:
-    -w, --width WIDTH                Internal width of the box
-    -h, --height HEIGHT              Internal height of the box
-    -d, --depth DEPTH                Internal depth of the box
-    -t, --thickness THICKNESS        Thickness of the box material
-    -n, --notch NOTCH                Optional notch length (aka "tab width"), guide only
-    -k, --kerf KERF                  Kerf - cut width (default is 0.0024in)
+A shallow box in millimeters, glued shut:
+
+```bash
+laser-cutter generate -u mm -w 70 -H 20 -d 50 -t 4.3 -n 5 -f svg -o box.svg
+```
 
-    -m, --margin MARGIN              Margins from the edge of the document
-    -p, --padding PADDING            Space between the boxes on the page
-    -s, --stroke WIDTH               Numeric stroke width of the line
-    -i, --page_size LETTER           Document page size, default is autofit the box.
-    -l, --page_layout portrait       Page layout, other option is 'landscape'
+![A 70 by 20 by 50 millimeter box](docs/images/box-metric.avif)
 
-    -O, --open                       Open generated file with system viewer before exiting
-    -W, --write CONFIG_FILE          Save provided configuration to a file, use '-' for STDOUT
-    -R, --read CONFIG_FILE           Read configuration from a file, or use '-' for STDIN
+A tray with a lid that lifts off, from 3mm material with wide notches:
 
-    -L, --list-all-page-sizes        Print all available page sizes with dimensions and exit
-    -M, --no-metadata                Do not print box metadata on the PDF
-    -v, --[no-]verbose               Run verbosely
-    -B, --inside-box                 Draw the inside boxes (helpful to verify kerfing)
-    -D, --debug                      Show full exception stack trace on error
+```bash
+laser-cutter generate -u mm -w 120 -H 25 -d 80 -t 3 -n 12 --lid plain -f svg -o tray.svg
+```
 
-        --examples                   Show detailed usage examples
-        --help                       Show this message
-        --version                    Show version
+![A 120 by 25 by 80 millimeter tray with a plain lid](docs/images/box-tray.avif)
 
-Common Options:
-    -o, --file FILE                  Required output filename of the PDF
-    -z, --size WxHxD/T[/N]           Combined internal dimensions: W = width, H = height,
-                                     D = depth, T = thickness, and optional N = notch length
+The pictures on this page are the SVG files themselves, drawn with a thicker stroke (`-s 0.5`) and converted:
 
-    -u, --units UNITS                Either 'in' for inches (default) or 'mm'
+```bash
+magick -density 96 -background white box.svg -flatten box.avif
 ```
 
-## Wish List
+## Using it from Ruby
 
-* Create T-style joins, using various standard sizes of nuts and bolts (such as common #4-40 and M2 sizes)
-* Extensibility with various layout strategies, notch drawing strategies, basically plug and play
-  model for adding new algorithms for path creation and box joining
-* Support more shapes than just box, such as prisms
-* Supporting lids and front panels, that are larger than the box itself and have holes for notches. 
-* Your brilliant idea can be here too!  Please see [contributing](CONTRIBUTING.md) for more info.
+A Ruby program draws a box in its own process; nothing runs the command line. It needs three things:
+
+| Call                            | What it does                                      |
+| :------------------------------ | :------------------------------------------------ |
+| `Laser::Cutter::Options.new`    | Every setting of a box, typed and checked         |
+| `Laser::Cutter.render(options)` | Returns the PDF or the SVG as a String            |
+| `Laser::Cutter.write(options)`  | Writes it to `options.file`, and returns the path |
+
+```ruby
+require "laser-cutter"
+
+options = Laser::Cutter::Options.new(
+  width: 70, height: 20, depth: 50, thickness: 4.3,
+  units: :mm, lid: :plain, format: :svg
+)
+
+svg = Laser::Cutter.render(options)                      # a String, no file written
+Laser::Cutter.write(options.new(file: "box.pdf", format: nil)) # the extension picks the format
+```
+
+`Options` has an attribute for each option of `generate`:
+
+| Attribute                               | Type                    | When left out                  |
+| :-------------------------------------- | :---------------------- | :----------------------------- |
+| `width`, `height`, `depth`, `thickness` | Float above zero        | `MissingOption` is raised      |
+| `notch`                                 | Float above zero        | Three times the thickness      |
+| `kerf`, `margin`, `padding`             | Float, zero or more     | The default for the units      |
+| `stroke`                                | Float above zero        | The default for the units      |
+| `units`                                 | `in` or `mm`            | `in`                           |
+| `lid`                                   | `full`, `back`, `plain` | `full`                         |
+| `format`                                | `pdf` or `svg`          | `pdf`, or the file's extension |
+| `file`                                  | String                  | Only `write` needs it          |
+| `page_size`                             | A name such as `A4`     | The page fits the box          |
+| `page_layout`                           | `portrait`, `landscape` | `portrait`                     |
+| `metadata`                              | Boolean                 | `true`                         |
+| `inside_box`                            | Boolean                 | `false`                        |
+
+- Values are coerced, so the Strings a web form sends will do, and a blank String counts as left out. Keys may be Strings or Symbols.
+- A value it cannot use, or a key that is not an option, raises `Laser::Cutter::InvalidOption` with a message such as `lid cannot be "sliding", but must be one of: full, back, plain.` Both errors descend from `Laser::Cutter::Error`.
+- An `Options` cannot be changed; `options.new(lid: :back)` returns a changed copy.
+
+In a Rails controller:
+
+```ruby
+def create
+  box = params.require(:box).permit(*Laser::Cutter::Options.attribute_names)
+  send_data Laser::Cutter.render(box.to_h), type: "application/pdf", filename: "box.pdf"
+rescue Laser::Cutter::Error => e
+  redirect_to new_box_path, alert: e.message
+end
+```
+
+`Laser::Cutter::Box::LIDS` lists the lids, for a select. `Configuration`, `Renderer::LayoutRenderer#render` and `PageManager#page_size_values`, which MakeABox.io called in 1.0.3, still work.
+
+## Feature Wish List
+
+- Create T-style joins, using various standard sizes of nuts and bolts (such as common #4-40 and M2 sizes)
+- Extensibility with various layout strategies, notch drawing strategies, basically plug and play model for adding new algorithms for path creation and box joining
+- Support more shapes than just box, such as prisms
+- Supporting lids and front panels, that are larger than the box itself and have holes for notches.
+- Your brilliant idea can be here too! Please see [contributing](CONTRIBUTING.md) for more info.
+
+## LaserCutter vs BoxMaker
+
+[Rahulbot](https://github.com/rahulbot/)-made [BoxMaker](https://github.com/rahulbot/boxmaker/) is a functional generator of notched designs, similar to `laser-cutter`, and generously open sourced by the author, and so in no way this project disputes BoxMaker's viability. In fact BoxMaker was an inspiration for this project.
+
+Laser-Cutter library attempts to further advance the concept of programmatically creating laser-cut box designs, provides additional fine tuning, many more options, strategies and most importantly – extensibility.
+
+Unlike `BoxMaker`, this gem has a suit of automated tests (rspecs) around the core functionality. In addition, new feature contributions are highly encouraged, and in that regard having existing test suit offers confidence against regressions, and thus welcomes colaboration.
+
+Finally, BoxMaker's notch-drawing algorithm generates non-symmetric and sometimes purely broken designs (see picture below).
+
+`laser-cutter`'s algorithm will create a _symmetric design for most panels_, but it might sacrifice identical notch length. Depending on the box dimensions you may end up with a slightly different notch length on each side of the box.
+
+The choice ultimately comes down to the preference and feature set, so here I show you two boxes made with each program, so you can pick what you prefer.
+
+### Example Outputs
+
+Below are two examples of boxes with identical dimensions produced with `laser-cutter` and `boxmaker`:
+
+This is how you would make a box with Adam Phelp's fork of BoxMaker (which adds flags and a lot of niceties):
+
+```bash
+git clone https://github.com/aphelps/boxmaker && cd boxmaker && ant
+java -cp BOX.jar com.rahulbotics.boxmaker.BoxMaker \
+      -W 1 -H 2 -D 1.5 -T 0.125 -n 0.125 -o box.pdf
+```
+
+And laser-cutter:
+
+```bash
+gem install laser-cutter
+laser-cutter generate -b 1x1.5x2/0.125/0.125 -O -o box.pdf
+```
+
+![LaserCutter Comparison](docs/images/comparison.jpg).
 
 ## Contributing
 
-1. Fork it ( https://github.com/kigster/laser-cutter/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+1. Fork it ( https://github.com/[my-github-username]/laser-cutter/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Create a new Pull Request
+1. Push to the branch (`git push origin my-new-feature`)
+
+## License
+
+MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
+
+Author: © 2015-2024 Konstantin Gredeskoul [@kigster](https://github.com/kigster)

data/Rakefile

@@ -1,29 +1,43 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'yard'
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "timeout"
+require "yard"
 
 def shell(*args)
   puts "running: #{args.join(' ')}"
-  system(args.join(' '))
+  system(args.join(" "))
 end
 
 task :clean do
-  shell('rm -rf pkg/ tmp/ coverage/' )
+  shell("rm -rf pkg/ tmp/ coverage/ doc/ ")
+end
+
+task gem: [:build] do
+  shell("gem install pkg/*")
 end
 
-task :permissions => [ :clean ] do
-  shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
-  shell("find . -type d -exec chmod o+x,g+x {} \\;")
+task permissions: [:clean] do
+  # One traversal replaces a six-level glob chain that printed "No such file
+  # or directory" for every level this project does not have, skipped dotfiles
+  # entirely, and silently stopped at depth six. .git is pruned: its objects
+  # have no business being group-readable.
+  shell("find . -path ./.git -prune -o -type d -exec chmod o+rx,g+rx {} + -o -type f -exec chmod o+r,g+r {} +")
 end
 
-task :build => :permissions
+task build: :permissions
 
 YARD::Rake::YardocTask.new(:doc) do |t|
-  t.files = %w(lib/**/*.rb bin/* - README.md LICENSE.txt BOXMAKER.md)
-  t.options.unshift('--title','LaserCutter Library')
-  t.after = ->() { exec('open doc/index.html') }
+  t.files = %w[lib/**/*.rb - README.md LICENSE.txt CHANGELOG.md]
+  t.options.unshift("--title", '"dry-cli-ui: runtime terminal UI for dry-cli commands"')
+  t.after = -> { exec("open doc/index.html") } if RUBY_PLATFORM =~ /darwin/
+
+  require "fileutils"
+  FileUtils.mkdir_p("doc/docs/badges")
+  FileUtils.cp("docs/badges/coverage_badge.svg", "doc/docs/badges")
 end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/docs/badges/coverage_badge.svg

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="99" height="20">
+  <linearGradient id="b" x2="0" y2="100%">
+    <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+    <stop offset="1" stop-opacity=".1"/>
+  </linearGradient>
+  <mask id="a">
+    <rect width="99" height="20" rx="3" fill="#fff"/>
+  </mask>
+  <g mask="url(#a)">
+    <path fill="#555" d="M0 0h63v20H0z"/>
+    <path fill="#4c1" d="M63 0h36v20H63z"/>
+    <path fill="url(#b)" d="M0 0h99v20H0z"/>
+  </g>
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
+    <text x="31.5" y="15" fill="#010101" fill-opacity=".3">coverage</text>
+    <text x="31.5" y="14">coverage</text>
+    <text x="80" y="15" fill="#010101" fill-opacity=".3">97%</text>
+    <text x="80" y="14">97%</text>
+  </g>
+</svg>

data/exe/laser-cutter

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# No Bundler here: a Gemfile in the user's directory must not decide which gems load.
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+require 'laser/cutter'
+
+Laser::Cutter::Launcher.new(ARGV).execute!

data/exe/lc

@@ -0,0 +1 @@
+laser-cutter

data/justfile

@@ -0,0 +1,97 @@
+set shell := ["bash", "-c"]
+
+version := `gawk -F'"' '/VERSION/ { printf "%s", $2 }' lib/laser/cutter/version.rb`
+rbenv   := 'eval "$(rbenv init - bash 2>/dev/null || true)"; bundle exec '
+repo    := 'git@github.com:kigster/laser-cutter.git'
+
+gem_name := 'laser-cutter'
+gem_file := 'pkg/' + gem_name + '-' + version + '.gem'
+gem_url  := 'https://rubygems.org/gems/' + gem_name
+
+[no-exit-message]
+recipes:
+    just --choose
+
+# Lint Ruby
+lint:
+    {{ rbenv }} rubocop
+
+# Autocorrect Ruby (pass -A for unsafe corrections) and format Markdown
+format *args: format-markdown
+    {{ rbenv }} rubocop -a {{ args }}
+
+# Format every Markdown file
+format-markdown:
+    fd .md -X mdformat --wrap no
+
+# Run all the tests; a full run enforces 100% line and branch coverage
+test *args:
+    {{ rbenv }} rspec {{ args }}
+
+# Run all tests with --documentation
+test-docs *args:
+    {{ rbenv }} rspec --format documentation {{ args }}
+
+# Run tests and measure coverage even for a partial run
+test-coverage *args:
+    export COVERAGE=true; {{ rbenv }} rspec {{ args }}
+
+ci: lint test-coverage
+
+alias check-all := ci
+
+# Remove .DS_Store files and tmp/
+clean:
+    fd --hidden --no-ignore --type file --glob .DS_Store --exec rm -v
+    rm -rf tmp coverage
+
+# Run all lefthook pre-commit hooks against every file
+lefthook:
+    lefthook run pre-commit --all-files
+
+# Print current gem version
+version:
+    @echo "{{ version }}"
+
+# Remove every generated file
+clobber:
+    {{ rbenv }} rake clobber
+
+# Generate YARD documentation
+doc:
+    {{ rbenv }} rake doc
+
+# Builds the gem for distribution
+build:
+    {{ rbenv }} rake build
+
+# `gem push` rather than `rake release`: release also tags and pushes git,
+# which `just release` does separately, and it gives no way to pass a 2FA code.
+#
+#   just publish            # gem push prompts for the code if 2FA needs one
+#   just publish 123456     # use this code
+#
+# Build the .gem and push it to RubyGems
+publish otp="": build
+    #!/usr/bin/env bash
+    set -euo pipefail
+    eval "$(rbenv init - bash 2>/dev/null || true)"
+
+    otp="{{ otp }}"
+    if [[ -n "${otp}" ]]; then
+      gem push "{{ gem_file }}" --otp "${otp}"
+    else
+      gem push "{{ gem_file }}"
+    fi
+
+    # Only reachable when the push succeeded: `set -e` aborts on a failed push.
+    echo "published {{ gem_name }} {{ version }} → {{ gem_url }}"
+    open "{{ gem_url }}" 2>/dev/null || xdg-open "{{ gem_url }}" 2>/dev/null || true
+
+# Tag v{{ version }} and publish the GitHub release
+release:
+    git fetch --tags
+    git tag -f "v{{ version }}"
+    git push -f --tags
+    gh release delete -y "v{{ version }}" --repo {{ repo }} 2>/dev/null || true
+    gh release create "v{{ version }}" --generate-notes --repo {{ repo }}

data/laser-cutter.gemspec

@@ -1,30 +1,43 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('./lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'laser-cutter/version'
+
+require_relative 'lib/laser/cutter/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "laser-cutter"
   spec.version       = Laser::Cutter::VERSION
   spec.authors       = ['Konstantin Gredeskoul']
   spec.email         = ["kigster@gmail.com"]
-  spec.summary       = %q{Creates notched box outlines for laser-cut boxes which are geometrically symmetric and pleasing to the eye.}
-  spec.description   = %q{Similar to the older BoxMaker, this ruby gem generates PDFs that can be used as a basis for cutting boxes on a typical laser cutter. The intention was to create an extensible, well tested, and modern ruby gem for generating PDF templates used in laser cutting.}
+  spec.summary       = 'Creates notched box outlines for laser-cut boxes which are geometrically symmetric and pleasing to the eye.'
+  spec.description   = 'Similar to the older BoxMaker, this ruby gem generates PDFs that can be used as a basis for cutting boxes on a typical laser cutter. The intention was to create an extensible, well tested, and modern ruby gem for generating PDF templates used in laser cutting.'
   spec.homepage      = "https://github.com/kigster/laser-cutter"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 4.0'
 
-  spec.add_dependency 'prawn'
+  spec.add_dependency 'dry-cli', '~> 1.4.1'
+  spec.add_dependency 'dry-cli-autocomplete'
+  spec.add_dependency 'dry-cli-help'
+  spec.add_dependency 'dry-cli-ui'
+  spec.add_dependency 'dry-struct', '~> 1.6'
   spec.add_dependency 'hashie'
-  spec.add_dependency 'colored'
+  spec.add_dependency 'matrix'
+  spec.add_dependency 'pastel'
+  spec.add_dependency 'prawn'
+  spec.add_dependency 'tty-cursor'
+  spec.add_dependency 'tty-progressbar'
+  spec.add_dependency 'tty-prompt'
+  spec.add_dependency 'tty-screen'
+  spec.add_dependency 'tty-spinner'
+  spec.add_dependency 'tty-table'
+  spec.add_dependency 'victor'
+  spec.add_dependency 'zeitwerk'
 
-  spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end