oozby 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a23a382871587b9a004386c00f558f07dbe317af
-  data.tar.gz: b287f6a6be40890def253994c9413f5ba3140bad
+  metadata.gz: 5011b1b0b04f3a797f17d23572edc2bcefab387c
+  data.tar.gz: 20e1ce49a8c42a847bb40930d4c76b041674e85b
 SHA512:
-  metadata.gz: e202ef9d0b2a7d76bf7cf885df73911e8f86f8240c6705760cccd86f34811db7ad80ae3c543b5e02145180b7fcfc888e6b3c0102cfcfd49e6f42435a312e9748
-  data.tar.gz: 52a53ae63fe96411d3b1783db58466db03e83f3d5b17c6f5819d94ec7c356e4ca0e2afc49f07a3dc093f7f87c82d83958484d87658a90192cc27d8c127b95779
+  metadata.gz: ad55acc6736bbcd0c1fdc4c41b22daacbcae995dd9c915c7c95aac4a24038fbe66db4cfa622c0eacb3b8a133957a005a3642c2e5a8b56c3a5c6496c99f9b07fe
+  data.tar.gz: 1f47fca1a937a05c199686a62007b8f7246dde56112278fa9bfc34ee201eb165ade3da96e092795d62a4dd5fdf7caa68d3b465d1ddd20df68f9e12bc094b20ef

data/bin/oozby

@@ -1,9 +1,17 @@
 #!/usr/bin/env ruby
-$:.unshift File.dirname(__FILE__) + "/../lib"
 require 'thor'
 require 'listen'
 require 'pp'
-require 'oozby'
+require File.join(__dir__, '..', 'lib', 'oozby')
+
+# motivational exit messages!
+$quit_message = {
+  '0.2.2' => "Have a nice day!",
+  '0.2.3' => "You're a superstar!",
+  '0.2.4' => "Keep up the great work!",
+  '0.2.5' => "Nice job!",
+  '0.2.6' => "It was a pleasure working with you!"
+}
 
 class OozbyUtility < Thor
   desc "compile some#{File::SEPARATOR}folder", "The Oozby Utility searches a directory and compiles all the .oozby files it finds, creating identically named files with .scad stuck on the end, translated in to OpenSCAD nonsense. Open those files in OpenSCAD app and enable Automatic Reload and Compile in the Design menu, then get to work."
@@ -14,6 +22,9 @@ class OozbyUtility < Thor
   def compile path
     if File.file? path
       ooz = Oozby.new
+      ooz.filter_errors = !options[:verbose]
+      ooz.debug = options[:verbose]
+      
       begin
         ooz.parse_file path
       
@@ -27,10 +38,11 @@ class OozbyUtility < Thor
         end
         
         puts "compiled #{File.basename(path)}"
-      rescue StandardError, ScriptError => err
+      rescue StandardError, ScriptError, NoMethodError => err
         local_pwd = Dir.pwd
         puts "#{err.class.name}: #{err.message.sub(local_pwd + File::SEPARATOR, '')}"
         err.backtrace.each { |line| puts line.sub(local_pwd + File::SEPARATOR, '') }
+        puts nil, nil
       end
       
     elsif File.directory? path
@@ -53,7 +65,7 @@ class OozbyUtility < Thor
           removed.each do |path|
             puts "#{File.basename(path)} deleted."
             if File.exists? "#{path}.scad"
-              File.delete("{path}.scad")
+              File.delete("#{path}.scad")
               puts "Deleted generated .scad file for obsolete #{File.basename(path)}"
             end
           end
@@ -62,7 +74,7 @@ class OozbyUtility < Thor
     end
   rescue Interrupt => e
     puts ""
-    puts "Have a nice day!"
+    puts $quit_message[Oozby.version] || $quit_message.values.last
   end
 end
 

data/lib/oozby.rb

@@ -4,3 +4,4 @@ require_relative 'oozby/environment'
 require_relative 'oozby/method_preprocessor'
 require_relative 'oozby/render'
 require_relative 'oozby/element'
+require_relative 'oozby/version'

data/lib/oozby/base.rb

@@ -2,25 +2,37 @@ require 'pp'
 
 # Oozby class loads up files and evaluates them to a syntax tree, and renders to openscad source code
 class Oozby
