laser-cutter 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b027c579de8cded3aba462a120045ed6ec685930
-  data.tar.gz: 76e13dddecbae505385b1064cb29198c7a0a5d41
+  metadata.gz: 3a3d7b723ed7171e84a93783545f037adeeeb122
+  data.tar.gz: d3571947154cda05176e1d1bbb84d8d2ee140c02
 SHA512:
-  metadata.gz: 843bd8781e86f9da4d6bee52529f625d7b04f177c1a3bf50847b33a51bcb938ce6310faf10b1f0bee57de4d21ee36427515ddfc1529e0c933f21ca268e842091
-  data.tar.gz: 337ae8d3ebe98ce3dc4380ef65a81c9172eb75ae7f799f60db35f228b2bd6713b525c6898c67dbff00da8de8ecd8adac8cff0d14e9d2d22c23e0598744f40294
+  metadata.gz: 870c36a4b07b2d4190076c524917f4322d599c58f5ff9b226b47e00a011dd63f722a7153ed885c192cbe0caefbda17fb150269a7822f4e36a001f4913a435d19
+  data.tar.gz: 67c264109139865d62292cb8cea2573ec5dbc569fec92316b00a14f942c0ea15d096d0391d1a5a275e3eaf78c7f9f8f179e95331f93859df982f7c7a80589e08

data/.gitignore

@@ -25,3 +25,4 @@ mkmf.log
 .idea/
 **output.pdf
 .ruby_version
+doc

data/.rspec

@@ -1,3 +1,2 @@
 --color
 --format progress
---require rspec/legacy_formatters

data/.travis.yml

@@ -1,11 +1,26 @@
+env:
+  global:
+  - CC_TEST_REPORTER_ID=6520104decf84e2f6c2c169d30d67976bfcdaa48cd89b4ec34f6e637f2a0ae02
+sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.1.3
-script: "CODECLIMATE_REPO_TOKEN=6520104decf84e2f6c2c169d30d67976bfcdaa48cd89b4ec34f6e637f2a0ae02 bundle exec rspec"
+- 2.4.1
+- 2.3.5
+before_install: gem install bundler -v 1.15.4
+before_script:
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+  > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
+script:
+- bundle exec rspec
+after_script:
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 notifications:
-  email:
-    recipients:
-      - kigster@gmail.com
-    on_success: never
-    on_failure: always
-
+  webhooks:
+    urls:
+      - secure: fgpv34jAm3rDNjiWuQtuijE0p9B2bpsCWdoCQ82pDZwktSITmNjanYCoZC0hlEw/kqMBDKRN78HfIIidy8dS664sLz8KyaFXq7RWAFsMP9fn/GMG/r9B+S3YumifQ/Zy+3OGa+0Qz76075q291QfNSPv0Y5QDMoAU5VljIVashC/qJS6DRO+vekDaDKIhi4Dr/+JpHPnjchqS4VaMB8gEIrDpeSYNlhrj1oAI/8GwgqZ8UR4sZGxNpIzUg+XGJSYz5/cAB3P18ENSQvOwaNefJa7qIVNjMD7YwXKmfX9cyr5RHM5sibq/S5fHH/N7pig+aveTquGGVxInJr1IEDiyr2TsFARjPitp9KJSFLHLsA2jm1cZfNW0/d6ii+51HdLPKorHom3fPjb0jkIe1LPa9CrrjnfSrAE9a/w4qpSnDv7OjAzkieepz+VQCtpQGIzQxJcHWaFX32iZ6RQ6pmKc/22E0OZwsNM2FHrB5V1b+rfczl8Ej7/R1wAOtHWkbLbfwZ9Ux2N0N0EKW8r8cOjEbsxmN8FFQubTwl68uqjJLhEtrOUbM28JM/NkX+Ue1KRw+NJAdMFEZQKPb/b/X6s3nwPD4/4yLyUDCGyr8aGpzSBD5uIu5uSJNiWdNDjcnXtJJ6TlGGZqj91r7FckjA8FuSA6S3yA8epMNG3FTUxPVE=
+    on_success: always
+    on_failure: onchange
+    on_start: never

data/BOXMAKER.md

@@ -0,0 +1,51 @@
+# LaserCutter versus BoxMaker
+
+Another developer [Rahulbot](https://github.com/rahulbot/) created a similar app [BoxMaker](https://github.com/rahulbot/boxmaker/) in Java, which was an inspiration to LaserCutter.
+
+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 -z 1x1.5x2/0.125/0.125 -O -o box.pdf
+```
+
+![LaserCutter Comparison](docs/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

data/README.md

@@ -1,34 +1,27 @@
 [![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)
-[![Code Climate](https://codeclimate.com/github/kigster/laser-cutter.png)](https://codeclimate.com/github/kigster/laser-cutter)
-[![Test Coverage](https://codeclimate.com/github/kigster/laser-cutter/badges/coverage.svg)](https://codeclimate.com/github/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)
 
-## LaserCutter and Make-A-Box.io
+[![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)
 
-```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.
+[![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)
 
-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.
+# LaserCutter
 
-[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.  
+**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.
 
-Use whatever suites you better.
+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.  
 
-### Design Goals
+Use whatever suites you better.
 
-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. 
+> NOTE: Please read our [feature comparison guide](BOXMAKER.md) of LaserCutter against an older tool called [BoxMaker](https://github.com/rahulbot/boxmaker).
 
-```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. 
@@ -43,12 +36,49 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it manually:
 
     $ gem install laser-cutter
 
 ## Usage
 
+We'll start with some examples:
+
+### Examples
+
+Create a box defined in inches, with kerf (cut width) set to `0.005in`, and open PDF in preview right after:
+
+```bash
+    laser-cutter -z 3x2x2/0.125 -k 0.005 -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`:
+
+```bash
+    laser-cutter -u mm -w70 -h20 -d50 -t4.3 -n5 -iA3 -l landscape -s0.5 -v -O -o box.pdf
+```   
+
+List all possible page sizes in metric system:
+
+```bash
+    laser-cutter -L -u mm
+```                 
+
+Create a box with provided dimensions, and save the config to a file for later use:
+
+```bash
+    laser-cutter -z 1.1x2.5x1.5/0.125/0.125 -p 0.1 -O -o box.pdf -W box-settings.json
+```    
+
+Read settings from a previously saved file:
+
+```bash
+    laser-cutter -O -o box.pdf -R box-settings.json
+    cat box-settings.json | laser-cutter -O -o box.pdf -R -
+```
+
+### Complete Help
+
 ```bash
 
 Usage: laser-cutter [options] -o filename.pdf
@@ -60,7 +90,7 @@ Specific Options:
     -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.007in)
+    -k, --kerf KERF                  Kerf - cut width (default is 0.0024in)
 
     -m, --margin MARGIN              Margins from the edge of the document
     -p, --padding PADDING            Space between the boxes on the page
@@ -90,41 +120,7 @@ Common Options:
     -u, --units UNITS                Either 'in' for inches (default) or 'mm'
 ```
 
-### Examples
-
-Create a box defined in inches, with kerf (cut width) set to 0.008", and open PDF in preview right after:
-
-```bash
-    laser-cutter -z 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:
-
-```bash
-    laser-cutter -u mm -w70 -h20 -d50 -t4.3 -n5 -iA3 -l landscape -s0.5 -v -O -o box.pdf
-```   
-
-List all possible page sizes in metric system:
-
-```bash
-    laser-cutter -L -u mm
-```                 
-
-Create a box with provided dimensions, and save the config to a file for later use:
-
-```bash
-    laser-cutter -z 1.1x2.5x1.5/0.125/0.125 -p 0.1 -O -o box.pdf -W box-settings.json
-```    
-
-Read settings from a previously saved file:
-
-```bash
-    laser-cutter -O -o box.pdf -R box-settings.json
-    cat box-settings.json | laser-cutter -O -o box.pdf -R -
-```
-
-## Feature Wish List
+## 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
@@ -133,56 +129,9 @@ Read settings from a previously saved file:
 * 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 -z 1x1.5x2/0.125/0.125 -O -o box.pdf
-```
-
-![LaserCutter Comparison](doc/comparison.jpg).
-
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/laser-cutter/fork )
+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`)

data/Rakefile

@@ -1,2 +1,29 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
 
+def shell(*args)
+  puts "running: #{args.join(' ')}"
+  system(args.join(' '))
+end
+
+task :clean do
+  shell('rm -rf pkg/ tmp/ coverage/' )
+end
+
+task :permissions => [ :clean ] do
+  shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
+  shell("find . -type d -exec chmod o+x,g+x {} \\;")
+end
+
+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') }
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/laser-cutter.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hashie'
   spec.add_dependency 'colored'
 
-  spec.add_development_dependency 'bundler', "~> 1.6"
+  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.add_development_dependency 'rspec-legacy_formatters'
-  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/laser-cutter/box.rb

@@ -1,9 +1,10 @@
+require 'forwardable'
 module Laser
   module Cutter
-    # Note: this class badly needs refactoring and tests.  Both are coming.
-
     class Box
       # Everything is in millimeters
+      extend Forwardable
+      def_delegators :@dim, :w, :h, :d
 
       attr_accessor :dim, :thickness, :notch_width, :kerf
       attr_accessor :padding, :units, :inside_box
@@ -13,33 +14,43 @@ module Laser
       attr_accessor :metadata, :notches
 
       def initialize(config = {})
-        self.dim = Geometry::Dimensions.new(config['width'], config['height'], config['depth'])
+        self.dim       = Geometry::Dimensions.new(config['width'], config['height'], config['depth'])
         self.thickness = config['thickness']
 
         self.notch_width = config['notch'] || (1.0 * self.longest / 5.0)
-        self.kerf = config['kerf'] || 0.0
-        self.padding = config['padding']
-        self.units = config['units']
-        self.inside_box = config['inside_box']
+        self.kerf        = config['kerf'] || 0.0
+        self.padding     = config['padding']
+        self.units       = config['units']
+        self.inside_box  = config['inside_box']
 
         self.notches = []
 
         self.metadata = Geometry::Point[config['metadata_width'] || 0, config['metadata_height'] || 0]
 
         create_faces! # generates dimensions for each side
-        self.faces =     [top, front, bottom, back, left, right]
-
-        self.conf   = {
-            valign: [    :out, :out,  :out,   :out, :in, :in],
-            halign: [    :in,  :out,  :in,    :out, :in, :in],
-            corners: {
-                front: [ :no,  :yes,  :no,    :yes, :no, :no], # our default choice, but may not work
-                top:   [ :yes, :no,   :yes,   :no,  :no, :no]  # 2nd choice, has to work if 1st doesn't
-            },
+        self.faces     = [top, front, bottom, back, left, right]
+
+        self.conf = {
+          valign:  [:out, :out, :out, :out, :in, :in],
+          halign:  [:in, :out, :in, :out, :in, :in],
+          corners: {
+            top: [:yes, :no, :yes, :no, :no, :no], # 2nd choice, has to work if 1st doesn't
+            front: [:no, :yes, :no, :yes, :no, :no], # our default choice, but may not work
+          },
         }
         self
       end
 
+      def generate_notches
+        position_faces!
+        self.corner_face = pick_corners_face
+        self.notches     = []
+        faces.each_with_index do |face, face_index|
+          create_face_edges(face, face_index)
+        end
+        self.notches.flatten!
+      end
+
       def enclosure
         generate_notches if self.notches.empty?
         p1 = notches.first.p1.to_a
@@ -47,55 +58,15 @@ module Laser
 
         notches.each do |notch|
           n = notch.normalized
-          n.p1.to_a.each_with_index {|c, i| p1[i] = c if c < p1[i] }
-          n.p2.to_a.each_with_index {|c, i| p2[i] = c if c > p2[i] }
+          n.p1.to_a.each_with_index {|c, i| p1[i] = c if c < p1[i]}
+          n.p2.to_a.each_with_index {|c, i| p2[i] = c if c > p2[i]}
         end
 
         Geometry::Rect[Geometry::Point.new(p1), Geometry::Point.new(p2)]
       end
 
-      def generate_notches
-        position_faces!
-        corner_face = pick_corners_face
-        self.notches = []
-        faces.each_with_index do |face, face_index|
-          bound = face_bounding_rect(face)
-          side_lines = []
-          edges = []
-          bound.sides.each_with_index do |bounding_side, side_index |
-            include_corners = (self.conf[:corners][corner_face][face_index] == :yes && side_index.odd?)
-            key = side_index.odd? ? :valign : :halign
-            center_out = (self.conf[key][face_index] == :out)
-            edges << Notching::Edge.new(bounding_side, face.sides[side_index],
-                            {:notch_width => notch_width,
-                             :thickness => thickness,
-                             :kerf => kerf,
-                             :center_out => center_out,
-                             :corners => include_corners
-                            })
-          end
-
-          if edges.any?{|e| e.corners} && !edges.all?{|e| e.first_notch_out? }
-            edges.each {|e| e.adjust_corners = true }
-          end
-
-          edges.each do |edge|
-            side_lines << Notching::PathGenerator.new(edge).generate
-          end
-
-          aggregator = Aggregator.new(side_lines.flatten)
-          aggregator.dedup!.deoverlap!.dedup!
-          self.notches << aggregator.lines
-        end
-        self.notches.flatten!
-      end
-
-      def w; dim.w; end
-      def h; dim.h; end
-      def d; dim.d; end
-
       def longest
-        [w, h, d].max()
+        [w, h, d].max
       end
 
       def to_s
@@ -104,6 +75,37 @@ module Laser
 
       private
 
+      def create_face_edges(face, face_index)
+        bound      = face_bounding_rect(face)
+
+        side_lines = []
+        edges      = []
+        bound.sides.each_with_index do |bounding_side, side_index|
+          include_corners = (self.conf[:corners][corner_face][face_index] == :yes && side_index.odd?)
+          key             = side_index.odd? ? :valign : :halign
+          center_out      = (self.conf[key][face_index] == :out)
+          edges << Notching::Edge.new(bounding_side, face.sides[side_index],
+                                      { :notch_width => notch_width,
+                                        :thickness   => thickness,
+                                        :kerf        => kerf,
+                                        :center_out  => center_out,
+                                        :corners     => include_corners
+                                      })
+        end
+
+        if edges.any? {|e| e.corners} && !edges.all? {|e| e.first_notch_out?}
+          edges.each {|e| e.adjust_corners = true}
+        end
+
+        edges.each do |edge|
+          side_lines << Notching::PathGenerator.new(edge).generate
+        end
+
+        aggregator = Aggregator.new(side_lines.flatten)
+        aggregator.dedup!.deoverlap!.dedup!
+        self.notches << aggregator.lines
+      end
+
       def face_bounding_rect(face)
         b = face.clone
         b.move_to(b.position.plus(-thickness, -thickness))
@@ -141,39 +143,39 @@ module Laser
         left.x  = offset_x - d - 2 * thickness - padding
         right.x = offset_x + w + 2 * thickness + padding
 
-        [bottom, front, top, back].each { |s| s.x = offset_x }
+        [bottom, front, top, back].each {|s| s.x = offset_x}
 
         # Y Coordinate
         top.y    = offset_y - d - 2 * thickness - padding
         bottom.y = offset_y + h + 2 * thickness + padding
         back.y   = bottom.y + d + 2 * thickness + padding
 
-        [left, front, right].each { |s| s.y = offset_y }
+        [left, front, right].each {|s| s.y = offset_y}
 
         faces.each(&:relocate!)
       end
 
       def create_faces!
-        zero = Geometry::Point.new(0, 0)
+        zero       = Geometry::Point.new(0, 0)
         self.front = Geometry::Rect.create(zero, dim.w, dim.h, "front")
-        self.back = Geometry::Rect.create(zero, dim.w, dim.h, "back")
+        self.back  = Geometry::Rect.create(zero, dim.w, dim.h, "back")
 
-        self.top = Geometry::Rect.create(zero, dim.w, dim.d, "top")
+        self.top    = Geometry::Rect.create(zero, dim.w, dim.d, "top")
         self.bottom = Geometry::Rect.create(zero, dim.w, dim.d, "bottom")
 
-        self.left = Geometry::Rect.create(zero, dim.d, dim.h, "left")
+        self.left  = Geometry::Rect.create(zero, dim.d, dim.h, "left")
         self.right = Geometry::Rect.create(zero, dim.d, dim.h, "right")
       end
 
       # Choose which face will be responsible for filling out the little square overlap
       # in the corners. Only one of the 3 possible sides need to be picked.
       def pick_corners_face
-        b = face_bounding_rect(front)
+        b     = face_bounding_rect(front)
         edges = []
         front.sides[0..1].each_with_index do |face, index|
-          edges << Notching::Edge.new(b.sides[index], face, :notch_width => notch_width, :kerf => kerf )
+          edges << Notching::Edge.new(b.sides[index], face, :notch_width => notch_width, :kerf => kerf)
         end
-        edges.map(&:notch_count).all?{|c| c % 4 == 3} ? :top : :front
+        edges.map(&:notch_count).all? {|c| c % 4 == 3} ? :top : :front
       end
 
     end

data/lib/laser-cutter/face.rb

@@ -0,0 +1,18 @@
+require 'forwardable'
+module Laser
+  module Cutter
+    # Note: this class badly needs refactoring and tests.  Both are coming.
+
+
+    class Face
+      attr_accessor :edges, :rect
+      extend Forwardable
+      def_delegators :@rect, *((Geometry::Rect.new(Geometry::Point.new(0,0), Geometry::Point.new(1,1))).methods - Object.methods)
+      def initialize(rect, edges = [])
+        self.rect  = rect
+        self.edges = edges
+      end
+    end
+
+  end
+end

data/lib/laser-cutter/notching.rb

@@ -5,6 +5,5 @@ module Laser
   end
 end
 
-require_relative 'notching/base'
 require_relative 'notching/edge'
 require_relative 'notching/path_generator'

data/lib/laser-cutter/notching/edge.rb

@@ -32,8 +32,8 @@ module Laser
           self.notch_width = options[:notch_width]
           self.adjust_corners = options[:adjust_corners]
 
-          adjust_for_kerf!
           calculate_notch_width!
+          adjust_for_kerf!
         end
 
         def adjust_for_kerf!
@@ -68,11 +68,11 @@ module Laser
         private
 
         def calculate_notch_width!
-          length = kerf? ? self.inside.length - kerf : self.inside.length
-          count = (length / notch_width).to_f.ceil + 1
+          count = ((self.inside.length) / notch_width).to_f.ceil + 1
           count = (count / 2 * 2) + 1 # make count always an odd number
           count = [MINIMUM_NOTCHES_PER_SIDE, count].max
-          self.notch_width = 1.0 * length / count
+
+          self.notch_width = 1.0 * (self.inside.length) / count
           self.notch_count = count
         end
 

data/lib/laser-cutter/notching/path_generator.rb

@@ -32,6 +32,17 @@ module Laser
         end
       end
 
+      # One of the key "tricks" that this algorithm applies, is that it converts everything into
+      # pure set of lines in the end. It then tries to find all intersections of the lines so that
+      # we can remove duplicates.  So any segment of any line that is covered by 2 lines or more is removed,
+      # cleared completely for an empty space.  This turns out to be very useful indeed, because we can
+      # paint with wide brush strokes to get the carcass, and then fine tune it by adding or removing line
+      # segments.  Some of the lines below are added to actually remove the lines that might have otherwise
+      # been there.
+      #
+      # This comes especially handy when drawing corner boxes, which are deliberately made not to match the notch
+      # width, but to match thickness of the material.  The corner notces for these sides will therefore have
+      # length equal to the thickness + regular notch length.
       class PathGenerator
 
         extend ::Forwardable
@@ -84,81 +95,23 @@ module Laser
           end
         end
 
+        # These two boxes occupy the corners of the 3D box. They do not match
+        # in width to our notches because they are usually merged with them. Their
+        # size is equal to the thickness of the material (adjusted for kerf)
+        # It's just an aesthetic choice I guess.
         def corner_box_sides
           boxes = []
           extra_lines = []
-          sides = []
 
-          # These two boxes occupy the corners of the 3D box. They do not match
-          # in width to our notches because they are usually merged with them.
-          # It's just an aesthetic choice I guess.
           boxes << Geometry::Rect[edge.inside.p1.clone, edge.outside.p1.clone]
           boxes << Geometry::Rect[edge.inside.p2.clone, edge.outside.p2.clone]
 
-          if kerf?
-            if adjust_corners
-              if first_notch_out?
-                k = 2
-                direction = -1
-                dim_index = 1
-                extra_lines << add_corners_when_out(dim_index, direction, k)
-              else
-                k = -2
-                direction = 1
-                dim_index = 0
-                extra_lines << add_boxes_when_in(dim_index, direction, k)
-              end
-            end
-          end
+          extra_lines << add_corners if adjust_corners && kerf?
           sides = boxes.flatten.map(&:relocate!).map(&:sides)
           sides << extra_lines if !extra_lines.empty?
           sides.flatten
         end
 
-        def add_boxes_when_in(dim_index, direction, k)
-          v1 = k * direction * shift_vector(1, dim_index)
-          v2 = k * direction * shift_vector(2, dim_index)
-          p1 = edge.inside.p1.plus(v1)
-          coords = []
-          coords[d_index_along] = edge.inside.p1[d_index_along]
-          coords[d_index_across] = edge.outside.p1[d_index_across]
-          p2 = Geometry::Point[*coords]
-          r1 = Geometry::Rect[p1, p2]
-
-          p1 = edge.inside.p2.plus(v2)
-          coords = []
-          coords[d_index_along] = edge.inside.p2[d_index_along]
-          coords[d_index_across] = edge.outside.p2[d_index_across]
-          p2 = Geometry::Point[*coords]
-          r2 = Geometry::Rect[p1, p2]
-          lines = [r1, r2].map(&:sides).flatten
-          lines << Geometry::Line[edge.inside.p1.plus(v1), edge.inside.p1.clone]
-          lines << Geometry::Line[edge.inside.p2.plus(v2), edge.inside.p2.clone]
-          lines
-        end
-
-        def add_corners_when_out(dim_index, direction, k)
-          v1 = direction * k * shift_vector(1, dim_index)
-          v2 = direction * k * shift_vector(2, dim_index)
-          p1 = edge.inside.p1.plus(v1)
-          coords = []
-          coords[d_index_along] = edge.outside.p1[d_index_along]
-          coords[d_index_across] = edge.inside.p1[d_index_across]
-          p2 = Geometry::Point[*coords]
-          r1 = Geometry::Rect[p1, p2]
-
-          p1 = edge.inside.p2.plus(v2)
-          coords = []
-          coords[d_index_along] = edge.outside.p2[d_index_along]
-          coords[d_index_across] = edge.inside.p2[d_index_across]
-          p2 = Geometry::Point[*coords]
-          r2 = Geometry::Rect[p1, p2]
-          lines = [r1, r2].map(&:sides).flatten
-          lines << Geometry::Line[edge.inside.p1.plus(v1), edge.inside.p1.clone]
-          lines << Geometry::Line[edge.inside.p2.plus(v2), edge.inside.p2.clone]
-          lines
-        end
-
         def shift_vector(index, dim_shift = 0)
           shift = []
           shift[(d_index_across + dim_shift) % 2] = 0
@@ -189,6 +142,38 @@ module Laser
         end
 
         private
+        # Helper method to calculate dimensions of our corners.
+        def add_corners
+          k, direction, dim_index, edge_along, edge_across = if first_notch_out?
+            [2, -1, 1, :inside, :outside]
+          else
+            [-2, 1, 0, :outside, :inside]
+          end
+          v1 = direction * k * shift_vector(1, dim_index)
+          v2 = direction * k * shift_vector(2, dim_index)
+
+          r1 = define_corner_rect(:p1, v1, edge_along, edge_across)
+          r2 = define_corner_rect(:p2, v2, edge_along, edge_across)
+
+          lines = [r1, r2].map(&:sides).flatten
+
+          # Our clever algorithm removes automatically duplicate lines. These lines
+          # below are added to actually clear out this space and remove the existing
+          # lines that are already there.
+          lines << Geometry::Line[edge.inside.p1.plus(v1), edge.inside.p1.clone]
+          lines << Geometry::Line[edge.inside.p2.plus(v2), edge.inside.p2.clone]
+          lines
+        end
+
+        def define_corner_rect(point, delta, edge_along, edge_across)
+          p1 = edge.inside.send(point).plus(delta)
+          coords = []
+          coords[d_index_along] = edge.send(edge_along).send(point)[d_index_along]
+          coords[d_index_across] = edge.send(edge_across).send(point)[d_index_across]
+          p2 = Geometry::Point[*coords]
+          Geometry::Rect[p1, p2]
+        end
+
 
         # This method has the bulk of the logic: we create the list of path deltas
         # to be applied when we walk the edge next.

data/lib/laser-cutter/version.rb

@@ -1,5 +1,5 @@
 module Laser
   module Cutter
-    VERSION = "1.0.3"
+    VERSION = '1.0.5'
   end
 end

data/spec/box_spec.rb

@@ -34,7 +34,6 @@ module Laser
           expect(box2.enclosure.to_a.flatten.map(&:round)).to eql([0,0, 232, 317])
         end
       end
-
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,16 +5,12 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
-if ENV['CODECLIMATE_REPO_TOKEN']
-  require 'codeclimate-test-reporter'
-  CodeClimate::TestReporter.start
-end
-
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __FILE__)
 require 'rubygems'
 require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'simplecov'
+SimpleCov.start
 require 'laser-cutter'
-require "codeclimate-test-reporter"
 
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: laser-cutter
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-01 00:00:00.000000000 Z
+date: 2018-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -53,21 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-legacy_formatters
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,6 +136,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- BOXMAKER.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -143,7 +144,7 @@ files:
 - README.md
 - Rakefile
 - bin/laser-cutter
-- doc/comparison.jpg
+- docs/comparison.jpg
 - laser-cutter.gemspec
 - lib/laser-cutter.rb
 - lib/laser-cutter/aggregator.rb
@@ -151,6 +152,7 @@ files:
 - lib/laser-cutter/cli/opt_parser.rb
 - lib/laser-cutter/cli/serializer.rb
 - lib/laser-cutter/configuration.rb
+- lib/laser-cutter/face.rb
 - lib/laser-cutter/geometry.rb
 - lib/laser-cutter/geometry/dimensions.rb
 - lib/laser-cutter/geometry/point.rb
@@ -159,7 +161,6 @@ files:
 - lib/laser-cutter/geometry/shape/rect.rb
 - lib/laser-cutter/geometry/tuple.rb
 - lib/laser-cutter/notching.rb
-- lib/laser-cutter/notching/base.rb
 - lib/laser-cutter/notching/edge.rb
 - lib/laser-cutter/notching/path_generator.rb
 - lib/laser-cutter/page_manager.rb
@@ -203,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Creates notched box outlines for laser-cut boxes which are geometrically
@@ -221,4 +222,3 @@ test_files:
 - spec/rect_spec.rb
 - spec/renderer_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/laser-cutter/notching/base.rb

@@ -1,13 +0,0 @@
-module Laser::Cutter::Notching
-  class Base
-    attr_accessor :edge
-
-    def initialize(edge)
-      @edge = edge
-    end
-
-    def notches
-      raise 'Abstract method'
-    end
-  end
-end