xeme 0.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40d47d6001c1c5b02169dd9a5018544da7dfac7385eb06c581c70cd22f9f9330
-  data.tar.gz: 0dcc2eee1b43a10c4caf95ecfe073a66db44f535ec7e0733cd9a22569a7bf22b
+  metadata.gz: 1413d7abd0e3cbfa5bebfad9dd795b007df52d93b177ab7233fbafc4bdd79c98
+  data.tar.gz: bad5d9f7de703c07d092a88f68ab97f5dbf01eae52ebdebc4632c611c5c3656d
 SHA512:
-  metadata.gz: c20d4379578985940d8529fa92fe94e1990b2b49cb62d3e559cdb3b19340f64391253d444d2b26b64170192d61efc775b619277fa49a8936eaeaf0c22d928f07
-  data.tar.gz: 457cfe0199c7c7da8a536d77b92cd596de85298da06f67035ae02f92db2ff50d25045133020a6da8e2f28d6597cafe31e94f83aa1cc18e9bce342aadfa6ea3d5
+  metadata.gz: 03d58e05f1544a1b68400bfb76be1ae38e880b3e4bde7c4e0894591b83015d9eee26b81803b96910cc045e06045adc75943798a42a3ceeeaa9c3600dd6d8305a
+  data.tar.gz: 674de2ab9106711fef9c123e68ddba3cc4293f3d8a3f1c2c7032e361e0864005e4c2a047e41df1eba98419d92a6420095fcfc27f36d3bac6c88f2e7a0eb3dd1d

data/lib/xeme.rb

@@ -6,13 +6,12 @@ require 'forwardable'
 # Xeme
 #
 
-##
 # Objects of this class represent a set of results. See the README file for
 # more details.
 
 class Xeme
-	# version 0.3
-	VERSION = '0.3'
+	# version 0.3.1
+	VERSION = '0.3.1'
 	
 	# A Xeme::Messages object, which is basically just a hash containing arrays
 	# for errors, warnings, and notes.
@@ -25,19 +24,13 @@ class Xeme
 	# initialize
 	#
 	
-	##
 	# new() does not take any parameters.
 	
 	def initialize
-		# initialize errors, warnings, notes, misc
 		@messages = Xeme::Messages.new
 		@misc = {}
-		
-		# prefix and auto_misc
 		@prefixes = []
 		@auto_details_val = nil
-		
-		# transaction
 		@transaction = nil
 	end
 	#
@@ -192,20 +185,19 @@ class Xeme
 	
 	
 	#---------------------------------------------------------------------------
-	# exception
+	# save_exception
 	#
 	
-	##
 	# Use this method to hold on to details about an exception. An error message
-	# object will be created, along with the exception's to_s backtrace.
+	# object will be created, along with the exception's to_s and backtrace.
 	
-	def exception(id, e, details={})
+	def save_exception(id, e, details={})
 		message = self.error(id, details)
 		message['error'] = e.to_s
 		message['backtrace'] = e.backtrace
 	end
 	#
-	# exception
+	# save_exception
 	#---------------------------------------------------------------------------
 	
 	
@@ -357,6 +349,21 @@ class Xeme
 	#---------------------------------------------------------------------------
 	
 	
+	#---------------------------------------------------------------------------
+	# new_exception
+	#
+	
+	# Creates and returns a Xeme::Exception object. The Xeme object is attached
+	# to the Xeme::Exception object.
+	
+	def new_exception(error_id)
+		return Xeme::Exception.new(error_id, self)
+	end
+	#
+	# new_exception
+	#---------------------------------------------------------------------------
+	
+	
 	# private methods
 	private
 
@@ -431,7 +438,6 @@ end
 # Xeme::Message
 #
 
-##
 # A Xeme::Message object represents a single error, warning, or note.
 # It is the base class for Xeme::Message::Error,
 # Xeme::Message::Warning, and 
@@ -450,6 +456,9 @@ class Xeme::Message
 	# The id of the message.
 	attr_reader :id
 	
+	# Details about the message.
+	attr_reader :details
+	
 	# delegate to hsh
 	extend Forwardable
 	delegate %w([] []= each length clear delete) => :@details
@@ -565,9 +574,8 @@ end
 # Xeme::Transaction
 #
 
-##
-# An object of this class provdes meta information about the request and
-# results. It always provides a a timestamp and a unique ID for the results. It
+# An object of this class provides meta information about the request and
+# results. It always provides a timestamp and a unique ID for the results. It
 # may also optionally include a request ID that was provided by the process
 # that made the request, such as a call to a REST application. Do not directly
 # instantiate this class; use Xeme#transaction.
@@ -626,3 +634,32 @@ end
 #
 # Xeme::Transaction
 #===============================================================================
+
+
+#===============================================================================
+# Xeme::Exception
+#
+
+# Xeme::Exception is a subclass of StandardError and can be used exactly like a
+# StandardError object. The one addition to StandardError is the `xeme` property
+# which holds a Xeme object. Don't instantiate this class directly; use
+# Xeme#new_exception.
+
+class Xeme::Exception < StandardError
+	attr_reader :xeme # a xeme object
+	
+	#---------------------------------------------------------------------------
+	# initialize
+	#
+	def initialize(error_code, xeme)
+		@error_code = error_code
+		@xeme = xeme
+		super @error_code
+	end
+	#
+	# initialize
+	#---------------------------------------------------------------------------
+end
+#
+# Xeme::Exception
+#===============================================================================

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xeme
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
 platform: ruby
 authors:
 - Mike O'Sullivan