laser-cutter 0.2.2 → 0.3.0

data/.gitignore

@@ -10,7 +10,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc

data/CONTRIBUTING.md

@@ -0,0 +1,117 @@
+Contributing to Laser-Cutter
+======================
+
+You're encouraged to submit [pull requests](https://github.com/kigster/laser-cutter/pulls), [propose features and discuss issues](https://github.com/kigster/laser-cutter/issues).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/kigster/laser-cutter) and check out your copy.
+
+```
+git clone https://github.com/contributor/laser-cutter.git
+cd laser-cutter
+git remote add upstream https://github.com/kigster/laser-cutter.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a 
+feature that you want to build. Add to [spec/laser-cutter](spec/laser-cutter).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Make sure that `bundle exec rspec` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/laser-cutter and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+#### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/kigster/laser-cutter/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+#### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/README.md

@@ -1,11 +1,52 @@
 [![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
-============
+## LaserCutter
 
-Similar to boxmaker, this ruby gem generates PDFs that can be used as a 
-basis for cutting boxes on a typical laser cutter. 
+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 cutting boxes on a typical laser cutter. 
+
+Unlike ```BoxMaker```, this gem has a lot of automated tests around creating the geometry of the notches
+and calculating locations. This welcomes additional feature contributions from other developers,
+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.
+ 
+```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.
+
+Finally, ```laser-cutter``` has a ton of 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.
+
+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.
+
+Below are two examples of boxes with identical dimensions produced with ```laser-cutter``` and ```boxmaker```:
+
+#### BoxMaker Example
+
+```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
+```
+
+![BoxMaker Example](doc/boxmaker.jpg).
+
+#### LaserCutter Example
+
+```bash
+> laser-cutter -u in -s 2.5x1x2/0.25/0.5 -o file.pdf
+```
+
+![LaserCutter Example](doc/laser-cutter.jpg).
+
+## 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
+* Your brilliant idea can be here!  Please see [contributing](CONTRIBUTING.md) for more info.
 
 ## Installation
 
@@ -24,7 +65,7 @@ Or install it yourself as:
 ## Usage
 
 ```bash
-> bundle exec laser-cutter --help
+> laser-cutter --help
 Usage: laser-cutter [options]'
 
    eg: laser-cutter --units in -s 2x3x2/0.125/0.5   -o box.pdf'

data/laser-cutter.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   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.summary       = %q{Creates notched box outlines for laser-cut boxes which are geometrically symmetric and pleasing to the eye.}
+  spec.description   = %q{Similar to the older BoxMaker, this ruby gem generates PDFs that can be used as a basis for cutting boxes on a typical laser cutter. The intention was to create an extensible, well tested, and modern ruby gem for generating PDF templates used in laser cutting.}
+  spec.homepage      = "https://github.com/kigster/laser-cutter"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

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

@@ -4,10 +4,7 @@ module Laser
   module Cutter
     module Renderer
       class BoxRenderer < AbstractRenderer
-
-        def box
-          subject
-        end
+        alias_method :box, :subject
 
         def render pdf = nil
           pdf = Prawn::Document.new(:margin => options.margin.send(options.units),

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

@@ -2,9 +2,7 @@ module Laser
   module Cutter
     module Renderer
       class LineRenderer < AbstractRenderer
-        def line
-          subject
-        end
+        alias_method :line, :subject
         def render pdf = nil
           pdf.stroke { pdf.line [line.p1.x, line.p1.y].map{ |p| p.send(units) },
                                 [line.p2.x, line.p2.y].map{ |p| p.send(units) }}

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

@@ -2,9 +2,7 @@ module Laser
   module Cutter
     module Renderer
       class RectRenderer < AbstractRenderer
-        def rect
-          subject
-        end
+        alias_method :rect, :subject
 
         def render pdf
           rect.sides.each do |side|

data/lib/laser-cutter/version.rb

@@ -1,5 +1,5 @@
 module Laser
   module Cutter
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: laser-cutter
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -107,7 +107,10 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+description: Similar to the older BoxMaker, this ruby gem generates PDFs that can
+  be used as a basis for cutting boxes on a typical laser cutter. The intention was
+  to create an extensible, well tested, and modern ruby gem for generating PDF templates
+  used in laser cutting.
 email:
 - kigster@gmail.com
 executables:
@@ -119,12 +122,15 @@ files:
 - .rspec
 - .ruby-version
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/laser-cutter
+- doc/boxmaker.jpg
+- doc/laser-cutter.jpg
 - laser-cutter.gemspec
 - lib/laser-cutter.rb
 - lib/laser-cutter/box.rb
@@ -153,7 +159,7 @@ files:
 - spec/rect_spec.rb
 - spec/renderer_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/kigster/laser-cutter
 licenses:
 - MIT
 post_install_message: 
@@ -177,7 +183,8 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Creates box outlines for laser-cut boxes.
+summary: Creates notched box outlines for laser-cut boxes which are geometrically
+  symmetric and pleasing to the eye.
 test_files:
 - spec/box_spec.rb
 - spec/configuration_spec.rb