appraisermetrics_report_service 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1636e2ee5c97a81021794dc71ac8c49956ecc06e
-  data.tar.gz: 5bb6f84f088ae66e32edcb84c414d6169309e492
+  metadata.gz: 0f325f462ad292bd28e892742d70d0cb058276b1
+  data.tar.gz: b0f7034d9400b0a0f936d4362a1ab0d06600f823
 SHA512:
-  metadata.gz: 3393a08515e9e51bfb30c9cd0a31c884ec9ab2317f0b78a01e75202aeaccb77016e55936d90da05089986d9cf4ebe6d47a94b8c83866ebd94161290f2bbee59f
-  data.tar.gz: 3a1c7e7b48d80261efbf458ef4c1b70890c2f077eb69aff4a849dba13c33c3d931513bb409dcb8c1f0ab6f3d20a064b6a16739b25a422a23edf10155d13f7776
+  metadata.gz: e8809c24fd56d962c911a9e77ba461e0ba304172ea130316916b8992e36e29c3ac37f8d37c5945592d0f6b91df537c00dc1a4a52089d04aff2a7fb11369e528a
+  data.tar.gz: 926930e83d783eee5b79dd7d4f648466c5eca3def232f9c4eee221e8af1aa8231cb2e69f95005aa3d70db4ca58d9c22917fa81cb03433305eb0abd45a845ff74

data/README.md

@@ -40,12 +40,12 @@ end
 ```ruby
 # generate an eval report
 r = EvalReport.new do
-	write_content(subject, comparables, images, logo, docs={}) 
-	# images is a hash, subject is a hash, comparables is an array, logo is a filepath
-	# docs is an options hash that will accept file paths for related pdf and image files
-end
+	write_content(subject, comparables, logo, docs={}) 
+	# docs is an optional hash. All keys are should be filepaths, with the exception of 
+	# :subjectphotos which is an Array of filepaths, 
 
-# image hash construction: {subject_photos: [], regional_maps: [], topo_maps: [], ag_sales_map: String}
+	# subject is a hash, comparables is an array, logo is a filepath
+end
 ```
 
 ## Output

data/lib/appraisermetrics_report_service/version.rb

@@ -1,3 +1,3 @@
 module AppraisermetricsReportService
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/eval_report.rb

@@ -10,17 +10,19 @@ class EvalReport < Prawn::Document
 		super()
 	end
 
-	def write_content(subject, comparables, images, logo, docs={}) # main method to populate pdf
+	def write_content(subject, comparables, logo, docs={}) # main method to populate pdf
 		# variables used across instance methods
 		@logo = logo
 		@sub = subject
 		@comps = comparables
 		@comps ||= [] # avoid calling methods on nil
-		@images = images
+		@docs = docs
 		@text_blocks = static_strings # Hash of text blocks loaded from .yml
 		@recon_primary_per_acre = [] # used for reconciliation for comparables
 		@recon_secondary_per_acre = [] # ""
-		@docs = docs
+
+		# hash for building table of contents from headers/page numbers
+		@toc_hash = {}
 
 		# font defaults to Helvetica
 		font_size 11 
@@ -45,6 +47,8 @@ class EvalReport < Prawn::Document
 		addenda_contents
 		addendum_a
 		addendum_b
+		additional_docs
+		finish_toc
 	end
 
 	def office_logo
@@ -147,10 +151,10 @@ class EvalReport < Prawn::Document
 	def subject_images
 		header("SUBJECT PHOTOGRAPHS")
 		move_down 10
-		if @images && @images[:subject_photos]
-			if @images[:subject_photos][0]
+		if @docs && @docs[:subjectphotos]
+			if @docs[:subjectphotos][0]
 				image_cap("")
-				image "#{@images[:subject_photos][0]}", width: 300, position: :center
+				image "#{@docs[:subjectphotos][0]}", width: 300, position: :center
 				move_down 2
 				text "Subject Property - Representative Image", align: :center
 				move_down 25
@@ -159,9 +163,9 @@ class EvalReport < Prawn::Document
 				move_cursor_to 350
 			end
 
-			if @images[:subject_photos][1]
+			if @docs[:subjectphotos][1]
 				image_cap("")
