laser-cutter 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32ce72abddaaccd285d8dbcbf03b9a7644bf0a91
-  data.tar.gz: df1bfc141e15b055e054dd70cbf921460f663ce2
+  metadata.gz: d78af71d854c6d20420b751eab1db6f8ab0052dc
+  data.tar.gz: 36373b9a7e2858dc489aa2c7ba4489f7db044b0e
 SHA512:
-  metadata.gz: 14f27fcf968d47af5505d7430022c02b6b69c33aec68102822ad5b80bb6915e44783509e94e4e169b8ee5af840fdc1173116138b239ac184cb52521d99e5ab13
-  data.tar.gz: 90c95f1f44c2ae2f0f15ae978faf130e2a3a62316bf405a719ef70fd26354695f0e905eedf9f440d2d3d591a5ec48ad8cf839c4302ee4fca1c449c217516498a
+  metadata.gz: 9e7ad6c1861371edf9e00856c68f79e9ccc0833918d442f42270b57afd4751fa0a462701ce280ec2e781d2a178a3236c5b3e518da9c5699930f2103af0ff63ec
+  data.tar.gz: 3bade22e2009f8ac1d1dbd2efb9c195323e6a66d094ff5e742b56a1457dee2e28f79b5d111cda64942ec66e7e1f4571dfa0dbcbdc3a27321ffed8732c7aa1717

data/README.md

@@ -45,22 +45,25 @@ Usage: laser-cutter [options] -o filename.pdf
    eg: laser-cutter -i -s 1x1.5x2/0.125/0.125 -O -o box.pdf
 
 Specific Options:
-    -w, --width WIDTH                Internal width of the box
+        --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
+        --thickness THICKNESS        Thickness of the box material
     -n, --notch NOTCH                Preferred notch length (used only as a guide)
 
     -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
-    -P, --page_size LETTER           Page size, see --list-all-page-sizes for more info.
-    -L, --page_layout portrait       Page layout, other option is 'landscape'
+    -t, --stroke WIDTH               Numeric stroke width of the line
+    -z, --page_size LETTER           Page size, see --list-all-page-sizes for more info.
+    -y, --page_layout portrait       Page layout, other option is 'landscape'
 
     -O, --open                       Open generated file with system viewer before exiting
+    -w, --write FILE                 Save current configuration to a file, use '-' for STDOUT
+    -r, --read FILE                  Read configuration from a file, use '-' for STDIN
     -u, --units UNITS                Either 'mm' (default) or 'in'
 
-    -A, --list-all-page-sizes        Print all available page sizes with dimensions and exit
+    -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
 
         --examples                   Show detailed usage examples

data/bin/laser-cutter

@@ -19,7 +19,7 @@ module Laser
 
 Usage: laser-cutter [options] -o filename.pdf
    eg: laser-cutter -i -s 1x1.5x2/0.125/0.125 -O -o box.pdf
-EOF
+        EOF
 
         examples = <<-EOF
 
@@ -37,7 +37,7 @@ Examples:
 
        laser-cutter --list-all-page-sizes
        laser-cutter --list-all-page-sizes --inches
-EOF
+        EOF
         options = Hashie::Mash.new
         options.verbose = false
         options.units = 'mm'
@@ -45,40 +45,46 @@ EOF
         opt_parser = OptionParser.new do |opts|
           opts.banner = banner_text.blue
           opts.separator "Specific Options:"
