laser-cutter 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06711815bb7563755b270427de4acb6dc2208777
-  data.tar.gz: 8daa7da0e30ed501f04b5786cf0b31c8b62ec823
+  metadata.gz: 869598bd65fbb14370dcce5b969a19748f246ce2
+  data.tar.gz: 4ce9cc14002201a598b5df25f1ae1a474b4269f6
 SHA512:
-  metadata.gz: 267e0cc220e9e83a0f8a8570429d3f11207d677b5d876831544ac33871fef9ce14daaab7f2594784d4d0a6da1e5161e8299d205d177543a3408ad3ccec42a2b5
-  data.tar.gz: f5c49c5f68fc71df0e84af028086f9a231cf9abfd42c07350bdfc175f3df31bf40469032c30c33ca49a000f5e82764d1e5788db5d42c90de65e6ed91936e71d9
+  metadata.gz: c3b2164cedb8d7af10dfc1beb1482d902f5ce56ae916d32f35cdc289d42d87943567a0d8729f3e793d2844a40c99b27428b5a942b3ddb0b57e4055cc3a7e0266
+  data.tar.gz: 9983e63d47f490f0354159f0ba96ddb086d30c2dc44b62e76f0541529bd1b546693b01100366ac7b0f68c44359b6431c873a4b4ec7fa5a0821dfddc2965edc85

data/README.md

