laser-cutter 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bf2240e444d50e1c3a40bdeb269a0df9b09a2c3
-  data.tar.gz: df226c09ee93f96b872f57d90e38b8abd4d15131
+  metadata.gz: 281b7861f4452cfb6323f9d2a4a05aff6db5a742
+  data.tar.gz: dd4e65121d84f8a285dd3c603d1674a5505af9f4
 SHA512:
-  metadata.gz: 7aee00b014f159f2b2df9d0c23d2f91c3830116eb3c6f4b3bda34818a38603497c52a253103e162c4d4663f06db01b4ef3e14369e99f8db2945b3d4cbbb8cf12
-  data.tar.gz: 2f1be7e7d1b78c182fb75b1e8597270aae29834a0401a3029d01027468249f600d3a7952afe179395b671296de045a31df86acb98ec219fd51de6120f4917f3e
+  metadata.gz: d42068728244eb2d1125a9f3e759d5c00e1623a15f29e0eede7deb4eb3a5711f717434f81d2c99fd400d346e3e9b6832e47cb932830171b55cc9fa551f0d979a
+  data.tar.gz: 65ab7c551ef9f144dc8f91e9898d526e60ac42246c779cb9d480aea6d2f3e36e44514ccc3ff7ff802bdf30097d34d3127adc4a928ec9fa9bb78317302d0bb104

data/README.md

@@ -12,22 +12,36 @@ and calculating locations. This welcomes additional feature contributions from o
 as existing test suite offers confidence around not introducing bugs or regressions.
 
 BoxMaker's algorithm _ensures that the same notch length is across all sides, but sacrifices
-symmetry as a result_.  So you may have your font panel's left and right sides be pretty different.
+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 :)
  
 ```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 
+identical notch length. Depending on the box dimensions you may end up with a slightly different notch 
 length on each side of the box.
 
-Finally, ```laser-cutter``` has a ton of options, that allow you to set stroke width, page size,
+Having said that, one of the design goals of this ruby version is to provide a highly extensible platform,
+where alternative algorithms can be implemented and supported by command line options.
+
+```laser-cutter``` has quite a few options that allow you to set stroke width, page size,
 layout, margins, padding (spacing between boxes), open the PDF file using system viewer right
-after generation, and many more are coming.
+after generation, and many more are coming soon.
 
 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.
+each program, so you can pick what you prefer. 
+
+#### Disclaimer
+
+Important quick 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 it's viability.  
+In fact BoxMaker was an inspiration for this project. This project simply attempts to advance 
+further and provide additional solutions to this complex problem of creating 3D designs on a 2D
+surface using laser cutter.
+
+### Example Outputs
 
 Below are two examples of boxes with identical dimensions produced with ```laser-cutter``` and ```boxmaker```:
 
-#### BoxMaker Example
+#### BoxMaker 
 
 ```bash
 > java -cp BOX.jar com.rahulbotics.boxmaker.BoxMaker -i -W 2.5 -H 2 -D 1 -T 0.25 -n 0.5 -f file.pdf
@@ -35,7 +49,7 @@ Below are two examples of boxes with identical dimensions produced with ```laser
 
 ![BoxMaker Example](doc/boxmaker.jpg).
 
-#### LaserCutter Example
+#### LaserCutter 
 
 ```bash
 > laser-cutter -u in -s 2.5x1x2/0.25/0.5 -o file.pdf
@@ -45,8 +59,9 @@ Below are two examples of boxes with identical dimensions produced with ```laser
 
 ## Future Features
 
-* Creating T-style holes and spacers for various sized nuts and bolts (such as common #4-40 and M2)
-* Creating lids and front panels that are larger than the box
+* Creating T-style joins, using various sized nuts and bolts (such as common #4-40 and M2 sizes)
+* Creating lids and front panels that are larger than the box 
+* Rendering to CSS to show live preview on a web app
 * Your brilliant idea can be here!  Please see [contributing](CONTRIBUTING.md) for more info.
 
 ## Installation
@@ -66,11 +81,18 @@ Or install it yourself as:
 ## Usage
 
 ```bash