+  attr_accessor :filter_errors, :debug
+  
   def initialize
     @code_tree = []
+    @filter_errors = false
+    @debug = false
   end
   
   # parse oozby code in to a syntax tree
   def parse code, filename: 'eval'
     env = Oozby::Environment.new(ooz: self)
+    if File.exists? filename
+      current_dir = Dir.pwd
+      Dir.chdir File.dirname(filename)
+    end
     
     # rescue block to filter out junk oozby library stuff from backtraces
     begin
       compiled = eval("lambda {; #{code};\n }", nil, filename)
       env.instance_exec(&compiled)
-    rescue
-      warn "Recent Calls: " + env.instance_variable_get(:@method_history).last(10).reverse.inspect
+    rescue StandardError, NoMethodError => err
       backtrace = $!.backtrace
-      backtrace = backtrace.select { |item| !item.include? __dir__ } unless backtrace.first.include? __dir__
+      #backtrace = backtrace.select { |item| !item.include? __dir__ } unless backtrace.first.include? __dir__
+      backtrace.delete_if { |item| item.to_s =~ /(\.rb|\/oozby):/ } if @filter_errors
+      
       raise $!, $!.message, backtrace
     end
     @code_tree = env._abstract_tree
+    
+  ensure
+    Dir.chdir current_dir if current_dir
   end
   
   # parse a file containing oozby code in to a syntax tree
@@ -31,7 +43,7 @@ class Oozby
   # render the last parsed oozby code in to openscad source code
   def render
     renderer = Oozby::Render.new(ooz: self)
-    renderer.render(@code_tree, clean: true).join("\n")
+    renderer.render(@code_tree, clean: true).join("\n") + "\n"
   end
   
   def abstract_tree

data/lib/oozby/environment.rb

@@ -1,3 +1,5 @@
+require 'amatch' # used to find possible intended method names
+
 class Oozby::Environment
   ResolutionDefaults = {
     degrees_per_fragment: 12,
@@ -14,8 +16,8 @@ class Oozby::Environment
     @modifier = nil
     @one_time_modifier = nil
     @preprocess = true
-    @method_history = []
     @method_preprocessor = Oozby::MethodPreprocessor.new(env: self, ooz: @parent)
+    @scanned_scad_files = []
   end
   
   # create a new scope that inherits from this one, and capture syntax tree created
@@ -44,6 +46,21 @@ class Oozby::Environment
   end
   
   def method_missing method_name, *args, **hash, &proc
+    # unless we know of this method in OpenSCAD or the preprocessor, abort!
+    unless @method_preprocessor.known?(method_name) or !@preprocess
+      # grab a list of all known methods, suggest a guess to user
+      known = @method_preprocessor.known
+      known.push(*public_methods(false))
+      known.delete_if { |x| x.to_s.start_with? '_' }
+      matcher = Amatch::Sellers.new(method_name.to_s)
+      suggestion = known.min_by { |item| matcher.match(item.to_s) }
+      
+      warn "Called unknown method #{method_name}()"
+      warn "Perhaps you meant #{suggestion}()?" if suggestion
+      
+      return super # continue to raise the usual error and all that
+    end
+    
     if proc
       children = _subscope(&proc)
     else
@@ -58,11 +75,13 @@ class Oozby::Environment
       call_address: @ast.length
     }
     
+    @ast.push(comment: "oozby code: " + JSON.generate(call)) if @parent.debug
+    
     @ast.push call
     element = Oozby::Element.new(call, @ast)
     @method_preprocessor.transform_call(element) if @preprocess
     @one_time_modifier = nil
-    @method_history.push method_name # maintain list of recent methods to aid debugging
+    
     return element
   end
   
@@ -169,7 +188,44 @@ class Oozby::Environment
     _apply_modifier('!', &proc)
   end
   
+  def require *args
+    file = args.first
+    if file.end_with? '.scad'
+      _require_scad_file(*args)
+    elsif File.exists? "#{file}.scad"
+      _require_scad_file("#{args.shift}.scad", *args)
+    else
+      Kernel.require(*args)
+    end
+  end
+  
+  def _require_scad_file filename, execute: true
+    raise "OpenSCAD file #{filename} not found" unless File.exists? filename
+    _scan_methods_from_scad_file filename
+    
+    # add include statement to resulting openscad code
+    @ast.push(execute: !!execute, import: filename)
+  end
   
