engineering 0.2 → 0.3

data/lib/engineering.rb

@@ -5,6 +5,9 @@ require 'model'
 require 'sketch'
 require 'units'
 
+require_relative 'builder/extrusion'
+require_relative 'builder/model'
+require_relative 'builder/sketch'
 require_relative 'sketchup'
 
 =begin
@@ -18,76 +21,42 @@ module Engineering
 
 	# Create a new {Extrusion} subclass and initialize it with the given block
 	# @param name [Symbol]    The name of the resulting subclass
-	def extrusion(symbol, &block)
-	    builder = Model::Extrusion::Builder.new
-	    builder.evaluate(&block) if block_given?
-	    initial_arguments = {sketch: builder.extrusion.sketch, length: builder.extrusion.length}.select {|k,v| v }
-
-	    klass = Class.new(Model::Extrusion)
-
-	    if initial_arguments.has_key?(:length)
-		klass.instance_variable_set :@length, initial_arguments[:length]
-		klass.class.send(:define_method, :length) { @length }
-	    end
-
-	    klass.instance_variable_set :@sketch, initial_arguments[:sketch]
-	    klass.class.send(:define_method, :sketch) { @sketch }
-
-	    klass.send :define_method, :initialize do |options={}, &block|
-		raise ArgumentError, "Can't initialize with a length when #{self} already has a length attribute" if initial_arguments.has_key?(:length) and options.has_key?(:length)
-		super initial_arguments.merge(options), &block
+	def extrusion(name=nil, &block)
+	    klass = Engineering::Builder::Extrusion.build(&block)
+	    if name
+		parent = (Module == self.class) ? self : Object
+		parent.const_set(name, klass)
 	    end
-
-	    Object.const_set(symbol, klass)
+	    klass
 	end
 
 	# Create a new {Model} subclass and initialize it with the given block
 	# @param name [Symbol]	The name of the new {Model} subclass
-	def model(name, &block)
-	    klass = Class.new(Model)
-	    builder = Model::Builder.new
-	    builder.evaluate(&block) if block_given?
-	    initial_elements = builder.elements
-
-	    # The defaults are hidden in an instance variable so that the passed block can't accidentally corrupt them
-	    attribute_defaults = builder.instance_variable_get(:@attribute_defaults) || {}
-
-	    # Bind any attribute getters and setters to the new subclass
-	    attribute_getters = builder.instance_variable_get(:@attribute_getters) || {}
-	    attribute_getters.each {|k, m| klass.send :define_method, k, m }
-
-	    attribute_setters = builder.instance_variable_get(:@attribute_setters) || {}
-	    attribute_setters.each {|k, m| klass.send :define_method, k, m }
-
-	    klass.send :define_method, :initialize do |*args, &block|
-		super *(attribute_defaults.map {|k,v| { k => (v.respond_to?(:call) ? v.call : v) } }), *args, &block
-		initial_elements.each {|a| push a }
+	def model(name=nil, &block)
+	    klass = Builder::Model.build(&block)
+	    if name
+		parent = (Module == self.class) ? self : Object
+		parent.const_set(name, klass)
 	    end
-
-	    Object.const_set(name, klass)
+	    klass
 	end
 
 	# Create a new {Sketch} subclass and initialize it with the given block
 	# @param name [Symbol]  The name of the {Sketch} subclass
-	def sketch(symbol, &block)
-	    builder = Sketch::Builder.new
-	    builder.evaluate(&block) if block_given?
-	    initial_elements = builder.elements
-
-	    klass = Class.new(Sketch)
-	    klass.send :define_method, :initialize do |*args, &block|
-		super *args, &block
-		initial_elements.each {|a| push a }
+	def sketch(name=nil, &block)
+	    klass = Builder::Sketch.build(&block)
+	    if name
+		parent = (Module == self.class) ? self : Object
+		parent.const_set(name, klass)
 	    end
-
-	    Object.const_set(symbol, klass)
+	    klass
 	end
 
 	class Geometry::Polygon
 	    # Build a {Polygon} instance using the {Sketch} DSL
 	    # @return [Polygon]
 	    def self.build(&block)