-> laser-cutter --help
-Usage: laser-cutter [options]'
+Usage: laser-cutter [options]
+       laser-cutter --list-all-page-sizes --units in
+
+Examples:
+  1. Create a box defined in inches, and open PDF in preview right after:
+
+       laser-cutter --units in -s 3x2x2/0.125/0.5  -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 2mm:
 
-   eg: laser-cutter --units in -s 2x3x2/0.125/0.5   -o box.pdf'
-       laser-cutter -w 30 -h 20 -d 10 -t 4.3 -n 10  -o box.pdf
+       laser-cutter -w70 -h20 -d50 -t4.3 -n5 -PA3 -L landscape -S 0.5 -v -O -o box.pdf
 
 
 Specific options:
@@ -86,10 +108,11 @@ Specific options:
     -u, --units UNITS                Either 'mm' (default) or 'in'
     -m, --margin MARGIN              Margins from the edge of the document
     -p, --padding PADDING            Space between the boxes on the page
-    -P, --page_size LETTER           Page size, see docs on Prawn for more options
+    -P, --page_size LETTER           Page size, see --list-all-page-sizes for more info.
     -L, --page_layout portrait       Page layout, other option is 'landscape'
     -S, --stroke WIDTH               Numeric stroke width of the line
     -O, --open                       Open generated file with system viewer before exiting
+    -A, --list-all-page-sizes        Print all available page sizes with dimensions and exit
     -v, --[no-]verbose               Run verbosely
 
 Common options:

data/bin/laser-cutter

@@ -10,7 +10,8 @@ module Laser
     class OptParse
       def self.parse(args)
         banner_text = <<-EOF
-Usage: laser-cutter [options]'
+Usage: laser-cutter [options]
+       laser-cutter --list-all-page-sizes --units in
 
 Examples:
   1. Create a box defined in inches, and open PDF in preview right after:
@@ -25,6 +26,7 @@ EOF
 
         options = Hashie::Mash.new
         options.verbose = false
+        options.units = 'mm'
 
         opt_parser = OptionParser.new do |opts|
           opts.banner = banner_text.cyan
@@ -48,11 +50,14 @@ EOF
           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 }
 
-          opts.on("-P", "--page_size LETTER", "Page size, see docs on Prawn for more options") { |value|  options.page_size = value }
+          opts.on("-P", "--page_size LETTER", "Page size, see --list-all-page-sizes for more info.") { |value|  options.page_size = value }
           opts.on("-L", "--page_layout portrait", "Page layout, other option is 'landscape' ") { |value|  options.page_layout = value }
           opts.on("-S", "--stroke WIDTH", "Numeric stroke width of the line") { |value|  options.stroke = value }
 
           opts.on("-O", "--open", "Open generated file with system viewer before exiting") { |v| options.open = v }
+
+          opts.on("-A", "--list-all-page-sizes", "Print all available page sizes with dimensions and exit") { |v| options.list_all_page_sizes = true }
+
           opts.on("-v", "--[no-]verbose", "Run verbosely") { |v| options.verbose = v }
 
           opts.separator ""
@@ -80,6 +85,21 @@ EOF
 end # class OptParse
 
 options = Laser::Cutter::OptParse.parse(ARGV)
+
+if options.list_all_page_sizes
+  puts
+  unit = 1.0 / 72.0 # PDF units per inch
+  multiplier = options.units == 'in' ? 1.0 : 25.4
+  hash = PDF::Core::PageGeometry::SIZES
+  hash.keys.sort.each do |k|
+    printf("\t%10s:\t%6.1f x %6.1f\n",
+           k,
+           multiplier * hash[k][0].to_f * unit,
+           multiplier * hash[k][1].to_f * unit )
+  end
+  exit 0
+end
+
 config = Laser::Cutter::Configuration.new(options.to_hash)
 
 if options.verbose

data/lib/laser-cutter/version.rb

@@ -1,5 +1,5 @@
 module Laser
   module Cutter
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: laser-cutter
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -180,3 +180,4 @@ test_files:
 - spec/rect_spec.rb
 - spec/renderer_spec.rb
 - spec/spec_helper.rb
+has_rdoc: