laser-cutter 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbd3a3886b9dfc9351a9843f874b93194f24a96f
+  data.tar.gz: 9409ff279e98f2f723595ca983dd1aa2f6b345d4
+SHA512:
+  metadata.gz: 2619eb894a05c15591d27115b8b6bbc0df9d969727de76dd35f4d91927a1162aeee91c5339f3b27e2b284a6f827a308166de4fa1177d9cdc37ae9d9fc47d8275
+  data.tar.gz: 32f24e47a6434d75b71fdc935a610fe0c0caac431f421e0941ebcc3594c21052391601e272d26b0ebbdbd50d2273fd49d07cc40e2cff0385177e56ec85f499b7

data/.gitignore

@@ -0,0 +1,27 @@
+**.pdf
+**.DS_Store
+**/*.swp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/
+**output.pdf

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: "bundle exec rspec"
+notifications:
+  email:
+    recipients:
+      - kigster@gmail.com
+    on_success: never
+    on_failure: always
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in laser-cutter-cutter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Konstantin Gredeskoul
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Konstantin Gredeskoul
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+[![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)
+
+LaserCutter
+============
+
+Similar to boxmaker, this ruby gem generates PDFs that can be used as a 
+basis for cutting boxes on a typical laser cutter. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'laser-cutter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install laser-cutter
+
+## Usage
+
+```bash
+> gem install bundler
+> git clone https://github.com/kigster/laser-cutter.git
+> cd laser-cutter && bundle
+> bundle exec bin/laser-cutter --help
+Usage: laser-cutter [options]'
+
+   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
+
+
+Specific options:
+    -s, --size WxHxD/T/N             Combined internal dimensions: W = width, H = height,
+                                     D = depth, T = thickness, N = notch length
+
+    -w, --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
+    -n, --notch NOTCH                Preferred notch length (used only as a guide)
+    -o, --file FILE                  Output filename of the PDF
+    -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
+    -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
+    -v, --[no-]verbose               Run verbosely
+
+Common options:
+        --help                       Show this message
+        --version                    Show version
+```       
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/laser-cutter

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'rubygems'
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'laser-cutter'
+require 'laser-cutter/renderer'
+require 'laser-cutter/configuration'
+require 'optparse'
+require 'colored'
+require 'json'
+
+module Laser
+  module Cutter
+    class OptParse
+      def self.parse(args)
+        banner_text = <<-EOF
+Usage: laser-cutter [options]'
+
+   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
+EOF
+
+        options = OpenStruct.new
+        options.verbose = false
+
+        opt_parser = OptionParser.new do |opts|
+          opts.banner = banner_text.cyan
+          opts.separator ""
+          opts.separator "Specific options:"
+
+          opts.on("-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("-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("-o", "--file FILE", "Output filename of the PDF") { |value|  options.file = value }
+
+          opts.on("-u", "--units UNITS", "Either 'mm' (default) or 'in'") { |value|  options.units = 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("-P", "--page_size LETTER", "Page size, see docs on Prawn for more options") { |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("-v", "--[no-]verbose", "Run verbosely") { |v| options.verbose = v }
+
+          opts.separator ""
+          opts.separator "Common options:"
+
+          opts.on_tail("--help", "Show this message") do
+            puts opts
+            exit
+          end
+          opts.on_tail("--version", "Show version") do
+            puts Laser::Cutter::VERSION
+            exit
+          end
+        end
+        opt_parser.parse!(args)
+        options
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        puts opt_parser.help
+        puts
+        puts "#{e.message}".red
+        exit 1
+      end # end parse()
+    end
+  end
+end # class OptParse
+
+options = Laser::Cutter::OptParse.parse(ARGV)
+config = Laser::Cutter::Configuration.new(options.to_h)
+
+if options.verbose
+  puts "Starting with the following configuration:"
+  puts JSON.pretty_generate(config.to_h).green
+end
+
+begin
+  config.validate!
+rescue Exception => e
+  STDERR.puts "\nSorry, #{e}".red
+  STDERR.puts "Try --help for more info..."
+  exit 1
+end
+
+begin
+  box = Laser::Cutter::Box.new(config)
+  Laser::Cutter::Renderer::BoxRenderer.new(box, config).render
+  if config.open
+    `open #{config.file}`
+  end
+rescue Exception => e
+  puts "#{e}".red
+  STDERR.puts "Try --help for more info...".yellow
+  if options.verbose
+    STDERR.puts "Exception: #{e.inspect}".red
+    STDERR.puts e.backtrace.join("\n").red
+  end
+end
+
+

data/laser-cutter.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'laser-cutter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "laser-cutter"
+  spec.version       = Laser::Cutter::VERSION
+  spec.authors       = ['Konstantin Gredeskoul']
+  spec.email         = ["kigster@gmail.com"]
+  spec.summary       = %q{Creates box outlines for laser-cut boxes.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'prawn'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'colored'
+
+  spec.add_development_dependency 'bundler', "~> 1.6"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+end

data/lib/laser-cutter.rb

@@ -0,0 +1,12 @@
+require 'laser-cutter/version'
+require 'laser-cutter/configuration'
+require 'laser-cutter/geometry'
+require 'laser-cutter/box'
+require 'laser-cutter/renderer'
+require 'prawn'
+require 'prawn/measurement_extensions'
+
+module Laser
+  module Cutter
+  end
+end

data/lib/laser-cutter/box.rb

@@ -0,0 +1,136 @@
+module Laser
+  module Cutter
+    class Box
+      # Everything is in millimeters
+
+      attr_accessor :dim, :thickness, :notch_width
+      attr_accessor :padding, :units
+
+      attr_accessor :front, :back, :top, :bottom, :left, :right
+      attr_accessor :faces, :bounds, :conf
+
+      def initialize(config = {})
+        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.padding = config['padding']
+        self.units = config['units']
+
+        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],
+            corners:[ :no,  :yes,  :no,   :yes, :no, :no]
+        }
+
+        self
+      end
+
+      # Returns an flattened array of lines representing notched
+      # rectangle.
+      def notches
+        generate_bounding_boxes!
+
+        notches = []
+
+        faces.each_with_index do |face, face_index|
+          bound = bounds[face_index]
+          bound.sides.each_with_index do |bounding_side, side_index |
+            key = side_index.odd? ? :valign : :halign
+            path = Geometry::PathGenerator.new(:notch_width => notch_width,
+                                               :center_out => (self.conf[key][face_index] == :out) ,
+                                               :fill_corners => (self.conf[:corners][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
+          end
+        end
+
+        Geometry::PathGenerator.deduplicate(notches.flatten.sort)
+      end
+
+      def w; dim.w; end
+      def h; dim.h; end
+      def d; dim.d; end
+
+      def longest
+        [w, h, d].max()
+      end
+
+      def to_s
+        "Box:\nH:#{dim.h} W:#{dim.w} D:#{dim.d}\nThickness:#{thickness}, Notch:#{notch_width}"
+      end
+
+      private
+
+      def generate_bounding_boxes!
+        self.bounds = []
+        self.bounds = faces.map do |face|
+          b = face.clone
+          b.move_to(b.position.move_by(-thickness, -thickness))
+          b.p2 = b.p2.move_by(2 * thickness, 2 * thickness)
+          b.relocate!
+          b
+        end
+      end
+
+      #___________________________________________________________________
+      #
+      #               +-----------------+
+      #               |                 |
+      #               | back:     W x H |
+      #               |                 |
+      #               +-----------------+
+      #               +-----------------+
+      #               | bottom:   W x D |
+      #               +-----------------+
+      #   +--------+  +-----------------+  +--------+
+      #   |        |  |                 |  |        |
+      #   | left   |  | front:    W x H |  | right  |
+      #   | D x H  |  |                 |  | D x H  |
+      #   +--------+  +-----------------+  +--------+
+      #               +-----------------+
+      #               | top   :   W x D |
+      #               +-----------------+
+      #
+      # 0,0
+      #___________________________________________________________________
+
+      def position_faces!
+        offset = padding + d + 3 * thickness
+        left.x = top.y = thickness
+        [bottom, front, top, back].each do |s|
+          s.x = offset
+        end
+
+        right.x = 2 * padding + w + d + 5 * thickness
+        [left, front, right].each do |s|
+          s.y = offset
+        end
+
+        bottom.y = d + 2 * padding + h + 5 * thickness
+        back.y = 3 * padding + 2 * d + h + 7*thickness
+
+        faces.each(&:relocate!)
+
+      end
+
+      def create_faces!
+        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.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.right = Geometry::Rect.create(zero, dim.d, dim.h, "right")
+      end
+
+    end
+  end
+end