-				image "#{@images[:subject_photos][1]}", width: 300, position: :center
+				image "#{@docs[:subjectphotos][1]}", width: 300, position: :center
 				move_down 2
 				text "Subject Property - Representative Image", align: :center
 				move_down 25
@@ -174,9 +178,9 @@ class EvalReport < Prawn::Document
 			start_new_page
 			header("SUBJECT PHOTOGRAPHS")
 			move_down 10
-			if @images[:subject_photos][2]
+			if @docs[:subjectphotos][2]
 				image_cap("")
-				image "#{@images[:subject_photos][2]}", width: 300, position: :center
+				image "#{@docs[:subjectphotos][2]}", width: 300, position: :center
 				move_down 2
 				text "Subject Property - Representative Image", align: :center
 				move_down 25
@@ -185,9 +189,9 @@ class EvalReport < Prawn::Document
 				move_cursor_to 350
 			end
 
-			if @images[:subject_photos][3]
+			if @docs[:subjectphotos][3]
 				image_cap("")
-				image "#{@images[:subject_photos][3]}", width: 300, position: :center
+				image "#{@docs[:subjectphotos][3]}", width: 300, position: :center
 				move_down 2
 				text "Subject Property - Representative Image", align: :center
 				move_down 25
@@ -212,21 +216,23 @@ class EvalReport < Prawn::Document
 
 	def table_of_contents
 		header("TABLE OF CONTENTS")
-		move_down 25
-		text "Table of Contents", size: 14
-		move_down 25
+		start_new_page
+	end
 
-		contents = ["INTRODUCTION", "PROPERTY IDENTIFICATION", "REGIONAL MAPS", "LOCAL MAPS", 
-			"PROPERTY DESCRIPTION", "VALUATION PROCESS", "DIRECT COMPARISON ANALYSIS", "DISCUSSION OF SALES USED", 
-			"AGRICULTURAL SALES MAP", "FINAL VALUE INDICATION","ASSUMPTIONS AND CONDITIONS", "ADDENDA CONTENTS"
-		]
+	def finish_toc
+		go_to_page(5)
+		move_down 30
+		@toc_hash.each do |k, v|
+			float do
+				indent(500) do
+					text "#{v}"
+				end
+			end
 
-		contents.each do |c|
-			text "#{c}"
+			text "#{k}"
 			stroke_horizontal_rule
 			move_down 5
 		end
-		start_new_page
 	end
 
 	def introduction
@@ -309,19 +315,19 @@ class EvalReport < Prawn::Document
 		header("REGIONAL MAPS")
 		move_down 25
 		text "REGIONAL MAPS", size: 14, align: :center
-		if @images && @images[:regional_maps]
-			if @images[:regional_maps][0]
+		if @docs && @docs[:statemap]
+			if @docs[:statemap]
 				image_cap("STATE MAP")
-				image "#{@images[:regional_maps][0]}", width: 300, position: :center
+				image "#{@docs[:statemap]}", width: 300, position: :center
 				move_down 25
 			else
 				text 'No Image', align: :center
 				move_cursor_to 350
 			end
 
-			if @images[:regional_maps][1]
+			if @docs[:countymap]
 				image_cap("COUNTY MAP")
-				image "#{@images[:regional_maps][1]}", width: 300, position: :center
+				image "#{@docs[:countymap]}", width: 300, position: :center
 			else
 				text 'No Image', align: :center
 				move_cursor_to 350
@@ -340,10 +346,10 @@ class EvalReport < Prawn::Document
 		move_down 25
 		text "MAPS", size: 14, align: :center
 
-		if @images && @images[:topo_maps]
-			if @images[:topo_maps][0]
-				image_cap("TOPOGRAPHICAL MAPS")
-				image "#{@images[:topo_maps][0]}", width: 300, position: :center
+		if @docs && @docs[:topomap]
+			if @docs[:topomap]
+				image_cap("TOPOGRAPHICAL MAP")
+				image "#{@docs[:topomap]}", width: 300, position: :center
 				move_down 25
 			else
 				text 'No Image', align: :center
@@ -351,9 +357,9 @@ class EvalReport < Prawn::Document
 			end
 
 
-			if @images[:topo_maps][1]
+			if @docs[:aerialmap]
 				image_cap("AERIAL FSA MAP")