+  def _scan_methods_from_scad_file filename
+    raise "OpenSCAD file #{filename} not found" unless File.exists? filename
+    data = File.read(filename)
+    @scanned_scad_files.push filename
+    
+    # parse out method definitions to add to our environment
+    data.gsub!(/\/\/.+?\n/m, "\n") # filter off single line comments
+    data.gsub!(/\/\*.+?\*\//m, '') # filter out multiline comments
+    data.scan /module[ \t]([a-zA-Z_9-9]+)/ do |module_name|
+      @method_preprocessor.openscad_methods.push module_name.first.to_sym
+    end
+    
+    # find any references to more files and recurse in to those
+    data.scan /(use|include)[ \t]\<(.+?)\>/ do |filename|
+      unless @scanned_scad_files.include? filename
+        _scan_methods_from_scad_file filename
+      end
+    end
+  end
   
   def _apply_modifier new_modifier, &children
     if children
@@ -185,6 +241,8 @@ class Oozby::Environment
   
   # returns the abstract tree
   def _abstract_tree; @ast; end
+  
+  def inspect; "OozbyFile"; end
 end
 
 

data/lib/oozby/method_preprocessor.rb

@@ -1,18 +1,49 @@
+# The Oozby Method Preprocessor handles requests via the transform_call method
+# and transforms the Oozby::Element passed in, patching in any extra features
+# and trying to alert the user of obvious bugs
+
+
 class Oozby::MethodPreprocessor
-  NoResolution = %i{translate rotate scale mirror resize difference union intersection hull minkowski}
+  # never pass resolution data in to these methods - it's pointless:
+  NoResolution = %i(translate rotate scale mirror resize difference union intersection hull minkowski color)
+  # list of OpenSCAD standard methods - these can pass through without error:
+  DefaultOpenSCADMethods = %i(
+    cube sphere cylinder polyhedron
+    circle square polygon
+    scale resize rotate translate mirror multmatrix color minkowski hull
+    linear_extrude rotate_extrude import projection
+    union difference intersection render
+  )
   
+  attr_accessor :openscad_methods
+  # setup a new method preprocessor
   def initialize env: nil, ooz: nil
     @env = env
     @parent = ooz
+    @openscad_methods = DefaultOpenSCADMethods.dup
   end
   
+  # accepts an Oozby::Element and transforms it according to the processors' rules
   def transform_call(call_info)
     send("_#{call_info.method}", call_info) if respond_to? "_#{call_info.method}"
     resolution call_info unless NoResolution.include? call_info.method # apply resolution settings from scope
     return call_info
   end
   
-  # allow translate to take x, y, z named args instead of array, with defaults to 0
+  # does this processor know of a method named whatever?
+  def known? name
+    return true if respond_to? "_#{name}"
+    return @openscad_methods.include? name.to_sym
+  end
+  
+  # array of all known method names
+  def known
+    list = @openscad_methods.dup
+    list.push *public_methods(false).select { |method_name| method_name.to_s.start_with? '_' }.map { |x| x.to_s.sub(/_/, '').to_sym }
+    list.uniq
+  end
+  
+  # allow method to take x, y, z named args instead of array, with defaults to 0
   def xyz_to_array(info, default: 0, arg: false, depth: true)
     if [:x, :y, :z].any? { |name| info[:named_args].include? name }
       
@@ -42,12 +73,12 @@ class Oozby::MethodPreprocessor
     end
   end
   
-  # layout defaults like center = whatever
+  # layout defaults like {center: true}
   def layout_defaults(info)
     info[:named_args] = @env.defaults.dup.merge(info[:named_args])
   end
   
-  # apply resolution settings to call info
+  # apply resolution settings to element
   ResolutionLookupTable = {degrees_per_fragment: :"$fa", minimum: :"$fs", fragments: :"$fn"}
   def resolution(info)
     res = @env.resolution
@@ -73,6 +104,12 @@ class Oozby::MethodPreprocessor
     end
   end
   
+  # general processing of arguments:
+  #  -o> Friendly names - use radius instead of r if you like
+  #  -o> Ranges - can specify radius: 5...10 instead of r1: 5, r2: 10
+  #  -o> Make h/height consistent (either works everywhere)
+  #  -o> Support inner radius, when number of sides is specified
+  #  -o> Specify diameter and have it halved automatically
   def expanded_names(info, height_label: :h)
     # let users use 'radius' as longhand for 'r'
     info.named_args[:r]  = info.named_args.delete(:radius)   if info.named_args[:radius]
@@ -83,11 +120,20 @@ class Oozby::MethodPreprocessor
     
     info.named_args[:"$fn"] = info.named_args.delete(:facets) if info.named_args[:facets]
     info.named_args[:"$fn"] = info.named_args.delete(:fragments) if info.named_args[:fragments]
+    info.named_args[:"$fn"] = info.named_args.delete(:sides) if info.named_args[:sides]
+    
+    info.named_args[:ir] = info.named_args.delete(:inr) if info.named_args[:inr]
+    info.named_args[:ir] = info.named_args.delete(:inradius) if info.named_args[:inradius]
+    info.named_args[:ir] = info.named_args.delete(:inner_r) if info.named_args[:inner_r]
+    info.named_args[:ir] = info.named_args.delete(:inner_radius) if info.named_args[:inner_radius]
     
     # let users specify diameter instead of radius - convert it
     {  diameter: :r,                    dia: :r,               d: :r,
       diameter1: :r1, diameter_1: :r1, dia1: :r1, dia_1: :r1, d1: :r1,
-      diameter2: :r2, diameter_2: :r2, dia2: :r2, dia_2: :r2, d2: :r2
+      diameter2: :r2, diameter_2: :r2, dia2: :r2, dia_2: :r2, d2: :r2,
+      id: :ir, inner_diameter: :ir, inner_d: :ir,
+      id1: :ir1, inner_diameter_1: :ir1, inner_diameter1: :ir1,
+      id2: :ir2, inner_diameter_2: :ir2, inner_diameter2: :ir2
     }.each do |d, r|
       if info.named_args.key? d
         data = info.named_args.delete(d)
@@ -100,6 +146,24 @@ class Oozby::MethodPreprocessor
       end
     end
     
+    # process 'inner radius' bits
+    { ir: :r, ir1: :r1, ir2: :r2 }.each do |ir, r|
+      if info.named_args.key? ir
+        sides = info.named_args[:"$fn"].to_i
+        raise "Use of inner radius requires sides/facets/fragments argument to #{info.method}()" unless sides
+        raise "Sides must be at least 3" unless sides >= 3
+        inradius = info.named_args.delete(ir)
+        if inradius.is_a? Range
+          circumradius = Range.new(inradius.first.to_f / @env.cos(180.0 / sides),
+                           inradius.first.to_f / @env.cos(180.0 / sides),
+                           inradius.exclude_end?)
+        else
+          circumradius = inradius.to_f / @env.cos(180.0 / sides)
+        end
+        info.named_args[r] = circumradius
+      end
+    end
+    
     # allow range for radius
     if info.named_args[:r].is_a? Range
       range = info.named_args.delete(:r)
@@ -130,6 +194,7 @@ class Oozby::MethodPreprocessor
   end
   
   def rounded_rect size: [1,1], center: false, r: 0.0, facets: nil
+    size = [size] * 2 if size.is_a? Numeric
     diameter = r * 2
     circle_x = (size[0] / 2.0) - r
     circle_y = (size[1] / 2.0) - r
@@ -155,6 +220,7 @@ class Oozby::MethodPreprocessor
   end
   
   def rounded_cube size: [1,1,1], center: false, r: 0.0, facets: nil
+    size = [size] * 3 if size.is_a? Numeric
     size = [size[0] || 1, size[1] || 1, size[2] || 1]
     diameter = r.to_f * 2.0
     
@@ -173,7 +239,7 @@ class Oozby::MethodPreprocessor
             inject_abstract_tree(preprocessor.rounded_rect(size: [size[2], size[1]], center: true, r: r)) }}
         
           # fill in the corners with spheres
