dxf 0.1 → 0.2

data/README.markdown

@@ -1,6 +1,6 @@
 # DXF
 
-TODO: Write a gem description
+Tools for working with the popular DXF file format
 
 ## Installation
 
@@ -14,16 +14,18 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install DXF
+    $ gem install dxf
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'dxf'
 
-## Contributing
+# To export the my_sketch object in inches
+DXF.write('filename.dxf', my_sketch, :inches)
+```
 
-1. Fork it
-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 new Pull Request
+License
+-------
+
+Copyright 2012-2013 Brandon Fosdick <bfoz@bfoz.net> and released under the BSD license.

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.libs.push "lib"
+    t.test_files = FileList['test/**/*.rb']
+    t.verbose = true
+end

data/dxf.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "dxf"
-  gem.version       = 0.1
+  gem.version       = '0.2'
   gem.authors       = ["Brandon Fosdick"]
   gem.email         = ["bfoz@bfoz.net"]
   gem.description   = %q{Read and write DXF files using Ruby}
@@ -17,4 +17,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency  'sketch'
+    gem.add_dependency	'units', '~> 2.1'
 end

data/lib/dxf.rb

@@ -1,5 +1,6 @@
 require 'geometry'
 require 'sketch'
+require 'units'
 
 module DXF
 =begin
@@ -12,9 +13,19 @@ Reading and writing of files using AutoCAD's {http://en.wikipedia.org/wiki/AutoC
 	attr_accessor :container
 
 	# Initialize with a Sketch
-	# @param [Sketch] container	A {Sketch} to export to DXF
-	def initialize(container=nil)
-	    @container = container
+	# @param [String,Symbol] units	The units to convert length values to (:inches or :millimeters)
+	def initialize(units=:mm)
+	    @units = units
+	end
+
+	# Convert the given value to the correct units and return it as a formatted string
+	# @return [String]
+	def format_value(value)
+	    if value.is_a? Units::Literal
+		"%g" % value.send("to_#{@units}".to_sym)
+	    else
+		"%g" % value
+	    end
 	end
 
 	def to_s
@@ -35,7 +46,12 @@ Reading and writing of files using AutoCAD's {http://en.wikipedia.org/wiki/AutoC
 	    end
 	    first = Point[first] unless first.is_a?(Geometry::Point)
 	    last = Point[last] unless last.is_a?(Geometry::Point)
-	    [0, 'LINE', 8, layer, 10, first.x, 20, first.y, 11, last.x, 21, last.y]
+	    [ 0, 'LINE',
+	      8, layer,
+	     10, format_value(first.x),
+	     20, format_value(first.y),
+	     11, format_value(last.x),
+	     21, format_value(last.y)]
 	end
 
 	def section(name)
@@ -54,16 +70,16 @@ Reading and writing of files using AutoCAD's {http://en.wikipedia.org/wiki/AutoC
 		case element
 		    when Geometry::Arc
 			bytes.push 0, 'ARC'
-			bytes.push 10, element.center.x
-			bytes.push 20, element.center.y
-			bytes.push 40, element.radius
-			bytes.push 50, element.start_angle
-			bytes.push 51, element.end_angle
+			bytes.push 10, format_value(element.center.x)
+			bytes.push 20, format_value(element.center.y)
+			bytes.push 40, format_value(element.radius)
+			bytes.push 50, format_value(element.start_angle)
+			bytes.push 51, format_value(element.end_angle)
 		    when Geometry::Circle
 			bytes.push 0, 'CIRCLE'
-			bytes.push 10, element.center.x
-			bytes.push 20, element.center.y
-			bytes.push 40, element.radius
+			bytes.push 10, format_value(element.center.x)
+			bytes.push 20, format_value(element.center.y)
+			bytes.push 40, format_value(element.radius)
 		    when Geometry::Line
 			bytes.push line(element.first, element.last)
 		    when Geometry::Polyline
@@ -83,7 +99,11 @@ Reading and writing of files using AutoCAD's {http://en.wikipedia.org/wiki/AutoC
 	end
     end
 
-    def self.write(filename, sketch)
-	File.write(filename, Builder.new.from_sketch(sketch))
+    # Export a {Sketch} to a DXF file
+    # @param [String] filename	The path to write to
+    # @param [Sketch] sketch	The {Sketch} to export
+    # @param [Symbol] units	Convert all values to the specified units (:inches or :mm)
+    def self.write(filename, sketch, units=:mm)
+	File.write(filename, Builder.new(units).from_sketch(sketch))
     end
 end

data/test/dxf/builder.rb

@@ -13,7 +13,6 @@ describe DXF::Builder do
 
     describe "when give an empty Sketch object" do
 	it "must export a minimal file" do
-	    skip
 	    builder.container = Sketch.new
 	    builder.to_s.must_equal (empty_header + entities_header + end_section + eof).join("\n")
 	end
@@ -107,5 +106,67 @@ describe DXF::Builder do
 	    builder.to_s.must_equal (empty_header + entities_header + square_lines +
 				     end_section + eof).join "\n"
 	end
+
+	describe "when the sketch has units" do
+	    let(:sketch) { Sketch.new }
+
+	    describe "when exporting to inches" do
+		subject { DXF::Builder.new :inches }
+		let(:square_inches) { File.read('test/fixtures/square_inches.dxf') }
+
+		before do
+		    subject.container = sketch
+		end
+
+		describe "when the units are all inches" do
+		    before do
+			sketch.push Geometry::Polygon.new [0.inches, 0.inches], [1.inches, 0.inches], [1.inches, 1.inches], [0.inches, 1.inches]
+		    end
+
+		    it "must not convert the values" do
+			subject.to_s.must_equal square_inches
+		    end
+		end
+
+		describe "when the units are all metric" do
+		    before do
+			sketch.push Geometry::Polygon.new [0.mm, 0.mm], [25.4.mm, 0.mm], [25.4.mm, 25.4.mm], [0.mm, 25.4.mm]
+		    end
+
+		    it "must convert the values" do
+			subject.to_s.must_equal square_inches
+		    end
+		end
+	    end
+
+	    describe "when exporting to millimeters" do
+		subject { DXF::Builder.new :mm }
+		let(:square_millimeters) { File.read('test/fixtures/square_millimeters.dxf') }
+
+		before do
+		    subject.container = sketch
+		end
+
+		describe "when the units are all inches" do
+		    before do
+			sketch.push Geometry::Polygon.new [0.inches, 0.inches], [1.inches, 0.inches], [1.inches, 1.inches], [0.inches, 1.inches]
+		    end
+
+		    it "must convert the values" do
+			subject.to_s.must_equal square_millimeters
+		    end
+		end
+
+		describe "when the units are all metric" do
+		    before do
+			sketch.push Geometry::Polygon.new [0.mm, 0.mm], [25.4.mm, 0.mm], [25.4.mm, 25.4.mm], [0.mm, 25.4.mm]
+		    end
+
+		    it "must not convert the values" do
+			subject.to_s.must_equal square_millimeters
+		    end
+		end
+	    end
+	end
     end
 end

data/test/fixtures/square_inches.dxf

@@ -0,0 +1,62 @@
+0
+SECTION
+2
+HEADER
+0
+ENDSEC
+0
+SECTION
+2
+ENTITIES
+0
+LINE
+8
+0
+10
+0
+20
+0
+11
+1
+21
+0
+0
+LINE
+8
+0
+10
+1
+20
+0
+11
+1
+21
+1
+0
+LINE
+8
+0
+10
+1
+20
+1
+11
+0
+21
+1
+0
+LINE
+8
+0
+10
+0
+20
+1
+11
+0
+21
+0
+0
+ENDSEC
+0
+EOF

data/test/fixtures/square_millimeters.dxf

@@ -0,0 +1,62 @@
+0
+SECTION
+2
+HEADER
+0
+ENDSEC
+0
+SECTION
+2
+ENTITIES
+0
+LINE
+8
+0
+10
+0
+20
+0
+11
+25.4
+21
+0
+0
+LINE
+8
+0
+10
+25.4
+20
+0
+11
+25.4
+21
+25.4
+0
+LINE
+8
+0
+10
+25.4
+20
+25.4
+11
+0
+21
+25.4
+0
+LINE
+8
+0
+10
+0
+20
+25.4
+11
+0
+21
+0
+0
+ENDSEC
+0
+EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dxf
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-21 00:00:00.000000000 Z
+date: 2013-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sketch
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: units
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Read and write DXF files using Ruby
 email:
 - bfoz@bfoz.net
@@ -41,6 +57,8 @@ files:
 - dxf.gemspec
 - lib/dxf.rb
 - test/dxf/builder.rb
+- test/fixtures/square_inches.dxf
+- test/fixtures/square_millimeters.dxf
 homepage: http://github.com/bfoz/ruby-dxf
 licenses: []
 post_install_message: 
@@ -67,3 +85,6 @@ specification_version: 3
 summary: Tools for working with the popular DXF file format
 test_files:
 - test/dxf/builder.rb
+- test/fixtures/square_inches.dxf
+- test/fixtures/square_millimeters.dxf
+has_rdoc: