laser-cutter 2.0.0 → 2.0.1

data/spec/laser/cutter/cli_spec.rb

@@ -148,6 +148,21 @@ RSpec.describe 'laser-cutter', type: :aruba do
       expect(last_command_started).to have_output(/"depth": 2\.0/)
     end
 
+    { 'plain' => 224, 'back' => 260, 'full' => 328 }.each do |lid, lines|
+      it "draws #{lines} lines for a #{lid} lid" do
+        run_command_and_stop("laser-cutter generate #{box} --lid #{lid} -o box.pdf")
+        expect(last_command_started).to have_output(%r{Lid:\s+#{lid}.*Drawing box\.pdf #{lines}/#{lines}}m)
+      end
+    end
+
+    it 'keeps the lid a saved configuration asks for' do
+      run_command_and_stop("laser-cutter generate #{box} -L plain -o box.pdf -W settings.json")
+      expect(JSON.parse(read('settings.json').join)).to include('lid' => 'plain')
+
+      run_command_and_stop('laser-cutter generate -R settings.json -o again.pdf')
+      expect(last_command_started).to have_output(%r{Drawing again\.pdf 224/224})
+    end
+
     it 'opens the file with --open' do
       allow_any_instance_of(Laser::Cutter::CLI::Generate).to receive(:system)
       run_command_and_stop("laser-cutter generate #{box} -o box.pdf --open")
@@ -172,6 +187,18 @@ RSpec.describe 'laser-cutter', type: :aruba do
         expect(last_command_started).to have_output(/unknown format "dxf", expected one of: pdf, svg/)
       end
 
+      it 'fails on an unknown lid' do
+        run_command_and_stop("laser-cutter generate #{box} --lid sliding -o box.pdf", fail_on_error: false)
+        expect(last_command_started).to have_exit_status(1)
+        expect(last_command_started.stderr).to match(/was called with arguments.*--lid sliding/)
+      end
+
+      it 'fails on an unknown lid in a saved configuration' do
+        write_file('settings.json', '{"box": "4x3x2/0.125/0.5", "lid": "sliding"}')
+        run_command_and_stop('laser-cutter generate -R settings.json -o box.pdf', fail_on_error: false)
+        expect(last_command_started.stderr).to match(/─ Error ─.*lid is "sliding", but must be one of: full, back, plain/m)
+      end
+
       it 'fails on a missing configuration file' do
         run_command_and_stop('laser-cutter generate -R nothing.json -o box.pdf', fail_on_error: false)
         expect(last_command_started).to have_output(/cannot read the configuration from nothing\.json/)

data/spec/laser/cutter/configuration_spec.rb

@@ -40,6 +40,23 @@ module Laser
         end
       end
 
+      describe 'lid' do
+        let(:opts) { { 'box' => '2x3x2/0.125/0.5', 'file' => '/tmp/a' } }
+
+        its(:lid) { is_expected.to eql('full') }
+
+        %w[full back plain].each do |lid|
+          it "accepts #{lid}" do
+            expect { described_class.new(opts.merge('lid' => lid)).validate! }.not_to raise_error
+          end
+        end
+
+        it 'rejects anything else' do
+          expect { described_class.new(opts.merge('lid' => 'sliding')).validate! }
+            .to raise_error(Laser::Cutter::InvalidOption, /lid is "sliding"/)
+        end
+      end
+
       context 'when notch is omitted' do
         let(:opts) { { 'box' => '2.0x1.0x2/0.125', 'file' => '/tmp/a' } }
 

data/spec/laser/cutter/options_spec.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Laser
+  module Cutter
+    RSpec.describe Options do
+      subject(:options) { described_class.new(settings) }
+
+      let(:dimensions) { { width: 40, height: 30, depth: 20, thickness: 3 } }
+      let(:settings) { dimensions }
+
+      describe 'with the dimensions alone' do
+        its(:width) { is_expected.to eql(40.0) }
+        its(:thickness) { is_expected.to eql(3.0) }
+        its(:units) { is_expected.to eq('in') }
+        its(:lid) { is_expected.to eq('full') }
+        its(:page_layout) { is_expected.to eq('portrait') }
+        its(:metadata) { is_expected.to be(true) }
+        its(:inside_box) { is_expected.to be(false) }
+        its(:notch) { is_expected.to be_nil }
+        its(:kerf) { is_expected.to be_nil }
+        its(:format) { is_expected.to be_nil }
+        its(:file) { is_expected.to be_nil }
+        its(:page_size) { is_expected.to be_nil }
+
+        it { is_expected.not_to respond_to(:width=) }
+      end
+
+      describe 'with what a form sends: Strings, some of them blank' do
+        let(:settings) do
+          { 'width' => '70', 'height' => '20', 'depth' => '50', 'thickness' => '4.3', 'notch' => '', 'kerf' => '0.1',
+            'units' => 'mm', 'lid' => 'plain', 'format' => 'SVG', 'page_size' => 'a4', 'page_layout' => '',
+            'metadata' => '0', 'inside_box' => 'true', 'margin' => '', 'padding' => '2', 'stroke' => '0.2' }
+        end
+
+        its(:width) { is_expected.to eql(70.0) }
+        its(:thickness) { is_expected.to eql(4.3) }
+        its(:notch) { is_expected.to be_nil }
+        its(:kerf) { is_expected.to eql(0.1) }
+        its(:units) { is_expected.to eq('mm') }
+        its(:lid) { is_expected.to eq('plain') }
+        its(:format) { is_expected.to eq('svg') }
+        its(:page_size) { is_expected.to eq('A4') }
+        its(:page_layout) { is_expected.to eq('portrait') }
+        its(:metadata) { is_expected.to be(false) }
+        its(:inside_box) { is_expected.to be(true) }
+        its(:margin) { is_expected.to be_nil }
+        its(:padding) { is_expected.to eql(2.0) }
+        its(:stroke) { is_expected.to eql(0.2) }
+      end
+
+      describe 'with Symbols' do
+        let(:settings) { dimensions.merge(units: :mm, lid: :back, format: :pdf, page_layout: :landscape) }
+
+        its(:units) { is_expected.to eq('mm') }
+        its(:lid) { is_expected.to eq('back') }
+        its(:format) { is_expected.to eq('pdf') }
+        its(:page_layout) { is_expected.to eq('landscape') }
+      end
+
+      describe 'given an Options' do
+        it 'returns it' do
+          expect(described_class.new(options)).to be(options)
+        end
+      end
+
+      describe '#new' do
+        subject(:changed) { options.new(lid: :plain) }
+
+        its(:lid) { is_expected.to eq('plain') }
+        its(:width) { is_expected.to eql(40.0) }
+      end
+
+      describe 'what it refuses' do
+        {
+          { lid: 'sliding' }          => 'lid cannot be "sliding", but must be one of: full, back, plain.',
+          { units: 'cm' }             => 'units cannot be "cm", but must be one of: in, mm.',
+          { format: 'dxf' }           => 'format cannot be "dxf", but must be one of: pdf, svg.',
+          { page_layout: 'sideways' } => 'page_layout cannot be "sideways", but must be one of: portrait, landscape.',
+          { page_size: 'A99' }        => 'page_size cannot be "A99".',
+          { width: 'wide' }           => 'width cannot be "wide".',
+          { depth: 0 }                => 'depth cannot be 0.',
+          { kerf: -0.1 }              => 'kerf cannot be -0.1.',
+          { metadata: 'maybe' }       => 'metadata cannot be "maybe".'
+        }.each do |bad, message|
+          it "raises InvalidOption when #{bad.keys.first} is #{bad.values.first.inspect}" do
+            expect { described_class.new(dimensions.merge(bad)) }.to raise_error(InvalidOption, message)
+          end
+        end
+
+        it 'raises InvalidOption for a key that is not an option' do
+          expect { described_class.new(dimensions.merge(lids: :plain)) }.to raise_error(InvalidOption, /lids/)
+        end
+
+        it 'raises MissingOption naming every dimension left out' do
+          expect { described_class.new(width: 40, depth: '') }
+            .to raise_error(MissingOption, 'height, depth, thickness are required, but missing.')
+        end
+
+        it 'raises MissingOption naming the one dimension left out' do
+          expect { described_class.new(dimensions.except(:width)) }.to raise_error(MissingOption, 'width is required, but missing.')
+        end
+      end
+
+      describe '#to_configuration' do
+        subject(:config) { described_class.new(dimensions.merge(units: :mm, lid: :back, inside_box: true, format: :svg)).to_configuration }
+
+        it { is_expected.to be_a(Configuration) }
+
+        its(:width) { is_expected.to eql(40.0) }
+        its(:lid) { is_expected.to eq('back') }
+        its(:debug) { is_expected.to be(true) }
+        its(:notch) { is_expected.to eql(9.0) }
+        its(:kerf) { is_expected.to be_within(1e-6).of(0.06096) }
+        its(:format) { is_expected.to be_nil }
+      end
+    end
+  end
+end

data/spec/laser/cutter/renderer/layout_renderer_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'tmpdir'
 
 module Laser
   module Cutter
@@ -8,33 +9,15 @@ module Laser
       RSpec.describe LayoutRenderer do
         describe '#render' do
           let(:renderer) { LayoutRenderer.new(config) }
-          let(:file) { File.expand_path("../../../laser-cutter-pdf-test.#{$$}.pdf", __FILE__) }
+          let(:dir) { Dir.mktmpdir }
+          let(:file) { File.join(dir, 'box.pdf') }
+
+          after { FileUtils.remove_entry(dir) }
 
           def render_file(filename)
-            real_file = ENV['RSPEC_SAVE_PDF'] ? true : false
             config.validate!
-            expect(!File.exist?(filename)) if real_file
             renderer.render
-            expect(File.exist?(filename)) if real_file
-            expect(File.size(filename) > 0) if real_file
-          rescue Exception => e
-            warn e.backtrace.join("\n")
-            fail e.message
-          ensure
-            if real_file
-              begin
-                File.delete(filename)
-              rescue StandardError
-                nil
-              end
-              expect(!File.exist?(filename))
-            end
-          end
-
-          before do
-            unless ENV['RSPEC_SAVE_PDF']
-              expect_any_instance_of(Prawn::Document).to receive(:render_file).once
-            end
+            expect(File.binread(filename)).to start_with('%PDF')
           end
 
           context 'metric' do

data/spec/laser/cutter_spec.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'tmpdir'
+
+# What a Ruby program, such as the MakeABox.io website, calls instead of the command line.
+RSpec.describe Laser::Cutter do
+  let(:settings) { { width: 40, height: 30, depth: 20, thickness: 3, units: 'mm' } }
+  let(:options) { Laser::Cutter::Options.new(settings) }
+  let(:dir) { Dir.mktmpdir }
+
+  after { FileUtils.remove_entry(dir) }
+
+  describe '.render' do
+    subject(:document) { described_class.render(options) }
+
+    it { is_expected.to start_with('%PDF') }
+
+    it 'writes no file' do
+      expect { Dir.chdir(dir) { document } }.not_to(change { Dir.children(dir) })
+    end
+
+    it 'draws an SVG when the options ask for one' do
+      expect(described_class.render(options.new(format: :svg))).to include('<svg', 'width="109.46048mm"')
+    end
+
+    it 'takes a Hash, the way a form sends it' do
+      expect(described_class.render(settings.transform_keys(&:to_s).transform_values(&:to_s))).to start_with('%PDF')
+    end
+
+    it 'yields each line it draws' do
+      lines = []
+      described_class.render(options.new(format: 'svg')) { |line| lines << line }
+      expect(lines.size).to eq(280)
+    end
+
+    { nil => 280, '' => 280, 'full' => 280, :back => 208, 'back' => 208, :plain => 184, 'plain' => 184 }.each do |lid, lines|
+      it "draws #{lines} lines for the lid #{lid.inspect}" do
+        svg = described_class.render(settings.merge(lid: lid, format: :svg))
+        expect(svg.scan('<line').size).to eq(lines)
+      end
+    end
+
+    it 'names the lid in the description of an SVG' do
+      expect(described_class.render(settings.merge(lid: :plain, format: :svg))).to match(/<desc>.*lid: plain/m)
+    end
+
+    it 'leaves the description out of an SVG without metadata' do
+      expect(described_class.render(settings.merge(format: :svg, metadata: false))).not_to include('<desc>')
+    end
+
+    it 'draws the box without kerf as well in a PDF, when asked' do
+      lines = 0
+      described_class.render(options.new(inside_box: true)) { lines += 1 }
+      expect(lines).to eq(560)
+    end
+
+    it 'raises InvalidOption for a lid it does not know' do
+      expect { described_class.render(settings.merge(lid: 'sliding')) }.to raise_error(Laser::Cutter::InvalidOption, /lid/)
+    end
+
+    it 'raises MissingOption for a dimension left out' do
+      expect { described_class.render(settings.except(:depth)) }.to raise_error(Laser::Cutter::MissingOption, /depth is required/)
+    end
+  end
+
+  describe '.write' do
+    let(:path) { File.join(dir, 'box.svg') }
+
+    it 'takes the format from the extension, and returns the path' do
+      expect(described_class.write(options.new(file: path, lid: :back))).to eq(path)
+      expect(File.read(path).scan('<line').size).to eq(208)
+    end
+
+    it 'writes the format it is given, whatever the extension' do
+      described_class.write(settings.merge(file: path, format: :pdf))
+      expect(File.binread(path)).to start_with('%PDF')
+    end
+
+    it 'writes a PDF when the extension says nothing' do
+      described_class.write(settings.merge(file: File.join(dir, 'box')))
+      expect(File.binread(File.join(dir, 'box'))).to start_with('%PDF')
+    end
+
+    it 'raises MissingOption without a file' do
+      expect { described_class.write(options) }.to raise_error(Laser::Cutter::MissingOption, /file is required/)
+    end
+  end
+
+  # app/helpers/home_helper.rb and app/controllers/home_controller.rb, written against 1.0.3.
+  describe 'the calls MakeABox.io makes today' do
+    let(:form) { { 'width' => '40', 'height' => '30', 'depth' => '20', 'thickness' => '3', 'units' => 'mm', 'lid' => '' } }
+    let(:config) { Laser::Cutter::Configuration.new(form.merge(metadata: true)) }
+    let(:path) { File.join(dir, 'box.pdf') }
+
+    before { config['file'] = path }
+
+    it 'still draw a box' do
+      config.validate!
+      Laser::Cutter::Renderer::LayoutRenderer.new(config).render
+      expect(File.binread(path)).to start_with('%PDF')
+    end
+
+    it 'still list the page sizes' do
+      expect(Laser::Cutter::PageManager.new(config.units).page_size_values)
+        .to include(['A4', be_within(0.1).of(210), be_within(0.1).of(297)])
+    end
+
+    it 'still fail on a missing dimension with an error the website rescues' do
+      config.delete(:width)
+      expect { config.validate! }.to raise_error(Laser::Cutter::MissingOption)
+    end
+  end
+end

data/spec/support/outline.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Reads the lines of one panel as the region they enclose, without using any
+# of the code that drew them.
+module Outline
+  module_function
+
+  # Whether a point is inside the outline, by the even-odd rule: a ray from
+  # the point crosses the outline an odd number of times.
+  #
+  # @param lines [Array<Laser::Cutter::Geometry::Line>] an outline of horizontal and vertical lines
+  # @return [Boolean]
+  def inside?(lines, x, y)
+    lines.count do |line|
+      next false unless line.p1.x == line.p2.x && line.p1.x > x
+
+      low, high = [line.p1.y, line.p2.y].sort
+      low < y && y < high
+    end.odd?
+  end
+
+  # Whether the outline grown by a margin on every side covers the point.
+  #
+  # @return [Boolean]
+  def within?(lines, x, y, margin)
+    offsets = [-margin, 0, margin]
+    offsets.product(offsets).any? { |dx, dy| inside?(lines, x + dx, y + dy) }
+  end
+
+  # Whether every line ends where another begins, so the outline has no gap.
+  #
+  # @return [Boolean]
+  def closed?(lines)
+    ends = lines.flat_map { |line| [line.p1, line.p2] }.map { |point| point.to_a.map { |c| c.round(6) + 0.0 } }
+    ends.tally.values.all?(&:even?)
+  end
+
+  # Points spread over a rectangle, off any round coordinate a line could sit on.
+  #
+  # @param rect [Laser::Cutter::Geometry::Rect]
+  # @param margin [Float] how far past the rectangle to reach
+  # @param steps [Integer] points per axis
+  # @return [Array<Array(Float, Float)>]
+  def samples(rect, margin:, steps: 61)
+    xs = spread(rect.p1.x - margin, rect.p2.x + margin, steps)
+    ys = spread(rect.p1.y - margin, rect.p2.y + margin, steps)
+    xs.product(ys)
+  end
+
+  def spread(from, to, steps)
+    Array.new(steps) { |i| from + ((to - from) * (i + 0.4142) / steps) }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: laser-cutter
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -65,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -250,6 +264,8 @@ files:
 - ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".plans/001.00-dry-cli-migration/plan.md"
+- ".plans/002.00-lid-options/plan.md"
+- ".plans/003.00-ruby-api/plan.md"
 - ".relaxed_rubocop.yml"
 - ".rspec"
 - ".rubocop.yml"
@@ -262,6 +278,11 @@ files:
 - README.md
 - Rakefile
 - docs/badges/coverage_badge.svg
+- docs/images/box-lid-back.avif
+- docs/images/box-lid-full.avif
+- docs/images/box-lid-plain.avif
+- docs/images/box-metric.avif
+- docs/images/box-tray.avif
 - docs/images/comparison.jpg
 - exe/laser-cutter
 - exe/lc
@@ -287,6 +308,7 @@ files:
 - lib/laser/cutter/geometry/rect.rb
 - lib/laser/cutter/geometry/shape.rb
 - lib/laser/cutter/geometry/tuple.rb
+- lib/laser/cutter/invalid_option.rb
 - lib/laser/cutter/launcher.rb
 - lib/laser/cutter/missing_option.rb
 - lib/laser/cutter/notching/base.rb
@@ -294,6 +316,7 @@ files:
 - lib/laser/cutter/notching/infinite_iterator.rb
 - lib/laser/cutter/notching/path_generator.rb
 - lib/laser/cutter/notching/shift.rb
+- lib/laser/cutter/options.rb
 - lib/laser/cutter/page_manager.rb
 - lib/laser/cutter/renderer.rb
 - lib/laser/cutter/renderer/base.rb
@@ -303,11 +326,13 @@ files:
 - lib/laser/cutter/renderer/meta_renderer.rb
 - lib/laser/cutter/renderer/rect_renderer.rb
 - lib/laser/cutter/renderer/svg_renderer.rb
+- lib/laser/cutter/types.rb
 - lib/laser/cutter/units_converter.rb
 - lib/laser/cutter/version.rb
 - lib/laser/cutter/zero_value_not_allowed.rb
 - lib/laser_cutter.rb
 - spec/laser/cutter/aggregator_spec.rb
+- spec/laser/cutter/box_lid_spec.rb
 - spec/laser/cutter/box_spec.rb
 - spec/laser/cutter/cli/config_file_spec.rb
 - spec/laser/cutter/cli_spec.rb
@@ -315,6 +340,7 @@ files:
 - spec/laser/cutter/dimensions_spec.rb
 - spec/laser/cutter/edge_spec.rb
 - spec/laser/cutter/line_spec.rb
+- spec/laser/cutter/options_spec.rb
 - spec/laser/cutter/page_manager_spec.rb
 - spec/laser/cutter/path_generator_spec.rb
 - spec/laser/cutter/point_spec.rb
@@ -322,8 +348,10 @@ files:
 - spec/laser/cutter/renderer/layout_renderer_spec.rb
 - spec/laser/cutter/renderer/svg_renderer_spec.rb
 - spec/laser/cutter/renderer_spec.rb
+- spec/laser/cutter_spec.rb
 - spec/spec_helper.rb
 - spec/support/aruba.rb
+- spec/support/outline.rb
 homepage: https://github.com/kigster/laser-cutter
 licenses:
 - MIT