-		Sketch::PolygonBuilder.new.evaluate(&block)
+		Sketch::Builder::Polygon.new.evaluate(&block)
 	    end
 	end
 
@@ -95,7 +64,7 @@ module Engineering
 	    # Build a {Polyline} instance using the {Sketch} DSL
 	    # @return [Polyline]
 	    def self.build(&block)
-		Sketch::PolylineBuilder.new.evaluate(&block)
+		Sketch::Builder::Polyline.new.evaluate(&block)
 	    end
 	end
     end
@@ -103,3 +72,8 @@ end
 
 self.extend Engineering::DSL
 include Geometry	# Make Geometry types more readily available
+
+# Allow the DSL to be called from within Module definitions
+class Module
+    include Engineering::DSL
+end

data/lib/model/dsl.rb

@@ -0,0 +1,26 @@
+class Model
+    # Extensions to Model::DSL
+    module DSL
+	# Define a new read-write {Model} attribute. An optional default value can be supplied as either an argument, or as a block. The block will be evaluated the first time the attribute is accessed.
+	# @param name [String,Symbol]	The new attribute's name
+	# @param value A default value for the new attribute
+	def attr_accessor(name, value=nil, &block)
+	    define_attribute_reader name, value, &block
+	    define_attribute_writer name
+	end
+	alias :attribute :attr_accessor
+
+	# Define a new read-only {Model} attribute.  An optional default value can be supplied as either an argument, or as a block. The block will be evaluated the first time the attribute is accessed.
+	# @param name [String,Symbol]	The new attribute's name
+	# @param value A default value for the new attribute
+	def attr_reader(name, value=nil, &block)
+	    define_attribute_reader(name, value, &block)
+	end
+
+	# Define a new write-only {Model} attribute
+	# @param name [String,Symbol]	The new attribute's name
+	def attr_writer(name)
+	    define_attribute_writer(name)
+	end
+    end
+end

data/lib/sketchup.rb

@@ -81,6 +81,7 @@ module SketchUp
 	end
 
 	# Convert the given container to an array of strings that SketchUp can read
+	# @return [Array]
 	def to_array(container, parent='model.entities', transformation=nil)
 	    case container
 		when Model::Extrusion
@@ -90,11 +91,11 @@ module SketchUp
 			to_array(container.sketch, parent, container.transformation).map {|l| "#{l}.pushpull(#{to_sketchup(-container.length)})"}
 		    end
 		when Model::Group
+		    elements = container.elements.map {|element| to_array(element, 'group.entities') }
 		    if container.transformation and not container.transformation.identity?
-			add_instance(parent, container)
-		    else
-			container.elements.map {|element| to_array(element, parent) }.flatten
+			elements << "group.transformation = #{to_sketchup(container.transformation)}"
 		    end
+		    ["#{parent}.add_group.tap {|group|", elements.flatten.map {|line| line.prepend("\t") }, '}']
 		when Model  # !!! Must be after all subclasses of Model
 		    if container.transformation and not container.transformation.identity?
 			add_instance(parent, container)
@@ -102,7 +103,14 @@ module SketchUp
 			container.elements.map {|element| to_array(element, parent) }.flatten
 		    end
 		when Sketch::Group
-		    container.geometry.map {|element| to_sketchup(element, parent, container.transformation) }.flatten
+		    container.geometry.map do |element|
+			combined_transformation = transformation ? (transformation + container.transformation) : container.transformation
+			case element
+			    when Sketch::Group then to_array(element, parent, combined_transformation)
+			    else
+				to_sketchup(element, parent, combined_transformation)
+			end
+		    end.flatten
 		when Sketch  # !!! Must be after all subclasses of Sketch
 		    container.geometry.map do |element|
 			case element
@@ -120,6 +128,11 @@ module SketchUp
 	    case entity
 		when Array
 		    entity.map {|v| to_sketchup(v, parent, transformation) }.join(', ')
+		when Geometry::Annulus
+		    "->{ inner_face = #{parent}.add_circle(#{to_sketchup(entity.center, parent, transformation)}, [0,0,1], #{to_sketchup(entity.inner_radius)}).tap {|points| points[0].find_faces}.first.faces[0]\n \
+			 outer_face = #{parent}.add_circle(#{to_sketchup(entity.center, parent, transformation)}, [0,0,1], #{to_sketchup(entity.outer_radius)}).tap {|points| points[0].find_faces}.first.faces[0]\n \
+			 #{parent}.erase_entities(inner_face)\n \
+			 outer_face }.call"
 		when Geometry::Arc
 		    "#{parent}.add_arc(#{to_sketchup(entity.center)}, [1,0,0], [0,0,1], #{to_sketchup(entity.radius)}, #{to_sketchup(entity.start_angle)}, #{to_sketchup(entity.end_angle)})"
 		when Geometry::Circle
@@ -145,7 +158,7 @@ module SketchUp
 		    end
 		when Geometry::Polygon
 		    "#{parent}.add_face(#{to_sketchup(entity.points, parent, transformation)})"
-		when Geometry::Rectangle
+		when Geometry::Rectangle, Geometry::Square
 		    "#{parent}.add_face(#{to_sketchup(entity.points, parent, transformation)})"
 		when Geometry::Transformation
 		    pt = '[' + (entity.translation ? to_sketchup(entity.translation.to_a) : '0,0,0') + ']'
@@ -161,6 +174,13 @@ module SketchUp
 		when Units
 		    s = entity.to_s
 		    SKETCHUP_UNITS[s] or raise "SketchUp won't recognize '#{s}'"
+		when Units::Operator
+		    operator =	case entity
+				    when Units::Addition then ' + '
+				    when Units::Division then ' / '
+				    when Units::Subtraction then ' - '
+				end
+		    '(' + entity.operands.map {|a| to_sketchup(a)}.join(operator) + ')'
 		when Units::Numeric
 		    [entity.value, entity.units].compact.map {|a| to_sketchup(a)}.join '.'
 		else

data/test/builder/extrusion.rb

@@ -0,0 +1,143 @@
+require 'minitest/autorun'
+require 'builder/extrusion'
+
+describe Engineering::Builder::Extrusion do
+    subject { Engineering::Builder::Extrusion }
+
+    it 'must build a subclass' do
+	subject.build.ancestors.must_include(Model::Extrusion)
+	Class.wont_be :respond_to?, :elements
+    end
+
+    it 'must build a subclass with an empty block' do
+	klass = subject.build {}
+	klass.ancestors.must_include(Model::Extrusion)
+	klass.sketch.ancestors.must_include(Sketch)
+	klass.sketch.elements.must_be_empty
+    end
+
+    it 'must build a subclass with a length property' do
+	subject.build.must_be :respond_to?, :length
+	Class.wont_be :respond_to?, :length
+    end
+
+    it 'must build a subclass with a sketch property' do
+	subject.build.must_be :respond_to?, :sketch
+	Class.wont_be :respond_to?, :sketch
+    end
+
+    it 'must have a length property that is availabe to the DSL' do
+	subject.build() { length 5; length.must_equal 5 }
+    end
+
+    describe 'when creating a subclass with attributes' do
+	let :klass do
+	    subject.build do
+		attribute :attribute0
+	    end
+	end
+
+	it 'must define the attributes' do
+	    klass.new.must_be :respond_to?, :attribute0
+	    klass.new.must_be :respond_to?, :attribute0=
+	end
+
+	it 'must define the attribute on the Sketch instance' do
+	    klass.new.sketch.must_be :respond_to?, :attribute0
+	end
+
+	it 'must have working accessors' do
+	    test_model = klass.new
+	    test_model.attribute0 = 42
+	    test_model.attribute0.must_equal 42
+	end
+
+	it 'must be able to initialize the attribute during construction' do
+	    klass.new(attribute0: 37).attribute0.must_equal 37
+	end
+    end
+
+    describe 'when creating a subclass with attributes that have default values' do
+	let :klass do
+	    subject.build do
+		attribute :attribute0, 42
+	    end
+	end
+
+	it 'must define the attribute on the Sketch subclass' do
+	    klass.sketch.must_be :respond_to?, :attribute0
+	end
+
+	it 'must have the default value' do
+	    klass.new.attribute0.must_equal 42
+	end
+
+	it 'must allow the default value to be overriden' do
+	    klass.new(attribute0: 24).attribute0.must_equal 24
+	end
+
+	it 'must not pollute Class' do
+	    Class.wont_be :respond_to?, :attribute0
+	end
+
+	it 'must have class attributes' do
+	    klass.attribute0.must_equal 42
+	end
+
+	it 'must not have a class setter' do
+	    -> { klass.attribute0 = 5 }.must_raise NoMethodError
+	end
+    end
+
+    describe 'when creating a subclass with read-only attributes that have default values' do
+	let :klass do
+	    subject.build do
+		attr_reader :attributeO, 42
+	    end
+	end
+
+	it 'must have the default value' do
+	    klass.new.attributeO.must_equal 42
+	end
+
+	it 'must not allow the default value to be overriden' do
+	    -> { klass.new(attributeO: 24) }.must_raise NoMethodError
+	end
+
+	it 'must not pollute Class' do
+	    Class.wont_be :respond_to?, :attribute0
+	end
+
+	it 'must have class attributes' do
+	    klass.attributeO.must_equal 42
+	end
+
+	it 'must not have a class setter' do
+	    -> { klass.attributeO = 5 }.must_raise NoMethodError
+	end
+
+	it 'must not have an instance setter' do
+	    -> { klass.new.attributeO = 6 }.must_raise NoMethodError
+	end
+    end
+
+    describe 'when creating a subclass with a group' do
+	let :klass do
+	    subject.build do
+		group origin:[1,2] do
+		end
+	    end
+	end
+
+	it 'must create a Group subclass' do
+	    klass.sketch.elements.count.must_equal 1
+	    klass.sketch.elements.first.first.ancestors.must_include Sketch::Group
+	    klass.sketch.elements.first.last.must_equal [origin:[1,2]]
+	end
+
+	it 'must pass the initializer arguments when instantiating the subclass' do
+	    klass.new.sketch.first.must_be_kind_of Sketch::Group
+	    klass.new.sketch.first.transformation.translation.must_equal Geometry::Point[1,2]
+	end
+    end
+end

data/test/builder/model.rb

@@ -0,0 +1,191 @@
+require 'minitest/autorun'
+require 'builder/model'
+
+describe Engineering::Builder::Model do
+    subject { Engineering::Builder::Model }
+
+    it 'must build a Model subclass' do
+	subject.build.ancestors.must_include(Model)
+	Class.wont_be :respond_to?, :elements
+    end
+
+    it 'must build a Model subclass with an empty block' do
+	klass = subject.build {}
+	klass.ancestors.must_include(Model)
+	klass.elements.must_be_empty
+	Class.wont_be :respond_to?, :elements
+    end
+
+    describe 'when creating a Model subclass with attributes' do
+	let :klass do
+	    subject.build do
+		attribute :attribute0
+	    end
+	end
+
+	it 'must define the attributes for instances' do
+	    klass.new.must_be :respond_to?, :attribute0
+	    klass.new.must_be :respond_to?, :attribute0=
+	end
+
+	it 'must have working instance accessors' do
+	    test_model = klass.new
+	    test_model.attribute0 = 42
+	    test_model.attribute0.must_equal 42
+	end
+
+	it 'must be able to initialize the attribute during construction' do
+	    klass.new(attribute0: 37).attribute0.must_equal 37
+	end
+    end
+
+    describe 'when creating a Model subclass with attributes that have default values' do
+	let :klass do
+	    subject.build do
+		attribute :attribute0, 42
+	    end
+	end
+
+	it 'must have the default value' do
+	    klass.new.attribute0.must_equal 42
+	end
+
+	it 'must allow the default value to be overriden' do
+	    klass.new(attribute0: 24).attribute0.must_equal 24
+	end
+
+	it 'must have class attributes' do
+	    klass.attribute0.must_equal 42
+	end
+
+	it 'must not pollute Class' do
+	    Class.wont_be :respond_to?, :attribute0
+	end
+
+	it 'must not have a class setter' do
+	    -> { klass.attribute0 = 5 }.must_raise NoMethodError
+	end
+    end
+
+    describe 'when creating a Model subclass with read-only attributes that have default values' do
+	let :klass do
+	    subject.build do
+		attr_reader :attributeO, 42
+	    end
+	end
+
+	it 'must have the default value' do
+	    klass.new.attributeO.must_equal 42
+	end
+
+	it 'must not allow the default value to be overriden' do
+	    -> { klass.new(attributeO: 24) }.must_raise NoMethodError
+	end
+
+	it 'must not pollute Class' do
+	    Class.wont_be :respond_to?, :attribute0
+	end
+
+	it 'must have class attributes' do
+	    klass.attributeO.must_equal 42
+	end
+
+	it 'must not have a class setter' do
+	    -> { klass.attributeO = 5 }.must_raise NoMethodError
+	end
+
+	it 'must not have an instance setter' do
+	    -> { klass.new.attributeO = 6 }.must_raise NoMethodError
+	end
+    end
+
+    describe 'when pushing subclasses with initializer arguments' do
+	let :klass do
+	    subject.build do
+		push Model, origin:[1,2,3]
+	    end
+	end
+
+	it 'must store the subclass in initializer arguments' do
+	    klass.elements.first.must_be_kind_of Array
+	    klass.elements.first.must_equal [Model, [origin:[1,2,3]]]
+	end
+
+	it 'must pass the initializer arguments when instantiating the subclass' do
+	    klass.new.elements.first.must_be_kind_of Model
+	end
+    end
+
+    describe 'when creating a subclass with an extrusion' do
+	let :klass do
+	    subject.build do
+		extrude length:10, origin:[1,2,3] do
+		end
+	    end
+	end
+
+	it 'must create an Extrusion subclass' do
+	    klass.elements.count.must_equal 1
+	    klass.elements.first.first.ancestors.must_include Model::Extrusion
+	    klass.elements.first.last.must_equal [length:10, origin:[1,2,3]]
+	end
+
+	it 'must pass the initializer arguments when instantiating the subclass' do
+	    klass.new.first.must_be_kind_of Model::Extrusion
+	    klass.new.first.transformation.translation.must_equal Geometry::Point[1,2,3]
+	end
+    end
+
+    describe 'when creating a subclass with a group' do
+	let :klass do
+	    subject.build do
+		group origin:[1,2,3] do
+		end
+	    end
+	end
+
+	it 'must create a Group subclass' do
+	    klass.elements.count.must_equal 1
+	    klass.elements.first.first.ancestors.must_include Model::Group
+	    klass.elements.first.last.must_equal [origin:[1,2,3]]
+	end
+
+	it 'must pass the initializer arguments when instantiating the subclass' do
+	    klass.new.first.must_be_kind_of Model::Group
+	    klass.new.first.transformation.translation.must_equal Geometry::Point[1,2,3]
+	end
+    end
+
+    describe 'when creating a subclass that contains another Model subclass' do
+	let :klass do
+	    subject.build do
+		push Model
+	    end
+	end
+
+	it 'must add the subclass' do
+	    klass.elements.length.must_equal 1
+	    klass.elements.first.first.ancestors.must_include Model
+	    klass.elements.first.last.must_equal []
+	end
+    end
+
+    describe 'when creating a subclass that contains another Model subclass that has argument' do
+	let :klass do
+	    subject.build do
+		push Model, origin:[1,2,3]
+	    end
+	end
+
+	it 'must add the subclass' do
+	    klass.elements.length.must_equal 1
+	    klass.elements.first.first.ancestors.must_include Model
+	    klass.elements.first.last.must_equal [origin:[1,2,3]]
+	end
+
+	it 'must pass the initializer arguments when instantiating the subclass' do
+	    klass.new.first.must_be_kind_of Model
+	    klass.new.first.transformation.translation.must_equal Geometry::Point[1,2,3]
+	end
+    end
+end