-          xr, yr, zr = size.map { |x| (x / 2) - r }
+          xr, yr, zr = size.map { |x| (x / 2.0) - r }
           corner_coordinates = [
             [ xr, yr, zr],
             [ xr, yr,-zr],
@@ -185,14 +251,14 @@ class Oozby::MethodPreprocessor
             [-xr,-yr,-zr]
           ]
           preprocessor true do
-            resolution(fragments: (_fragments_for(radius: r).to_f / 4.0).round * 4.0) do
+            resolution(fragments: (_fragments_for(radius: r.to_f).to_f / 4.0).round * 4.0) do
               corner_coordinates.each do |coordinate|
                 translate(coordinate) do
                   # generate sphere shape
                   rotate_extrude do
                     intersection do
                       circle(r: r)
-                      translate([r, 0, 0]) { square([r * 2, r * 4], center: true) }
+                      translate([r, 0, 0]) { square([r * 2.0, r * 4.0], center: true) }
                     end
                   end
                 end
@@ -222,6 +288,68 @@ class Oozby::MethodPreprocessor
       }
     }).first    
   end
+  
+  # meta! construct aliases which preset some values
+  def self.oozby_alias from, to, extra_args = {}
+    define_method "_#{from}" do |info|
+      info.method = to
+      info.named_args.merge! extra_args
+      send("_#{to}", info) if self.respond_to? "_#{to}"
+    end
+  end
+  
+  # some regular shapes - from:
+  # http://en.wikipedia.org/wiki/Regular_polygon#Regular_convex_polygons
+  polygon_names = {
+    triangle: 3,
+    equilateral_triangle: 3,
+    pentagon: 5,
+    hexagon: 6,
+    heptagon: 7,
+    octagon: 8,
+    nonagon: 9,
+    enneagon: 9,
+    decagon: 10,
+    hendecagon: 11,
+    undecagon: 11,
+    dodecagon: 12,
+    tridecagon: 13,
+    tetradecagon: 14,
+    pentadecagon: 15,
+    hexadecagon: 16,
+    heptadecagon: 17,
+    octadecagon: 18,
+    enneadecagon: 19,
+    icosagon: 20,
+    triacontagon: 30,
+    tetracontagon: 40,
+    pentacontagon: 50,
+    hexacontagon: 60,
+    heptacontagon: 70,
+    octacontagon: 80,
+    enneacontagon: 90,
+    hectogon: 100
+  }
+  polygon_names.each do |shape_name, sides|
+    oozby_alias shape_name, :circle, sides: sides
+  end
+  
+  # make a polygon with an arbitrary number of sides
+  oozby_alias :ngon, :circle, sides: 3
+  # make a prism with an arbitrary number of sides
+  oozby_alias :prism, :cylinder, sides: 3
+  
+  # triangles are an edge case
+  oozby_alias :triangular_prism, :cylinder, sides: 3
+  
+  # for all the rest, transform the prism names automatically
+  polygon_names.each do |poly_name, sides|
+    name = poly_name.to_s
+    if name.end_with? 'gon'
+      name += 'al_prism'
+      oozby_alias name, :cylinder, sides: sides
+    end
+  end
 end
 
 

data/lib/oozby/render.rb

@@ -35,8 +35,12 @@ class Oozby::Render
           output.push "}"
         end
         
+      elsif node.key? :comment
+        output.push "/* #{node[:comment]} */"
       elsif node.key? :assign
-        output << "#{node[:assign]} = #{escape(node[:value])};"
+        output.push "#{node[:assign]} = #{escape(node[:value])};"
+      elsif node.key? :import
+        output.push "#{node[:execute] ? 'include' : 'use'} <#{node[:import]}>;"
       end
     end
     

data/lib/oozby/version.rb

@@ -0,0 +1,7 @@
+class Oozby
+  Version = '0.3.0'
+  
+  def self.version
+    Oozby::Version
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oozby
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Bluebie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: amatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.11
 description: OpenSCAD - a cad language for creating solid 3d objects, useful for CNC
   and 3D Printing, is incredibly annoying. It doesn't even support variables! Oozby
   is a markup builder like Markaby or XML Builder, so you can write OpenSCAD programs
@@ -55,6 +69,7 @@ files:
 - lib/oozby/environment.rb
 - lib/oozby/method_preprocessor.rb
 - lib/oozby/render.rb
+- lib/oozby/version.rb
 - lib/oozby.rb
 - readme.md
 - license.txt