@@ -3,14 +3,23 @@
 [![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)
 
-## LaserCutter
+## LaserCutter and Make-A-Box.io
 
-Similar to [BoxMaker](https://github.com/rahulbot/boxmaker/) (which is written in Java a long time ago), 
-this ruby gem generates PDFs that can be used as a basis for creating a "snap-in" boxes with notched
-sides on a typical laser cutter, by providing dimensions, material thickness and output file name. 
+```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.
 
-For more detailed comparison with BoxMaker and motivation behind this project, please see the section 
-at the bottom of this README.
+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.
+
+[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.
+
+### 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 
@@ -20,13 +29,6 @@ contributing to the project, please see [contributing](CONTRIBUTING.md) for more
 ```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.
   
-## Web Front-End
-
-There is a web online application that uses this gem and allows you to generate PDFs with 
-a friendly UI.
-
-Please visit [http://makeabox.io](http://makeabox.io).
-
 ## Dependencies
 
 The gem depends primarily on [Prawn](http://prawnpdf.org) – a fantastic PDF generation library. 
@@ -118,31 +120,32 @@ Read settings from a previously saved file:
     cat box-settings.json | laser-cutter -O -o box.pdf -R -
 ```
 
-## Future Features
+## 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
-* Create T-style joins, using various standard sizes of nuts and bolts (such as common #4-40 and M2 sizes)
+* 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.
 
-## Comparison with BoxMaker
+## LaserCutter vs BoxMaker
 
-It's important to note that the author believes that BoxMaker is a greatly useful piece of software 
-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 
-concept of programmatically creating laser-cut boxes, provide additional tuning, options, strategies
-and most importantly – extensibility.  
+[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 creating the geometry. 
-In addition, we welcome new feature contributions, or bug fixes from other developers, and in that 
-regard rspecs offer confidence that functionality still works.
+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.
 
-BoxMaker's algorithm _tries to ensures that the same notch length is across all sides, but sacrifices
-symmetry as a result_.  So you may have a front panel's left and right edges be simply non symmetric. 
-And that might be entirely OK with you :)
+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 

data/bin/laser-cutter

@@ -18,7 +18,7 @@ module Laser
 #{('Laser-Cutter v'+ Laser::Cutter::VERSION).bold}
 
 Usage: laser-cutter [options] -o filename.pdf
-   eg: laser-cutter -s 1x1.5x2/0.125/0.125 -O -o box.pdf
+   eg: laser-cutter -s 1x1.5x2/0.125 -O -o box.pdf
         EOF
 
         examples = <<-EOF
@@ -26,7 +26,7 @@ Usage: laser-cutter [options] -o filename.pdf
 Examples:
   1. Create a box defined in inches, and open PDF in preview right after:
 
-       laser-cutter -s 3x2x2/0.125/0.5 -O -o box.pdf
+       laser-cutter -s 3x2x2/0.125 -O -o box.pdf
 
   2. 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:
@@ -59,7 +59,7 @@ Examples:
           opts.on("-h", "--height HEIGHT", "Internal height of the box") { |value| options.height = value }
           opts.on("-d", "--depth DEPTH", "Internal depth of the box") { |value| options.depth= value }
           opts.on("-t", "--thickness THICKNESS", "Thickness of the box material") { |value| options.thickness = value }
-          opts.on("-n", "--notch NOTCH", "Preferred notch length (used only as a guide)") { |value| options.notch = value }
+          opts.on("-n", "--notch NOTCH", "Optional notch length (used as a guide)") { |value| options.notch = value }
           opts.separator ""
           opts.on("-m", "--margin MARGIN", "Margins from the edge of the document") { |value| options.margin = value }
           opts.on("-p", "--padding PADDING", "Space between the boxes on the page") { |value| options.padding = value }
@@ -81,8 +81,8 @@ Examples:
           opts.separator ""
           opts.separator "Common Options:"
           opts.on_tail("-o", "--file FILE", "Required output filename of the PDF") { |value| options.file = value }
-          opts.on_tail("-s", "--size WxHxD/T/N",
-                       "Combined internal dimensions: W = width, H = height,\n#{" " * 37}D = depth, T = thickness, N = notch length\n\n") do |size|
+          opts.on_tail("-s", "--size WxHxD/T[/N]",
+                       "Combined internal dimensions: W = width, H = height,\n#{" " * 37}D = depth, T = thickness, and optional N = notch length\n\n") do |size|
             options.size = size
           end
           opts.on_tail("-u", "--units UNITS", "Either 'in' for inches (default) or 'mm'") { |value| options.units = value }

data/lib/laser-cutter/box.rb

@@ -10,7 +10,7 @@ module Laser
 
       attr_accessor :front, :back, :top, :bottom, :left, :right
       attr_accessor :faces, :bounds, :conf, :corner_face
-      attr_accessor :metadata
+      attr_accessor :metadata, :notches
 
       def initialize(config = {})
         self.dim = Geometry::Dimensions.new(config['width'], config['height'], config['depth'])
@@ -20,6 +20,8 @@ module Laser
         self.padding = config['padding']
         self.units = config['units']
 
+        @notches = []
+
         self.metadata = Geometry::Point[config['metadata_width'] || 0, config['metadata_height'] || 0]
 
         create_faces! # generates dimensions for each side
@@ -36,15 +38,31 @@ module Laser
         self
       end
 
+      def enclosure
+        p1 = notches.first.p1.to_a
+        p2 = notches.first.p2.to_a
+
+        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] }
+        end
 
-      # Returns an flattened array of lines representing notched
-      # rectangle.
+        Geometry::Rect[Geometry::Point.new(p1), Geometry::Point.new(p2)]
+      end
+
+      # Returns an flattened array of lines representing notched lines
       def notches
+        generate_notches! if @notches.empty?
+        @notches
+      end
+
+      def generate_notches!
         position_faces!
 
         corner_face = pick_corners_face
 
-        notches = []
+        @notches = []
         faces.each_with_index do |face, face_index|
           bound = face_bounding_rect(face)
           bound.sides.each_with_index do |bounding_side, side_index |
@@ -54,11 +72,11 @@ module Laser
                                                :fill_corners => (self.conf[:corners][corner_face][face_index] == :yes && side_index.odd?),
                                                :thickness => thickness
             ).path(Geometry::Edge.new(bounding_side, face.sides[side_index], self.notch_width))
-            notches << path.create_lines
+            @notches << path.create_lines
           end
         end
 
-        Geometry::PathGenerator.deduplicate(notches.flatten.sort)
+        @notches = Geometry::PathGenerator.deduplicate(@notches.flatten.sort)
       end
 
       def w; dim.w; end

data/lib/laser-cutter/configuration.rb

@@ -17,8 +17,8 @@ module Laser
 
       UNIT_SPECIFIC_DEFAULTS = {
           'mm' => {
-              margin: 5,
-              padding: 5,
+              margin: 3,
+              padding: 2,
               stroke: 0.0254,
           },
           'in' => {
@@ -28,8 +28,7 @@ module Laser
           }
       }
 
-
-      SIZE_REGEXP = /[\d\.]+x[\d\.]+x[\d\.]+\/[\d\.]+\/[\d\.]+/
+      SIZE_REGEXP = /[\d\.]+x[\d\.]+x[\d\.]+\/[\d\.]+(\/[\d\.]+)?/
 
       FLOATS = %w(width height depth thickness notch margin padding stroke)
       NON_ZERO = %w(width height depth thickness stroke)
@@ -51,6 +50,7 @@ module Laser
           self[k] = self[k].to_f if (self[k] && self[k].is_a?(String))
         end
         self.merge!(UNIT_SPECIFIC_DEFAULTS[self['units']].merge(self))
+        self['notch'] = self['thickness'] * 3.0 if self['thickness'] && self['notch'].nil?
       end
 
       def validate!
@@ -67,6 +67,7 @@ module Laser
         return if (self.units.eql?(new_units) || !UNIT_SPECIFIC_DEFAULTS.keys.include?(new_units))
         k = (self.units == 'in') ? 25.4 : 0.039370079
         FLOATS.each do |field|
+          next if self.send(field.to_sym).nil?
           self.send("#{field}=".to_sym, (self.send(field.to_sym) * k).round(5))
         end
         self.units = new_units

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

@@ -34,7 +34,7 @@ module Laser
         # Removes the items from the list that appear more than once
         # Unlike uniq-ing which keeps all elements, just ensures that are not
         # repeated, here we remove elements completely if they are seen more than once.
-        # This is used to remove lines
+        # This is used to remove lines that join the same two points.
         def self.deduplicate list
           new_list = []
           list.sort!
@@ -53,9 +53,6 @@ module Laser
           @notch_width = options[:notch_width]    # only desired, will be adapted for each line
           @center_out = options[:center_out]      # when true, the notch in the middle of the edge is out, not in.
           @thickness = options[:thickness]
-
-          # 2D array of booleans.  If true first or second end of the edge is
-          # created with a corner filled in.
           @fill_corners = options[:fill_corners]
         end
 

data/lib/laser-cutter/geometry/shape/rect.rb

@@ -46,11 +46,13 @@ module Laser
           p2.y - p1.y
         end
 
-
         def to_s
           "#{sprintf "%3d", w}(w)x#{sprintf "%3d", h}(h) @ #{position.to_s}"
         end
 
+        def to_a
+          [[p1.x, p1.y], [p2.x, p2.y]]
+        end
       end
 
     end

data/lib/laser-cutter/geometry/tuple.rb

@@ -36,7 +36,7 @@ module Laser
         end
 
         def to_a
-          self.coords
+          self.coords.clone
         end
 
         def to_s

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

@@ -1,6 +1,9 @@
 module Laser
   module Cutter
     module Renderer
+      # subject is what we are rendering
+      # enclosure is the rectangle enclosing our subject's rendered image
+      # page_manager contains access to units and page sizes
       class Base
         BLACK = "000000"
         BLUE = "4090E0"

data/lib/laser-cutter/renderer/box_renderer.rb

@@ -16,6 +16,9 @@ module Laser
           box.metadata = Geometry::Point.new(coords)
         end
 
+        def enclosure
+          box.enclosure
+        end
 
         def render pdf = nil
           renderer = self

data/lib/laser-cutter/renderer/layout_renderer.rb

@@ -6,18 +6,20 @@ module Laser
       class LayoutRenderer < Base
         def initialize(config)
           self.config = config
+          super(config)
         end
 
         def render
           renderer = self
 
+          margin = config.margin.to_f.send(config.units.to_sym)
           meta_renderer = MetaRenderer.new(config)
           box_renderer = BoxRenderer.new(config)
           box_renderer.ensure_space_for(meta_renderer.enclosure) if config.metadata
 
-          page_size = config.page_size || 'LETTER' # TODO: auto-detect page size based on box dimensions.
+          page_size = config.page_size || calculate_image_boundary(box_renderer, margin)
 
-          pdf = Prawn::Document.new(:margin => config.margin.to_f.send(config.units.to_sym),
+          pdf = Prawn::Document.new(:margin => margin,
                                     :page_size => page_size,
                                     :page_layout => config.page_layout.to_sym)
 
@@ -34,6 +36,12 @@ module Laser
           end
         end
 
+        def calculate_image_boundary(box_renderer, margin)
+          box_renderer.enclosure.to_a[1].map do |c|
+            c.send(config.units.to_sym) + 2 * margin
+          end
+        end
+
       end
     end
   end

data/lib/laser-cutter/renderer/meta_renderer.rb

@@ -23,11 +23,12 @@ class Laser::Cutter::Renderer::MetaRenderer < Laser::Cutter::Renderer::Base
 
     metadata = config.to_hash
     metadata.delete_if { |k| %w(verbose metadata open file).include?(k) }
+    metadata['page_size'] ||= 'custom'
 
     rect = self.enclosure
 
     pdf.instance_eval do
-      self.line_width = 0.5.mm
+      self.line_width = 0.2.mm
       float do
         bounding_box([rect.p1.x, rect.h + rect.p1.y], :width => rect.w, :height => rect.h) do
           stroke_color meta_color

data/lib/laser-cutter/version.rb

@@ -1,5 +1,5 @@
 module Laser
   module Cutter
-    VERSION = "0.5.1"
+    VERSION = "0.5.3"
   end
 end

data/spec/box_spec.rb

@@ -3,7 +3,7 @@ require_relative 'spec_helper'
 module Laser
   module Cutter
     describe Box do
-      let(:config) { {'width' => 50, 'height' => 60, 'depth' => 70, 'margin' => 5, 'padding' => 3 } }
+      let(:config) { {'width' => 50, 'height' => 60, 'depth' => 70, 'margin' => 5, 'padding' => 3, 'units' => 'mm'} }
       let(:box1) { Box.new(config.merge('thickness' => 6, 'notch' => 10)) }
       let(:box2) { Box.new(config.merge('thickness' => 6, )) }
 
@@ -24,6 +24,11 @@ module Laser
           expect(box1.notches).to_not be_nil
           expect(box1.notches.size).to eql(320)
         end
+
+        it 'should properly calculate enclosure' do
+          expect(box1.enclosure.to_a.flatten.map(&:round)).to eql([0,0, 232, 317])
+          expect(box2.enclosure.to_a.flatten.map(&:round)).to eql([0,0, 232, 317])
+        end
       end
 
     end

data/spec/configuration_spec.rb

@@ -24,7 +24,7 @@ module Laser
           end
         end
         context 'zero options' do
-          let(:opts) { {"size" => "2.0x0.0x2/0.125/0.5", "inches" => true, 'file' => '/tmp/a'} }
+          let(:opts) { {"size" => "2.0x0.0x2/0.125/0.5", 'file' => '/tmp/a'} }
           it 'should be able to validate missing options' do
             expect(config.height).to eql(0.0)
             expect { config.validate! }.to raise_error(Laser::Cutter::ZeroValueNotAllowed)
@@ -32,6 +32,15 @@ module Laser
         end
       end
 
+      context 'default values' do
+        let(:opts) { {"size" => "2.0x1.0x2/0.125", 'file' => '/tmp/a'} }
+        it 'should correctly default notch based on thickness' do
+          config.validate!
+          expect(config.thickness).to eql(0.125)
+          expect(config.notch).to eql(config.thickness * 3.0)
+        end
+      end
+
       context 'when invalid units are provided' do
         let(:opts) { {"size" => "2x3x2/0.125/0.5", "units" => 'xx'} }
         it 'should default to inches' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: laser-cutter
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2014-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn