STLExtract 1.0.0 → 1.0.1

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-First create a new StlExtract object using the following command
+First create a new StlExtract object using the following command.
 
 ```ruby
 s = StlExtract.new()
@@ -32,20 +32,26 @@ Then use the following command to get info about a file specified as an argument
  s.get_info("C:/Users/Tom/Documents/champagne_bottle.stl")
 ```
 
+You can automate the above two commands by specifying the optional file path in the new construct as shown below
+
+```ruby
+s = StlExtract.new("C:/Users/Tom/Documents/champagne_bottle.stl")
+```
+
 Should there be any errors with getting the details from the file then you can retrieve the error from 
 
 ```ruby
-s.get_error
+s.error
 ```
 
-The error will be a string value containing text about the error or -1 if the program ran correctly and there was no error. If there was no errors then you can access x,y,z,volume and if file needs repair using
+The error will be a string value containing text about the error or false if the program ran correctly and there was no error. If there was no errors then you can access x,y,z,volume and if file needs repair using
 
 ```ruby
-s.get_x_value
-s.get_y_value
-s.get_z_value
-s.get_volume
-s.get_repair
+s.x
+s.y
+s.z
+s.volume
+s.repair
 ```
 
 Should the STL file need repairing we can use the following command
@@ -54,7 +60,8 @@ Should the STL file need repairing we can use the following command
 s.repair_file("C:/Users/Tom/Documents/champagne_bottle.stl")
 ```
 
-to create a fixed file named [OrginalName]_fixed.obj so in our above example we will now have a file named champagne_bottle_fixed.obj in C:/Users/Tom/Documents/
+to create a fixed file named [OrginalName]_fixed.obj so in our above example we will now have a file named champagne_bottle_fixed.obj in C:/Users/Tom/Documents/.
+If no argument is given to repair_file it automatically uses the last string passed to new() or get_info()
 
 
 ## Contributing

data/STLExtract.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "STLExtract"
   spec.version       = STLExtract::VERSION
   spec.authors       = ["Thomas Preece"]
-  spec.email         = ["t.preece@warwick.ac.uk"]
+  spec.email         = ["RubyGems@thomaspreece.com"]
   spec.summary       = 'Extracts data from STL, OBJ and AMF files using Slic3r'
   spec.description   = 'Extracts x,y,z and volume data from STL, OBJ and AMF files using Slic3r'
   spec.homepage      = "http://thomaspreece.com"

data/lib/STLExtract.rb

@@ -2,28 +2,47 @@ require "STLExtract/version"
 require 'io/console'
 
 class StlExtract 
-	def repair_file(file)
-		@error = -1
+	def repair_file(file=nil)
+		@error = false
 		
-		io = IO.popen(@slic3r_path+' --repair '+file+" 2>&1")
-		io.each do |s|
-			if s.include? "No such file"
-				@error = "Incorrect filename"
+		if file==nil
+			#Check for file to repair in local @file
+			if @file!=nil
+				#Use file found in @file to repair
+				file = @file
+			else
+				#No file provided, give error
+				@error = "No file provided to repair"
+			end
+		else
+			#Use file provided to function in repair
+		end
+		
+		#If no errors, repair file
+		if @error == false
+			io = IO.popen(@slic3r_path+" --repair \""+file+"\" 2>&1")
+			io.each do |s|
+				if s.include? "No such file"
+					@error = "Incorrect filename"
+				end
 			end
 		end
 	end
 	
 	def get_info(file)
-		#reset initial values to -1 
-		@x_value = -1
-		@y_value = -1
-		@z_value = -1
-		@volume = -1 
-		@repair = -1
-		@error = -1
+		#Set @file to use later in repair
+		@file = file
+	
+		#Set our initial values to nil and false for error
+		@x_value = nil
+		@y_value = nil
+		@z_value = nil
+		@volume = nil
+		@repair = nil
+		@error = false
 		
 		#Open slic3r with filename supplied
-		io = IO.popen(@slic3r_path+' --info '+file+" 2>&1")
+		io = IO.popen(@slic3r_path+" --info \""+file+"\" 2>&1")
 		
 		io.each do |s|
 			#If output contains size, extract size information using regex
@@ -40,9 +59,9 @@ class StlExtract
 				sizeMatch = s.match( /needed repair:[^y]+(yes|no)/ )
 				if sizeMatch!=nil 
 					if sizeMatch.values_at( 1 )[0]=="yes"
-						@repair = 1
+						@repair = true
 					else
-						@repair = 0
+						@repair = false
 					end
 				end
 			end
@@ -67,19 +86,19 @@ class StlExtract
 		end
 		
 		#Check that all required data is extracted
-		if ((@x_value==-1 || @y_value==-1 || @z_value==-1 || @volume==-1 || @repair==-1 ) && @error == -1)
+		if ((@x_value==nil || @y_value==nil || @z_value==nil || @volume==nil || @repair==nil ) && @error == false)
 			@error = "Could not extract all data"
 		end	
 	end
 	
-	def initialize()
-		#Set our initial values to -1 
-		@x_value = -1
-		@y_value = -1
-		@z_value = -1
-		@volume = -1 
-		@repair = -1
-		@error = -1
+	def initialize(file=nil)
+		#Set our initial values to nil and false for error 
+		@x_value = nil
+		@y_value = nil
+		@z_value = nil
+		@volume = nil
+		@repair = nil
+		@error = false
 		
 		#Find Slic3r location
 		@slic3r_path = File.expand_path('../../', __FILE__)
@@ -101,34 +120,38 @@ class StlExtract
 				raise "Could not make Slic3r executable"
 			end
 		end	
+		
+		if file!=nil
+			get_info(file)
+		end
 	end
   
-	def get_x_value()
+	def x()
 		#Return stored x value
 		@x_value
 	end
   
-	def get_y_value()
+	def y()
 		#Return stored y value
 		@y_value
 	end
 
-	def get_z_value()
+	def z()
 		#Return stored z value
 		@z_value
 	end
 
-	def get_volume()
+	def volume()
 		#Return stored volume
 		@volume
 	end  
 	
-	def get_repair()
+	def repair()
 		#Return stored volume
 		@repair
 	end  
 	
-	def get_error()
+	def error()
 		#Return stored volume
 		@error
 	end  	

data/lib/STLExtract/version.rb

@@ -1,3 +1,3 @@
 module STLExtract
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: STLExtract
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,7 +45,7 @@ dependencies:
         version: '10.0'
 description: Extracts x,y,z and volume data from STL, OBJ and AMF files using Slic3r
 email:
-- t.preece@warwick.ac.uk
+- RubyGems@thomaspreece.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -55,7 +55,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- STLExtract-0.0.1.gem
 - STLExtract.gemspec
 - Slic3r/Linux/bin/slic3r
 - Slic3r/Linux/dll/libGLU.so