-          opts.on("-w", "--width WIDTH", "Internal width of the box") { |value|  options.width = value }
-          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("-w", "--width WIDTH", "Internal width of the box") { |value| options.width = value }
+          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.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 }
-          opts.on("-S", "--stroke WIDTH", "Numeric stroke width of the line") { |value|  options.stroke = 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("-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("-t", "--stroke WIDTH", "Numeric stroke width of the line") { |value| options.stroke = value }
+          opts.on("-z", "--page_size LETTER", "Page size, see --list-all-page-sizes for more info.") { |value| options.page_size = value }
+          opts.on("-y", "--page_layout portrait", "Page layout, other option is 'landscape' ") { |value| options.page_layout = value }
           opts.separator ""
           opts.on("-O", "--open", "Open generated file with system viewer before exiting") { |v| options.open = v }
-          opts.on("-u", "--units UNITS", "Either 'mm' (default) or 'in'") { |value|  options.units = value }
+          opts.on("-w", "--write FILE", "Save current configuration to a file, use '-' for STDOUT") { |v| options.write_file = v }
+          opts.on("-r", "--read FILE", "Read configuration from a file, use '-' for STDIN") { |v| options.read_file = v }
+          opts.on("-u", "--units UNITS", "Either 'mm' (default) or 'in'") { |value| options.units = value }
           opts.separator ""
-          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("-l", "--list-all-page-sizes", "Print all available page sizes with dimensions and exit") { |v| options.list_all_page_sizes = true }
+          opts.on("-M", "--no-metadata", "Do not print box metadata on the PDF") { |value| options.metadata = value }
           opts.on("-v", "--[no-]verbose", "Run verbosely") { |v| options.verbose = v }
-          opts.on("-m", "--[no-]metadata", "Print to the PDF metadata") { |value| options.metadata = value }
           opts.separator ""
-          opts.on("--examples", "Show detailed usage examples") {  puts opts; puts examples.yellow; exit  }
+          opts.on("--examples", "Show detailed usage examples") { puts opts; puts examples.yellow; exit }
           opts.on("--help", "Show this message") { puts opts; exit }
-          opts.on("--version", "Show version") {  puts Laser::Cutter::VERSION; exit }
+          opts.on("--version", "Show version") { puts Laser::Cutter::VERSION; exit }
           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("-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|
             options.size = size
           end
-          opts.on_tail("-i", "--inches", "Switch measurements to inches instead of millimeters") { |value|  options.units = 'in' }
+          opts.on_tail("-i", "--inches", "Switch measurements to inches instead of millimeters") { |value| options.units = 'in' }
         end
 
         opt_parser.parse!(args)
 
+        if options.read_file
+          read_options_from_file(options)
+        end
+
         config = Laser::Cutter::Configuration.new(options.to_hash)
         if config.list_all_page_sizes
           puts config.all_page_sizes
@@ -91,12 +97,52 @@ EOF
         end
 
         config.validate!
+
+        if config.write_file
+          write_options_to_file(config)
+        end
+
         config
       rescue OptionParser::InvalidOption, OptionParser::MissingArgument, Laser::Cutter::MissingOption => e
         puts opt_parser.banner.blue
         puts_error(e)
         exit 1
-      end # end parse()
+      end
+
+      def self.read_options_from_file(options)
+        string = if options.read_file.eql?('-')
+                   $stdin.read
+                 elsif File.exist?(options.read_file)
+                   File.read(options.read_file)
+                 end
+        if string
+          options.replace(JSON.load(string))
+        end
+      rescue Exception => e
+        STDERR.puts "Error reading options from file #{options.read_file}, #{e.message}".red
+        if options.verbose
+          STDERR.puts e.backtrace.join("\n").red
+        end
+        exit 1
+      end
+
+      def self.write_options_to_file(options)
+        output = if options.write_file.eql?('-')
+                   $stdout
+                 elsif options.write_file
+                   File.open(options.write_file, 'w')
+                 else
+                   nil
+                 end
+        output.puts(JSON.pretty_generate(options))
+        output.close if output != $stdout
+      rescue Exception => e
+        STDERR.puts "Error writing options to file #{options.write_file}, #{e.message}".red
+        if options.verbose
+          STDERR.puts e.backtrace.join("\n").red
+        end
+        exit 1
+      end
     end
   end
 end # class OptParse

data/lib/laser-cutter/box.rb

@@ -10,6 +10,7 @@ module Laser
 
       attr_accessor :front, :back, :top, :bottom, :left, :right
       attr_accessor :faces, :bounds, :conf, :corner_face
+      attr_accessor :metadata
 
       def initialize(config = {})
         self.dim = Geometry::Dimensions.new(config['width'], config['height'], config['depth'])
@@ -19,11 +20,11 @@ module Laser
         self.padding = config['padding']
         self.units = config['units']
 
+        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]
 
-        position_faces!
-
         self.conf   = {
             valign: [    :out, :out,  :out,   :out, :in, :in],
             halign: [    :in,  :out,  :in,    :out, :in, :in],
@@ -39,6 +40,8 @@ module Laser
       # Returns an flattened array of lines representing notched
       # rectangle.
       def notches
+        position_faces!
+
         corner_face = pick_corners_face
 
         notches = []
@@ -93,7 +96,7 @@ module Laser
       #   |        |  |                 |  |        |
       #   | left   |  | front:    W x H |  | right  |
       #   | D x H  |  |                 |  | D x H  |
-      #   +--------+  +-----------------+  +--------+
+      #   +--------+  X-----------------+  +--------+
       #               +-----------------+
       #               | top   :   W x D |
       #               +-----------------+
@@ -102,22 +105,23 @@ module Laser
       #___________________________________________________________________
 
       def position_faces!
-        offset = padding + d + 3 * thickness
-        left.x = top.y = thickness
-        [bottom, front, top, back].each do |s|
-          s.x = offset
-        end
+        offset_x = [padding + d + 3 * thickness, metadata.x + 2 * thickness + padding].max
+        offset_y = [padding + d + 3 * thickness, metadata.y + 2 * thickness + padding].max
 
-        right.x = 2 * padding + w + d + 5 * thickness
-        [left, front, right].each do |s|
-          s.y = offset
-        end
+        # X Coordinate
+        left.x  = offset_x - d - 2 * thickness - padding
+        right.x = offset_x + w + 2 * thickness + padding
 
-        bottom.y = d + 2 * padding + h + 5 * thickness
-        back.y = 3 * padding + 2 * d + h + 7*thickness
+        [bottom, front, top, back].each { |s| s.x = offset_x }
 
-        faces.each(&:relocate!)
+        # 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 }
+
+        faces.each(&:relocate!)
       end
 
       def create_faces!

data/lib/laser-cutter/configuration.rb

@@ -29,6 +29,7 @@ module Laser
           }
       }
 
+
       SIZE_REGEXP = /[\d\.]+x[\d\.]+x[\d\.]+\/[\d\.]+\/[\d\.]+/
 
       FLOATS = %w(width height depth thickness notch margin padding stroke)
@@ -64,18 +65,33 @@ module Laser
       end
 
       def page_size_values
-        unit = 1.0 / 72.0 # PDF units per inch
-        multiplier = (self.units == 'in') ? 1.0 : 25.4
         h = PDF::Core::PageGeometry::SIZES
         array = []
         h.keys.sort.each do |k|
-          array << [ k,
-                      multiplier * h[k][0].to_f * unit,
-                      multiplier * h[k][1].to_f * unit ]
+          array << [k, value_from_units(h[k][0].to_f), value_from_units(h[k][1].to_f)]
         end
         array
       end
 
+      # if from_units is nil, we expect it to be in dots per inch (default
+      # measurements for Prawn
+      def value_from_units value, from_units = nil
+        multiplier = if from_units.nil?
+                       if units.eql?('in')
+                         1.0 / 72.0 # PDF units per inch
+                       else
+                         25.4 * 1.0 / 72.0
+                       end
+                     elsif self.units.eql?(from_units)
+                       1.0
+                     elsif self.units.eql?('in') && from_units.eql?('mm')
+                       (1.0 / 25.4)
+                     else
+                       25.4
+                     end
+        value.to_f * multiplier
+      end
+
       def all_page_sizes
         output = ""
         page_size_values.each do |k|

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

@@ -11,10 +11,16 @@ module Laser
         def x= value
           position.x = value
         end
+        def x
+          position.x
+        end
 
         def y= value
           position.y = value
         end
+        def y
+          position.y
+        end
 
         def move_to new_point
           self.position = new_point

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

@@ -6,6 +6,8 @@ module Laser
       class BoxRenderer < AbstractRenderer
         alias_method :box, :subject
 
+        META_RECT = Geometry::Rect.create(Geometry::Point[0, 0], 140, 150)
+
         def initialize(options = {})
           self.options = options
           self.subject = Laser::Cutter::Box.new(options)
@@ -27,15 +29,19 @@ module Laser
 
           renderer = self
 
-          meta_color = "406080"
-          meta_top = 150
+          meta_color = "4090E0"
+          meta_top_height = 50
           metadata = renderer.options.to_hash
-          metadata.delete_if { |k| %w(verbose metadata open).include?(k) }
+          metadata.delete_if { |k| %w(verbose metadata open file).include?(k) }
+          if options.metadata
+            coords = [ META_RECT.p2.x, META_RECT.p2.y ].map{|a| options.value_from_units(a)}
+            box.metadata = Geometry::Point.new(coords)
+          end
           pdf.instance_eval do
             self.line_width = renderer.options.stroke.send(renderer.options.units.to_sym)
             if renderer.options.metadata
               float do
-                bounding_box([0, meta_top], :width => 140, :height => 150) do
+                bounding_box([0, META_RECT.h], :width => META_RECT.w, :height => META_RECT.h) do
                   stroke_color meta_color
                   stroke_bounds
                   indent 10 do
@@ -44,11 +50,13 @@ module Laser
                     end
                   end
                   float do
-                    bounding_box([0, 100], :width => 140, :height => 100) do
+                    bounding_box([0, META_RECT.h - meta_top_height],
+                                 :width => META_RECT.w,
+                                 :height => META_RECT.h - meta_top_height) do
                       stroke_color meta_color
                       stroke_bounds
                       float do
-                        bounding_box([0, 100], :width => 70, :height => 100) do
+                        bounding_box([0, META_RECT.h - meta_top_height], :width => 70, :height => META_RECT.h - meta_top_height) do
                           indent 10 do
                             font('Helvetica', :size => 6) do
                               out = JSON.pretty_generate(metadata).gsub(/[\{\}",]/, '').gsub(/:.*\n/x, "\n")
@@ -58,7 +66,7 @@ module Laser
                         end
                       end
                       float do
-                        bounding_box([60, 100], :width => 70, :height => 100) do
+                        bounding_box([60, META_RECT.h - meta_top_height], :width => 70, :height => META_RECT.h - meta_top_height) do
                           indent 10 do
                             font('Helvetica', :size => 6) do
                               out = JSON.pretty_generate(metadata).gsub(/[\{\}",]/, '').gsub(/\n?.*:/x, "\n:")

data/lib/laser-cutter/version.rb

@@ -1,5 +1,5 @@
 module Laser
   module Cutter
-    VERSION = "0.4.3"
+    VERSION = "0.5.0"
   end
 end

data/spec/configuration_spec.rb

@@ -17,18 +17,18 @@ module Laser
       end
       context '#validate' do
         context 'missing options' do
-        let(:opts) { {"height" => "23"} }
-        it 'should be able to validate missing options' do
-          expect(config.height).to eql(23.0)
-          expect { config.validate! }.to raise_error(Laser::Cutter::MissingOption)
-        end
+          let(:opts) { {"height" => "23"} }
+          it 'should be able to validate missing options' do
+            expect(config.height).to eql(23.0)
+            expect { config.validate! }.to raise_error(Laser::Cutter::MissingOption)
+          end
         end
         context 'zero options' do
-        let(:opts) { {"size" => "2.0x0.0x2/0.125/0.5", "inches" => true, '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)
-        end
+          let(:opts) { {"size" => "2.0x0.0x2/0.125/0.5", "inches" => true, '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)
+          end
         end
       end
       context '#list_page_sizes' do
@@ -48,36 +48,56 @@ module Laser
         end
       end
 
-      context "#default to mm for incorrect units" do
+      context 'when invalid units are provided' do
         let(:opts) { {"size" => "2x3x2/0.125/0.5", "units" => 'xx'} }
         it 'should default to millimeters' do
           expect(config.units).to eql('mm')
         end
       end
 
-      context "#change_units" do
-        context "from inches" do
-          let(:opts) { {"size" => "2.0x3x2/0.125/0.5", 'padding' => '4.2', "units" => 'in'} }
-          it "should convert to mm" do
-            expect(config.width).to eql(2.0)
-            config.change_units('in')
-            expect(config.width).to eql(2.0)
-            config.change_units('mm')
-            expect(config.width).to eql(50.8)
-            expect(config.padding).to eql(106.68)
-            expect(config.units).to eql('mm')
+      context 'when converting between units' do
+        context 'a single value' do
+          context 'to inches' do
+            let(:opts) { {'units' => 'in'} }
+            it 'should be correct' do
+              expect(config.value_from_units(150)).to be_within(0.0001).of(150.0/72.0)
+              expect(config.value_from_units(150, 'mm')).to be_within(0.0001).of(150.0/25.4)
+              expect(config.value_from_units(150, 'in')).to be_within(0.0001).of(150.0)
+            end
+          end
+          context 'to mm' do
+            let(:opts) { {'units' => 'mm'} }
+            it 'should be correct' do
+              expect(config.value_from_units(150)).to be_within(0.0001).of(25.4 * 150.0 / 72.0)
+              expect(config.value_from_units(150, 'in')).to be_within(0.0001).of(150.0 * 25.4)
+              expect(config.value_from_units(150, 'mm')).to be_within(0.0001).of(150.0)
+            end
           end
         end
-        context "from mm" do
-          let(:opts) { {"size" => "20.0x30.0x40.0/5/5", 'margin' => '10.0', "units" => 'mm'} }
-          it "should convert to inches" do
-            expect(config.width).to eql(20.0)
-            config.change_units('mm')
-            expect(config.width).to eql(20.0)
-            config.change_units('in')
-            expect(config.width).to be_within(0.00001).of(0.787401575)
-            expect(config.margin).to be_within(0.00001).of(0.393700787)
-            expect(config.units).to eql('in')
+        context 'all config values' do
+          context "to mm" do
+            let(:opts) { {'size' => "2.0x3x2/0.125/0.5", 'padding' => '4.2', "units" => 'in'} }
+            it 'should be correct' do
+              expect(config.width).to eql(2.0)
+              config.change_units('in')
+              expect(config.width).to eql(2.0)
+              config.change_units('mm')
+              expect(config.width).to eql(50.8)
+              expect(config.padding).to eql(106.68)
+              expect(config.units).to eql('mm')
+            end
+          end
+          context 'to inches' do
+            let(:opts) { {'size' => "20.0x30.0x40.0/5/5", 'margin' => '10.0', "units" => 'mm'} }
+            it 'should be correct' do
+              expect(config.width).to eql(20.0)
+              config.change_units('mm')
+              expect(config.width).to eql(20.0)
+              config.change_units('in')
+              expect(config.width).to be_within(0.00001).of(0.787401575)
+              expect(config.margin).to be_within(0.00001).of(0.393700787)
+              expect(config.units).to eql('in')
+            end
           end
         end
       end

metadata

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