rubyscad 1.0.6 → 1.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a80caa055d22b7cf20a71065152b13a12ba474f1
+  data.tar.gz: b06afd17a237f675db9eb32e6bfc9b20bcfa507a
+SHA512:
+  metadata.gz: 24bcf312da8902c63ea57d68b8025f954157575ce37cba2f2cefb240534f1bf2000b82a2b9cd7f6dd07277e3c4a53405a616349fbfd9525324388aa648dd8509
+  data.tar.gz: 14080c5a808c586787fabbcd5b7e7bf19e34b8c6093d638564fdc77405b2b203523c9b30b76f4e7df062aabaa2d0601fc3c4cf80ea6ff4a837ce725d5792fd7e

data/.gitignore

@@ -1,21 +1,21 @@
-*.gem
-*.rbc
-.bundle
-.config
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*~
-Gemfile.lock
-doc/
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~
+Gemfile.lock
+doc/
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2013 cjbissonnette
-
-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
+Copyright (c) 2013 cjbissonnette
+
+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

@@ -1,323 +1,323 @@
-RubyScad
-========
-
-Ruby module to easily generate openscad scripts
-
-General Usage
--------------
-
-Requirements: Ruby 1.9.3
-Installation: `gem install rubyscad`
-
-RubyScad is a ruby mixin module which provides functions which allow easy output of openscad scripts .  To use simply "include" or "extend" the module into any class or module:
-
-    require "rubyscad"
-
-    module Test
-
-      extend RubyScad
-
-      def self.cone(base=5, height=10)
-
-        cylinder(r1: base, r2: 0, h:height)
-
-      end
-
-      cone(2, 4)
-    end
-
----
-
-  from command line: 
-
-  print to standard output: `ruby test.rb`
-
-  generate file: `ruby test.rb "test.scad"`
-
----
-
-    require "rubyscad"
-
-    class Test2
-
-      include RubyScad
-
-      def initialize(args={})
-        @radius = args.fetch(:radius, 3)
-      end
-
-      def render()
-        sphere(r:@radius)
-      end
-    end
-
-    Test2.new.render
-
----
-
-  print to standard output: `ruby test2.rb`
-
-  generate file: `ruby test2.rb "test2.scad"`
-
-General Considerations
------------------------
-
-- All arguments are passed as named hash values matching the openscad spec, exceptions are for functions fa, fs, fn, echo, include, and use (see below).  
-  openscad: `cube(6)`  
-  rubyscad: `cube(size: 6)`
-- Any hash values may be passed to functions (with the exception of the ones noted above) but openscad may or may not use these values  
-  *cube(openscadwontusethis: 5)* will produce *cube(openscadwontusethis = 5);*
-  nothing bad will happen here, the value will just have no effect
-- $fn, $fs, $fa variables are passed without the '$'  
-  openscad: `sphere(4, $fn=12)`  
-  rubyscad: `sphere(r: 4, fn: 12)`
-- Ruby's math functions use radians, openscad uses degrees, for ease I've added a 'radians' function to the numeric class so the following is possible:  
-  openscad: sin(15)  
-  rubyscad: Math.sin(15.radians)
-- All functions which take code blocks (union, difference, intersection, ...) can use the form "function() { code }" or "function()" with the following result:  
-  the code:  
-  
-        translate(x: 5)
-        cube(size: 7)
-
-  would produce:
-
-        translate([5,0,0])
-        cube(size = 7);
-
-  the code:
-
-        translate(x: 5) {
-          cube(size: 7)
-        }
-
-  would produce:
-
-        translate([5,0,0]) {
-          cube(size = 7);
-        }
-
-Openscad Functions:      
--------------------
-
-  openscad: `$fa = 0.2;`  
-  rubyscad: `fa 0.2`
-
-----------------------------------------------------------------------------
-
-  openscad: `$fs = 2;`  
-  rubyscad: `fs 2`
-
-----------------------------------------------------------------------------
-
-  openscad: `$fn = 5;`  
-  rubyscad: `fn 5`
-
-----------------------------------------------------------------------------
-
-  openscad: `include <file.scad>`  
-  rubyscad: `include_scad "file.scad"`
-
-----------------------------------------------------------------------------
-
-  openscad: `use <file.scad>`  
-  rubyscad: `use "file.scad"`
-
-----------------------------------------------------------------------------
-
-  openscad: `echo(1,2,3);`  
-  rubyscad: `echo 1, 2, 3`
-
-----------------------------------------------------------------------------
-
-  openscad: `%`  
-  rubyscad: `background`
-
-----------------------------------------------------------------------------
-
-  openscad: `#`  
-  rubyscad: `debug`
-
-----------------------------------------------------------------------------
-
-  openscad: `!`  
-  rubyscad: `root`
-
-----------------------------------------------------------------------------
-
-  openscad: `*`  
-  rubyscad: `disable`
-
-----------------------------------------------------------------------------
-
-  openscad: `projection([args]) [{ code }]`  
-  rubyscad: `projection([args]) [{ code }]`
-
-----------------------------------------------------------------------------
-
-  openscad: `linear_extrude([args]) [{ code }]`  
-  rubyscad: `linear_extrude([args]) [{ code }]`
-
-----------------------------------------------------------------------------
-
-  openscad: `rotate_extrude([args]) [{ code }]`  
-  rubyscad: `rotate_extrude([args]) [{ code }]`
-
-----------------------------------------------------------------------------
-
-  openscad: `import([args])`  
-  rubyscad: `import([args])`
-
-----------------------------------------------------------------------------
-
-  openscad: `difference() { code }`  
-  rubyscad: `difference() { code }`
-
-----------------------------------------------------------------------------
-
-  openscad: `union() { code }`  
-  rubyscad: `union() { code }`
-
-----------------------------------------------------------------------------
-
-  openscad: `intersection() { code }`  
-  rubyscad: `intersection() { code }`
-
-----------------------------------------------------------------------------
-
-  openscad: `render([args]) [{ code }]`  
-  rubyscad: `render([args]) [{ code }]`
-
-----------------------------------------------------------------------------
-
-  openscad: `minkowski() { code }`  
-  rubyscad: `minkowski() { code }`
-
-----------------------------------------------------------------------------
-
-  openscad: `hull() { code }`  
-  rubyscad: `hull() { code }`
-
-----------------------------------------------------------------------------
-
-  openscad: `cube([args])`  
-  rubyscad: `cube([args])`
-
-----------------------------------------------------------------------------
-
-  openscad: `sphere([args])`  
-  rubyscad: `sphere([args])`  
-
-* In addition to the normal arguments d: can also be provided instead of r: to specify the diameter instead of the radius
-
-----------------------------------------------------------------------------
-
-  openscad: `polyhedron([args])`  
-  rubyscad: `polyhedron([args])`
-
-----------------------------------------------------------------------------
-
-  openscad: `square([args])`  
-  rubyscad: `square([args])`
-
-----------------------------------------------------------------------------
-
-  openscad: `circle([args])`  
-  rubyscad: `circle([args])`
-
-* In addition to the normal arguments d: can also be provided instead of r: to specify the diameter instead of the radius
-
-----------------------------------------------------------------------------
-
-  openscad: `polygon([args])`  
-  rubyscad: `polygon([args])`
-
-----------------------------------------------------------------------------
-
-  openscad: `surface([args])`  
-  rubyscad: `surface([args])`
-
-----------------------------------------------------------------------------
-
-  openscad: `cylinder([args])`  
-  rubyscad: `cylinder([args])`
-
-----------------------------------------------------------------------------
-
-  openscad: `rotate([args]) [{ code }]`  
-  rubyscad: `rotate([args]) [{ code }]`
-
-* In addition to specifying a: as a vector x:, y:, and z: can be used instead
-
-----------------------------------------------------------------------------
-
-  openscad: `translate([args]) [{ code }]`  
-  rubyscad: `translate([args]) [{ code }]`
-
-* In addition to specifying v: as a vector x:, y:, and z: can be used instead
-
-----------------------------------------------------------------------------
-
-  openscad: `scale([args]) [{ code }]`  
-  rubyscad: `scale([args]) [{ code }]`
-
-* In addition to specifying v: as a vector x:, y:, and z: can be used instead
-
-----------------------------------------------------------------------------
-
-  openscad: `mirror([args]) [{ code }]`  
-  rubyscad: `mirror([args]) [{ code }]`
-
-* In addition to specifying v: as a vector x:, y:, and z: can be used instead
-
-----------------------------------------------------------------------------
-
-  openscad: `multmatrix([args]) [{ code }]`  
-  rubyscad: `multmatrix([args]) [{ code }]`
-
-----------------------------------------------------------------------------
-
-  openscad: `color([args]) [{ code }]`  
-  rubyscad: `color([args]) [{ code }]`
-
-* Instead of color: being defined, r:, g:, b:, and a: can be provided
-
-RubyScad Functions:
--------------------
-
-`format_command(cmd_str, args={}, &block)`
-
-* an easy way to implement new openscad commands.
-* cmd\_str should be in the form "func\_name(%&lt;args&gt;);"
-* all arguments passed from "args" will be inserted into the <args> string modifier
-* if a block is passed it will output between { }
-
-----------------------------------------------------------------------------
-
-`new_line`
-
-* outputs a new line
-
-----------------------------------------------------------------------------
-
-`start_block`
-
-* outputs a '{' at the correct tab level
-
-----------------------------------------------------------------------------
-
-`end_block`
-
-* outputs a '}' at the correct tab level
-
-----------------------------------------------------------------------------
-
-`end_all_blocks`
-
-* outputs a '}' for every open block
-
-----------------------------------------------------------------------------
-
-`format_output`
-
+RubyScad
+========
+
+Ruby module to easily generate openscad scripts
+
+General Usage
+-------------
+
+Requirements: Ruby 1.9.3
+Installation: `gem install rubyscad`
+
+RubyScad is a ruby mixin module which provides functions which allow easy output of openscad scripts .  To use simply "include" or "extend" the module into any class or module:
+
+    require "rubyscad"
+
+    module Test
+
+      extend RubyScad
+
+      def self.cone(base=5, height=10)
+
+        cylinder(r1: base, r2: 0, h:height)
+
+      end
+
+      cone(2, 4)
+    end
+
+---
+
+  from command line: 
+
+  print to standard output: `ruby test.rb`
+
+  generate file: `ruby test.rb "test.scad"`
+
+---
+
+    require "rubyscad"
+
+    class Test2
+
+      include RubyScad
+
+      def initialize(args={})
+        @radius = args.fetch(:radius, 3)
+      end
+
+      def render()
+        sphere(r:@radius)
+      end
+    end
+
+    Test2.new.render
+
+---
+
+  print to standard output: `ruby test2.rb`
+
+  generate file: `ruby test2.rb "test2.scad"`
+
+General Considerations
+-----------------------
+
+- All arguments are passed as named hash values matching the openscad spec, exceptions are for functions fa, fs, fn, echo, include, and use (see below).  
+  openscad: `cube(6)`  
+  rubyscad: `cube(size: 6)`
+- Any hash values may be passed to functions (with the exception of the ones noted above) but openscad may or may not use these values  
+  *cube(openscadwontusethis: 5)* will produce *cube(openscadwontusethis = 5);*
+  nothing bad will happen here, the value will just have no effect
+- $fn, $fs, $fa variables are passed without the '$'  
+  openscad: `sphere(4, $fn=12)`  
+  rubyscad: `sphere(r: 4, fn: 12)`
+- Ruby's math functions use radians, openscad uses degrees, for ease I've added a 'radians' function to the numeric class so the following is possible:  
+  openscad: sin(15)  
+  rubyscad: Math.sin(15.radians)
+- All functions which take code blocks (union, difference, intersection, ...) can use the form "function() { code }" or "function()" with the following result:  
+  the code:  
+  
+        translate(x: 5)
+        cube(size: 7)
+
+  would produce:
+
+        translate([5,0,0])
+        cube(size = 7);
+
+  the code:
+
+        translate(x: 5) {
+          cube(size: 7)
+        }
+
+  would produce:
+
+        translate([5,0,0]) {
+          cube(size = 7);
+        }
+
+Openscad Functions:      
+-------------------
+
+  openscad: `$fa = 0.2;`  
+  rubyscad: `fa 0.2`
+
+----------------------------------------------------------------------------
+
+  openscad: `$fs = 2;`  
+  rubyscad: `fs 2`
+
+----------------------------------------------------------------------------
+
+  openscad: `$fn = 5;`  
+  rubyscad: `fn 5`
+
+----------------------------------------------------------------------------
+
+  openscad: `include <file.scad>`  
+  rubyscad: `include_scad "file.scad"`
+
+----------------------------------------------------------------------------
+
+  openscad: `use <file.scad>`  
+  rubyscad: `use "file.scad"`
+
+----------------------------------------------------------------------------
+
+  openscad: `echo(1,2,3);`  
+  rubyscad: `echo 1, 2, 3`
+
+----------------------------------------------------------------------------
+
+  openscad: `%`  
+  rubyscad: `background`
+
+----------------------------------------------------------------------------
+
+  openscad: `#`  
+  rubyscad: `debug`
+
+----------------------------------------------------------------------------
+
+  openscad: `!`  
+  rubyscad: `root`
+
+----------------------------------------------------------------------------
+
+  openscad: `*`  
+  rubyscad: `disable`
+
+----------------------------------------------------------------------------
+
+  openscad: `projection([args]) [{ code }]`  
+  rubyscad: `projection([args]) [{ code }]`
+
+----------------------------------------------------------------------------
+
+  openscad: `linear_extrude([args]) [{ code }]`  
+  rubyscad: `linear_extrude([args]) [{ code }]`
+
+----------------------------------------------------------------------------
+
+  openscad: `rotate_extrude([args]) [{ code }]`  
+  rubyscad: `rotate_extrude([args]) [{ code }]`
+
+----------------------------------------------------------------------------
+
+  openscad: `import([args])`  
+  rubyscad: `import([args])`
+
+----------------------------------------------------------------------------
+
+  openscad: `difference() { code }`  
+  rubyscad: `difference() { code }`
+
+----------------------------------------------------------------------------
+
+  openscad: `union() { code }`  
+  rubyscad: `union() { code }`
+
+----------------------------------------------------------------------------
+
+  openscad: `intersection() { code }`  
+  rubyscad: `intersection() { code }`
+
+----------------------------------------------------------------------------
+
+  openscad: `render([args]) [{ code }]`  
+  rubyscad: `render([args]) [{ code }]`
+
+----------------------------------------------------------------------------
+
+  openscad: `minkowski() { code }`  
+  rubyscad: `minkowski() { code }`
+
+----------------------------------------------------------------------------
+
+  openscad: `hull() { code }`  
+  rubyscad: `hull() { code }`
+
+----------------------------------------------------------------------------
+
+  openscad: `cube([args])`  
+  rubyscad: `cube([args])`
+
+----------------------------------------------------------------------------
+
+  openscad: `sphere([args])`  
+  rubyscad: `sphere([args])`  
+
+* In addition to the normal arguments d: can also be provided instead of r: to specify the diameter instead of the radius
+
+----------------------------------------------------------------------------
+
+  openscad: `polyhedron([args])`  
+  rubyscad: `polyhedron([args])`
+
+----------------------------------------------------------------------------
+
+  openscad: `square([args])`  
+  rubyscad: `square([args])`
+
+----------------------------------------------------------------------------
+
+  openscad: `circle([args])`  
+  rubyscad: `circle([args])`
+
+* In addition to the normal arguments d: can also be provided instead of r: to specify the diameter instead of the radius
+
+----------------------------------------------------------------------------
+
+  openscad: `polygon([args])`  
+  rubyscad: `polygon([args])`
+
+----------------------------------------------------------------------------
+
+  openscad: `surface([args])`  
+  rubyscad: `surface([args])`
+
+----------------------------------------------------------------------------
+
+  openscad: `cylinder([args])`  
+  rubyscad: `cylinder([args])`
+
+----------------------------------------------------------------------------
+
+  openscad: `rotate([args]) [{ code }]`  
+  rubyscad: `rotate([args]) [{ code }]`
+
+* In addition to specifying a: as a vector x:, y:, and z: can be used instead
+
+----------------------------------------------------------------------------
+
+  openscad: `translate([args]) [{ code }]`  
+  rubyscad: `translate([args]) [{ code }]`
+
+* In addition to specifying v: as a vector x:, y:, and z: can be used instead
+
+----------------------------------------------------------------------------
+
+  openscad: `scale([args]) [{ code }]`  
+  rubyscad: `scale([args]) [{ code }]`
+
+* In addition to specifying v: as a vector x:, y:, and z: can be used instead
+
+----------------------------------------------------------------------------
+
+  openscad: `mirror([args]) [{ code }]`  
+  rubyscad: `mirror([args]) [{ code }]`
+
+* In addition to specifying v: as a vector x:, y:, and z: can be used instead
+
+----------------------------------------------------------------------------
+
+  openscad: `multmatrix([args]) [{ code }]`  
+  rubyscad: `multmatrix([args]) [{ code }]`
+
+----------------------------------------------------------------------------
+
+  openscad: `color([args]) [{ code }]`  
+  rubyscad: `color([args]) [{ code }]`
+
+* Instead of color: being defined, r:, g:, b:, and a: can be provided
+
+RubyScad Functions:
+-------------------
+
+`format_command(cmd_str, args={}, &block)`
+
+* an easy way to implement new openscad commands.
+* cmd\_str should be in the form "func\_name(%&lt;args&gt;);"
+* all arguments passed from "args" will be inserted into the <args> string modifier
+* if a block is passed it will output between { }
+
+----------------------------------------------------------------------------
+
+`new_line`
+
+* outputs a new line
+
+----------------------------------------------------------------------------
+
+`start_block`
+
+* outputs a '{' at the correct tab level
+
+----------------------------------------------------------------------------
+
+`end_block`
+
+* outputs a '}' at the correct tab level
+
+----------------------------------------------------------------------------
+
+`end_all_blocks`
+
+* outputs a '}' for every open block
+
+----------------------------------------------------------------------------
+
+`format_output`
+
 * outputs a string at the correct tab level