-				image "#{@images[:topo_maps][1]}", width: 300, position: :center
+				image "#{@docs[:aerialmap]}", width: 300, position: :center
 			else
 				text 'No Image', align: :center
 			end
@@ -823,8 +829,8 @@ class EvalReport < Prawn::Document
 	def ag_sales_map
 		header("AGRICULTURE SALES LOCATION MAP")
 		move_down 50
-		if @images && @images[:ag_sales_map]
-			image "#{@images[:ag_sales_map]}", width: 500, position: :center
+		if @docs && @docs[:agsalesmap]
+			image "#{@docs[:agsalesmap]}", width: 500, position: :center
 		else
 			text 'No Image'
 		end
@@ -947,8 +953,8 @@ class EvalReport < Prawn::Document
 
 	def addendum_a
 		# if an engagement letter is present, use it as a template for this page
-		if @docs[:engagement_letter]
-			start_new_page(template: @docs[:engagement_letter])
+		if @docs && @docs[:engagementletter]
+			start_new_page(template: @docs[:engagementletter])
 			header("ENGAGEMENT LETTER")
 		else
 			start_new_page
@@ -960,8 +966,8 @@ class EvalReport < Prawn::Document
 
 	def addendum_b
 
-		if @docs[:legal_description]
-			start_new_page(template: @docs[:legal_description])
+		if @docs && @docs[:legaldescription]
+			start_new_page(template: @docs[:legaldescription])
 			header("LEGAL DESCRIPTION")
 		else
 			start_new_page
@@ -972,6 +978,36 @@ class EvalReport < Prawn::Document
 		# end of document
 	end
 
+	def additional_docs
+		pdf_doc_proc = Proc.new do |doc_key, title|
+			if @docs[doc_key]
+				start_new_page(template: @docs[doc_key])
+				header(title)
+			end
+		end
+
+		pdf_doc_proc.call(:warrantydeed, "WARRANTY DEED/TRANSFER DEED")
+		pdf_doc_proc.call(:titleinsurancepolicy, "TITLE INSURANCE POLICY")
+		pdf_doc_proc.call(:lease, "LEASE")
+		pdf_doc_proc.call(:purchaseandsaleagreement, "PURCHASE AND SALE AGREEMENT")
+		pdf_doc_proc.call(:fsamap, "FSA MAP")
+		pdf_doc_proc.call(:fsa156, "FSA 156")
+		pdf_doc_proc.call(:addendum, "ADDENDUM")
+		pdf_doc_proc.call(:crpcontracts, "CRP CONTRACTS")
+		pdf_doc_proc.call(:floodmap, "FLOOD MAP")
+		pdf_doc_proc.call(:platmap, "PLAT MAP")
+		pdf_doc_proc.call(:surveymap, "SURVEY MAP")
+		pdf_doc_proc.call(:othermap, "OTHER MAP")
+		pdf_doc_proc.call(:buildingschematics, "BUILDING SCHEMATICS")
+		pdf_doc_proc.call(:irrigationschematics, "IRRIGATION SCHEMATICS")
+		pdf_doc_proc.call(:irrigationequipment, "IRRIGATION/PUMPING EQUIPMENT INVENTORY")
+		pdf_doc_proc.call(:cropcontracts, "CROP CONTRACTS")
+		pdf_doc_proc.call(:cropinsurancehistory, "CROP INSURANCE HISTORY")
+		pdf_doc_proc.call(:timbercruise, "TIMBER CRUISE")
+		pdf_doc_proc.call(:notes, "NOTES")
+		pdf_doc_proc.call(:photos, "PHOTOS")
+	end
+
 	def prepare_comps_for_calc
 		@comps.each do |p|
 			if p[:landclassifications] && p[:landclassifications].any?
@@ -988,6 +1024,13 @@ class EvalReport < Prawn::Document
 
 	def header(page_title)
 		text "#{page_title}  " << "#{page_count - 1}", align: :right
+
+		# build up the hash for table of contents
+		@toc_hash ||= {}
+		if @toc_hash[page_title] == nil
+			@toc_hash[page_title] = page_count - 1
+		end
+
 		stroke_horizontal_rule
 	end
 

data/spec/lib/eval_report_spec.rb

@@ -158,7 +158,7 @@ describe 'eval report class' do
 			it 'renders static content' do
 				@pdf = EvalReport.new do
 					@sub = Sampler.get_eval1
-					@images = Sampler.sample_eval_images
+					@docs = Sampler.sample_eval_docs
 					regional_maps
 				end
 
@@ -171,7 +171,7 @@ describe 'eval report class' do
 			it 'renders static content' do
 				@pdf = EvalReport.new do
 					@sub = {}
-					@images = {}
+					@docs = {}
 					regional_maps
 				end
 
@@ -186,7 +186,7 @@ describe 'eval report class' do
 			it 'renders image headers' do
 				@pdf = EvalReport.new do
 					@sub = {}
-					@images = Sampler.sample_eval_images
+					@docs = Sampler.sample_eval_docs
 					topo_maps
 				end
 
@@ -199,7 +199,7 @@ describe 'eval report class' do
 			it 'renders static content' do
 				@pdf = EvalReport.new do
 					@sub = {}
-					@images = {}
+					@docs = {}
 					topo_maps
 				end
 
@@ -488,7 +488,7 @@ describe 'eval report class' do
 			it 'renders static content' do
 				@pdf = EvalReport.new do
 					@sub = Sampler.get_eval1
-					@docs = {engagement_letter: './spec/test_data/pdfs/engagement_letter.pdf'}
+					@docs = {engagementletter: './spec/test_data/pdfs/engagement_letter.pdf'}
 					addendum_a
 				end
 
@@ -499,7 +499,7 @@ describe 'eval report class' do
 			it 'renders dynamic content from keys' do
 				@pdf = EvalReport.new do
 					@sub = Sampler.get_eval1
-					@docs = {engagement_letter: './spec/test_data/pdfs/engagement_letter.pdf'}
+					@docs = {engagementletter: './spec/test_data/pdfs/engagement_letter.pdf'}
 					addendum_a
 				end
 
@@ -527,7 +527,7 @@ describe 'eval report class' do
 			it 'renders static content' do
 				@pdf = EvalReport.new do
 					@sub = {}
-					@docs = {legal_description: './spec/test_data/pdfs/legal_description.pdf'}
+					@docs = {legaldescription: './spec/test_data/pdfs/legal_description.pdf'}
 					addendum_b
 				end
 
@@ -538,7 +538,7 @@ describe 'eval report class' do
 			it 'renders inserts dynamic content from pdf' do
 				@pdf = EvalReport.new do
 					@sub = Sampler.get_eval1
-					@docs = {legal_description: './spec/test_data/pdfs/legal_description.pdf'}
+					@docs = {legaldescription: './spec/test_data/pdfs/legal_description.pdf'}
 					addendum_b
 				end
 

data/spec/test_data/pdfs/optional_doc.pdf

@@ -0,0 +1,69 @@
+%PDF-1.3
+%����
+1 0 obj
+<< /Creator <feff0050007200610077006e>
+/Producer <feff0050007200610077006e>
+>>
+endobj
+2 0 obj
+<< /Type /Catalog
+/Pages 3 0 R
+>>
+endobj
+3 0 obj
+<< /Type /Pages
+/Count 1
+/Kids [5 0 R]
+>>
+endobj
+4 0 obj
+<< /Length 79
+>>
+stream
+q
+
+BT
+36 688.05 Td
+/F1.0 25 Tf
+[<6f7074696f6e616c207465737420646f63>] TJ
+ET
+
+Q
+
+endstream
+endobj
+5 0 obj
+<< /Type /Page
+/Parent 3 0 R
+/MediaBox [0 0 612.0 792.0]
+/Contents 4 0 R
+/Resources << /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
+/Font << /F1.0 6 0 R
+>>
+>>
+>>
+endobj
+6 0 obj
+<< /Type /Font
+/Subtype /Type1
+/BaseFont /Helvetica
+/Encoding /WinAnsiEncoding
+>>
+endobj
+xref
+0 7
+0000000000 65535 f 
+0000000015 00000 n 
+0000000109 00000 n 
+0000000158 00000 n 
+0000000215 00000 n 
+0000000344 00000 n 
+0000000522 00000 n 
+trailer
+<< /Size 7
+/Root 2 0 R
+/Info 1 0 R
+>>
+startxref
+619
+%%EOF

data/spec/test_data/sampler.rb

@@ -17,7 +17,7 @@ class Sampler
     r = EvalReport.new do
       comps = []
       8.times {|c| comps << Sampler.get_comp2}
-      write_content(Sampler.get_eval1, comps, Sampler.sample_eval_images, Sampler.sample_logo, {engagement_letter: './spec/test_data/pdfs/engagement_letter.pdf'})
+      write_content(Sampler.get_eval1, comps, Sampler.sample_logo, Sampler.sample_eval_docs)
       render_file("eval.pdf")
     end
 
@@ -38,23 +38,41 @@ class Sampler
     ]
   end
 
-  def self.sample_eval_images
-    images = {
-      subject_photos: [
+  def self.sample_eval_docs
+    docs = {
+      subjectphotos: [
         './spec/test_data/images/subject1.jpg', 
         './spec/test_data/images/subject2.jpg', 
         './spec/test_data/images/subject3.jpg',
         './spec/test_data/images/subject4.jpg'
       ],
-      regional_maps: [
-        './spec/test_data/images/regional1.jpg',
-        './spec/test_data/images/regional2.jpg'
-      ],
-      topo_maps: [
-        './spec/test_data/images/topo1.jpg',
-        './spec/test_data/images/topo2.jpg'
-      ],
-      ag_sales_map: './spec/test_data/images/ag_sales.jpg'
+      engagementletter: './spec/test_data/pdfs/engagement_letter.pdf',
+      legaldescription: './spec/test_data/pdfs/legal_description.pdf',
+      statemap: './spec/test_data/images/regional1.jpg',
+      countymap: './spec/test_data/images/regional2.jpg',
+      topomap: './spec/test_data/images/topo1.jpg',
+      aerialmap: './spec/test_data/images/topo2.jpg',
+      agsalesmap: './spec/test_data/images/ag_sales.jpg',
+      warrantydeed: './spec/test_data/pdfs/optional_doc.pdf',
+      titleinsurancepolicy: './spec/test_data/pdfs/optional_doc.pdf',
+      lease: './spec/test_data/pdfs/optional_doc.pdf',
+      purchaseandsaleagreement: './spec/test_data/pdfs/optional_doc.pdf',
+      fsamap: './spec/test_data/pdfs/optional_doc.pdf',
+      fsa156: './spec/test_data/pdfs/optional_doc.pdf',
+      addendum: './spec/test_data/pdfs/optional_doc.pdf',
+      crpcontracts: './spec/test_data/pdfs/optional_doc.pdf',
+      floodmap: './spec/test_data/pdfs/optional_doc.pdf',
+      platmap: './spec/test_data/pdfs/optional_doc.pdf',
+      surveymap: './spec/test_data/pdfs/optional_doc.pdf',
+      othermap: './spec/test_data/pdfs/optional_doc.pdf',
+      buildingschematics: './spec/test_data/pdfs/optional_doc.pdf',
+      irrigationschematics: './spec/test_data/pdfs/optional_doc.pdf',
+      irrigationequipment: './spec/test_data/pdfs/optional_doc.pdf',
+      cropcontracts: './spec/test_data/pdfs/optional_doc.pdf',
+      cropinsurancehistory: './spec/test_data/pdfs/optional_doc.pdf',
+      timbercruise: './spec/test_data/pdfs/optional_doc.pdf',
+      notes: './spec/test_data/pdfs/optional_doc.pdf',
+      photos: './spec/test_data/pdfs/optional_doc.pdf'
     }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appraisermetrics_report_service
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - StackPoint
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ttfunk
@@ -189,6 +189,7 @@ files:
 - spec/test_data/images/topo2.jpg
 - spec/test_data/pdfs/engagement_letter.pdf
 - spec/test_data/pdfs/legal_description.pdf
+- spec/test_data/pdfs/optional_doc.pdf
 - spec/test_data/sampler.rb
 homepage: ''
 licenses: []
@@ -235,4 +236,5 @@ test_files:
 - spec/test_data/images/topo2.jpg
 - spec/test_data/pdfs/engagement_letter.pdf
 - spec/test_data/pdfs/legal_description.pdf
+- spec/test_data/pdfs/optional_doc.pdf
 - spec/test_data/sampler.rb